[ResponseOps] Adds uiSettingsClient to alerting framework services (#…

…126648)

x-pack/plugins/alerting/server/mocks.ts

@@ -11,6 +11,7 @@ import { Alert, AlertFactoryDoneUtils } from './alert';
 import {
   elasticsearchServiceMock,
   savedObjectsClientMock,
+  uiSettingsServiceMock,
 } from '../../../../src/core/server/mocks';
 import { AlertInstanceContext, AlertInstanceState } from './types';
 
@@ -105,6 +106,7 @@ const createAlertServicesMock = <
       done: jest.fn().mockReturnValue(alertFactoryMockDone),
     },
     savedObjectsClient: savedObjectsClientMock.create(),
+    uiSettingsClient: uiSettingsServiceMock.createClient(),
     scopedClusterClient: elasticsearchServiceMock.createScopedClusterClient(),
     shouldWriteAlerts: () => true,
     shouldStopExecution: () => true,

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

@@ -384,6 +384,7 @@ export class AlertingPlugin {
     taskRunnerFactory.initialize({
       logger,
       savedObjects: core.savedObjects,
+      uiSettings: core.uiSettings,
       elasticsearch: core.elasticsearch,
       getRulesClientWithRequest,
       spaceIdToNamespace,

x-pack/plugins/alerting/server/task_runner/task_runner.test.ts

@@ -30,6 +30,7 @@ import {
   executionContextServiceMock,
   savedObjectsServiceMock,
   elasticsearchServiceMock,
+  uiSettingsServiceMock,
 } from '../../../../../src/core/server/mocks';
 import { PluginStartContract as ActionsPluginStart } from '../../../actions/server';
 import { actionsMock, actionsClientMock } from '../../../actions/server/mocks';
@@ -95,6 +96,7 @@ describe('Task Runner', () => {
   const ruleTypeRegistry = ruleTypeRegistryMock.create();
   const savedObjectsService = savedObjectsServiceMock.createInternalStartContract();
   const elasticsearchService = elasticsearchServiceMock.createInternalStart();
+  const uiSettingsService = uiSettingsServiceMock.createStartContract();
 
   type TaskRunnerFactoryInitializerParamsType = jest.Mocked<TaskRunnerContext> & {
     actionsPlugin: jest.Mocked<ActionsPluginStart>;
@@ -106,6 +108,7 @@ describe('Task Runner', () => {
 
   const taskRunnerFactoryInitializerParams: TaskRunnerFactoryInitializerParamsType = {
     savedObjects: savedObjectsService,
+    uiSettings: uiSettingsService,
     elasticsearch: elasticsearchService,
     actionsPlugin: actionsMock.createStart(),
     getRulesClientWithRequest: jest.fn().mockReturnValue(rulesClient),

x-pack/plugins/alerting/server/task_runner/task_runner.ts

@@ -352,14 +352,17 @@ export class TaskRunner<
         }] namespace`,
       };
 
+      const savedObjectsClient = this.context.savedObjects.getScopedClient(fakeRequest, {
+        includedHiddenTypes: ['alert', 'action'],
+      });
+
       updatedRuleTypeState = await this.context.executionContext.withContext(ctx, () =>
         this.ruleType.executor({
           alertId: ruleId,
           executionId: this.executionId,
           services: {
-            savedObjectsClient: this.context.savedObjects.getScopedClient(fakeRequest, {
-              includedHiddenTypes: ['alert', 'action'],
-            }),
+            savedObjectsClient,
+            uiSettingsClient: this.context.uiSettings.asScopedToClient(savedObjectsClient),
             scopedClusterClient: wrappedScopedClusterClient.client(),
             alertFactory: createAlertFactory<
               InstanceState,

x-pack/plugins/alerting/server/task_runner/task_runner_cancel.test.ts

@@ -25,6 +25,7 @@ import {
   executionContextServiceMock,
   savedObjectsServiceMock,
   elasticsearchServiceMock,
+  uiSettingsServiceMock,
 } from '../../../../../src/core/server/mocks';
 import { PluginStartContract as ActionsPluginStart } from '../../../actions/server';
 import { actionsMock, actionsClientMock } from '../../../actions/server/mocks';
@@ -94,6 +95,7 @@ describe('Task Runner Cancel', () => {
   const ruleTypeRegistry = ruleTypeRegistryMock.create();
   const savedObjectsService = savedObjectsServiceMock.createInternalStartContract();
   const elasticsearchService = elasticsearchServiceMock.createInternalStart();
+  const uiSettingsService = uiSettingsServiceMock.createStartContract();
 
   type TaskRunnerFactoryInitializerParamsType = jest.Mocked<TaskRunnerContext> & {
     actionsPlugin: jest.Mocked<ActionsPluginStart>;
@@ -103,6 +105,7 @@ describe('Task Runner Cancel', () => {
 
   const taskRunnerFactoryInitializerParams: TaskRunnerFactoryInitializerParamsType = {
     savedObjects: savedObjectsService,
+    uiSettings: uiSettingsService,
     elasticsearch: elasticsearchService,
     actionsPlugin: actionsMock.createStart(),
     getRulesClientWithRequest: jest.fn().mockReturnValue(rulesClient),

x-pack/plugins/alerting/server/task_runner/task_runner_factory.test.ts

@@ -16,6 +16,7 @@ import {
   httpServiceMock,
   savedObjectsServiceMock,
   elasticsearchServiceMock,
+  uiSettingsServiceMock,
 } from '../../../../../src/core/server/mocks';
 import { actionsMock } from '../../../actions/server/mocks';
 import { rulesClientMock } from '../mocks';
@@ -28,6 +29,7 @@ const executionContext = executionContextServiceMock.createSetupContract();
 const mockUsageCountersSetup = usageCountersServiceMock.createSetupContract();
 const mockUsageCounter = mockUsageCountersSetup.createUsageCounter('test');
 const savedObjectsService = savedObjectsServiceMock.createInternalStartContract();
+const uiSettingsService = uiSettingsServiceMock.createStartContract();
 const elasticsearchService = elasticsearchServiceMock.createInternalStart();
 const ruleType: UntypedNormalizedRuleType = {
   id: 'test',
@@ -77,6 +79,7 @@ describe('Task Runner Factory', () => {
 
   const taskRunnerFactoryInitializerParams: jest.Mocked<TaskRunnerContext> = {
     savedObjects: savedObjectsService,
+    uiSettings: uiSettingsService,
     elasticsearch: elasticsearchService,
     getRulesClientWithRequest: jest.fn().mockReturnValue(rulesClient),
     actionsPlugin: actionsMock.createStart(),

x-pack/plugins/alerting/server/task_runner/task_runner_factory.ts

@@ -15,6 +15,7 @@ import type {
   ExecutionContextStart,
   SavedObjectsServiceStart,
   ElasticsearchServiceStart,
+  UiSettingsServiceStart,
 } from '../../../../../src/core/server';
 import { RunContext } from '../../../task_manager/server';
 import { EncryptedSavedObjectsClient } from '../../../encrypted_saved_objects/server';
@@ -35,6 +36,7 @@ import { NormalizedRuleType } from '../rule_type_registry';
 export interface TaskRunnerContext {
   logger: Logger;
   savedObjects: SavedObjectsServiceStart;
+  uiSettings: UiSettingsServiceStart;
   elasticsearch: ElasticsearchServiceStart;
   getRulesClientWithRequest(request: KibanaRequest): PublicMethodsOf<RulesClient>;
   actionsPlugin: ActionsPluginStartContract;

x-pack/plugins/alerting/server/types.ts

@@ -11,6 +11,7 @@ import type {
   RequestHandlerContext,
   SavedObjectReference,
   ElasticsearchClient,
+  IUiSettingsClient,
 } from 'src/core/server';
 import type { PublicMethodsOf } from '@kbn/utility-types';
 import { AlertFactoryDoneUtils, PublicAlert } from './alert';
@@ -78,6 +79,7 @@ export interface AlertServices<
   ActionGroupIds extends string = never
 > {
   savedObjectsClient: SavedObjectsClientContract;
+  uiSettingsClient: IUiSettingsClient;
   scopedClusterClient: IScopedClusterClient;
   alertFactory: {
     create: (id: string) => PublicAlert<InstanceState, InstanceContext, ActionGroupIds>;

x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type.test.ts

@@ -112,6 +112,7 @@ function createRule(shouldWriteAlerts: boolean = true) {
         services: {
           alertFactory,
           savedObjectsClient: {} as any,
+          uiSettingsClient: {} as any,
           scopedClusterClient: {} as any,
           shouldWriteAlerts: () => shouldWriteAlerts,
           shouldStopExecution: () => false,

x-pack/plugins/rule_registry/server/utils/rule_executor_test_utils.ts

@@ -7,6 +7,7 @@
 import {
   elasticsearchServiceMock,
   savedObjectsClientMock,
+  uiSettingsServiceMock,
 } from '../../../../../src/core/server/mocks';
 import {
   AlertExecutorOptions,
@@ -69,6 +70,7 @@ export const createDefaultAlertExecutorOptions = <
   services: {
     alertFactory: alertsMock.createAlertServices<InstanceState, InstanceContext>().alertFactory,
     savedObjectsClient: savedObjectsClientMock.create(),
+    uiSettingsClient: uiSettingsServiceMock.createClient(),
     scopedClusterClient: elasticsearchServiceMock.createScopedClusterClient(),
     shouldWriteAlerts: () => shouldWriteAlerts,
     shouldStopExecution: () => false,

x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts

@@ -195,6 +195,7 @@ export const previewRulesRoute = async (
                 }),
                 savedObjectsClient: context.core.savedObjects.client,
                 scopedClusterClient: context.core.elasticsearch.client,
+                uiSettingsClient: context.core.uiSettings.client,
               },
               spaceId,
               startedAt: startedAt.toDate(),