fix: add modelId and used index name to the log (#4186)

Author: adrians5j

packages/api-headless-cms-ddb-es/src/operations/entry/elasticsearch/logIgnoredEsResponseError.ts

@@ -0,0 +1,23 @@
+import WebinyError from "@webiny/error";
+import { CmsModel } from "@webiny/api-headless-cms/types";
+
+interface LogIgnoredElasticsearchExceptionParams {
+    error: WebinyError;
+    model: CmsModel;
+    indexName: string;
+}
+
+export const logIgnoredEsResponseError = (params: LogIgnoredElasticsearchExceptionParams) => {
+    const { error, indexName, model } = params;
+
+    console.log(`Ignoring Elasticsearch response error: ${error.message}`, {
+        modelId: model.modelId,
+        usedIndexName: indexName,
+        error: {
+            message: error.message,
+            code: error.code,
+            data: error.data,
+            stack: error.stack
+        }
+    });
+};

packages/api-headless-cms-ddb-es/src/operations/entry/elasticsearch/shouldIgnoreEsResponseError.ts

@@ -0,0 +1,10 @@
+import WebinyError from "@webiny/error";
+
+const IGNORED_ES_SEARCH_EXCEPTIONS = [
+    "index_not_found_exception",
+    "search_phase_execution_exception"
+];
+
+export const shouldIgnoreEsResponseError = (error: WebinyError) => {
+    return IGNORED_ES_SEARCH_EXCEPTIONS.includes(error.message);
+};

packages/api-headless-cms-ddb-es/src/operations/entry/index.ts

@@ -40,6 +40,8 @@ import {
 } from "@webiny/api-elasticsearch/types";
 import { CmsEntryStorageOperations, CmsIndexEntry } from "~/types";
 import { createElasticsearchBody } from "./elasticsearch/body";
+import { logIgnoredEsResponseError } from "./elasticsearch/logIgnoredEsResponseError";
+import { shouldIgnoreEsResponseError } from "./elasticsearch/shouldIgnoreEsResponseError";
 import { createLatestRecordType, createPublishedRecordType, createRecordType } from "./recordType";
 import { StorageOperationsCmsModelPlugin } from "@webiny/api-headless-cms";
 import { WriteRequest } from "@webiny/aws-sdk/client-dynamodb";
@@ -63,24 +65,6 @@ export interface CreateEntriesStorageOperationsParams {
     plugins: PluginsContainer;
 }
 
-const IGNORED_ES_SEARCH_EXCEPTIONS = [
-    "index_not_found_exception",
-    "search_phase_execution_exception"
-];
-
-const shouldIgnoreElasticsearchException = (ex: WebinyError) => {
-    if (IGNORED_ES_SEARCH_EXCEPTIONS.includes(ex.message)) {
-        console.log(`Ignoring Elasticsearch exception: ${ex.message}`);
-        console.log({
-            code: ex.code,
-            data: ex.data,
-            stack: ex.stack
-        });
-        return true;
-    }
-    return false;
-};
-
 export const createEntriesStorageOperations = (
     params: CreateEntriesStorageOperationsParams
 ): CmsEntryStorageOperations => {
@@ -303,10 +287,6 @@ export const createEntriesStorageOperations = (
             })
         ];
 
-        const { index } = configurations.es({
-            model
-        });
-
         if (isPublished) {
             items.push(
                 entity.putBatch({
@@ -1096,21 +1076,28 @@ export const createEntriesStorageOperations = (
                 index,
                 body
             });
-        } catch (ex) {
+        } catch (error) {
             /**
              * We will silently ignore the `index_not_found_exception` error and return an empty result set.
              * This is because the index might not exist yet, and we don't want to throw an error.
              */
-            if (shouldIgnoreElasticsearchException(ex)) {
+            if (shouldIgnoreEsResponseError(error)) {
+                logIgnoredEsResponseError({
+                    error,
+                    model,
+                    indexName: index
+                });
+
                 return {
                     hasMoreItems: false,
                     totalCount: 0,
                     cursor: null,
                     items: []
                 };
             }
-            throw new WebinyError(ex.message, ex.code || "ELASTICSEARCH_ERROR", {
-                error: ex,
+
+            throw new WebinyError(error.message, error.code || "ELASTICSEARCH_ERROR", {
+                error,
                 index,
                 body,
                 model
@@ -1807,15 +1794,21 @@ export const createEntriesStorageOperations = (
                 index,
                 body
             });
-        } catch (ex) {
-            if (shouldIgnoreElasticsearchException(ex)) {
+        } catch (error) {
+            if (shouldIgnoreEsResponseError(error)) {
+                logIgnoredEsResponseError({
+                    error,
+                    model,
+                    indexName: index
+                });
                 return [];
             }
+
             throw new WebinyError(
-                ex.message || "Error in the Elasticsearch query.",
-                ex.code || "ELASTICSEARCH_ERROR",
+                error.message || "Error in the Elasticsearch query.",
+                error.code || "ELASTICSEARCH_ERROR",
                 {
-                    error: ex,
+                    error,
                     index,
                     model,
                     body