[Search][Onboarding] Empty State page endpoints

x-pack/plugins/search_indices/common/index.ts

@@ -7,3 +7,5 @@
 
 export const PLUGIN_ID = 'searchIndices';
 export const PLUGIN_NAME = 'searchIndices';
+
+export type { IndicesStatusResponse, UserStartPrivilegesResponse } from './types';

x-pack/plugins/search_indices/common/types.ts

@@ -0,0 +1,17 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface IndicesStatusResponse {
+  indexNames: string[];
+}
+
+export interface UserStartPrivilegesResponse {
+  privileges: {
+    canCreateApiKeys: boolean;
+    canCreateIndex: boolean;
+  };
+}

x-pack/plugins/search_indices/server/lib/status.test.ts

@@ -0,0 +1,231 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type {
+  IndicesGetResponse,
+  SecurityHasPrivilegesResponse,
+} from '@elastic/elasticsearch/lib/api/types';
+import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server';
+import type { Logger } from '@kbn/logging';
+import { fetchIndicesStatus, fetchUserStartPrivileges } from './status';
+
+const mockLogger = {
+  warn: jest.fn(),
+  error: jest.fn(),
+};
+const logger: Logger = mockLogger as unknown as Logger;
+
+const mockClient = {
+  indices: {
+    get: jest.fn(),
+  },
+  security: {
+    hasPrivileges: jest.fn(),
+  },
+};
+const client = mockClient as unknown as ElasticsearchClient;
+
+describe('status api lib', function () {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('fetchIndicesStatus', function () {
+    it('should return results from get', async () => {
+      const mockResult: IndicesGetResponse = {};
+      mockClient.indices.get.mockResolvedValue(mockResult);
+
+      await expect(fetchIndicesStatus(client, logger)).resolves.toEqual({ indexNames: [] });
+      expect(mockClient.indices.get).toHaveBeenCalledTimes(1);
+      expect(mockClient.indices.get).toHaveBeenCalledWith({
+        expand_wildcards: ['open'],
+        features: ['settings'],
+        index: '*',
+      });
+    });
+    it('should return index names', async () => {
+      const mockResult: IndicesGetResponse = {
+        'unit-test-index': {
+          settings: {},
+        },
+      };
+      mockClient.indices.get.mockResolvedValue(mockResult);
+
+      await expect(fetchIndicesStatus(client, logger)).resolves.toEqual({
+        indexNames: ['unit-test-index'],
+      });
+    });
+    it('should not return hidden indices', async () => {
+      const mockResult: IndicesGetResponse = {
+        'unit-test-index': {
+          settings: {},
+        },
+        'hidden-index': {
+          settings: {
+            index: {
+              hidden: true,
+            },
+          },
+        },
+      };
+      mockClient.indices.get.mockResolvedValue(mockResult);
+
+      await expect(fetchIndicesStatus(client, logger)).resolves.toEqual({
+        indexNames: ['unit-test-index'],
+      });
+
+      mockResult['hidden-index']!.settings!.index!.hidden = 'true';
+      await expect(fetchIndicesStatus(client, logger)).resolves.toEqual({
+        indexNames: ['unit-test-index'],
+      });
+    });
+    it('should not return closed indices', async () => {
+      const mockResult: IndicesGetResponse = {
+        'unit-test-index': {
+          settings: {},
+        },
+        'closed-index': {
+          settings: {
+            index: {
+              verified_before_close: true,
+            },
+          },
+        },
+      };
+      mockClient.indices.get.mockResolvedValue(mockResult);
+
+      await expect(fetchIndicesStatus(client, logger)).resolves.toEqual({
+        indexNames: ['unit-test-index'],
+      });
+
+      mockResult['closed-index']!.settings!.index!.verified_before_close = 'true';
+      await expect(fetchIndicesStatus(client, logger)).resolves.toEqual({
+        indexNames: ['unit-test-index'],
+      });
+    });
+    it('should raise exceptions', async () => {
+      const error = new Error('boom');
+      mockClient.indices.get.mockRejectedValue(error);
+
+      await expect(fetchIndicesStatus(client, logger)).rejects.toThrow(error);
+    });
+  });
+
+  describe('fetchUserStartPrivileges', function () {
+    it('should return privileges true', async () => {
+      const result: SecurityHasPrivilegesResponse = {
+        application: {},
+        cluster: {
+          manage_api_key: true,
+        },
+        has_all_requested: true,
+        index: {
+          'test-index-name': {
+            create_index: true,
+          },
+        },
+        username: 'unit-test',
+      };
+      mockClient.security.hasPrivileges.mockResolvedValue(result);
+
+      await expect(fetchUserStartPrivileges(client, logger)).resolves.toEqual({
+        privileges: {
+          canCreateIndex: true,
+          canCreateApiKeys: true,
+        },
+      });
+
+      expect(mockClient.security.hasPrivileges).toHaveBeenCalledTimes(1);
+      expect(mockClient.security.hasPrivileges).toHaveBeenCalledWith({
+        cluster: ['manage_api_key'],
+        index: [
+          {
+            names: ['test-index-name'],
+            privileges: ['create_index'],
+          },
+        ],
+      });
+    });
+    it('should return privileges false', async () => {
+      const result: SecurityHasPrivilegesResponse = {
+        application: {},
+        cluster: {
+          manage_api_key: false,
+        },
+        has_all_requested: false,
+        index: {
+          'test-index-name': {
+            create_index: false,
+          },
+        },
+        username: 'unit-test',
+      };
+      mockClient.security.hasPrivileges.mockResolvedValue(result);
+
+      await expect(fetchUserStartPrivileges(client, logger)).resolves.toEqual({
+        privileges: {
+          canCreateIndex: false,
+          canCreateApiKeys: false,
+        },
+      });
+    });
+    it('should return mixed privileges', async () => {
+      const result: SecurityHasPrivilegesResponse = {
+        application: {},
+        cluster: {
+          manage_api_key: false,
+        },
+        has_all_requested: false,
+        index: {
+          'test-index-name': {
+            create_index: true,
+          },
+        },
+        username: 'unit-test',
+      };
+      mockClient.security.hasPrivileges.mockResolvedValue(result);
+
+      await expect(fetchUserStartPrivileges(client, logger)).resolves.toEqual({
+        privileges: {
+          canCreateIndex: true,
+          canCreateApiKeys: false,
+        },
+      });
+    });
+    it('should handle malformed responses', async () => {
+      const result: SecurityHasPrivilegesResponse = {
+        application: {},
+        cluster: {},
+        has_all_requested: true,
+        index: {
+          'test-index-name': {
+            create_index: true,
+          },
+        },
+        username: 'unit-test',
+      };
+      mockClient.security.hasPrivileges.mockResolvedValue(result);
+
+      await expect(fetchUserStartPrivileges(client, logger)).resolves.toEqual({
+        privileges: {
+          canCreateIndex: true,
+          canCreateApiKeys: false,
+        },
+      });
+    });
+    it('should default privileges on exceptions', async () => {
+      mockClient.security.hasPrivileges.mockRejectedValue(new Error('Boom!!'));
+
+      await expect(fetchUserStartPrivileges(client, logger)).resolves.toEqual({
+        privileges: {
+          canCreateIndex: false,
+          canCreateApiKeys: false,
+        },
+      });
+    });
+  });
+});

x-pack/plugins/search_indices/server/lib/status.ts

@@ -0,0 +1,70 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server';
+import type { Logger } from '@kbn/logging';
+
+import type { IndicesStatusResponse, UserStartPrivilegesResponse } from '../../common/types';
+
+import { isHidden, isClosed } from '../utils/index_utils';
+
+export async function fetchIndicesStatus(
+  client: ElasticsearchClient,
+  logger: Logger
+): Promise<IndicesStatusResponse> {
+  const indexMatches = await client.indices.get({
+    expand_wildcards: ['open'],
+    // for better performance only compute settings of indices but not mappings
+    features: ['settings'],
+    index: '*',
+  });
+
+  const indexNames = Object.keys(indexMatches).filter(
+    (indexName) =>
+      indexMatches[indexName] &&
+      !isHidden(indexMatches[indexName]) &&
+      !isClosed(indexMatches[indexName])
+  );
+
+  return {
+    indexNames,
+  };
+}
+
+export async function fetchUserStartPrivileges(
+  client: ElasticsearchClient,
+  logger: Logger,
+  indexName: string = 'test-index-name'
+): Promise<UserStartPrivilegesResponse> {
+  try {
+    const securityCheck = await client.security.hasPrivileges({
+      cluster: ['manage_api_key'],
+      index: [
+        {
+          names: [indexName],
+          privileges: ['create_index'],
+        },
+      ],
+    });
+
+    return {
+      privileges: {
+        canCreateIndex: securityCheck?.index?.[indexName]?.create_index ?? false,
+        canCreateApiKeys: securityCheck?.cluster?.manage_api_key ?? false,
+      },
+    };
+  } catch (e) {
+    logger.error(`Error checking user privileges for searchIndices elasticsearch start`);
+    logger.error(e);
+    return {
+      privileges: {
+        canCreateIndex: false,
+        canCreateApiKeys: false,
+      },
+    };
+  }
+}

x-pack/plugins/search_indices/server/plugin.ts

@@ -31,7 +31,7 @@ export class SearchIndicesPlugin
     const router = core.http.createRouter();
 
     // Register server side APIs
-    defineRoutes(router);
+    defineRoutes(router, this.logger);
 
     return {};
   }

x-pack/plugins/search_indices/server/routes/index.ts

@@ -6,5 +6,10 @@
  */
 
 import type { IRouter } from '@kbn/core/server';
+import type { Logger } from '@kbn/logging';
 
-export function defineRoutes(router: IRouter) {}
+import { registerStatusRoutes } from './status';
+
+export function defineRoutes(router: IRouter, logger: Logger) {
+  registerStatusRoutes(router, logger);
+}