Schema: Clean up / correct panel schema (grafana#76346)

* Schema: Clean up / correct panel schema * fixes
Nortech-ai · Oct 11, 2023 · 72a1de8 · 72a1de8
1 parent bcf850f
commit 72a1de8
Show file tree

Hide file tree

Showing 16 changed files with 93 additions and 114 deletions.
diff --git a/docs/sources/developers/kinds/core/dashboard/schema-reference.md b/docs/sources/developers/kinds/core/dashboard/schema-reference.md
diff --git a/kinds/dashboard/dashboard_kind.cue b/kinds/dashboard/dashboard_kind.cue
@@ -42,11 +42,11 @@ lineage: schemas: [{
 			timezone?: string | *"browser"
 
 			// Whether a dashboard is editable or not.
-			editable: bool | *true
+			editable?: bool | *true
 
 			// Configuration of dashboard cursor sync behavior.
 			// Accepted values are 0 (sync turned off), 1 (shared crosshair), 2 (shared crosshair and tooltip).
-			graphTooltip: #DashboardCursorSync
+			graphTooltip?: #DashboardCursorSync
 
 			// Time range for dashboard.
 			// Accepted values are relative time strings like {from: 'now-6h', to: 'now'} or absolute time strings like {from: '2020-07-10T08:00:00.000Z', to: '2020-07-10T14:00:00.000Z'}.
@@ -515,7 +515,7 @@ lineage: schemas: [{
 			description?: string
 
 			// Whether to display the panel without a background.
-			transparent: bool | *false
+			transparent?: bool | *false
 
 			// The datasource used in all targets.
 			datasource?: #DataSourceRef
@@ -543,7 +543,7 @@ lineage: schemas: [{
 			// List of transformations that are applied to the panel data before rendering.
 			// When there are multiple transformations, Grafana applies them in the order they are listed.
 			// Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.
-			transformations: [...#DataTransformerConfig]
+			transformations?: [...#DataTransformerConfig]
 
 			// The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.
 			// This value must be formatted as a number followed by a valid time
@@ -574,10 +574,10 @@ lineage: schemas: [{
 			libraryPanel?: #LibraryPanelRef
 
 			// It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.
-			options: {...} @grafanamaturity(NeedsExpertReview)
+			options?: {...} @grafanamaturity(NeedsExpertReview)
 
 			// Field options allow you to change how the data is displayed in your visualizations.
-			fieldConfig: #FieldConfigSource
+			fieldConfig?: #FieldConfigSource
 		} @cuetsy(kind="interface") @grafana(TSVeneer="type") @grafanamaturity(NeedsExpertReview)
 
 		// The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.

diff --git a/packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts b/packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts
@@ -644,7 +644,7 @@ export interface Panel {
   /**
    * Field options allow you to change how the data is displayed in your visualizations.
    */
-  fieldConfig: FieldConfigSource;
+  fieldConfig?: FieldConfigSource;
   /**
    * Grid position.
    */
@@ -684,7 +684,7 @@ export interface Panel {
   /**
    * It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.
    */
-  options: Record<string, unknown>;
+  options?: Record<string, unknown>;
   /**
    * The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.
    */
@@ -733,11 +733,11 @@ export interface Panel {
    * When there are multiple transformations, Grafana applies them in the order they are listed.
    * Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.
    */
-  transformations: Array<DataTransformerConfig>;
+  transformations?: Array<DataTransformerConfig>;
   /**
    * Whether to display the panel without a background.
    */
-  transparent: boolean;
+  transparent?: boolean;
   /**
    * The panel plugin type id. This is used to find the plugin to display the panel.
    */
@@ -991,7 +991,7 @@ export interface Dashboard {
   /**
    * Whether a dashboard is editable or not.
    */
-  editable: boolean;
+  editable?: boolean;
   /**
    * The month that the fiscal year starts on.  0 = January, 11 = December
    */
@@ -1004,7 +1004,7 @@ export interface Dashboard {
    * Configuration of dashboard cursor sync behavior.
    * Accepted values are 0 (sync turned off), 1 (shared crosshair), 2 (shared crosshair and tooltip).
    */
-  graphTooltip: DashboardCursorSync;
+  graphTooltip?: DashboardCursorSync;
   /**
    * Unique numeric identifier for the dashboard.
    * `id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances.

diff --git a/packages/grafana-schema/src/veneer/dashboard.types.ts b/packages/grafana-schema/src/veneer/dashboard.types.ts
@@ -7,7 +7,7 @@ export type { CommonDataSourceRef as DataSourceRef };
 
 export interface Panel<TOptions = Record<string, unknown>, TCustomFieldConfig = Record<string, unknown>>
   extends Omit<raw.Panel, 'fieldConfig'> {
-  fieldConfig: FieldConfigSource<TCustomFieldConfig>;
+  fieldConfig?: FieldConfigSource<TCustomFieldConfig>;
 }
 
 export interface RowPanel extends Omit<raw.RowPanel, 'panels'> {

diff --git a/pkg/kinds/dashboard/dashboard_spec_gen.go b/pkg/kinds/dashboard/dashboard_spec_gen.go
diff --git a/public/app/features/alerting/TestRuleResult.test.tsx b/public/app/features/alerting/TestRuleResult.test.tsx
@@ -2,7 +2,7 @@ import { render, screen } from '@testing-library/react';
 import React from 'react';
 
 import { PanelModel } from '../dashboard/state';
-import { createDashboardModelFixture, createPanelJSONFixture } from '../dashboard/state/__fixtures__/dashboardFixtures';
+import { createDashboardModelFixture, createPanelSaveModel } from '../dashboard/state/__fixtures__/dashboardFixtures';
 
 import { TestRuleResult } from './TestRuleResult';
 
@@ -22,7 +22,7 @@ jest.mock('@grafana/runtime', () => {
 const props: React.ComponentProps<typeof TestRuleResult> = {
   panel: new PanelModel({ id: 1 }),
   dashboard: createDashboardModelFixture({
-    panels: [createPanelJSONFixture({ id: 1 })],
+    panels: [createPanelSaveModel({ id: 1 })],
   }),
 };
 

diff --git a/public/app/features/dashboard-scene/serialization/transformSaveModelToScene.test.ts b/public/app/features/dashboard-scene/serialization/transformSaveModelToScene.test.ts
@@ -17,7 +17,7 @@ import {
 } from '@grafana/scenes';
 import { DashboardCursorSync, defaultDashboard, Panel, RowPanel, VariableType } from '@grafana/schema';
 import { DashboardModel, PanelModel } from 'app/features/dashboard/state';
-import { createPanelJSONFixture } from 'app/features/dashboard/state/__fixtures__/dashboardFixtures';
+import { createPanelSaveModel } from 'app/features/dashboard/state/__fixtures__/dashboardFixtures';
 import { SHARED_DASHBOARD_QUERY } from 'app/plugins/datasource/dashboard';
 import { DASHBOARD_DATASOURCE_PLUGIN_ID } from 'app/plugins/datasource/dashboard/types';
 
@@ -112,12 +112,12 @@ describe('transformSaveModelToScene', () => {
 
   describe('when organizing panels as scene children', () => {
     it('should create panels within collapsed rows', () => {
-      const panel = createPanelJSONFixture({
+      const panel = createPanelSaveModel({
         title: 'test',
         gridPos: { x: 1, y: 0, w: 12, h: 8 },
       }) as Panel;
 
-      const row = createPanelJSONFixture({
+      const row = createPanelSaveModel({
         title: 'test',
         type: 'row',
         gridPos: { x: 0, y: 0, w: 12, h: 1 },
@@ -146,7 +146,7 @@ describe('transformSaveModelToScene', () => {
     });
 
     it('should create panels within expanded row', () => {
-      const panelOutOfRow = createPanelJSONFixture({
+      const panelOutOfRow = createPanelSaveModel({
         title: 'Out of a row',
         gridPos: {
           h: 8,
@@ -155,7 +155,7 @@ describe('transformSaveModelToScene', () => {
           y: 0,
         },
       });
-      const rowWithPanel = createPanelJSONFixture({
+      const rowWithPanel = createPanelSaveModel({
         title: 'Row with panel',
         type: 'row',
         id: 10,
@@ -169,7 +169,7 @@ describe('transformSaveModelToScene', () => {
         // This panels array is not used if the row is not collapsed
         panels: [],
       });
-      const panelInRow = createPanelJSONFixture({
+      const panelInRow = createPanelSaveModel({
         gridPos: {
           h: 8,
           w: 12,
@@ -178,7 +178,7 @@ describe('transformSaveModelToScene', () => {
         },
         title: 'In row 1',
       });
-      const emptyRow = createPanelJSONFixture({
+      const emptyRow = createPanelSaveModel({
         collapsed: false,
         gridPos: {
           h: 1,

diff --git a/public/app/features/dashboard-scene/serialization/transformSceneToSaveModel.test.ts b/public/app/features/dashboard-scene/serialization/transformSceneToSaveModel.test.ts
@@ -374,7 +374,7 @@ describe('transformSceneToSaveModel', () => {
 
       const result = gridItemToPanel(panel);
 
-      expect(result.transformations.length).toBe(1);
+      expect(result.transformations?.length).toBe(1);
 
       expect(result.maxDataPoints).toBe(100);
       expect(result.targets?.length).toBe(2);
@@ -458,7 +458,7 @@ describe('transformSceneToSaveModel', () => {
 
       const result = gridItemToPanel(panel);
 
-      expect(result.transformations.length).toBe(1);
+      expect(result.transformations?.length).toBe(1);
 
       expect(result.targets?.length).toBe(1);
       expect(result.targets?.[0]).toEqual({

diff --git a/public/app/features/dashboard/components/DashboardPrompt/DashboardPrompt.test.tsx b/public/app/features/dashboard/components/DashboardPrompt/DashboardPrompt.test.tsx
@@ -2,14 +2,14 @@ import { getPanelPlugin } from '@grafana/data/test/__mocks__/pluginMocks';
 
 import { ContextSrv, setContextSrv } from '../../../../core/services/context_srv';
 import { PanelModel } from '../../state/PanelModel';
-import { createDashboardModelFixture, createPanelJSONFixture } from '../../state/__fixtures__/dashboardFixtures';
+import { createDashboardModelFixture, createPanelSaveModel } from '../../state/__fixtures__/dashboardFixtures';
 
 import { hasChanges, ignoreChanges } from './DashboardPrompt';
 
 function getDefaultDashboardModel() {
   return createDashboardModelFixture({
     panels: [
-      createPanelJSONFixture({
+      createPanelSaveModel({
         id: 1,
         type: 'graph',
         gridPos: { x: 0, y: 0, w: 24, h: 6 },

diff --git a/public/app/features/dashboard/components/GenAI/utils.test.ts b/public/app/features/dashboard/components/GenAI/utils.test.ts
@@ -1,4 +1,4 @@
-import { createDashboardModelFixture, createPanelJSONFixture } from '../../state/__fixtures__/dashboardFixtures';
+import { createDashboardModelFixture, createPanelSaveModel } from '../../state/__fixtures__/dashboardFixtures';
 
 import { openai } from './llms';
 import { getDashboardChanges, isLLMPluginEnabled, sanitizeReply } from './utils';
@@ -21,7 +21,7 @@ describe('getDashboardChanges', () => {
     const deprecatedVersion = 37;
     const dashboard = createDashboardModelFixture({
       schemaVersion: deprecatedVersion,
-      panels: [createPanelJSONFixture({ title: 'Panel 1', options: deprecatedOptions })],
+      panels: [createPanelSaveModel({ title: 'Panel 1', options: deprecatedOptions })],
     });
 
     // Update title for the first panel

diff --git a/public/app/features/dashboard/state/DashboardMigrator.test.ts b/public/app/features/dashboard/state/DashboardMigrator.test.ts
@@ -128,7 +128,6 @@ describe('DashboardModel', () => {
           {
             type: 'row',
             panels: [
-              // @ts-expect-error
               {
                 id: 501,
                 type: 'table',
@@ -845,7 +844,6 @@ describe('DashboardModel', () => {
               '# Angular Text Panel\n# $constant\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)\n\n## $text\n\n',
             mode: 'markdown',
           },
-          // @ts-expect-error
           {
             id: 3,
             type: 'text2',
@@ -856,7 +854,6 @@ describe('DashboardModel', () => {
                 '# React Text Panel from scratch\n# $constant\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)\n\n## $text',
             },
           },
-          // @ts-expect-error
           {
             id: 4,
             type: 'text2',
@@ -1594,7 +1591,6 @@ describe('DashboardModel', () => {
           ],
         },
         panels: [
-          // @ts-expect-error
           {
             gridPos: {
               h: 8,
@@ -1717,7 +1713,6 @@ describe('DashboardModel', () => {
               title: 'DynamoDB',
               type: 'row',
               panels: [
-                // @ts-expect-error
                 {
                   gridPos: {
                     h: 8,
@@ -1772,7 +1767,6 @@ describe('DashboardModel', () => {
                   title: 'Panel Title',
                   type: 'timeseries',
                 },
-                // @ts-expect-error
                 {
                   gridPos: {
                     h: 8,
@@ -1982,8 +1976,8 @@ describe('DashboardModel', () => {
   describe('when migrating time series axis visibility', () => {
     test('preserves x axis visibility', () => {
       const model = new DashboardModel({
+        schemaVersion: 25,
         panels: [
-          // @ts-expect-error
           {
             type: 'timeseries',
             fieldConfig: {
@@ -2204,7 +2198,6 @@ describe('when migrating table cell display mode to cell options', () => {
   beforeEach(() => {
     model = new DashboardModel({
       panels: [
-        // @ts-expect-error
         {
           id: 1,
           type: 'table',
@@ -2216,9 +2209,8 @@ describe('when migrating table cell display mode to cell options', () => {
                 inspect: false,
               },
             },
-          } as unknown as FieldConfigSource, // missing overrides
+          } as unknown as FieldConfigSource, // missing overrides on purpose
         },
-        // @ts-expect-error
         {
           id: 2,
           type: 'table',
@@ -2233,7 +2225,6 @@ describe('when migrating table cell display mode to cell options', () => {
             overrides: [],
           },
         },
-        // @ts-expect-error
         {
           id: 3,
           type: 'table',
@@ -2248,7 +2239,6 @@ describe('when migrating table cell display mode to cell options', () => {
             overrides: [],
           },
         },
-        // @ts-expect-error
         {
           id: 4,
           type: 'table',
@@ -2263,7 +2253,6 @@ describe('when migrating table cell display mode to cell options', () => {
             overrides: [],
           },
         },
-        // @ts-expect-error
         {
           id: 5,
           type: 'table',
@@ -2278,7 +2267,6 @@ describe('when migrating table cell display mode to cell options', () => {
             overrides: [],
           },
         },
-        // @ts-expect-error
         {
           id: 6,
           type: 'table',
@@ -2346,7 +2334,6 @@ describe('when migrating table cell display mode to cell options', () => {
             ],
           },
         },
-        // @ts-expect-error
         {
           id: 7,
           type: 'table',