Create Plugin: Add docker-compose migration for extending from .config

.gitignore

@@ -46,4 +46,5 @@ playwright/.auth
 
 # Used in CI to pass built packages to the next job
 packed-artifacts/
-.mise.toml
+.mise.toml
+.cursor/

packages/create-plugin/package.json

@@ -41,7 +41,8 @@
     "minimist": "^1.2.8",
     "semver": "^7.3.5",
     "title-case": "^4.3.0",
-    "which": "^5.0.0"
+    "which": "^5.0.0",
+    "yaml": "^2.7.0"
   },
   "devDependencies": {
     "@types/glob": "^8.1.0",

packages/create-plugin/src/migrations/scripts/001-update-grafana-compose-extend.test.ts

@@ -0,0 +1,122 @@
+import { describe, it, expect } from 'vitest';
+import { createDefaultContext } from '../test-utils.js';
+import migrate from './001-update-grafana-compose-extend.js';
+import { parse, stringify } from 'yaml';
+
+describe('001-update-grafana-compose-extend', () => {
+  it('should not modify anything if docker-compose.yaml does not exist', async () => {
+    const context = createDefaultContext();
+    const initialChanges = context.listChanges();
+    await migrate(context);
+    expect(context.listChanges()).toEqual(initialChanges);
+  });
+
+  it('should not modify if grafana service with correct build context is missing', async () => {
+    const context = createDefaultContext();
+    context.addFile(
+      './docker-compose.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: './wrong-path',
+            },
+          },
+        },
+      })
+    );
+    const initialChanges = context.listChanges();
+    await migrate(context);
+    expect(context.listChanges()).toEqual(initialChanges);
+  });
+
+  it('should not modify if base compose file is missing', async () => {
+    const context = createDefaultContext();
+    context.addFile(
+      './docker-compose.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: './.config',
+            },
+          },
+        },
+      })
+    );
+    const initialChanges = context.listChanges();
+    await migrate(context);
+    expect(context.listChanges()).toEqual(initialChanges);
+  });
+
+  it('should update compose file and preserve build args', async () => {
+    const context = createDefaultContext();
+    context.addFile(
+      './docker-compose.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: './.config',
+              args: {
+                grafana_image: 'custom-image',
+                grafana_version: '10.0.0',
+                other_arg: 'value',
+              },
+            },
+          },
+        },
+      })
+    );
+    context.addFile(
+      './.config/docker-compose-base.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: '.',
+            },
+          },
+        },
+      })
+    );
+
+    await migrate(context);
+
+    const result = parse(context.getFile('./docker-compose.yaml') || '');
+    expect(result.services.grafana).toEqual({
+      extends: {
+        file: '.config/docker-compose-base.yaml',
+        service: 'grafana',
+      },
+      build: {
+        args: {
+          grafana_image: 'custom-image',
+          grafana_version: '10.0.0',
+        },
+      },
+    });
+  });
+
+  it('should be idempotent', async () => {
+    const context = createDefaultContext();
+    context.addFile(
+      './docker-compose.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: './.config',
+              args: {
+                grafana_image: 'custom-image',
+                grafana_version: '10.0.0',
+              },
+            },
+          },
+        },
+      })
+    );
+    context.addFile('./.config/docker-compose-base.yaml', 'exists');
+    await expect(migrate).toBeIdempotent(context);
+  });
+});

packages/create-plugin/src/migrations/scripts/001-update-grafana-compose-extend.ts

@@ -0,0 +1,57 @@
+import { type Context } from '../context.js';
+import { parse, stringify } from 'yaml';
+
+export default async function migrate(context: Context) {
+  // Check if docker-compose.yaml exists
+  if (!context.doesFileExist('./docker-compose.yaml')) {
+    return context;
+  }
+
+  // Read and parse the docker-compose file
+  const composeContent = context.getFile('./docker-compose.yaml');
+  if (!composeContent) {
+    return context;
+  }
+
+  const composeData = parse(composeContent);
+
+  // Check if grafana service exists with the specified build context
+  if (composeData?.services?.grafana?.build?.context !== './.config') {
+    return context;
+  }
+
+  // Check if base compose file exists
+  if (!context.doesFileExist('./.config/docker-compose-base.yaml')) {
+    return context;
+  }
+
+  // Preserve build args if they exist
+  const existingBuildArgs = composeData.services.grafana.build.args;
+  const preservedArgs: Record<string, string> = {};
+  if (existingBuildArgs?.grafana_image || existingBuildArgs?.grafana_version) {
+    if (existingBuildArgs.grafana_image) {
+      preservedArgs['grafana_image'] = existingBuildArgs.grafana_image;
+    }
+    if (existingBuildArgs.grafana_version) {
+      preservedArgs['grafana_version'] = existingBuildArgs.grafana_version;
+    }
+  }
+
+  // Update the grafana service configuration
+  composeData.services.grafana = {
+    extends: {
+      file: '.config/docker-compose-base.yaml',
+      service: 'grafana',
+    },
+    ...(Object.keys(preservedArgs).length > 0 && {
+      build: {
+        args: preservedArgs,
+      },
+    }),
+  };
+
+  // Write the updated compose file
+  context.updateFile('./docker-compose.yaml', stringify(composeData, { lineWidth: 0 }));
+
+  return context;
+}