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

# 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)
elastic · Dec 6, 2024 · 4dd3c9e · 4dd3c9e
1 parent aa59d7a
commit 4dd3c9e
Show file tree

Hide file tree

Showing 57 changed files with 485 additions and 420 deletions.
diff --git a/config/serverless.es.yml b/config/serverless.es.yml
@@ -84,9 +84,6 @@ xpack.ml.compatibleModuleType: 'search'
 
 data_visualizer.resultLinks.fileBeat.enabled: false
 
-# Search Playground
-xpack.searchPlayground.ui.enabled: true
-
 # Search InferenceEndpoints
 xpack.searchInferenceEndpoints.ui.enabled: true
 

diff --git a/config/serverless.oblt.yml b/config/serverless.oblt.yml
@@ -7,6 +7,7 @@ xpack.infra.enabled: true
 xpack.uptime.enabled: true
 xpack.securitySolution.enabled: false
 xpack.search.notebooks.enabled: false
+xpack.searchPlayground.enabled: false
 
 ## Fine-tune the observability solution feature privileges. Also, refer to `serverless.yml` for the project-agnostic overrides.
 xpack.features.overrides:

diff --git a/config/serverless.security.yml b/config/serverless.security.yml
@@ -8,6 +8,7 @@ xpack.observabilityLogsExplorer.enabled: false
 xpack.observability.enabled: false
 xpack.observabilityAIAssistant.enabled: false
 xpack.search.notebooks.enabled: false
+xpack.searchPlayground.enabled: false
 
 ## Fine-tune the security solution feature privileges. Also, refer to `serverless.yml` for the project-agnostic overrides.
 xpack.features.overrides:

diff --git a/packages/deeplinks/search/constants.ts b/packages/deeplinks/search/constants.ts
@@ -16,7 +16,7 @@ export const ENTERPRISE_SEARCH_APPSEARCH_APP_ID = 'appSearch';
 export const ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID = 'workplaceSearch';
 export const SERVERLESS_ES_APP_ID = 'serverlessElasticsearch';
 export const SERVERLESS_ES_CONNECTORS_ID = 'serverlessConnectors';
-export const SERVERLESS_ES_SEARCH_PLAYGROUND_ID = 'searchPlayground';
+export const ES_SEARCH_PLAYGROUND_ID = 'searchPlayground';
 export const SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID = 'searchInferenceEndpoints';
 export const SEARCH_HOMEPAGE = 'searchHomepage';
 export const SEARCH_INDICES_START = 'elasticsearchStart';

diff --git a/packages/deeplinks/search/deep_links.ts b/packages/deeplinks/search/deep_links.ts
@@ -17,7 +17,7 @@ import {
   ENTERPRISE_SEARCH_ANALYTICS_APP_ID,
   ENTERPRISE_SEARCH_APPSEARCH_APP_ID,
   ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID,
-  SERVERLESS_ES_SEARCH_PLAYGROUND_ID,
+  ES_SEARCH_PLAYGROUND_ID,
   SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID,
   SEARCH_HOMEPAGE,
   SEARCH_INDICES_START,
@@ -38,7 +38,7 @@ export type EnterpriseSearchAppsearchApp = typeof ENTERPRISE_SEARCH_APPSEARCH_AP
 export type EnterpriseSearchWorkplaceSearchApp = typeof ENTERPRISE_SEARCH_WORKPLACESEARCH_APP_ID;
 export type ServerlessSearchApp = typeof SERVERLESS_ES_APP_ID;
 export type ConnectorsId = typeof SERVERLESS_ES_CONNECTORS_ID;
-export type SearchPlaygroundId = typeof SERVERLESS_ES_SEARCH_PLAYGROUND_ID;
+export type SearchPlaygroundId = typeof ES_SEARCH_PLAYGROUND_ID;
 export type SearchInferenceEndpointsId = typeof SERVERLESS_ES_SEARCH_INFERENCE_ENDPOINTS_ID;
 export type SearchHomepage = typeof SEARCH_HOMEPAGE;
 export type SearchStart = typeof SEARCH_INDICES_START;
@@ -50,7 +50,7 @@ export type SearchAISearch = typeof SEARCH_AI_SEARCH;
 
 export type ContentLinkId = 'searchIndices' | 'connectors' | 'webCrawlers';
 
-export type ApplicationsLinkId = 'searchApplications' | 'playground';
+export type ApplicationsLinkId = 'searchApplications';
 
 export type AppsearchLinkId = 'engines';
 

diff --git a/packages/deeplinks/search/index.ts b/packages/deeplinks/search/index.ts
@@ -21,6 +21,7 @@ export {
   SEARCH_VECTOR_SEARCH,
   SEARCH_SEMANTIC_SEARCH,
   SEARCH_AI_SEARCH,
+  ES_SEARCH_PLAYGROUND_ID,
 } from './constants';
 
 export type {

diff --git a/src/plugins/kibana_usage_collection/server/collectors/application_usage/schema.ts b/src/plugins/kibana_usage_collection/server/collectors/application_usage/schema.ts
@@ -137,6 +137,7 @@ export const applicationUsageSchema = {
   enterpriseSearch: commonSchema,
   enterpriseSearchContent: commonSchema,
   searchInferenceEndpoints: commonSchema,
+  searchPlayground: commonSchema,
   enterpriseSearchAnalytics: commonSchema,
   enterpriseSearchApplications: commonSchema,
   enterpriseSearchAISearch: commonSchema,

diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
@@ -2229,6 +2229,137 @@
             }
           }
         },
+        "searchPlayground": {
+          "properties": {
+            "appId": {
+              "type": "keyword",
+              "_meta": {
+                "description": "The application being tracked"
+              }
+            },
+            "viewId": {
+              "type": "keyword",
+              "_meta": {
+                "description": "Always `main`"
+              }
+            },
+            "clicks_total": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application since we started counting them"
+              }
+            },
+            "clicks_7_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 7 days"
+              }
+            },
+            "clicks_30_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 30 days"
+              }
+            },
+            "clicks_90_days": {
+              "type": "long",
+              "_meta": {
+                "description": "General number of clicks in the application over the last 90 days"
+              }
+            },
+            "minutes_on_screen_total": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen since we started counting them."
+              }
+            },
+            "minutes_on_screen_7_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 7 days"
+              }
+            },
+            "minutes_on_screen_30_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 30 days"
+              }
+            },
+            "minutes_on_screen_90_days": {
+              "type": "float",
+              "_meta": {
+                "description": "Minutes the application is active and on-screen over the last 90 days"
+              }
+            },
+            "views": {
+              "type": "array",
+              "items": {
+                "properties": {
+                  "appId": {
+                    "type": "keyword",
+                    "_meta": {
+                      "description": "The application being tracked"
+                    }
+                  },
+                  "viewId": {
+                    "type": "keyword",
+                    "_meta": {
+                      "description": "The application view being tracked"
+                    }
+                  },
+                  "clicks_total": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the application sub view since we started counting them"
+                    }
+                  },
+                  "clicks_7_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 7 days"
+                    }
+                  },
+                  "clicks_30_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 30 days"
+                    }
+                  },
+                  "clicks_90_days": {
+                    "type": "long",
+                    "_meta": {
+                      "description": "General number of clicks in the active application sub view over the last 90 days"
+                    }
+                  },
+                  "minutes_on_screen_total": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application sub view is active and on-screen since we started counting them."
+                    }
+                  },
+                  "minutes_on_screen_7_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 7 days"
+                    }
+                  },
+                  "minutes_on_screen_30_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 30 days"
+                    }
+                  },
+                  "minutes_on_screen_90_days": {
+                    "type": "float",
+                    "_meta": {
+                      "description": "Minutes the application is active and on-screen active application sub view over the last 90 days"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
         "enterpriseSearchAnalytics": {
           "properties": {
             "appId": {

diff --git a/x-pack/plugins/enterprise_search/common/locators/index.ts b/x-pack/plugins/enterprise_search/common/locators/index.ts
@@ -13,10 +13,8 @@ import {
   type CreateIndexLocatorParams,
 } from './create_index_locator';
 import { SearchInferenceEndpointLocatorDefinition } from './inference_locator';
-import { PlaygroundLocatorDefinition, type PlaygroundLocatorParams } from './playground_locator';
 
 export function registerLocators(share: SharePluginSetup) {
   share.url.locators.create<CreateIndexLocatorParams>(new CreateIndexLocatorDefinition());
-  share.url.locators.create<PlaygroundLocatorParams>(new PlaygroundLocatorDefinition());
   share.url.locators.create<SerializableRecord>(new SearchInferenceEndpointLocatorDefinition());
 }
diff --git a/x-pack/plugins/enterprise_search/common/locators/playground_locator.tsx b/x-pack/plugins/enterprise_search/common/locators/playground_locator.tsx
diff --git a/...ck/plugins/enterprise_search/public/applications/__mocks__/kea_logic/kibana_logic.mock.ts b/...ck/plugins/enterprise_search/public/applications/__mocks__/kea_logic/kibana_logic.mock.ts
@@ -16,7 +16,6 @@ import { dataPluginMock } from '@kbn/data-plugin/public/mocks';
 
 import { LensPublicStart } from '@kbn/lens-plugin/public';
 import { mlPluginMock } from '@kbn/ml-plugin/public/mocks';
-import { searchPlaygroundMock } from '@kbn/search-playground/__mocks__/search_playground_mock';
 import { securityMock } from '@kbn/security-plugin/public/mocks';
 import { sharePluginMock } from '@kbn/share-plugin/public/mocks';
 
@@ -67,7 +66,6 @@ export const mockKibanaValues = {
   },
   renderHeaderActions: jest.fn(),
   searchInferenceEndpoints: null,
-  searchPlayground: searchPlaygroundMock.createStart(),
   security: securityMock.createStart(),
   setBreadcrumbs: jest.fn(),
   setChromeIsVisible: jest.fn(),

diff --git a/...ns/enterprise_search/public/applications/applications/components/layout/page_template.tsx b/...ns/enterprise_search/public/applications/applications/components/layout/page_template.tsx
@@ -19,14 +19,12 @@ import { SetEnterpriseSearchApplicationsChrome } from '../../../shared/kibana_ch
 import { EnterpriseSearchPageTemplateWrapper, PageTemplateProps } from '../../../shared/layout';
 import { useEnterpriseSearchApplicationNav } from '../../../shared/layout';
 import { SendEnterpriseSearchTelemetry } from '../../../shared/telemetry';
-import { PlaygroundHeaderDocsAction } from '../playground/header_docs_action';
 import { SearchApplicationHeaderDocsAction } from '../search_application/header_docs_action';
 
 export type EnterpriseSearchApplicationsPageTemplateProps = Omit<
   PageTemplateProps,
   'useEndpointHeaderActions'
 > & {
-  docLink?: 'search_application' | 'playground';
   hasSchemaConflicts?: boolean;
   restrictWidth?: boolean;
   searchApplicationName?: string;
@@ -41,7 +39,6 @@ export const EnterpriseSearchApplicationsPageTemplate: React.FC<
   searchApplicationName,
   hasSchemaConflicts,
   restrictWidth = true,
-  docLink = 'search_application',
   ...pageTemplateProps
 }) => {
   const alwaysReturnNavItems = true;
@@ -72,11 +69,7 @@ export const EnterpriseSearchApplicationsPageTemplate: React.FC<
   );
 
   useLayoutEffect(() => {
-    const docAction = {
-      playground: PlaygroundHeaderDocsAction,
-      search_application: SearchApplicationHeaderDocsAction,
-    }[docLink];
-    renderHeaderActions(docAction);
+    renderHeaderActions(SearchApplicationHeaderDocsAction);
 
     return () => {
       renderHeaderActions();

diff --git a/...rise_search/public/applications/applications/components/playground/header_docs_action.tsx b/...rise_search/public/applications/applications/components/playground/header_docs_action.tsx