IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Deprecation: Create explicit feature toggle to auto-migrate from graph panel (#79369)

Browse Source
This commit is contained in:
Nathan Marrs 2024-02-08 15:00:48 -07:00 committed by GitHub
parent ce57166c9a
commit 829672759c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 100 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
devenv/dev-dashboards/migrations/migrations.json
View File

@ -21,7 +21,31 @@
"links": [
{
"asDropdown": false,
"icon": "dashboard",
"icon": "external link",
"includeVars": false,
"keepTime": false,
"tags": [],
"targetBlank": true,
"title": "Auto migrate graph panel (TRUE)",
"tooltip": "",
"type": "link",
"url": " /d/cdd412c4/?__feature.autoMigrateGraphPanel=true"
},
{
"asDropdown": false,
"icon": "external link",
"includeVars": false,
"keepTime": false,
"tags": [],
"targetBlank": true,
"title": "Auto migrate graph panel (FALSE)",
"tooltip": "",
"type": "link",
"url": " /d/cdd412c4/?__feature.autoMigrateGraphPanel=false"
},
{
"asDropdown": false,
"icon": "external link",
"includeVars": false,
"keepTime": false,
"tags": [],
@ -45,7 +69,7 @@
},
{
"asDropdown": false,
"icon": "dashboard",
"icon": "external link",
"includeVars": false,
"keepTime": false,
"tags": [],
@ -198,7 +222,7 @@
"sort": 0,
"value_type": "individual"
},
"type": "timeseries",
"type": "graph",
"xaxis": {
"mode": "time",
"show": true,

1
docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md
View File

@ -64,6 +64,7 @@ Some features are enabled by default. You can disable these feature by setting t
| `panelTitleSearch` | Search for dashboards using panel title |
| `migrationLocking` | Lock database during migrations |
| `autoMigrateOldPanels` | Migrate old angular panels to supported versions (graph, table-old, worldmap, etc) |
| `autoMigrateGraphPanel` | Migrate old graph panel to supported time series panel - broken out from autoMigrateOldPanels to enable granular tracking |
| `disableAngular` | Dynamic flag to disable angular at runtime. The preferred method is to set `angular_support_enabled` to `false` in the [security] settings, which allows you to change the state at runtime. |
| `newVizTooltips` | New visualizations tooltips UX |
| `grpcServer` | Run the GRPC server |

36
e2e/various-suite/graph-auto-migrate.spec.ts
View File

@ -1,18 +1,50 @@
import { e2e } from '../utils';
const DASHBOARD_ID = 'XMjIZPmik';
const DASHBOARD_NAME = 'Panel Tests - Graph Time Regions';
const UPLOT_MAIN_DIV_SELECTOR = '[data-testid="uplot-main-div"]';
describe('Auto-migrate graph panel', () => {
beforeEach(() => {
e2e.flows.login(Cypress.env('USERNAME'), Cypress.env('PASSWORD'));
});
it('Graph panel is migrated with `autoMigrateOldPanels` feature toggle', () => {
e2e.flows.openDashboard({ uid: DASHBOARD_ID });
cy.contains(DASHBOARD_NAME).should('be.visible');
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('not.exist');
e2e.flows.openDashboard({ uid: DASHBOARD_ID, queryParams: { '__feature.autoMigrateOldPanels': true } });
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('exist');
});
it('Graph panel is migrated with config `disableAngular` feature toggle', () => {
e2e.flows.openDashboard({ uid: DASHBOARD_ID });
cy.contains(DASHBOARD_NAME).should('be.visible');
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('not.exist');
e2e.flows.openDashboard({ uid: DASHBOARD_ID, queryParams: { '__feature.disableAngular': true } });
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('exist');
});
it('Graph panel is migrated with `autoMigrateGraphPanel` feature toggle', () => {
e2e.flows.openDashboard({ uid: DASHBOARD_ID });
cy.contains(DASHBOARD_NAME).should('be.visible');
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('not.exist');
e2e.flows.openDashboard({ uid: DASHBOARD_ID, queryParams: { '__feature.autoMigrateGraphPanel': true } });
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('exist');
});
it('Annotation markers exist for time regions', () => {
e2e.flows.openDashboard({ uid: DASHBOARD_ID });
cy.contains(DASHBOARD_NAME).should('be.visible');
cy.contains('uplot-main-div').should('not.exist');
cy.get(UPLOT_MAIN_DIV_SELECTOR).should('not.exist');
e2e.flows.openDashboard({ uid: DASHBOARD_ID, queryParams: { '__feature.autoMigrateOldPanels': true } });
e2e.flows.openDashboard({ uid: DASHBOARD_ID, queryParams: { '__feature.autoMigrateGraphPanel': true } });
e2e.components.Panels.Panel.title('Business Hours')
.should('exist')

1
packages/grafana-data/src/types/featureToggles.gen.ts
View File

@ -33,6 +33,7 @@ export interface FeatureToggles {
datasourceQueryMultiStatus?: boolean;
traceToMetrics?: boolean;
autoMigrateOldPanels?: boolean;
autoMigrateGraphPanel?: boolean;
disableAngular?: boolean;
canvasPanelNesting?: boolean;
newVizTooltips?: boolean;

8
pkg/services/featuremgmt/registry.go
View File

@ -134,6 +134,14 @@ var (
Owner: grafanaDatavizSquad,
Created: time.Date(2022, time.June, 11, 12, 0, 0, 0, time.UTC),
},
{
Name: "autoMigrateGraphPanel",
Description: "Migrate old graph panel to supported time series panel - broken out from autoMigrateOldPanels to enable granular tracking",
Stage: FeatureStagePublicPreview,
FrontendOnly: true,
Owner: grafanaDatavizSquad,
Created: time.Date(2023, time.December, 11, 7, 0, 0, 0, time.UTC),
},
{
Name: "disableAngular",
Description: "Dynamic flag to disable angular at runtime. The preferred method is to set `angular_support_enabled` to `false` in the [security] settings, which allows you to change the state at runtime.",

1
pkg/services/featuremgmt/toggles_gen.csv
View File

@ -14,6 +14,7 @@ exploreContentOutline,GA,@grafana/explore-squad,2023-11-03,false,false,true
datasourceQueryMultiStatus,experimental,@grafana/plugins-platform-backend,2022-05-03,false,false,false
traceToMetrics,experimental,@grafana/observability-traces-and-profiling,2022-03-07,false,false,true
autoMigrateOldPanels,preview,@grafana/dataviz-squad,2022-06-11,false,false,true
autoMigrateGraphPanel,preview,@grafana/dataviz-squad,2023-12-11,false,false,true
disableAngular,preview,@grafana/dataviz-squad,2023-03-23,false,false,true
canvasPanelNesting,experimental,@grafana/dataviz-squad,2022-05-31,false,false,true
newVizTooltips,preview,@grafana/dataviz-squad,2023-11-03,false,false,true

1 Name Stage Owner Created requiresDevMode RequiresRestart FrontendOnly
14 datasourceQueryMultiStatus experimental @grafana/plugins-platform-backend 2022-05-03 false false false
15 traceToMetrics experimental @grafana/observability-traces-and-profiling 2022-03-07 false false true
16 autoMigrateOldPanels preview @grafana/dataviz-squad 2022-06-11 false false true
17 autoMigrateGraphPanel preview @grafana/dataviz-squad 2023-12-11 false false true
18 disableAngular preview @grafana/dataviz-squad 2023-03-23 false false true
19 canvasPanelNesting experimental @grafana/dataviz-squad 2022-05-31 false false true
20 newVizTooltips preview @grafana/dataviz-squad 2023-11-03 false false true

4
pkg/services/featuremgmt/toggles_gen.go
View File

@ -67,6 +67,10 @@ const (
// Migrate old angular panels to supported versions (graph, table-old, worldmap, etc)
FlagAutoMigrateOldPanels = "autoMigrateOldPanels"
// FlagAutoMigrateGraphPanel
// Migrate old graph panel to supported time series panel - broken out from autoMigrateOldPanels to enable granular tracking
FlagAutoMigrateGraphPanel = "autoMigrateGraphPanel"
// FlagDisableAngular
// Dynamic flag to disable angular at runtime. The preferred method is to set `angular_support_enabled` to `false` in the [security] settings, which allows you to change the state at runtime.
FlagDisableAngular = "disableAngular"

23
public/app/features/dashboard/state/DashboardModel.ts
View File

@ -44,7 +44,7 @@ import { getTimeSrv } from '../services/TimeSrv';
import { mergePanels, PanelMergeInfo } from '../utils/panelMerge';
import { DashboardMigrator } from './DashboardMigrator';
import { PanelModel, autoMigrateAngular } from './PanelModel';
import { PanelModel, autoMigrateAngular, explicitlyControlledMigrationPanels } from './PanelModel';
import { TimeModel } from './TimeModel';
import { deleteScopeVars, isOnTheSameGridRow } from './utils';
@ -173,6 +173,12 @@ export class DashboardModel implements TimeModel {
if (options?.autoMigrateOldPanels || !config.angularSupportEnabled || config.featureToggles.autoMigrateOldPanels) {
for (const p of this.panelIterator()) {
const newType = autoMigrateAngular[p.type];
// Skip explicitly controlled panels
if (explicitlyControlledMigrationPanels.includes(p.type)) {
continue;
}
if (!p.autoMigrateFrom && newType) {
p.autoMigrateFrom = p.type;
p.type = newType;
@ -180,6 +186,21 @@ export class DashboardModel implements TimeModel {
}
}
// Explicit handling of graph -> time series migration (and eventually others)
if (
options?.autoMigrateOldPanels ||
!config.angularSupportEnabled ||
config.featureToggles.autoMigrateOldPanels ||
config.featureToggles.autoMigrateGraphPanel
) {
for (const p of this.panelIterator()) {
if (!p.autoMigrateFrom && p.type === 'graph') {
p.autoMigrateFrom = p.type;
p.type = 'timeseries';
}
}
}
this.addBuiltInAnnotationQuery();
this.sortPanelsByGridPos();
this.panelsAffectedByVariableChange = null;

2
public/app/features/dashboard/state/PanelModel.ts
View File

@ -130,6 +130,8 @@ const defaults: any = {
title: '',
};
export const explicitlyControlledMigrationPanels = ['graph'];
export const autoMigrateAngular: Record<string, string> = {
graph: 'timeseries',
'table-old': 'table',