Fix error message display issue in dev tool console (#3652)

Fix error message display issue in dev tool console When user sends request in the console and result in error, the console will output a customized error message. Signed-off-by: Su <[email protected]>
opensearch-project · Mar 27, 2023 · 53047b6 · 53047b6
1 parent 7efc231
commit 53047b6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/src/core/server/opensearch/client/errors.ts b/src/core/server/opensearch/client/errors.ts
@@ -35,7 +35,7 @@ export type UnauthorizedError = ResponseError & {
 };
 
 export function isResponseError(error: any): error is ResponseError {
-  return Boolean(error.body && error.statusCode && error.headers);
+  return Boolean(error && error.body && error.statusCode && error.headers);
 }
 
 export function isUnauthorizedError(error: any): error is UnauthorizedError {

diff --git a/src/plugins/console/server/routes/api/console/proxy/create_handler.ts b/src/plugins/console/server/routes/api/console/proxy/create_handler.ts
@@ -30,12 +30,14 @@
 
 import { OpenSearchDashboardsRequest, RequestHandler } from 'opensearch-dashboards/server';
 import { trimStart } from 'lodash';
+import { Readable } from 'stream';
 
-import { ResponseError } from '@opensearch-project/opensearch/lib/errors';
 import { ApiResponse } from '@opensearch-project/opensearch/';
 
 // eslint-disable-next-line @osd/eslint/no-restricted-paths
 import { ensureRawRequest } from '../../../../../../../core/server/http/router';
+// eslint-disable-next-line @osd/eslint/no-restricted-paths
+import { isResponseError } from '../../../../../../../core/server/opensearch/client/errors';
 
 import { RouteDependencies } from '../../../';
 
@@ -127,15 +129,22 @@ export const createHandler = ({
       },
     });
   } catch (e: any) {
-    log.error(e);
     const isResponseErrorFlag = isResponseError(e);
+
+    const errorMessage = isResponseErrorFlag ? JSON.stringify(e.meta.body) : e.message;
+    // core http route handler has special logic that asks for stream readable input to pass error opaquely
+    const errorResponseBody = new Readable({
+      read() {
+        this.push(errorMessage);
+        this.push(null);
+      },
+    });
     return response.customError({
       statusCode: isResponseErrorFlag ? e.statusCode : 502,
-      body: isResponseErrorFlag ? JSON.stringify(e.meta.body) : `502.${e.statusCode || 0}`,
+      body: errorResponseBody,
+      headers: {
+        'Content-Type': 'application/json',
+      },
     });
   }
 };
-
-const isResponseError = (error: any): error is ResponseError => {
-  return Boolean(error && error.body && error.statusCode && error.header);
-};