create-forgeon 0.3.14 → 0.3.16

package/src/modules/files.mjs

@@ -13,6 +13,7 @@ import {
   ensureValidatorSchema,
   upsertEnvLines,
 } from './shared/patch-utils.mjs';
+import { ensureWebProbeDefinition, resolveProbeTargets } from './shared/probes.mjs';
 
 function copyFromPreset(packageRoot, targetRoot, relativePath) {
   const source = path.join(packageRoot, 'templates', 'module-presets', 'files', relativePath);
@@ -234,7 +235,11 @@ function patchApiDockerfile(targetRoot) {
   fs.writeFileSync(dockerfilePath, `${content.trimEnd()}\n`, 'utf8');
 }
 
-function patchHealthController(targetRoot) {
+function patchHealthController(targetRoot, probeTargets) {
+  if (!probeTargets.allowApi) {
+    return;
+  }
+
   const filePath = path.join(targetRoot, 'apps', 'api', 'src', 'health', 'health.controller.ts');
   if (!fs.existsSync(filePath)) {
     return;
@@ -303,107 +308,31 @@ function patchHealthController(targetRoot) {
   fs.writeFileSync(filePath, `${content.trimEnd()}\n`, 'utf8');
 }
 
-function patchWebApp(targetRoot) {
-  const filePath = path.join(targetRoot, 'apps', 'web', 'src', 'App.tsx');
-  if (!fs.existsSync(filePath)) {
-    return;
-  }
-
-  let content = fs.readFileSync(filePath, 'utf8').replace(/\r\n/g, '\n');
-  content = content
-    .replace(/^\s*\{\/\* forgeon:probes:actions:start \*\/\}\r?\n?/gm, '')
-    .replace(/^\s*\{\/\* forgeon:probes:actions:end \*\/\}\r?\n?/gm, '')
-    .replace(/^\s*\{\/\* forgeon:probes:results:start \*\/\}\r?\n?/gm, '')
-    .replace(/^\s*\{\/\* forgeon:probes:results:end \*\/\}\r?\n?/gm, '');
-
-  if (!content.includes('filesProbeResult')) {
-    const stateAnchors = [
-      '  const [dbProbeResult, setDbProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [authProbeResult, setAuthProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [validationProbeResult, setValidationProbeResult] = useState<ProbeResult | null>(null);',
-    ];
-    const stateAnchor = stateAnchors.find((line) => content.includes(line));
-    if (stateAnchor) {
-      content = ensureLineAfter(
-        content,
-        stateAnchor,
-        '  const [filesProbeResult, setFilesProbeResult] = useState<ProbeResult | null>(null);',
-      );
-    }
-  }
-
-  if (!content.includes('filesVariantsProbeResult')) {
-    const stateAnchors = [
-      '  const [filesProbeResult, setFilesProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [validationProbeResult, setValidationProbeResult] = useState<ProbeResult | null>(null);',
-    ];
-    const stateAnchor = stateAnchors.find((line) => content.includes(line));
-    if (stateAnchor) {
-      content = ensureLineAfter(
-        content,
-        stateAnchor,
-        '  const [filesVariantsProbeResult, setFilesVariantsProbeResult] = useState<ProbeResult | null>(null);',
-      );
-    }
-  }
-
-  if (!content.includes('Check files probe (create metadata)')) {
-    const probePath = content.includes("runProbe(setHealthResult, '/health')")
-      ? '/health/files'
-      : '/api/health/files';
-    const button = `        <button onClick={() => runProbe(setFilesProbeResult, '${probePath}', { method: 'POST' })}>\n          Check files probe (create metadata)\n        </button>`;
-
-    const actionsStart = content.indexOf('<div className="actions">');
-    if (actionsStart >= 0) {
-      const actionsEnd = content.indexOf('\n      </div>', actionsStart);
-      if (actionsEnd >= 0) {
-        content = `${content.slice(0, actionsEnd)}\n${button}${content.slice(actionsEnd)}`;
-      }
-    }
-  }
-
-  if (!content.includes("{renderResult('Files probe response', filesProbeResult)}")) {
-    const resultLine = "      {renderResult('Files probe response', filesProbeResult)}";
-    const networkLine = '      {networkError ? <p className="error">{networkError}</p> : null}';
-    if (content.includes(networkLine)) {
-      content = content.replace(networkLine, `${resultLine}\n${networkLine}`);
-    } else {
-      const anchor = "{renderResult('Validation probe response', validationProbeResult)}";
-      if (content.includes(anchor)) {
-        content = ensureLineAfter(content, anchor, resultLine);
-      }
-    }
-  }
-
-  if (!content.includes('Check files variants capability')) {
-    const probePath = content.includes("runProbe(setHealthResult, '/health')")
-      ? '/health/files-variants'
-      : '/api/health/files-variants';
-    const button = `        <button onClick={() => runProbe(setFilesVariantsProbeResult, '${probePath}')}>\n          Check files variants capability\n        </button>`;
-
-    const actionsStart = content.indexOf('<div className="actions">');
-    if (actionsStart >= 0) {
-      const actionsEnd = content.indexOf('\n      </div>', actionsStart);
-      if (actionsEnd >= 0) {
-        content = `${content.slice(0, actionsEnd)}\n${button}${content.slice(actionsEnd)}`;
-      }
-    }
-  }
-
-  if (!content.includes("{renderResult('Files variants probe response', filesVariantsProbeResult)}")) {
-    const resultLine = "      {renderResult('Files variants probe response', filesVariantsProbeResult)}";
-    const networkLine = '      {networkError ? <p className="error">{networkError}</p> : null}';
-    if (content.includes(networkLine)) {
-      content = content.replace(networkLine, `${resultLine}\n${networkLine}`);
-    } else {
-      const anchor = "{renderResult('Files probe response', filesProbeResult)}";
-      if (content.includes(anchor)) {
-        content = ensureLineAfter(content, anchor, resultLine);
-      }
-    }
-  }
-
-  fs.writeFileSync(filePath, `${content.trimEnd()}\n`, 'utf8');
+function registerWebProbe(targetRoot, probeTargets) {
+  ensureWebProbeDefinition({
+    targetRoot,
+    probeTargets,
+    definition: {
+      id: 'files',
+      title: 'Files',
+      buttonLabel: 'Check files probe (create metadata)',
+      resultTitle: 'Files probe response',
+      path: '/health/files',
+      request: { method: 'POST' },
+    },
+  });
+
+  ensureWebProbeDefinition({
+    targetRoot,
+    probeTargets,
+    definition: {
+      id: 'files-variants',
+      title: 'Files Variants',
+      buttonLabel: 'Check files variants capability',
+      resultTitle: 'Files variants probe response',
+      path: '/health/files-variants',
+    },
+  });
 }
 
 function patchCompose(targetRoot) {
@@ -499,13 +428,15 @@ Key env:
 
 export function applyFilesModule({ packageRoot, targetRoot }) {
   copyFromPreset(packageRoot, targetRoot, path.join('packages', 'files'));
+  const probeTargets = resolveProbeTargets({ targetRoot, moduleId: 'files' });
+
 
   patchApiPackage(targetRoot);
   patchPrismaSchema(targetRoot);
   patchPrismaMigration(packageRoot, targetRoot);
   patchAppModule(targetRoot);
-  patchHealthController(targetRoot);
-  patchWebApp(targetRoot);
+  patchHealthController(targetRoot, probeTargets);
+  registerWebProbe(targetRoot, probeTargets);
   patchApiDockerfile(targetRoot);
   patchCompose(targetRoot);
   patchReadme(targetRoot);

package/src/modules/i18n.mjs

@@ -13,6 +13,7 @@ import {
   ensureValidatorSchema,
   upsertEnvLines,
 } from './shared/patch-utils.mjs';
+import { ensureWebProbeDefinition, readManagedWebProbeDefinitions } from './shared/probes.mjs';
 
 function copyFromBase(packageRoot, targetRoot, relativePath) {
   const source = path.join(packageRoot, 'templates', 'base', relativePath);
@@ -39,10 +40,6 @@ function patchApiDockerfile(targetRoot) {
   }
 
   let content = fs.readFileSync(dockerfilePath, 'utf8').replace(/\r\n/g, '\n');
-  content = content.replace(
-    /^COPY package\.json pnpm-workspace\.yaml tsconfig\.base\.json \.\/$/m,
-    'COPY package.json pnpm-workspace.yaml tsconfig.base.json tsconfig.base.node.json tsconfig.base.esm.json ./',
-  );
 
   content = ensureLineAfter(
     content,
@@ -95,22 +92,6 @@ function patchProxyDockerfile(filePath) {
   }
 
   let content = fs.readFileSync(filePath, 'utf8').replace(/\r\n/g, '\n');
-
-  content = ensureLineAfter(
-    content,
-    'COPY package.json pnpm-workspace.yaml ./',
-    'COPY tsconfig.base.json ./',
-  );
-  content = ensureLineAfter(
-    content,
-    'COPY tsconfig.base.json ./',
-    'COPY tsconfig.base.node.json ./',
-  );
-  content = ensureLineAfter(
-    content,
-    'COPY tsconfig.base.node.json ./',
-    'COPY tsconfig.base.esm.json ./',
-  );
   content = ensureLineAfter(
     content,
     'COPY apps/web/package.json apps/web/package.json',
@@ -449,118 +430,32 @@ Module env:
   fs.writeFileSync(readmePath, `${content.trimEnd()}\n`, 'utf8');
 }
 
-function restoreKnownWebProbes(targetRoot, previousAppContent) {
-  if (!previousAppContent) {
+function restoreManagedWebProbes(targetRoot, definitions) {
+  if (!Array.isArray(definitions) || definitions.length === 0) {
     return;
   }
 
-  const filePath = path.join(targetRoot, 'apps', 'web', 'src', 'App.tsx');
-  if (!fs.existsSync(filePath)) {
+  const probesFilePath = path.join(targetRoot, 'apps', 'web', 'src', 'probes.ts');
+  if (!fs.existsSync(probesFilePath)) {
     return;
   }
 
-  let content = fs.readFileSync(filePath, 'utf8').replace(/\r\n/g, '\n');
-
-  const ensureProbeState = (stateLine) => {
-    if (content.includes(stateLine)) {
-      return;
-    }
-    const anchors = [
-      '  const [rbacProbeResult, setRbacProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [rateLimitProbeResult, setRateLimitProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [authProbeResult, setAuthProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [dbProbeResult, setDbProbeResult] = useState<ProbeResult | null>(null);',
-      '  const [validationProbeResult, setValidationProbeResult] = useState<ProbeResult | null>(null);',
-    ];
-    const anchor = anchors.find((line) => content.includes(line));
-    if (anchor) {
-      content = ensureLineAfter(content, anchor, stateLine);
-    }
-  };
-
-  const ensureProbeButton = (buttonText, buttonCode) => {
-    if (content.includes(buttonText)) {
-      return;
-    }
-    const actionsStart = content.indexOf('<div className="actions">');
-    if (actionsStart < 0) {
-      return;
-    }
-    const actionsEnd = content.indexOf('\n      </div>', actionsStart);
-    if (actionsEnd < 0) {
-      return;
-    }
-    content = `${content.slice(0, actionsEnd)}\n${buttonCode}${content.slice(actionsEnd)}`;
-  };
-
-  const ensureProbeResult = (resultLine) => {
-    if (content.includes(resultLine)) {
-      return;
-    }
-    const networkLine = '      {networkError ? <p className="error">{networkError}</p> : null}';
-    if (content.includes(networkLine)) {
-      content = content.replace(networkLine, `${resultLine}\n${networkLine}`);
-      return;
-    }
-    const anchors = [
-      "      {renderResult('RBAC probe response', rbacProbeResult)}",
-      "      {renderResult('Rate limit probe response', rateLimitProbeResult)}",
-      "      {renderResult('Auth probe response', authProbeResult)}",
-      "      {renderResult('DB probe response', dbProbeResult)}",
-      "      {renderResult('Validation probe response', validationProbeResult)}",
-    ];
-    const anchor = anchors.find((line) => content.includes(line));
-    if (anchor) {
-      content = ensureLineAfter(content, anchor, resultLine);
-    }
+  const probeTargets = {
+    allowWeb: true,
+    probesFilePath,
   };
 
-  if (previousAppContent.includes('Check database (create user)')) {
-    ensureProbeState('  const [dbProbeResult, setDbProbeResult] = useState<ProbeResult | null>(null);');
-    ensureProbeButton(
-      'Check database (create user)',
-      "        <button onClick={() => runProbe(setDbProbeResult, '/health/db', { method: 'POST' })}>\n          Check database (create user)\n        </button>",
-    );
-    ensureProbeResult("      {renderResult('DB probe response', dbProbeResult)}");
-  }
-
-  if (previousAppContent.includes('Check JWT auth probe')) {
-    ensureProbeState('  const [authProbeResult, setAuthProbeResult] = useState<ProbeResult | null>(null);');
-    ensureProbeButton(
-      'Check JWT auth probe',
-      "        <button onClick={() => runProbe(setAuthProbeResult, '/health/auth')}>Check JWT auth probe</button>",
-    );
-    ensureProbeResult("      {renderResult('Auth probe response', authProbeResult)}");
-  }
-
-  if (previousAppContent.includes('Check rate limit (click repeatedly)')) {
-    ensureProbeState(
-      '  const [rateLimitProbeResult, setRateLimitProbeResult] = useState<ProbeResult | null>(null);',
-    );
-    ensureProbeButton(
-      'Check rate limit (click repeatedly)',
-      "        <button onClick={() => runProbe(setRateLimitProbeResult, '/health/rate-limit')}>\n          Check rate limit (click repeatedly)\n        </button>",
-    );
-    ensureProbeResult("      {renderResult('Rate limit probe response', rateLimitProbeResult)}");
+  for (const definition of definitions) {
+    ensureWebProbeDefinition({
+      targetRoot,
+      probeTargets,
+      definition,
+    });
   }
-
-  if (previousAppContent.includes('Check RBAC access')) {
-    ensureProbeState('  const [rbacProbeResult, setRbacProbeResult] = useState<ProbeResult | null>(null);');
-    ensureProbeButton(
-      'Check RBAC access',
-      "        <button\n          onClick={() =>\n            runProbe(setRbacProbeResult, '/health/rbac', {\n              headers: { 'x-forgeon-permissions': 'health.rbac' },\n            })\n          }\n        >\n          Check RBAC access\n        </button>",
-    );
-    ensureProbeResult("      {renderResult('RBAC probe response', rbacProbeResult)}");
-  }
-
-  fs.writeFileSync(filePath, `${content.trimEnd()}\n`, 'utf8');
 }
 
 export function applyI18nModule({ packageRoot, targetRoot }) {
-  const existingWebAppPath = path.join(targetRoot, 'apps', 'web', 'src', 'App.tsx');
-  const previousAppContent = fs.existsSync(existingWebAppPath)
-    ? fs.readFileSync(existingWebAppPath, 'utf8')
-    : '';
+  const previousProbeDefinitions = readManagedWebProbeDefinitions(targetRoot);
 
   copyFromBase(packageRoot, targetRoot, path.join('scripts', 'i18n-add.mjs'));
   copyFromBase(packageRoot, targetRoot, path.join('packages', 'i18n'));
@@ -568,10 +463,11 @@ export function applyI18nModule({ packageRoot, targetRoot }) {
 
   copyFromPreset(packageRoot, targetRoot, path.join('packages', 'i18n-contracts'));
   copyFromPreset(packageRoot, targetRoot, path.join('packages', 'i18n-web'));
+  copyFromBase(packageRoot, targetRoot, path.join('apps', 'web', 'src', 'probes.ts'));
   copyFromPreset(packageRoot, targetRoot, path.join('apps', 'web', 'src', 'App.tsx'));
   copyFromPreset(packageRoot, targetRoot, path.join('apps', 'web', 'src', 'i18n.ts'));
   copyFromPreset(packageRoot, targetRoot, path.join('apps', 'web', 'src', 'main.tsx'));
-  restoreKnownWebProbes(targetRoot, previousAppContent);
+  restoreManagedWebProbes(targetRoot, previousProbeDefinitions);
 
   patchI18nPackage(targetRoot);
   patchApiPackage(targetRoot);

package/src/modules/idempotency.test.mjs

@@ -0,0 +1,174 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { addModule } from './executor.mjs';
+import { scaffoldProject } from '../core/scaffold.mjs';
+
+function makeTempDir(prefix) {
+  return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
+}
+
+function readFile(filePath) {
+  return fs.readFileSync(filePath, 'utf8');
+}
+
+function scaffoldBaseProject({ packageRoot, targetRoot, projectName, dbPrismaEnabled, proxy = 'caddy' }) {
+  const templateRoot = path.join(packageRoot, 'templates', 'base');
+  scaffoldProject({
+    templateRoot,
+    packageRoot,
+    targetRoot,
+    projectName,
+    frontend: 'react',
+    db: 'prisma',
+    dbPrismaEnabled,
+    i18nEnabled: false,
+    proxy,
+  });
+}
+
+function readProjectSnapshot(projectRoot) {
+  const snapshot = {};
+  const queue = [projectRoot];
+  const skipDirs = new Set(['node_modules', '.git', 'dist', 'build']);
+
+  while (queue.length > 0) {
+    const currentDir = queue.shift();
+    const entries = fs
+      .readdirSync(currentDir, { withFileTypes: true })
+      .sort((left, right) => left.name.localeCompare(right.name));
+
+    for (const entry of entries) {
+      const nextPath = path.join(currentDir, entry.name);
+      if (entry.isDirectory()) {
+        if (!skipDirs.has(entry.name)) {
+          queue.push(nextPath);
+        }
+        continue;
+      }
+
+      if (!entry.isFile()) {
+        continue;
+      }
+
+      snapshot[path.relative(projectRoot, nextPath)] = readFile(nextPath);
+    }
+  }
+
+  return Object.fromEntries(
+    Object.entries(snapshot).sort(([left], [right]) => left.localeCompare(right)),
+  );
+}
+
+describe('addModule idempotency', () => {
+  const modulesDir = path.dirname(fileURLToPath(import.meta.url));
+  const packageRoot = path.resolve(modulesDir, '..', '..');
+  const scenarios = [
+    {
+      name: 'logger',
+      moduleId: 'logger',
+      dbPrismaEnabled: true,
+      setup: [],
+      verify(projectRoot) {
+        assert.equal(fs.existsSync(path.join(projectRoot, 'packages', 'logger', 'package.json')), true);
+        assert.match(
+          readFile(path.join(projectRoot, 'apps', 'api', 'src', 'main.ts')),
+          /app\.useLogger\(app\.get\(ForgeonLoggerService\)\);/,
+        );
+      },
+    },
+    {
+      name: 'jwt-auth',
+      moduleId: 'jwt-auth',
+      dbPrismaEnabled: false,
+      setup: [],
+      verify(projectRoot) {
+        assert.equal(fs.existsSync(path.join(projectRoot, 'packages', 'auth-api', 'package.json')), true);
+        assert.match(
+          readFile(path.join(projectRoot, 'apps', 'api', 'src', 'health', 'health.controller.ts')),
+          /@Get\('auth'\)/,
+        );
+        assert.doesNotMatch(
+          readFile(path.join(projectRoot, 'apps', 'api', 'src', 'app.module.ts')),
+          /PrismaAuthRefreshTokenStore/,
+        );
+      },
+    },
+    {
+      name: 'files-local',
+      moduleId: 'files-local',
+      dbPrismaEnabled: true,
+      setup: [],
+      verify(projectRoot) {
+        assert.equal(fs.existsSync(path.join(projectRoot, 'packages', 'files-local', 'package.json')), true);
+        assert.match(readFile(path.join(projectRoot, 'apps', 'api', '.env.example')), /FILES_LOCAL_ROOT=storage\/uploads/);
+        assert.match(readFile(path.join(projectRoot, 'infra', 'docker', 'compose.yml')), /^\s{2}files_data:\s*$/m);
+      },
+    },
+    {
+      name: 'files',
+      moduleId: 'files',
+      dbPrismaEnabled: true,
+      setup: ['files-local'],
+      verify(projectRoot) {
+        assert.equal(fs.existsSync(path.join(projectRoot, 'packages', 'files', 'package.json')), true);
+        assert.match(readFile(path.join(projectRoot, 'apps', 'api', '.env.example')), /FILES_STORAGE_DRIVER=local/);
+        assert.match(
+          readFile(path.join(projectRoot, 'apps', 'api', 'src', 'health', 'health.controller.ts')),
+          /@Post\('files'\)/,
+        );
+      },
+    },
+    {
+      name: 'queue',
+      moduleId: 'queue',
+      dbPrismaEnabled: false,
+      setup: [],
+      verify(projectRoot) {
+        assert.equal(fs.existsSync(path.join(projectRoot, 'packages', 'queue', 'package.json')), true);
+        assert.match(readFile(path.join(projectRoot, 'infra', 'docker', 'compose.yml')), /^\s{2}redis:\s*$/m);
+        assert.match(
+          readFile(path.join(projectRoot, 'apps', 'api', 'src', 'health', 'health.controller.ts')),
+          /@Get\('queue'\)/,
+        );
+      },
+    },
+  ];
+
+  it('reapplying representative implemented modules is a no-op on project files', () => {
+    for (const scenario of scenarios) {
+      const tempRoot = makeTempDir(`forgeon-idempotent-${scenario.name}-`);
+      const projectRoot = path.join(tempRoot, `demo-${scenario.name}`);
+
+      try {
+        scaffoldBaseProject({
+          packageRoot,
+          targetRoot: projectRoot,
+          projectName: `demo-${scenario.name}`,
+          dbPrismaEnabled: scenario.dbPrismaEnabled,
+        });
+
+        for (const moduleId of scenario.setup) {
+          addModule({ moduleId, targetRoot: projectRoot, packageRoot });
+        }
+
+        const firstResult = addModule({ moduleId: scenario.moduleId, targetRoot: projectRoot, packageRoot });
+        assert.equal(firstResult.applied, true);
+        scenario.verify(projectRoot);
+
+        const before = readProjectSnapshot(projectRoot);
+        const secondResult = addModule({ moduleId: scenario.moduleId, targetRoot: projectRoot, packageRoot });
+        const after = readProjectSnapshot(projectRoot);
+
+        assert.equal(secondResult.applied, true);
+        assert.deepEqual(after, before);
+        scenario.verify(projectRoot);
+      } finally {
+        fs.rmSync(tempRoot, { recursive: true, force: true });
+      }
+    }
+  });
+});