PR fixes

x-pack/plugins/alerts/common/alert_notify_when_type.ts

@@ -4,11 +4,15 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-const AlertNotifyWhenTypeValues = ['onActionGroupChange', 'onActiveAlert', 'onThrottleInterval'];
+const AlertNotifyWhenTypeValues = [
+  'onActionGroupChange',
+  'onActiveAlert',
+  'onThrottleInterval',
+] as const;
 export type AlertNotifyWhenType = typeof AlertNotifyWhenTypeValues[number];
 
 export function validateNotifyWhenType(notifyWhen: string) {
-  if (AlertNotifyWhenTypeValues.includes(notifyWhen)) {
+  if (AlertNotifyWhenTypeValues.includes(notifyWhen as AlertNotifyWhenType)) {
     return;
   }
   return `string is not a valid AlertNotifyWhenType: ${notifyWhen}`;

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

@@ -31,7 +31,11 @@ import {
   AlertExecutionStatusValues,
   AlertNotifyWhenType,
 } from '../types';
-import { validateAlertTypeParams, alertExecutionStatusFromRaw } from '../lib';
+import {
+  validateAlertTypeParams,
+  alertExecutionStatusFromRaw,
+  getAlertNotifyWhenType,
+} from '../lib';
 import {
   GrantAPIKeyResult as SecurityPluginGrantAPIKeyResult,
   InvalidateAPIKeyResult as SecurityPluginInvalidateAPIKeyResult,
@@ -253,7 +257,7 @@ export class AlertsClient {
     const createTime = Date.now();
     const { references, actions } = await this.denormalizeActions(data.actions);
 
-    const notifyWhen = this.validateAlertNotifyWhenType(data.notifyWhen, data.throttle);
+    const notifyWhen = getAlertNotifyWhenType(data.notifyWhen, data.throttle);
 
     const rawAlert: RawAlert = {
       ...data,
@@ -699,7 +703,7 @@ export class AlertsClient {
       ? await this.createAPIKey(this.generateAPIKeyName(alertType.id, data.name))
       : null;
     const apiKeyAttributes = this.apiKeyAsAlertAttributes(createdAPIKey, username);
-    const notifyWhen = this.validateAlertNotifyWhenType(data.notifyWhen, data.throttle);
+    const notifyWhen = getAlertNotifyWhenType(data.notifyWhen, data.throttle);
 
     let updatedObject: SavedObject<RawAlert>;
     const createAttributes = this.updateMeta({
@@ -1382,15 +1386,6 @@ export class AlertsClient {
     }
   }
 
-  private validateAlertNotifyWhenType(
-    notifyWhen: AlertNotifyWhenType | null,
-    throttle: string | null
-  ): AlertNotifyWhenType {
-    // We allow notifyWhen to be null for backwards compatibility. If it is null, determine its
-    // value based on whether the throttle is set to a value or null
-    return notifyWhen ? notifyWhen! : throttle ? 'onThrottleInterval' : 'onActiveAlert';
-  }
-
   private async denormalizeActions(
     alertActions: NormalizedAlertAction[]
   ): Promise<{ actions: RawAlert['actions']; references: SavedObjectReference[] }> {

x-pack/plugins/alerts/server/lib/get_alert_notify_when_type.test.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { getAlertNotifyWhenType } from './get_alert_notify_when_type';
+
+test(`should return 'notifyWhen' value if value is set and throttle is null`, () => {
+  expect(getAlertNotifyWhenType('onActionGroupChange', null)).toEqual('onActionGroupChange');
+});
+
+test(`should return 'notifyWhen' value if value is set and throttle is defined`, () => {
+  expect(getAlertNotifyWhenType('onActionGroupChange', '10m')).toEqual('onActionGroupChange');
+});
+
+test(`should return 'onThrottleInterval' value if 'notifyWhen' is null and throttle is defined`, () => {
+  expect(getAlertNotifyWhenType(null, '10m')).toEqual('onThrottleInterval');
+});
+
+test(`should return 'onActiveAlert' value if 'notifyWhen' is null and throttle is null`, () => {
+  expect(getAlertNotifyWhenType(null, null)).toEqual('onActiveAlert');
+});

x-pack/plugins/alerts/server/lib/get_alert_notify_when_type.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { AlertNotifyWhenType } from '../types';
+
+export function getAlertNotifyWhenType(
+  notifyWhen: AlertNotifyWhenType | null,
+  throttle: string | null
+): AlertNotifyWhenType {
+  // We allow notifyWhen to be null for backwards compatibility. If it is null, determine its
+  // value based on whether the throttle is set to a value or null
+  return notifyWhen ? notifyWhen! : throttle ? 'onThrottleInterval' : 'onActiveAlert';
+}

x-pack/plugins/alerts/server/lib/index.ts

@@ -7,6 +7,7 @@
 export { parseDuration, validateDurationSchema } from '../../common/parse_duration';
 export { LicenseState } from './license_state';
 export { validateAlertTypeParams } from './validate_alert_type_params';
+export { getAlertNotifyWhenType } from './get_alert_notify_when_type';
 export { ErrorWithReason, getReasonFromError, isErrorWithReason } from './error_with_reason';
 export {
   executionStatusFromState,