[Synonyms UI] Synonyms UI base plugin

.github/CODEOWNERS

@@ -944,6 +944,7 @@ x-pack/plugins/search_inference_endpoints @elastic/search-kibana
 x-pack/plugins/search_notebooks @elastic/search-kibana
 x-pack/plugins/search_playground @elastic/search-kibana
 x-pack/plugins/search_solution/search_navigation @elastic/search-kibana
+x-pack/plugins/search_synonyms @elastic/search-kibana
 x-pack/plugins/security @elastic/kibana-security
 x-pack/plugins/serverless @elastic/appex-sharedux
 x-pack/plugins/serverless_search @elastic/search-kibana

config/serverless.oblt.yml

@@ -9,6 +9,7 @@ xpack.securitySolution.enabled: false
 xpack.search.notebooks.enabled: false
 xpack.searchPlayground.enabled: false
 xpack.searchInferenceEndpoints.enabled: false
+xpack.searchSynonyms.enabled: false
 
 ## Fine-tune the observability solution feature privileges. Also, refer to `serverless.yml` for the project-agnostic overrides.
 xpack.features.overrides:

config/serverless.security.yml

@@ -11,6 +11,7 @@ xpack.search.notebooks.enabled: false
 xpack.searchPlayground.enabled: false
 xpack.searchInferenceEndpoints.enabled: false
 xpack.inventory.enabled: false
+xpack.searchSynonyms.enabled: false
 
 ## Fine-tune the security solution feature privileges. Also, refer to `serverless.yml` for the project-agnostic overrides.
 xpack.features.overrides:

docs/developer/plugin-list.asciidoc

@@ -859,6 +859,10 @@ detailed information on how Elasticsearch executed the search request. People us
 to understand why a search request might be slow.
 
 
+|{kib-repo}blob/{branch}/x-pack/plugins/search_synonyms/README.md[searchSynonyms]
+|A plugin to manage synonyms in Elasticsearch through Synonyms APIs through Kibana.
+
+
 |{kib-repo}blob/{branch}/x-pack/plugins/security/README.md[security]
 |See Configuring security in
 Kibana.

package.json

@@ -815,6 +815,7 @@
     "@kbn/search-playground": "link:x-pack/plugins/search_playground",
     "@kbn/search-response-warnings": "link:packages/kbn-search-response-warnings",
     "@kbn/search-shared-ui": "link:x-pack/packages/search/shared_ui",
+    "@kbn/search-synonyms": "link:x-pack/plugins/search_synonyms",
     "@kbn/search-types": "link:packages/kbn-search-types",
     "@kbn/searchprofiler-plugin": "link:x-pack/platform/plugins/shared/searchprofiler",
     "@kbn/security-api-key-management": "link:x-pack/packages/security/api_key_management",

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';
 export const SEARCH_HOMEPAGE = 'searchHomepage';
 export const SEARCH_INDICES_START = 'elasticsearchStart';
 export const SEARCH_INDICES = 'elasticsearchIndices';

packages/deeplinks/search/deep_links.ts

@@ -27,6 +27,7 @@ import {
   SEARCH_VECTOR_SEARCH,
   SEARCH_SEMANTIC_SEARCH,
   SEARCH_AI_SEARCH,
+  SERVERLESS_ES_SEARCH_SYNONYMS_ID,
 } from './constants';
 
 export type EnterpriseSearchApp = typeof ENTERPRISE_SEARCH_APP_ID;
@@ -40,6 +41,7 @@ export type ConnectorsId = typeof SERVERLESS_ES_CONNECTORS_ID;
 export type ServerlessWebCrawlers = typeof SERVERLESS_ES_WEB_CRAWLERS_ID;
 export type SearchPlaygroundId = typeof ES_SEARCH_PLAYGROUND_ID;
 export type SearchInferenceEndpointsId = typeof SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID;
+export type SearchSynonymsId = typeof SERVERLESS_ES_SEARCH_SYNONYMS_ID;
 export type SearchHomepage = typeof SEARCH_HOMEPAGE;
 export type SearchStart = typeof SEARCH_INDICES_START;
 export type SearchIndices = typeof SEARCH_INDICES;
@@ -56,6 +58,8 @@ export type AppsearchLinkId = 'engines';
 
 export type SearchInferenceEndpointsLinkId = 'inferenceEndpoints';
 
+export type SynonymsLinkId = 'synonyms';
+
 export type SearchIndicesLinkId = typeof SEARCH_INDICES_CREATE_INDEX;
 
 export type DeepLinkId =
@@ -70,11 +74,13 @@ export type DeepLinkId =
   | ServerlessWebCrawlers
   | SearchPlaygroundId
   | SearchInferenceEndpointsId
+  | SearchSynonymsId
   | SearchHomepage
   | `${EnterpriseSearchContentApp}:${ContentLinkId}`
   | `${EnterpriseSearchApplicationsApp}:${ApplicationsLinkId}`
   | `${EnterpriseSearchAppsearchApp}:${AppsearchLinkId}`
   | `${SearchInferenceEndpointsId}:${SearchInferenceEndpointsLinkId}`
+  | `${SearchSynonymsId}:${SynonymsLinkId}`
   | SearchStart
   | SearchIndices
   | SearchElasticsearch

packages/kbn-optimizer/limits.yml

@@ -149,6 +149,7 @@ pageLoadAssetSize:
   searchNotebooks: 18942
   searchPlayground: 19325
   searchprofiler: 67080
+  searchSynonyms: 20262
   security: 81771
   securitySolution: 98429
   securitySolutionEss: 31781

test/plugin_functional/test_suites/core_plugins/rendering.ts

@@ -330,6 +330,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) {
         'xpack.searchAssistant.ui.enabled (boolean?)',
         'xpack.searchInferenceEndpoints.ui.enabled (boolean?)',
         'xpack.searchPlayground.ui.enabled (boolean?)',
+        'xpack.searchSynonyms.ui.enabled (boolean?)',
         'xpack.security.loginAssistanceMessage (string?)',
         'xpack.security.sameSiteCookies (Strict?|Lax?|None?)',
         'xpack.security.showInsecureClusterWarning (boolean?)',

tsconfig.base.json

@@ -1606,6 +1606,8 @@
       "@kbn/search-response-warnings/*": ["packages/kbn-search-response-warnings/*"],
       "@kbn/search-shared-ui": ["x-pack/packages/search/shared_ui"],
       "@kbn/search-shared-ui/*": ["x-pack/packages/search/shared_ui/*"],
+      "@kbn/search-synonyms": ["x-pack/plugins/search_synonyms"],
+      "@kbn/search-synonyms/*": ["x-pack/plugins/search_synonyms/*"],
       "@kbn/search-types": ["packages/kbn-search-types"],
       "@kbn/search-types/*": ["packages/kbn-search-types/*"],
       "@kbn/searchprofiler-plugin": ["x-pack/platform/plugins/shared/searchprofiler"],

x-pack/plugins/enterprise_search/public/applications/shared/layout/base_nav.tsx

@@ -121,6 +121,14 @@ export const buildBaseClassicNavItems = (): ClassicNavItem[] => {
         },
         id: 'inference_endpoints',
       },
+      {
+        'data-test-subj': 'searchSideNav-Synonyms',
+        deepLink: {
+          link: 'searchSynonyms:synonyms',
+          shouldShowActiveForSubroutes: true,
+        },
+        id: 'synonyms',
+      },
     ],
     name: i18n.translate('xpack.enterpriseSearch.nav.relevanceTitle', {
       defaultMessage: 'Relevance',

x-pack/plugins/enterprise_search/public/navigation_tree.ts

@@ -207,7 +207,10 @@ export const getNavigationTreeDefinition = ({
                   }),
                 },
                 {
-                  children: [{ link: 'searchInferenceEndpoints:inferenceEndpoints' }],
+                  children: [
+                    { link: 'searchInferenceEndpoints:inferenceEndpoints' },
+                    { link: 'searchSynonyms:synonyms' },
+                  ],
                   id: 'relevance',
                   title: i18n.translate('xpack.enterpriseSearch.searchNav.relevance', {
                     defaultMessage: 'Relevance',

x-pack/plugins/search_synonyms/README.md

@@ -0,0 +1,3 @@
+# Search Synonyms
+
+A plugin to manage synonyms in Elasticsearch through Synonyms APIs through Kibana.

x-pack/plugins/search_synonyms/common/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export const PLUGIN_ID = 'searchSynonyms';
+export const PLUGIN_NAME = 'Synonyms';
+export const PLUGIN_PATH = '/synonyms';

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

@@ -0,0 +1,24 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SearchSynonymsPluginSetup {}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SearchSynonymsPluginStart {}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SearchSynonymsConfigType {}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface AppPluginSetupDependencies {}
+
+export interface SearchSynonymsConfigType {
+  ui: {
+    enabled: boolean;
+  };
+}

x-pack/plugins/search_synonyms/jest.config.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../..',
+  roots: ['<rootDir>/x-pack/plugins/search_synonyms'],
+  coverageDirectory: '<rootDir>/target/kibana-coverage/jest/x-pack/plugins/search_synonyms',
+  coverageReporters: ['text', 'html'],
+  collectCoverageFrom: ['<rootDir>/x-pack/plugins/search_synonyms/{public,server}/**/*.{ts,tsx}'],
+};

x-pack/plugins/search_synonyms/kibana.jsonc

@@ -0,0 +1,29 @@
+{
+  "type": "plugin",
+  "id": "@kbn/search-synonyms",
+  "owner": "@elastic/search-kibana",
+  "group": "search",
+  "visibility": "private",
+  "plugin": {
+    "id": "searchSynonyms",
+    "server": true,
+    "browser": true,
+    "configPath": [
+      "xpack",
+      "searchSynonyms"
+    ],
+    "requiredPlugins": [
+      "licensing",
+      "features",
+    ],
+    "optionalPlugins": [
+      "cloud",
+      "console",
+      "usageCollection",
+      "searchNavigation",
+    ],
+    "requiredBundles": [
+      "kibanaReact",
+    ]
+  }
+}

x-pack/plugins/search_synonyms/public/application.tsx

@@ -0,0 +1,35 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { CoreStart } from '@kbn/core/public';
+import { KibanaRenderContextProvider } from '@kbn/react-kibana-context-render';
+import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
+import { I18nProvider } from '@kbn/i18n-react';
+import { Router } from '@kbn/shared-ux-router';
+import { AppPluginStartDependencies } from './types';
+
+export const renderApp = async (
+  core: CoreStart,
+  services: AppPluginStartDependencies,
+  element: HTMLElement
+) => {
+  ReactDOM.render(
+    <KibanaRenderContextProvider {...core}>
+      <KibanaContextProvider services={{ ...core, ...services }}>
+        <I18nProvider>
+          <Router history={services.history}>
+            <div>Synonyms</div>
+          </Router>
+        </I18nProvider>
+      </KibanaContextProvider>
+    </KibanaRenderContextProvider>,
+    element
+  );
+  return () => ReactDOM.unmountComponentAtNode(element);
+};

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

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { PluginInitializerContext } from '@kbn/core/public';
+
+import { SearchSynonymsPlugin } from './plugin';
+
+export function plugin(initializerContext: PluginInitializerContext) {
+  return new SearchSynonymsPlugin(initializerContext);
+}
+
+export const SYNONYMS_UI_FLAG = 'searchSynonyms:synonymsEnabled';

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

@@ -0,0 +1,104 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { BehaviorSubject, type Subscription } from 'rxjs';
+
+import { AppStatus } from '@kbn/core/public';
+import type {
+  AppUpdater,
+  CoreSetup,
+  Plugin,
+  PluginInitializerContext,
+  AppMountParameters,
+  CoreStart,
+} from '@kbn/core/public';
+import { i18n } from '@kbn/i18n';
+import { PLUGIN_ID, PLUGIN_NAME, PLUGIN_PATH } from '../common';
+import {
+  AppPluginSetupDependencies,
+  AppPluginStartDependencies,
+  SearchSynonymsConfigType,
+  SearchSynonymsPluginSetup,
+  SearchSynonymsPluginStart,
+} from './types';
+import { SYNONYMS_UI_FLAG } from '.';
+
+export class SearchSynonymsPlugin
+  implements Plugin<SearchSynonymsPluginSetup, SearchSynonymsPluginStart>
+{
+  private config: SearchSynonymsConfigType;
+  private readonly appUpdater$ = new BehaviorSubject<AppUpdater>(() => ({}));
+  private licenseSubscription?: Subscription;
+
+  constructor(initializerContext: PluginInitializerContext) {
+    this.config = initializerContext.config.get<SearchSynonymsConfigType>();
+  }
+
+  public setup(
+    core: CoreSetup<AppPluginStartDependencies, SearchSynonymsPluginStart>,
+    _: AppPluginSetupDependencies
+  ): SearchSynonymsPluginSetup {
+    if (!this.config.ui?.enabled && !core.uiSettings.get<boolean>(SYNONYMS_UI_FLAG, false)) {
+      return {};
+    }
+    core.application.register({
+      id: PLUGIN_ID,
+      appRoute: '/app/elasticsearch/synonyms',
+      title: PLUGIN_NAME,
+      deepLinks: [
+        {
+          id: 'synonyms',
+          path: PLUGIN_PATH,
+          title: i18n.translate('xpack.searchSynonyms.appTitle', {
+            defaultMessage: 'Synonyms',
+          }),
+          visibleIn: ['globalSearch'],
+        },
+      ],
+      status: AppStatus.inaccessible,
+      updater$: this.appUpdater$,
+      async mount({ element, history }: AppMountParameters) {
+        const { renderApp } = await import('./application');
+        const [coreStart, depsStart] = await core.getStartServices();
+
+        coreStart.chrome.docTitle.change(PLUGIN_NAME);
+
+        const startDeps: AppPluginStartDependencies = {
+          ...depsStart,
+          history,
+        };
+
+        depsStart.searchNavigation?.handleOnAppMount();
+
+        return renderApp(coreStart, startDeps, element);
+      },
+      visibleIn: [],
+    });
+
+    return {};
+  }
+
+  public start(_: CoreStart, deps: AppPluginStartDependencies): SearchSynonymsPluginStart {
+    const { licensing } = deps;
+    this.licenseSubscription = licensing.license$.subscribe((license) => {
+      const status: AppStatus =
+        license && license.isAvailable && license.isActive && license.hasAtLeast('enterprise')
+          ? AppStatus.accessible
+          : AppStatus.inaccessible;
+
+      this.appUpdater$.next(() => ({ status }));
+    });
+    return {};
+  }
+
+  public stop() {
+    if (this.licenseSubscription) {
+      this.licenseSubscription.unsubscribe();
+      this.licenseSubscription = undefined;
+    }
+  }
+}