public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Dynamic Dashboards: Added dynamic dashboard feature toggle info as prop to dashboards events (#110024)

Browse Source 
* Added dynamic dashboard feature toggle info as prop to dashboards events

* splitting out sharing interactions from dashboards one and fixing tests
This commit is contained in:
Yaelle Chaudy
2025-08-22 14:28:27 +02:00
committed by GitHub
parent 85f1f0d227
commit bf8979a7bf
4 changed files with 58 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/app/features/dashboard-scene/utils/interactions.ts
+33 -22
View File
@@ -1,4 +1,4 @@
import { reportInteraction } from '@grafana/runtime';
import { config, reportInteraction } from '@grafana/runtime';
let isScenesContextSet = false;
@@ -37,67 +37,67 @@ export const DashboardInteractions = {
// Sharing interactions:
sharingCategoryClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_category_clicked', properties);
reportSharingInteraction('sharing_category_clicked', properties);
},
shareLinkCopied: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_link_copy_clicked', properties);
reportSharingInteraction('sharing_link_copy_clicked', properties);
},
embedSnippetCopy: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_embed_copy_clicked', properties);
reportSharingInteraction('sharing_embed_copy_clicked', properties);
},
generatePanelImageClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_link_generate_image_clicked', properties);
reportSharingInteraction('sharing_link_generate_image_clicked', properties);
},
downloadPanelImageClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_link_download_image_clicked', properties);
reportSharingInteraction('sharing_link_download_image_clicked', properties);
},
publishSnapshotClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_snapshot_publish_clicked', properties);
reportSharingInteraction('sharing_snapshot_publish_clicked', properties);
},
publishSnapshotLocalClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_snapshot_local_clicked', properties);
reportSharingInteraction('sharing_snapshot_local_clicked', properties);
},
exportDownloadJsonClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_export_download_json_clicked', properties);
reportSharingInteraction('sharing_export_download_json_clicked', properties);
},
exportCopyJsonClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_export_copy_json_clicked', properties);
reportSharingInteraction('sharing_export_copy_json_clicked', properties);
},
exportSaveJsonClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_export_save_json_clicked', properties);
reportSharingInteraction('sharing_export_save_json_clicked', properties);
},
exportViewJsonClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_export_view_json_clicked', properties);
reportSharingInteraction('sharing_export_view_json_clicked', properties);
},
generatePublicDashboardUrlClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_generate_url_clicked', properties);
reportSharingInteraction('sharing_public_generate_url_clicked', properties);
},
revokePublicDashboardEmailClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_email_revoke_clicked', properties);
reportSharingInteraction('sharing_public_email_revoke_clicked', properties);
},
resendPublicDashboardEmailClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_email_resend_clicked', properties);
reportSharingInteraction('sharing_public_email_resend_clicked', properties);
},
publicDashboardEmailInviteClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_email_invite_clicked', properties);
reportSharingInteraction('sharing_public_email_invite_clicked', properties);
},
publicDashboardShareTypeChange: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_can_view_clicked', properties);
reportSharingInteraction('sharing_public_can_view_clicked', properties);
},
publicDashboardTimeSelectionChanged: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_time_picker_clicked', properties);
reportSharingInteraction('sharing_public_time_picker_clicked', properties);
},
publicDashboardAnnotationsSelectionChanged: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_annotations_clicked', properties);
reportSharingInteraction('sharing_public_annotations_clicked', properties);
},
publicDashboardUrlCopied: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_copy_url_clicked', properties);
reportSharingInteraction('sharing_public_copy_url_clicked', properties);
},
publicDashboardPauseSharingClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_pause_clicked', properties);
reportSharingInteraction('sharing_public_pause_clicked', properties);
},
revokePublicDashboardClicked: (properties?: Record<string, unknown>) => {
reportDashboardInteraction('sharing_public_revoke_clicked', properties);
reportSharingInteraction('sharing_public_revoke_clicked', properties);
},
// Empty dashboard state interactions:
@@ -136,6 +136,17 @@ export const DashboardInteractions = {
const reportDashboardInteraction: typeof reportInteraction = (name, properties) => {
const meta = isScenesContextSet ? { scenesView: true } : {};
const isDynamicDashboard = config.featureToggles?.dashboardNewLayouts ?? false;
if (properties) {
reportInteraction(`dashboards_${name}`, { ...properties, ...meta, isDynamicDashboard });
} else {
reportInteraction(`dashboards_${name}`, { isDynamicDashboard });
}
};
const reportSharingInteraction: typeof reportInteraction = (name, properties) => {
const meta = isScenesContextSet ? { scenesView: true } : {};
if (properties) {
reportInteraction(`dashboards_${name}`, { ...properties, ...meta });
public/app/features/dashboard/components/AddPanelButton/AddPanelMenu.test.tsx
+12 -3
View File
@@ -106,7 +106,10 @@ it('creates new visualization when clicked on menu item Visualization', () => {
fireEvent.click(screen.getByRole('menuitem', { name: 'Visualization' }));
});
expect(reportInteraction).toHaveBeenCalledWith('dashboards_toolbar_add_clicked', { item: 'add_visualization' });
expect(reportInteraction).toHaveBeenCalledWith('dashboards_toolbar_add_clicked', {
item: 'add_visualization',
isDynamicDashboard: false,
});
expect(locationService.partial).toHaveBeenCalled();
expect(onCreateNewPanel).toHaveBeenCalled();
});
@@ -118,7 +121,10 @@ it('creates new row when clicked on menu item Row', () => {
fireEvent.click(screen.getByRole('menuitem', { name: 'Row' }));
});
expect(reportInteraction).toHaveBeenCalledWith('dashboards_toolbar_add_clicked', { item: 'add_row' });
expect(reportInteraction).toHaveBeenCalledWith('dashboards_toolbar_add_clicked', {
item: 'add_row',
isDynamicDashboard: false,
});
expect(locationService.partial).not.toHaveBeenCalled();
expect(onCreateNewRow).toHaveBeenCalled();
});
@@ -130,7 +136,10 @@ it('adds a library panel when clicked on menu item Import from library', () => {
fireEvent.click(screen.getByRole('menuitem', { name: 'Import from library' }));
});
expect(reportInteraction).toHaveBeenCalledWith('dashboards_toolbar_add_clicked', { item: 'import_from_library' });
expect(reportInteraction).toHaveBeenCalledWith('dashboards_toolbar_add_clicked', {
item: 'import_from_library',
isDynamicDashboard: false,
});
expect(locationService.partial).not.toHaveBeenCalled();
expect(onAddLibraryPanel).toHaveBeenCalled();
});
public/app/features/dashboard/dashgrid/DashboardEmpty.test.tsx
+12 -3
View File
@@ -71,7 +71,10 @@ it('creates new visualization when clicked Add visualization', () => {
fireEvent.click(screen.getByRole('button', { name: 'Add visualization' }));
});
expect(reportInteraction).toHaveBeenCalledWith('dashboards_emptydashboard_clicked', { item: 'add_visualization' });
expect(reportInteraction).toHaveBeenCalledWith('dashboards_emptydashboard_clicked', {
item: 'add_visualization',
isDynamicDashboard: false,
});
expect(locationService.partial).toHaveBeenCalled();
expect(locationService.partial).toHaveBeenCalledWith({ editPanel: undefined, firstPanel: true });
expect(onCreateNewPanel).toHaveBeenCalled();
@@ -84,7 +87,10 @@ it('open import dashboard when clicked Import dashboard', () => {
fireEvent.click(screen.getByRole('button', { name: 'Import dashboard' }));
});
expect(reportInteraction).toHaveBeenCalledWith('dashboards_emptydashboard_clicked', { item: 'import_dashboard' });
expect(reportInteraction).toHaveBeenCalledWith('dashboards_emptydashboard_clicked', {
item: 'import_dashboard',
isDynamicDashboard: false,
});
expect(onImportDashboard).toHaveBeenCalled();
});
@@ -95,7 +101,10 @@ it('adds a library panel when clicked Add library panel', () => {
fireEvent.click(screen.getByRole('button', { name: 'Add library panel' }));
});
expect(reportInteraction).toHaveBeenCalledWith('dashboards_emptydashboard_clicked', { item: 'import_from_library' });
expect(reportInteraction).toHaveBeenCalledWith('dashboards_emptydashboard_clicked', {
item: 'import_from_library',
isDynamicDashboard: false,
});
expect(locationService.partial).not.toHaveBeenCalled();
expect(onAddLibraryPanel).toHaveBeenCalled();
});
public/app/features/dashboard/utils/tracking.test.ts
+1
View File
@@ -38,6 +38,7 @@ describe('trackDashboardLoaded', () => {
expect(reportInteractionSpy).toHaveBeenCalledWith('dashboards_init_dashboard_completed', {
duration: 200,
isScene: false,
isDynamicDashboard: false,
uid: 'dashboard-123',
title: 'Test Dashboard',
schemaVersion: model.schemaVersion, // This value is based on public/app/features/dashboard/state/DashboardMigrator.ts#L81