[RND-326] Adding total count from open search (#98)

* Adding total count from open search * Adding total-count headers to unit tests
Ed-Fi-Exchange-OSS · Sep 6, 2022 · f7bdc99 · f7bdc99
1 parent 920f47f
commit f7bdc99
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/Meadowlark-js/backends/meadowlark-opensearch-backend/src/repository/QueryOpensearch.ts b/Meadowlark-js/backends/meadowlark-opensearch-backend/src/repository/QueryOpensearch.ts
@@ -72,6 +72,7 @@ export async function queryDocuments(request: QueryRequest, client: Client): Pro
   Logger.debug(`Building query`, traceId);
 
   let documents: any = [];
+  let recordCount: number;
   try {
     let query = `SELECT info FROM ${indexFromResourceInfo(resourceInfo)}`;
     let whereClause: string = '';
@@ -99,6 +100,7 @@ export async function queryDocuments(request: QueryRequest, client: Client): Pro
     Logger.debug(`meadowlark-opensearch-backend: queryDocuments executing query: ${query}`, traceId);
 
     const { body } = await performSqlQuery(client, query);
+    recordCount = body.total;
     Logger.debug(`Result: ${JSON.stringify(body)}`, traceId);
     documents = body.datarows.map((datarow) => JSON.parse(datarow));
   } catch (e) {
@@ -118,5 +120,5 @@ export async function queryDocuments(request: QueryRequest, client: Client): Pro
     }
   }
 
-  return { response: 'QUERY_SUCCESS', documents };
+  return { response: 'QUERY_SUCCESS', documents, totalCount: recordCount };
 }
diff --git a/Meadowlark-js/packages/meadowlark-core/src/handler/Query.ts b/Meadowlark-js/packages/meadowlark-core/src/handler/Query.ts
@@ -14,6 +14,7 @@ import { FrontendRequest } from './FrontendRequest';
 import { FrontendResponse } from './FrontendResponse';
 
 const moduleName = 'Query';
+const TOTAL_COUNT_HEADER_NAME: string = 'total-count';
 
 const removeDisallowedQueryParameters = R.omit(['offset', 'limit', 'totalCount']);
 const onlyPaginationParameters = R.pick(['offset', 'limit']);
@@ -54,9 +55,15 @@ export async function query(frontendRequest: FrontendRequest): Promise<FrontendR
 
   writeDebugStatusToLog(moduleName, frontendRequest, 'query', 200);
   const body = JSON.stringify(documents);
+
+  const headers = {
+    ...frontendRequest.middleware.headerMetadata,
+    [TOTAL_COUNT_HEADER_NAME]: result.totalCount?.toString() ?? '0',
+  };
+
   return {
     body,
     statusCode: 200,
-    headers: frontendRequest.middleware.headerMetadata,
+    headers,
   };
 }
diff --git a/Meadowlark-js/packages/meadowlark-core/src/message/QueryResult.ts b/Meadowlark-js/packages/meadowlark-core/src/message/QueryResult.ts
@@ -7,4 +7,5 @@ export type QueryResult = {
   response: 'QUERY_SUCCESS' | 'QUERY_FAILURE_INVALID_QUERY' | 'QUERY_FAILURE_AUTHORIZATION' | 'UNKNOWN_FAILURE';
   documents: Array<object>;
   failureMessage?: string;
+  totalCount?: number;
 };
diff --git a/Meadowlark-js/packages/meadowlark-core/test/handler/Query.test.ts b/Meadowlark-js/packages/meadowlark-core/test/handler/Query.test.ts
@@ -61,6 +61,7 @@ describe('given successful query result', () => {
   let response: FrontendResponse;
   let mockQueryHandler: any;
   const goodResult: object = { goodResult: 'result' };
+  const headers: object = [{ totalCount: '1' }];
 
   beforeAll(async () => {
     mockQueryHandler = jest.spyOn(PluginLoader, 'getQueryHandler').mockReturnValue({
@@ -69,6 +70,7 @@ describe('given successful query result', () => {
         Promise.resolve({
           response: 'QUERY_SUCCESS',
           documents: [goodResult],
+          Headers: headers,
         } as unknown as QueryResult),
     });
 
@@ -84,6 +86,10 @@ describe('given successful query result', () => {
     expect(response.statusCode).toEqual(200);
   });
 
+  it('returns total count of 1', () => {
+    expect(headers[0].totalCount).toEqual('1');
+  });
+
   it('returns 1 result', () => {
     expect(JSON.parse(response.body)).toHaveLength(1);
   });