fix: add support for inclusion of orphans in verbatim PFB (#264) (#269)

* fix!: add support for inclusion of orphans in verbatim PFB (#264) * feat: added tests for file facets status (#264) * feat: added tests for file manifest request filters (#264) * fix: import (#264) --------- Co-authored-by: Fran McDade <[email protected]>
DataBiosphere · Nov 19, 2024 · 5f295e0 · 5f295e0
1 parent 092ad93
commit 5f295e0
Show file tree

Hide file tree

Showing 14 changed files with 479 additions and 71 deletions.
diff --git a/src/components/Export/components/DownloadCurlCommand/downloadCurlCommand.tsx b/src/components/Export/components/DownloadCurlCommand/downloadCurlCommand.tsx
@@ -32,11 +32,13 @@ export const DownloadCurlCommand = ({
   DownloadCurlStart,
   DownloadCurlSuccess,
   fileManifestState,
+  fileManifestType,
   fileSummaryFacetName,
   filters,
   formFacet,
 }: DownloadCurlCommandProps): JSX.Element => {
   useRequestFileManifest(
+    fileManifestType,
     MANIFEST_DOWNLOAD_FORMAT.CURL,
     filters,
     fileSummaryFacetName

diff --git a/src/components/Export/components/ExportToTerra/exportToTerra.tsx b/src/components/Export/components/ExportToTerra/exportToTerra.tsx
@@ -29,6 +29,7 @@ export const ExportToTerra = ({
   ExportToTerraStart,
   ExportToTerraSuccess,
   fileManifestState,
+  fileManifestType,
   fileSummaryFacetName,
   filters,
   formFacet,
@@ -38,7 +39,12 @@ export const ExportToTerra = ({
   const {
     exploreState: { tabValue: entityList },
   } = useExploreState();
-  useRequestFileManifest(manifestDownloadFormat, filters, fileSummaryFacetName);
+  useRequestFileManifest(
+    fileManifestType,
+    manifestDownloadFormat,
+    filters,
+    fileSummaryFacetName
+  );
   const { requestParams } = fileManifestState;
   const { data, isLoading, run } = useFileManifest();
   const exportURL = useExportToTerraResponseURL(requestParams, data);

diff --git a/.../components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.tsx b/.../components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.tsx
@@ -13,10 +13,16 @@ export interface ManifestDownloadEntityProps {
 }
 
 export const ManifestDownloadEntity = ({
+  fileManifestType,
   filters,
   metadataFilters,
 }: ManifestDownloadEntityProps): JSX.Element => {
-  useRequestFileManifest(MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, undefined);
+  useRequestFileManifest(
+    fileManifestType,
+    MANIFEST_DOWNLOAD_FORMAT.COMPACT,
+    filters,
+    undefined
+  );
   return (
     <>
       <FileManifestSpreadsheet filters={metadataFilters} />

diff --git a/src/components/Export/components/ManifestDownload/manifestDownload.tsx b/src/components/Export/components/ManifestDownload/manifestDownload.tsx
@@ -25,6 +25,7 @@ export interface ManifestDownloadProps {
 
 export const ManifestDownload = ({
   fileManifestState,
+  fileManifestType,
   fileSummaryFacetName,
   filters,
   formFacet,
@@ -33,6 +34,7 @@ export const ManifestDownload = ({
   ManifestDownloadSuccess,
 }: ManifestDownloadProps): JSX.Element => {
   useRequestFileManifest(
+    fileManifestType,
     MANIFEST_DOWNLOAD_FORMAT.COMPACT,
     filters,
     fileSummaryFacetName

diff --git a/src/hooks/useFileManifest/common/buildFileManifestRequestURL.ts b/src/hooks/useFileManifest/common/buildFileManifestRequestURL.ts
@@ -20,13 +20,12 @@ export interface FileManifestRequestURL {
  */
 export const buildFileManifestRequestURL = (
   url: string,
-  filters: Filters,
+  filters: Filters | undefined,
   catalog: string,
   manifestFormat: ManifestDownloadFormat | undefined
 ): FileManifestRequestURL | undefined => {
-  if (!manifestFormat) {
-    return;
-  }
+  if (!manifestFormat) return;
+  if (!filters) return;
 
   // Build request params.
   const requestParams = new URLSearchParams({

diff --git a/src/hooks/useFileManifest/common/entities.ts b/src/hooks/useFileManifest/common/entities.ts
@@ -37,21 +37,20 @@ export interface FileFacet {
 export enum FILE_MANIFEST_TYPE {
   BULK_DOWNLOAD = "BULK_DOWNLOAD",
   DOWNLOAD_MANIFEST = "DOWNLOAD_MANIFEST",
-  ENITY_EXPORT_TO_TERRA = "ENITY_EXPORT_TO_TERRA",
   ENTITY_BULK_DOWNLOAD = "ENTITY_BULK_DOWNLOAD",
   ENTITY_DOWNLOAD_MANIFEST = "ENTITY_DOWNLOAD_MANIFEST",
+  ENTITY_EXPORT_TO_TERRA = "ENTITY_EXPORT_TO_TERRA",
   EXPORT_TO_TERRA = "EXPORT_TO_TERRA",
 }
 
 export type FileManifestType = FILE_MANIFEST_TYPE;
 
-export enum FILE_MANIFEST_STATE_STATUS {
-  ACTIVE = "ACTIVE",
-  INACTIVE = "INACTIVE",
+export enum FILES_FACETS_STATUS {
+  COMPLETED = "COMPLETED",
+  IN_PROGRESS = "IN_PROGRESS",
+  NOT_STARTED = "NOT_STARTED",
 }
 
-export type FileManifestStateStatus = FILE_MANIFEST_STATE_STATUS;
-
 export type SelectedSearchTermsBySearchKey = Map<
   CategoryKey,
   Set<CategoryValueKey>

diff --git a/src/hooks/useFileManifest/useRequestFileManifest.ts b/src/hooks/useFileManifest/useRequestFileManifest.ts
@@ -3,14 +3,17 @@ import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
 import { Filters } from "../../common/entities";
 import { FileManifestActionKind } from "../../providers/fileManifestState";
 import { useFileManifestState } from "../useFileManifestState";
+import { FileManifestType } from "./common/entities";
 
 /**
  * Initializes and fetches file manifest comprising file facets and summary for the given file manifest format.
+ * @param fileManifestType - File manifest type.
  * @param fileManifestFormat - File manifest format.
  * @param initialFilters - Filters to initialize file manifest request.
  * @param fileSummaryFacetName - File summary facet name.
  */
 export const useRequestFileManifest = (
+  fileManifestType: FileManifestType | undefined,
   fileManifestFormat: ManifestDownloadFormat | undefined,
   initialFilters: Filters | undefined = [],
   fileSummaryFacetName?: string
@@ -26,6 +29,7 @@ export const useRequestFileManifest = (
     fileManifestDispatch({
       payload: {
         fileManifestFormat,
+        fileManifestType,
         fileSummaryFacetName,
         filters: initFilters,
       },
@@ -40,6 +44,7 @@ export const useRequestFileManifest = (
   }, [
     fileManifestDispatch,
     fileManifestFormat,
+    fileManifestType,
     fileSummaryFacetName,
     initFilters,
   ]);

diff --git a/src/providers/fileManifestState.tsx b/src/providers/fileManifestState.tsx
@@ -19,36 +19,26 @@ import {
 import { useCatalog } from "../hooks/useCatalog";
 import { buildNextFilterState } from "../hooks/useCategoryFilter";
 import { buildFileManifestRequestURL } from "../hooks/useFileManifest/common/buildFileManifestRequestURL";
-import { FileFacet } from "../hooks/useFileManifest/common/entities";
+import {
+  FileFacet,
+  FileManifestType,
+  FILES_FACETS_STATUS,
+} from "../hooks/useFileManifest/common/entities";
 import { useFetchFilesFacets } from "../hooks/useFileManifest/useFetchFilesFacets";
 import { useFetchSummary } from "../hooks/useFileManifest/useFetchSummary";
 import { useFileManifestURL } from "../hooks/useFileManifest/useFileManifestURL";
-
-// Default file manifest state.
-export const DEFAULT_FILE_MANIFEST_STATE = {
-  fileManifestFormat: undefined,
-  fileSummary: undefined,
-  fileSummaryFacetName: undefined,
-  fileSummaryFilters: [],
-  filesFacets: [],
-  filters: [],
-  isEnabled: false,
-  isFacetsLoading: false,
-  isFacetsSuccess: false,
-  isFileSummaryLoading: false,
-  isLoading: false,
-  isSummaryLoading: false,
-  requestParams: undefined,
-  requestURL: undefined,
-  summary: undefined,
-};
+import { updateFileManifestAction } from "./fileManifestState/actions";
+import { FILE_MANIFEST_STATE } from "./fileManifestState/constants";
+import { getRequestFilters } from "./fileManifestState/utils";
 
 /**
  * File manifest state.
  */
 export type FileManifestState = {
   fileManifestFormat?: ManifestDownloadFormat;
+  fileManifestType?: FileManifestType;
   filesFacets: FileFacet[];
+  filesFacetsStatus: FILES_FACETS_STATUS;
   fileSummary?: AzulSummaryResponse;
   fileSummaryFacetName?: string;
   fileSummaryFilters: Filters;
@@ -76,7 +66,7 @@ export const FileManifestStateContext =
   createContext<FileManifestStateContextProps>({
     // eslint-disable-next-line @typescript-eslint/no-empty-function -- allow dummy function for default state.
     fileManifestDispatch: () => {},
-    fileManifestState: DEFAULT_FILE_MANIFEST_STATE,
+    fileManifestState: FILE_MANIFEST_STATE,
   });
 
 export interface FileManifestStateProps {
@@ -96,7 +86,7 @@ export function FileManifestStateProvider({
   const [fileManifestState, fileManifestDispatch] = useReducer(
     (s: FileManifestState, a: FileManifestAction) =>
       fileManifestReducer(s, a, { URL, catalog }),
-    DEFAULT_FILE_MANIFEST_STATE
+    FILE_MANIFEST_STATE
   );
 
   const { fileSummaryFacetName, fileSummaryFilters, filters, isEnabled } =
@@ -233,14 +223,15 @@ type UpdateFiltersCategoryAction = {
  */
 type FetchFileManifestPayload = {
   fileManifestFormat?: ManifestDownloadFormat;
+  fileManifestType?: FileManifestType;
   fileSummaryFacetName?: string;
   filters: Filters;
 };
 
 /**
  * Update file manifest payload.
  */
-type UpdateFileManifestPayload = {
+export type UpdateFileManifestPayload = {
   filesFacets: FileFacet[];
   fileSummary?: AzulSummaryResponse;
   isFacetsLoading: boolean;
@@ -288,6 +279,7 @@ function fileManifestReducer(
       return {
         ...state,
         fileManifestFormat: undefined,
+        filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
         isEnabled: false,
         requestParams: undefined,
         requestURL: undefined,
@@ -300,35 +292,29 @@ function fileManifestReducer(
         payload.filters,
         payload.fileSummaryFacetName
       );
-      // Build request params and request URL.
-      const { requestParams, requestURL } =
-        buildFileManifestRequestURL(
-          URL,
-          payload.filters,
-          catalog,
-          payload.fileManifestFormat
-        ) || {};
       return {
         ...state,
         ...payload,
         fileSummaryFilters,
         isEnabled: true,
-        requestParams,
-        requestURL,
+        requestParams: undefined,
+        requestURL: undefined,
       };
     }
     // Updates file manifest.
     case FileManifestActionKind.UpdateFileManifest: {
-      return {
-        ...state,
-        ...payload,
-      };
+      return updateFileManifestAction(state, payload, fileManifestContext);
     }
     // Updates file manifest format.
     case FileManifestActionKind.UpdateFileManifestFormat: {
       // Build request params and request URL.
       const { requestParams, requestURL } =
-        buildFileManifestRequestURL(URL, state.filters, catalog, payload) || {};
+        buildFileManifestRequestURL(
+          URL,
+          getRequestFilters(state),
+          catalog,
+          payload
+        ) || {};
       return {
         ...state,
         fileManifestFormat: payload,
@@ -350,20 +336,13 @@ function fileManifestReducer(
         filters,
         state.fileSummaryFacetName
       );
-      // Build request params and request URL.
-      const { requestParams, requestURL } =
-        buildFileManifestRequestURL(
-          URL,
-          filters,
-          catalog,
-          state.fileManifestFormat
-        ) || {};
       return {
         ...state,
         fileSummaryFilters,
+        filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
         filters,
-        requestParams,
-        requestURL,
+        requestParams: undefined,
+        requestURL: undefined,
       };
     }
     // Updates selected file manifest filters by category.
@@ -379,20 +358,13 @@ function fileManifestReducer(
         filters,
         state.fileSummaryFacetName
       );
-      // Build request params and request URL.
-      const { requestParams, requestURL } =
-        buildFileManifestRequestURL(
-          URL,
-          filters,
-          catalog,
-          state.fileManifestFormat
-        ) || {};
       return {
         ...state,
         fileSummaryFilters,
+        filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
         filters,
-        requestParams,
-        requestURL,
+        requestParams: undefined,
+        requestURL: undefined,
       };
     }
     default:

diff --git a/src/providers/fileManifestState/actions.ts b/src/providers/fileManifestState/actions.ts
@@ -0,0 +1,34 @@
+import { buildFileManifestRequestURL } from "../../hooks/useFileManifest/common/buildFileManifestRequestURL";
+import {
+  FileManifestContext,
+  FileManifestState,
+  UpdateFileManifestPayload,
+} from "../fileManifestState";
+import { getRequestFilters, updateFilesFacetsStatus } from "./utils";
+
+/**
+ * Update file manifest action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @param context - Context.
+ * @returns state.
+ */
+export function updateFileManifestAction(
+  state: FileManifestState,
+  payload: UpdateFileManifestPayload,
+  context: FileManifestContext
+): FileManifestState {
+  const { catalog, URL } = context;
+  const filesFacetsStatus = updateFilesFacetsStatus(state, payload);
+  const nextState = { ...state, ...payload, filesFacetsStatus };
+  const fileManifestRequest = buildFileManifestRequestURL(
+    URL,
+    getRequestFilters(nextState),
+    catalog,
+    nextState.fileManifestFormat
+  );
+  return {
+    ...nextState,
+    ...fileManifestRequest,
+  };
+}
diff --git a/src/providers/fileManifestState/constants.ts b/src/providers/fileManifestState/constants.ts
@@ -0,0 +1,31 @@
+import {
+  FILE_MANIFEST_TYPE,
+  FILES_FACETS_STATUS,
+} from "../../hooks/useFileManifest/common/entities";
+import { FileManifestState } from "../fileManifestState";
+
+export const ENTITIES_FILE_MANIFEST_TYPES: FILE_MANIFEST_TYPE[] = [
+  FILE_MANIFEST_TYPE.BULK_DOWNLOAD,
+  FILE_MANIFEST_TYPE.DOWNLOAD_MANIFEST,
+  FILE_MANIFEST_TYPE.EXPORT_TO_TERRA,
+];
+
+export const FILE_MANIFEST_STATE: FileManifestState = {
+  fileManifestFormat: undefined,
+  fileManifestType: undefined,
+  fileSummary: undefined,
+  fileSummaryFacetName: undefined,
+  fileSummaryFilters: [],
+  filesFacets: [],
+  filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
+  filters: [],
+  isEnabled: false,
+  isFacetsLoading: false,
+  isFacetsSuccess: false,
+  isFileSummaryLoading: false,
+  isLoading: false,
+  isSummaryLoading: false,
+  requestParams: undefined,
+  requestURL: undefined,
+  summary: undefined,
+};