[8.14] [Cases] Populate user info from fake requests (elastic#180671) (…

…elastic#181572) # Backport This will backport the following commits from `main` to `8.14`: - [[Cases] Populate user info from fake requests (elastic#180671)](elastic#180671)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Christos Nasikas <[email protected]>
darnautov · Apr 24, 2024 · e98ed18 · e98ed18
1 parent 65cf0de
commit e98ed18
Show file tree

Hide file tree

Showing 10 changed files with 176 additions and 9 deletions.
diff --git a/x-pack/plugins/actions/server/actions_client/actions_client.mock.ts b/x-pack/plugins/actions/server/actions_client/actions_client.mock.ts
@@ -6,7 +6,7 @@
  */
 
 import type { PublicMethodsOf } from '@kbn/utility-types';
-import { ActionsClient } from './actions_client';
+import type { ActionsClient } from './actions_client';
 
 type ActionsClientContract = PublicMethodsOf<ActionsClient>;
 export type ActionsClientMock = jest.Mocked<ActionsClientContract>;

diff --git a/x-pack/plugins/actions/server/authorization/actions_authorization.mock.ts b/x-pack/plugins/actions/server/authorization/actions_authorization.mock.ts
@@ -6,7 +6,7 @@
  */
 
 import type { PublicMethodsOf } from '@kbn/utility-types';
-import { ActionsAuthorization } from './actions_authorization';
+import type { ActionsAuthorization } from './actions_authorization';
 
 export type ActionsAuthorizationMock = jest.Mocked<PublicMethodsOf<ActionsAuthorization>>;
 

diff --git a/x-pack/plugins/actions/server/feature.ts b/x-pack/plugins/actions/server/feature.ts
@@ -5,8 +5,8 @@
  * 2.0.
  */
 
+import { DEFAULT_APP_CATEGORIES } from '@kbn/core-application-common';
 import { i18n } from '@kbn/i18n';
-import { DEFAULT_APP_CATEGORIES } from '@kbn/core/server';
 import {
   ACTION_SAVED_OBJECT_TYPE,
   ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE,

diff --git a/x-pack/plugins/actions/tsconfig.json b/x-pack/plugins/actions/tsconfig.json
@@ -46,7 +46,8 @@
     "@kbn/actions-types",
     "@kbn/core-http-server",
     "@kbn/core-test-helpers-kbn-server",
-    "@kbn/security-plugin-types-server"
+    "@kbn/security-plugin-types-server",
+    "@kbn/core-application-common"
   ],
   "exclude": [
     "target/**/*",

diff --git a/x-pack/plugins/cases/common/constants/index.ts b/x-pack/plugins/cases/common/constants/index.ts
@@ -192,6 +192,7 @@ export const GET_CONNECTORS_CONFIGURE_API_TAG = 'casesGetConnectorsConfigure';
 export const DEFAULT_USER_SIZE = 10;
 export const MAX_ASSIGNEES_PER_CASE = 10;
 export const NO_ASSIGNEES_FILTERING_KEYWORD = 'none';
+export const KIBANA_SYSTEM_USERNAME = 'elastic/kibana';
 
 /**
  * Delays

diff --git a/x-pack/plugins/cases/server/client/factory.test.ts b/x-pack/plugins/cases/server/client/factory.test.ts
@@ -0,0 +1,124 @@
+/*
+ * 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 { coreMock, httpServerMock, loggingSystemMock } from '@kbn/core/server/mocks';
+import { CasesClientFactory } from './factory';
+import { createCasesClientFactoryMockArgs } from './mocks';
+import { createCasesClient } from './client';
+import type { FakeRawRequest } from '@kbn/core-http-server';
+import { CoreKibanaRequest } from '@kbn/core-http-router-server-internal';
+
+jest.mock('./client');
+
+describe('CasesClientFactory', () => {
+  const coreStart = coreMock.createStart();
+  const request = httpServerMock.createKibanaRequest();
+
+  const rawRequest: FakeRawRequest = {
+    headers: {},
+    path: '/',
+  };
+
+  const fakeRequest = CoreKibanaRequest.from(rawRequest);
+  const createCasesClientMocked = createCasesClient as jest.Mock;
+  const logger = loggingSystemMock.createLogger();
+  const args = createCasesClientFactoryMockArgs();
+  let casesClientFactory: CasesClientFactory;
+
+  args.featuresPluginStart.getKibanaFeatures.mockReturnValue([]);
+
+  beforeEach(() => {
+    casesClientFactory = new CasesClientFactory(logger);
+    casesClientFactory.initialize(args);
+    jest.clearAllMocks();
+  });
+
+  describe('user info', () => {
+    it('constructs the user info from user profiles', async () => {
+      const scopedClusterClient = coreStart.elasticsearch.client.asScoped(request).asCurrentUser;
+      args.securityPluginStart.userProfiles.getCurrent.mockResolvedValueOnce({
+        // @ts-expect-error: not all fields are needed
+        user: { username: 'my_user', full_name: 'My user', email: '[email protected]' },
+      });
+
+      await casesClientFactory.create({
+        request,
+        savedObjectsService: coreStart.savedObjects,
+        scopedClusterClient,
+      });
+
+      expect(args.securityPluginStart.userProfiles.getCurrent).toHaveBeenCalled();
+      expect(args.securityPluginStart.authc.getCurrentUser).not.toHaveBeenCalled();
+      expect(createCasesClientMocked.mock.calls[0][0].user).toEqual({
+        username: 'my_user',
+        full_name: 'My user',
+        email: '[email protected]',
+      });
+    });
+
+    it('constructs the user info from the authc service if the user profile is not available', async () => {
+      const scopedClusterClient = coreStart.elasticsearch.client.asScoped(request).asCurrentUser;
+      // @ts-expect-error: not all fields are needed
+      args.securityPluginStart.authc.getCurrentUser.mockReturnValueOnce({
+        username: 'my_user_2',
+        full_name: 'My user 2',
+        email: '[email protected]',
+      });
+
+      await casesClientFactory.create({
+        request,
+        savedObjectsService: coreStart.savedObjects,
+        scopedClusterClient,
+      });
+
+      expect(args.securityPluginStart.userProfiles.getCurrent).toHaveBeenCalled();
+      expect(args.securityPluginStart.authc.getCurrentUser).toHaveBeenCalled();
+      expect(createCasesClientMocked.mock.calls[0][0].user).toEqual({
+        username: 'my_user_2',
+        full_name: 'My user 2',
+        email: '[email protected]',
+      });
+    });
+
+    it('constructs the user info from fake requests correctly', async () => {
+      const scopedClusterClient =
+        coreStart.elasticsearch.client.asScoped(fakeRequest).asCurrentUser;
+
+      await casesClientFactory.create({
+        request: fakeRequest,
+        savedObjectsService: coreStart.savedObjects,
+        scopedClusterClient,
+      });
+
+      expect(args.securityPluginStart.userProfiles.getCurrent).toHaveBeenCalled();
+      expect(args.securityPluginStart.authc.getCurrentUser).toHaveBeenCalled();
+      expect(createCasesClientMocked.mock.calls[0][0].user).toEqual({
+        username: 'elastic/kibana',
+        full_name: null,
+        email: null,
+      });
+    });
+
+    it('return null for all user fields if it cannot find the user info', async () => {
+      const scopedClusterClient = coreStart.elasticsearch.client.asScoped(request).asCurrentUser;
+
+      await casesClientFactory.create({
+        request,
+        savedObjectsService: coreStart.savedObjects,
+        scopedClusterClient,
+      });
+
+      expect(args.securityPluginStart.userProfiles.getCurrent).toHaveBeenCalled();
+      expect(args.securityPluginStart.authc.getCurrentUser).toHaveBeenCalled();
+      expect(createCasesClientMocked.mock.calls[0][0].user).toEqual({
+        username: null,
+        full_name: null,
+        email: null,
+      });
+    });
+  });
+});
diff --git a/x-pack/plugins/cases/server/client/factory.ts b/x-pack/plugins/cases/server/client/factory.ts
@@ -34,7 +34,7 @@ import type {
 import type { PublicMethodsOf } from '@kbn/utility-types';
 import { DEFAULT_SPACE_ID } from '@kbn/spaces-plugin/common';
 import type { FilesStart } from '@kbn/files-plugin/server';
-import { SAVED_OBJECT_TYPES } from '../../common/constants';
+import { KIBANA_SYSTEM_USERNAME, SAVED_OBJECT_TYPES } from '../../common/constants';
 import { Authorization } from '../authorization/authorization';
 import {
   CaseConfigureService,
@@ -286,6 +286,14 @@ export class CasesClientFactory {
       this.logger.debug(`Failed to retrieve user info from authc: ${error}`);
     }
 
+    if (request.isFakeRequest) {
+      return {
+        username: KIBANA_SYSTEM_USERNAME,
+        full_name: null,
+        email: null,
+      };
+    }
+
     return {
       username: null,
       full_name: null,

diff --git a/x-pack/plugins/cases/server/client/mocks.ts b/x-pack/plugins/cases/server/client/mocks.ts
@@ -9,12 +9,20 @@ import type { PublicContract, PublicMethodsOf } from '@kbn/utility-types';
 import { loggingSystemMock, savedObjectsClientMock } from '@kbn/core/server/mocks';
 import type { ISavedObjectsSerializer } from '@kbn/core-saved-objects-server';
 
-import { createFileServiceMock } from '@kbn/files-plugin/server/mocks';
+import {
+  createFileServiceFactoryMock,
+  createFileServiceMock,
+} from '@kbn/files-plugin/server/mocks';
 import { securityMock } from '@kbn/security-plugin/server/mocks';
 import { actionsClientMock } from '@kbn/actions-plugin/server/actions_client/actions_client.mock';
 import { makeLensEmbeddableFactory } from '@kbn/lens-plugin/server/embeddable/make_lens_embeddable_factory';
 import { serializerMock } from '@kbn/core-saved-objects-base-server-mocks';
-
+import { spacesMock } from '@kbn/spaces-plugin/server/mocks';
+import { featuresPluginMock } from '@kbn/features-plugin/server/mocks';
+import { actionsMock } from '@kbn/actions-plugin/server/mocks';
+import { notificationsMock } from '@kbn/notifications-plugin/server/mocks';
+import { licensingMock } from '@kbn/licensing-plugin/server/mocks';
+import { alertsMock } from '@kbn/alerting-plugin/server/mocks';
 import type { CasesSearchRequest } from '../../common/types/api';
 import type { CasesClient, CasesClientInternal } from '.';
 import type { AttachmentsSubClient } from './attachments/client';
@@ -214,6 +222,30 @@ export const createCasesClientMockArgs = () => {
   };
 };
 
+export const createCasesClientFactoryMockArgs = () => {
+  return {
+    securityPluginSetup: securityMock.createSetup(),
+    securityPluginStart: securityMock.createStart(),
+    spacesPluginStart: spacesMock.createStart(),
+    featuresPluginStart: featuresPluginMock.createSetup(),
+    actionsPluginStart: actionsMock.createStart(),
+    licensingPluginStart: licensingMock.createStart(),
+    notifications: notificationsMock.createStart(),
+    ruleRegistry: { getRacClientWithRequest: jest.fn(), alerting: alertsMock.createStart() },
+    filesPluginStart: { fileServiceFactory: createFileServiceFactoryMock() },
+    publicBaseUrl: 'https//example.com',
+    lensEmbeddableFactory: jest.fn().mockReturnValue(
+      makeLensEmbeddableFactory(
+        () => ({}),
+        () => ({}),
+        {}
+      )
+    ),
+    externalReferenceAttachmentTypeRegistry: createExternalReferenceAttachmentTypeRegistryMock(),
+    persistableStateAttachmentTypeRegistry: createPersistableStateAttachmentTypeRegistryMock(),
+  };
+};
+
 export const createCasesClientMockSearchRequest = (
   overwrites?: CasesSearchRequest
 ): CasesSearchRequest => ({

diff --git a/x-pack/plugins/cases/server/plugin.test.ts b/x-pack/plugins/cases/server/plugin.test.ts
@@ -11,7 +11,7 @@ import { coreMock } from '@kbn/core/server/mocks';
 import { usageCollectionPluginMock } from '@kbn/usage-collection-plugin/server/mocks';
 import { licensingMock } from '@kbn/licensing-plugin/server/mocks';
 import { featuresPluginMock } from '@kbn/features-plugin/server/mocks';
-import { createFilesSetupMock } from '@kbn/files-plugin/server/mocks';
+import { createFileServiceFactoryMock, createFilesSetupMock } from '@kbn/files-plugin/server/mocks';
 import { securityMock } from '@kbn/security-plugin/server/mocks';
 import { makeLensEmbeddableFactory } from '@kbn/lens-plugin/server/embeddable/make_lens_embeddable_factory';
 import { taskManagerMock } from '@kbn/task-manager-plugin/server/mocks';
@@ -69,7 +69,7 @@ describe('Cases Plugin', () => {
     pluginsStart = {
       licensing: licensingMock.createStart(),
       actions: actionsMock.createStart(),
-      files: { fileServiceFactory: { asScoped: jest.fn(), asInternal: jest.fn() } },
+      files: { fileServiceFactory: createFileServiceFactoryMock() },
       features: featuresPluginMock.createStart(),
       security: securityMock.createStart(),
       notifications: notificationsMock.createStart(),

diff --git a/x-pack/plugins/cases/tsconfig.json b/x-pack/plugins/cases/tsconfig.json
@@ -74,6 +74,7 @@
     "@kbn/core-logging-server-mocks",
     "@kbn/core-logging-browser-mocks",
     "@kbn/data-views-plugin",
+    "@kbn/core-http-router-server-internal",
   ],
   "exclude": [
     "target/**/*",