@grafana/create-plugin 5.17.0 → 5.18.0

package/src/utils/utils.templates.ts

@@ -2,10 +2,10 @@ import { lt as semverLt } from 'semver';
 import { glob } from 'glob';
 import path from 'node:path';
 import fs from 'node:fs';
-import createDebug from 'debug';
 import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
 import { normalizeId, renderHandlebarsTemplate } from './utils.handlebars.js';
 import { getPluginJson } from './utils.plugin.js';
+import { debug } from './utils.cli.js';
 import {
   TEMPLATE_PATHS,
   EXPORT_PATH_PREFIX,
@@ -23,7 +23,7 @@ import { getExportFileName } from '../utils/utils.files.js';
 import { getGrafanaRuntimeVersion, getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
 
-const debug = createDebug('create-plugin:templates');
+const templatesDebugger = debug.extend('templates');
 
 /**
  *
@@ -161,7 +161,7 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
     };
   }
 
-  debug('\nTemplate data:\n' + JSON.stringify(templateData, null, 2));
+  templatesDebugger('\nTemplate data:\n' + JSON.stringify(templateData, null, 2));
 
   return templateData;
 }

package/templates/common/.config/docker-compose-base.yaml

@@ -7,7 +7,7 @@ services:
       context: .
       args:
         grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
-        grafana_version: ${GRAFANA_VERSION:-11.5.1}
+        grafana_version: ${GRAFANA_VERSION:-11.5.2}
         development: ${DEVELOPMENT:-false}
         anonymous_auth_enabled: ${ANONYMOUS_AUTH_ENABLED:-true}
     ports:

package/templates/common/_package.json

@@ -72,10 +72,10 @@
   },
   "dependencies": {
     "@emotion/css": "11.10.6",
-    "@grafana/data": "^11.5.1",
-    "@grafana/runtime": "^11.5.1",
-    "@grafana/ui": "^11.5.1",
-    "@grafana/schema": "^11.5.1",{{#if_eq pluginType "scenesapp"}}
+    "@grafana/data": "^11.5.2",
+    "@grafana/runtime": "^11.5.2",
+    "@grafana/ui": "^11.5.2",
+    "@grafana/schema": "^11.5.2",{{#if_eq pluginType "scenesapp"}}
     "@grafana/scenes": "^5.41.3",{{/if_eq}}
     "react": "18.2.0",
     "react-dom": "18.2.0"{{#if isAppType}},

package/tsconfig.json

@@ -5,5 +5,5 @@
   },
   "exclude": ["node_modules", "templates"],
   "extends": "../../tsconfig.base.json",
-  "include": ["src"]
+  "include": ["src", "vitest.d.ts"]
 }

package/vitest.config.ts

@@ -7,6 +7,7 @@ export default mergeConfig(
   defineProject({
     test: {
       root: resolve(__dirname),
+      setupFiles: ['./vitest.setup.ts'],
     },
   })
 );

package/vitest.d.ts

@@ -0,0 +1,11 @@
+import 'vitest';
+import { Context } from './src/migrations/context';
+
+interface CustomMatchers<R = unknown> {
+  toBeIdempotent(context: Context): Promise<void>;
+}
+
+declare module 'vitest' {
+  interface Assertion<T = any> extends CustomMatchers<T> {}
+  interface AsymmetricMatchersContaining extends CustomMatchers {}
+}

package/vitest.setup.ts

@@ -0,0 +1,53 @@
+import { expect } from 'vitest';
+import type { Context } from './src/migrations/context';
+import { inspect } from 'node:util';
+
+type ClonedContext = {
+  files: Record<string, { content: string; changeType: 'add' | 'update' | 'delete' }>;
+};
+
+async function compareContexts(firstRun: ClonedContext, secondRun: ClonedContext) {
+  for (const file of Object.keys(firstRun.files)) {
+    const firstRunContent = firstRun.files[file].content;
+    const secondRunContent = secondRun.files[file].content;
+    if (firstRunContent !== secondRunContent) {
+      return {
+        pass: false,
+        file,
+        firstRunContent,
+        secondRunContent,
+      };
+    }
+  }
+
+  return { pass: true };
+}
+
+const parseContent = (content?: string) => (content ? JSON.parse(content) : '');
+
+expect.extend({
+  async toBeIdempotent(migrate: (context: Context) => Promise<Context>, context: Context) {
+    const firstRun = await migrate(context);
+    const firstRunDeepCopy = structuredClone(firstRun) as unknown as ClonedContext;
+
+    const secondRun = await migrate(firstRun);
+    const secondRunDeepCopy = structuredClone(secondRun) as unknown as ClonedContext;
+
+    const result = await compareContexts(firstRunDeepCopy, secondRunDeepCopy);
+
+    if (result.pass) {
+      return {
+        pass: true,
+        message: () => 'Expected migration not to be idempotent',
+      };
+    }
+
+    return {
+      pass: false,
+      message: () =>
+        `Migration is not idempotent. File ${result.file} changed on second run.\n` +
+        `First run content: ${inspect(parseContent(result.firstRunContent), { colors: true })}\n` +
+        `Second run content: ${inspect(parseContent(result.secondRunContent), { colors: true })}`,
+    };
+  },
+});