fix: current query (#890) (#3606)

Author: frano-m

explorer/app/viewModelBuilders/azul/anvil-cmg/common/viewModelBuilders.ts

@@ -1,5 +1,8 @@
 import { LABEL } from "@clevercanary/data-explorer-ui/lib/apis/azul/common/entities";
-import { Filters } from "@clevercanary/data-explorer-ui/lib/common/entities";
+import {
+  Filters,
+  SelectedFilter,
+} from "@clevercanary/data-explorer-ui/lib/common/entities";
 import { CallToAction } from "@clevercanary/data-explorer-ui/lib/components/common/Button/components/CallToActionButton/callToActionButton";
 import { CurrentQuery } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ExportSummary/components/ExportCurrentQuery/exportCurrentQuery";
 import { Summary } from "@clevercanary/data-explorer-ui/lib/components/Export/components/ExportSummary/components/ExportSelectedDataSummary/exportSelectedDataSummary";
@@ -327,9 +330,9 @@ export const buildExportCurrentQuery = (): React.ComponentProps<
   typeof C.ExportCurrentQuery
 > => {
   return {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars -- filters is unused.
-    getExportCurrentQueries: (filters: Filters, filesFacets: FileFacet[]) =>
-      getExportCurrentQueries(filesFacets),
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars -- filesFacets is unused.
+    getExportCurrentQueries: (filters: Filters) =>
+      getExportCurrentQueries(filters),
   };
 };
 
@@ -647,20 +650,16 @@ function getDatasetCallToAction(
 
 /**
  * Returns current queries from the given selected file facets.
- * @param filesFacets - Files facets.
+ * @param filters - filters.
  * @returns current queries.
  */
-export function getExportCurrentQueries(
-  filesFacets: FileFacet[]
-): CurrentQuery[] {
+export function getExportCurrentQueries(filters: Filters): CurrentQuery[] {
   const categoryKeyLabel = mapCategoryKeyLabel(
     ANVIL_CMG_CATEGORY_KEY,
     ANVIL_CMG_CATEGORY_LABEL
   );
-  // Return all selected facets, as a list of current queries.
-  return filesFacets
-    .filter(isFacetSelected)
-    .map((facet) => mapCurrentQuery(facet, categoryKeyLabel));
+  // Return all selected filters, as a list of current queries.
+  return filters.map((filter) => mapCurrentQuery(filter, categoryKeyLabel));
 }
 
 /**
@@ -699,28 +698,19 @@ export function getExportSelectedDataSummary(
   ]);
 }
 
-/**
- * Returns true if the facet is selected.
- * @param facet - Facet.
- * @returns returns true if the facet is selected.
- */
-function isFacetSelected(facet: FileFacet): boolean {
-  return facet.selected;
-}
-
 /**
  * Returns current query for the given facet.
- * @param facet - File facet.
+ * @param filter - Selected filter.
  * @param categoryKeyLabel - Map of category key to category label.
  * @returns current query.
  */
 function mapCurrentQuery(
-  facet: FileFacet,
+  filter: SelectedFilter,
   categoryKeyLabel: CategoryKeyLabel
 ): CurrentQuery {
-  const { name, selectedTerms } = facet;
+  const { categoryKey, value: values } = filter;
   return [
-    categoryKeyLabel.get(name) || name,
-    selectedTerms.map(({ name }) => sanitizeString(name)),
+    categoryKeyLabel.get(categoryKey) || categoryKey,
+    values.map((value) => sanitizeString(value)),
   ];
 }

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

@@ -1,5 +1,8 @@
 import { LABEL } from "@clevercanary/data-explorer-ui/lib/apis/azul/common/entities";
-import { Filters } from "@clevercanary/data-explorer-ui/lib/common/entities";
+import {
+  Filters,
+  SelectedFilter,
+} from "@clevercanary/data-explorer-ui/lib/common/entities";
 import { Breadcrumb } from "@clevercanary/data-explorer-ui/lib/components/common/Breadcrumbs/breadcrumbs";
 import {
   Key,
@@ -424,27 +427,6 @@ export const buildEstimateCellCount = (
   };
 };
 
-/**
- * Build props for entity related ExportCurrentQuery component.
- * @returns model to be used as props for the ExportCurrentQuery component.
- */
-export const buildExportEntityCurrentQuery = (): React.ComponentProps<
-  typeof C.ExportCurrentQuery
-> => {
-  return {
-    getExportCurrentQueries: (
-      filters: Filters,
-      filesFacets: FileFacet[]
-    ): CurrentQuery[] => {
-      // Grab the project facet.
-      const projectFacet = getSelectedProjectFacet(filesFacets);
-      // Initialize the selected facets with the project facet.
-      const facets = projectFacet ? [projectFacet] : [];
-      return getExportCurrentQueries(filesFacets, facets);
-    },
-  };
-};
-
 /**
  * Build props for ExportCurrentQuery component.
  * @returns model to be used as props for the ExportCurrentQuery component.
@@ -454,7 +436,7 @@ export const buildExportCurrentQuery = (): React.ComponentProps<
 > => {
   return {
     getExportCurrentQueries: (filters: Filters, filesFacets: FileFacet[]) =>
-      getExportCurrentQueries(filesFacets),
+      getExportCurrentQueries(filters, filesFacets),
   };
 };
 
@@ -1070,28 +1052,23 @@ export function getEstimatedCellCount(
 
 /**
  * Returns current queries from the given selected file facets.
+ * @param filters - Filters.
  * @param filesFacets - Files facets.
- * @param facets - Selected facets i.e. for entity related queries.
  * @returns current queries.
  */
 export function getExportCurrentQueries(
-  filesFacets: FileFacet[],
-  facets: FileFacet[] = []
+  filters: Filters,
+  filesFacets: FileFacet[]
 ): CurrentQuery[] {
   const categoryKeyLabel = mapCategoryKeyLabel(
     HCA_DCP_CATEGORY_KEY,
     HCA_DCP_CATEGORY_LABEL
   );
-  // Grab all selected facets.
-  // Entity related current queries should always return the project facet as a selected facet as there is no equivalent
-  // file facet for project id.
-  return filesFacets
-    .filter(isFacetSelected)
-    .reduce((acc, facet) => {
-      acc.push(facet);
-      return acc;
-    }, facets)
-    .map((facet) => mapCurrentQuery(facet, categoryKeyLabel));
+  // Return all selected filters, as a list of current queries.
+  // Replace any selected filter projectIds with project facet terms.
+  return filters
+    .map((filter) => mapProjectIdToProject(filter, filesFacets))
+    .map((filter) => mapCurrentQuery(filter, categoryKeyLabel));
 }
 
 /**
@@ -1135,6 +1112,17 @@ function getExportMethodHero(
   };
 }
 
+/**
+ * Returns file facet term names.
+ * @param facet - File facet.
+ * @returns file facet term names.
+ */
+function getFacetTerms(facet: FileFacet | undefined): string[] {
+  return (
+    facet?.terms.map(({ name }) => sanitizeString(name)) || [LABEL.UNSPECIFIED]
+  );
+}
+
 /**
  * Returns generated matrices actions column def.
  * @returns actions column def.
@@ -1324,27 +1312,6 @@ export function getProjectBreadcrumbs(
   return breadcrumbs;
 }
 
-/**
- * Returns project facet as a selected facet, using the project terms as the selected terms.
- * @param filesFacets - Files facets.
- * @returns selected project facet.
- */
-function getSelectedProjectFacet(
-  filesFacets: FileFacet[]
-): FileFacet | undefined {
-  const projectFacet = findProjectFacet(filesFacets);
-  if (!projectFacet) {
-    return;
-  }
-  return {
-    ...projectFacet,
-    name: HCA_DCP_CATEGORY_KEY.PROJECT,
-    selected: true, // Forcing project facet to be selected.
-    selectedTermCount: projectFacet.terms.length, // Selected term count will be equal to the number of terms.
-    selectedTerms: projectFacet.terms, // Selected terms will equal all terms.
-  };
-}
-
 /**
  * Returns project file formats from the projects API response.
  * @param projectsResponse - Response returned from projects API response.
@@ -1383,37 +1350,32 @@ function getProjectTitleUrl(projectsResponse: ProjectsResponse): string {
 }
 
 /**
- * Returns project file facet.
+ * Returns file facet for the given facet name.
+ * @param facetName - Facet name.
  * @param filesFacets - Files facets.
  * @returns project file facet.
  */
-function findProjectFacet(filesFacets: FileFacet[]): FileFacet | undefined {
-  return filesFacets.find(({ name }) => name === HCA_DCP_CATEGORY_KEY.PROJECT);
-}
-
-/**
- * Returns true if the facet is selected.
- * @param facet - Facet.
- * @returns returns true if the facet is selected.
- */
-function isFacetSelected(facet: FileFacet): boolean {
-  return facet.selected;
+function findFacet(
+  facetName: string,
+  filesFacets: FileFacet[]
+): FileFacet | undefined {
+  return filesFacets.find(({ name }) => name === facetName);
 }
 
 /**
  * Returns current query for the given facet.
- * @param facet - File facet.
+ * @param filter - Selected filter.
  * @param categoryKeyLabel - Map of category key to category label.
  * @returns current query.
  */
 function mapCurrentQuery(
-  facet: FileFacet,
+  filter: SelectedFilter,
   categoryKeyLabel: CategoryKeyLabel
 ): CurrentQuery {
-  const { name, selectedTerms } = facet;
+  const { categoryKey, value: values } = filter;
   return [
-    categoryKeyLabel.get(name) || name,
-    selectedTerms.map(({ name }) => sanitizeString(name)),
+    categoryKeyLabel.get(categoryKey) || categoryKey,
+    values.map((value) => sanitizeString(value)),
   ];
 }
 
@@ -1441,6 +1403,26 @@ function mapFileTypeCounts(
   );
 }
 
+/**
+ * Returns the project facet name and terms as a selected filter in lieu of selected filter of category project id.
+ * @param filter - Selected filter.
+ * @param filesFacets - Files facets.
+ * @returns selected filter.
+ */
+function mapProjectIdToProject(
+  filter: SelectedFilter,
+  filesFacets: FileFacet[]
+): SelectedFilter {
+  if (filter.categoryKey === HCA_DCP_CATEGORY_KEY.PROJECT_ID) {
+    const projectFacet = findFacet(HCA_DCP_CATEGORY_KEY.PROJECT, filesFacets);
+    return {
+      categoryKey: HCA_DCP_CATEGORY_KEY.PROJECT,
+      value: getFacetTerms(projectFacet),
+    };
+  }
+  return filter;
+}
+
 /**
  * Returns the aggregated total cells from cellSuspensions for the given entity response.
  * @param entityResponse - Response model return from entity API.

explorer/site-config/hca-dcp/dev/detail/project/exportSideColumn.ts

@@ -8,7 +8,7 @@ export const sideColumn: ComponentConfig[] = [
     children: [
       {
         component: C.ExportCurrentQuery,
-        viewBuilder: V.buildExportEntityCurrentQuery,
+        viewBuilder: V.buildExportCurrentQuery,
       } as ComponentConfig<typeof C.ExportCurrentQuery>,
       {
         component: C.ExportSelectedDataSummary,

explorer/site-config/hca-dcp/dev/detail/project/projectFilesSideColumn.ts

@@ -8,7 +8,7 @@ export const sideColumn: ComponentConfig[] = [
     children: [
       {
         component: C.ExportCurrentQuery,
-        viewBuilder: V.buildExportEntityCurrentQuery,
+        viewBuilder: V.buildExportCurrentQuery,
       } as ComponentConfig<typeof C.ExportCurrentQuery>,
       {
         component: C.ExportSelectedDataSummary,