[Enterprise Search] Index Pipelines JSON Configurations #142609

TattdCodeMonkey · 2022-10-04T14:02:09Z

Summary

Add the right panel with tabs for the Search Index Pipelines page, along with the JSON configurations tab.

The index pipelines get request was already returning the index specific ingest pipelines so I added the default pipeline to this result so we can get all the pipelines related to an index with a single call.

Index without a custom pipeline:

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
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)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

TattdCodeMonkey · 2022-10-04T14:04:08Z

...nterprise_search_content/components/search_index/pipelines/pipelines_json_configurations.tsx

+          { defaultMessage: 'View the JSON for your pipeline configurations on this index.' }
+        )}
+        footerDocLink={
+          <EuiLink href={docLinks.ingestPipelines} target="_blank" color="subdued">


I'm not 100% sure if we want to use the same doc link here since it's already in the footer for the Ingest Pipelines card.

TattdCodeMonkey · 2022-10-04T14:05:03Z

...nterprise_search_content/components/search_index/pipelines/pipelines_json_configurations.tsx

+              </EuiFlexItem>
+            </EuiFlexGroup>
+            <EuiSpacer size="m" />
+            <EuiCodeBlock language="json" overflowHeight={300} isCopyable>


this overflowHeight={300} is a bit arbitrary, is there a patter we usually follow for what to set this value to?

I don't think we have, we can try to come up with one though.

TattdCodeMonkey · 2022-10-04T14:12:56Z

x-pack/plugins/enterprise_search/server/routes/enterprise_search/indices.ts

@@ -293,9 +295,15 @@ export function registerIndexRoutes({
    elasticsearchErrorHandler(log, async (context, request, response) => {
      const indexName = decodeURIComponent(request.params.indexName);
      const { client } = (await context.core).elasticsearch;
-      const pipelines = await getCustomPipelines(indexName, client);
+      const [defaultPipeline, customPipelines] = await Promise.all([
+        getPipeline(DEFAULT_PIPELINE_NAME, client),


I went back and forth on if I should add a new endpoint for getting a pipeline or one specific to the default pipeline. But eventually landed on returning the default ingest pipeline from this endpoint we were already calling. This works for indices that do and do not already have custom pipelines.

We already have an endpoint for the default pipeline, but it's parsing it and returning a response specific to what the ingest pipeline card/modal uses via the PipelinesLogic.

It might be worthwhile to refactor the default pipeline endpoint to return the full IngestPipeline and then do the parsing in the PipelinesLogic. Then we would not need to return the default pipeline here. but instead combine the custom pipelines and default pipeline into a single list in the frontend logic.

I like the refactor idea. Do you think we can handle this during the node architecture overhaul ?

.../applications/enterprise_search_content/components/search_index/pipelines/pipelines_logic.ts

...nterprise_search_content/components/search_index/pipelines/pipelines_json_configurations.tsx

efegurkan

Looks good. I don't see a major problem. 🚀

If you can check the comments before merging that would be cool.

...cations/enterprise_search_content/components/search_index/pipelines/pipeline_json_badges.tsx

efegurkan · 2022-10-04T16:33:53Z

...nterprise_search_content/components/search_index/pipelines/pipelines_json_configurations.tsx

+              </EuiFlexItem>
+            </EuiFlexGroup>
+            <EuiSpacer size="m" />
+            <EuiCodeBlock language="json" overflowHeight={300} isCopyable>


I don't think we have, we can try to come up with one though.

...nterprise_search_content/components/search_index/pipelines/pipelines_json_configurations.tsx

efegurkan · 2022-10-04T16:47:33Z

x-pack/plugins/enterprise_search/server/routes/enterprise_search/indices.ts

@@ -293,9 +295,15 @@ export function registerIndexRoutes({
    elasticsearchErrorHandler(log, async (context, request, response) => {
      const indexName = decodeURIComponent(request.params.indexName);
      const { client } = (await context.core).elasticsearch;
-      const pipelines = await getCustomPipelines(indexName, client);
+      const [defaultPipeline, customPipelines] = await Promise.all([
+        getPipeline(DEFAULT_PIPELINE_NAME, client),


I like the refactor idea. Do you think we can handle this during the node architecture overhaul ?

.../applications/enterprise_search_content/components/search_index/pipelines/pipelines_logic.ts

Add the right panel with tabs for the Search Index Pipelines page, along with the JSON configurations tab. The index pipeliens get request was already returning the index specific ingest pipelines so I added the default pipeline to this result so we can get all the pipelines related to an index with a single call.

The modal is closed from the pipelines logic and this createApiSuccess listener ended up being completely unnecessary.

kibana-ci · 2022-10-04T18:22:53Z

💚 Build Succeeded

Buildkite Build
Commit: 6389378

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	1719	1723	+4

Async chunks

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

id	before	after	diff
`enterpriseSearch`	1.7MB	1.7MB	+6.4KB

History

💛 Build #77987 was flaky bfd3506f3c9e38bbe3d0f399b1970ac5890989cb
💔 Build #77950 failed 6db65f760a55d840ddd6398e6d6793785f4f08c7

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

* [Enterprise Search] pipelines json configs tab Add the right panel with tabs for the Search Index Pipelines page, along with the JSON configurations tab. The index pipeliens get request was already returning the index specific ingest pipelines so I added the default pipeline to this result so we can get all the pipelines related to an index with a single call. * removed unnecessary listener The modal is closed from the pipelines logic and this createApiSuccess listener ended up being completely unnecessary.

TattdCodeMonkey added release_note:skip Skip the PR/issue when compiling release notes Team:EnterpriseSearch v8.6.0 labels Oct 4, 2022

TattdCodeMonkey requested a review from a team October 4, 2022 14:02

TattdCodeMonkey commented Oct 4, 2022

View reviewed changes

.../applications/enterprise_search_content/components/search_index/pipelines/pipelines_logic.ts Show resolved Hide resolved

TattdCodeMonkey force-pushed the rnorris/es/pipelines-json-config-tab branch from 6db65f7 to bfd3506 Compare October 4, 2022 15:04

TattdCodeMonkey commented Oct 4, 2022

View reviewed changes

...nterprise_search_content/components/search_index/pipelines/pipelines_json_configurations.tsx Show resolved Hide resolved

efegurkan approved these changes Oct 4, 2022

View reviewed changes

TattdCodeMonkey added 2 commits October 4, 2022 12:21

removed unnecessary listener

6389378

The modal is closed from the pipelines logic and this createApiSuccess listener ended up being completely unnecessary.

TattdCodeMonkey force-pushed the rnorris/es/pipelines-json-config-tab branch from bfd3506 to 6389378 Compare October 4, 2022 17:21

TattdCodeMonkey merged commit c843987 into elastic:main Oct 4, 2022

kibanamachine added the backport:skip This commit does not require backporting label Oct 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Index Pipelines JSON Configurations #142609

[Enterprise Search] Index Pipelines JSON Configurations #142609

TattdCodeMonkey commented Oct 4, 2022

TattdCodeMonkey Oct 4, 2022

TattdCodeMonkey Oct 4, 2022

efegurkan Oct 4, 2022

TattdCodeMonkey Oct 4, 2022

efegurkan Oct 4, 2022

efegurkan left a comment

efegurkan Oct 4, 2022

efegurkan Oct 4, 2022

kibana-ci commented Oct 4, 2022

[Enterprise Search] Index Pipelines JSON Configurations #142609

[Enterprise Search] Index Pipelines JSON Configurations #142609

Conversation

TattdCodeMonkey commented Oct 4, 2022

Summary

Checklist

TattdCodeMonkey Oct 4, 2022

Choose a reason for hiding this comment

TattdCodeMonkey Oct 4, 2022

Choose a reason for hiding this comment

efegurkan Oct 4, 2022

Choose a reason for hiding this comment

TattdCodeMonkey Oct 4, 2022

Choose a reason for hiding this comment

efegurkan Oct 4, 2022

Choose a reason for hiding this comment

efegurkan left a comment

Choose a reason for hiding this comment

efegurkan Oct 4, 2022

Choose a reason for hiding this comment

efegurkan Oct 4, 2022

Choose a reason for hiding this comment

kibana-ci commented Oct 4, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History