[dashboards as code] drilldown schemas by nreese · Pull Request #249445 · elastic/kibana

nreese · 2026-01-16T19:09:43Z

Kibana-presentation team is working on "Dashboards as code" project. Dashboard REST API state contains drilldown state. This PR refactors drilldown state and provides schemas for drilldown state.

Before

In the image below, notice how drilldown state is passed as { enhancements: { dynamicActions: events: [ { ...messyStateWithClassStructures } ] } }. This shape leaks Kibana registry design and class structures into dashboards as code REST API.

After

In the image below, notice how drilldown state is passed as { drilldowns: [ {...cleanState } ] }. Now the dashboards as code REST API does not leak Kibana registry design or class structures.

Overview of changes

EmbeddableServerSetup changes
- Adds registerDrilldown, allowing drilldowns to register schemas and transforms.
- Changes registerTransforms shape from { transformIn, transformOut, ...otherProps } to { getTransforms, ...otherProps }. This change is done to pass drilldownTransforms to embeddable transform implementations. drilldownTransforms is stateful because it uses the contents of drilldown registry.
- Removes transformEnhancementsIn and transformEnhancementsOut from interface. Instead of exposing drilldown tranforms directly from EmbeddableServerSetup, drilldownTransforms is provided to embeddables as a prop to getTransforms
Registers schema and transforms for all drilldown types; dashboard_drilldown, discover_drilldown, and url_drilldown
Updates all usages of registerTransforms to provide { getTransforms, ...otherProps } instead of { transformIn, transformOut, ...otherProps }
Updates all usages of transformEnhancementsIn and transformEnhancementsOut to use drilldownTransforms

What this PR does not do

To limit scope as much as possible, this PR does not refactor client code to use the new drilldown format. As a stop gap, a translation layer is in place that converts drilldowns to enhancements. Then, on save, enhancements are converted back to drilldowns before sending state across the dashboard REST API. In a follow up PR(s), this translation layer will be removed and drilldown client code will be refactored to work directly with DrilldownsState

External team testing

If your embebbable type does not support drilldowns then there is nothing to test.

If your embeddable type does support drilldowns, then run the following

install your favorite data set or use one of the sample data sets that ship with kibana
Open dashboard application and create a new dashboard
Add a panel for your embeddable type
Add one or more drilldowns to this panel
Save dashboard
Inspect network requests (filtering by /api/dashboards). Notice that drilldowns are passed as drilldowns instead of enhancements.
Open dashboard and verify drilldowns still work as expected
Open dashboards with drilldowns created from 9.3 cloud instance and in sure drilldowns still function as expected.

nreese · 2026-01-20T15:14:24Z

@elasticmachine merge upstream

nreese · 2026-01-20T17:24:24Z

@elasticmachine merge upstream

elasticmachine · 2026-01-20T17:24:27Z

merge conflict between base and head

nreese · 2026-01-21T19:45:33Z

/ci

nreese · 2026-01-21T23:26:18Z

/ci

nreese · 2026-01-22T20:54:53Z

@elasticmachine merge upstream

nickpeihl · 2026-02-03T13:31:54Z

src/platform/plugins/shared/embeddable/common/bwc/enhancements/transform_enhancements_out.ts

+
+  const drilldownsFromEnhancements = enhancements.dynamicActions.events
+    .map((event) => {
+      if (event.action.factoryId === 'DASHBOARD_TO_DASHBOARD_DRILLDOWN') {


I wonder if we should be using constants instead of hard-coding the strings here? I see this constant is defined in the dashboard_enhanced plugin, but I expect that plugin will be removed in a subsequent PR?

I see this constant is defined in the dashboard_enhanced plugin, but I expect that plugin will be removed in a subsequent PR?

That is correct. BWC code should be isolated and not import from other places to ensure the functionality remains the same. In this case, dashboard_enhanced, will be removed when client gets migrated to drilldown schema.

For BWC, I think hard coded strings are more clear and since its BWC, we know the string value will never change so there is no advantage for a constant.

src/platform/plugins/shared/embeddable/public/bwc/legacy_url_transform.ts

…1337) There is currently an issue in main where `findLensReference` does not find a lens reference because the reference name is `panel_5` instead of `savedObjectRef`. This causes the transform out to throw because `savedObjectRef && isByRefLensState(state)` check fails and call to `const migratedAttributes = migrateAttributes(state.attributes);` throws. I discovered this because x-pack/platform/test/functional/apps/dashboard/group2/migration_smoke_tests/lens_migration_smoke_test.ts started failing in #249445. With #249445, throwing in lens transforms prevents enhancements from getting converted to drilldowns so the functional test fails because the lens state is `{ enhancements }` instead of `{ drilldowns }`. The root of the problem is that `transformPanelProperties` injects by-reference reference. This is left over from client side injection. The problem is resolved by transforming the reference to what transforms expect and stop injecting references in `transformPanelProperties`. --------- Co-authored-by: Devon Thomson <devon.thomson@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

x-pack/platform/plugins/private/drilldowns/url_drilldown/common/constants.ts

nickpeihl · 2026-02-03T20:17:38Z

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

+// Do not change constan value - part of public REST API
+export const DISCOVER_DRILLDOWN_TYPE = 'discover_drilldown';
+// Only additive changes are allowed, part of public REST API
+export const DISCOVER_DRILLDOWN_SUPPORTED_TRIGGERS = [APPLY_FILTER_TRIGGER];


Great to have these comments.

elasticmachine · 2026-02-03T21:17:15Z

⏳ Build in-progress, with failures

Buildkite Build
Commit: 00cb665

Failed CI Steps

Test Failures

[job] [logs] Jest Tests #22 / drilldown registry getSchemas should include triggers that intersect with supported triggers
[job] [logs] Jest Tests #22 / drilldown registry getSchemas should include triggers that intersect with supported triggers
[job] [logs] Jest Tests #7 / getTransformIn by reference should extract references
[job] [logs] Jest Tests #7 / getTransformIn by reference should extract references
[job] [logs] Jest Tests #7 / getTransformIn by value should extract references
[job] [logs] Jest Tests #7 / getTransformIn by value should extract references
[job] [logs] Jest Tests #7 / getTransformOut by reference should inject references
[job] [logs] Jest Tests #7 / getTransformOut by reference should inject references
[job] [logs] Jest Tests #7 / getTransformOut by value should inject references
[job] [logs] Jest Tests #7 / getTransformOut by value should inject references

History

💔 Build #389551 failed 6eac902
💔 Build #389533 failed e228db3
💔 Build #389450 failed ba4f13c
💛 Build #388717 was flaky aea3e61
💛 Build #388165 was flaky e12c72a

nickpeihl

lgtm! code review only.

davismcphee

Data Discovery changes LGTM 👍

Dosant

i smoked checked image, url drilldowns. lgtm

andrimal

Visualization changes LGTM!

andrimal · 2026-02-04T11:05:38Z

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

nit: I think I would keep the index.ts to the transforms directory and export getTransformIn and getTransformOut from there. This would be consistent with other directories within lens and give us a cleaner import path.

I opted to directly import getTransformOut only because getTransform requires both transformDrilldownOut and trasnformDrilldownIn. In public, only transformDrilldownOut is available and only transformDrilldownOut is needed.

qn895

ML changes LGTM

…hema types (#252976) Follow up to #249445 Part of #239425 Kibana-presentation team is working on "Dashboards as code" project. #249445 created a schema for drilldowns and updated Dashboard REST API to use new schema defined shape for drilldowns. #249445 did not touch client code - leaving client code using old shape. This PR takes the next step and refactors client code to use new schema defined drilldowns shape. ### Overview of changes * Decouples drilldowns from dynamic actions * Moves registryDrilldown from uiActionsEnhanced plugin to embeddables plugin * Moves DrilldownsManager UI components from uiActionsEnhanced plugin to embeddables plugin. The effort tried to change as little as possible in DrilldownsManager UI components. * Removes dashboardEnhanced plugin * Moves createDrilldowns action and manageDrilldowns action registration into embeddable plugin * Moves dashboard drilldown registation into drilldown plugin * Removes emebbeddableEnhanced plugin * Replaces `HasDynamicActions` interface with `HasDrilldown` interface and moves this interface into embeddable plugin * Replaces `initializeDynamicActionsManager` with `initializeDrilldownsManager` * Moves `initializeDrilldownsManager` as parameter passed to `buildEmbeddable` instead of exposing via plugin start contract. * Updates all embeddables to `initializeDrilldownsManager` * Moves DiscoverDrilldown to embeddables plugin `registerDrilldown` * Moves URLDrilldown to embeddables plugin `registerDrilldown` ### What this PR does not do The uiActionsEnhanced plugin can be removed now that drilldowns no longer use dynamic actions. This is clean up work that will occur in future efforts. URLDrilldown is still very intertwined with uiActionsEnhancement plugin. These 2 plugins will need to be separated in future work. ### Embeddable owner test instructions * Create new dashboard * add your embeddable panel * add drilldowns. Ensure they work as expected ### Drilldown owner test instructions * Create new dashboard * add an embeddable panel that supports your drilldown type * add drilldowns. Ensure they work as expected --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

…hema types (elastic#252976) Follow up to elastic#249445 Part of elastic#239425 Kibana-presentation team is working on "Dashboards as code" project. elastic#249445 created a schema for drilldowns and updated Dashboard REST API to use new schema defined shape for drilldowns. elastic#249445 did not touch client code - leaving client code using old shape. This PR takes the next step and refactors client code to use new schema defined drilldowns shape. ### Overview of changes * Decouples drilldowns from dynamic actions * Moves registryDrilldown from uiActionsEnhanced plugin to embeddables plugin * Moves DrilldownsManager UI components from uiActionsEnhanced plugin to embeddables plugin. The effort tried to change as little as possible in DrilldownsManager UI components. * Removes dashboardEnhanced plugin * Moves createDrilldowns action and manageDrilldowns action registration into embeddable plugin * Moves dashboard drilldown registation into drilldown plugin * Removes emebbeddableEnhanced plugin * Replaces `HasDynamicActions` interface with `HasDrilldown` interface and moves this interface into embeddable plugin * Replaces `initializeDynamicActionsManager` with `initializeDrilldownsManager` * Moves `initializeDrilldownsManager` as parameter passed to `buildEmbeddable` instead of exposing via plugin start contract. * Updates all embeddables to `initializeDrilldownsManager` * Moves DiscoverDrilldown to embeddables plugin `registerDrilldown` * Moves URLDrilldown to embeddables plugin `registerDrilldown` ### What this PR does not do The uiActionsEnhanced plugin can be removed now that drilldowns no longer use dynamic actions. This is clean up work that will occur in future efforts. URLDrilldown is still very intertwined with uiActionsEnhancement plugin. These 2 plugins will need to be separated in future work. ### Embeddable owner test instructions * Create new dashboard * add your embeddable panel * add drilldowns. Ensure they work as expected ### Drilldown owner test instructions * Create new dashboard * add an embeddable panel that supports your drilldown type * add drilldowns. Ensure they work as expected --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

nreese added 2 commits January 16, 2026 12:09

[dashboards as code] drilldown schemas

5fba245

tslint

7b437b5

Merge branch 'main' into embeddable_drilldowns

55fd3b8

nreese added 12 commits January 20, 2026 10:26

merge with main

e55b763

fix merge conflicts

3b0d47e

register dashboard drilldown

8c32a56

tslint

9389798

transformDashboardDrilldown

7e2cc8e

eslint

b119cc3

convertToDrilldowns

d5870ca

register url_drilldown

84a8f72

convert url drilldowns

cc6eab5

discover drilldown schema

1121680

drilldown transforms

56727a3

getTransforms

3df9a2a

kibanamachine and others added 4 commits January 21, 2026 20:01

Changes from node scripts/lint_ts_projects --fix

234a47f

Changes from node scripts/regenerate_moon_projects.js --update

9231f1d

Changes from node scripts/eslint_all_files --no-cache --fix

8f02998

tslint image embeddable

eb2b6fc

kibanamachine and others added 2 commits January 21, 2026 23:51

Changes from node scripts/eslint_all_files --no-cache --fix

4939a6a

update drilldown transforms to return all state

8a9aab6

elasticmachine and others added 3 commits January 22, 2026 21:54

Merge branch 'main' into embeddable_drilldowns

70388c4

drilldowns to enhancements

4192464

serializeEnhancements back into drilldowns

70b7310

nickpeihl reviewed Feb 3, 2026

View reviewed changes

src/platform/plugins/shared/embeddable/public/bwc/legacy_url_transform.ts Show resolved Hide resolved

nreese added 6 commits February 3, 2026 09:29

merge with main

8e9ff35

remove enhancements from image schema

8862ac0

typo

3bf0105

typo

ba4f13c

convert triggers from array to just string

f9644e1

make transformIn generic

e5b0fac

nreese requested a review from davismcphee February 3, 2026 18:50

nickpeihl reviewed Feb 3, 2026

View reviewed changes

x-pack/platform/plugins/private/drilldowns/url_drilldown/common/constants.ts Outdated Show resolved Hide resolved

nreese and others added 5 commits February 3, 2026 11:58

add maxSize for number of drilldowns

e228db3

Changes from node scripts/eslint_all_files --no-cache --fix

0a7cf50

import ROW_CLICK_TRIGGER from @kbn/ui-actions-browser

6eac902

Changes from node scripts/lint_ts_projects --fix

ab7bb02

Changes from node scripts/regenerate_moon_projects.js --update

00cb665

nickpeihl reviewed Feb 3, 2026

View reviewed changes

nickpeihl approved these changes Feb 3, 2026

View reviewed changes

davismcphee approved these changes Feb 3, 2026

View reviewed changes

fix jest tests

54ed201

Dosant approved these changes Feb 4, 2026

View reviewed changes

andrimal approved these changes Feb 4, 2026

View reviewed changes

qn895 approved these changes Feb 4, 2026

View reviewed changes

nreese merged commit b2cd262 into elastic:main Feb 4, 2026
16 checks passed

nreese mentioned this pull request Feb 4, 2026

[dashboards as code] Refactor drilldowns UI code to use drilldowns schema types #251715

Closed

nreese mentioned this pull request Feb 12, 2026

[dashboards as code] Refactor drilldowns UI code to use drilldowns schema types #252976

Merged

nreese mentioned this pull request Feb 23, 2026

[Dashboards as code] Rebuild the drilldowns capabilities with schemas in Embeddable plugin #248871

Closed

Conversation

nreese commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before

After

Overview of changes

What this PR does not do

External team testing

Uh oh!

nreese commented Jan 20, 2026

Uh oh!

nreese commented Jan 20, 2026

Uh oh!

elasticmachine commented Jan 20, 2026

Uh oh!

nreese commented Jan 21, 2026

Uh oh!

nreese commented Jan 21, 2026

Uh oh!

nreese commented Jan 22, 2026

Uh oh!

nickpeihl Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

nreese Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nickpeihl Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⏳ Build in-progress, with failures

Failed CI Steps

Test Failures

History

Uh oh!

nickpeihl left a comment

Choose a reason for hiding this comment

Uh oh!

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

andrimal left a comment

Choose a reason for hiding this comment

Uh oh!

andrimal Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

nreese Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

qn895 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

nreese commented Jan 16, 2026 •

edited

Loading

elasticmachine commented Feb 3, 2026 •

edited

Loading