[RAM] Window Maintenance Client/Saved Object and Mapping/REST APIs

packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/aggregations/aggs_types/bucket_aggs.ts

@@ -25,12 +25,12 @@ import { sortOrderSchema } from './common_schemas';
  * - filter
  * - filters
  * - composite
+ * - date_histogram
  *
  * Not implemented:
  * - adjacency_matrix
  * - auto_date_histogram
  * - children
- * - date_histogram
  * - diversified_sampler
  * - geo_distance
  * - geohash_grid
@@ -161,6 +161,25 @@ const histogramSchema = s.object({
   ),
 });
 
+const dateHistogramSchema = s.object({
+  field: s.maybe(s.string()),
+  interval: s.maybe(s.oneOf([s.string(), s.literal(0), s.literal(-1)])),
+  fixed_interval: s.maybe(s.oneOf([s.string(), s.literal(0), s.literal(-1)])),
+  min_doc_count: s.maybe(s.number({ min: 0 })),
+  extended_bounds: s.maybe(
+    s.object({
+      min: s.oneOf([s.string(), s.number()]),
+      max: s.oneOf([s.string(), s.number()]),
+    })
+  ),
+  hard_bounds: s.maybe(
+    s.object({
+      min: s.oneOf([s.string(), s.number()]),
+      max: s.oneOf([s.string(), s.number()]),
+    })
+  ),
+});
+
 const compositeSchema = s.object({
   size: s.maybe(s.number()),
   after: s.maybe(s.recordOf(s.string(), s.nullable(s.oneOf([s.string(), s.number()])))),
@@ -183,6 +202,7 @@ export const bucketAggsSchemas: Record<string, ObjectType> = {
     filters: s.recordOf(s.string(), s.oneOf([termSchema, boolSchema])),
   }),
   histogram: histogramSchema,
+  date_histogram: dateHistogramSchema,
   nested: s.object({
     path: s.string(),
   }),

x-pack/plugins/alerting/common/index.ts

@@ -23,6 +23,8 @@ export * from './rule_notify_when_type';
 export * from './parse_duration';
 export * from './execution_log_types';
 export * from './rule_snooze_type';
+export * from './rrule_type';
+export * from './maintenance_window';
 export * from './default_rule_aggregation';
 export * from './rule_tags_aggregation';
 

x-pack/plugins/alerting/common/maintenance_window.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 { Logger, SavedObjectsClientContract } from '@kbn/core/server';
+import { RRuleParams } from './rrule_type';
+
+export enum MaintenanceWindowStatus {
+  Running = 'running',
+  Upcoming = 'upcoming',
+  Finished = 'finished',
+  Archived = 'archived',
+}
+
+export interface MaintenanceWindowModificationMetadata {
+  createdBy: string | null;
+  updatedBy: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface DateRange {
+  gte: string;
+  lte: string;
+}
+
+export interface MaintenanceWindowSOProperties {
+  title: string;
+  enabled: boolean;
+  duration: number;
+  expirationDate: string;
+  events: DateRange[];
+  rRule: RRuleParams;
+}
+
+export type MaintenanceWindowSOAttributes = MaintenanceWindowSOProperties &
+  MaintenanceWindowModificationMetadata;
+
+export type MaintenanceWindow = MaintenanceWindowSOAttributes & {
+  status: MaintenanceWindowStatus;
+  startDate: string | null;
+  endDate: string | null;
+  id: string;
+};
+
+export interface MaintenanceWindowClientContext {
+  getModificationMetadata: () => Promise<MaintenanceWindowModificationMetadata>;
+  savedObjectsClient: SavedObjectsClientContract;
+  logger: Logger;
+}
+
+export const MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE = 'maintenance-window';
+export const MAINTENANCE_WINDOW_FEATURE_ID = 'maintenanceWindow';
+export const MAINTENANCE_WINDOW_API_PRIVILEGES = {
+  READ_MAINTENANCE_WINDOW: 'read-maintenance-window',
+  WRITE_MAINTENANCE_WINDOW: 'write-maintenance-window',
+};

x-pack/plugins/alerting/common/rrule_type.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 type { WeekdayStr } from 'rrule';
+
+export type RRuleParams = Partial<RRuleRecord> & Pick<RRuleRecord, 'dtstart' | 'tzid'>;
+
+// An iCal RRULE  to define a recurrence schedule, see https://github.com/jakubroztocil/rrule for the spec
+export interface RRuleRecord {
+  dtstart: string;
+  tzid: string;
+  freq?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+  until?: string;
+  count?: number;
+  interval?: number;
+  wkst?: WeekdayStr;
+  byweekday?: Array<string | number>;
+  bymonth?: number[];
+  bysetpos?: number[];
+  bymonthday: number[];
+  byyearday: number[];
+  byweekno: number[];
+  byhour: number[];
+  byminute: number[];
+  bysecond: number[];
+}

x-pack/plugins/alerting/common/rule_snooze_type.ts

@@ -5,13 +5,11 @@
  * 2.0.
  */
 
-import type { WeekdayStr } from 'rrule';
-
-type SnoozeRRule = Partial<RRuleRecord> & Pick<RRuleRecord, 'dtstart' | 'tzid'>;
+import { RRuleParams } from './rrule_type';
 
 export interface RuleSnoozeSchedule {
   duration: number;
-  rRule: SnoozeRRule;
+  rRule: RRuleParams;
   // For scheduled/recurring snoozes, `id` uniquely identifies them so that they can be displayed, modified, and deleted individually
   id?: string;
   skipRecurrences?: string[];
@@ -21,27 +19,7 @@ export interface RuleSnoozeSchedule {
 // RuleSnooze = RuleSnoozeSchedule[] throws typescript errors across the whole lib
 export type RuleSnooze = Array<{
   duration: number;
-  rRule: SnoozeRRule;
+  rRule: RRuleParams;
   id?: string;
   skipRecurrences?: string[];
 }>;
-
-// An iCal RRULE  to define a recurrence schedule, see https://github.com/jakubroztocil/rrule for the spec
-export interface RRuleRecord {
-  dtstart: string;
-  tzid: string;
-  freq?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
-  until?: string;
-  count?: number;
-  interval?: number;
-  wkst?: WeekdayStr;
-  byweekday?: Array<string | number>;
-  bymonth?: number[];
-  bysetpos?: number[];
-  bymonthday: number[];
-  byyearday: number[];
-  byweekno: number[];
-  byhour: number[];
-  byminute: number[];
-  bysecond: number[];
-}

x-pack/plugins/alerting/server/lib/rrule/index.ts

@@ -0,0 +1,8 @@
+/*
+ * 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 * from './parse_by_weekday';

x-pack/plugins/alerting/server/lib/rrule/parse_by_weekday.ts

@@ -0,0 +1,13 @@
+/*
+ * 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 { ByWeekday, rrulestr } from 'rrule';
+
+export function parseByWeekday(byweekday: Array<string | number>): ByWeekday[] {
+  const rRuleString = `RRULE:BYDAY=${byweekday.join(',')}`;
+  const parsedRRule = rrulestr(rRuleString);
+  return parsedRRule.origOptions.byweekday as ByWeekday[];
+}

x-pack/plugins/alerting/server/maintenance_window_client/generate_maintenance_window_events.test.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 moment from 'moment';
+import { generateMaintenanceWindowEvents } from './generate_maintenance_window_events';
+
+describe('generateMaintenanceWindowEvents', () => {
+  beforeAll(() => {
+    jest.useFakeTimers().setSystemTime(new Date('2023-02-27T00:00:00.000Z'));
+  });
+
+  it('should generate events', () => {
+    const result = generateMaintenanceWindowEvents({
+      duration: 1 * 60 * 60 * 1000,
+      expirationDate: moment(new Date('2023-02-27T00:00:00.000Z')).add(5, 'weeks').toISOString(),
+      rRule: {
+        tzid: 'UTC',
+        freq: 2,
+        interval: 1,
+        dtstart: '2023-02-27T00:00:00.000Z',
+      },
+    });
+
+    expect(result.length).toEqual(5);
+
+    expect(result[0].gte).toEqual('2023-02-27T00:00:00.000Z');
+    expect(result[0].lte).toEqual('2023-02-27T01:00:00.000Z');
+
+    expect(result[4].gte).toEqual('2023-03-27T00:00:00.000Z');
+    expect(result[4].lte).toEqual('2023-03-27T01:00:00.000Z');
+  });
+});

x-pack/plugins/alerting/server/maintenance_window_client/generate_maintenance_window_events.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 moment from 'moment';
+import { RRule, Weekday } from 'rrule';
+import { parseByWeekday } from '../lib/rrule';
+import { RRuleParams } from '../../common';
+
+export interface GenerateMaintenanceWindowEventsParams {
+  rRule: RRuleParams;
+  expirationDate: string;
+  duration: number;
+}
+
+export const generateMaintenanceWindowEvents = ({
+  rRule,
+  expirationDate,
+  duration,
+}: GenerateMaintenanceWindowEventsParams) => {
+  const { dtstart, until, wkst, byweekday } = rRule;
+  const rRuleOptions = {
+    ...rRule,
+    dtstart: new Date(dtstart),
+    until: until ? new Date(until) : null,
+    wkst: wkst ? Weekday.fromStr(wkst) : null,
+    byweekday: byweekday ? parseByWeekday(byweekday) : null,
+  };
+
+  try {
+    const startDate = new Date(dtstart);
+    const endDate = new Date(expirationDate);
+    const recurrenceRule = new RRule(rRuleOptions);
+    const occurrenceDates = recurrenceRule.between(startDate, endDate, true);
+
+    return occurrenceDates.map((date) => ({
+      gte: date.toISOString(),
+      lte: moment(date).add(duration, 'ms').toISOString(),
+    }));
+  } catch (e) {
+    throw new Error(`Failed to process RRule ${rRule}. Error: ${e}`);
+  }
+};