[Enterprise Search] Added App Search log settings routes (#82162) (#82652)

JasonStoltz · web-flow · commit c76865975896 · 2020-11-04T17:43:43.000-08:00
diff --git a/x-pack/plugins/enterprise_search/server/plugin.ts b/x-pack/plugins/enterprise_search/server/plugin.ts
@@ -41,6 +41,7 @@ import { appSearchTelemetryType } from './saved_objects/app_search/telemetry';
 import { registerTelemetryUsageCollector as registerASTelemetryUsageCollector } from './collectors/app_search/telemetry';
 import { registerEnginesRoute } from './routes/app_search/engines';
 import { registerCredentialsRoutes } from './routes/app_search/credentials';
+import { registerSettingsRoutes } from './routes/app_search/settings';
 
 import { workplaceSearchTelemetryType } from './saved_objects/workplace_search/telemetry';
 import { registerTelemetryUsageCollector as registerWSTelemetryUsageCollector } from './collectors/workplace_search/telemetry';
@@ -128,6 +129,7 @@ export class EnterpriseSearchPlugin implements Plugin {
     registerConfigDataRoute(dependencies);
     registerEnginesRoute(dependencies);
     registerCredentialsRoutes(dependencies);
+    registerSettingsRoutes(dependencies);
     registerWSOverviewRoute(dependencies);
     registerWSGroupRoutes(dependencies);
 
diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/settings.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/settings.test.ts
@@ -0,0 +1,74 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { MockRouter, mockRequestHandler, mockDependencies } from '../../__mocks__';
+
+import { registerSettingsRoutes } from './settings';
+
+describe('log settings routes', () => {
+  describe('GET /api/app_search/log_settings', () => {
+    let mockRouter: MockRouter;
+
+    beforeEach(() => {
+      jest.clearAllMocks();
+      mockRouter = new MockRouter({ method: 'get' });
+
+      registerSettingsRoutes({
+        ...mockDependencies,
+        router: mockRouter.router,
+      });
+    });
+
+    it('creates a request to enterprise search', () => {
+      mockRouter.callRoute({});
+
+      expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({
+        path: '/as/log_settings',
+      });
+    });
+  });
+
+  describe('PUT /api/app_search/log_settings', () => {
+    let mockRouter: MockRouter;
+
+    beforeEach(() => {
+      jest.clearAllMocks();
+      mockRouter = new MockRouter({ method: 'put', payload: 'body' });
+
+      registerSettingsRoutes({
+        ...mockDependencies,
+        router: mockRouter.router,
+      });
+    });
+
+    it('creates a request to enterprise search', () => {
+      expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({
+        path: '/as/log_settings',
+      });
+    });
+
+    describe('validates', () => {
+      it('validates good data', () => {
+        const request = {
+          body: {
+            analytics: { enabled: true },
+            api: { enabled: true },
+          },
+        };
+        mockRouter.shouldValidate(request);
+      });
+
+      it('rejects bad data', () => {
+        const request = {
+          body: {
+            foo: 'bar',
+          },
+        };
+        mockRouter.shouldThrow(request);
+      });
+    });
+  });
+});
diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/settings.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/settings.ts
@@ -0,0 +1,49 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { schema } from '@kbn/config-schema';
+
+import { IRouteDependencies } from '../../plugin';
+
+export function registerSettingsRoutes({
+  router,
+  enterpriseSearchRequestHandler,
+}: IRouteDependencies) {
+  router.get(
+    {
+      path: '/api/app_search/log_settings',
+      validate: false,
+    },
+    enterpriseSearchRequestHandler.createRequest({
+      path: '/as/log_settings',
+    })
+  );
+
+  router.put(
+    {
+      path: '/api/app_search/log_settings',
+      validate: {
+        body: schema.object({
+          api: schema.maybe(
+            schema.object({
+              enabled: schema.boolean(),
+            })
+          ),
+          analytics: schema.maybe(
+            schema.object({
+              enabled: schema.boolean(),
+            })
+          ),
+        }),
+      },
+    },
+    async (context, request, response) => {
+      return enterpriseSearchRequestHandler.createRequest({
+        path: '/as/log_settings',
+      })(context, request, response);
+    }
+  );
+}
