[Index details page] Implement "settings" tab by yuliacech · Pull Request #165456 · elastic/kibana

yuliacech · 2023-09-01T11:16:31Z

Summary

This PR implements the Settings tab on the new index details page. The tab load the settings from the API and displays them in a code block. When "edit mode" is enabled, a subset of settings that can be changed are displayed in a code editor. When the "save" button is clicked, only updated settings are sent to the API. I also added a button to reset the changes in the code editor.

How to test

Add xpack.index_management.dev.enableIndexDetailsPage: true to the file ./config/kibana.dev.yml
Start ES and Kibana yarn es snapshot and yarn start
Add at least one sample data set
Navigate to index management and click any index name in the indices list
Click the "Settings" tab
Enable "edit mode"
Try saving the updated settings
Try saving without changing any settings (for example by deleting a line from the editor, no settings are actually changed, but the editor content is changed which enables the "save" button)
Try saving an incorrect setting value, for example index.priority: test.

Screenshots

Loading indicator

Screen.Recording.2023-09-01.at.18.36.47.mov

Loading error

Read only mode

Edit mode

Loading indicator while updating the settings

Screen.Recording.2023-09-01.at.18.32.58.mov

No settings changed warning

Screen.Recording.2023-09-01.at.18.35.32.mov

Error updating the settings

Checklist

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

…r the update

elasticmachine · 2023-09-01T16:44:08Z

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

…t change

alisonelizabeth

Great work @yuliacech! Tested locally and everything LGTM. I left a few comments in the code, if you don't mind taking a look before merging.

alisonelizabeth · 2023-09-05T15:01:27Z

...ndex_management/__jest__/client_integration/index_details_page/index_details_page.helpers.ts

+      return find('indexDetailsSettingsEditor').prop('data-currentvalue');
+    },
+    updateCodeEditorContent: async (value: string) => {
+      find('indexDetailsSettingsEditor').getDOMNode().setAttribute('data-currentvalue', value);


Is it worth adding a comment here indicating this is needed for the mock?

alisonelizabeth · 2023-09-05T15:12:21Z

...t/public/application/sections/home/index_list/details_page/details_page_settings_content.tsx

+          {updateError && (
+            <>
+              <EuiSpacer size="m" />
+              <EuiCallOut title="Unable to save the settings" color="danger" iconType="error">


Good catch, thanks a lot!

alisonelizabeth · 2023-09-05T15:15:47Z

x-pack/plugins/index_management/public/application/lib/edit_settings.ts

Would these settings differ on serverless?

Good question, let me check if there are an differences.

I've got a doc with settings list that I'll use when updating the UI (still not sure what the best approach is) and I opened this issue to track the work.

yuliacech · 2023-09-06T12:31:26Z

Thanks a lot for your review, @alisonelizabeth! I've asked the ES team about any differences in the index settings that can be updated on serverless. I'll merge this PR as soon as I've confirmed with them.

kibana-ci · 2023-09-06T13:30:11Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 7aad925

Failed CI Steps

Test Failures

[job] [logs] Serverless Security Cypress Tests #2 / Manage lists from "Shared Exception Lists" page Create/Export/Delete List "before each" hook for "Export exception list" "before each" hook for "Export exception list"
[job] [logs] Serverless Security Investigations Cypress Tests #2 / Row renderers "before each" hook for "Row renderers should be enabled by default" "before each" hook for "Row renderers should be enabled by default"

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`indexManagement`	499	501	+2

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
`indexManagement`	186	189	+3

Async chunks

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

id	before	after	diff
`indexManagement`	533.8KB	539.1KB	+5.3KB

Unknown metric groups

API count

id	before	after	diff
`indexManagement`	191	194	+3

History

💛 Build #156732 was flaky d669a7f
💔 Build #156397 failed 4491f1c
💔 Build #156251 failed e3439e5
💔 Build #156049 failed 1c6e56e
💔 Build #155775 failed 3a987e5
💔 Build #155749 failed 1050d74

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

yuliacech · 2023-09-06T18:42:57Z

Opened #165895 for work to follow up with index settings on serverless.

## Summary This PR removes the feature flag and enables the new index details page by default. The index details page was implemented in following PRs: - #163521 - #163955 - #164741 - #165027 - #165038 - #165456 In this PR we completely remove now obsolete code for the old index details flyout: react components and corresponding redux code. All related tests are updated and cleaned up. The config value for Index Management plugin `xpack.index_management.dev.enableIndexDetailsPage` is deprecated as unused and can be removed in v9.0. ### How to test 1. Start ES and Kibana with `yarn es snapshot` and `yarn start` 3. Navigate to Index Management and create an index 4. Click the index name in the table and check the tabs of the details page ### Screenshots #### Stateful Overview <img width="1387" alt="Screenshot 2023-09-27 at 14 41 57" src="https://github.com/elastic/kibana/assets/6585477/e58b15e7-d10c-4473-873c-d0f128392404"> Mappings <img width="1392" alt="Screenshot 2023-09-27 at 14 42 05" src="https://github.com/elastic/kibana/assets/6585477/441157cb-5a26-47c3-8da0-b4df51ebec5d"> Settings <img width="1385" alt="Screenshot 2023-09-27 at 14 42 13" src="https://github.com/elastic/kibana/assets/6585477/da66a2eb-1f21-44c1-9356-484c66caab88"> Statistics <img width="1380" alt="Screenshot 2023-09-27 at 14 42 22" src="https://github.com/elastic/kibana/assets/6585477/ec93d85c-e754-4c21-88ab-0124dc114fc9"> Error loading data <img width="1333" alt="Screenshot 2023-09-26 at 19 05 37" src="https://github.com/elastic/kibana/assets/6585477/fc1804b3-6aa0-4019-bae6-e7bb40113b28"> <img width="1327" alt="Screenshot 2023-09-26 at 19 06 07" src="https://github.com/elastic/kibana/assets/6585477/ca711697-cc74-4ba8-b17c-ec9b01f3026e"> <img width="1329" alt="Screenshot 2023-09-26 at 19 06 28" src="https://github.com/elastic/kibana/assets/6585477/0cb46b09-8542-452a-8845-40d060057e95"> <img width="1331" alt="Screenshot 2023-09-26 at 19 06 48" src="https://github.com/elastic/kibana/assets/6585477/87de8d3d-b6e5-4e8f-b27c-18a1c6e950d8"> Error saving index settings <img width="1332" alt="Screenshot 2023-09-26 at 19 07 31" src="https://github.com/elastic/kibana/assets/6585477/e6e4b3d0-c237-4d0a-995a-4562bc78f88e"> ### Serverless Overview <img width="1336" alt="Screenshot 2023-09-26 at 19 51 47" src="https://github.com/elastic/kibana/assets/6585477/6c76c23b-4be6-4ab3-ae1d-c7ae751e100d"> Mappings <img width="1336" alt="Screenshot 2023-09-26 at 19 23 51" src="https://github.com/elastic/kibana/assets/6585477/625fa703-506f-4389-9df0-86441a655074"> Settings <img width="1332" alt="Screenshot 2023-09-26 at 19 24 02" src="https://github.com/elastic/kibana/assets/6585477/c496ab09-f2db-4c1b-9fb6-1e9b64b1c142"> # Release note Index details can now be viewed on a new index details page in Index Management. <img width="1387" alt="Screenshot 2023-09-27 at 14 41 57" src="https://github.com/elastic/kibana/assets/6585477/b90c706d-8b15-49e4-8f6a-cb66f3ed1822"> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

yuliacech added 2 commits September 1, 2023 12:41

[Index details page] Implement the read-only mode for the settings tab

7ef4f07

[Index details page] Implement the editable settings

729d916

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 t// release_note:skip Skip the PR/issue when compiling release notes v8.11.0 labels Sep 1, 2023

yuliacech and others added 3 commits September 1, 2023 14:50

[Index details page] Add a reload request for the index settings afte…

e58b835

…r the update

[Index details page] Implement the jest tests for the settings tab

1050d74

Merge branch 'main' into im/details_page/settings_tab

d1aeed3

yuliacech marked this pull request as ready for review September 1, 2023 16:44

yuliacech requested a review from a team as a code owner September 1, 2023 16:44

yuliacech requested a review from alisonelizabeth September 1, 2023 16:44

yuliacech and others added 4 commits September 1, 2023 18:44

[Index details page] Disable save button if the editor content doesn'…

3a987e5

…t change

Merge branch 'main' into im/details_page/settings_tab

1c6e56e

Merge branch 'main' into im/details_page/settings_tab

e3439e5

Merge branch 'main' into im/details_page/settings_tab

4491f1c

yuliacech mentioned this pull request Sep 5, 2023

[Index Management] Implement index details page #165705

Merged

alisonelizabeth approved these changes Sep 5, 2023

View reviewed changes

yuliacech and others added 2 commits September 6, 2023 11:40

Merge branch 'main' into im/details_page/settings_tab

d669a7f

[Index details page] Address code review comments

7aad925

yuliacech merged commit d3031e7 into elastic:main Sep 6, 2023

kibanamachine added the backport:skip This PR does not require backporting label Sep 6, 2023

yuliacech deleted the im/details_page/settings_tab branch February 15, 2024 12:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Index details page] Implement "settings" tab#165456

[Index details page] Implement "settings" tab#165456
yuliacech merged 11 commits intoelastic:mainfrom
yuliacech:im/details_page/settings_tab

yuliacech commented Sep 1, 2023 •

edited

Loading

Uh oh!

elasticmachine commented Sep 1, 2023

Uh oh!

alisonelizabeth left a comment

Uh oh!

alisonelizabeth Sep 5, 2023

Uh oh!

alisonelizabeth Sep 5, 2023

Uh oh!

yuliacech Sep 6, 2023

Uh oh!

alisonelizabeth Sep 5, 2023

Uh oh!

yuliacech Sep 6, 2023

Uh oh!

yuliacech Sep 6, 2023

Uh oh!

yuliacech commented Sep 6, 2023

Uh oh!

kibana-ci commented Sep 6, 2023

API count

Uh oh!

yuliacech commented Sep 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

yuliacech commented Sep 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How to test

Screenshots

Loading indicator

Loading error

Read only mode

Edit mode

Loading indicator while updating the settings

No settings changed warning

Error updating the settings

Checklist

Uh oh!

elasticmachine commented Sep 1, 2023

Uh oh!

alisonelizabeth left a comment

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth Sep 5, 2023

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth Sep 5, 2023

Choose a reason for hiding this comment

Uh oh!

yuliacech Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth Sep 5, 2023

Choose a reason for hiding this comment

Uh oh!

yuliacech Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

yuliacech Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

yuliacech commented Sep 6, 2023

Uh oh!

kibana-ci commented Sep 6, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

API count

History

Uh oh!

yuliacech commented Sep 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yuliacech commented Sep 1, 2023 •

edited

Loading