ensure reserved types arent in aciton groups in executor

gmmorris · Dec 30, 2020 · 0c8b26a · 0c8b26a
1 parent 582b60d
commit 0c8b26a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/x-pack/plugins/alerts/common/builtin_action_groups.ts b/x-pack/plugins/alerts/common/builtin_action_groups.ts
@@ -16,8 +16,12 @@ export const RecoveredActionGroup: Readonly<ActionGroup<'recovered'>> = Object.f
   }),
 });
 
+export type ReservedActionGroups<RecoveryActionGroupId extends string> =
+  | RecoveryActionGroupId
+  | RecoveredActionGroupId;
+
 export function getBuiltinActionGroups<RecoveryActionGroupId extends string>(
   customRecoveryGroup?: ActionGroup<RecoveryActionGroupId>
-): [ActionGroup<RecoveryActionGroupId | RecoveredActionGroupId>] {
+): [ActionGroup<ReservedActionGroups<RecoveryActionGroupId>>] {
   return [customRecoveryGroup ?? RecoveredActionGroup];
 }
diff --git a/x-pack/plugins/alerts/server/types.ts b/x-pack/plugins/alerts/server/types.ts
@@ -29,6 +29,7 @@ import {
   AlertExecutionStatusErrorReasons,
   AlertsHealth,
   AlertNotifyWhenType,
+  ReservedActionGroups,
 } from '../common';
 import { LicenseType } from '../../licensing/server';
 
@@ -118,7 +119,17 @@ export interface AlertType<
   actionGroups: Array<ActionGroup<ActionGroupIds>>;
   defaultActionGroupId: ActionGroup<ActionGroupIds>['id'];
   recoveryActionGroup?: ActionGroup<RecoveryActionGroupId>;
-  executor: ExecutorType<Params, State, InstanceState, InstanceContext, ActionGroupIds>;
+  executor: ExecutorType<
+    Params,
+    State,
+    InstanceState,
+    InstanceContext,
+    /**
+     * Ensure that the reserved ActionGroups (such as `Recovered`) are not
+     * available for scheduling in the Executor
+     */
+    ActionGroupIds extends ReservedActionGroups<RecoveryActionGroupId> ? never : ActionGroupIds
+  >;
   producer: string;
   actionVariables?: {
     context?: ActionVariable[];