clarify error handling with comments and small variable name refactor

elastic · Apr 8, 2021 · 3156eb6 · 3156eb6
1 parent b810dcd
commit 3156eb6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts b/src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts
@@ -17,8 +17,10 @@ interface EsErrorHandlerParams {
   handleCustomError?: () => IKibanaResponse<any>;
 }
 
-/*
+/**
  * For errors returned by the new elasticsearch js client.
+ *
+ * @throws If "error" is not an error from the elasticsearch client this handler will throw "error".
  */
 export const handleEsError = ({
   error,

diff --git a/x-pack/plugins/ingest_pipelines/server/routes/api/get.ts b/x-pack/plugins/ingest_pipelines/server/routes/api/get.ts
@@ -31,11 +31,13 @@ export const registerGetRoutes = ({
 
         return res.ok({ body: deserializePipelines(pipelines) });
       } catch (error) {
-        const errorResponse = handleEsError({ error, response: res });
-        if (errorResponse.status === 404) {
+        const esErrorResponse = handleEsError({ error, response: res });
+        if (esErrorResponse.status === 404) {
+          // ES returns 404 when there are no pipelines
+          // Instead, we return an empty array and 200 status back to the client
           return res.ok({ body: [] });
         }
-        return errorResponse;
+        return esErrorResponse;
       }
     })
   );