[RAM][Maintenance Window] MW scoped query schema and API changes (#17…

…1597)

## Summary

Partially Resolves: #164255

This pull request is part 1/3 to add scoped queries to maintenance
windows. More specifically, this PR adds the new `scoped_query` field to
the `maintenanceWindow` type and schema. Also adds the `scoped_query`
field to `create/update` maintenance window APIs.

This PR only contains the schema and API component. All changes should
be backwards compatible since the `scoped_query` field is optional. So
this PR can be merged without any dependencies.

The 2 PRs that comes after will be:
- Frontend changes
- Task runner changes

### Checklist
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

Co-authored-by: Kibana Machine <[email protected]>

x-pack/plugins/alerting/server/constants/plugin.ts → x-pack/plugins/alerting/common/constants/plugin.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { LicenseType } from '@kbn/licensing-plugin/server';
+import type { LicenseType } from '@kbn/licensing-plugin/server';
 
 export const PLUGIN = {
   ID: 'alerting',

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

@@ -14,6 +14,13 @@ export enum MaintenanceWindowStatus {
   Archived = 'archived',
 }
 
+export const filterStateStore = {
+  APP_STATE: 'appState',
+  GLOBAL_STATE: 'globalState',
+} as const;
+
+export type FilterStateStore = typeof filterStateStore[keyof typeof filterStateStore];
+
 export interface MaintenanceWindowModificationMetadata {
   createdBy: string | null;
   updatedBy: string | null;
@@ -26,6 +33,23 @@ export interface DateRange {
   lte: string;
 }
 
+export interface ScopeQueryFilter {
+  query?: Record<string, unknown>;
+  meta: Record<string, unknown>;
+  $state?: {
+    store: FilterStateStore;
+  };
+}
+
+export interface ScopedQueryAttributes {
+  kql: string;
+  filters: ScopeQueryFilter[];
+  dsl?: string;
+}
+
+/**
+ * @deprecated Use the data/maintenance_window types instead
+ */
 export interface MaintenanceWindowSOProperties {
   title: string;
   enabled: boolean;
@@ -34,11 +58,18 @@ export interface MaintenanceWindowSOProperties {
   events: DateRange[];
   rRule: RRuleParams;
   categoryIds?: string[] | null;
+  scopedQuery?: ScopedQueryAttributes | null;
 }
 
+/**
+ * @deprecated Use the data/maintenance_window types instead
+ */
 export type MaintenanceWindowSOAttributes = MaintenanceWindowSOProperties &
   MaintenanceWindowModificationMetadata;
 
+/**
+ * @deprecated Use the application/maintenance_window types instead
+ */
 export type MaintenanceWindow = MaintenanceWindowSOAttributes & {
   status: MaintenanceWindowStatus;
   eventStartTime: string | null;

x-pack/plugins/alerting/common/routes/alerts_filter_query/constants/latest.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 { filterStateStore } from './v1';
+export type { FilterStateStore } from './v1';

x-pack/plugins/alerting/common/routes/alerts_filter_query/constants/v1.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.
+ */
+
+export const filterStateStore = {
+  APP_STATE: 'appState',
+  GLOBAL_STATE: 'globalState',
+} as const;
+
+export type FilterStateStore = typeof filterStateStore[keyof typeof filterStateStore];

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

@@ -0,0 +1,14 @@
+/*
+ * 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 { filterStateStore } from './constants/latest';
+export type { FilterStateStore } from './constants/latest';
+export { alertsFilterQuerySchema } from './schemas/latest';
+
+export { filterStateStore as filterStateStoreV1 } from './constants/v1';
+export type { FilterStateStore as FilterStateStoreV1 } from './constants/v1';
+export { alertsFilterQuerySchema as alertsFilterQuerySchemaV1 } from './schemas/v1';

x-pack/plugins/alerting/common/routes/alerts_filter_query/schemas/latest.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 { alertsFilterQuerySchema } from './v1';

x-pack/plugins/alerting/common/routes/alerts_filter_query/schemas/v1.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 { filterStateStore } from '..';
+
+export const alertsFilterQuerySchema = schema.object({
+  kql: schema.string(),
+  filters: schema.arrayOf(
+    schema.object({
+      query: schema.maybe(schema.recordOf(schema.string(), schema.any())),
+      meta: schema.recordOf(schema.string(), schema.any()),
+      $state: schema.maybe(
+        schema.object({
+          store: schema.oneOf([
+            schema.literal(filterStateStore.APP_STATE),
+            schema.literal(filterStateStore.GLOBAL_STATE),
+          ]),
+        })
+      ),
+    })
+  ),
+  dsl: schema.maybe(schema.string()),
+});

x-pack/plugins/alerting/common/routes/maintenance_window/apis/create/schemas/v1.ts

@@ -8,10 +8,12 @@
 import { schema } from '@kbn/config-schema';
 import { maintenanceWindowCategoryIdsSchemaV1 } from '../../../shared';
 import { rRuleRequestSchemaV1 } from '../../../../r_rule';
+import { alertsFilterQuerySchemaV1 } from '../../../../alerts_filter_query';
 
 export const createBodySchema = schema.object({
   title: schema.string(),
   duration: schema.number(),
   r_rule: rRuleRequestSchemaV1,
   category_ids: maintenanceWindowCategoryIdsSchemaV1,
+  scoped_query: schema.maybe(schema.nullable(alertsFilterQuerySchemaV1)),
 });

x-pack/plugins/alerting/common/routes/maintenance_window/apis/update/schemas/v1.ts

@@ -8,6 +8,7 @@
 import { schema } from '@kbn/config-schema';
 import { maintenanceWindowCategoryIdsSchemaV1 } from '../../../shared';
 import { rRuleRequestSchemaV1 } from '../../../../r_rule';
+import { alertsFilterQuerySchemaV1 } from '../../../../alerts_filter_query';
 
 export const updateParamsSchema = schema.object({
   id: schema.string(),
@@ -19,4 +20,5 @@ export const updateBodySchema = schema.object({
   duration: schema.maybe(schema.number()),
   r_rule: schema.maybe(rRuleRequestSchemaV1),
   category_ids: maintenanceWindowCategoryIdsSchemaV1,
+  scoped_query: schema.maybe(schema.nullable(alertsFilterQuerySchemaV1)),
 });

x-pack/plugins/alerting/common/routes/maintenance_window/response/schemas/v1.ts

@@ -9,6 +9,7 @@ import { schema } from '@kbn/config-schema';
 import { maintenanceWindowStatusV1 } from '..';
 import { maintenanceWindowCategoryIdsSchemaV1 } from '../../shared';
 import { rRuleResponseSchemaV1 } from '../../../r_rule';
+import { alertsFilterQuerySchemaV1 } from '../../../alerts_filter_query';
 
 export const maintenanceWindowEventSchema = schema.object({
   gte: schema.string(),
@@ -36,4 +37,5 @@ export const maintenanceWindowResponseSchema = schema.object({
     schema.literal(maintenanceWindowStatusV1.ARCHIVED),
   ]),
   category_ids: maintenanceWindowCategoryIdsSchemaV1,
+  scoped_query: schema.maybe(schema.nullable(alertsFilterQuerySchemaV1)),
 });

x-pack/plugins/alerting/common/routes/rule/apis/create/schemas/v1.ts

@@ -8,7 +8,7 @@
 import { schema } from '@kbn/config-schema';
 import { validateDurationV1, validateHoursV1, validateTimezoneV1 } from '../../../validation';
 import { notifyWhenSchemaV1 } from '../../../response';
-import { filterStateStore } from '../../../common/constants/v1';
+import { alertsFilterQuerySchemaV1 } from '../../../../alerts_filter_query';
 
 export const actionFrequencySchema = schema.object({
   summary: schema.boolean(),
@@ -17,26 +17,7 @@ export const actionFrequencySchema = schema.object({
 });
 
 export const actionAlertsFilterSchema = schema.object({
-  query: schema.maybe(
-    schema.object({
-      kql: schema.string(),
-      filters: schema.arrayOf(
-        schema.object({
-          query: schema.maybe(schema.recordOf(schema.string(), schema.any())),
-          meta: schema.recordOf(schema.string(), schema.any()),
-          $state: schema.maybe(
-            schema.object({
-              store: schema.oneOf([
-                schema.literal(filterStateStore.APP_STATE),
-                schema.literal(filterStateStore.GLOBAL_STATE),
-              ]),
-            })
-          ),
-        })
-      ),
-      dsl: schema.maybe(schema.string()),
-    })
-  ),
+  query: schema.maybe(alertsFilterQuerySchemaV1),
   timeframe: schema.maybe(
     schema.object({
       days: schema.arrayOf(

x-pack/plugins/alerting/common/routes/rule/response/schemas/v1.ts

@@ -7,13 +7,13 @@
 
 import { schema } from '@kbn/config-schema';
 import { rRuleResponseSchemaV1 } from '../../../r_rule';
+import { alertsFilterQuerySchemaV1 } from '../../../alerts_filter_query';
 import {
   ruleNotifyWhen as ruleNotifyWhenV1,
   ruleExecutionStatusValues as ruleExecutionStatusValuesV1,
   ruleExecutionStatusErrorReason as ruleExecutionStatusErrorReasonV1,
   ruleExecutionStatusWarningReason as ruleExecutionStatusWarningReasonV1,
   ruleLastRunOutcomeValues as ruleLastRunOutcomeValuesV1,
-  filterStateStore as filterStateStoreV1,
 } from '../../common/constants/v1';
 import { validateNotifyWhenV1 } from '../../validation';
 
@@ -41,25 +41,7 @@ const actionFrequencySchema = schema.object({
 });
 
 const actionAlertsFilterSchema = schema.object({
-  query: schema.maybe(
-    schema.object({
-      kql: schema.string(),
-      filters: schema.arrayOf(
-        schema.object({
-          query: schema.maybe(schema.recordOf(schema.string(), schema.any())),
-          meta: schema.recordOf(schema.string(), schema.any()),
-          $state: schema.maybe(
-            schema.object({
-              store: schema.oneOf([
-                schema.literal(filterStateStoreV1.APP_STATE),
-                schema.literal(filterStateStoreV1.GLOBAL_STATE),
-              ]),
-            })
-          ),
-        })
-      ),
-    })
-  ),
+  query: schema.maybe(alertsFilterQuerySchemaV1),
   timeframe: schema.maybe(
     schema.object({
       days: schema.arrayOf(

x-pack/plugins/alerting/server/application/alerts_filter_query/constants.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.
+ */
+
+export const filterStateStore = {
+  APP_STATE: 'appState',
+  GLOBAL_STATE: 'globalState',
+} as const;
+
+export type FilterStateStore = typeof filterStateStore[keyof typeof filterStateStore];

x-pack/plugins/alerting/server/application/alerts_filter_query/schemas/alerts_filter_query_schemas.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 { filterStateStore } from '../constants';
+
+export const alertsFilterQuerySchema = schema.object({
+  kql: schema.string(),
+  filters: schema.arrayOf(
+    schema.object({
+      query: schema.maybe(schema.recordOf(schema.string(), schema.any())),
+      meta: schema.recordOf(schema.string(), schema.any()),
+      $state: schema.maybe(
+        schema.object({
+          store: schema.oneOf([
+            schema.literal(filterStateStore.APP_STATE),
+            schema.literal(filterStateStore.GLOBAL_STATE),
+          ]),
+        })
+      ),
+    })
+  ),
+  dsl: schema.maybe(schema.string()),
+});

x-pack/plugins/alerting/server/application/alerts_filter_query/schemas/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 { alertsFilterQuerySchema } from './alerts_filter_query_schemas';

x-pack/plugins/alerting/server/application/alerts_filter_query/types/alerts_filter_query.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 { TypeOf } from '@kbn/config-schema';
+import { alertsFilterQuerySchema } from '../schemas/alerts_filter_query_schemas';
+
+export type AlertsFilterQuery = TypeOf<typeof alertsFilterQuerySchema>;

x-pack/plugins/alerting/server/application/alerts_filter_query/types/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 type { AlertsFilterQuery } from './alerts_filter_query';

x-pack/plugins/alerting/server/application/maintenance_window/constants.ts

@@ -13,8 +13,12 @@ export const maintenanceWindowStatus = {
 } as const;
 
 export const maintenanceWindowCategoryIdTypes = {
-  KIBANA: 'kibana',
   OBSERVABILITY: 'observability',
   SECURITY_SOLUTION: 'securitySolution',
   MANAGEMENT: 'management',
 } as const;
+
+export const filterStateStore = {
+  APP_STATE: 'appState',
+  GLOBAL_STATE: 'globalState',
+} as const;

x-pack/plugins/alerting/server/application/maintenance_window/lib/generate_maintenance_window_events.ts

@@ -8,7 +8,8 @@
 import _ from 'lodash';
 import moment from 'moment-timezone';
 import { RRule, Weekday } from '@kbn/rrule';
-import { RRuleParams, MaintenanceWindowSOAttributes, DateRange } from '../../../../common';
+import { RRuleParams, DateRange } from '../../../../common';
+import { MaintenanceWindow } from '../types';
 
 export interface GenerateMaintenanceWindowEventsParams {
   rRule: RRuleParams;
@@ -58,7 +59,7 @@ export const shouldRegenerateEvents = ({
   rRule,
   duration,
 }: {
-  maintenanceWindow: MaintenanceWindowSOAttributes;
+  maintenanceWindow: MaintenanceWindow;
   rRule?: RRuleParams;
   duration?: number;
 }): boolean => {