[RAM][Maintenance Window] Maintenance window scoped query frontend changes #171949

JiaweiWu · 2023-11-26T00:29:36Z

Summary

Partially resolves: #164255, this is 2/3 of the scoped query changes.

Maintenance window scoped query frontend changes. Adds the ability to add and edit scoped query for maintenance windows. Due to limitations with the alerts search bar and each solution fetches AAD fields, we only allow users to associate scoped query with 1 category (manangement, o11y, or security solution). The intended usage in this case is for the user to create multiple maintenance windows if they wish to apply scoped queries to multiple solutions.

To test:

go to x-pack/plugins/alerting/public/pages/maintenance_windows/constants.ts and set IS_SCOPED_QUERY_ENABLED to true

Scoped query off, multiple category allowed:

Scoped query on, multiple category disallowed:

Checklist

Unit or functional tests were updated or added to match the most common scenarios

JiaweiWu · 2023-11-26T00:30:07Z

@elasticmachine merge upstream

…fix'

…-fix'

elasticmachine · 2023-11-27T17:21:27Z

Pinging @elastic/response-ops (Team:ResponseOps)

JiaweiWu · 2023-11-29T20:11:53Z

@elasticmachine merge upstream

XavierM · 2023-11-30T19:23:44Z

packages/kbn-alerting-types/README.md

@@ -0,0 +1,3 @@
+# @kbn/alerting-types


do we need to add some explanation for future user?

XavierM · 2023-11-30T19:31:57Z

packages/kbn-alerts-ui-shared/src/alerts_search_bar/hooks/use_load_rule_types_query.ts

+  const filteredIndex = data ? getFilteredIndex(data, filteredRuleTypes) : new Map();
+
+  const hasAnyAuthorizedRuleType = filteredIndex.size > 0;
+  const authorizedRuleTypes = [...filteredIndex.values()];
+  const authorizedToCreateAnyRules = authorizedRuleTypes.some(
+    (ruleType) => ruleType.authorizedConsumers[ALERTS_FEATURE_ID]?.all
+  );
+  const authorizedToReadAnyRules =
+    authorizedToCreateAnyRules ||
+    authorizedRuleTypes.some((ruleType) => ruleType.authorizedConsumers[ALERTS_FEATURE_ID]?.read);
+
+  return {
+    ruleTypesState: {
+      initialLoad: isLoading || isInitialLoading,
+      isLoading: isLoading || isFetching,
+      data: filteredIndex,
+    },
+    hasAnyAuthorizedRuleType,
+    authorizedRuleTypes,
+    authorizedToReadAnyRules,
+    authorizedToCreateAnyRules,
+    isSuccess,
+  };
+};


Thanks to @cnasikas, I just learned that we can do all this in the select property.

DOC

I'm not going to make this change in this PR because #171417 is also touching this hook and now we have 2 copies of it and it'll be a big mess.

Ok but know we know how to do it.

packages/kbn-alerts-ui-shared/src/alerts_search_bar/index.tsx

packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts

XavierM · 2023-11-30T19:58:39Z

...ins/alerting/public/pages/maintenance_windows/components/create_maintenance_windows_form.tsx

+  );
+
+  const modal = useMemo(() => {
+    let m;


I thought that jsx, we will not like to render an undefined value but it will be ok with null.

react is too smart

maybe it just got smarter!

x-pack/plugins/alerting/public/services/maintenance_windows_api/get.ts

XavierM

To test this PR, I used #172117.

The different scenario that I created to test this PR are the follows:

I created 4 different window maintenances under main with different categories and all of them, then upgraded to your PR. I was able to see my window maintenances set up as previously.
I created two log threshold rules with different tags and create a window maintenance with scope query around one of my tag. I was able to confirm that we still send the recover notification when the alert was active outside of the window maintenance but after that we kept this rule muted. I was also able to confirm that the other rule in the same category was still notifying me.
I tested that when we toggle the scope query then we keep in memory the query but we do not keep the history of our category. I thing we should fix that.
In future PR, we should make sure to validate all the fields that we use in the query by querying the fields caps API to make sure that these fields belong to index associated to our category. That will help us to be closer to the versioning API requirements and also making sure user do not use something that we will never support.

@JiaweiWu, I think we should fix #3 and I will be all good to give the green light on this awesome feature. Well done!

kibana-ci · 2023-12-04T23:07:26Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 7afeb0b

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`alerting`	101	151	+50
`observability`	517	531	+14
`securitySolution`	4773	4787	+14
`triggersActionsUi`	623	640	+17
total			+95

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/actions-types`	-	5	+5
`@kbn/alerting-types`	-	29	+29
`@kbn/alerts-ui-shared`	10	82	+72
`@kbn/triggers-actions-ui-types`	-	11	+11
`alerting`	783	791	+8
`triggersActionsUi`	558	559	+1
total			+126

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`alerting`	70.4KB	89.1KB	+18.7KB
`observability`	1.1MB	1.1MB	+152.0B
`securitySolution`	12.8MB	12.8MB	+153.0B
total			+19.0KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`triggersActionsUi`	55	54	-1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`alerting`	23.3KB	23.5KB	+180.0B
`triggersActionsUi`	104.1KB	104.2KB	+148.0B
total			+328.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/actions-types`	-	5	+5
`@kbn/alerting-types`	-	29	+29
`@kbn/alerts-ui-shared`	11	83	+72
`@kbn/triggers-actions-ui-types`	-	11	+11
`alerting`	814	822	+8
`triggersActionsUi`	584	585	+1
total			+126

ESLint disabled line counts

id	before	after	diff
`@kbn/alerts-ui-shared`	3	5	+2

Total ESLint disabled count

id	before	after	diff
`@kbn/alerts-ui-shared`	3	5	+2

History

💚 Build #180253 succeeded e0c998a
💚 Build #180250 succeeded abcd3a1
💚 Build #178960 succeeded cf4cfdc
💔 Build #178951 failed ce9f7f7
💔 Build #178949 failed 00ebe60

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

JiaweiWu and others added 8 commits November 20, 2023 22:52

MW scoped query API and schema changes

08d7210

Merge branch 'main' into mw-scoped-query-api-changes

eee5cb8

WIP

61ff8d4

WIP packages

4a97122

Merge branch 'main' into issue-164255-mw-filtering-fe-and-api

6f80f82

Fix packages

a7165db

Merge branch 'main' into issue-164255-mw-filtering-fe-and-api

c6f17fe

MW scoped query FE changes

0553e5a

JiaweiWu added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Alerting/RulesManagement Issues related to the Rules Management UX v8.12.0 labels Nov 26, 2023

kibanamachine and others added 6 commits November 25, 2023 19:30

Merge branch 'main' into issue-164255-mw-filtering-fe-and-api

3977779

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

164349b

…fix'

[CI] Auto-commit changed files from 'node scripts/generate codeowners'

00ebe60

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

d79cd5e

…-fix'

fix translations

ce9f7f7

Fix tests

cf4cfdc

JiaweiWu marked this pull request as ready for review November 27, 2023 17:21

JiaweiWu requested a review from a team as a code owner November 27, 2023 17:21

JiaweiWu added 3 commits November 27, 2023 10:31

Merge branch 'main' into issue-164255-mw-filtering-fe-and-api

2a09c42

merge conflicts

f3ac0d9

Put changes behind flag

abcd3a1

Merge branch 'main' into issue-164255-mw-filtering-fe-and-api

e0c998a

XavierM reviewed Nov 30, 2023

View reviewed changes

packages/kbn-alerting-types/README.md

@@ -0,0 +1,3 @@

# @kbn/alerting-types

Copy link

Contributor

XavierM Nov 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to add some explanation for future user?

XavierM reviewed Nov 30, 2023

View reviewed changes

packages/kbn-alerts-ui-shared/src/alerts_search_bar/index.tsx Show resolved Hide resolved

XavierM reviewed Nov 30, 2023

View reviewed changes

packages/kbn-alerts-ui-shared/src/alerts_search_bar/types.ts Show resolved Hide resolved

XavierM reviewed Nov 30, 2023

View reviewed changes

x-pack/plugins/alerting/public/services/maintenance_windows_api/get.ts Show resolved Hide resolved

XavierM reviewed Dec 4, 2023

View reviewed changes

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into issue-164255-mw-filtering-fe-and-api

276927e

This comment was marked as resolved.

Sign in to view

Address comments

7afeb0b

This comment was marked as abuse.

Sign in to view

XavierM approved these changes Dec 4, 2023

View reviewed changes

JiaweiWu merged commit e4805fc into elastic:main Dec 4, 2023
33 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Dec 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RAM][Maintenance Window] Maintenance window scoped query frontend changes #171949

[RAM][Maintenance Window] Maintenance window scoped query frontend changes #171949

JiaweiWu commented Nov 26, 2023 •

edited

Loading

JiaweiWu commented Nov 26, 2023

elasticmachine commented Nov 27, 2023

JiaweiWu commented Nov 29, 2023

XavierM Nov 30, 2023

XavierM Nov 30, 2023

JiaweiWu Dec 4, 2023 •

edited

Loading

XavierM Dec 4, 2023

XavierM Nov 30, 2023

JiaweiWu Dec 4, 2023

XavierM Dec 4, 2023

XavierM left a comment •

edited

Loading

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as abuse.

kibana-ci commented Dec 4, 2023

API count

ESLint disabled line counts

Total ESLint disabled count

[RAM][Maintenance Window] Maintenance window scoped query frontend changes #171949

[RAM][Maintenance Window] Maintenance window scoped query frontend changes #171949

Conversation

JiaweiWu commented Nov 26, 2023 • edited Loading

Summary

To test:

Scoped query off, multiple category allowed:

Scoped query on, multiple category disallowed:

Checklist

JiaweiWu commented Nov 26, 2023

elasticmachine commented Nov 27, 2023

JiaweiWu commented Nov 29, 2023

XavierM Nov 30, 2023

Choose a reason for hiding this comment

XavierM Nov 30, 2023

Choose a reason for hiding this comment

JiaweiWu Dec 4, 2023 • edited Loading

Choose a reason for hiding this comment

XavierM Dec 4, 2023

Choose a reason for hiding this comment

XavierM Nov 30, 2023

Choose a reason for hiding this comment

JiaweiWu Dec 4, 2023

Choose a reason for hiding this comment

XavierM Dec 4, 2023

Choose a reason for hiding this comment

XavierM left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as abuse.

kibana-ci commented Dec 4, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

JiaweiWu commented Nov 26, 2023 •

edited

Loading

JiaweiWu Dec 4, 2023 •

edited

Loading

XavierM left a comment •

edited

Loading