[fix/UiSettings] ignore certain errors (#13079)

* [SavedObjectClient] emit detectable errors

* [uiSettingsService] consume new SavedObjectsClient errors

* [SavedObjectsClient] expose errorTypeHelpers as such

* [elasticsearch/tests] recreate error for each test

* [http] wait for elasticsearch plugin to be ready

* [shortUrl/tests] ensure that create request responds with 200

* [shortUrl] use errorTypeHelpers to filter errors

* [uiSettings/savedObjectsClientStub] stub errorTypeHelpers

* [SavedObjectsClient/errors] expose error module so tests can make errors

* [shortUrl/tests] use actual SavedObjectsClient errors

* [uiSettings/savedObjectsClientStub] use actual errors lib

* [SavedObjectsClient] use decorate instead of "wrap"

* [server/routes/uiSettings] refactor routes to forward Boom errors from uiSettings

* [uiSettings] colocate routes and service

* [testUtils/esTestCluster] use more standard api style

* [testUtils/es] add createCallCluster util

* [testUtils/esTestCluster] add getters for client/callCluster

* [es/healthcheck] ensure that healtcheck stops when server is stopped

* [uiSettings/routes] add param/payload validation

* [uiSettings/routes] add tests that verify error behaviors

(cherry picked from commit 8a64872)

package.json

@@ -105,7 +105,7 @@
     "babel-register": "6.18.0",
     "bluebird": "2.9.34",
     "body-parser": "1.12.0",
-    "boom": "2.8.0",
+    "boom": "5.2.0",
     "brace": "0.5.1",
     "bunyan": "1.7.1",
     "check-hash": "1.0.1",

src/core_plugins/elasticsearch/lib/__tests__/cluster.js

@@ -104,10 +104,12 @@ describe('plugins/elasticsearch', function () {
 
       describe('wrap401Errors', () => {
         let handler;
-        const error = new Error('Authentication required');
-        error.statusCode = 401;
+        let error;
 
         beforeEach(() => {
+          error = new Error('Authentication required');
+          error.statusCode = 401;
+
           handler = sinon.stub();
         });
 

src/core_plugins/kibana/index.js

@@ -5,7 +5,6 @@ import { mkdirp as mkdirpNode } from 'mkdirp';
 
 import manageUuid from './server/lib/manage_uuid';
 import search from './server/routes/api/search';
-import settings from './server/routes/api/settings';
 import { scrollSearchApi } from './server/routes/api/scroll_search';
 import { importApi } from './server/routes/api/import';
 import { exportApi } from './server/routes/api/export';
@@ -143,7 +142,6 @@ export default function (kibana) {
       manageUuid(server);
       // routes
       search(server);
-      settings(server);
       scripts(server);
       scrollSearchApi(server);
       importApi(server);

src/core_plugins/kibana/server/lib/handle_es_error.js

@@ -11,7 +11,7 @@ export default function handleESError(error) {
     error instanceof esErrors.ServiceUnavailable ||
     error instanceof esErrors.NoConnections ||
     error instanceof esErrors.RequestTimeout) {
-    return Boom.serverTimeout(error);
+    return Boom.serverUnavailable(error);
   } else if (error instanceof esErrors.Conflict || _.contains(error.message, 'index_template_already_exists')) {
     return Boom.conflict(error);
   } else if (error instanceof esErrors[403]) {

src/server/http/__tests__/index.js

@@ -70,6 +70,8 @@ describe('routes', () => {
 
     it('redirects shortened urls', (done) => {
       kbnTestServer.makeRequest(kbnServer, shortenOptions, (res) => {
+        expect(res).to.have.property('statusCode', 200);
+
         const gotoOptions = {
           method: 'GET',
           url: '/goto/' + res.payload

src/server/http/__tests__/short_url_lookup.js

@@ -1,6 +1,7 @@
 import expect from 'expect.js';
 import sinon from 'sinon';
 import shortUrlLookupProvider from '../short_url_lookup';
+import { SavedObjectsClient } from '../../saved_objects/client';
 
 describe('shortUrlLookupProvider', () => {
   const ID = 'bf00ad16941fc51420f91a93428b27a0';
@@ -17,7 +18,8 @@ describe('shortUrlLookupProvider', () => {
     savedObjectsClient = {
       get: sandbox.stub(),
       create: sandbox.stub().returns(Promise.resolve({ id: ID })),
-      update: sandbox.stub()
+      update: sandbox.stub(),
+      errors: SavedObjectsClient.errors
     };
 
     req = { getSavedObjectsClient: () => savedObjectsClient };
@@ -58,10 +60,8 @@ describe('shortUrlLookupProvider', () => {
     });
 
     it('gracefully handles version conflict', async () => {
-      const error = new Error('version conflict');
-      error.data = { type: 'version_conflict_engine_exception' };
+      const error = savedObjectsClient.errors.decorateConflictError(new Error());
       savedObjectsClient.create.throws(error);
-
       const id = await shortUrl.generateUrlId(URL, req);
       expect(id).to.eql(ID);
     });

src/server/http/short_url_lookup.js

@@ -17,22 +17,24 @@ export default function (server) {
   return {
     async generateUrlId(url, req) {
       const id = crypto.createHash('md5').update(url).digest('hex');
+      const savedObjectsClient = req.getSavedObjectsClient();
+      const { isConflictError } = savedObjectsClient.errors;
 
       try {
-        const doc = await req.getSavedObjectsClient().create('url', {
+        const doc = await savedObjectsClient.create('url', {
           url,
           accessCount: 0,
           createDate: new Date(),
           accessDate: new Date()
         }, { id });
 
         return doc.id;
-      } catch(e) {
-        if (get(e, 'data.type') === 'version_conflict_engine_exception') {
+      } catch (error) {
+        if (isConflictError(error)) {
           return id;
         }
 
-        throw e;
+        throw error;
       }
     },
 

src/server/saved_objects/client/lib/__tests__/decorate_es_error.js

@@ -0,0 +1,89 @@
+import expect from 'expect.js';
+import { errors as esErrors } from 'elasticsearch';
+
+import { decorateEsError } from '../decorate_es_error';
+import {
+  isEsUnavailableError,
+  isConflictError,
+  isNotAuthorizedError,
+  isForbiddenError,
+  isNotFoundError,
+  isBadRequestError,
+} from '../errors';
+
+describe('savedObjectsClient/decorateEsError', () => {
+  it('always returns the same error it receives', () => {
+    const error = new Error();
+    expect(decorateEsError(error)).to.be(error);
+  });
+
+  it('makes es.ConnectionFault a SavedObjectsClient/EsUnavailable error', () => {
+    const error = new esErrors.ConnectionFault();
+    expect(isEsUnavailableError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isEsUnavailableError(error)).to.be(true);
+  });
+
+  it('makes es.ServiceUnavailable a SavedObjectsClient/EsUnavailable error', () => {
+    const error = new esErrors.ServiceUnavailable();
+    expect(isEsUnavailableError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isEsUnavailableError(error)).to.be(true);
+  });
+
+  it('makes es.NoConnections a SavedObjectsClient/EsUnavailable error', () => {
+    const error = new esErrors.NoConnections();
+    expect(isEsUnavailableError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isEsUnavailableError(error)).to.be(true);
+  });
+
+  it('makes es.RequestTimeout a SavedObjectsClient/EsUnavailable error', () => {
+    const error = new esErrors.RequestTimeout();
+    expect(isEsUnavailableError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isEsUnavailableError(error)).to.be(true);
+  });
+
+  it('makes es.Conflict a SavedObjectsClient/Conflict error', () => {
+    const error = new esErrors.Conflict();
+    expect(isConflictError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isConflictError(error)).to.be(true);
+  });
+
+  it('makes es.AuthenticationException a SavedObjectsClient/NotAuthorized error', () => {
+    const error = new esErrors.AuthenticationException();
+    expect(isNotAuthorizedError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isNotAuthorizedError(error)).to.be(true);
+  });
+
+  it('makes es.Forbidden a SavedObjectsClient/Forbidden error', () => {
+    const error = new esErrors.Forbidden();
+    expect(isForbiddenError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isForbiddenError(error)).to.be(true);
+  });
+
+  it('makes es.NotFound a SavedObjectsClient/NotFound error', () => {
+    const error = new esErrors.NotFound();
+    expect(isNotFoundError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isNotFoundError(error)).to.be(true);
+  });
+
+  it('makes es.BadRequest a SavedObjectsClient/BadRequest error', () => {
+    const error = new esErrors.BadRequest();
+    expect(isBadRequestError(error)).to.be(false);
+    expect(decorateEsError(error)).to.be(error);
+    expect(isBadRequestError(error)).to.be(true);
+  });
+
+  it('returns other errors as Boom errors', () => {
+    const error = new Error();
+    expect(error).to.not.have.property('isBoom');
+    expect(decorateEsError(error)).to.be(error);
+    expect(error).to.have.property('isBoom');
+  });
+});