declapract-typescript-ehmpathy 0.49.10 → 0.49.12

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/.declapract.integration.test.ts

@@ -0,0 +1,103 @@
+import fs from 'fs/promises';
+import path from 'node:path';
+
+import { executeApply } from 'declapract';
+import { genTempDir, given, then, useThen, when } from 'test-fns';
+
+// executeApply is slow (full practice evaluation), so grant a generous limit
+jest.setTimeout(180_000);
+
+/**
+ * .what = end-to-end proof of the simple-lambda-handlers migration, run through the REAL declapract
+ *   apply pipeline against a genTempDir clone of a consumer repo. per
+ *   rule.require.declapract-integration-tests, a fix that TRANSFORMS a file (regex rewrite + a
+ *   value-rewrite @declapract:review marker) owes a pipeline test — a unit test of the exported
+ *   `fix` never exercises the source-file glob -> file match, nor that the marker lands on disk.
+ * .why = the fix rewrites the `simple-lambda-handlers` import to `sdk-aws-lambda` and prepends a
+ *   loud @declapract:review marker, because the schema+invoke CONTRACT differs between the two
+ *   frameworks and a rename-only migration answers 400 to every request yet typechecks (#594). the
+ *   marker names the two manual edits rather than let a regex guess the contract.
+ * .note = the target file is snapshotted in full (before AND after), so a reviewer can eyeball the
+ *   exact end-state, per rule.require.declapract-integration-tests.
+ * .teeth = the input imports + CALLS `createApiGatewayHandler`. the after-state proves the import is
+ *   rewritten to `sdk-aws-lambda`, the call is rewritten to `genLambdaEndpoint.for.apiGateway`, and
+ *   the @declapract:review marker lands on disk — the glue a mocked-context unit test cannot show.
+ */
+describe('simple-lambda-handlers migration', () => {
+  given('[case1] a repo with a simple-lambda-handlers api-gateway handler', () => {
+    const tempDir = genTempDir({
+      slug: 'declapract-simple-lambda-handlers',
+      clone: './src/practices/node-service/bad-practices/simple-lambda-handlers/.test/assets/demo-repo-with-simple-lambda-handlers',
+      symlink: [
+        {
+          at: 'declarations',
+          to: './src/.test/assets/node-service/declarations',
+        },
+        { at: 'node_modules', to: 'node_modules' },
+      ],
+    });
+
+    const targetPath = 'src/contract/handlers/getWidget.ts';
+    const read = (relativePath: string) =>
+      fs.readFile(path.join(tempDir, relativePath), 'utf-8');
+    const applyMigrate = () =>
+      executeApply({
+        config: path.join(tempDir, 'declapract.use.yml'),
+        practice: 'node-service',
+        file: targetPath,
+      });
+
+    when('[t0] the migration input (before any fix)', () => {
+      then('the src file imports + calls the simple-lambda-handlers factory + matches snapshot', async () => {
+        const before = await read(targetPath);
+        expect(before).toContain("from 'simple-lambda-handlers'");
+        expect(before).toContain('createApiGatewayHandler(');
+        expect(before).not.toContain('@declapract:review');
+        expect(before).toMatchSnapshot('getWidget.ts — before');
+      });
+    });
+
+    when('[t1] the simple-lambda-handlers fix is applied', () => {
+      useThen('migrate the handler import + call', async () => applyMigrate());
+
+      then(
+        'the import + call are rewritten to sdk-aws-lambda, the review marker lands, and it matches snapshot',
+        async () => {
+          const after = await read(targetPath);
+
+          // the import is rewritten to the sdk
+          expect(after).toContain("from 'sdk-aws-lambda'");
+          expect(after).not.toContain("from 'simple-lambda-handlers'");
+
+          // the api-gateway factory call is rewritten to its sdk equivalent
+          expect(after).toContain('genLambdaEndpoint.for.apiGateway(');
+          expect(after).not.toContain('createApiGatewayHandler(');
+
+          // the value-rewrite marker lands on disk — the un-rewritable schema+invoke contract
+          // is loud, so a consumer cannot ship a handler that answers 400 to every request
+          expect(after).toContain('@declapract:review');
+          expect(after).toContain('rawEvent');
+
+          // full content, for the reviewer's eye
+          expect(after).toMatchSnapshot('getWidget.ts — after');
+        },
+      );
+    });
+
+    when('[t2] the fix is applied a second time (idempotency)', () => {
+      // post-rewrite the file imports from sdk-aws-lambda, so the check no longer detects the bad
+      // practice and the fix does not run — the second apply changes zero bytes, and the marker is
+      // never double-prepended (per rule.require.idempotent-fixes).
+      const passes = useThen('a second apply over its own output', async () => {
+        const before = await read(targetPath); // post-first-migrate
+        await applyMigrate(); // second apply
+        const after = await read(targetPath);
+        return { before, after };
+      });
+
+      then('the second apply is a no-op', () => {
+        expect(passes.after).toEqual(passes.before);
+      });
+    });
+  });
+});

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/.declapract.readme.md

@@ -0,0 +1,60 @@
+# simple-lambda-handlers
+
+## what
+
+detects and transforms simple-lambda-handlers usage to sdk-aws-lambda.
+
+## why
+
+sdk-aws-lambda provides modern lambda handler patterns:
+- better schema validation with zod (input + output)
+- log context passed to invoke function
+- trail.exid auto-propagation
+
+## transforms
+
+| old | new |
+|-----|-----|
+| `import { createStandardHandler } from 'simple-lambda-handlers'` | `import { genLambdaEndpoint } from 'sdk-aws-lambda'` |
+| `import { createApiGatewayHandler } from 'simple-lambda-handlers'` | `import { genLambdaEndpoint } from 'sdk-aws-lambda'` |
+| `createStandardHandler(...)` | `genLambdaEndpoint(...)` |
+| `createApiGatewayHandler(...)` | `genLambdaEndpoint.for.apiGateway(...)` |
+
+## limitations
+
+these patterns require manual migration:
+
+- `schema` (single joi) → `schema: { input, output }` (split zod)
+- `logic: (event) => O` → `invoke: ({ event }, { log }) => O`
+- `log` passed at creation → `log` also received in invoke context
+
+the contract differs in a way a regex cannot get right: the prior framework's schema described the
+WHOLE event, while sdk-aws-lambda's input schema describes the request BODY (the handler then reads
+headers off a separate `rawEvent`). a rename-only rewrite answers 400 to every request yet
+typechecks. so a handler CALL now carries a `@declapract:review` marker that names the two manual
+edits (unwrap the `body` key into the input schema; thread headers via `rawEvent.headers`). the
+codemod does NOT guess the contract — it flags it loud, and the consumer deletes the marker once the
+call is restructured (#594).
+
+## example
+
+before:
+```ts
+import { createStandardHandler } from 'simple-lambda-handlers';
+
+export const handler = createStandardHandler({
+  log,
+  schema,
+  logic: async (event) => doStuff(event),
+});
+```
+
+after (requires manual refinement):
+```ts
+import { genLambdaEndpoint } from 'sdk-aws-lambda';
+
+export const handler = genLambdaEndpoint({
+  schema: { input: inputSchema, output: outputSchema },
+  invoke: async ({ event }, { log }) => doStuff(event),
+}, { log });
+```

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/.test/assets/demo-repo-with-simple-lambda-handlers/declapract.use.yml

@@ -0,0 +1,5 @@
+# .note = the declarations dir is symlinked by the test (holds declapract.declare.yml + a
+#         practices/node-service symlink to the real practice), so the consumer's own src/ tree
+#         stays free to hold the target .ts file the src/**/*.ts glob matches.
+declarations: 'declarations/declapract.declare.yml'
+useCase: lambda-service

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/.test/assets/demo-repo-with-simple-lambda-handlers/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "test-project",
+  "version": "1.0.0"
+}

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/.test/assets/demo-repo-with-simple-lambda-handlers/src/contract/handlers/getWidget.ts

@@ -0,0 +1,13 @@
+import { createApiGatewayHandler } from 'simple-lambda-handlers';
+
+import { log } from '../../utils/logger';
+import { getWidgetSchema } from './getWidget.schema';
+
+// an api-gateway handler CALL — the schema+invoke contract differs between the two
+// frameworks, so the fix cannot rename-only; it must emit a loud review marker.
+export const handler = createApiGatewayHandler({
+  log,
+  schema: getWidgetSchema,
+  logic: async (event) => ({ widget: event.widgetId }),
+  cors: true,
+});

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/__snapshots__/.declapract.integration.test.ts.snap

@@ -0,0 +1,44 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`simple-lambda-handlers migration given: [case1] a repo with a simple-lambda-handlers api-gateway handler when: [t0] the migration input (before any fix) then: the src file imports + calls the simple-lambda-handlers factory + matches snapshot: getWidget.ts — before 1`] = `
+"import { createApiGatewayHandler } from 'simple-lambda-handlers';
+
+import { log } from '../../utils/logger';
+import { getWidgetSchema } from './getWidget.schema';
+
+// an api-gateway handler CALL — the schema+invoke contract differs between the two
+// frameworks, so the fix cannot rename-only; it must emit a loud review marker.
+export const handler = createApiGatewayHandler({
+  log,
+  schema: getWidgetSchema,
+  logic: async (event) => ({ widget: event.widgetId }),
+  cors: true,
+});
+"
+`;
+
+exports[`simple-lambda-handlers migration given: [case1] a repo with a simple-lambda-handlers api-gateway handler when: [t1] the simple-lambda-handlers fix is applied then: the import + call are rewritten to sdk-aws-lambda, the review marker lands, and it matches snapshot: getWidget.ts — after 1`] = `
+"/**
+ * @declapract:review — auto-migrated to sdk-aws-lambda; the api-gateway handler CONTRACT differs
+ * and MUST be restructured by hand (a rename-only migration answers 400 to every request):
+ *  - schema: the prior single schema described the WHOLE event; the sdk input schema describes the
+ *    request BODY only. split into \`schema: { input, output }\` and unwrap the \`body\` key.
+ *  - invoke: \`logic: (event) => O\` becomes \`invoke: async ({ event, rawEvent }) => O\`. \`event\` is
+ *    the parsed body; thread headers through \`rawEvent.headers\`.
+ * delete this marker once restructured.
+ */
+import { genLambdaEndpoint } from 'sdk-aws-lambda';
+
+import { log } from '../../utils/logger';
+import { getWidgetSchema } from './getWidget.schema';
+
+// an api-gateway handler CALL — the schema+invoke contract differs between the two
+// frameworks, so the fix cannot rename-only; it must emit a loud review marker.
+export const handler = genLambdaEndpoint.for.apiGateway({
+  log,
+  schema: getWidgetSchema,
+  logic: async (event) => ({ widget: event.widgetId }),
+  cors: true,
+});
+"
+`;

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "simple-lambda-handlers": "@declapract{check.minVersion('0.0.0')}"
+  }
+}

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/package.json.declapract.ts

@@ -0,0 +1,27 @@
+import { FileCheckType, type FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;
+
+/**
+ * .what = removes simple-lambda-handlers and adds sdk-aws-lambda
+ * .why = sdk-aws-lambda is the modern replacement with better patterns
+ */
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return { contents };
+
+  const packageJSON = JSON.parse(contents);
+
+  const updatedPackageJSON = {
+    ...packageJSON,
+    dependencies: {
+      ...packageJSON.dependencies,
+      'simple-lambda-handlers': undefined,
+      'sdk-aws-lambda':
+        packageJSON.dependencies?.['sdk-aws-lambda'] ?? '^0.1.0',
+    },
+  };
+
+  return {
+    contents: JSON.stringify(updatedPackageJSON, null, 2),
+  };
+};

package/dist/.test/assets/node-service/declarations/practices/node-service/bad-practices/simple-lambda-handlers/src/<star><star>/<star>.ts.declapract.ts

@@ -0,0 +1,130 @@
+import type { FileCheckFunction, FileFixFunction } from 'declapract';
+
+/**
+ * .what = detects simple-lambda-handlers imports in source files
+ * .why = simple-lambda-handlers should be replaced with sdk-aws-lambda
+ */
+export const check: FileCheckFunction = (contents) => {
+  // match if file imports from simple-lambda-handlers
+  if (contents?.includes("from 'simple-lambda-handlers'")) return;
+  if (contents?.includes('from "simple-lambda-handlers"')) return;
+
+  // no match
+  throw new Error('does not import from simple-lambda-handlers');
+};
+
+/**
+ * .what = a loud marker for an api-gateway handler call, whose schema+invoke CONTRACT differs
+ *         between the two frameworks and cannot be mechanically rewritten.
+ * .why = the prior framework's schema described the WHOLE event and the handler received the whole
+ *        event; the sdk's input schema describes the request BODY and the handler receives the
+ *        parsed body plus a separate rawEvent. a rename-only rewrite leaves a handler that answers
+ *        400 to every request, yet typechecks (#594). the marker flags the two manual edits rather
+ *        than let a regex guess the contract.
+ */
+const apiGatewayReviewMarker = `/**
+ * @declapract:review — auto-migrated to sdk-aws-lambda; the api-gateway handler CONTRACT differs
+ * and MUST be restructured by hand (a rename-only migration answers 400 to every request):
+ *  - schema: the prior single schema described the WHOLE event; the sdk input schema describes the
+ *    request BODY only. split into \`schema: { input, output }\` and unwrap the \`body\` key.
+ *  - invoke: \`logic: (event) => O\` becomes \`invoke: async ({ event, rawEvent }) => O\`. \`event\` is
+ *    the parsed body; thread headers through \`rawEvent.headers\`.
+ * delete this marker once restructured.
+ */
+`;
+
+/**
+ * .what = a loud marker for a standard handler call, whose schema+invoke shape also differs.
+ * .why = the rename does not restructure the args; the sdk splits the schema and passes log in the
+ *        invoke context. the marker flags the manual edits (#594).
+ */
+const standardReviewMarker = `/**
+ * @declapract:review — auto-migrated to sdk-aws-lambda; the handler CONTRACT differs and MUST be
+ * restructured by hand:
+ *  - schema: the prior single schema splits into \`schema: { input, output }\`.
+ *  - invoke: \`logic: (event) => O\` becomes \`invoke: async ({ event }, { log }) => O\`; \`log\` is now
+ *    received in the invoke context, not only at creation.
+ * delete this marker once restructured.
+ */
+`;
+
+/**
+ * .what = parse a comma-separated import clause into its trimmed import names
+ * .why = names the split/trim parse, so the fix orchestrator reads as narrative rather than
+ *        an inline array-manipulation chain (rule.forbid.inline-decode-friction)
+ */
+const asImportNames = (input: { clause: string }): string[] =>
+  input.clause.split(',').map((name) => name.trim());
+
+/**
+ * .what = map one simple-lambda-handlers import name to its sdk-aws-lambda equivalent
+ * .why = both handler-factory names collapse onto `genLambdaEndpoint`; the named map keeps the
+ *        fix orchestrator narrative rather than an inline conditional (rule.forbid.inline-decode-friction)
+ */
+const asTransformedImportName = (input: { name: string }): string => {
+  if (input.name === 'createStandardHandler') return 'genLambdaEndpoint';
+  if (input.name === 'createApiGatewayHandler') return 'genLambdaEndpoint';
+  return input.name;
+};
+
+/**
+ * .what = dedupe import names, first-seen order retained
+ * .why = the two handler factories both map to `genLambdaEndpoint`, so a clause that imports both
+ *        would emit a duplicate; the named dedupe hides the Set semantics from the orchestrator
+ */
+const asDedupedImportNames = (input: { names: string[] }): string[] => [
+  ...new Set(input.names),
+];
+
+/**
+ * .what = transforms simple-lambda-handlers imports to sdk-aws-lambda, with a review marker
+ * .why = automated migration reduces manual toil, but the schema+invoke contract cannot be
+ *        mechanically rewritten — so a handler CALL gets a @declapract:review marker that names the
+ *        manual edits, rather than a silent rename that answers 400 to every request (#594).
+ *
+ * .note = basic transforms only; complex patterns require manual fix
+ *
+ * API map:
+ * - createStandardHandler → genLambdaEndpoint
+ * - createApiGatewayHandler → genLambdaEndpoint.for.apiGateway
+ */
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return {};
+
+  // detect a handler CALL (name + paren) on the ORIGINAL contents, before the rename
+  const hasApiGatewayCall = /createApiGatewayHandler\s*\(/.test(contents);
+  const hasStandardCall = /createStandardHandler\s*\(/.test(contents);
+
+  const transformed = contents
+    // transform imports (dedupe to avoid duplicate genLambdaEndpoint)
+    .replace(
+      /import\s+\{([^}]*)\}\s+from\s+['"]simple-lambda-handlers['"]/g,
+      (match, imports) => {
+        // split, replace, dedupe, join
+        const importNames = asImportNames({ clause: imports });
+        const mapped = importNames.map((name) =>
+          asTransformedImportName({ name }),
+        );
+        const deduped = asDedupedImportNames({ names: mapped });
+        return `import { ${deduped.join(', ')} } from 'sdk-aws-lambda'`;
+      },
+    )
+    // transform function calls
+    .replace(/createStandardHandler/g, 'genLambdaEndpoint')
+    .replace(/createApiGatewayHandler/g, 'genLambdaEndpoint.for.apiGateway');
+
+  // prepend the review marker for a handler CALL (api-gateway takes precedence), so the
+  // un-rewritable schema+invoke contract is loud. idempotent: the check no longer fires
+  // post-rewrite, and a second pass would find the marker already present.
+  const marker = hasApiGatewayCall
+    ? apiGatewayReviewMarker
+    : hasStandardCall
+      ? standardReviewMarker
+      : '';
+  const updated =
+    marker && !transformed.includes('@declapract:review')
+      ? marker + transformed
+      : transformed;
+
+  return { contents: updated };
+};

package/dist/.test/assets/node-service/declarations/practices/node-service/best-practice/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "dependencies": {
+    "sdk-aws-lambda": "@declapract{check.minVersion('0.4.0')}"
+  }
+}

package/dist/.test/assets/node-service/declarations/practices/node-service/best-practice/package.json.declapract.ts

@@ -0,0 +1,3 @@
+import { FileCheckType } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;

package/dist/.test/assets/node-service/declarations/useCases.yml

@@ -0,0 +1,5 @@
+# minimal use case for the node-service practice integration test
+use-cases:
+  lambda-service:
+    practices:
+      - node-service

package/dist/.test/assets/pnpm/declarations/declapract.declare.yml

@@ -0,0 +1,4 @@
+# minimal declarations for the pnpm bad-practice integration tests
+declare:
+  practices: practices
+  use-cases: useCases.yml