Skip to content

VizPanel: Add shouldMigrate() callback to migration logic #1092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leeoniya merged 8 commits into from
Aug 20, 2025
Merged

VizPanel: Add shouldMigrate() callback to migration logic #1092

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6c4beef
VizPanel: Add shouldMigrate() callback to migration logic
leeoniya Apr 9, 2025
fe778b1
ts-expect-error
leeoniya Apr 9, 2025
4a2cc71
Merge remote-tracking branch 'origin/main' into leeoniya/shouldMigrate
adela-almasan Aug 6, 2025
d2785f7
add tests for shouldMigrate
adela-almasan Aug 7, 2025
7fec79e
updated PR in expect-error
adela-almasan Aug 7, 2025
86839fd
Merge branch 'main' into leeoniya/shouldMigrate
adela-almasan Aug 7, 2025
6901b37
Merge branch 'main' into leeoniya/shouldMigrate
leeoniya Aug 20, 2025
0bcfa58
apply suggestions
leeoniya Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/scenes/src/components/VizPanel/VizPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,11 @@ export class VizPanel<TOptions = {}, TFieldConfig extends {} = {}> extends Scene

_UNSAFE_customMigrationHandler?.(panel, plugin);

if (plugin.onPanelMigration && currentVersion !== pluginVersion && !isAfterPluginChange) {
if (
plugin.onPanelMigration &&
(currentVersion !== pluginVersion || plugin.shouldMigrate?.(panel)) &&
!isAfterPluginChange
) {
// These migration handlers also mutate panel.fieldConfig to migrate fieldConfig
panel.options = await plugin.onPanelMigration(panel);
}
Expand Down
Loading