Add panel options migration for editor mode

src/migration.test.ts

@@ -0,0 +1,29 @@
+import { EditorMode } from './constants';
+import { getMigratedOptions } from './migration';
+import { PanelOptions } from './types';
+
+describe('Migrations', () => {
+  it('Should return panel options', () => {
+    const options: Partial<PanelOptions> = {
+      editorMode: EditorMode.VISUAL,
+    };
+
+    expect(
+      getMigratedOptions({
+        options: options,
+      } as any)
+    ).toEqual(options);
+  });
+
+  describe('5.2.0', () => {
+    it('Should set code to editor mode if not defined', () => {
+      expect(
+        getMigratedOptions({
+          options: {},
+        } as any)
+      ).toEqual({
+        editorMode: EditorMode.CODE,
+      });
+    });
+  });
+});

src/migration.ts

@@ -0,0 +1,32 @@
+import { PanelModel } from '@grafana/data';
+
+import { EditorMode } from './constants';
+import { PanelOptions } from './types';
+
+/**
+ * Outdated Panel Options
+ */
+interface OutdatedPanelOptions extends Omit<PanelOptions, 'editorMode'> {
+  /**
+   * Editor Mode introduced in 5.2.0
+   */
+  editorMode?: EditorMode;
+}
+
+/**
+ * Get Migrated Options
+ *
+ * @param panel
+ */
+export const getMigratedOptions = (panel: PanelModel<OutdatedPanelOptions>): PanelOptions => {
+  const { ...options } = panel.options;
+
+  /**
+   * Set code editor mode if not defined
+   */
+  if (!options.editorMode) {
+    options.editorMode = EditorMode.CODE;
+  }
+
+  return options;
+};

src/module.ts

@@ -13,13 +13,15 @@ import {
   Theme,
   THEME_OPTIONS,
 } from './constants';
+import { getMigratedOptions } from './migration';
 import { PanelOptions } from './types';
 
 /**
  * Panel Plugin
  */
 export const plugin = new PanelPlugin<PanelOptions>(EchartsPanel)
   .setNoPadding()
+  .setMigrationHandler(getMigratedOptions)
   .setPanelOptions((builder) => {
     const isCodeEditor = (config: PanelOptions) => config.editorMode !== EditorMode.VISUAL;
     const isVisualEditor = (config: PanelOptions) => config.editorMode === EditorMode.VISUAL;