[alerting] add mustache variable for Kibana's publicly exposed base URL

resolves elastic#49392

Adds the top-level mustache variable `kibanaBaseUrl` for action parameter
mustache templates.  The value comes from Kibana config, which, if not set
will result in this variable having the value `undefined`.

x-pack/plugins/alerts/server/alert_type_registry.ts

@@ -34,6 +34,7 @@ export interface ConstructorOptions {
  taskRunnerFactory: TaskRunnerFactory;
  licenseState: ILicenseState;
  licensing: LicensingPluginSetup;
+ kibanaBaseUrl: string | undefined;
 }
 
 export interface RegistryAlertType
@@ -113,12 +114,20 @@ export class AlertTypeRegistry {
  private readonly taskRunnerFactory: TaskRunnerFactory;
  private readonly licenseState: ILicenseState;
  private readonly licensing: LicensingPluginSetup;
+ private readonly kibanaBaseUrl: string | undefined;
 
- constructor({ taskManager, taskRunnerFactory, licenseState, licensing }: ConstructorOptions) {
+ constructor({
+ taskManager,
+ taskRunnerFactory,
+ licenseState,
+ licensing,
+ kibanaBaseUrl,
+ }: ConstructorOptions) {
  this.taskManager = taskManager;
  this.taskRunnerFactory = taskRunnerFactory;
  this.licenseState = licenseState;
  this.licensing = licensing;
+ this.kibanaBaseUrl = kibanaBaseUrl;
  }
 
  public has(id: string) {
@@ -183,7 +192,7 @@ export class AlertTypeRegistry {
  InstanceContext,
  ActionGroupIds,
  RecoveryActionGroupId | RecoveredActionGroupId
- >(normalizedAlertType, context),
+ >(normalizedAlertType, context, this.kibanaBaseUrl),
  },
  });
  // No need to notify usage on basic alert types

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

@@ -176,6 +176,7 @@ export class AlertingPlugin {
  core: CoreSetup<AlertingPluginsStart, unknown>,
  plugins: AlertingPluginsSetup
  ): PluginSetupContract {
+ const kibanaBaseUrl = core.http.basePath.publicBaseUrl;
  this.licenseState = new LicenseState(plugins.licensing.license$);
  this.security = plugins.security;
 
@@ -211,6 +212,7 @@ export class AlertingPlugin {
  taskRunnerFactory: this.taskRunnerFactory,
  licenseState: this.licenseState,
  licensing: plugins.licensing,
+ kibanaBaseUrl,
  });
  this.alertTypeRegistry = alertTypeRegistry;
 

x-pack/plugins/alerts/server/task_runner/create_execution_handler.ts

@@ -39,6 +39,7 @@ export interface CreateExecutionHandlerOptions<
  actions: AlertAction[];
  spaceId: string;
  apiKey: RawAlert['apiKey'];
+ kibanaBaseUrl: string | undefined;
  alertType: NormalizedAlertType<
  Params,
  State,
@@ -82,6 +83,7 @@ export function createExecutionHandler<
  spaceId,
  apiKey,
  alertType,
+ kibanaBaseUrl,
  eventLogger,
  request,
  alertParams,
@@ -126,6 +128,7 @@ export function createExecutionHandler<
  context,
  actionParams: action.params,
  state,
+ kibanaBaseUrl,
  alertParams,
  }),
  };

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

@@ -74,6 +74,7 @@ export class TaskRunner<
  private context: TaskRunnerContext;
  private logger: Logger;
  private taskInstance: AlertTaskInstance;
+ private kibanaBaseUrl: string | undefined;
  private alertType: NormalizedAlertType<
  Params,
  State,
@@ -94,13 +95,15 @@ export class TaskRunner<
  RecoveryActionGroupId
  >,
  taskInstance: ConcreteTaskInstance,
- context: TaskRunnerContext
+ context: TaskRunnerContext,
+ kibanaBaseUrl: string | undefined
  ) {
  this.context = context;
  this.logger = context.logger;
  this.alertType = alertType;
  this.taskInstance = taskInstanceToAlertTaskInstance(taskInstance);
  this.alertTypeRegistry = context.alertTypeRegistry;
+ this.kibanaBaseUrl = kibanaBaseUrl;
  }
 
  async getApiKeyForAlertPermissions(alertId: string, spaceId: string) {
@@ -160,6 +163,7 @@ export class TaskRunner<
  tags: string[] | undefined,
  spaceId: string,
  apiKey: RawAlert['apiKey'],
+ kibanaBaseUrl: string | undefined,
  actions: Alert<Params>['actions'],
  alertParams: Params
  ) {
@@ -180,6 +184,7 @@ export class TaskRunner<
  actions,
  spaceId,
  alertType: this.alertType,
+ kibanaBaseUrl,
  eventLogger: this.context.eventLogger,
  request: this.getFakeKibanaRequest(spaceId, apiKey),
  alertParams,
@@ -373,7 +378,8 @@ export class TaskRunner<
  services: Services,
  apiKey: RawAlert['apiKey'],
  alert: SanitizedAlert<Params>,
- event: Event
+ event: Event,
+ kibanaBaseUrl: string | undefined
  ) {
  const {
  params: { alertId, spaceId },
@@ -387,6 +393,7 @@ export class TaskRunner<
  alert.tags,
  spaceId,
  apiKey,
+ kibanaBaseUrl,
  alert.actions,
  alert.params
  );
@@ -428,7 +435,7 @@ export class TaskRunner<
  }
  return {
  state: await promiseResult<AlertTaskState, Error>(
- this.validateAndExecuteAlert(services, apiKey, alert, event)
+ this.validateAndExecuteAlert(services, apiKey, alert, event, this.kibanaBaseUrl)
  ),
  schedule: asOk(
  // fetch the alert again to ensure we return the correct schedule as it may have

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

@@ -70,7 +70,8 @@ export class TaskRunnerFactory {
  ActionGroupIds,
  RecoveryActionGroupId
  >,
- { taskInstance }: RunContext
+ { taskInstance }: RunContext,
+ kibanaBaseUrl: string | undefined
  ) {
  if (!this.isInitialized) {
  throw new Error('TaskRunnerFactory not initialized');
@@ -83,6 +84,6 @@ export class TaskRunnerFactory {
  InstanceContext,
  ActionGroupIds,
  RecoveryActionGroupId
- >(alertType, taskInstance, this.taskRunnerContext!);
+ >(alertType, taskInstance, this.taskRunnerContext!, kibanaBaseUrl);
  }
 }

x-pack/plugins/alerts/server/task_runner/transform_action_params.ts

@@ -27,6 +27,7 @@ interface TransformActionParamsOptions {
  actionParams: AlertActionParams;
  alertParams: AlertTypeParams;
  state: AlertInstanceState;
+ kibanaBaseUrl?: string;
  context: AlertInstanceContext;
 }
 
@@ -44,6 +45,7 @@ export function transformActionParams({
  context,
  actionParams,
  state,
+ kibanaBaseUrl,
  alertParams,
 }: TransformActionParamsOptions): AlertActionParams {
  // when the list of variables we pass in here changes,
@@ -61,6 +63,7 @@ export function transformActionParams({
  context,
  date: new Date().toISOString(),
  state,
+ kibanaBaseUrl,
  params: alertParams,
  };
  return actionsPlugin.renderActionParameterTemplates(actionTypeId, actionParams, variables);