[Onboarding] Add delete index action to search index detail page #192428

saarikabhasi · 2024-09-10T02:14:11Z

Summary

In this PR for Onboarding Search detail page added,

Delete index action
Page loading section while fetching index
Page error section when index not found
Api reference doc link
Added FTR tests for the new implementation

Screenshots

How to test:

Enable searchIndices plugin in kibana.dev.yml as this plugin is behind Feature flag

xpack.searchIndices.enabled: true

Create a new index
Navigate to /app/elasticsearch/indices/index_details/${indexName}
Delete index and visit to /app/elasticsearch/indices/index_details/${indexName} again

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
Flaky Test Runner was used on any tests changed

saarikabhasi · 2024-09-10T03:23:33Z

x-pack/plugins/search_indices/public/hooks/api/use_index.ts

@@ -18,7 +18,7 @@ export const useIndex = (indexName: string) => {
    refetchInterval: POLLING_INTERVAL,
    refetchIntervalInBackground: true,
    refetchOnWindowFocus: 'always',
-    retry: true,
+    retry: false,


When retry is true, the api try to refetch even if there is a fetch error. So there is no way to confirm if fetchIndex had a failure since isLoading & isSuccess will be false.
Setting retry to false, would stop refetch when last fetch failed and will save the error which can help to show error message in front end.

Would suggest retry to be capped to a number like 3 rather than true so that errors are bubbled to the UI when it consistently throws an error

https://tanstack.com/query/latest/docs/framework/react/reference/useQuery#usequery

updated in 13ac078

…fix'

pheyos

svl_search_navigation test service changes LGTM

joemcelroy · 2024-09-10T12:51:27Z

packages/kbn-doc-links/src/get_doc_links.ts

@@ -51,6 +51,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
    elasticStackGetStarted: isServerless
      ? `${SERVERLESS_DOCS}`
      : `${ELASTIC_WEBSITE_URL}guide/en/index.html`,
+    apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/${DOC_LINK_VERSION}/api-reference.html`,


would link this to current, like the other URLS

Suggested change

apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/${DOC_LINK_VERSION}/api-reference.html`,

apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html`,

updated in 13ac078

kibanamachine · 2024-09-10T12:51:58Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6907

[✅] x-pack/test_serverless/functional/test_suites/search/config.feature_flags.ts: 25/25 tests passed.

see run history

joemcelroy · 2024-09-10T12:57:03Z

x-pack/plugins/search_indices/public/hooks/api/use_delete_index.ts

+    indices,
+  });
+  const result = useMutation({
+    mutationFn: async () => {


also invalidate the index from querycache, onSuccess. see this doc https://tanstack.com/query/v4/docs/framework/react/guides/invalidations-from-mutations

updated in 13ac078

mdefazio · 2024-09-10T14:49:04Z

x-pack/plugins/search_indices/public/components/indices/delete_index_modal.tsx

+      title={i18n.translate(
+        'xpack.searchIndices.indexActionsMenu.deleteIndex.confirmModal.modalTitle',
+        {
+          defaultMessage: 'Delete {index}',


I think the modal title should be more general and simply read 'Delete index'—especially since we are also including the index name in the body of the modal.

updated in 5dde7ca

TattdCodeMonkey

Overall looks good, some minor comments and questions.

TattdCodeMonkey · 2024-09-10T15:46:58Z

x-pack/plugins/search_indices/common/doc_links.ts

+  constructor() {}
+
+  setDocLinks(newDocLinks: DocLinks) {
+    this.apiReference = newDocLinks.apiReference;


@joemcelroy Will we need to worry about showing different links here based on serverless and stack?

We will do eventually. ATM we rely on stack URLs, waiting on @leemthompo guidance on how that will work out :)

@lcawl knows more about this topic than me, and I know the autogenerated API refs are coming along nicely :)

We do have the isServerless option too IIUC

Yes, the doc link service can have two "flavours" of links so that's definitely something that already exists.

@lcawl would you recommend linking to the autogenerated API refs today, or circling back in a while on that one?

x-pack/plugins/search_indices/public/components/indices/details_page.tsx

x-pack/plugins/search_indices/public/components/indices/delete_index_modal.tsx

…key in li tag

TattdCodeMonkey · 2024-09-10T18:02:06Z

x-pack/plugins/search_indices/public/hooks/api/use_delete_index.ts

+    indices,
+  });
+  const queryClient = useQueryClient();
+  const { queryKey } = useIndex(indexName);


We should probably have a constants for the query keys and likely a function for building the queryKey based on the indexName.

I think using this hook here will do a fetch of of the index, with the polling, by including this hook here.

For an example I experimented with using enum for query keys in search homepage That PR ended up not getting merged for other reasons though.

Also moved for other UseQuery implementation APIs as well. d7ca011

kibanamachine · 2024-09-10T18:09:35Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6912

[✅] x-pack/test_serverless/functional/test_suites/search/config.feature_flags.ts: 25/25 tests passed.

see run history

saarikabhasi · 2024-09-10T18:11:09Z

@joemcelroy @TattdCodeMonkey, just a note. I have also updated FTR for page reload logic in f4866b7

…ana into onboarding/delete-index

saarikabhasi · 2024-09-10T21:26:31Z

@elasticmachine merge upstream

joemcelroy

Looks good!

lcawl · 2024-09-11T19:22:38Z

packages/kbn-doc-links/src/get_doc_links.ts

@@ -51,6 +51,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
    elasticStackGetStarted: isServerless
      ? `${SERVERLESS_DOCS}`
      : `${ELASTIC_WEBSITE_URL}guide/en/index.html`,
+    apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html`,


apiReference: ${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html,

If you do want this link to take you to a list of all APIs for all products and deployment types, this is a good target for now (the long term target will be https://www.elastic.co/docs/api/). If you're only interested in a specific subset of APIs and you want to differentiate between serverless and non-serverless contexts, you could use the "isServerless" condition here. Just lmk if there a specific subset you want to be able to link to and I can help figure out the URL.

cc: @joemcelroy @serenachou

IMO, we could go with stack url and revisit in future if need to differentiate between serverless & stack.
@joemcelroy please lmk if you think otherwise

saarikabhasi · 2024-09-13T11:39:35Z

pinging @elastic/kibana-core

kibana-ci · 2024-09-13T13:35:06Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: b8fd1cb

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`searchIndices`	136	139	+3

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/doc-links`	78	79	+1

Async chunks

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

id	before	after	diff
`aiAssistantManagementSelection`	90.8KB	90.9KB	+114.0B
`lists`	143.3KB	143.4KB	+114.0B
`searchIndices`	57.1KB	62.4KB	+5.3KB
total			+5.5KB

Page load bundle

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

id	before	after	diff
`core`	418.8KB	418.9KB	+114.0B
`searchIndices`	5.3KB	5.5KB	+140.0B
total			+254.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/doc-links`	78	79	+1

History

💛 Build #233800 was flaky 7cf8bb4
💛 Build #233478 was flaky d1c10b7
💛 Build #233260 was flaky f803c82459e9fc79c4a599bbb35a3a8642d222d6
💔 Build #233229 failed 7e966a6
💔 Build #233197 failed 63048f4
💔 Build #233195 failed f4866b7

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

leemthompo

Approving doclink to unblock :)

jbudz · 2024-09-13T14:39:35Z

Apologies, ignore the linked skip. That was meant for #192688

saarikabhasi · 2024-09-16T19:16:59Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…stic#192428) ## Summary In this PR for Onboarding Search detail page added, * Delete index action * Page loading section while fetching index * Page error section when index not found * Api reference doc link * Added FTR tests for the new implementation ## Screenshots <img width="1462" alt="Screenshot 2024-09-09 at 11 17 05 PM" src="https://github.com/user-attachments/assets/b407d8ff-36c6-4bd6-a6af-d63d9ee6ac40"> <img width="1484" alt="Screenshot 2024-09-09 at 11 17 33 PM" src="https://github.com/user-attachments/assets/5ff8a84d-b8fd-4b43-8057-2691a3741353"> **How to test:** 1. Enable searchIndices plugin in `kibana.dev.yml` as this plugin is behind Feature flag ``` xpack.searchIndices.enabled: true ``` 2. Create a new index 3. Navigate to `/app/elasticsearch/indices/index_details/${indexName}` 4. Delete index and visit to `/app/elasticsearch/indices/index_details/${indexName}` again ### Checklist Delete any items that are not applicable to this PR. - [x] 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) - [x] [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 - [x] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit dcbba95) # Conflicts: # x-pack/plugins/search_indices/tsconfig.json

#192428) (#193075) # Backport This will backport the following commits from `main` to `8.x`: - [[Onboarding] Add delete index action to search index detail page (#192428)](#192428)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  --------- Co-authored-by: kibanamachine <[email protected]>

saarikabhasi added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v8.16.0 labels Sep 10, 2024

saarikabhasi requested review from a team as code owners September 10, 2024 02:14

saarikabhasi added 2 commits September 9, 2024 23:03

add delete action, page loading, error

edb1153

add FTR

fe41521

saarikabhasi force-pushed the onboarding/delete-index branch from 478a21a to fe41521 Compare September 10, 2024 03:15

saarikabhasi commented Sep 10, 2024

View reviewed changes

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

bd41dad

…fix'

pheyos approved these changes Sep 10, 2024

View reviewed changes

joemcelroy reviewed Sep 10, 2024

View reviewed changes

mdefazio reviewed Sep 10, 2024

View reviewed changes

TattdCodeMonkey reviewed Sep 10, 2024

View reviewed changes

saarikabhasi and others added 4 commits September 10, 2024 13:18

set retry count, invalidate query, update doclink

13ac078

use initialoading value, move loading error to new component, remove …

5dde7ca

…key in li tag

update FTR for page reload

f4866b7

Merge branch 'main' into onboarding/delete-index

63048f4

TattdCodeMonkey reviewed Sep 10, 2024

View reviewed changes

saarikabhasi added 2 commits September 10, 2024 15:28

move querykey & mutationKey to contansts file

d7ca011

Merge branch 'onboarding/delete-index' of github.com:saarikabhasi/kib…

7e966a6

…ana into onboarding/delete-index

joemcelroy approved these changes Sep 11, 2024

View reviewed changes

saarikabhasi force-pushed the onboarding/delete-index branch from f803c82 to 7e966a6 Compare September 11, 2024 15:16

Merge branch 'main' into onboarding/delete-index

d1c10b7

lcawl reviewed Sep 11, 2024

View reviewed changes

Merge branch 'main' into onboarding/delete-index

7cf8bb4

Merge branch 'main' into onboarding/delete-index

b8fd1cb

rudolf approved these changes Sep 13, 2024

View reviewed changes

leemthompo approved these changes Sep 13, 2024

View reviewed changes

saarikabhasi merged commit dcbba95 into elastic:main Sep 13, 2024
23 checks passed

kibanamachine added the v9.0.0 label Sep 13, 2024

saarikabhasi deleted the onboarding/delete-index branch September 13, 2024 14:31

jbudz added a commit that referenced this pull request Sep 13, 2024

skip failing test suite (#192428)

8d8742f

jbudz added a commit that referenced this pull request Sep 13, 2024

skip failing test suite (#192428)

3f76211

kibanamachine mentioned this pull request Sep 16, 2024

[Onboarding] Connection details + Quick Stats #192636

Merged

saarikabhasi mentioned this pull request Sep 16, 2024

[8.x] [Onboarding] Add delete index action to search index detail page (#192428) #193075

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Onboarding] Add delete index action to search index detail page #192428

[Onboarding] Add delete index action to search index detail page #192428

saarikabhasi commented Sep 10, 2024 •

edited

Loading

saarikabhasi Sep 10, 2024

joemcelroy Sep 10, 2024

saarikabhasi Sep 10, 2024

pheyos left a comment

joemcelroy Sep 10, 2024

saarikabhasi Sep 10, 2024

kibanamachine commented Sep 10, 2024

joemcelroy Sep 10, 2024

saarikabhasi Sep 10, 2024

mdefazio Sep 10, 2024

saarikabhasi Sep 10, 2024

TattdCodeMonkey left a comment

TattdCodeMonkey Sep 10, 2024

joemcelroy Sep 11, 2024

leemthompo Sep 11, 2024

leemthompo Sep 11, 2024

lcawl Sep 11, 2024

leemthompo Sep 12, 2024

TattdCodeMonkey Sep 10, 2024

TattdCodeMonkey Sep 10, 2024

saarikabhasi Sep 10, 2024 •

edited

Loading

kibanamachine commented Sep 10, 2024

saarikabhasi commented Sep 10, 2024

saarikabhasi commented Sep 10, 2024

joemcelroy left a comment

lcawl Sep 11, 2024 •

edited

Loading

saarikabhasi Sep 11, 2024

saarikabhasi Sep 13, 2024

saarikabhasi commented Sep 13, 2024

kibana-ci commented Sep 13, 2024

API count

leemthompo left a comment

jbudz commented Sep 13, 2024

saarikabhasi commented Sep 16, 2024

	apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/${DOC_LINK_VERSION}/api-reference.html`,
	apiReference: `${ELASTIC_WEBSITE_URL}guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/api-reference.html`,

[Onboarding] Add delete index action to search index detail page #192428

[Onboarding] Add delete index action to search index detail page #192428

Conversation

saarikabhasi commented Sep 10, 2024 • edited Loading

Summary

Screenshots

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pheyos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Sep 10, 2024

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6907

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TattdCodeMonkey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saarikabhasi Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

kibanamachine commented Sep 10, 2024

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6912

saarikabhasi commented Sep 10, 2024

saarikabhasi commented Sep 10, 2024

joemcelroy left a comment

Choose a reason for hiding this comment

lcawl Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saarikabhasi commented Sep 13, 2024

kibana-ci commented Sep 13, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

leemthompo left a comment

Choose a reason for hiding this comment

jbudz commented Sep 13, 2024

saarikabhasi commented Sep 16, 2024

💚 All backports created successfully

Questions ?

saarikabhasi commented Sep 10, 2024 •

edited

Loading

saarikabhasi Sep 10, 2024 •

edited

Loading

lcawl Sep 11, 2024 •

edited

Loading