[Index Management] Add sorting for index columns added via extensions service #176163

yuliacech · 2024-02-02T15:35:56Z

Summary

Fixes #175140
Follow up for #174785

This PR fixes the sorting in the indices table for columns added via the extensions service. To test this change, add an ILM phase column as the example in this commit and follow the instructions in the ILM plugin readme.

Screenshot

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
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

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

This was checked for breaking API changes and was labeled appropriately

…rvice

This reverts commit 90bdf47.

yuliacech · 2024-02-02T15:36:05Z

/ci

elasticmachine · 2024-02-02T18:05:52Z

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

ElenaStoeva

Thanks for adding sorting and the unit tests @yuliacech! I tested locally and the sorting of the extension columns works as expected. I just have a question about the implementation, but otherwise LGTM!

ElenaStoeva · 2024-02-05T15:39:53Z

x-pack/plugins/index_management/public/services/extensions_service.ts

@@ -44,6 +44,8 @@ export interface IndicesListColumn {
  label: string;
  order: number;
  render?: (index: Index) => ReactNode;
+  // return a value used for sorting (only if the value is different from the original value at index[fieldName])
+  sort?: (index: Index) => any;


I was wondering why we need an additional sort property since we could use the already existing render property for sorting? After all, the user would expect the column to be sorted by the values that are rendered in this column.

That is just to keep the extensions service flexible: there might a property used for render and a property used for sorting, for example display_size: '58kb' and size_in_bytes: 59392

kibana-ci · 2024-02-05T18:19:38Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: ee7d613

Failed CI Steps

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
`indexManagement`	588.9KB	589.0KB	+91.0B

History

💛 Build #191107 was flaky 04415ce

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

… service (elastic#176163) ## Summary Fixes elastic#175140 Follow up for elastic#174785 This PR fixes the sorting in the indices table for columns added via the extensions service. To test this change, add an ILM phase column as the example in this [commit](elastic@90bdf47) and follow the instructions in the ILM plugin [readme](https://github.com/elastic/kibana/blob/04415ce2fc3b302efdace7f391c07047839fb0f1/x-pack/plugins/index_lifecycle_management/README.md#quick-steps-for-testing-ilm-in-index-management). ### Screenshot <img width="1088" alt="Screenshot 2024-02-02 at 18 03 34" src="https://github.com/elastic/kibana/assets/6585477/9f8b9409-ea38-41ed-9e04-636b4f61e8dd"> ### 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—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](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)

yuliacech added 4 commits February 2, 2024 15:01

[Index Management] Add sorting to the columns added via extensions se…

f2bd00f

…rvice

[Index Management] Add sorting for any index values

3a527cc

TESTING: add ilm phase column

90bdf47

Revert "TESTING: add ilm phase column"

04415ce

This reverts commit 90bdf47.

yuliacech added Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes labels Feb 2, 2024

yuliacech marked this pull request as ready for review February 2, 2024 18:05

yuliacech requested a review from a team as a code owner February 2, 2024 18:05

ElenaStoeva self-requested a review February 5, 2024 11:45

ElenaStoeva approved these changes Feb 5, 2024

View reviewed changes

Merge branch 'main' into im/indices_list/fix_columns_sorting

ee7d613

yuliacech enabled auto-merge (squash) February 5, 2024 17:00

yuliacech merged commit 7d32d6b into elastic:main Feb 5, 2024
19 checks passed

kibanamachine added v8.13.0 backport:skip This commit does not require backporting labels Feb 5, 2024

yuliacech deleted the im/indices_list/fix_columns_sorting branch February 15, 2024 12:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Index Management] Add sorting for index columns added via extensions service #176163

[Index Management] Add sorting for index columns added via extensions service #176163

yuliacech commented Feb 2, 2024 •

edited

Loading

yuliacech commented Feb 2, 2024

elasticmachine commented Feb 2, 2024

ElenaStoeva left a comment

ElenaStoeva Feb 5, 2024

yuliacech Feb 5, 2024

kibana-ci commented Feb 5, 2024

[Index Management] Add sorting for index columns added via extensions service #176163

[Index Management] Add sorting for index columns added via extensions service #176163

Conversation

yuliacech commented Feb 2, 2024 • edited Loading

Summary

Screenshot

Checklist

Risk Matrix

For maintainers

yuliacech commented Feb 2, 2024

elasticmachine commented Feb 2, 2024

ElenaStoeva left a comment

Choose a reason for hiding this comment

ElenaStoeva Feb 5, 2024

Choose a reason for hiding this comment

yuliacech Feb 5, 2024

Choose a reason for hiding this comment

kibana-ci commented Feb 5, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

History

yuliacech commented Feb 2, 2024 •

edited

Loading