[Roles] Use Query Roles API for Role Management grid screen #194630

SiddharthMantri · 2024-10-01T18:47:55Z

Release notes

Enhanced Role management to manage larger number of roles by adding server side filtering, pagination and querying.

Summary

Replaced the usage of Get Roles API with Query Role API
Added server side pagination and filtering with a maximum limit of 10000 keys (default for max results on index). Added new label to indicate that we show only 10k results.
Search box replicates client side implementation by only filtering on Role names.

Run locally

Start ES with the JVM option to enable this feature:

ES_JAVA_OPTS="-Des.queryable_built_in_roles_enabled=true" yarn es snapshot --license=trial

Start Kibana normally

yarn start --no-base-path

Navigate to Stack Management > Roles and verify the same behavior as the screen recording below

Screen recording

Screen.Recording.2024-12-23.at.19.46.42.mov

Technical notes

Client side EuiInMemory table has been replaced by EuiSearchBar, EuiBasicTable and Filters
One new Kibana endpoint added
- roles/_query
- Replicates existing get_role endpoint by being public and added to Open API spec
Extra logic to handle previously UI only filter to show/hide reserved roles
- Parse the query to construct the correct DSL if the filter is present
Update Get All Roles by Space internal API to use the Query Role and filter by space id using query DSL.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

…ks to reduce complexity

SiddharthMantri · 2024-12-18T07:01:44Z

@elasticmachine merge upstream

SiddharthMantri · 2024-12-23T10:27:51Z

@elasticmachine merge upstream

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --include-path /api/dashboards --update'

elasticmachine · 2024-12-23T11:11:59Z

Pinging @elastic/kibana-security (Team:Security)

kc13greiner · 2025-01-08T03:32:35Z

x-pack/plugins/security/server/routes/authorization/roles/query.ts

+  logger,
+  buildFlavor,
+}: RouteDefinitionParams) {
+  router.post(


Question: Should this be switched to use the versioned router? I see many of the other routes in this directory use it

Ooh, good point! What makes us choose versioned router vs regular router when building these routes?

Looking for guidance. Ill have some feedback soon

Ok so I have the following: For public routes, we will always want to use the versioned router. Otherwise, it's still strongly preferred, but not mandatory.

Nice, thank you! Updated to versioned router in 989120f

x-pack/plugins/security/server/routes/authorization/roles/query.ts

x-pack/plugins/security/server/routes/authorization/roles/query.test.ts

x-pack/test/api_integration/apis/security/roles.ts

x-pack/platform/plugins/shared/security/server/routes/authorization/roles/query.test.ts

SiddharthMantri · 2025-01-14T13:28:45Z

@elasticmachine merge upstream

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --include-path /api/dashboards --update'

kc13greiner · 2025-01-15T04:32:28Z

Last observations/questions for my final review:

Case sensitivity
I am not sure if this is intended or just how the ES queries work, but I just wanted to raise it.

Status not sorting reserved vs non-reserved. Maybe this is intentional?

x-pack/platform/plugins/shared/security/server/routes/authorization/roles/get_all_by_space.ts

SiddharthMantri · 2025-01-15T06:25:38Z

Thank you for the review @kc13greiner! Answered the questions:

Case sensitivity
I am not sure if this is intended or just how the ES queries work, but I just wanted to raise it.

Since we're using the wildcard query on the name field, i think it defaults to case sensitivity. Happy to change it to Case insensitive search, what do you think?

Status not sorting reserved vs non-reserved. Maybe this is intentional?

I believe the field is not sortable on the API. I've changed the column config in 31cf053

kc13greiner · 2025-01-15T13:32:07Z

Thank you for the review @kc13greiner! Answered the questions:

Case sensitivity
I am not sure if this is intended or just how the ES queries work, but I just wanted to raise it.

Since we're using the wildcard query on the name field, i think it defaults to case sensitivity. Happy to change it to Case insensitive search, what do you think?

This could be a good question for product @bitzandeb !

Status not sorting reserved vs non-reserved. Maybe this is intentional?

I believe the field is not sortable on the API. I've changed the column config in 31cf053

++ makes sense - thank you!

kc13greiner

LGTM - works great, very excited for this 🚀

elasticmachine · 2025-01-15T15:21:16Z

💚 Build Succeeded

Buildkite Build
Commit: d3c7687

Metrics [docs]

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/security-plugin-types-common`	66	71	+5

Async chunks

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

id	before	after	diff
`security`	565.2KB	565.9KB	+771.0B

Page load bundle

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

id	before	after	diff
`security`	62.8KB	62.9KB	+123.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/security-plugin-types-common`	127	132	+5

History

💚 Build #267228 succeeded 31cf053
💚 Build #266990 succeeded 39e51d1
💔 Build #266886 failed 6300b66
💛 Build #266086 was flaky 399b4d5
💔 Build #266059 failed 7b84a2b
💚 Build #265503 succeeded 0b5f795

cc @SiddharthMantri

SiddharthMantri added 8 commits October 1, 2024 20:46

[Roles] Use Query Roles API for Role Management grid screen

559acad

remove unused function

af5f44e

clean up roles grid page, remove useAsyncFn and use regular react hoo…

5c4b894

…ks to reduce complexity

Add option for filtering by space id

73aad8e

replicate TS expect error

5f864f7

Merge branch 'main' into roles-management-use-query-roles

c761885

remove TS expect error and add todo

87f299d

update get all by space to use query roles api

4af8c05

elasticmachine and others added 5 commits December 18, 2024 07:01

Merge branch 'main' into roles-management-use-query-roles

ff02d56

update query endpoint to use metadata reserved roles correctly

f3df93f

update must to should

09251e2

fix tests and query dsl

012deae

update tests, add check for max items

3dd451e

SiddharthMantri marked this pull request as ready for review December 23, 2024 10:27

SiddharthMantri requested a review from a team as a code owner December 23, 2024 10:27

elasticmachine and others added 5 commits December 23, 2024 10:27

Merge branch 'main' into roles-management-use-query-roles

7a4bbc0

remove console log

d921b6e

use fallback for no roles

b1a3e8d

remove logs

95653e7

SiddharthMantri and others added 2 commits January 2, 2025 19:50

update page size to 1000

af84349

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

3710780

kc13greiner self-requested a review January 2, 2025 20:43

kc13greiner reviewed Jan 8, 2025

View reviewed changes

x-pack/plugins/security/server/routes/authorization/roles/query.ts Outdated Show resolved Hide resolved

kc13greiner reviewed Jan 8, 2025

View reviewed changes

x-pack/plugins/security/server/routes/authorization/roles/query.test.ts Outdated Show resolved Hide resolved

kc13greiner reviewed Jan 8, 2025

View reviewed changes

x-pack/test/api_integration/apis/security/roles.ts Show resolved Hide resolved

SiddharthMantri added 2 commits January 9, 2025 10:04

fix tests, update authz

0b5f795

updat config

1c542ce

SiddharthMantri force-pushed the roles-management-use-query-roles branch from 7b84a2b to 1c542ce Compare January 10, 2025 14:15

SiddharthMantri added 2 commits January 10, 2025 15:21

fix two files in merge

bb26a0f

remove unused term query

399b4d5

SiddharthMantri requested a review from kc13greiner January 13, 2025 10:08

kc13greiner reviewed Jan 13, 2025

View reviewed changes

x-pack/platform/plugins/shared/security/server/routes/authorization/roles/query.test.ts Outdated Show resolved Hide resolved

update test

6300b66

elasticmachine and others added 2 commits January 14, 2025 13:28

Merge branch 'main' into roles-management-use-query-roles

bbab456

use versioned router, update tests and api client

989120f

SiddharthMantri requested a review from kc13greiner January 14, 2025 14:14

kibanamachine added 2 commits January 14, 2025 14:24

[CI] Auto-commit changed files from 'make api-docs'

39e51d1

kc13greiner reviewed Jan 15, 2025

View reviewed changes

x-pack/platform/plugins/shared/security/server/routes/authorization/roles/get_all_by_space.ts Show resolved Hide resolved

remove sortable status column

31cf053

kc13greiner assigned SiddharthMantri Jan 15, 2025

kc13greiner approved these changes Jan 15, 2025

View reviewed changes

change wildcard to case insensitive

d3c7687

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Roles] Use Query Roles API for Role Management grid screen #194630

[Roles] Use Query Roles API for Role Management grid screen #194630

SiddharthMantri commented Oct 1, 2024 •

edited

Loading

SiddharthMantri commented Dec 18, 2024

SiddharthMantri commented Dec 23, 2024

elasticmachine commented Dec 23, 2024

kc13greiner Jan 8, 2025

SiddharthMantri Jan 10, 2025

kc13greiner Jan 14, 2025

kc13greiner Jan 14, 2025

SiddharthMantri Jan 14, 2025

SiddharthMantri commented Jan 14, 2025

kc13greiner commented Jan 15, 2025

SiddharthMantri commented Jan 15, 2025 •

edited

Loading

kc13greiner commented Jan 15, 2025

kc13greiner left a comment

elasticmachine commented Jan 15, 2025

API count

[Roles] Use Query Roles API for Role Management grid screen #194630

Are you sure you want to change the base?

[Roles] Use Query Roles API for Role Management grid screen #194630

Conversation

SiddharthMantri commented Oct 1, 2024 • edited Loading

Release notes

Summary

Run locally

Screen recording

Technical notes

Checklist

SiddharthMantri commented Dec 18, 2024

SiddharthMantri commented Dec 23, 2024

elasticmachine commented Dec 23, 2024

kc13greiner Jan 8, 2025

Choose a reason for hiding this comment

SiddharthMantri Jan 10, 2025

Choose a reason for hiding this comment

kc13greiner Jan 14, 2025

Choose a reason for hiding this comment

kc13greiner Jan 14, 2025

Choose a reason for hiding this comment

SiddharthMantri Jan 14, 2025

Choose a reason for hiding this comment

SiddharthMantri commented Jan 14, 2025

kc13greiner commented Jan 15, 2025

SiddharthMantri commented Jan 15, 2025 • edited Loading

kc13greiner commented Jan 15, 2025

kc13greiner left a comment

Choose a reason for hiding this comment

elasticmachine commented Jan 15, 2025

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

SiddharthMantri commented Oct 1, 2024 •

edited

Loading

SiddharthMantri commented Jan 15, 2025 •

edited

Loading