[Canvas] Adds references extract/inject for Workpads (#109874) (#110621)

* Register embeddable functions server side. Adds reference extraction/injection to workpads * Clean up * Fix Types * Update API docs * Remove API doc from expression (bad conflict resolution) Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # src/plugins/embeddable/kibana.json # x-pack/plugins/canvas/canvas_plugin_src/functions/external/index.ts
elastic · Aug 31, 2021 · 3172b55 · 3172b55
1 parent bf5e982
commit 3172b55
Show file tree

Hide file tree

Showing 41 changed files with 543 additions and 213 deletions.
diff --git a/src/plugins/discover/common/index.ts b/src/plugins/discover/common/index.ts
@@ -20,3 +20,4 @@ export const MODIFY_COLUMNS_ON_SWITCH = 'discover:modifyColumnsOnSwitch';
 export const SEARCH_FIELDS_FROM_SOURCE = 'discover:searchFieldsFromSource';
 export const MAX_DOC_FIELDS_DISPLAYED = 'discover:maxDocFieldsDisplayed';
 export const SHOW_MULTIFIELDS = 'discover:showMultiFields';
+export const SEARCH_EMBEDDABLE_TYPE = 'search';
diff --git a/src/plugins/discover/kibana.json b/src/plugins/discover/kibana.json
@@ -17,6 +17,7 @@
   ],
   "optionalPlugins": ["home", "share", "usageCollection"],
   "requiredBundles": ["kibanaUtils", "home", "kibanaReact", "fieldFormats"],
+  "extraPublicDirs": ["common"],
   "owner": {
     "name": "Data Discovery",
     "githubTeam": "kibana-data-discovery"

diff --git a/src/plugins/discover/public/application/embeddable/constants.ts b/src/plugins/discover/public/application/embeddable/constants.ts
@@ -6,4 +6,4 @@
  * Side Public License, v 1.
  */
 
-export const SEARCH_EMBEDDABLE_TYPE = 'search';
+export { SEARCH_EMBEDDABLE_TYPE } from '../../../common/index';
diff --git a/src/plugins/embeddable/kibana.json b/src/plugins/embeddable/kibana.json
@@ -8,5 +8,6 @@
     "githubTeam": "kibana-app-services"
   },
   "requiredPlugins": ["inspector", "uiActions"],
+  "extraPublicDirs": ["common"],
   "requiredBundles": ["savedObjects", "kibanaReact", "kibanaUtils"]
 }
diff --git a/src/plugins/expressions/common/service/expressions_services.ts b/src/plugins/expressions/common/service/expressions_services.ts
@@ -54,6 +54,8 @@ export type ExpressionsServiceSetup = Pick<
   | 'registerType'
   | 'run'
   | 'fork'
+  | 'extract'
+  | 'inject'
 >;
 
 export interface ExpressionExecutionParams {

diff --git a/src/plugins/expressions/public/mocks.tsx b/src/plugins/expressions/public/mocks.tsx
@@ -16,13 +16,15 @@ export type Start = jest.Mocked<ExpressionsStart>;
 
 const createSetupContract = (): Setup => {
   const setupContract: Setup = {
+    extract: jest.fn(),
     fork: jest.fn(),
     getFunction: jest.fn(),
     getFunctions: jest.fn(),
     getRenderer: jest.fn(),
     getRenderers: jest.fn(),
     getType: jest.fn(),
     getTypes: jest.fn(),
+    inject: jest.fn(),
     registerFunction: jest.fn(),
     registerRenderer: jest.fn(),
     registerType: jest.fn(),

diff --git a/src/plugins/expressions/server/mocks.ts b/src/plugins/expressions/server/mocks.ts
@@ -15,13 +15,15 @@ export type Start = jest.Mocked<ExpressionsServerStart>;
 
 const createSetupContract = (): Setup => {
   const setupContract: Setup = {
+    extract: jest.fn(),
     fork: jest.fn(),
     getFunction: jest.fn(),
     getFunctions: jest.fn(),
     getRenderer: jest.fn(),
     getRenderers: jest.fn(),
     getType: jest.fn(),
     getTypes: jest.fn(),
+    inject: jest.fn(),
     registerFunction: jest.fn(),
     registerRenderer: jest.fn(),
     registerType: jest.fn(),

diff --git a/src/plugins/visualizations/common/constants.ts b/src/plugins/visualizations/common/constants.ts
@@ -7,3 +7,4 @@
  */
 
 export const VISUALIZE_ENABLE_LABS_SETTING = 'visualize:enableLabs';
+export const VISUALIZE_EMBEDDABLE_TYPE = 'visualization';
diff --git a/src/plugins/visualizations/public/embeddable/constants.ts b/src/plugins/visualizations/public/embeddable/constants.ts
@@ -6,4 +6,4 @@
  * Side Public License, v 1.
  */
 
-export const VISUALIZE_EMBEDDABLE_TYPE = 'visualization';
+export { VISUALIZE_EMBEDDABLE_TYPE } from '../../common/constants';
diff --git a/x-pack/plugins/canvas/canvas_plugin_src/expression_types/embeddable.ts b/x-pack/plugins/canvas/canvas_plugin_src/expression_types/embeddable.ts
@@ -6,7 +6,7 @@
  */
 
 import { ExpressionTypeDefinition } from '../../../../../src/plugins/expressions';
-import { EmbeddableInput } from '../../../../../src/plugins/embeddable/public';
+import { EmbeddableInput } from '../../../../../src/plugins/embeddable/common/';
 import { EmbeddableTypes } from './embeddable_types';
 
 export const EmbeddableExpressionType = 'embeddable';

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/expression_types/embeddable_types.ts b/x-pack/plugins/canvas/canvas_plugin_src/expression_types/embeddable_types.ts
@@ -5,10 +5,10 @@
  * 2.0.
  */
 
-import { MAP_SAVED_OBJECT_TYPE } from '../../../../plugins/maps/public';
-import { VISUALIZE_EMBEDDABLE_TYPE } from '../../../../../src/plugins/visualizations/public';
+import { MAP_SAVED_OBJECT_TYPE } from '../../../../plugins/maps/common/constants';
+import { VISUALIZE_EMBEDDABLE_TYPE } from '../../../../../src/plugins/visualizations/common/constants';
 import { LENS_EMBEDDABLE_TYPE } from '../../../../plugins/lens/common/constants';
-import { SEARCH_EMBEDDABLE_TYPE } from '../../../../../src/plugins/discover/public';
+import { SEARCH_EMBEDDABLE_TYPE } from '../../../../../src/plugins/discover/common';
 
 export const EmbeddableTypes: {
   lens: string;

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.test.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.test.ts
@@ -6,7 +6,7 @@
  */
 
 import { savedLens } from './saved_lens';
-import { getQueryFilters } from '../../../public/lib/build_embeddable_filters';
+import { getQueryFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter } from '../../../types';
 
 const filterContext: ExpressionValueFilter = {

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts
@@ -7,9 +7,10 @@
 
 import { ExpressionFunctionDefinition } from 'src/plugins/expressions/common';
 import { PaletteOutput } from 'src/plugins/charts/common';
-import { TimeRange, Filter as DataFilter } from 'src/plugins/data/public';
-import { EmbeddableInput } from 'src/plugins/embeddable/public';
-import { getQueryFilters } from '../../../public/lib/build_embeddable_filters';
+import { Filter as DataFilter } from '@kbn/es-query';
+import { TimeRange } from 'src/plugins/data/common';
+import { EmbeddableInput } from 'src/plugins/embeddable/common';
+import { getQueryFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter, TimeRange as TimeRangeArg } from '../../../types';
 import {
   EmbeddableTypes,
@@ -18,7 +19,6 @@ import {
 } from '../../expression_types';
 import { getFunctionHelp } from '../../../i18n';
 import { SavedObjectReference } from '../../../../../../src/core/types';
-
 interface Arguments {
   id: string;
   title: string | null;

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_map.test.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_map.test.ts
@@ -6,7 +6,7 @@
  */
 
 import { savedMap } from './saved_map';
-import { getQueryFilters } from '../../../public/lib/build_embeddable_filters';
+import { getQueryFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter } from '../../../types';
 
 const filterContext: ExpressionValueFilter = {

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_map.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_map.ts
@@ -6,15 +6,15 @@
  */
 
 import { ExpressionFunctionDefinition } from 'src/plugins/expressions/common';
-import { getQueryFilters } from '../../../public/lib/build_embeddable_filters';
+import { getQueryFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter, MapCenter, TimeRange as TimeRangeArg } from '../../../types';
 import {
   EmbeddableTypes,
   EmbeddableExpressionType,
   EmbeddableExpression,
 } from '../../expression_types';
 import { getFunctionHelp } from '../../../i18n';
-import { MapEmbeddableInput } from '../../../../../plugins/maps/public/embeddable';
+import { MapEmbeddableInput } from '../../../../../plugins/maps/public';
 import { SavedObjectReference } from '../../../../../../src/core/types';
 
 interface Arguments {

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_search.test.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_search.test.ts
@@ -6,7 +6,7 @@
  */
 
 import { savedSearch } from './saved_search';
-import { buildEmbeddableFilters } from '../../../public/lib/build_embeddable_filters';
+import { buildEmbeddableFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter } from '../../../types';
 
 const filterContext: ExpressionValueFilter = {

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_search.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_search.ts
@@ -13,7 +13,7 @@ import {
   EmbeddableExpression,
 } from '../../expression_types';
 
-import { buildEmbeddableFilters } from '../../../public/lib/build_embeddable_filters';
+import { buildEmbeddableFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter } from '../../../types';
 import { getFunctionHelp } from '../../../i18n';
 import { SavedObjectReference } from '../../../../../../src/core/types';

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_visualization.test.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_visualization.test.ts
@@ -6,7 +6,7 @@
  */
 
 import { savedVisualization } from './saved_visualization';
-import { getQueryFilters } from '../../../public/lib/build_embeddable_filters';
+import { getQueryFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter } from '../../../types';
 
 const filterContext: ExpressionValueFilter = {

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_visualization.ts b/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_visualization.ts
@@ -12,7 +12,7 @@ import {
   EmbeddableExpressionType,
   EmbeddableExpression,
 } from '../../expression_types';
-import { getQueryFilters } from '../../../public/lib/build_embeddable_filters';
+import { getQueryFilters } from '../../../common/lib/build_embeddable_filters';
 import { ExpressionValueFilter, TimeRange as TimeRangeArg, SeriesStyle } from '../../../types';
 import { getFunctionHelp } from '../../../i18n';
 import { SavedObjectReference } from '../../../../../../src/core/types';

diff --git a/x-pack/plugins/canvas/canvas_plugin_src/plugin.ts b/x-pack/plugins/canvas/canvas_plugin_src/plugin.ts
@@ -15,6 +15,7 @@ import { Start as InspectorStart } from '../../../../src/plugins/inspector/publi
 import { functions } from './functions/browser';
 import { typeFunctions } from './expression_types';
 import { renderFunctions, renderFunctionFactories } from './renderers';
+
 interface SetupDeps {
   canvas: CanvasSetup;
 }

diff --git a/...ins/canvas/public/lib/build_bool_array.js → ...ins/canvas/common/lib/build_bool_array.js b/...ins/canvas/public/lib/build_bool_array.js → ...ins/canvas/common/lib/build_bool_array.js
diff --git a/...blic/lib/build_embeddable_filters.test.ts → ...mmon/lib/build_embeddable_filters.test.ts b/...blic/lib/build_embeddable_filters.test.ts → ...mmon/lib/build_embeddable_filters.test.ts
diff --git a/...as/public/lib/build_embeddable_filters.ts → ...as/common/lib/build_embeddable_filters.ts b/...as/public/lib/build_embeddable_filters.ts → ...as/common/lib/build_embeddable_filters.ts
@@ -9,7 +9,7 @@ import { buildQueryFilter, Filter } from '@kbn/es-query';
 import { ExpressionValueFilter } from '../../types';
 // @ts-expect-error untyped local
 import { buildBoolArray } from './build_bool_array';
-import { TimeRange } from '../../../../../src/plugins/data/public';
+import { TimeRange } from '../../../../../src/plugins/data/common';
 
 export interface EmbeddableFilterInput {
   filters: Filter[];

diff --git a/x-pack/plugins/canvas/public/lib/filters.js → x-pack/plugins/canvas/common/lib/filters.js b/x-pack/plugins/canvas/public/lib/filters.js → x-pack/plugins/canvas/common/lib/filters.js
diff --git a/...lugins/canvas/public/lib/get_es_filter.js → ...lugins/canvas/common/lib/get_es_filter.js b/...lugins/canvas/public/lib/get_es_filter.js → ...lugins/canvas/common/lib/get_es_filter.js
diff --git a/x-pack/plugins/canvas/public/functions/timelion.ts b/x-pack/plugins/canvas/public/functions/timelion.ts
@@ -13,7 +13,7 @@ import { TimeRange } from 'src/plugins/data/common';
 import { ExpressionFunctionDefinition, DatatableRow } from 'src/plugins/expressions/public';
 import { fetch } from '../../common/lib/fetch';
 // @ts-expect-error untyped local
-import { buildBoolArray } from '../../public/lib/build_bool_array';
+import { buildBoolArray } from '../../common/lib/build_bool_array';
 import { Datatable, ExpressionValueFilter } from '../../types';
 import { getFunctionHelp } from '../../i18n';
 import { InitializeArguments } from './';

diff --git a/x-pack/plugins/canvas/server/mocks/index.ts b/x-pack/plugins/canvas/server/mocks/index.ts
@@ -0,0 +1,8 @@
+/*
+ * 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 { workpadRouteContextMock, MockWorkpadRouteContext } from './workpad_route_context';
diff --git a/x-pack/plugins/canvas/server/mocks/workpad_route_context.ts b/x-pack/plugins/canvas/server/mocks/workpad_route_context.ts
@@ -0,0 +1,28 @@
+/*
+ * 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 { CanvasRouteHandlerContext } from '../workpad_route_context';
+
+export interface MockWorkpadRouteContext extends CanvasRouteHandlerContext {
+  canvas: {
+    workpad: {
+      create: jest.Mock;
+      get: jest.Mock;
+      update: jest.Mock;
+    };
+  };
+}
+
+export const workpadRouteContextMock = {
+  create: (): MockWorkpadRouteContext['canvas'] => ({
+    workpad: {
+      create: jest.fn(),
+      get: jest.fn(),
+      update: jest.fn(),
+    },
+  }),
+};
diff --git a/x-pack/plugins/canvas/server/plugin.ts b/x-pack/plugins/canvas/server/plugin.ts
@@ -26,6 +26,7 @@ import { customElementType, workpadType, workpadTemplateType } from './saved_obj
 import { initializeTemplates } from './templates';
 import { essqlSearchStrategyProvider } from './lib/essql_strategy';
 import { getUISettings } from './ui_settings';
+import { CanvasRouteHandlerContext, createWorkpadRouteContext } from './workpad_route_context';
 
 interface PluginsSetup {
   expressions: ExpressionsServerSetup;
@@ -48,18 +49,26 @@ export class CanvasPlugin implements Plugin {
   }
 
   public setup(coreSetup: CoreSetup<PluginsStart>, plugins: PluginsSetup) {
+    const expressionsFork = plugins.expressions.fork();
+
     coreSetup.uiSettings.register(getUISettings());
     coreSetup.savedObjects.registerType(customElementType);
     coreSetup.savedObjects.registerType(workpadType);
     coreSetup.savedObjects.registerType(workpadTemplateType);
 
     plugins.features.registerKibanaFeature(getCanvasFeature(plugins));
 
-    const canvasRouter = coreSetup.http.createRouter();
+    const contextProvider = createWorkpadRouteContext({ expressions: expressionsFork });
+    coreSetup.http.registerRouteHandlerContext<CanvasRouteHandlerContext, 'canvas'>(
+      'canvas',
+      contextProvider
+    );
+
+    const canvasRouter = coreSetup.http.createRouter<CanvasRouteHandlerContext>();
 
     initRoutes({
       router: canvasRouter,
-      expressions: plugins.expressions,
+      expressions: expressionsFork,
       bfetch: plugins.bfetch,
       logger: this.logger,
     });
@@ -73,7 +82,7 @@ export class CanvasPlugin implements Plugin {
     const globalConfig = this.initializerContext.config.legacy.get();
     registerCanvasUsageCollector(plugins.usageCollection, globalConfig.kibana.index);
 
-    setupInterpreter(plugins.expressions);
+    setupInterpreter(expressionsFork);
 
     coreSetup.getStartServices().then(([_, depsStart]) => {
       const strategy = essqlSearchStrategyProvider();

diff --git a/x-pack/plugins/canvas/server/routes/catch_error_handler.ts b/x-pack/plugins/canvas/server/routes/catch_error_handler.ts
@@ -5,11 +5,11 @@
  * 2.0.
  */
 
-import { RequestHandler } from 'src/core/server';
+import { RequestHandler, RequestHandlerContext } from 'src/core/server';
 
-export const catchErrorHandler: <P, Q, B>(
-  fn: RequestHandler<P, Q, B>
-) => RequestHandler<P, Q, B> = (fn) => {
+export const catchErrorHandler: <P, Q, B, Context extends RequestHandlerContext>(
+  fn: RequestHandler<P, Q, B, Context>
+) => RequestHandler<P, Q, B, Context> = (fn) => {
   return async (context, request, response) => {
     try {
       return await fn(context, request, response);

diff --git a/x-pack/plugins/canvas/server/routes/index.ts b/x-pack/plugins/canvas/server/routes/index.ts
@@ -14,9 +14,10 @@ import { initShareablesRoutes } from './shareables';
 import { initWorkpadRoutes } from './workpad';
 import { initTemplateRoutes } from './templates';
 import { initFunctionsRoutes } from './functions';
+import { CanvasRouteHandlerContext } from '../workpad_route_context';
 
 export interface RouteInitializerDeps {
-  router: IRouter;
+  router: IRouter<CanvasRouteHandlerContext>;
   logger: Logger;
   expressions: ExpressionsServerSetup;
   bfetch: BfetchServerSetup;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@
		*/

		export const VISUALIZE_ENABLE_LABS_SETTING = 'visualize:enableLabs';
		export const VISUALIZE_EMBEDDABLE_TYPE = 'visualization';