Create the ftrSoApis FTR plugin

docs/developer/plugin-list.asciidoc

@@ -184,6 +184,10 @@ for use in their own application.
 |Minimal interface for admins to manage files in Kibana.
 
 
+|{kib-repo}blob/{branch}/src/plugins/ftr_apis/README.md[ftrApis]
+|Set of APIs used internally by the FTR.
+
+
 |{kib-repo}blob/{branch}/src/plugins/guided_onboarding/README.md[guidedOnboarding]
 |This plugin contains the code for the Guided Onboarding project. Guided onboarding consists of guides for Solutions (Enterprise Search, Observability, Security) that can be completed as a checklist of steps. The guides help users to ingest their data and to navigate to the correct Solutions pages.
 

packages/kbn-test/src/kbn_client/kbn_client_saved_objects.ts

@@ -7,7 +7,6 @@
  */
 
 import { inspect } from 'util';
-
 import * as Rx from 'rxjs';
 import { mergeMap } from 'rxjs/operators';
 import { isAxiosResponseError } from '@kbn/dev-utils';
@@ -90,6 +89,11 @@ async function concurrently<T>(maxConcurrency: number, arr: T[], fn: (item: T) =
   }
 }
 
+/**
+ * SO client for FTR.
+ *
+ * @remarks: Leverage the `ftrApis` plugin under the hood.
+ */
 export class KbnClientSavedObjects {
   constructor(private readonly log: ToolingLog, private readonly requester: KbnClientRequester) {}
 
@@ -117,8 +121,8 @@ export class KbnClientSavedObjects {
     const { data } = await this.requester.request<SavedObjectResponse<Attributes>>({
       description: 'get saved object',
       path: options.space
-        ? uriencode`/s/${options.space}/api/saved_objects/${options.type}/${options.id}`
-        : uriencode`/api/saved_objects/${options.type}/${options.id}`,
+        ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/${options.type}/${options.id}`
+        : uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`,
       method: 'GET',
     });
     return data;
@@ -133,8 +137,8 @@ export class KbnClientSavedObjects {
     const { data } = await this.requester.request<SavedObjectResponse<Attributes>>({
       description: 'update saved object',
       path: options.id
-        ? uriencode`/api/saved_objects/${options.type}/${options.id}`
-        : uriencode`/api/saved_objects/${options.type}`,
+        ? uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`
+        : uriencode`/internal/ftr/kbn_client_so/${options.type}`,
       query: {
         overwrite: options.overwrite,
       },
@@ -156,7 +160,7 @@ export class KbnClientSavedObjects {
 
     const { data } = await this.requester.request<SavedObjectResponse<Attributes>>({
       description: 'update saved object',
-      path: uriencode`/api/saved_objects/${options.type}/${options.id}`,
+      path: uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`,
       query: {
         overwrite: options.overwrite,
       },
@@ -179,8 +183,8 @@ export class KbnClientSavedObjects {
     const { data } = await this.requester.request({
       description: 'delete saved object',
       path: options.space
-        ? uriencode`/s/${options.space}/api/saved_objects/${options.type}/${options.id}`
-        : uriencode`/api/saved_objects/${options.type}/${options.id}`,
+        ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/${options.type}/${options.id}`
+        : uriencode`/internal/ftr/kbn_client_so/${options.type}/${options.id}`,
       method: 'DELETE',
     });
 
@@ -196,8 +200,8 @@ export class KbnClientSavedObjects {
       const resp = await this.requester.request<FindApiResponse>({
         method: 'GET',
         path: options.space
-          ? uriencode`/s/${options.space}/api/saved_objects/_find`
-          : '/api/saved_objects/_find',
+          ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/_find`
+          : `/internal/ftr/kbn_client_so/_find`,
         query: {
           per_page: 1000,
           type: options.types,
@@ -270,8 +274,8 @@ export class KbnClientSavedObjects {
         await this.requester.request({
           method: 'DELETE',
           path: options.space
-            ? uriencode`/s/${options.space}/api/saved_objects/${obj.type}/${obj.id}?force=true`
-            : uriencode`/api/saved_objects/${obj.type}/${obj.id}?force=true`,
+            ? uriencode`/s/${options.space}/internal/ftr/kbn_client_so/${obj.type}/${obj.id}`
+            : uriencode`/internal/ftr/kbn_client_so/${obj.type}/${obj.id}`,
         });
         deleted++;
       } catch (error) {

src/plugins/ftr_apis/README.md

@@ -0,0 +1,3 @@
+# ftrApis plugin
+
+Set of APIs used internally by the FTR.

src/plugins/ftr_apis/jest.config.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../..',
+  roots: ['<rootDir>/src/plugins/ftr_apis'],
+  coverageDirectory: '<rootDir>/target/kibana-coverage/jest/src/plugins/ftr_apis',
+  coverageReporters: ['text', 'html'],
+  collectCoverageFrom: ['<rootDir>/src/plugins/ftr_apis/{common,public,server}/**/*.{js,ts,tsx}'],
+};

src/plugins/ftr_apis/kibana.json

@@ -0,0 +1,11 @@
+{
+  "id": "ftrApis",
+  "owner": {
+    "name": "Core",
+    "githubTeam": "kibana-core"
+  },
+  "version": "kibana",
+  "configPath": ["ftr_apis"],
+  "server": true,
+  "ui": false
+}

src/plugins/ftr_apis/server/config.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { schema, type TypeOf } from '@kbn/config-schema';
+import type { PluginConfigDescriptor } from '@kbn/core/server';
+
+const configSchema = schema.object({
+  disableApis: schema.boolean({ defaultValue: false }),
+});
+
+export type ConfigType = TypeOf<typeof configSchema>;
+
+export const config: PluginConfigDescriptor<ConfigType> = {
+  schema: configSchema,
+};

src/plugins/ftr_apis/server/index.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { PluginInitializerContext } from '@kbn/core/server';
+import { FtrApisPlugin } from './plugin';
+
+export function plugin(initializerContext: PluginInitializerContext) {
+  return new FtrApisPlugin(initializerContext);
+}
+
+export { config } from './config';

src/plugins/ftr_apis/server/plugin.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { CoreSetup, Plugin, PluginInitializerContext } from '@kbn/core/server';
+import { registerRoutes } from './routes';
+import type { ConfigType } from './config';
+
+export class FtrApisPlugin implements Plugin {
+  private readonly config: ConfigType;
+
+  constructor(initializerContext: PluginInitializerContext) {
+    this.config = initializerContext.config.get<ConfigType>();
+  }
+
+  public setup({ http, savedObjects }: CoreSetup) {
+    const router = http.createRouter();
+    if (!this.config.disableApis) {
+      registerRoutes(router);
+    }
+  }
+
+  public start() {}
+}

src/plugins/ftr_apis/server/routes/index.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { registerKbnClientSoRoutes } from './kbn_client_so';
+
+export const registerRoutes = (router: IRouter) => {
+  registerKbnClientSoRoutes(router);
+};

src/plugins/ftr_apis/server/routes/kbn_client_so/bulk_delete.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerBulkDeleteRoute = (router: IRouter) => {
+  router.post(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/_bulk_delete`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        body: schema.arrayOf(
+          schema.object({
+            type: schema.string(),
+            id: schema.string(),
+          })
+        ),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const { savedObjects } = await ctx.core;
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const statuses = await soClient.bulkDelete(req.body, { force: true });
+      return res.ok({ body: statuses });
+    })
+  );
+};

src/plugins/ftr_apis/server/routes/kbn_client_so/create.ts

@@ -0,0 +1,62 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerCreateRoute = (router: IRouter) => {
+  router.post(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/{type}/{id?}`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        params: schema.object({
+          type: schema.string(),
+          id: schema.maybe(schema.string()),
+        }),
+        query: schema.object({
+          overwrite: schema.boolean({ defaultValue: false }),
+        }),
+        body: schema.object({
+          attributes: schema.recordOf(schema.string(), schema.any()),
+          migrationVersion: schema.maybe(schema.recordOf(schema.string(), schema.string())),
+          references: schema.maybe(
+            schema.arrayOf(
+              schema.object({
+                name: schema.string(),
+                type: schema.string(),
+                id: schema.string(),
+              })
+            )
+          ),
+        }),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const { type, id } = req.params;
+      const { overwrite } = req.query;
+      const { attributes, migrationVersion, references } = req.body;
+      const { savedObjects } = await ctx.core;
+
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const options = {
+        id,
+        overwrite,
+        migrationVersion,
+        references,
+      };
+      const result = await soClient.create(type, attributes, options);
+      return res.ok({ body: result });
+    })
+  );
+};

src/plugins/ftr_apis/server/routes/kbn_client_so/delete.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerDeleteRoute = (router: IRouter) => {
+  router.delete(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/{type}/{id}`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        params: schema.object({
+          type: schema.string(),
+          id: schema.string(),
+        }),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const { type, id } = req.params;
+      const { savedObjects } = await ctx.core;
+
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const result = await soClient.delete(type, id, { force: true });
+      return res.ok({ body: result });
+    })
+  );
+};

src/plugins/ftr_apis/server/routes/kbn_client_so/find.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { IRouter } from '@kbn/core/server';
+import { schema } from '@kbn/config-schema';
+import { KBN_CLIENT_API_PREFIX, listHiddenTypes, catchAndReturnBoomErrors } from './utils';
+
+export const registerFindRoute = (router: IRouter) => {
+  router.get(
+    {
+      path: `${KBN_CLIENT_API_PREFIX}/_find`,
+      options: {
+        tags: ['access:ftrApis'],
+      },
+      validate: {
+        query: schema.object({
+          per_page: schema.number({ min: 0, defaultValue: 20 }),
+          page: schema.number({ min: 0, defaultValue: 1 }),
+          type: schema.oneOf([schema.string(), schema.arrayOf(schema.string())]),
+          search: schema.maybe(schema.string()),
+          fields: schema.maybe(schema.oneOf([schema.string(), schema.arrayOf(schema.string())])),
+        }),
+      },
+    },
+    catchAndReturnBoomErrors(async (ctx, req, res) => {
+      const query = req.query;
+
+      const { savedObjects } = await ctx.core;
+      const hiddenTypes = listHiddenTypes(savedObjects.typeRegistry);
+      const soClient = savedObjects.getClient({ includedHiddenTypes: hiddenTypes });
+
+      const result = await soClient.find({
+        perPage: query.per_page,
+        page: query.page,
+        type: Array.isArray(query.type) ? query.type : [query.type],
+        search: query.search,
+        fields: typeof query.fields === 'string' ? [query.fields] : query.fields,
+      });
+
+      return res.ok({ body: result });
+    })
+  );
+};