138 lines
4.7 KiB
TypeScript
138 lines
4.7 KiB
TypeScript
import { AppEvents } from '@grafana/data';
|
|
import { SceneQueryRunner, VizPanel } from '@grafana/scenes';
|
|
import appEvents from 'app/core/app_events';
|
|
import { KioskMode } from 'app/types';
|
|
|
|
import { getCloneKey } from '../utils/clone';
|
|
|
|
import { DashboardScene } from './DashboardScene';
|
|
import { DashboardGridItem } from './layout-default/DashboardGridItem';
|
|
import { DefaultGridLayoutManager } from './layout-default/DefaultGridLayoutManager';
|
|
import { DashboardRepeatsProcessedEvent } from './types/DashboardRepeatsProcessedEvent';
|
|
|
|
describe('DashboardSceneUrlSync', () => {
|
|
describe('Given a standard scene', () => {
|
|
it('Should set inspectPanelKey when url has inspect key', () => {
|
|
const scene = buildTestScene();
|
|
scene.urlSync?.updateFromUrl({ inspect: '2' });
|
|
expect(scene.state.inspectPanelKey).toBe('2');
|
|
});
|
|
|
|
it('Should handle inspect key that is not found', () => {
|
|
const scene = buildTestScene();
|
|
scene.urlSync?.updateFromUrl({ inspect: '12321' });
|
|
expect(scene.state.inspectPanelKey).toBe(undefined);
|
|
});
|
|
|
|
it('Should set viewPanelKey when url has viewPanel', () => {
|
|
const scene = buildTestScene();
|
|
scene.urlSync?.updateFromUrl({ viewPanel: '2' });
|
|
expect(scene.state.viewPanelScene!.getUrlKey()).toBe('panel-2');
|
|
});
|
|
|
|
it('Should set UNSAFE_fitPanels when url has autofitpanels', () => {
|
|
const scene = buildTestScene();
|
|
scene.urlSync?.updateFromUrl({ autofitpanels: '' });
|
|
const layout = scene.state.body as DefaultGridLayoutManager;
|
|
|
|
expect(layout.state.grid.state.UNSAFE_fitPanels).toBe(true);
|
|
});
|
|
|
|
it('Should get the autofitpanels from the scene state', () => {
|
|
const scene = buildTestScene();
|
|
|
|
expect(scene.urlSync?.getUrlState().autofitpanels).toBeUndefined();
|
|
const layout = scene.state.body as DefaultGridLayoutManager;
|
|
layout.state.grid.setState({ UNSAFE_fitPanels: true });
|
|
expect(scene.urlSync?.getUrlState().autofitpanels).toBe('true');
|
|
});
|
|
|
|
it('Should set kiosk mode when url has kiosk', () => {
|
|
const scene = buildTestScene();
|
|
|
|
scene.urlSync?.updateFromUrl({ kiosk: 'invalid' });
|
|
expect(scene.state.kioskMode).toBe(undefined);
|
|
scene.urlSync?.updateFromUrl({ kiosk: '' });
|
|
expect(scene.state.kioskMode).toBe(KioskMode.Full);
|
|
scene.urlSync?.updateFromUrl({ kiosk: 'true' });
|
|
expect(scene.state.kioskMode).toBe(KioskMode.Full);
|
|
});
|
|
|
|
it('Should get the kiosk mode from the scene state', () => {
|
|
const scene = buildTestScene();
|
|
|
|
expect(scene.urlSync?.getUrlState().kiosk).toBe(undefined);
|
|
scene.setState({ kioskMode: KioskMode.Full });
|
|
expect(scene.urlSync?.getUrlState().kiosk).toBe('');
|
|
});
|
|
});
|
|
|
|
describe('entering edit mode', () => {
|
|
it('it should be possible to go from the view panel view to the edit view when the dashboard is not in edit mdoe', () => {
|
|
const scene = buildTestScene();
|
|
scene.setState({ isEditing: false });
|
|
scene.urlSync?.updateFromUrl({ viewPanel: 'panel-1' });
|
|
expect(scene.state.viewPanelScene).toBeDefined();
|
|
scene.urlSync?.updateFromUrl({ editPanel: 'panel-1' });
|
|
expect(scene.state.editPanel).toBeDefined();
|
|
});
|
|
});
|
|
|
|
describe('Given a viewPanelKey with clone that is not found', () => {
|
|
const scene = buildTestScene();
|
|
|
|
let errorNotice = 0;
|
|
appEvents.on(AppEvents.alertError, (evt) => errorNotice++);
|
|
|
|
scene.urlSync?.updateFromUrl({ viewPanel: getCloneKey('panel-1', 1) });
|
|
|
|
expect(scene.state.viewPanelScene).toBeUndefined();
|
|
// Verify no error notice was shown
|
|
expect(errorNotice).toBe(0);
|
|
|
|
// fake adding clone panel
|
|
const layout = scene.state.body as DefaultGridLayoutManager;
|
|
|
|
layout.state.grid.setState({
|
|
children: [
|
|
new DashboardGridItem({
|
|
key: 'griditem-1',
|
|
x: 0,
|
|
body: new VizPanel({
|
|
title: 'Clone Panel A',
|
|
key: getCloneKey('panel-1', 1),
|
|
pluginId: 'table',
|
|
}),
|
|
}),
|
|
],
|
|
});
|
|
|
|
// Verify it subscribes to DashboardRepeatsProcessedEvent
|
|
scene.publishEvent(new DashboardRepeatsProcessedEvent({ source: scene }));
|
|
expect(scene.state.viewPanelScene?.getUrlKey()).toBe(getCloneKey('panel-1', 1));
|
|
});
|
|
});
|
|
|
|
function buildTestScene() {
|
|
const scene = new DashboardScene({
|
|
title: 'hello',
|
|
uid: 'dash-1',
|
|
body: DefaultGridLayoutManager.fromVizPanels([
|
|
new VizPanel({
|
|
title: 'Panel A',
|
|
key: 'panel-1',
|
|
pluginId: 'table',
|
|
$data: new SceneQueryRunner({ key: 'data-query-runner', queries: [{ refId: 'A' }] }),
|
|
}),
|
|
|
|
new VizPanel({
|
|
title: 'Panel B',
|
|
key: 'panel-2',
|
|
pluginId: 'table',
|
|
}),
|
|
]),
|
|
});
|
|
|
|
return scene;
|
|
}
|