[Lens][Embeddable] Unify internal api into a single object (#204194)

## Summary Fixes #198753 Initially `visualizationContext` was migrated from the legacy system "as-is" when refactoring to the new system. This PR merges the `visualizationContextHelpers` within the Lens `internalApi` to avoid: * attributes unsync (it rely on the `attributes` variable which is hold by the `internalApi` already) * single place to find internal variables Took also the opportunity to simplify the mocks here: * use the actual implementation for the internalApi vs mocks * this would simplify also the maintenance of types in the future * adapted the tests to use the new implementation and `internalApi`
elastic · Dec 18, 2024 · 6490c45 · 6490c45
1 parent 860d5b6
commit 6490c45
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 125 deletions.
diff --git a/x-pack/plugins/lens/public/react_embeddable/data_loader.ts b/x-pack/plugins/lens/public/react_embeddable/data_loader.ts
@@ -22,13 +22,7 @@ import {
 import fastIsEqual from 'fast-deep-equal';
 import { pick } from 'lodash';
 import { getEditPath } from '../../common/constants';
-import type {
-  GetStateType,
-  LensApi,
-  LensInternalApi,
-  LensPublicCallbacks,
-  VisualizationContextHelper,
-} from './types';
+import type { GetStateType, LensApi, LensInternalApi, LensPublicCallbacks } from './types';
 import { getExpressionRendererParams } from './expressions/expression_params';
 import type { LensEmbeddableStartServices } from './types';
 import { prepareCallbacks } from './expressions/callbacks';
@@ -84,7 +78,6 @@ export function loadEmbeddableData(
   parentApi: unknown,
   internalApi: LensInternalApi,
   services: LensEmbeddableStartServices,
-  { getVisualizationContext, updateVisualizationContext }: VisualizationContextHelper,
   metaInfo?: SharingSavedObjectProps
 ) {
   const { onLoad, onBeforeBadgesRender, ...callbacks } = apiHasLensComponentCallbacks(parentApi)
@@ -103,7 +96,6 @@ export function loadEmbeddableData(
   } = buildUserMessagesHelpers(
     api,
     internalApi,
-    getVisualizationContext,
     services,
     onBeforeBadgesRender,
     services.spaces,
@@ -174,7 +166,7 @@ export function loadEmbeddableData(
     };
 
     const onDataCallback = (adapters: Partial<DefaultInspectorAdapters> | undefined) => {
-      updateVisualizationContext({
+      internalApi.updateVisualizationContext({
         activeData: adapters?.tables?.tables,
       });
       // data has loaded
@@ -243,8 +235,8 @@ export function loadEmbeddableData(
 
     // update the visualization context before anything else
     // as it will be used to compute blocking errors also in case of issues
-    updateVisualizationContext({
-      doc: currentState.attributes,
+    internalApi.updateVisualizationContext({
+      activeAttributes: currentState.attributes,
       mergedSearchContext: params?.searchContext || {},
       ...rest,
     });

diff --git a/x-pack/plugins/lens/public/react_embeddable/helper.ts b/x-pack/plugins/lens/public/react_embeddable/helper.ts
@@ -40,7 +40,7 @@ export function createEmptyLensState(
         query: query || { query: '', language: 'kuery' },
         filters: filters || [],
         internalReferences: [],
-        datasourceStates: { ...(isTextBased ? { text_based: {} } : { form_based: {} }) },
+        datasourceStates: { ...(isTextBased ? { textBased: {} } : { formBased: {} }) },
         visualization: {},
       },
     },

diff --git a/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_actions.test.ts b/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_actions.test.ts
@@ -13,8 +13,8 @@ import {
   getLensApiMock,
   makeEmbeddableServices,
   getLensRuntimeStateMock,
-  getVisualizationContextHelperMock,
   createUnifiedSearchApi,
+  getLensInternalApiMock,
 } from '../mocks';
 import { createEmptyLensState } from '../helper';
 const DATAVIEW_ID = 'myDataView';
@@ -40,11 +40,17 @@ function setupActionsApi(
 ) {
   const services = makeEmbeddableServices(undefined, undefined, {
     visOverrides: { id: 'lnsXY' },
-    dataOverrides: { id: 'form_based' },
+    dataOverrides: { id: 'formBased' },
   });
   const uuid = faker.string.uuid();
   const runtimeState = getLensRuntimeStateMock(stateOverrides);
   const apiMock = getLensApiMock();
+  // create the internal API and customize internal state
+  const internalApi = getLensInternalApiMock();
+  internalApi.updateVisualizationContext({
+    ...contextOverrides,
+    activeAttributes: runtimeState.attributes,
+  });
 
   const { api } = initializeActionApi(
     uuid,
@@ -53,7 +59,7 @@ function setupActionsApi(
     createUnifiedSearchApi(),
     pick(apiMock, ['timeRange$']),
     pick(apiMock, ['panelTitle']),
-    getVisualizationContextHelperMock(stateOverrides?.attributes, contextOverrides),
+    internalApi,
     {
       ...services,
       data: {
@@ -85,6 +91,7 @@ describe('Dashboard actions', () => {
   describe('Explore in Discover', () => {
     // make it pass the basic check on viewUnderlyingData
     const visualizationContextMockOverrides = {
+      activeAttributes: undefined,
       mergedSearchContext: {},
       indexPatterns: {
         [DATAVIEW_ID]: {

diff --git a/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_actions.ts b/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_actions.ts
@@ -34,10 +34,10 @@ import { buildObservableVariable, isTextBasedLanguage } from '../helper';
 import type {
   GetStateType,
   LensEmbeddableStartServices,
+  LensInternalApi,
   LensRuntimeState,
   ViewInDiscoverCallbacks,
   ViewUnderlyingDataArgs,
-  VisualizationContextHelper,
 } from '../types';
 import { getActiveDatasourceIdFromDoc, getActiveVisualizationIdFromDoc } from '../../utils';
 
@@ -120,7 +120,7 @@ function getViewUnderlyingDataArgs({
 
 function loadViewUnderlyingDataArgs(
   state: LensRuntimeState,
-  { getVisualizationContext }: VisualizationContextHelper,
+  { getVisualizationContext }: LensInternalApi,
   searchContextApi: { timeRange$: PublishingSubject<TimeRange | undefined> },
   parentApi: unknown,
   {
@@ -132,16 +132,21 @@ function loadViewUnderlyingDataArgs(
     visualizationMap,
   }: LensEmbeddableStartServices
 ) {
-  const { doc, activeData, activeDatasourceState, activeVisualizationState, indexPatterns } =
-    getVisualizationContext();
-  const activeVisualizationId = getActiveVisualizationIdFromDoc(doc);
-  const activeDatasourceId = getActiveDatasourceIdFromDoc(doc);
+  const {
+    activeAttributes,
+    activeData,
+    activeDatasourceState,
+    activeVisualizationState,
+    indexPatterns,
+  } = getVisualizationContext();
+  const activeVisualizationId = getActiveVisualizationIdFromDoc(activeAttributes);
+  const activeDatasourceId = getActiveDatasourceIdFromDoc(activeAttributes);
   const activeVisualization = activeVisualizationId
     ? visualizationMap[activeVisualizationId]
     : undefined;
   const activeDatasource = activeDatasourceId ? datasourceMap[activeDatasourceId] : undefined;
   if (
-    !doc ||
+    !activeAttributes ||
     !activeData ||
     !activeDatasource ||
     !activeDatasourceState ||
@@ -199,7 +204,7 @@ function loadViewUnderlyingDataArgs(
 
 function createViewUnderlyingDataApis(
   getState: GetStateType,
-  visualizationContextHelper: VisualizationContextHelper,
+  internalApi: LensInternalApi,
   searchContextApi: { timeRange$: PublishingSubject<TimeRange | undefined> },
   parentApi: unknown,
   services: LensEmbeddableStartServices
@@ -213,7 +218,7 @@ function createViewUnderlyingDataApis(
     loadViewUnderlyingData: () => {
       viewUnderlyingDataArgs = loadViewUnderlyingDataArgs(
         getState(),
-        visualizationContextHelper,
+        internalApi,
         searchContextApi,
         parentApi,
         services
@@ -237,7 +242,7 @@ export function initializeActionApi(
   parentApi: unknown,
   searchContextApi: { timeRange$: PublishingSubject<TimeRange | undefined> },
   titleApi: { panelTitle: PublishingSubject<string | undefined> },
-  visualizationContextHelper: VisualizationContextHelper,
+  internalApi: LensInternalApi,
   services: LensEmbeddableStartServices
 ): {
   api: ViewInDiscoverCallbacks & HasDynamicActions;
@@ -257,7 +262,7 @@ export function initializeActionApi(
       ...(isTextBasedLanguage(initialState) ? {} : dynamicActionsApi?.dynamicActionsApi ?? {}),
       ...createViewUnderlyingDataApis(
         getLatestState,
-        visualizationContextHelper,
+        internalApi,
         searchContextApi,
         parentApi,
         services

diff --git a/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_internal_api.ts b/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_internal_api.ts
@@ -15,6 +15,7 @@ import type {
   LensInternalApi,
   LensOverrides,
   LensRuntimeState,
+  VisualizationContext,
 } from '../types';
 import { apiHasAbortController, apiHasLensComponentProps } from '../type_guards';
 import type { UserMessage } from '../../types';
@@ -52,6 +53,18 @@ export function initializeInternalApi(
   // the isNewPanel won't be serialized so it will be always false after the edit panel closes applying the changes
   const isNewlyCreated$ = new BehaviorSubject<boolean>(initialState.isNewPanel || false);
 
+  const visualizationContext$ = new BehaviorSubject<VisualizationContext>({
+    // doc can point to a different set of attributes for the visualization
+    // i.e. when inline editing or applying a suggestion
+    activeAttributes: initialState.attributes,
+    mergedSearchContext: {},
+    indexPatterns: {},
+    indexPatternRefs: [],
+    activeVisualizationState: undefined,
+    activeDatasourceState: undefined,
+    activeData: undefined,
+  });
+
   // No need to expose anything at public API right now, that would happen later on
   // where each initializer will pick what it needs and publish it
   return {
@@ -65,6 +78,8 @@ export function initializeInternalApi(
     renderCount$,
     isNewlyCreated$,
     dataViews: dataViews$,
+    messages$,
+    validationMessages$,
     dispatchError: () => {
       hasRenderCompleted$.next(true);
       renderCount$.next(renderCount$.getValue() + 1);
@@ -82,9 +97,7 @@ export function initializeInternalApi(
     updateAbortController: (abortController: AbortController | undefined) =>
       expressionAbortController$.next(abortController),
     updateDataViews: (dataViews: DataView[] | undefined) => dataViews$.next(dataViews),
-    messages$,
     updateMessages: (newMessages: UserMessage[]) => messages$.next(newMessages),
-    validationMessages$,
     updateValidationMessages: (newMessages: UserMessage[]) => validationMessages$.next(newMessages),
     resetAllMessages: () => {
       messages$.next([]);
@@ -116,5 +129,12 @@ export function initializeInternalApi(
 
       return displayOptions;
     },
+    getVisualizationContext: () => visualizationContext$.getValue(),
+    updateVisualizationContext: (newVisualizationContext: Partial<VisualizationContext>) => {
+      visualizationContext$.next({
+        ...visualizationContext$.getValue(),
+        ...newVisualizationContext,
+      });
+    },
   };
 }
diff --git a/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_visualization_context.ts b/x-pack/plugins/lens/public/react_embeddable/initializers/initialize_visualization_context.ts
diff --git a/x-pack/plugins/lens/public/react_embeddable/lens_embeddable.tsx b/x-pack/plugins/lens/public/react_embeddable/lens_embeddable.tsx
@@ -22,7 +22,6 @@ import { initializeInspector } from './initializers/initialize_inspector';
 import { initializeDashboardServices } from './initializers/initialize_dashboard_services';
 import { initializeInternalApi } from './initializers/initialize_internal_api';
 import { initializeSearchContext } from './initializers/initialize_search_context';
-import { initializeVisualizationContext } from './initializers/initialize_visualization_context';
 import { initializeActionApi } from './initializers/initialize_actions';
 import { initializeIntegrations } from './initializers/initialize_integrations';
 import { initializeStateManagement } from './initializers/initialize_state_management';
@@ -61,8 +60,6 @@ export const createLensEmbeddableFactory = (
        */
       const internalApi = initializeInternalApi(initialState, parentApi, services);
 
-      const visualizationContextHelper = initializeVisualizationContext(internalApi);
-
       /**
        * Initialize various configurations required to build all the required
        * parts for the Lens embeddable.
@@ -108,7 +105,7 @@ export const createLensEmbeddableFactory = (
         parentApi,
         searchContextConfig.api,
         dashboardConfig.api,
-        visualizationContextHelper,
+        internalApi,
         services
       );
 
@@ -165,8 +162,7 @@ export const createLensEmbeddableFactory = (
         api,
         parentApi,
         internalApi,
-        services,
-        visualizationContextHelper
+        services
       );
 
       const onUnmount = () => {