Add multi-index aggregation query to Guppy API

Author: craigrbarnes

packages/core/src/features/guppy/guppySlice.ts

@@ -1,12 +1,7 @@
 import useSWR, { Fetcher, SWRResponse } from 'swr';
 import { AggregationsData, JSONObject, StatsData } from '../../types';
 import { Accessibility, GEN3_GUPPY_API } from '../../constants';
-import {
-  convertFilterSetToGqlFilter,
-  FilterSet,
-  GQLFilter,
-  isFilterEmpty,
-} from '../filters';
+import { convertFilterSetToGqlFilter, FilterSet, GQLFilter, isFilterEmpty, } from '../filters';
 import { guppyApi, guppyApiSliceRequest } from './guppyApi';
 import { RangeQueryRequest, SharedFieldMapping } from './types';
 import { groupSharedFields } from './utils';
@@ -111,6 +106,11 @@ interface ObjectIdQueryResponse {
   index: string;
 }
 
+interface MultiIndexFieldQueryRequest {
+  indexAndFields: Array<QueryAggsParams>;
+  accessibility?: Accessibility;
+}
+
 export const explorerTags = guppyApi.enhanceEndpoints({
   addTagTypes: ['AGGS', 'COUNTS', 'STATS', 'TABLE_DATA', 'RAW_DATA'] as const,
 });
@@ -616,6 +616,35 @@ export const explorerApi = explorerTags.injectEndpoints({
         };
       },
     }),
+    getGetMultiIndexAggregation: builder.query<
+      ObjectIdQueryResponse,
+      MultiIndexFieldQueryRequest
+    >({
+      query: ({
+        indexAndFields,
+        accessibility = Accessibility.ALL,
+      }: MultiIndexFieldQueryRequest) => {
+        // build each query
+        const filters = indexAndFields.reduce(
+          (acc, curr) => {
+            acc[curr.type] = convertFilterSetToGqlFilter(curr.filters);
+            return acc;
+          },
+          {} as Record<string, GQLFilter>,
+        );
+        const query = buildMultiIndexAggregationQuery(indexAndFields);
+        return {
+          query,
+          variables: {
+            ...filters,
+            accessibility,
+          },
+        };
+      },
+      transformResponse: (response: Record<string, any>) => {
+        return response?.data?._aggregation ?? {};
+      },
+    }),
     generalGQL: builder.query<Record<string, unknown>, guppyApiSliceRequest>({
       query: ({ query, variables }) => {
         return {
@@ -645,6 +674,32 @@ export const useGetIndexFields = (index: string, indexPrefix = '') => {
   return data ?? [];
 };
 
+const buildMultiIndexAggregationQuery = (
+  indexesAndFields: Array<QueryAggsParams>,
+  filterBasename: string = 'filter',
+) => {
+  const filterNames = indexesAndFields.reduce(
+    (acc, curr) => acc + `$${curr.type}${filterBasename}: JSON,`,
+    '',
+  );
+
+  let queryString = `query getAggs (${filterNames}) {`;
+
+  indexesAndFields.forEach((indexQuery) => {
+    queryString += `  ${indexQuery.type}_aggregation {
+      ${indexQuery.type} (filter: ${indexQuery.type}${filterBasename}, filterSelf: ${indexQuery.filterSelf ? 'true' : 'false'}, accessibility: ${indexQuery.accessibility}) { _totalCount
+    `;
+    queryString += indexQuery.fields.map((field: string) =>
+      histogramQueryStrForEachField(field),
+    );
+    queryString += ' } }';
+  });
+
+  queryString += '}';
+
+  return queryString;
+};
+
 export const buildGetAggregationQuery = (
   type: string,
   fields: ReadonlyArray<string>,
@@ -730,4 +785,6 @@ export const {
   useLazyCustomRangeQuery,
   useGetObjectIdsQuery,
   useLazyGetObjectIdsQuery,
+  useGetGetMultiIndexAggregationQuery,
+  useLazyGetGetMultiIndexAggregationQuery,
 } = explorerApi;

packages/core/src/features/guppy/queryGenerators.ts

@@ -23,6 +23,7 @@ export const histogramQueryStrForEachField = (field: string): string => {
   if (splittedFieldArray.length === 0) {
     return `
     ${splittedField} {
+      _totalCount
       histogram {
         key
         count