Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract Kibana Privilege Feature table into package #189871

Conversation

eokoneyo
Copy link
Contributor

@eokoneyo eokoneyo commented Aug 5, 2024

Summary

This PR extracts the kibana privilege component into a package, to support the work that's been done to integrate role privilege selection within the newly improved spaces administration app, and is the last in the series of PR to make this possible. Without this undertaken we would be creating cyclic dependency between the security and spaces plugin, the image below provides a visual representation on how this PR resolves the aforementioned issue;

image1

This particular component, alongside the components that it's composed of will now be housed in @kbn/security-ui-components (P.S. I'm not too entirely sure about the naming, suggestions welcome).

Footnotes

  1. item marked in blue is the package created in this PR.

@eokoneyo eokoneyo self-assigned this Aug 5, 2024
@eokoneyo eokoneyo added Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! release_note:skip Skip the PR/issue when compiling release notes labels Aug 13, 2024
eokoneyo added a commit that referenced this pull request Aug 22, 2024
## Summary

This PR is a precursor to #189871,
as part of the spaces improvement initiative there's a need to be able
to share the user privilege assignment component between the roles
experience and the new spaces experience to prevent duplication of
business logic and cohesiveness in the privilege assignment experience.

The aforementioned PR extracts the required component into it's own
package so it might be consumed as needed, this PR is particularly
concerned with extracting business logic said UI component depends on
that exists still within the security plugin. For context; the security
plugin already depends on the spaces plugin, so having the spaces plugin
in turn statically depend on the security plugin creates a cyclic
dependency. That being said to complement the eventual state of said
component so it might be imported elsewhere outside of the security
plugin there's a need to extract further logic into standalone packages,
so that the spaces plugin can consume this plugin without the afore
mentioned cyclic dependency problem.


#### Visually; 

##### Problem;


![image](https://github.com/user-attachments/assets/6be85fb0-3ba3-4d5f-b614-3c0ff2cf7c69)

##### Proposal

![image](https://github.com/user-attachments/assets/5c4f423d-4ad4-48f4-b5bd-2ea0a99b196e)[^legend]

[^legend]: items marked in blue are the packages created in this PR,
whilst the entire diagram is the proposed future state

<!--### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@eokoneyo eokoneyo force-pushed the chore/extract-kibana-privilege-table-into-package branch 4 times, most recently from fb09cfd to 5cec056 Compare August 23, 2024 10:16
@eokoneyo
Copy link
Contributor Author

/ci

@eokoneyo eokoneyo force-pushed the chore/extract-kibana-privilege-table-into-package branch from 5cec056 to fa60e4a Compare August 23, 2024 14:00
@eokoneyo
Copy link
Contributor Author

/ci

@eokoneyo eokoneyo marked this pull request as ready for review August 23, 2024 14:01
@eokoneyo eokoneyo requested review from a team as code owners August 23, 2024 14:01
@elasticmachine
Copy link
Contributor

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

@eokoneyo
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Contributor

@ryankeairns ryankeairns left a comment

Choose a reason for hiding this comment

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

Moved scss files.

@eokoneyo eokoneyo force-pushed the chore/extract-kibana-privilege-table-into-package branch from a176189 to 837d477 Compare August 26, 2024 09:41
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
security 523 524 +1

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-ui-components - 12 +12

Async chunks

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

id before after diff
security 589.4KB 589.8KB +462.0B
Unknown metric groups

API count

id before after diff
@kbn/security-ui-components - 47 +47

History

  • 💛 Build #229526 was flaky b5a823fd2ede3bea144118188552e56816ba03b3
  • 💔 Build #229474 failed fa60e4a911fc5fd069c70712c0d27be7396cd8b2
  • 💔 Build #229406 failed 5cec0560336ea7ee596ed4af6f81655c3475bcf1
  • 💔 Build #229360 failed fb09cfdd0c686a486255de8e06a2b6432b367e55
  • 💔 Build #229241 failed 20eecf2eed56ff7cb742654f8839e8dac4c4a970
  • 💔 Build #229214 failed 30a5c45bed411f7753f80cb30d900dbfde31d64e

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

cc @eokoneyo

Copy link
Contributor

@SiddharthMantri SiddharthMantri left a comment

Choose a reason for hiding this comment

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

LGTM!

@eokoneyo eokoneyo merged commit fd312e3 into elastic:main Aug 27, 2024
39 checks passed
@eokoneyo eokoneyo deleted the chore/extract-kibana-privilege-table-into-package branch August 27, 2024 14:17
@kibanamachine kibanamachine added v8.16.0 backport:skip This commit does not require backporting labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants