[Alerting] Allow rule types to extract/inject saved object references on rule CRU

[ymao1]

Resolves #87992

Summary

This PR provides a framework level hook to allow individual rule types to register functions for extracting/injecting saved object references from and into a rule's parameters.

The AlertType interface has been updated to include a new ExtractedParams template type and optional useSavedObjectReferences functions. Both useSavedObjectReferences.extractReferences and useSavedObjectReferences.injectReferences must be defined if one is defined.

Updated `AlertType` interface

export interface AlertType<
  Params extends AlertTypeParams = never,
  ExtractedParams extends AlertTypeParams = never -----> this can be the same as Params if the rule type wants
  State extends AlertTypeState = never,
  InstanceState extends AlertInstanceState = never,
  InstanceContext extends AlertInstanceContext = never,
  ActionGroupIds extends string = never,
  RecoveryActionGroupId extends string = never
> {
  id: string;
  name: string;
  actionGroups: Array<ActionGroup<ActionGroupIds>>;
  defaultActionGroupId: ActionGroup<ActionGroupIds>['id'];
  recoveryActionGroup?: ActionGroup<RecoveryActionGroupId>;
  executor: ExecutorType;
  producer: string;
  actionVariables?: {};
  minimumLicenseRequired: LicenseType;
  /**
   * These are the new hooks
   **/
  useSavedObjectReferences?: {
    extractReferences: (params: Params) => RuleParamsAndRefs<ExtractedParams>;
    injectReferences: (params: SavedObjectAttributes, references: SavedObjectReference[]) => Params;
  };
}

In the alerts_client, the extractReferences hook would be called (if defined) on create and update and the injectReferences hook would be called (if defined) on get and find. The framework will prefix any extracted SO reference names with a framework level prefix (currently param:) to delineate between framework level SO references and references extracted by the rule type.

Example hooks implementation:

useSavedObjectReferences: {
  extractReferences: (params: Params): RuleParamsAndRefs<ExtractedParams> => {
    const { testSavedObjectId, ...otherParams } = params;

    const testSavedObjectRef = 'testRef_0';
    const references = [
      {
        name: `testRef_0`,
        id: testSavedObjectId,
        type: 'index-pattern',
      },
    ];
    return { params: { ...otherParams, testSavedObjectRef }, references };
  },
  injectReferences: (params: SavedObjectAttributes, references: SavedObjectReference[]) => {
    const { testSavedObjectRef, ...otherParams } = params;
    const reference = references.find((ref) => ref.name === testSavedObjectRef);
    if (!reference) {
      throw new Error(`Test reference "${testSavedObjectRef}"`);
    }
    return { ...otherParams, testSavedObjectId: reference.id } as Params;
  },
},

Checklist

Delete any items that are not applicable to this PR.

• Documentation was added for features that require explanation or tutorials
• Unit or functional tests were updated or added to match the most common scenarios

[ymao1]

@elasticmachine merge upstream

[FrankHassanabad]

LGTM

I did this:

• Reading through the description and the example.
• Making sure I understood the example.
• In the example I saw that you can remove params as well as add them back if you only want to store them in the saved references which is 👍 great.
• Read through the two changes in files changed

I did not do this:

• I did not try to create a function that exercises this functionality and ensure it works. Assuming someone from kibana-alerting will do this part and/or a e2e test at some point from kibana-alerting.

I assume once approved we will then implement this for exception lists and then write a SO migration to upgrade existing exception lists. These two PR's could be separate from our end.

[mikecote]

Changes LGTM! I tested locally with the index threshold rule type, I was able to see it work as expected 👍

[mikecote]

I'm thinking there's a reason for it to be SavedObjectAttributes but I figured I'd ask, should this be ExtractedParams?

Suggested change

	injectReferences: (params: SavedObjectAttributes, references: SavedObjectReference[]) => Params;
	injectReferences: (params: ExtractedParams, references: SavedObjectReference[]) => Params;

[mikecote]

optional nit: should we add a comment about modifying this value will require a migration for existing SOs with references?

[ymao1]

@elasticmachine merge upstream

[kindsun]

Maps team owned file updates lgtm!

[ymao1]

@elasticmachine merge upstream

[ymao1]

@elasticmachine merge upstream

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 9fdfea3
• Storybooks Preview
• Documentation Changes

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
alerting	230	234	+4

Unknown metric groups

API count

id	before	after	diff
alerting	238	242	+4

History

• 💚 Build #139335 succeeded 1921d4f
• 💛 Build #139165 was flaky 37fe7b2
• 💚 Build #138431 succeeded 9d1c536
• 💚 Build #138025 succeeded b3570f5
• 💚 Build #137799 succeeded 5d04948

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @ymao1

[YulNaumenko]

LGTM! Awesome new capabilities for the rule types. Tested this manually on the extending Index Threshold with the new hooks - it works!

[kibanamachine]

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.