[RND-641] Adds QUERY_FAILURE_INDEX_NOT_FOUND as a QueryResult response (

#298) * Adds QUERY_FAILURE_INDEX_NOT_FOUND as a QueryResult * Changes on elasticsearch.
Ed-Fi-Exchange-OSS · Sep 21, 2023 · aab3e45 · aab3e45
1 parent e4eb344
commit aab3e45
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 7 deletions.
diff --git a/...ark-js/backends/meadowlark-elasticsearch-backend/src/repository/ElasticSearchException.ts b/...ark-js/backends/meadowlark-elasticsearch-backend/src/repository/ElasticSearchException.ts
@@ -50,7 +50,7 @@ export async function handleElasticSearchError(
               if (responseException?.message.indexOf('index_not_found_exception') !== -1) {
                 Logger.warn(`${moduleName} ${documentProcessError} index not found`, traceId);
                 return {
-                  response: 'QUERY_FAILURE_INVALID_QUERY',
+                  response: 'QUERY_FAILURE_INDEX_NOT_FOUND',
                   documents: [],
                   failureMessage: 'IndexNotFoundException',
                 };

diff --git a/...-js/backends/meadowlark-elasticsearch-backend/test/integration/QueryElasticsearch.test.ts b/...-js/backends/meadowlark-elasticsearch-backend/test/integration/QueryElasticsearch.test.ts
@@ -133,7 +133,7 @@ describe('When querying for documents', () => {
         invalidResourceInfo.projectName = 'wrong-project';
         const result = await queryDocuments(setupQueryRequest({}, {}, invalidResourceInfo), client);
 
-        expect(result.response).toEqual('QUERY_FAILURE_INVALID_QUERY');
+        expect(result.response).toEqual('QUERY_FAILURE_INDEX_NOT_FOUND');
         expect(result.documents).toHaveLength(0);
         expect(result.totalCount).toBeUndefined();
       });

diff --git a/Meadowlark-js/backends/meadowlark-opensearch-backend/src/repository/OpenSearchException.ts b/Meadowlark-js/backends/meadowlark-opensearch-backend/src/repository/OpenSearchException.ts
@@ -45,7 +45,7 @@ export async function handleOpenSearchError(
               if (responseException?.message.indexOf('index_not_found_exception') !== -1) {
                 Logger.warn(`${moduleName} ${documentProcessError} index not found`, traceId);
                 return {
-                  response: 'QUERY_FAILURE_INVALID_QUERY',
+                  response: 'QUERY_FAILURE_INDEX_NOT_FOUND',
                   documents: [],
                   failureMessage: 'IndexNotFoundException',
                 };
@@ -65,7 +65,7 @@ export async function handleOpenSearchError(
                     // No object has been uploaded for the requested type
                     Logger.warn(`${moduleName} ${documentProcessError} index not found`, traceId);
                     return {
-                      response: 'QUERY_FAILURE_INVALID_QUERY',
+                      response: 'QUERY_FAILURE_INDEX_NOT_FOUND',
                       documents: [],
                       failureMessage: 'IndexNotFoundException',
                     };

diff --git a/...owlark-js/backends/meadowlark-opensearch-backend/test/integration/QueryOpensearch.test.ts b/...owlark-js/backends/meadowlark-opensearch-backend/test/integration/QueryOpensearch.test.ts
@@ -133,7 +133,7 @@ describe('When querying for documents', () => {
         invalidResourceInfo.projectName = 'wrong-project';
         const result = await queryDocuments(setupQueryRequest({}, {}, invalidResourceInfo), client);
 
-        expect(result.response).toEqual('QUERY_FAILURE_INVALID_QUERY');
+        expect(result.response).toEqual('QUERY_FAILURE_INDEX_NOT_FOUND');
         expect(result.documents).toHaveLength(0);
         expect(result.totalCount).toBeUndefined();
       });

diff --git a/Meadowlark-js/packages/meadowlark-core/src/handler/Query.ts b/Meadowlark-js/packages/meadowlark-core/src/handler/Query.ts
@@ -67,7 +67,7 @@ export async function query(frontendRequest: FrontendRequest): Promise<FrontendR
     return { statusCode: 500, headers: frontendRequest.middleware.headerMetadata };
   }
 
-  if (response === 'QUERY_FAILURE_INVALID_QUERY' && result.failureMessage !== 'IndexNotFoundException') {
+  if (response === 'QUERY_FAILURE_INVALID_QUERY') {
     const invalidQueryHeaders = {
       ...frontendRequest.middleware.headerMetadata,
       [TOTAL_COUNT_HEADER_NAME]: result.totalCount?.toString() ?? '0',
@@ -79,6 +79,16 @@ export async function query(frontendRequest: FrontendRequest): Promise<FrontendR
       headers: invalidQueryHeaders,
     };
   }
+
+  if (response === 'QUERY_FAILURE_INDEX_NOT_FOUND') {
+    const invalidQueryHeaders = {
+      ...frontendRequest.middleware.headerMetadata,
+      [TOTAL_COUNT_HEADER_NAME]: '0',
+    };
+    writeDebugStatusToLog(moduleName, frontendRequest, 'query', 200);
+    return { statusCode: 200, headers: invalidQueryHeaders, body: documents };
+  }
+
   writeDebugStatusToLog(moduleName, frontendRequest, 'query', 200);
 
   const headers = {

diff --git a/Meadowlark-js/packages/meadowlark-core/src/message/QueryResult.ts b/Meadowlark-js/packages/meadowlark-core/src/message/QueryResult.ts
@@ -4,7 +4,12 @@
 // See the LICENSE and NOTICES files in the project root for more information.
 
 export type QueryResult = {
-  response: 'QUERY_SUCCESS' | 'QUERY_FAILURE_INVALID_QUERY' | 'QUERY_FAILURE_AUTHORIZATION' | 'UNKNOWN_FAILURE';
+  response:
+    | 'QUERY_SUCCESS'
+    | 'QUERY_FAILURE_INVALID_QUERY'
+    | 'QUERY_FAILURE_AUTHORIZATION'
+    | 'UNKNOWN_FAILURE'
+    | 'QUERY_FAILURE_INDEX_NOT_FOUND';
   documents: Array<object>;
   failureMessage?: string;
   totalCount?: number;