Adds explicit SavedObjectsRespository error type for 404 that do not originate from Elasticsearch responses

docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) &gt; [createGenericNotFoundEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md)
+
+## SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError() method
+
+<b>Signature:</b>
+
+```typescript
+static createGenericNotFoundEsUnavailableError(type?: string | null, id?: string | null): DecoratedError;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | <code>string &#124; null</code> |  |
+|  id | <code>string &#124; null</code> |  |
+
+<b>Returns:</b>
+
+`DecoratedError`
+

docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) &gt; [isNotFoundEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md)
+
+## SavedObjectsErrorHelpers.isNotFoundEsUnavailableError() method
+
+<b>Signature:</b>
+
+```typescript
+static isNotFoundEsUnavailableError(error: Error | DecoratedError): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  error | <code>Error &#124; DecoratedError</code> |  |
+
+<b>Returns:</b>
+
+`boolean`
+

docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md

@@ -18,6 +18,7 @@ export declare class SavedObjectsErrorHelpers
 |  [createBadRequestError(reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) | <code>static</code> |  |
 |  [createConflictError(type, id, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) | <code>static</code> |  |
 |  [createGenericNotFoundError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) | <code>static</code> |  |
+|  [createGenericNotFoundEsUnavailableError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md) | <code>static</code> |  |
 |  [createIndexAliasNotFoundError(alias)](./kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md) | <code>static</code> |  |
 |  [createInvalidVersionError(versionInput)](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) | <code>static</code> |  |
 |  [createTooManyRequestsError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) | <code>static</code> |  |
@@ -41,6 +42,7 @@ export declare class SavedObjectsErrorHelpers
 |  [isInvalidVersionError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md) | <code>static</code> |  |
 |  [isNotAuthorizedError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md) | <code>static</code> |  |
 |  [isNotFoundError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md) | <code>static</code> |  |
+|  [isNotFoundEsUnavailableError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfoundesunavailableerror.md) | <code>static</code> |  |
 |  [isRequestEntityTooLargeError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md) | <code>static</code> |  |
 |  [isSavedObjectsClientError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md) | <code>static</code> |  |
 |  [isTooManyRequestsError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md) | <code>static</code> |  |

src/core/server/elasticsearch/client/mocks.ts

@@ -139,15 +139,16 @@ export type MockedTransportRequestPromise<T> = TransportRequestPromise<T> & {
   abort: jest.MockedFunction<() => undefined>;
 };
 
-const createSuccessTransportRequestPromise = <T>(
+const createSuccessTransportRequestPromise = <T, U>(
   body: T,
-  { statusCode = 200 }: { statusCode?: number } = {}
-): MockedTransportRequestPromise<ApiResponse<T>> => {
-  const response = createApiResponse({ body, statusCode });
+  { statusCode = 200 }: { statusCode?: number } = {},
+  headers?: U
+): MockedTransportRequestPromise<ApiResponse<T, U>> => {
+  const response = createApiResponse({ body, statusCode, headers });
   const promise = Promise.resolve(response);
-  (promise as MockedTransportRequestPromise<ApiResponse<T>>).abort = jest.fn();
+  (promise as MockedTransportRequestPromise<ApiResponse<T, U>>).abort = jest.fn();
 
-  return promise as MockedTransportRequestPromise<ApiResponse<T>>;
+  return promise as MockedTransportRequestPromise<ApiResponse<T, U>>;
 };
 
 const createErrorTransportRequestPromise = (err: any): MockedTransportRequestPromise<never> => {

src/core/server/saved_objects/service/lib/errors.test.ts

@@ -439,4 +439,55 @@ describe('savedObjectsClient/errorTypes', () => {
       });
     });
   });
+
+  describe('NotFoundEsUnavailableError', () => {
+    it('makes an error identifiable as an EsUnavailable error', () => {
+      const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError();
+      expect(SavedObjectsErrorHelpers.isEsUnavailableError(error)).toBe(true);
+    });
+
+    it('makes an error identifiable as an NotFoundEsUnavailableError error', () => {
+      const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError();
+      expect(SavedObjectsErrorHelpers.isNotFoundEsUnavailableError(error)).toBe(true);
+    });
+
+    it('returns a boom error', () => {
+      const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError();
+      expect(error).toHaveProperty('isBoom', true);
+    });
+
+    it('decorates the error message with the saved object that was not found', () => {
+      const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError('foo', 'bar');
+      expect(error.output.payload).toHaveProperty(
+        'message',
+        'x-elastic-product not present or not recognized: Saved object [foo/bar] not found'
+      );
+    });
+
+    describe('error.output', () => {
+      it('prefixes Not Found message with passed reason', () => {
+        const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError();
+        expect(error.output.payload).toHaveProperty(
+          'message',
+          'x-elastic-product not present or not recognized: Not Found'
+        );
+      });
+
+      it('specifies the saved object that was not found', () => {
+        const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError(
+          'foo',
+          'bar'
+        );
+        expect(error.output.payload).toHaveProperty(
+          'message',
+          'x-elastic-product not present or not recognized: Saved object [foo/bar] not found'
+        );
+      });
+
+      it('sets statusCode to 503', () => {
+        const error = SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError();
+        expect(error.output).toHaveProperty('statusCode', 503);
+      });
+    });
+  });
 });

src/core/server/saved_objects/service/lib/errors.ts

@@ -202,4 +202,23 @@ export class SavedObjectsErrorHelpers {
   public static isGeneralError(error: Error | DecoratedError) {
     return isSavedObjectsClientError(error) && error[code] === CODE_GENERAL_ERROR;
   }
+
+  public static createGenericNotFoundEsUnavailableError(
+    type: string | null = null,
+    id: string | null = null
+  ) {
+    const notFoundError = this.createGenericNotFoundError(type, id);
+    return this.decorateEsUnavailableError(
+      new Error(`${notFoundError.message}`),
+      `x-elastic-product not present or not recognized`
+    );
+  }
+
+  public static isNotFoundEsUnavailableError(error: Error | DecoratedError) {
+    return (
+      isSavedObjectsClientError(error) &&
+      error[code] === CODE_ES_UNAVAILABLE &&
+      error.message.startsWith('x-elastic-product not present or not recognized:')
+    );
+  }
 }