[Synonyms UI] Synonyms UI base plugin #203284

efegurkan · 2024-12-06T16:39:18Z

Summary

Creates a plugin for Synonyms UI implementation. It is hidden under the UI flag and config option which is off by default.

POST kbn:/internal/kibana/settings/searchSynonyms:synonymsEnabled
{"value": true}

Serverless Search:

Stack Search

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

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
This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
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

…e-plugin

TattdCodeMonkey

It would be good to also add enabling the feature flag in this serverless config.feature_flags.ts and adding some very light FTRs with these changes as well. Just something that checks for the page to render or the link in the side nav that would give a place to build from.

You'll also want to add the app id to the apps list in the serverless FTR config.

And we would need to do the same in x-pack/test/functional/config.base.js when we want to add FTRs functional_search.

TattdCodeMonkey · 2024-12-17T18:52:30Z

x-pack/plugins/search_synonyms/public/plugin.ts

+    core: CoreSetup<AppPluginStartDependencies, SearchSynonymsPluginStart>,
+    _: AppPluginSetupDependencies
+  ): SearchSynonymsPluginSetup {
+    if (!this.config.ui?.enabled && !core.uiSettings.get<boolean>(SYNONYMS_UI_FLAG, false)) {


I'm not sure we need the config.ui for this plugin. Those were added for the other plugins to share backend without sharing the frontend. Now that these plugins should always use both I think we can leave this out.

TattdCodeMonkey · 2024-12-17T18:52:59Z

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

+
+    defineRoutes({ router, logger: this.logger });
+
+    plugins.features.registerKibanaFeature({


TattdCodeMonkey · 2024-12-17T18:53:49Z

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

+      privileges: {
+        all: {
+          app: ['kibana', PLUGIN_ID],
+          api: [],


we should have privileges for the APIs as well as the UI since we're handling the KibanaFeature from creation.

TattdCodeMonkey · 2024-12-17T18:55:01Z

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

+          },
+          ui: [],
+        },
+        read: {


We should implement read privileges with the feature so that we don't have to add it later. We should be able to follow other plugin (not search) for examples.

This will mean that you'll need to setup APIs with correct privileges as well for read vs all.

I experimented a bit on this, I will update these with the next PR where I actually use them otherwise it will complicate. Also will include a cluster permission registration as well since we need those for the APIs.

Do you think changing these freely until we release the feature would cause a problem ? @TattdCodeMonkey

TattdCodeMonkey · 2024-12-17T18:56:26Z

x-pack/plugins/search_synonyms/server/config.ts

+
+const configSchema = schema.object({
+  enabled: schema.boolean({ defaultValue: true }),
+  ui: schema.object({


see other comment, I think we can ditch this config value.

TattdCodeMonkey · 2024-12-17T19:00:06Z

x-pack/plugins/search_synonyms/public/plugin.ts

+      deepLinks: [
+        {
+          id: 'synonyms',
+          path: PLUGIN_PATH,


PLUGIN_PATH = '/synonyms' so the full URL path is going to be /app/elasticsearch/synonyms/synonyms should that be /app/elasticsearch/synonyms/list or something else? the double /synonyms seems like it could be better.

TattdCodeMonkey · 2024-12-17T19:00:55Z

packages/deeplinks/search/constants.ts

@@ -18,6 +18,7 @@ export const SERVERLESS_ES_CONNECTORS_ID = 'serverlessConnectors';
 export const SERVERLESS_ES_WEB_CRAWLERS_ID = 'serverlessWebCrawlers';
 export const ES_SEARCH_PLAYGROUND_ID = 'searchPlayground';
 export const SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID = 'searchInferenceEndpoints';
+export const SERVERLESS_ES_SEARCH_SYNONYMS_ID = 'searchSynonyms';


I think we can drop SERVERLESS_ since this app id/deep link will be used in both serverless and stack.

Suggested change

export const SERVERLESS_ES_SEARCH_SYNONYMS_ID = 'searchSynonyms';

export const ES_SEARCH_SYNONYMS_ID = 'searchSynonyms';

afharo

Core changes LGTM

efegurkan · 2024-12-23T15:10:53Z

@elasticmachine merge upstream

…fix'

azasypkin

Overall, LGTM, but there are a number of rough edges that I think we might want to polish before merging this. Sorry if some of the suggestions feel like nitpicking, but adding a new plugin is a rare opportunity for the platform team to share knowledge and best practices with the rest of the Kibana contributors.

Thanks!

config/serverless.es.yml

x-pack/plugins/search_synonyms/README.md

x-pack/plugins/search_synonyms/server/config.ts

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

x-pack/plugins/search_synonyms/public/plugin.ts

azasypkin · 2024-12-24T11:58:05Z

x-pack/plugins/search_synonyms/kibana.jsonc

+    "requiredPlugins": [
+      "licensing",
+      "features",
+    ],
+    "optionalPlugins": [
+      "cloud",
+      "console",
+      "usageCollection",
+      "searchNavigation",
+    ],
+    "requiredBundles": [
+      "kibanaReact",
+    ]


Caution
Let's only add dependencies when we know we need them.

Suggested change

"requiredPlugins": [

"licensing",

"features",

],

"optionalPlugins": [

"cloud",

"console",

"usageCollection",

"searchNavigation",

],

"requiredBundles": [

"kibanaReact",

]

"requiredPlugins": [

"features"

],

"optionalPlugins": [

"searchNavigation"

],

"requiredBundles": [

"kibanaReact"

]

I updated this, and left the console in, as I will use it in the next PR same as the permissions conversation above. TBH eventually I will use (almost) all of the above but it is a good habit to not include unless using it, I understand your point.

x-pack/plugins/search_synonyms/public/types.ts

x-pack/test_serverless/functional/test_suites/search/config.feature_flags.ts

…e-plugin

… into synonyms-ui-base-plugin

azasypkin

LGTM. Thanks for addressing my comments!

…e-plugin

efegurkan · 2025-01-06T09:23:46Z

My pleasure <3

…ocs'

efegurkan · 2025-01-06T17:27:34Z

@elasticmachine merge upstream

kibanamachine · 2025-01-06T19:15:36Z

Starting backport for target branches: 8.x

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

elasticmachine · 2025-01-06T19:15:51Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 804f38d

Failed CI Steps

FTR Configs #60

Test Failures

[job] [logs] FTR Configs #60 / serverless observability UI Dataset Quality Dataset quality summary shows poor, degraded and good count as 0 and all dataset as healthy

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`searchSynonyms`	-	7	+7

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
`searchSynonyms`	-	5	+5

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	+297.0B
`searchSynonyms`	-	790.0B	+790.0B
total			+1.1KB

Page load bundle

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

id	before	after	diff
`searchSynonyms`	-	3.8KB	+3.8KB
`serverlessSearch`	22.8KB	22.9KB	+150.0B
total			+3.9KB

Unknown metric groups

API count

id	before	after	diff
`searchSynonyms`	-	5	+5

async chunk count

id	before	after	diff
`searchSynonyms`	-	1	+1

ESLint disabled line counts

id	before	after	diff
`searchSynonyms`	-	3	+3

Total ESLint disabled count

id	before	after	diff
`searchSynonyms`	-	3	+3

History

💔 Build #264264 failed 2e4e87f
💔 Build #263809 failed cafd722
💔 Build #263762 failed 268d63f
💛 Build #262871 was flaky e43981a
💔 Build #262857 failed 9bcf377
💔 Build #262817 failed 807c206

kibanamachine · 2025-01-06T19:20:42Z

💔 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 203284

Questions ?

Please refer to the Backport tool documentation

## Summary Creates a plugin for Synonyms UI implementation. It is hidden under the UI flag and config option which is off by default. ``` POST kbn:/internal/kibana/settings/searchSynonyms:synonymsEnabled {"value": true} ``` Serverless Search: <img width="379" alt="Screenshot 2024-12-17 at 13 18 02" src="https://github.com/user-attachments/assets/8c2cb6f0-ce2a-4be6-8605-4f994adeefd7" /> Stack Search <img width="293" alt="Screenshot 2024-12-17 at 13 21 43" src="https://github.com/user-attachments/assets/0d61de0e-2cd3-46a6-990f-1f1a70843324" /> ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [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) - [ ] [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 - [x] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]>

efegurkan · 2025-01-08T08:36:37Z

💚 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

efegurkan · 2025-01-08T09:09:33Z

💚 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

# Backport This will backport the following commits from `main` to `8.x`: - [[Synonyms UI] Synonyms UI base plugin (#203284)](#203284)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

efegurkan added 6 commits December 4, 2024 18:13

Add synonyms plugin and add routes

1b9cbcd

Check config before registering

97c8d0a

Merge branch 'main' of github.com:elastic/kibana into synonyms-ui-bas…

3c4c114

…e-plugin

Update navigation on synonyms plugins

ac08dfa

Fix missing config export

0706eca

Fix quick check failures

ba7c1f4

efegurkan force-pushed the synonyms-ui-base-plugin branch from 7db5d71 to ba7c1f4 Compare December 17, 2024 14:21

efegurkan added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 v8.17.0 Team:EnterpriseSearch labels Dec 17, 2024

efegurkan changed the title ~~[Synonyms UI]Synonyms UI base plugin~~ [Synonyms UI] Synonyms UI base plugin Dec 17, 2024

efegurkan marked this pull request as ready for review December 17, 2024 14:23

efegurkan requested review from a team as code owners December 17, 2024 14:23

efegurkan added backport:version Backport to applied version labels v8.18.0 and removed v8.17.0 labels Dec 17, 2024

FTR fixes

7cf6cf1

Ikuni17 approved these changes Dec 17, 2024

View reviewed changes

TattdCodeMonkey reviewed Dec 17, 2024

View reviewed changes

afharo approved these changes Dec 17, 2024

View reviewed changes

azasypkin self-requested a review December 20, 2024 14:36

Review changes

78c132c

elasticmachine and others added 3 commits December 23, 2024 15:10

Merge branch 'main' into synonyms-ui-base-plugin

88404f4

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

807c206

…fix'

Fix FTRs

9bcf377

azasypkin requested changes Dec 24, 2024

View reviewed changes

efegurkan and others added 5 commits January 2, 2025 16:27

Merge branch 'main' of github.com:elastic/kibana into synonyms-ui-bas…

2dc16b4

…e-plugin

Rebase and review changes

4097ac5

[CI] Auto-commit changed files from 'node scripts/generate codeowners'

eeefab0

Update tsconfig base path

1a609df

Merge branch 'synonyms-ui-base-plugin' of github.com:efegurkan/kibana…

268d63f

… into synonyms-ui-base-plugin

efegurkan requested a review from azasypkin January 2, 2025 16:13

efegurkan disabled auto-merge January 2, 2025 16:14

efegurkan added 2 commits January 2, 2025 18:54

Fix types

cafd722

Fix checks

c32620e

azasypkin approved these changes Jan 3, 2025

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into synonyms-ui-bas…

8500b3a

…e-plugin

efegurkan and others added 2 commits January 6, 2025 10:26

Remove wrongfully added lines due to merge conflict

b5b5df3

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

2e4e87f

…ocs'

efegurkan enabled auto-merge (squash) January 6, 2025 10:13

Merge branch 'main' into synonyms-ui-base-plugin

804f38d

efegurkan merged commit e542fd2 into elastic:main Jan 6, 2025
9 checks passed

This was referenced Jan 6, 2025

[ci] Use daily promoted EPR distribution #205221

Merged

Sustainable Kibana Architecture: Move content management related packages #205593

Merged

efegurkan mentioned this pull request Jan 8, 2025

[8.x] [Synonyms UI] Synonyms UI base plugin (#203284) #205840

Closed

efegurkan mentioned this pull request Jan 8, 2025

[8.x] [Synonyms UI] Synonyms UI base plugin (#203284) #205843

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Synonyms UI] Synonyms UI base plugin #203284

[Synonyms UI] Synonyms UI base plugin #203284

efegurkan commented Dec 6, 2024 •

edited by kibanamachine

Loading

TattdCodeMonkey left a comment

TattdCodeMonkey Dec 17, 2024

TattdCodeMonkey Dec 17, 2024

TattdCodeMonkey Dec 17, 2024

TattdCodeMonkey Dec 17, 2024

efegurkan Dec 20, 2024

TattdCodeMonkey Dec 17, 2024

TattdCodeMonkey Dec 17, 2024

TattdCodeMonkey Dec 17, 2024

afharo left a comment

efegurkan commented Dec 23, 2024

azasypkin left a comment

azasypkin Dec 24, 2024

efegurkan Jan 2, 2025

azasypkin left a comment

efegurkan commented Jan 6, 2025

efegurkan commented Jan 6, 2025

kibanamachine commented Jan 6, 2025

elasticmachine commented Jan 6, 2025

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

kibanamachine commented Jan 6, 2025

efegurkan commented Jan 8, 2025

efegurkan commented Jan 8, 2025


		defineRoutes({ router, logger: this.logger });

		plugins.features.registerKibanaFeature({

	export const SERVERLESS_ES_SEARCH_SYNONYMS_ID = 'searchSynonyms';
	export const ES_SEARCH_SYNONYMS_ID = 'searchSynonyms';

[Synonyms UI] Synonyms UI base plugin #203284

[Synonyms UI] Synonyms UI base plugin #203284

Conversation

efegurkan commented Dec 6, 2024 • edited by kibanamachine Loading

Summary

Checklist

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

afharo left a comment

Choose a reason for hiding this comment

efegurkan commented Dec 23, 2024

azasypkin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azasypkin left a comment

Choose a reason for hiding this comment

efegurkan commented Jan 6, 2025

efegurkan commented Jan 6, 2025

kibanamachine commented Jan 6, 2025

elasticmachine commented Jan 6, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

History

kibanamachine commented Jan 6, 2025

💔 All backports failed

Manual backport

Questions ?

efegurkan commented Jan 8, 2025

💚 All backports created successfully

Questions ?

efegurkan commented Jan 8, 2025

💚 All backports created successfully

Questions ?

efegurkan commented Dec 6, 2024 •

edited by kibanamachine

Loading