@databiosphere/findable-ui 16.0.0 → 17.0.0

package/src/mocks/useRequestFileManifest.mocks.ts

@@ -0,0 +1,121 @@
+import { Filters, SelectedFilter } from "../common/entities";
+import { FormFacet } from "../components/Export/common/entities";
+import { SiteConfig } from "../config/entities";
+import { FileFacet } from "../hooks/useFileManifest/common/entities";
+import { ConfigContextProps } from "../providers/config";
+import { FileManifestState } from "../providers/fileManifestState";
+
+export const CATALOG: string | undefined = "catalog";
+
+const CATEGORY_KEY_NAME: Record<string, SelectedFilter["categoryKey"]> = {
+  CATEGORY_FILES: "files",
+  CATEGORY_OTHER: "other",
+  CATEGORY_SPECIES: "species",
+};
+
+export const CONFIG = {
+  config: { dataSource: { url: "https://mock-endpoint.com" } } as SiteConfig,
+} as ConfigContextProps;
+
+const FACET_PARTIAL: Pick<
+  FileFacet,
+  "selectedTerms" | "terms" | "termsByName" | "total"
+> = {
+  selectedTerms: [],
+  terms: [],
+  termsByName: new Map(),
+  total: 0,
+}; // `name`, `selected`, `selectedTermCount`, and `termCount` properties are not used in this test.
+
+export const FILE_FACET: Record<string, FileFacet> = {
+  FACET_FILES: {
+    ...FACET_PARTIAL,
+    name: CATEGORY_KEY_NAME.CATEGORY_FILES,
+    selected: false,
+    selectedTermCount: 0,
+    termCount: 2,
+  },
+  FACET_OTHER: {
+    ...FACET_PARTIAL,
+    name: CATEGORY_KEY_NAME.CATEGORY_OTHER,
+    selected: false,
+    selectedTermCount: 0,
+    termCount: 1,
+  },
+  FACET_SPECIES: {
+    ...FACET_PARTIAL,
+    name: CATEGORY_KEY_NAME.CATEGORY_SPECIES,
+    selected: false,
+    selectedTermCount: 0,
+    termCount: 3,
+  },
+};
+
+const FILTER_FILES: SelectedFilter = {
+  categoryKey: CATEGORY_KEY_NAME.CATEGORY_FILES,
+  value: ["file01", "file02"],
+};
+
+const FILTER_FILES_SUBSET: SelectedFilter = {
+  categoryKey: CATEGORY_KEY_NAME.CATEGORY_FILES,
+  value: ["file01"],
+};
+
+const FILTER_OTHER: SelectedFilter = {
+  categoryKey: CATEGORY_KEY_NAME.CATEGORY_OTHER,
+  value: ["other"],
+};
+
+const FILTER_SPECIES: SelectedFilter = {
+  categoryKey: CATEGORY_KEY_NAME.CATEGORY_SPECIES,
+  value: ["species01", "species02", "species03"],
+};
+
+export const FILTERS: Record<string, Filters> = {
+  FORM_COMPLETE_SET: [FILTER_FILES, FILTER_OTHER, FILTER_SPECIES],
+  FORM_INCOMPLETE_SET: [FILTER_FILES, FILTER_OTHER],
+  FORM_INITIAL_SET: [FILTER_OTHER],
+  FORM_SUBSET: [FILTER_FILES_SUBSET, FILTER_OTHER, FILTER_SPECIES],
+};
+
+export const FILE_MANIFEST_STATE = {
+  filters: FILTERS.FORM_INITIAL_SET,
+  isEnabled: true,
+  isLoading: false,
+} as FileManifestState;
+
+export const FORM_FACET: Record<string, FormFacet> = {
+  COMPLETE_SET: {
+    fileSummaryFacet: {
+      ...FILE_FACET.FACET_FILES,
+      selected: true,
+      selectedTermCount: FILE_FACET.FACET_FILES.termCount, // All terms selected.
+    },
+    speciesFacet: {
+      ...FILE_FACET.FACET_SPECIES,
+      selected: true,
+      selectedTermCount: FILE_FACET.FACET_SPECIES.termCount, // All terms selected.
+    },
+  },
+  INCOMPLETE_SET: {
+    fileSummaryFacet: {
+      ...FILE_FACET.FACET_FILES,
+      selected: true,
+      selectedTermCount: FILE_FACET.FACET_FILES.termCount, // All terms selected.
+    },
+    speciesFacet: FILE_FACET.FACET_SPECIES, // Species facet is unselected.
+  },
+  INITIAL_SET: { fileSummaryFacet: undefined, speciesFacet: undefined },
+  SUBSET: {
+    fileSummaryFacet: {
+      ...FILE_FACET.FACET_FILES,
+      selected: true,
+      selectedTermCount: 1, // One of a possible two terms selected.
+    },
+    speciesFacet: {
+      ...FILE_FACET.FACET_SPECIES,
+      selected: true,
+      selectedTermCount: 1, // One of a possible three terms selected.
+    },
+  },
+};

package/src/providers/fileManifestState/constants.ts

@@ -1,23 +1,10 @@
-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,
@@ -25,7 +12,5 @@ export const FILE_MANIFEST_STATE: FileManifestState = {
   isFileSummaryLoading: false,
   isLoading: false,
   isSummaryLoading: false,
-  requestParams: undefined,
-  requestURL: undefined,
   summary: undefined,
 };

package/src/providers/fileManifestState.tsx

@@ -5,10 +5,7 @@ import React, {
   useEffect,
   useReducer,
 } from "react";
-import {
-  AzulSummaryResponse,
-  ManifestDownloadFormat,
-} from "../apis/azul/common/entities";
+import { AzulSummaryResponse } from "../apis/azul/common/entities";
 import { getFilterParameterValue } from "../apis/azul/common/utils";
 import {
   CategoryKey,
@@ -18,27 +15,16 @@ import {
 } from "../common/entities";
 import { useCatalog } from "../hooks/useCatalog";
 import { buildNextFilterState } from "../hooks/useCategoryFilter";
-import { buildFileManifestRequestURL } from "../hooks/useFileManifest/common/buildFileManifestRequestURL";
-import {
-  FileFacet,
-  FileManifestType,
-  FILES_FACETS_STATUS,
-} from "../hooks/useFileManifest/common/entities";
+import { FileFacet } from "../hooks/useFileManifest/common/entities";
 import { useFetchFilesFacets } from "../hooks/useFileManifest/useFetchFilesFacets";
 import { useFetchSummary } from "../hooks/useFileManifest/useFetchSummary";
-import { useFileManifestURL } from "../hooks/useFileManifest/useFileManifestURL";
-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;
@@ -49,8 +35,6 @@ export type FileManifestState = {
   isFileSummaryLoading: boolean;
   isLoading: boolean;
   isSummaryLoading: boolean;
-  requestParams?: URLSearchParams;
-  requestURL?: string;
   summary?: AzulSummaryResponse;
 };
 
@@ -79,13 +63,9 @@ export function FileManifestStateProvider({
   // Determine catalog.
   const catalog = useCatalog() as string; // catalog should be defined.
 
-  // Determine file manifest request data URL.
-  const URL = useFileManifestURL();
-
   // File manifest state.
   const [fileManifestState, fileManifestDispatch] = useReducer(
-    (s: FileManifestState, a: FileManifestAction) =>
-      fileManifestReducer(s, a, { URL, catalog }),
+    (s: FileManifestState, a: FileManifestAction) => fileManifestReducer(s, a),
     FILE_MANIFEST_STATE
   );
 
@@ -154,7 +134,6 @@ export enum FileManifestActionKind {
   ClearFileManifest = "CLEAR_FILE_MANIFEST",
   FetchFileManifest = "FETCH_FILE_MANIFEST",
   UpdateFileManifest = "UPDATE_FILE_MANIFEST",
-  UpdateFileManifestFormat = "UPDATE_FILE_MANIFEST_FORMAT",
   UpdateFilter = "UPDATE_FILTER",
   UpdateFiltersCategory = "UPDATE_FILTERS_CATEGORY",
 }
@@ -166,7 +145,6 @@ export type FileManifestAction =
   | ClearFileManifestAction
   | FetchFileManifestAction
   | UpdateFileManifestAction
-  | UpdateFileManifestFormatAction
   | UpdateFilterAction
   | UpdateFiltersCategoryAction;
 
@@ -194,14 +172,6 @@ type UpdateFileManifestAction = {
   type: FileManifestActionKind.UpdateFileManifest;
 };
 
-/**
- * Update file manifest format action.
- */
-type UpdateFileManifestFormatAction = {
-  payload: ManifestDownloadFormat | undefined;
-  type: FileManifestActionKind.UpdateFileManifestFormat;
-};
-
 /**
  * Update filter action.
  */
@@ -222,8 +192,6 @@ type UpdateFiltersCategoryAction = {
  * Initialize file manifest payload.
  */
 type FetchFileManifestPayload = {
-  fileManifestFormat?: ManifestDownloadFormat;
-  fileManifestType?: FileManifestType;
   fileSummaryFacetName?: string;
   filters: Filters;
 };
@@ -251,38 +219,23 @@ export type UpdateFilterPayload = {
   selectedValue: CategoryValueKey;
 };
 
-/**
- * File manifest context.
- */
-export interface FileManifestContext {
-  catalog: string;
-  URL: string;
-}
-
 /**
  * File manifest reducer.
  * @param state - File manifest state.
  * @param action - File manifest action.
- * @param fileManifestContext - File manifest context.
  * @returns file manifest state.
  */
 function fileManifestReducer(
   state: FileManifestState,
-  action: FileManifestAction,
-  fileManifestContext: FileManifestContext
+  action: FileManifestAction
 ): FileManifestState {
   const { payload, type } = action;
-  const { catalog, URL } = fileManifestContext;
   switch (type) {
     // Resets file manifest.
     case FileManifestActionKind.ClearFileManifest: {
       return {
         ...state,
-        fileManifestFormat: undefined,
-        filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
         isEnabled: false,
-        requestParams: undefined,
-        requestURL: undefined,
       };
     }
     // Fetches file manifest.
@@ -297,30 +250,11 @@ function fileManifestReducer(
         ...payload,
         fileSummaryFilters,
         isEnabled: true,
-        requestParams: undefined,
-        requestURL: undefined,
       };
     }
     // Updates file manifest.
     case FileManifestActionKind.UpdateFileManifest: {
-      return updateFileManifestAction(state, payload, fileManifestContext);
-    }
-    // Updates file manifest format.
-    case FileManifestActionKind.UpdateFileManifestFormat: {
-      // Build request params and request URL.
-      const { requestParams, requestURL } =
-        buildFileManifestRequestURL(
-          URL,
-          getRequestFilters(state),
-          catalog,
-          payload
-        ) || {};
-      return {
-        ...state,
-        fileManifestFormat: payload,
-        requestParams,
-        requestURL,
-      };
+      return { ...state, ...payload };
     }
     // Updates selected file manifest filters with given selected category value.
     case FileManifestActionKind.UpdateFilter: {
@@ -339,10 +273,7 @@ function fileManifestReducer(
       return {
         ...state,
         fileSummaryFilters,
-        filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
         filters,
-        requestParams: undefined,
-        requestURL: undefined,
       };
     }
     // Updates selected file manifest filters by category.
@@ -361,10 +292,7 @@ function fileManifestReducer(
       return {
         ...state,
         fileSummaryFilters,
-        filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
         filters,
-        requestParams: undefined,
-        requestURL: undefined,
       };
     }
     default:

package/src/views/ExportView/exportView.tsx

@@ -4,7 +4,7 @@ import { ComponentCreator } from "../../components/ComponentCreator/ComponentCre
 import { BackPageView } from "../../components/Layout/components/BackPage/backPageView";
 import { useExploreState } from "../../hooks/useExploreState";
 import { useExportConfig } from "../../hooks/useExportConfig";
-import { useRequestFileManifest } from "../../hooks/useFileManifest/useRequestFileManifest";
+import { useFileManifest } from "../../hooks/useFileManifest/useFileManifest";
 import { useUpdateURLSearchParams } from "../../hooks/useUpdateURLSearchParams";
 
 export type ExportViewProps = AzulEntityStaticResponse;
@@ -14,7 +14,7 @@ export const ExportView = (props: ExportViewProps): JSX.Element => {
     exploreState: { filterState },
   } = useExploreState();
   useUpdateURLSearchParams();
-  useRequestFileManifest(undefined, undefined, filterState, undefined);
+  useFileManifest(filterState, undefined);
   const { tabs, top } = useExportConfig();
   const currentTab = tabs[0];
   const { mainColumn, sideColumn } = currentTab;

package/tests/buildRequestFilters.test.ts

@@ -0,0 +1,68 @@
+import { Filters } from "../src/common/entities";
+import { buildRequestFilters } from "../src/hooks/useRequestManifest/utils";
+import {
+  FILE_MANIFEST_STATE,
+  FILTERS,
+  FORM_FACET,
+} from "../src/mocks/useRequestFileManifest.mocks";
+import { FileManifestState } from "../src/providers/fileManifestState";
+
+describe("buildRequestFilters", () => {
+  describe("should return filters from file manifest state", () => {
+    test("when form facet is not defined", () => {
+      const fileManifestState = getFileManifestState(FILTERS.FORM_INITIAL_SET);
+      const result = buildRequestFilters(fileManifestState, {});
+      expect(result).toEqual(fileManifestState.filters);
+    });
+
+    test("when form facet `fileSummaryFacet` and `speciesFacet` are not defined", () => {
+      const fileManifestState = getFileManifestState(FILTERS.FORM_INITIAL_SET);
+      const result = buildRequestFilters(
+        fileManifestState,
+        FORM_FACET.INITIAL_SET
+      );
+      expect(result).toEqual(fileManifestState.filters);
+    });
+
+    test("when at least one form facet has no terms selected", () => {
+      const fileManifestState = getFileManifestState(
+        FILTERS.FORM_INCOMPLETE_SET
+      );
+      const result = buildRequestFilters(
+        fileManifestState,
+        FORM_FACET.INCOMPLETE_SET
+      );
+      expect(result).toEqual(fileManifestState.filters);
+    });
+
+    test("when at least one form facet has an unselected term", () => {
+      const fileManifestState = getFileManifestState(FILTERS.FORM_SUBSET);
+      const result = buildRequestFilters(fileManifestState, FORM_FACET.SUBSET);
+      expect(result).toEqual(fileManifestState.filters);
+    });
+  });
+
+  describe("should return filters excluding form related filters", () => {
+    test("when all form facets have all their terms selected", () => {
+      const fileManifestState = getFileManifestState(FILTERS.FORM_COMPLETE_SET);
+      const result = buildRequestFilters(
+        fileManifestState,
+        FORM_FACET.COMPLETE_SET
+      );
+      expect(result).not.toEqual(fileManifestState.filters);
+      expect(result).toEqual(FILTERS.FORM_INITIAL_SET);
+    });
+  });
+});
+
+/**
+ * Returns a file manifest state with the given filters.
+ * @param filters - Selected filters.
+ * @returns file manifest state.
+ */
+function getFileManifestState(filters: Filters): FileManifestState {
+  return {
+    ...FILE_MANIFEST_STATE,
+    filters,
+  };
+}

package/tests/buildRequestManifest.test.ts

@@ -0,0 +1,103 @@
+import {
+  MANIFEST_DOWNLOAD_FORMAT,
+  ManifestDownloadFormat,
+} from "../src/apis/azul/common/entities";
+import { transformFilters } from "../src/apis/azul/common/filterTransformer";
+import { Filters } from "../src/common/entities";
+import { METHOD } from "../src/hooks/types";
+import { buildRequestManifest } from "../src/hooks/useRequestManifest/utils";
+import { FILTERS } from "../src/mocks/useRequestFileManifest.mocks";
+
+const ENDPOINT_URL = "https://example.com/";
+const CATALOG = "test-catalog";
+const MANIFEST_FORMAT = MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB;
+
+describe("buildRequestManifest", () => {
+  test("should return request method 'PUT'", () => {
+    const result = buildRequestManifest(
+      ENDPOINT_URL,
+      CATALOG,
+      FILTERS.FORM_SUBSET,
+      MANIFEST_FORMAT
+    );
+    expect(result.requestMethod).toEqual(METHOD.PUT);
+  });
+
+  test("should return defined request params and request url", () => {
+    const result = buildRequestManifest(
+      ENDPOINT_URL,
+      CATALOG,
+      FILTERS.FORM_SUBSET,
+      MANIFEST_FORMAT
+    );
+    expect(result.requestParams).toBeDefined();
+    expect(result.requestUrl).toBeDefined();
+  });
+
+  test("should return request params with entries 'catalog', 'filters' and 'format'", () => {
+    const result = buildRequestManifest(
+      ENDPOINT_URL,
+      CATALOG,
+      FILTERS.FORM_SUBSET,
+      MANIFEST_FORMAT
+    );
+    // Assert that the requestParams contains the required keys.
+    expect(result.requestParams?.has("catalog")).toBeTruthy();
+    expect(result.requestParams?.has("filters")).toBeTruthy();
+    expect(result.requestParams?.has("format")).toBeTruthy();
+    // // Assert the values of these keys.
+    expect(result.requestParams?.get("catalog")).toEqual(CATALOG);
+    expect(result.requestParams?.get("filters")).toEqual(
+      transformFilters(FILTERS.FORM_SUBSET)
+    );
+    expect(result.requestParams?.get("format")).toEqual(MANIFEST_FORMAT);
+  });
+
+  test("should return expected request URL", () => {
+    const result = buildRequestManifest(
+      ENDPOINT_URL,
+      CATALOG,
+      FILTERS.FORM_INITIAL_SET,
+      MANIFEST_FORMAT
+    );
+    const expectedParams = getExpectedParams(
+      CATALOG,
+      FILTERS.FORM_INITIAL_SET,
+      MANIFEST_FORMAT
+    );
+    const expectedUrl = getExpectedUrl(expectedParams);
+    expect(result.requestUrl).toEqual(expectedUrl);
+  });
+});
+
+/**
+ * Returns the expected URLSearchParams for the given parameters.
+ * @param catalog - Catalog.
+ * @param filters - Selected filters.
+ * @param manifestFormat - Manifest format.
+ * @returns URLSearchParams.
+ */
+function getExpectedParams(
+  catalog: string,
+  filters: Filters,
+  manifestFormat: ManifestDownloadFormat
+): URLSearchParams {
+  return new URLSearchParams({
+    catalog,
+    filters: transformFilters(filters),
+    format: manifestFormat,
+  });
+}
+
+/**
+ * Returns the expected URL for the given parameters.
+ * @param expectedParams - Expected URLSearchParams.
+ * @param endpointUrl - Data URL.
+ * @returns expected URL.
+ */
+function getExpectedUrl(
+  expectedParams: URLSearchParams,
+  endpointUrl: string = ENDPOINT_URL
+): string {
+  return `${endpointUrl}fetch/manifest/files?${expectedParams.toString()}`;
+}