[Lens] Integrate Config Builder into APIs and transforms by nickofthyme · Pull Request #235277 · elastic/kibana

nickofthyme · 2025-09-16T20:54:59Z

Summary

Lens transforms Phase 2

Changes

Integrate the Config Builder

This integrates the LensConfigBuilder into the full end-to-end flow of all aspects of Lens including:

Lens APIs (transforms config to pass over the wire, convert to SO for saving)
Lens public client (transform api format to old Lens state)
Lens transforms (transforms Lens by-value panels for dashboards)

Update Lens CM and API schema

The schemas following changes from #229534, did not match the integration perfectly and stubbed out a few things. So there was some cleanup needed to these schema to make them clearer and easier to understand.

These also needed to be changed to integrate the new lensApiStateSchema that will include all New API Formats.

Registers Lens embeddable transforms

Transforms:

dashboard/server - Used to transform by-ref Lens dashboard panels.
dashboard/public - Used to transform panels from url state.
lens/public - Used to transform standalone Lens embeddables (see example here).

These transforms are meant to transform both:

Item transforms - Current v0 Lens state/attributes with old configurations to the latest state/attributes. Applying all existing runtime migrations and pins version to latest Lens item v1.
- Only for lens/public transforms, we are not saving standalone Lens embeddable state in new API format.
API Format transforms - Transforms the current v1 Lens state to the new API format and vis-versa.
- Needed to save Lens as v1 as SO but pass the New API Format over the wire.
- Needed to save Lens state in dashboard by-value panels in the New API Format.

Transforms are behind a features flag, when enabled it will transform only supported chart types for all lens visualizations including by-ref and by-value. When disabled (default) it will pass around the only Lens SO state as it does today.

# kibana.dev.yml
feature_flags.overrides:
  lens.apiFormat: true

Issues

Closes #229543
Closes #229546
Closed #237192

Checklist

Unit or functional tests were updated or added to match the most common scenarios
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list

This is needed in case of dashboard url state that would bypass other transforms for by-value lens panels.

…b-integration

This item should never return the old `v0` state of lens.

…b-integration

elasticmachine · 2025-11-05T18:26:33Z

Pinging @elastic/kibana-visualizations (Team:Visualizations)

src/platform/packages/shared/kbn-lens-embeddable-utils/config_builder/schema/charts/metric.ts

src/platform/packages/shared/kbn-lens-common-2/README.md

x-pack/platform/plugins/shared/lens/common/transforms/transform_in.ts

x-pack/platform/plugins/shared/lens/common/transforms/utils.ts

x-pack/platform/plugins/shared/lens/public/react_embeddable/helper.ts

x-pack/platform/plugins/shared/lens/public/plugin.ts

x-pack/platform/plugins/shared/lens/server/plugin.tsx

src/platform/packages/shared/kbn-lens-common-2/index.ts

src/platform/packages/shared/kbn-lens-common-2/README.md

x-pack/platform/plugins/shared/lens/public/plugin.ts

x-pack/platform/plugins/shared/lens/server/plugin.tsx

markov00

Reviewed after accepting my previous comments replies. Thanks Nick, all good for me!

dej611

General logic seems ok.
I'm a bit concerned about the lens-common-2 package: perhaps it can have a better name & more organized content? Not a blocker tho.

dej611 · 2025-11-10T09:40:03Z

src/platform/packages/shared/kbn-lens-common-2/README.md

Would it be best to include here all the Lens Embeddable types at this point?
I mean, generic Lens types at this point in @kbn/lens-common and embeddable types in @kbn/lens-embeddable-common. wdyt?

I don't know, whatever makes it easier. I don't love these types being on their own when they should be in Lens.

Especially when the only limitation is the type checking, then re-exporting many of these types from Lens.

x-pack/platform/plugins/shared/lens/common/feature_flags.ts

x-pack/platform/plugins/shared/lens/public/react_embeddable/lens_embeddable.tsx

x-pack/platform/plugins/shared/lens/public/plugin.ts

) ## Summary Lens transforms Phase 2 ### Changes #### Integrate the Config Builder This integrates the `LensConfigBuilder` into the full end-to-end flow of all aspects of Lens including: - Lens APIs (transforms config to pass over the wire, convert to SO for saving) - Lens public client (transform api format to old Lens state) - Lens transforms (transforms Lens by-value panels for dashboards) #### Update Lens CM and API schema The schemas following changes from elastic#229534, did not match the integration perfectly and stubbed out a few things. So there was some cleanup needed to these schema to make them clearer and easier to understand. These also needed to be changed to integrate the new `lensApiStateSchema` that will include all New API Formats. #### Registers Lens embeddable transforms Transforms: - `dashboard/server` - Used to transform by-ref Lens dashboard panels. - `dashboard/public` - Used to transform panels from url state. - `lens/public` - Used to transform standalone Lens embeddables (see example [here](https://github.com/elastic/kibana/blob/ed9f709ef56b182116ebcd788245fdecfdacfd8b/x-pack/platform/plugins/shared/cases/public/components/visualizations/lens_renderer.tsx#L40)). These transforms are meant to transform both: - **Item transforms** - Current `v0` Lens state/attributes with old configurations to the latest state/attributes. Applying all existing runtime migrations and pins version to latest Lens item `v1`. - Only for `lens/public` transforms, we are not saving standalone Lens embeddable state in new API format. - **API Format transforms** - Transforms the current `v1` Lens state to the new API format and vis-versa. - Needed to save Lens as `v1` as SO but pass the New API Format over the wire. - Needed to save Lens state in dashboard by-value panels in the New API Format. Transforms are behind a features flag, when enabled it will transform only supported chart types for all lens visualizations including by-ref and by-value. When disabled (default) it will pass around the only Lens SO state as it does today. ```yml # kibana.dev.yml feature_flags.overrides: lens.apiFormat: true ``` ### Issues Closes elastic#229543 Closes elastic#229546 Closed elastic#237192 ### Checklist - [x] [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] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) --------- Co-authored-by: Peter Pisljar <peter.pisljar@elastic.co> Co-authored-by: dej611 <dej611@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Marco Liberati <dej611@users.noreply.github.com> Co-authored-by: Marco Vettorello <marco.vettorello@elastic.co>

nickofthyme added 4 commits September 16, 2025 14:48

cleanup api/cm schema and types

9b58b6f

integrate config builder into lens api and clients

10f2bd2

add public and server lens embeddable transforms

aad0fdf

add embeddable initial state transforms

a592cd6

This is needed in case of dashboard url state that would bypass other transforms for by-value lens panels.

nickofthyme added Team:Visualizations Team label for Lens, elastic-charts, Graph, legacy editors (TSVB, Visualize, Timelion) t// release_note:skip Skip the PR/issue when compiling release notes Feature:Lens backport:skip This PR does not require backporting labels Sep 16, 2025

nickofthyme mentioned this pull request Sep 16, 2025

[Lens] Add embeddable transforms #229545

Closed

5 tasks

nickofthyme and others added 15 commits September 17, 2025 19:00

dataview fix from peter

4e0efd1

Merge branch 'main' into lens-cb-integration

8ce59be

Merge branch 'main' into lens-cb-integration

23c694c

Merge remote-tracking branch 'origin/lens-cb-integration' into lens-c…

47d1ff9

…b-integration

✨ Add id to the schema

fbb59fc

🐛 Fix the background_chart and dataViews bugs

1976f7b

Merge remote-tracking branch 'origin/lens-cb-integration' into lens-c…

7260819

…b-integration

Merge remote-tracking branch 'upstream/main' into lens-cb-integration

f20d469

Merge remote-tracking branch 'origin/lens-cb-integration' into lens-c…

ffdfa44

…b-integration

Merge branch 'main' into lens-cb-integration

32e7600

update serialized types

372a2a4

add transforms for by-value panels

13cedfe

update lens embeddable to use/transform api format

f1db0ad

feat: allow create with custom ids

044e00f

fix: lens by-value panel refs

22a2611

nickofthyme mentioned this pull request Sep 29, 2025

[Lens] Add telemetry to track obsolete Lens runtime migrations #236848

Draft

2 tasks

nickofthyme added 5 commits October 1, 2025 16:07

add feature flag to enable api transforms

01c1993

Merge branch 'main' into lens-cb-integration

c8ea840

fix type error with response item

2a2a9a4

This item should never return the old `v0` state of lens.

fix custom lens renderer, add parentApi types

cff2bc0

fix api attributes types

05b18e7

nickofthyme added 2 commits November 5, 2025 11:25

fix: alert action tests

7282b3c

Merge remote-tracking branch 'origin/lens-cb-integration' into lens-c…

5c0737a

…b-integration

nickofthyme marked this pull request as ready for review November 5, 2025 18:26

nickofthyme requested review from a team as code owners November 5, 2025 18:26

Merge branch 'main' into lens-cb-integration

4a806e3

elastic deleted a comment from elasticmachine Nov 5, 2025

jbudz approved these changes Nov 5, 2025

View reviewed changes

markov00 reviewed Nov 6, 2025

View reviewed changes

Merge branch 'main' into lens-cb-integration

5847aca

nickofthyme commented Nov 6, 2025

View reviewed changes

nickofthyme added 3 commits November 6, 2025 11:54

chore: rename embeddable transform helpers

4a5b7e5

chore: cleanup naming

8022ab3

chore: remove old metric schema id

933f246

nickofthyme removed the blocked label Nov 6, 2025

markov00 approved these changes Nov 7, 2025

View reviewed changes

Merge branch 'main' into lens-cb-integration

72a1d30

dej611 approved these changes Nov 10, 2025

View reviewed changes

nickofthyme added 4 commits November 10, 2025 07:48

chore: simplify async logic

5ca7844

chore: revert destructure order change

5d30702

test: disable message check on empty response test

5fb7a50

Merge branch 'main' into lens-cb-integration

fb73cbb

elastic deleted a comment from elasticmachine Nov 10, 2025

chore: improve async logic in plugin

8012738

mistic merged commit f2f865d into elastic:main Nov 11, 2025
13 checks passed

kibanamachine added the v9.3.0 label Nov 11, 2025

nickofthyme deleted the lens-cb-integration branch November 11, 2025 15:25

Conversation

nickofthyme commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Integrate the Config Builder

Update Lens CM and API schema

Registers Lens embeddable transforms

Issues

Checklist

Uh oh!

elasticmachine commented Nov 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markov00 left a comment

Choose a reason for hiding this comment

Uh oh!

dej611 left a comment

Choose a reason for hiding this comment

Uh oh!

dej611 Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

nickofthyme Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

nickofthyme commented Sep 16, 2025 •

edited

Loading