[8.17] [ResponseOps][MW] Fix bug when creating repeating Maintenance Window (#207084) (#208312)

# Backport This will backport the following commits from `main` to `8.17`: - [[ResponseOps][MW] Fix bug when creating repeating Maintenance Window (#207084)](https://github.com/elastic/kibana/pull/207084)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) \r\n\r\n### Questions ?\r\nPlease refer to the [Backport tool\r\ndocumentation](https://github.com/sorenlouv/backport)\r\n\r\n"}}]}] BACKPORT-->
2025-04-24 01:38:56 -04:00 · 2025-01-27 12:26:15 +01:00 · 2025-01-27 12:26:15 +01:00 · 52fddd8394
commit 52fddd8394
parent f5ba3e18e3
18 changed files with 158 additions and 133 deletions
--- a/x-pack/plugins/alerting/common/routes/r_rule/request/schemas/v1.ts
+++ b/x-pack/plugins/alerting/common/routes/r_rule/request/schemas/v1.ts
@ -10,6 +10,7 @@ import {
  validateStartDateV1,
  validateEndDateV1,
  createValidateRecurrenceByV1,
+  validateRecurrenceByWeekdayV1,
 } from '../../validation';

 export const rRuleRequestSchema = schema.object({
@ -34,20 +35,9 @@ export const rRuleRequestSchema = schema.object({
    })
  ),
  byweekday: schema.maybe(
-    schema.arrayOf(
-      schema.oneOf([
-        schema.literal('MO'),
-        schema.literal('TU'),
-        schema.literal('WE'),
-        schema.literal('TH'),
-        schema.literal('FR'),
-        schema.literal('SA'),
-        schema.literal('SU'),
-      ]),
-      {
-        validate: createValidateRecurrenceByV1('byweekday'),
-      }
-    )
+    schema.arrayOf(schema.string(), {
+      validate: validateRecurrenceByWeekdayV1,
+    })
  ),
  bymonthday: schema.maybe(
    schema.arrayOf(schema.number({ min: 1, max: 31 }), {
--- a/x-pack/plugins/alerting/common/routes/r_rule/validation/index.ts
+++ b/x-pack/plugins/alerting/common/routes/r_rule/validation/index.ts
@ -8,7 +8,9 @@
 export { validateStartDate } from './validate_start_date/latest';
 export { validateEndDate } from './validate_end_date/latest';
 export { createValidateRecurrenceBy } from './validate_recurrence_by/latest';
+export { validateRecurrenceByWeekday } from './validate_recurrence_by_weekday/latest';

 export { validateStartDate as validateStartDateV1 } from './validate_start_date/v1';
 export { validateEndDate as validateEndDateV1 } from './validate_end_date/v1';
 export { createValidateRecurrenceBy as createValidateRecurrenceByV1 } from './validate_recurrence_by/v1';
+export { validateRecurrenceByWeekday as validateRecurrenceByWeekdayV1 } from './validate_recurrence_by_weekday/v1';
--- a/x-pack/plugins/alerting/common/routes/r_rule/validation/validate_recurrence_by_weekday/latest.ts
+++ b/x-pack/plugins/alerting/common/routes/r_rule/validation/validate_recurrence_by_weekday/latest.ts
@ -4,7 +4,5 @@
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */
-import { TypeOf } from '@kbn/config-schema';
-import { rRuleRequestSchema } from '../schemas/r_rule_request_schema';

-export type RRuleRequest = TypeOf<typeof rRuleRequestSchema>;
+export * from './v1';
--- a/x-pack/plugins/alerting/common/routes/r_rule/validation/validate_recurrence_by_weekday/v1.test.ts
+++ b/x-pack/plugins/alerting/common/routes/r_rule/validation/validate_recurrence_by_weekday/v1.test.ts
@ -0,0 +1,29 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+import { validateRecurrenceByWeekday } from './v1';
+
+describe('validateRecurrenceByWeekday', () => {
+  it('validates empty array', () => {
+    expect(validateRecurrenceByWeekday([])).toEqual('rRule byweekday cannot be empty');
+  });
+
+  it('validates properly formed byweekday strings', () => {
+    const weekdays = ['+1MO', '+2TU', '+3WE', '+4TH', '-4FR', '-3SA', '-2SU', '-1MO'];
+
+    expect(validateRecurrenceByWeekday(weekdays)).toBeUndefined();
+  });
+
+  it('validates improperly formed byweekday strings', () => {
+    expect(validateRecurrenceByWeekday(['+1MO', 'FOO', '+3WE', 'BAR', '-4FR'])).toEqual(
+      'invalid byweekday values in rRule byweekday: FOO,BAR'
+    );
+  });
+
+  it('validates byweekday strings without recurrence', () => {
+    expect(validateRecurrenceByWeekday(['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU'])).toBeUndefined();
+  });
+});
--- a/x-pack/plugins/alerting/common/routes/r_rule/validation/validate_recurrence_by_weekday/v1.ts
+++ b/x-pack/plugins/alerting/common/routes/r_rule/validation/validate_recurrence_by_weekday/v1.ts
@ -0,0 +1,25 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export const validateRecurrenceByWeekday = (array: string[]) => {
+  if (array.length === 0) {
+    return 'rRule byweekday cannot be empty';
+  }
+
+  const byWeekDayRegex = new RegExp('^(((\\+|-)[1-4])?(MO|TU|WE|TH|FR|SA|SU))$');
+  const invalidDays: string[] = [];
+
+  array.forEach((day) => {
+    if (!byWeekDayRegex.test(day)) {
+      invalidDays.push(day);
+    }
+  });
+
+  if (invalidDays.length > 0) {
+    return `invalid byweekday values in rRule byweekday: ${invalidDays.join(',')}`;
+  }
+};
--- a/x-pack/plugins/alerting/server/application/maintenance_window/methods/create/create_maintenance_window.test.ts
+++ b/x-pack/plugins/alerting/server/application/maintenance_window/methods/create/create_maintenance_window.test.ts
@ -6,21 +6,24 @@
 */

 import moment from 'moment-timezone';
-import { createMaintenanceWindow } from './create_maintenance_window';
-import { CreateMaintenanceWindowParams } from './types';
+
 import {
  savedObjectsClientMock,
  loggingSystemMock,
  uiSettingsServiceMock,
 } from '@kbn/core/server/mocks';
 import { SavedObject } from '@kbn/core/server';
+import { FilterStateStore } from '@kbn/es-query';
+import { Frequency } from '@kbn/rrule';
+
 import {
  MaintenanceWindowClientContext,
  MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE,
 } from '../../../../../common';
 import { getMockMaintenanceWindow } from '../../../../data/maintenance_window/test_helpers';
 import type { MaintenanceWindow } from '../../types';
-import { FilterStateStore } from '@kbn/es-query';
+import { createMaintenanceWindow } from './create_maintenance_window';
+import { CreateMaintenanceWindowParams } from './types';

 const savedObjectsClient = savedObjectsClientMock.create();
 const uiSettings = uiSettingsServiceMock.createClient();
@ -57,6 +60,13 @@ describe('MaintenanceWindowClient - create', () => {

    const mockMaintenanceWindow = getMockMaintenanceWindow({
      expirationDate: moment(new Date()).tz('UTC').add(1, 'year').toISOString(),
+      rRule: {
+        tzid: 'UTC',
+        dtstart: '2023-02-26T00:00:00.000Z',
+        freq: Frequency.WEEKLY,
+        byweekday: ['-4MO', 'TU'],
+        count: 2,
+      },
    });

    savedObjectsClient.create.mockResolvedValueOnce({
--- a/x-pack/plugins/alerting/server/application/maintenance_window/methods/create/schemas/create_maintenance_window_params_schema.ts
+++ b/x-pack/plugins/alerting/server/application/maintenance_window/methods/create/schemas/create_maintenance_window_params_schema.ts
@ -6,8 +6,9 @@
 */

 import { schema } from '@kbn/config-schema';
+import { rRuleRequestSchema } from '../../../../../../common/routes/r_rule';
 import { maintenanceWindowCategoryIdsSchema } from '../../../schemas';
-import { rRuleRequestSchema } from '../../../../r_rule/schemas';
+
 import { alertsFilterQuerySchema } from '../../../../alerts_filter_query/schemas';

 export const createMaintenanceWindowParamsSchema = schema.object({
--- a/x-pack/plugins/alerting/server/application/maintenance_window/methods/update/schemas/update_maintenance_window_params_schema.ts
+++ b/x-pack/plugins/alerting/server/application/maintenance_window/methods/update/schemas/update_maintenance_window_params_schema.ts
@ -7,7 +7,7 @@

 import { schema } from '@kbn/config-schema';
 import { maintenanceWindowCategoryIdsSchema } from '../../../schemas';
-import { rRuleRequestSchema } from '../../../../r_rule/schemas';
+import { rRuleRequestSchema } from '../../../../../../common/routes/r_rule';
 import { alertsFilterQuerySchema } from '../../../../alerts_filter_query/schemas';

 export const updateMaintenanceWindowParamsSchema = schema.object({
--- a/x-pack/plugins/alerting/server/application/maintenance_window/methods/update/update_maintenance_window.test.ts
+++ b/x-pack/plugins/alerting/server/application/maintenance_window/methods/update/update_maintenance_window.test.ts
@ -38,6 +38,7 @@ const updatedAttributes = {
    dtstart: '2023-03-26T00:00:00.000Z',
    freq: Frequency.WEEKLY,
    count: 2,
+    byweekday: ['-1MO', 'WE'],
  },
 };

@ -110,8 +111,8 @@ describe('MaintenanceWindowClient - update', () => {
      {
        ...updatedAttributes,
        events: [
-          { gte: '2023-03-26T00:00:00.000Z', lte: '2023-03-26T02:00:00.000Z' },
-          { gte: '2023-04-01T23:00:00.000Z', lte: '2023-04-02T01:00:00.000Z' }, // Daylight savings
+          { gte: '2023-03-26T23:00:00.000Z', lte: '2023-03-27T01:00:00.000Z' },
+          { gte: '2023-03-28T23:00:00.000Z', lte: '2023-03-29T01:00:00.000Z' }, // Daylight savings
        ],
        expirationDate: moment(new Date(secondTimestamp)).tz('UTC').add(1, 'year').toISOString(),
        createdAt: '2023-02-26T00:00:00.000Z',
--- a/x-pack/plugins/alerting/server/application/r_rule/schemas/index.ts
+++ b/x-pack/plugins/alerting/server/application/r_rule/schemas/index.ts
@ -6,4 +6,3 @@
 */

 export { rRuleSchema } from './r_rule_schema';
-export { rRuleRequestSchema } from './r_rule_request_schema';
--- a/x-pack/plugins/alerting/server/application/r_rule/schemas/r_rule_request_schema.ts
+++ b/x-pack/plugins/alerting/server/application/r_rule/schemas/r_rule_request_schema.ts
@ -1,57 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
- */
-import { schema } from '@kbn/config-schema';
-import { validateStartDate, validateEndDate, createValidateRecurrenceBy } from '../validation';
-
-export const rRuleRequestSchema = schema.object({
-  dtstart: schema.string({ validate: validateStartDate }),
-  tzid: schema.string(),
-  freq: schema.maybe(
-    schema.oneOf([schema.literal(0), schema.literal(1), schema.literal(2), schema.literal(3)])
-  ),
-  interval: schema.maybe(
-    schema.number({
-      validate: (interval: number) => {
-        if (interval < 1) return 'rRule interval must be > 0';
-      },
-    })
-  ),
-  until: schema.maybe(schema.string({ validate: validateEndDate })),
-  count: schema.maybe(
-    schema.number({
-      validate: (count: number) => {
-        if (count < 1) return 'rRule count must be > 0';
-      },
-    })
-  ),
-  byweekday: schema.maybe(
-    schema.arrayOf(
-      schema.oneOf([
-        schema.literal('MO'),
-        schema.literal('TU'),
-        schema.literal('WE'),
-        schema.literal('TH'),
-        schema.literal('FR'),
-        schema.literal('SA'),
-        schema.literal('SU'),
-      ]),
-      {
-        validate: createValidateRecurrenceBy('byweekday'),
-      }
-    )
-  ),
-  bymonthday: schema.maybe(
-    schema.arrayOf(schema.number({ min: 1, max: 31 }), {
-      validate: createValidateRecurrenceBy('bymonthday'),
-    })
-  ),
-  bymonth: schema.maybe(
-    schema.arrayOf(schema.number({ min: 1, max: 12 }), {
-      validate: createValidateRecurrenceBy('bymonth'),
-    })
-  ),
-});
--- a/x-pack/plugins/alerting/server/application/r_rule/types/index.ts
+++ b/x-pack/plugins/alerting/server/application/r_rule/types/index.ts
@ -6,4 +6,3 @@
 */

 export type { RRule } from './r_rule';
-export type { RRuleRequest } from './r_rule_request';
--- a/x-pack/plugins/alerting/server/application/r_rule/validation/index.ts
+++ b/x-pack/plugins/alerting/server/application/r_rule/validation/index.ts
@ -1,10 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
- */
-
-export { validateStartDate } from './validate_start_date';
-export { validateEndDate } from './validate_end_date';
-export { validateRecurrenceBy, createValidateRecurrenceBy } from './validate_recurrence_by';
--- a/x-pack/plugins/alerting/server/application/r_rule/validation/validate_end_date.ts
+++ b/x-pack/plugins/alerting/server/application/r_rule/validation/validate_end_date.ts
@ -1,13 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
- */
-
-export const validateEndDate = (date: string) => {
-  const parsedValue = Date.parse(date);
-  if (isNaN(parsedValue)) return `Invalid date: ${date}`;
-  if (parsedValue <= Date.now()) return `Invalid snooze date as it is in the past: ${date}`;
-  return;
-};
--- a/x-pack/plugins/alerting/server/application/r_rule/validation/validate_recurrence_by.ts
+++ b/x-pack/plugins/alerting/server/application/r_rule/validation/validate_recurrence_by.ts
@ -1,16 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
- */
-
-export const validateRecurrenceBy = <T>(name: string, array: T[]) => {
-  if (array.length === 0) {
-    return `rRule ${name} cannot be empty`;
-  }
-};
-
-export const createValidateRecurrenceBy = <T>(name: string) => {
-  return (array: T[]) => validateRecurrenceBy(name, array);
-};
--- a/x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/schemas/bulk_edit_rules_option_schemas.ts
+++ b/x-pack/plugins/alerting/server/application/rule/methods/bulk_edit/schemas/bulk_edit_rules_option_schemas.ts
@ -5,8 +5,8 @@
 * 2.0.
 */
 import { schema } from '@kbn/config-schema';
-import { rRuleRequestSchema } from '../../../../r_rule/schemas';
 import { notifyWhenSchema, actionRequestSchema, systemActionRequestSchema } from '../../../schemas';
+import { rRuleRequestSchema } from '../../../../../../common/routes/r_rule';
 import { validateDuration } from '../../../validation';
 import { validateSnoozeSchedule } from '../validation';

--- a/x-pack/plugins/alerting/server/saved_objects/schemas/raw_maintenance_window/v1.ts
+++ b/x-pack/plugins/alerting/server/saved_objects/schemas/raw_maintenance_window/v1.ts
@ -27,7 +27,7 @@ export const alertsFilterQuerySchema = schema.object({
  dsl: schema.maybe(schema.string()),
 });

-const rRuleSchema = schema.object({
+export const rRuleSchema = schema.object({
  dtstart: schema.string(),
  tzid: schema.string(),
  freq: schema.maybe(
@ -55,15 +55,17 @@ const rRuleSchema = schema.object({
      schema.literal('SU'),
    ])
  ),
-  byweekday: schema.maybe(schema.arrayOf(schema.oneOf([schema.string(), schema.number()]))),
-  bymonth: schema.maybe(schema.number()),
-  bysetpos: schema.maybe(schema.number()),
-  bymonthday: schema.maybe(schema.number()),
-  byyearday: schema.maybe(schema.number()),
-  byweekno: schema.maybe(schema.number()),
-  byhour: schema.maybe(schema.number()),
-  byminute: schema.maybe(schema.number()),
-  bysecond: schema.maybe(schema.number()),
+  byweekday: schema.maybe(
+    schema.nullable(schema.arrayOf(schema.oneOf([schema.string(), schema.number()])))
+  ),
+  bymonth: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  bysetpos: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  bymonthday: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  byyearday: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  byweekno: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  byhour: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  byminute: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
+  bysecond: schema.maybe(schema.nullable(schema.arrayOf(schema.number()))),
 });

 const rawMaintenanceWindowEventsSchema = schema.object({
--- a/x-pack/test/alerting_api_integration/security_and_spaces/group3/tests/maintenance_window/create_maintenance_window.ts
+++ b/x-pack/test/alerting_api_integration/security_and_spaces/group3/tests/maintenance_window/create_maintenance_window.ts
@ -110,6 +110,71 @@ export default function createMaintenanceWindowTests({ getService }: FtrProvider
      });
    }

+    describe('rRuleSchema validation', () => {
+      it('should create maintenance window with byweekday', async () => {
+        const rrule = {
+          dtstart: new Date().toISOString(),
+          tzid: 'UTC',
+          byweekday: ['+1MO', 'TH'],
+        };
+
+        const response = await supertest
+          .post(`${getUrlPrefix('space1')}/internal/alerting/rules/maintenance_window`)
+          .set('kbn-xsrf', 'foo')
+          .send({
+            ...createParams,
+            r_rule: rrule,
+          })
+          .expect(200);
+
+        objectRemover.add('space1', response.body.id, 'rules/maintenance_window', 'alerting', true);
+
+        expect(response.body.r_rule.byweekday).to.eql(rrule.byweekday);
+      });
+
+      it('should create maintenance window with bymonth', async () => {
+        const rrule = {
+          dtstart: new Date().toISOString(),
+          tzid: 'UTC',
+          bymonth: [9, 4],
+        };
+
+        const response = await supertest
+          .post(`${getUrlPrefix('space1')}/internal/alerting/rules/maintenance_window`)
+          .set('kbn-xsrf', 'foo')
+          .send({
+            ...createParams,
+            r_rule: rrule,
+          })
+          .expect(200);
+
+        objectRemover.add('space1', response.body.id, 'rules/maintenance_window', 'alerting', true);
+
+        expect(response.body.r_rule.bymonth).to.eql(rrule.bymonth);
+      });
+
+      it('should create maintenance window with bymonthday', async () => {
+        const rrule = {
+          dtstart: new Date().toISOString(),
+          tzid: 'UTC',
+          bymonthday: [1, 30],
+        };
+
+        const response = await supertest
+          .post(`${getUrlPrefix('space1')}/internal/alerting/rules/maintenance_window`)
+          .set('kbn-xsrf', 'foo')
+          .send({
+            ...createParams,
+            r_rule: rrule,
+          })
+          .expect(200);
+
+        objectRemover.add('space1', response.body.id, 'rules/maintenance_window', 'alerting', true);
+
+        expect(response.body.r_rule.bymonthday).to.eql(rrule.bymonthday);
+      });
+    });
+
    it('should create maintenance window with category ids', async () => {
      const response = await supertest
        .post(`${getUrlPrefix('space1')}/internal/alerting/rules/maintenance_window`)