Register a system action using the sub actions framework

elastic · Mar 6, 2024 · 58bd36b · 58bd36b
1 parent e64be97
commit 58bd36b
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/x-pack/plugins/actions/server/sub_action_framework/register.test.ts b/x-pack/plugins/actions/server/sub_action_framework/register.test.ts
@@ -82,4 +82,25 @@ describe('Registration', () => {
     expect(mockRenderParameterTemplates).toHaveBeenCalledWith(logger, params, variables, actionId);
     expect(rendered).toBe(renderedVariables);
   });
+
+  it('registers a system connector correctly', async () => {
+    register<TestConfig, TestSecrets>({
+      actionTypeRegistry,
+      connector: { ...connector, isSystemActionType: true },
+      configurationUtilities: mockedActionsConfig,
+      logger,
+    });
+
+    expect(actionTypeRegistry.register).toHaveBeenCalledTimes(1);
+    expect(actionTypeRegistry.register).toHaveBeenCalledWith({
+      id: connector.id,
+      name: connector.name,
+      minimumLicenseRequired: connector.minimumLicenseRequired,
+      supportedFeatureIds: connector.supportedFeatureIds,
+      validate: expect.anything(),
+      executor: expect.any(Function),
+      renderParameterTemplates: expect.any(Function),
+      isSystemActionType: true,
+    });
+  });
 });
diff --git a/x-pack/plugins/actions/server/sub_action_framework/register.ts b/x-pack/plugins/actions/server/sub_action_framework/register.ts
@@ -40,5 +40,6 @@ export const register = <Config extends ActionTypeConfig, Secrets extends Action
     validate: validators,
     executor,
     renderParameterTemplates: connector.renderParameterTemplates,
+    isSystemActionType: connector.isSystemActionType,
   });
 };
diff --git a/x-pack/plugins/actions/server/sub_action_framework/types.ts b/x-pack/plugins/actions/server/sub_action_framework/types.ts
@@ -81,6 +81,7 @@ export interface SubActionConnectorType<Config, Secrets> {
   validators?: Array<ConfigValidator<Config> | SecretsValidator<Secrets>>;
   getService: (params: ServiceParams<Config, Secrets>) => SubActionConnector<Config, Secrets>;
   renderParameterTemplates?: RenderParameterTemplates<ExecutorParams>;
+  isSystemActionType?: boolean;
 }
 
 export interface ExecutorParams extends ActionTypeParams {