From 98aa6c50dc6ef8979c2f8e5e9f4fee4a944a40f1 Mon Sep 17 00:00:00 2001 From: Alexa Vargas <239999+axelavargas@users.noreply.github.com> Date: Thu, 18 Dec 2025 16:42:37 +0100 Subject: [PATCH] DashboardLibrary: Force v1 dashboard scene page manager when loading template dashboards (#115488) Force v1 manager for template dashboards feature --- .../DashboardScenePageStateManager.test.ts | 117 ++++++++++++++++++ .../pages/DashboardScenePageStateManager.ts | 6 + 2 files changed, 123 insertions(+) diff --git a/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.test.ts b/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.test.ts index 00de1c7ea13..b1857c9f01e 100644 --- a/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.test.ts +++ b/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.test.ts @@ -1673,6 +1673,123 @@ describe('UnifiedDashboardScenePageStateManager', () => { expect(manager2['activeManager']).toBeInstanceOf(DashboardScenePageStateManagerV2); }); }); + + describe('Template dashboards', () => { + let originalGetLocation: typeof locationService.getLocation; + + beforeEach(() => { + originalGetLocation = locationService.getLocation; + + // Mock window.location.search for loadDashboardLibrary + Object.defineProperty(window, 'location', { + value: { + search: '?gnetId=969&datasource=xpyRJd9Mz&mappings=%5B%5D', + }, + writable: true, + }); + }); + + afterEach(() => { + locationService.getLocation = originalGetLocation; + }); + + it('should always use v1 manager for template dashboards even when dashboardNewLayouts is enabled', async () => { + config.featureToggles.dashboardNewLayouts = true; + config.featureToggles.suggestedDashboards = true; + + // Mock location service with gnetId and mappings parameters + locationService.getLocation = jest.fn().mockReturnValue({ + pathname: '/dashboard/template', + search: '?gnetId=969&datasource=xpyRJd9Mz&mappings=%5B%5D', + }); + + // Mock the backend to return a community dashboard from grafana.com + setBackendSrv({ + get: jest.fn((url: string) => { + if (url.includes('/api/gnet/dashboards/')) { + return Promise.resolve({ + json: { + title: 'AWS ElastiCache Redis', + uid: '', + panels: [], + schemaVersion: 40, + }, + }); + } + return Promise.reject(new Error('Not found')); + }), + post: jest.fn((url: string) => { + if (url === '/api/dashboards/interpolate') { + return Promise.resolve({ + title: 'AWS ElastiCache Redis', + uid: '', + panels: [], + schemaVersion: 40, + }); + } + return Promise.reject(new Error('Not found')); + }), + } as unknown as BackendSrv); + + const manager = new UnifiedDashboardScenePageStateManager({}); + expect(manager['activeManager']).toBeInstanceOf(DashboardScenePageStateManagerV2); + + await manager.loadDashboard({ uid: '', route: DashboardRoutes.Template }); + + // Should switch to V1 manager for template dashboards + expect(manager['activeManager']).toBeInstanceOf(DashboardScenePageStateManager); + }); + + it('should reset to V2 manager when loading a new dashboard after template', async () => { + config.featureToggles.dashboardNewLayouts = true; + config.featureToggles.suggestedDashboards = true; + + // Mock locationService for this test too + locationService.getLocation = jest.fn().mockReturnValue({ + pathname: '/dashboard/template', + search: '?gnetId=969&datasource=xpyRJd9Mz&mappings=%5B%5D', + }); + + // Mock the backend for template load + setBackendSrv({ + get: jest.fn((url: string) => { + if (url.includes('/api/gnet/dashboards/')) { + return Promise.resolve({ + json: { + title: 'Template Dashboard', + uid: '', + panels: [], + schemaVersion: 40, + }, + }); + } + return Promise.reject(new Error('Not found')); + }), + post: jest.fn((url: string) => { + if (url === '/api/dashboards/interpolate') { + return Promise.resolve({ + title: 'Template Dashboard', + uid: '', + panels: [], + schemaVersion: 40, + }); + } + return Promise.reject(new Error('Not found')); + }), + } as unknown as BackendSrv); + + const manager = new UnifiedDashboardScenePageStateManager({}); + + // Load template - forces V1 + await manager.loadDashboard({ uid: '', route: DashboardRoutes.Template }); + expect(manager['activeManager']).toBeInstanceOf(DashboardScenePageStateManager); + + // Load new dashboard - should reset to V2 based on shouldForceV2API() + await manager.loadDashboard({ uid: '', route: DashboardRoutes.New }); + // Should be back to V2 manager + expect(manager['activeManager']).toBeInstanceOf(DashboardScenePageStateManagerV2); + }); + }); }); const customHomeDashboardV1Spec = { diff --git a/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.ts b/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.ts index 3a1841e6b32..3cc0df33e8a 100644 --- a/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.ts +++ b/public/app/features/dashboard-scene/pages/DashboardScenePageStateManager.ts @@ -1082,6 +1082,12 @@ export class UnifiedDashboardScenePageStateManager extends DashboardScenePageSta const newDashboardVersion = shouldForceV2API() ? 'v2' : 'v1'; this.setActiveManager(newDashboardVersion); } + + // Template dashboards are currently in v1 schema format. + if (options.route === DashboardRoutes.Template) { + this.setActiveManager('v1'); + } + return this.withVersionHandling((manager) => manager.loadDashboard.call(this, options)); }