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

[Lens] Partition legend order synced with filters order #154820

Merged
merged 6 commits into from
Apr 17, 2023

Conversation

dej611
Copy link
Contributor

@dej611 dej611 commented Apr 12, 2023

Summary

Fix #149034

This PR adds the legend order sync with Lens filters when there's a single category grouping dimension.

legend_filters

treemap_legend_filters

While working on the feature I've noticed also that the Nested switch in the Legend popover was always enabled when visible, also when there's a single grouping dimension and the nesting won't apply. So I've created a new disabled state for this specific case with a tooltip explanation of the disabled state.

Screenshot 2023-04-12 at 14 42 10

Screenshot 2023-04-12 at 14 42 26

Screenshot 2023-04-12 at 14 43 03

Screenshot 2023-04-12 at 14 43 22

Checklist

Delete any items that are not applicable to this PR.

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—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—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

For maintainers

@dej611 dej611 added release_note:enhancement Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Lens labels Apr 12, 2023
@dej611 dej611 added the v8.8.0 label Apr 13, 2023
@dej611 dej611 marked this pull request as ready for review April 13, 2023 07:50
@dej611 dej611 requested a review from a team as a code owner April 13, 2023 07:50
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

@stratoula
Copy link
Contributor

@dej611 should the order being applied if I have multiple layers with the filters as the parent layer?

image

@dej611
Copy link
Contributor Author

dej611 commented Apr 13, 2023

In that case it should work only when the legend is not nested (Legend popover => disable Nested switch).
There are some implementation challenges to make it work the custom sorting with nested legend on the EC side, so that scenario is not covered yet.

Copy link
Contributor

@stratoula stratoula left a comment

Choose a reason for hiding this comment

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

This works great! LGTM! I think that we have decided to hide instead of disabling the not applicable settings (talking about the nested switch) but I leave this to @MichaelMarcialis to decide.

@dej611
Copy link
Contributor Author

dej611 commented Apr 13, 2023

I thought about it, but then it feels like adding/showing the control based on the number of bucketed dimensions could make the feature a little bit harder to discover. I think show/hide makes more sense for supported/unsupported features, while in this case the nested is still applied but with no effect by the EC library.
Let's see what @MichaelMarcialis thinks about it.

@MichaelMarcialis
Copy link
Contributor

This works great! LGTM! I think that we have decided to hide instead of disabling the not applicable settings (talking about the nested switch) but I leave this to @MichaelMarcialis to decide.

I thought about it, but then it feels like adding/showing the control based on the number of bucketed dimensions could make the feature a little bit harder to discover. I think show/hide makes more sense for supported/unsupported features, while in this case the nested is still applied but with no effect by the EC library.
Let's see what @MichaelMarcialis thinks about it.

@stratoula, @dej611: If we're saying that nesting will always be "off" when there is a single grouping dimension, my initial instinct is to hide it instead of disabling it. If it were the inverse (i.e. a feature that was always "on" in a certain state), I might be more incline to show it as disabled, but that doesn't sound like the case here.

Copy link
Contributor

@MichaelMarcialis MichaelMarcialis left a comment

Choose a reason for hiding this comment

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

Code review only. LGTM, after my previous comment about hiding/disabling the nested switch is address.

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #4 / cases security and spaces enabled: no_public_base_url push_case incident recorder server should format the comments correctly

Metrics [docs]

Async chunks

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

id before after diff
expressionPartitionVis 53.1KB 53.3KB +260.0B
lens 1.3MB 1.3MB +208.0B
total +468.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
securitySolution 432 435 +3

Total ESLint disabled count

id before after diff
securitySolution 512 515 +3

History

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

@dej611 dej611 merged commit e3d7bf3 into elastic:main Apr 17, 2023
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Apr 17, 2023
nikitaindik pushed a commit to nikitaindik/kibana that referenced this pull request Apr 18, 2023
## Summary

Fix elastic#149034

This PR adds the legend order sync with Lens filters when there's a
single category grouping dimension.


![legend_filters](https://user-images.githubusercontent.com/924948/231465750-c26532c0-e63e-4472-ae69-a853c4f250b4.gif)


![treemap_legend_filters](https://user-images.githubusercontent.com/924948/231466081-d78ab1b0-170b-40c3-8316-5b575c788218.gif)

While working on the feature I've noticed also that the `Nested` switch
in the Legend popover was always enabled when visible, also when there's
a single grouping dimension and the nesting won't apply. So I've created
a new `disabled` state for this specific case with a tooltip explanation
of the disabled state.

<img width="862" alt="Screenshot 2023-04-12 at 14 42 10"
src="https://user-images.githubusercontent.com/924948/231466601-eef3d9af-1c98-4e97-b497-529f3aee412f.png">
<img width="861" alt="Screenshot 2023-04-12 at 14 42 26"
src="https://user-images.githubusercontent.com/924948/231466605-8228b922-f92c-4928-a03c-4ba540c38427.png">
<img width="850" alt="Screenshot 2023-04-12 at 14 43 03"
src="https://user-images.githubusercontent.com/924948/231466608-9a196284-1dff-4ef0-8495-d6721dbce2ae.png">
<img width="851" alt="Screenshot 2023-04-12 at 14 43 22"
src="https://user-images.githubusercontent.com/924948/231466611-0a7facbc-7f05-4206-b035-c481c6e4400f.png">


### 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
- [ ] 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: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
saarikabhasi pushed a commit to saarikabhasi/kibana that referenced this pull request Apr 19, 2023
## Summary

Fix elastic#149034

This PR adds the legend order sync with Lens filters when there's a
single category grouping dimension.


![legend_filters](https://user-images.githubusercontent.com/924948/231465750-c26532c0-e63e-4472-ae69-a853c4f250b4.gif)


![treemap_legend_filters](https://user-images.githubusercontent.com/924948/231466081-d78ab1b0-170b-40c3-8316-5b575c788218.gif)

While working on the feature I've noticed also that the `Nested` switch
in the Legend popover was always enabled when visible, also when there's
a single grouping dimension and the nesting won't apply. So I've created
a new `disabled` state for this specific case with a tooltip explanation
of the disabled state.

<img width="862" alt="Screenshot 2023-04-12 at 14 42 10"
src="https://user-images.githubusercontent.com/924948/231466601-eef3d9af-1c98-4e97-b497-529f3aee412f.png">
<img width="861" alt="Screenshot 2023-04-12 at 14 42 26"
src="https://user-images.githubusercontent.com/924948/231466605-8228b922-f92c-4928-a03c-4ba540c38427.png">
<img width="850" alt="Screenshot 2023-04-12 at 14 43 03"
src="https://user-images.githubusercontent.com/924948/231466608-9a196284-1dff-4ef0-8495-d6721dbce2ae.png">
<img width="851" alt="Screenshot 2023-04-12 at 14 43 22"
src="https://user-images.githubusercontent.com/924948/231466611-0a7facbc-7f05-4206-b035-c481c6e4400f.png">


### 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
- [ ] 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: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
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 Feature:Lens release_note:enhancement Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Lens] Keep the filters order in the partition chart legend
6 participants