feat: download search results via curl (#3243)

Author: Fran McDade

explorer/app/components/index.tsx

@@ -34,6 +34,8 @@ export { ExportSummary } from "@clevercanary/data-explorer-ui/lib/components/Exp
 export { ExportToTerraForm } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ExportToTerra/components/ExportToTerraForm/exportToTerraForm";
 export { TerraSetUpForm } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ExportToTerra/components/TerraSetUpForm/terraSetUpForm";
 export { ExportToTerra } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ExportToTerra/exportToTerra";
+export { ManifestDownloadForm } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ManifestDownload/components/ManifestDownloadForm/manifestDownloadForm";
+export { ManifestDownload } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ManifestDownload/manifestDownload";
 export { AzulFileDownload } from "@clevercanary/data-explorer-ui/lib/components/Index/components/AzulFileDownload/azulFileDownload";
 export { Cell } from "@clevercanary/data-explorer-ui/lib/components/Index/components/Cell/cell";
 export { Summaries } from "@clevercanary/data-explorer-ui/lib/components/Index/components/Hero/components/Summaries/summaries";

explorer/app/content/hca-dcp/index.tsx

@@ -13,4 +13,6 @@ export { default as DownloadCurlCommandStart } from "./downloadCurlCommandStart.
 export { default as DownloadCurlCommandSuccess } from "./downloadCurlCommandSuccess.mdx";
 export { default as ExportToTerraStart } from "./exportToTerraStart.mdx";
 export { default as ExportToTerraSuccessWithWarning } from "./exportToTerraSuccessWithWarning.mdx";
+export { default as ManifestDownloadStart } from "./manifestDownloadStart.mdx";
+export { default as ManifestDownloadSuccess } from "./manifestDownloadSuccess.mdx";
 export { default as MatrixQuestionnaire } from "./matrixQuestionnaire.mdx";

explorer/app/content/hca-dcp/manifestDownloadStart.mdx

@@ -0,0 +1,3 @@
+### Confirm Species Selection and Select Manifest File Types
+
+Please explicitly select at least one species and file type for inclusion in the manifest.

explorer/app/content/hca-dcp/manifestDownloadSuccess.mdx

@@ -0,0 +1,12 @@
+import { BatchCorrectionWarning } from "../../components/Export/components/BatchCorrectionWarning/batchCorrectionWarning";
+
+### Your File Manifest is Ready
+
+<BatchCorrectionWarning
+  label={"Matrix Normalization and Batch Correction"}
+  url={
+    "https://data.humancellatlas.org/guides/consumer-vignettes/matrices#matrix-normalization-and-batch-correction"
+  }
+/>
+
+This link expires in 7 days.

explorer/app/viewModelBuilders/azul/hca-dcp/common/viewModelBuilders.ts

@@ -52,6 +52,7 @@ import { PROJECTS_URL } from "../../../../../site-config/hca-dcp/dev/config";
 import {
   ROUTE_BULK_DOWNLOAD,
   ROUTE_EXPORT_TO_TERRA,
+  ROUTE_MANIFEST_DOWNLOAD,
 } from "../../../../../site-config/hca-dcp/dev/export/constants";
 import {
   processAggregatedOrArrayValue,
@@ -562,6 +563,23 @@ export const buildExportMethodHeroCurlCommand = (
   return getExportMethodHero(tabValue, title);
 };
 
+/**
+ * Build props for manifest download Hero component.
+ * @param _ - Unused.
+ * @param viewContext - View context.
+ * @returns model to be used as props for the Hero component.
+ */
+export const buildExportMethodHeroManifestDownload = (
+  _: Unused,
+  viewContext: ViewContext
+): React.ComponentProps<typeof C.BackPageHero> => {
+  const title = "Request File Manifest";
+  const {
+    exploreState: { tabValue },
+  } = viewContext;
+  return getExportMethodHero(tabValue, title);
+};
+
 /**
  * Build props for export to terra Hero component.
  * @param _ - Unused.
@@ -579,6 +597,21 @@ export const buildExportMethodHeroTerra = (
   return getExportMethodHero(tabValue, title);
 };
 
+/**
+ * Build props for ExportMethod component for display of the manifest download section.
+ * @returns model to be used as props for the ExportMethod component.
+ */
+export const buildExportMethodManifestDownload = (): React.ComponentProps<
+  typeof C.ExportMethod
+> => ({
+  buttonLabel: "Request File Manifest",
+  description:
+    "Request a file manifest for the current query containing the full list of selected files and the metadata for each file.",
+  disabled: false,
+  route: ROUTE_MANIFEST_DOWNLOAD,
+  title: "Download a File Manifest with Metadata for the Selected Data",
+});
+
 /**
  * Build props for ExportMethod component for display of the export to terra section.
  * @returns model to be used as props for the ExportMethod component.
@@ -797,6 +830,34 @@ export const buildLibraryConstructionApproach = (
   };
 };
 
+/**
+ * Build props for ManifestDownload component.
+ * @param _ - Unused.
+ * @param viewContext - View context.
+ * @returns model to be used as props for the ManifestDownload component.
+ */
+export const buildManifestDownload = (
+  _: Unused,
+  viewContext: ViewContext
+): React.ComponentProps<typeof C.ManifestDownload> => {
+  const {
+    exploreState: { filterState },
+    fileManifestState,
+  } = viewContext;
+  // Get the form facets.
+  const formFacet = getFormFacets(fileManifestState);
+  return {
+    ManifestDownloadForm: C.ManifestDownloadForm,
+    ManifestDownloadStart: MDX.ManifestDownloadStart,
+    ManifestDownloadSuccess: MDX.ManifestDownloadSuccess,
+    fileManifestState,
+    fileManifestType: FILE_MANIFEST_TYPE.DOWNLOAD_MANIFEST,
+    fileSummaryFacetName: HCA_DCP_CATEGORY_KEY.FILE_FORMAT,
+    filters: filterState,
+    formFacet,
+  };
+};
+
 /**
  * Build props for the project title Link component from the given entity response.
  * @param projectsResponse - Response model return from the entity response API.

explorer/package-lock.json

@@ -33,7 +33,7 @@
     "test:anvil-catalog": "playwright test -c playwright_anvil-catalog.config.ts"
   },
   "dependencies": {
-    "@clevercanary/data-explorer-ui": "0.42.0",
+    "@clevercanary/data-explorer-ui": "0.43.0",
     "@emotion/react": "11.11.1",
     "@emotion/styled": "11.11.0",
     "@mdx-js/loader": "^2.3.0",

explorer/package.json

@@ -0,0 +1,12 @@
+import { ExportMethodView } from "@clevercanary/data-explorer-ui/lib/views/ExportMethodView/exportMethodView";
+import React from "react";
+
+/**
+ * Export method page.
+ * @returns export method view component.
+ */
+const ExportMethodPage = (): JSX.Element => {
+  return <ExportMethodView />;
+};
+
+export default ExportMethodPage;

explorer/pages/export/download-manifest.tsx

@@ -1,2 +1,3 @@
 export const ROUTE_BULK_DOWNLOAD = "/export/get-curl-command";
 export const ROUTE_EXPORT_TO_TERRA = "/export/export-to-terra";
+export const ROUTE_MANIFEST_DOWNLOAD = "/export/download-manifest";

explorer/site-config/hca-dcp/dev/export/constants.ts

@@ -5,7 +5,11 @@ import {
 import * as C from "app/components";
 import * as MDX from "../../../../app/content/hca-dcp";
 import * as V from "../../../../app/viewModelBuilders/azul/hca-dcp/common/viewModelBuilders";
-import { ROUTE_BULK_DOWNLOAD, ROUTE_EXPORT_TO_TERRA } from "./constants";
+import {
+  ROUTE_BULK_DOWNLOAD,
+  ROUTE_EXPORT_TO_TERRA,
+  ROUTE_MANIFEST_DOWNLOAD,
+} from "./constants";
 
 export const exportConfig: ExportConfig = {
   exportMethods: [
@@ -24,6 +28,21 @@ export const exportConfig: ExportConfig = {
         } as ComponentConfig<typeof C.BackPageHero>,
       ],
     },
+    {
+      mainColumn: [
+        {
+          component: C.ManifestDownload,
+          viewBuilder: V.buildManifestDownload,
+        } as ComponentConfig<typeof C.ManifestDownload>,
+      ],
+      route: ROUTE_MANIFEST_DOWNLOAD,
+      top: [
+        {
+          component: C.BackPageHero,
+          viewBuilder: V.buildExportMethodHeroManifestDownload,
+        } as ComponentConfig<typeof C.BackPageHero>,
+      ],
+    },
     {
       mainColumn: [
         {
@@ -49,6 +68,10 @@ export const exportConfig: ExportConfig = {
           component: C.ExportMethod,
           viewBuilder: V.buildExportMethodBulkDownload,
         } as ComponentConfig<typeof C.ExportMethod>,
+        {
+          component: C.ExportMethod,
+          viewBuilder: V.buildExportMethodManifestDownload,
+        } as ComponentConfig<typeof C.ExportMethod>,
         {
           component: C.ExportMethod,
           viewBuilder: V.buildExportMethodTerra,