[Search] Search Playground - shared rendering #201302

TattdCodeMonkey · 2024-11-21T23:01:48Z

Summary

This PR removes Search Playground rendering from enterprise_search in favor of search_playground rendering the UI for both Serverless and Stack. Included in this are changes needed to support that shift. With this change the search playground UI is now enabled by default, and the search playground plugin explicitly disabled for other Serverless projects.

Additionally this PR introduces a KibanaFeature specifically for searchPlayground so that it can be controlled with RBAC independently from the entire search feature set.

Checklist

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
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

TattdCodeMonkey · 2024-11-21T23:01:59Z

/ci

github-actions · 2024-11-21T23:02:02Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

Request a new doc build by commenting

Rebuild this PR: run docs-build
Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.}

…fix'

legrego · 2024-12-03T17:06:37Z

x-pack/plugins/search_playground/server/plugin.ts

+      privileges: {
+        all: {
+          app: ['kibana', PLUGIN_ID],
+          api: [],
+          catalogue: [PLUGIN_ID],
+          savedObject: {
+            all: [],
+            read: [],
+          },
+          ui: [],
+        },
+        read: {
+          disabled: true,
+          savedObject: {
+            all: [],
+            read: [],
+          },
+          ui: [],
+        },
+      },


This is a passing comment, I'll defer to an engineer from @elastic/kibana-security for the full review.

The PR states:

Additionally this PR introduces a KibanaFeature specifically for searchPlayground so that it can be controlled with RBAC independently from the entire search feature set.

But this privilege definition only controls access to the UI application, and does not protect any API endpoints or saved objects. Your feature may not use saved objects, so that might be ok (please confirm) -- but it is rare that a feature exists without both APIs and Saved Objects. Which Kibana endpoints does this feature require? Do any of them:

Perform actions in ES via the internal kibana_system user?

Communicate with an LLM or other third-party service?

Perform computationally expensive operations on the Kibana server?

I don't think we are using any saved objects. We do have some APIs. We have follow-up work to expand the feature from All | None to All | Read | None but that is outside the scope of this initial effort.

I can look into including the APIs, I was just doing the UI as the first pass as we're new to using features in this way.

cc: @joemcelroy

@legrego I added API to the feature in 7e109f0, I think I got that right and will test it further after I finish adding min license to the feature as well which I just realized should also be included.

Updated to use the security config over the access tag per dev docs.

Thanks for adding route authorization! It looks like it is setup correctly. You may want to consider more granular access control for the APIs, or using a naming convention with more flexibility. That said, if a single privilege to grant access to all APIs works for this plugin then you should be all set!

…fix'

TattdCodeMonkey · 2024-12-03T20:34:12Z

Once this gets a clean CI run I will test this in a QA serverless project just to ensure everything is working as expected.

TattdCodeMonkey · 2024-12-03T22:20:17Z

@elasticmachine merge upstream

kibanamachine · 2024-12-03T22:36:53Z

Flaky Test Runner Stats

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

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

see run history

TinaHeiligers

Changes to configs, manifests and usage collection LGTM

elasticmachine · 2024-12-03T23:31:22Z

💚 Build Succeeded

Buildkite Build
Commit: 3c78793
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-201302-3c787935cb72

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	2299	2296	-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/deeplinks-search`	21	22	+1
`searchNavigation`	21	22	+1
`searchPlayground`	16	13	-3
total			-1

Async chunks

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

id	before	after	diff
`enterpriseSearch`	2.6MB	2.6MB	-1.8KB
`searchPlayground`	169.9KB	164.1KB	-5.8KB
total			-7.6KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`searchNavigation`	0	1	+1
`searchPlayground`	1	0	-1
total			-0

Page load bundle

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

id	before	after	diff
`enterpriseSearch`	54.6KB	53.9KB	-636.0B
`searchNavigation`	4.1KB	5.0KB	+954.0B
`searchPlayground`	7.2KB	7.0KB	-226.0B
total			+92.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/deeplinks-search`	21	22	+1
`searchNavigation`	21	22	+1
`searchPlayground`	22	13	-9
total			-7

async chunk count

id	before	after	diff
`searchPlayground`	6	2	-4

ESLint disabled line counts

id	before	after	diff
`searchPlayground`	4	5	+1

Total ESLint disabled count

id	before	after	diff
`searchPlayground`	4	5	+1

History

💚 Build #256629 succeeded 2317525
💔 Build #256614 failed 7e109f0
💔 Build #256583 failed 355c51c
💔 Build #256243 failed 732cb8c
💔 Build #256222 failed 5871e2d

joemcelroy

Works well!

Tested on serverless and on stateful

TattdCodeMonkey · 2024-12-04T17:01:58Z

Tested this in QA for serverless and ran the FTR tests for MKI and everything seems ✅

jeramysoucy

Kibana Security changes LGTM. Just one thing, are there API integration tests for the search playground endpoints? These should get augmented to validate access/unauthorized based on user privileges.

TattdCodeMonkey · 2024-12-04T22:17:03Z

@jeramysoucy there are currently not any API integration tests for playground 😬

jeramysoucy · 2024-12-04T22:19:51Z

@jeramysoucy there are currently not any API integration tests for playground 😬

🙈 Are there plans to add them in the near future? Could you open an issue for traceability, and include validating authorization in the description?

joemcelroy · 2024-12-05T08:42:26Z

@jeramysoucy created an issue for API coverage and includes checking authorization. https://github.com/elastic/search-team/issues/8889

kibanamachine · 2024-12-05T21:10:10Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12188102874

kibanamachine · 2024-12-05T21:15:14Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 201302

Questions ?

Please refer to the Backport tool documentation

TattdCodeMonkey · 2024-12-06T15:14: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

(cherry picked from commit 434eaa7) # Conflicts: # packages/deeplinks/search/constants.ts # packages/deeplinks/search/deep_links.ts

# Backport This will backport the following commits from `main` to `8.x`: - [[Search] Search Playground - shared rendering (#201302)](#201302)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

TattdCodeMonkey added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 Team:Search backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.18.0 labels Nov 21, 2024

TattdCodeMonkey force-pushed the search/search_playground-stack-rendering branch from 17de46d to 848d374 Compare November 30, 2024 17:09

TattdCodeMonkey added 8 commits December 2, 2024 17:53

search_navigation: add basic breadcrumb handling to API

298609f

search: remove playground rendering from stack plugin

7795955

search_playground: render stack ui within shared plugin

21cecdb

search_playground: add feature to enable RBAC

d07324c

search_playground: clean tsconfig

2dfd950

search: remove unused translations

3a83711

fix(playground): type imports for sec & nav

32ffea1

chore(search_navigation): remove unused includes

32f1dff

TattdCodeMonkey force-pushed the search/search_playground-stack-rendering branch from 848d374 to 32f1dff Compare December 2, 2024 20:32

kibanamachine and others added 2 commits December 2, 2024 20:45

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

5871e2d

…fix'

fix(search): use locator to navigate to playground

732cb8c

TattdCodeMonkey marked this pull request as ready for review December 2, 2024 21:58

TattdCodeMonkey requested review from a team as code owners December 2, 2024 21:58

legrego reviewed Dec 3, 2024

View reviewed changes

TattdCodeMonkey and others added 6 commits December 3, 2024 17:16

test: update tests for the searchPlayground feature

355c51c

search_playground: restrict access to API routes with feature

7e109f0

search_playground: explicitly tie feature and UI to enterprise license

0418c25

search_playground: update telemetry schema

419b152

search_playground: use security config over access tags for routes

1ae2918

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

2317525

…fix'

TattdCodeMonkey added the ci:build-serverless-image label Dec 3, 2024

Merge branch 'main' into search/search_playground-stack-rendering

3c78793

TinaHeiligers approved these changes Dec 3, 2024

View reviewed changes

joemcelroy approved these changes Dec 4, 2024

View reviewed changes

TattdCodeMonkey requested a review from a team December 4, 2024 17:02

TattdCodeMonkey removed the ci:build-serverless-image label Dec 4, 2024

jeramysoucy requested changes Dec 4, 2024

View reviewed changes

jeramysoucy approved these changes Dec 5, 2024

View reviewed changes

TattdCodeMonkey merged commit 434eaa7 into elastic:main Dec 5, 2024
9 checks passed

TattdCodeMonkey mentioned this pull request Dec 6, 2024

[8.x] [Search] Search Playground - shared rendering (#201302) #203243

Merged

markov00 pushed a commit to markov00/kibana that referenced this pull request Dec 7, 2024

[Search] Search Playground - shared rendering (elastic#201302)

2e379a5

SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Dec 9, 2024

[Search] Search Playground - shared rendering (elastic#201302)

ddbf94d

SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Dec 9, 2024

[Search] Search Playground - shared rendering (elastic#201302)

21680fb

CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 9, 2024

[Search] Search Playground - shared rendering (elastic#201302)

f280950

Samiul-TheSoccerFan pushed a commit to Samiul-TheSoccerFan/kibana that referenced this pull request Dec 10, 2024

[Search] Search Playground - shared rendering (elastic#201302)

5fd5855

mykolaharmash pushed a commit to mykolaharmash/kibana that referenced this pull request Dec 11, 2024

[Search] Search Playground - shared rendering (elastic#201302)

0f0b6a0

CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 12, 2024

[Search] Search Playground - shared rendering (elastic#201302)

e90f1d8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search] Search Playground - shared rendering #201302

[Search] Search Playground - shared rendering #201302

TattdCodeMonkey commented Nov 21, 2024 •

edited by kibanamachine

Loading

TattdCodeMonkey commented Nov 21, 2024

github-actions bot commented Nov 21, 2024

legrego Dec 3, 2024

TattdCodeMonkey Dec 3, 2024

TattdCodeMonkey Dec 3, 2024

TattdCodeMonkey Dec 3, 2024

jeramysoucy Dec 4, 2024

TattdCodeMonkey commented Dec 3, 2024

TattdCodeMonkey commented Dec 3, 2024

kibanamachine commented Dec 3, 2024

TinaHeiligers left a comment

elasticmachine commented Dec 3, 2024 •

edited

Loading

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

joemcelroy left a comment

TattdCodeMonkey commented Dec 4, 2024

jeramysoucy left a comment

TattdCodeMonkey commented Dec 4, 2024

jeramysoucy commented Dec 4, 2024

joemcelroy commented Dec 5, 2024

kibanamachine commented Dec 5, 2024

kibanamachine commented Dec 5, 2024

TattdCodeMonkey commented Dec 6, 2024

[Search] Search Playground - shared rendering #201302

[Search] Search Playground - shared rendering #201302

Conversation

TattdCodeMonkey commented Nov 21, 2024 • edited by kibanamachine Loading

Summary

Checklist

TattdCodeMonkey commented Nov 21, 2024

github-actions bot commented Nov 21, 2024

legrego Dec 3, 2024

Choose a reason for hiding this comment

TattdCodeMonkey Dec 3, 2024

Choose a reason for hiding this comment

TattdCodeMonkey Dec 3, 2024

Choose a reason for hiding this comment

TattdCodeMonkey Dec 3, 2024

Choose a reason for hiding this comment

jeramysoucy Dec 4, 2024

Choose a reason for hiding this comment

TattdCodeMonkey commented Dec 3, 2024

TattdCodeMonkey commented Dec 3, 2024

kibanamachine commented Dec 3, 2024

Flaky Test Runner Stats

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

TinaHeiligers left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 3, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

History

joemcelroy left a comment

Choose a reason for hiding this comment

TattdCodeMonkey commented Dec 4, 2024

jeramysoucy left a comment

Choose a reason for hiding this comment

TattdCodeMonkey commented Dec 4, 2024

jeramysoucy commented Dec 4, 2024

joemcelroy commented Dec 5, 2024

kibanamachine commented Dec 5, 2024

kibanamachine commented Dec 5, 2024

💔 All backports failed

Manual backport

Questions ?

TattdCodeMonkey commented Dec 6, 2024

💚 All backports created successfully

Questions ?

TattdCodeMonkey commented Nov 21, 2024 •

edited by kibanamachine

Loading

elasticmachine commented Dec 3, 2024 •

edited

Loading