Merge branch 'main' into copilot/add-apply-command

Author: pmcelhaney

.changeset/renovate-0941c05.md

@@ -0,0 +1,5 @@
+---
+'counterfact': patch
+---
+
+Updated dependency `ajv` to `8.18.0`.

.github/copilot-instructions.md

@@ -33,6 +33,14 @@ Each item must use this format:
 - [ ] Response includes `x-test` header when defined
 - [ ] Existing routes without examples behave unchanged
 
+### Exception: Design PRs
+
+When the goal of the **PR** is to **create more issues rather than write code** (e.g., proposing issue files under `.github/issue-proposals/`), treat the PR as a **design PR**:
+
+1. Add the `design` label to the PR.
+2. Do **not** include a "## Manual acceptance tests" section — omit it entirely.
+3. The CI check for manual acceptance tests will automatically pass for PRs with the `design` label.
+
 ## Test-driven workflow
 
 When implementing a change, work in a test-first or test-guided way whenever practical.
@@ -68,6 +76,30 @@ Add or update tests for:
 - generated code, when generation behavior is being changed
 - any change that affects external contracts, APIs, schemas, or CLI behavior
 
+### File system operations in tests
+
+When tests need to read or write files, always use `usingTemporaryFiles()` from the `using-temporary-files` package (already a devDependency). Never import `node:fs`, `fs`, `node:fs/promises`, or `fs/promises` directly in test files.
+
+The `$` helper passed to the callback provides:
+- `$.add(relativePath, contents)` — create or overwrite a file
+- `$.addDirectory(relativePath)` — create a directory
+- `$.read(relativePath)` — read a file's contents (returns `Promise<string>`)
+- `$.remove(relativePath)` — delete a file
+- `$.path(relativePath)` — resolve an absolute path within the temporary directory (use this when passing paths to the code under test)
+
+```ts
+import { usingTemporaryFiles } from "using-temporary-files";
+
+it("example", async () => {
+  await usingTemporaryFiles(async ($) => {
+    await $.add("input.json", JSON.stringify({ key: "value" }));
+    const result = await myFunction($.path("input.json"));
+    const output = await $.read("output.txt");
+    expect(output).toBe("expected content");
+  });
+});
+```
+
 ### When tests are hard to add
 
 If a test is difficult to write:

.github/workflows/manual-acceptance-tests.yaml

@@ -15,15 +15,26 @@ jobs:
         env:
           PR_BRANCH: ${{ github.event.pull_request.head.ref }}
           PR_BODY: ${{ github.event.pull_request.body }}
+          PR_LABELS: ${{ toJson(github.event.pull_request.labels.*.name) }}
         run: |
-          if [[ "$PR_BRANCH" == copilot* ]] || grep -iq "## manual acceptance tests" <<<"$PR_BODY"; then
+          if python3 -c "
+import json, os, sys
+try:
+    labels = json.loads(os.environ.get('PR_LABELS', '[]'))
+    sys.exit(0 if 'design' in labels else 1)
+except Exception as e:
+    print(f'Error parsing PR labels: {e}', file=sys.stderr)
+    sys.exit(1)
+"; then
+            echo "enforce=false" >> "$GITHUB_OUTPUT"
+          elif [[ "$PR_BRANCH" == copilot* ]] || grep -iq "## manual acceptance tests" <<<"$PR_BODY"; then
             echo "enforce=true" >> "$GITHUB_OUTPUT"
           else
             echo "enforce=false" >> "$GITHUB_OUTPUT"
           fi
       - name: Skip (no enforcement needed)
         if: steps.decide.outputs.enforce == 'false'
-        run: echo "Skipping manual acceptance test validation (not a Copilot PR and no section present)"
+        run: echo "Skipping manual acceptance test validation (design PR, not a Copilot PR, or no section present)"
 
       - name: Validate PR body
         if: steps.decide.outputs.enforce == 'true'

eslint.config.cjs

@@ -114,6 +114,33 @@ module.exports = [
       "max-lines": "off",
       "new-cap": ["error", { capIsNewExceptionPattern: "GET|PUT|POST|DELETE" }],
       "no-magic-numbers": "off",
+      "no-restricted-imports": [
+        "error",
+        {
+          paths: [
+            {
+              name: "fs",
+              message:
+                "Do not import 'fs' in tests. Use usingTemporaryFiles() from 'using-temporary-files' instead.",
+            },
+            {
+              name: "node:fs",
+              message:
+                "Do not import 'node:fs' in tests. Use usingTemporaryFiles() from 'using-temporary-files' instead.",
+            },
+            {
+              name: "fs/promises",
+              message:
+                "Do not import 'fs/promises' in tests. Use usingTemporaryFiles() from 'using-temporary-files' instead.",
+            },
+            {
+              name: "node:fs/promises",
+              message:
+                "Do not import 'node:fs/promises' in tests. Use usingTemporaryFiles() from 'using-temporary-files' instead.",
+            },
+          ],
+        },
+      ],
       "no-shadow": "off",
     },
   },

package.json

@@ -126,7 +126,7 @@
     "@apidevtools/json-schema-ref-parser": "13.0.5",
     "@hapi/accept": "6.0.3",
     "@types/json-schema": "7.0.15",
-    "ajv": "6.14.0",
+    "ajv": "8.18.0",
     "chokidar": "5.0.0",
     "commander": "14.0.3",
     "debug": "4.4.3",

src/server/request-validator.ts

@@ -4,7 +4,7 @@ import type { OpenApiOperation } from "../counterfact-types/index.js";
 
 const ajv = new Ajv({
   allErrors: true,
-  unknownFormats: "ignore",
+  strict: false,
   coerceTypes: false,
 });
 
@@ -57,10 +57,7 @@ export function validateRequest(
 
       if (!valid && ajv.errors) {
         for (const error of ajv.errors) {
-          const path =
-            (error as { instancePath?: string }).instancePath ??
-            error.dataPath ??
-            "";
+          const path = error.instancePath ?? "";
 
           errors.push(`body${path} ${error.message ?? "is invalid"}`);
         }
@@ -78,10 +75,7 @@ export function validateRequest(
 
     if (!valid && ajv.errors) {
       for (const error of ajv.errors) {
-        const path =
-          (error as { instancePath?: string }).instancePath ??
-          error.dataPath ??
-          "";
+        const path = error.instancePath ?? "";
 
         errors.push(`body${path} ${error.message ?? "is invalid"}`);
       }

test/migrate/update-route-types.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "@jest/globals";
-import { promises as fs } from "node:fs";
+
 import { usingTemporaryFiles } from "using-temporary-files";
 
 // Import the main function - other functions are not exported so we test through integration
@@ -48,10 +48,7 @@ export const GET: HTTP_GET = ($) => {
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/pet/{id}.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/pet/{id}.ts");
 
         expect(updatedContent).toContain("import type { getPetById }");
         expect(updatedContent).toContain("export const GET: getPetById");
@@ -100,10 +97,7 @@ export const POST: HTTP_POST = ($) => {
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/pet.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/pet.ts");
 
         expect(updatedContent).toContain("import type { addPet }");
         expect(updatedContent).toContain("export const POST: addPet");
@@ -157,10 +151,7 @@ export const DELETE: HTTP_DELETE = ($) => {
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/pet/{id}.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/pet/{id}.ts");
 
         expect(updatedContent).toContain(
           "import type { getPetById, updatePet, deletePet }",
@@ -204,10 +195,7 @@ export const GET: HTTP_GET = ($) => {
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/index.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/index.ts");
 
         expect(updatedContent).toContain("import type { getRoot }");
         expect(updatedContent).toContain("export const GET: getRoot");
@@ -244,10 +232,7 @@ export const GET: HTTP_GET = ($) => {
         // Should return false because no changes needed (HTTP_GET stays HTTP_GET)
         expect(migrated).toBe(false);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/anonymous.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/anonymous.ts");
 
         // File should remain unchanged
         expect(updatedContent).toContain("import type { HTTP_GET }");
@@ -287,10 +272,7 @@ export const GET: HTTP_GET = ($) => {
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/api/v1/users/{id}.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/api/v1/users/{id}.ts");
 
         expect(updatedContent).toContain("import type { getUserById }");
         expect(updatedContent).toContain("export const GET: getUserById");
@@ -346,21 +328,15 @@ export const GET: HTTP_GET = ($) => ({ status: 200 });`,
 
         expect(migrated).toBe(true);
 
-        const petsContent = await fs.readFile($.path("routes/pets.ts"), "utf8");
+        const petsContent = await $.read("routes/pets.ts");
         expect(petsContent).toContain("import type { listPets }");
         expect(petsContent).toContain("export const GET: listPets");
 
-        const petByIdContent = await fs.readFile(
-          $.path("routes/pets/{id}.ts"),
-          "utf8",
-        );
+        const petByIdContent = await $.read("routes/pets/{id}.ts");
         expect(petByIdContent).toContain("import type { getPetById }");
         expect(petByIdContent).toContain("export const GET: getPetById");
 
-        const usersContent = await fs.readFile(
-          $.path("routes/users.ts"),
-          "utf8",
-        );
+        const usersContent = await $.read("routes/users.ts");
         expect(usersContent).toContain("import type { listUsers }");
         expect(usersContent).toContain("export const GET: listUsers");
       });
@@ -399,10 +375,7 @@ export const GET: getPetById = ($) => {
         // Should return false because file is already migrated
         expect(migrated).toBe(false);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/pet/{id}.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/pet/{id}.ts");
 
         // File should remain exactly the same
         expect(updatedContent).toBe(alreadyMigratedFile);
@@ -439,10 +412,7 @@ export const POST: HTTP_POST = ($) => {
         );
         expect(firstMigration).toBe(true);
 
-        const afterFirstMigration = await fs.readFile(
-          $.path("routes/pet.ts"),
-          "utf8",
-        );
+        const afterFirstMigration = await $.read("routes/pet.ts");
 
         // Second migration
         const secondMigration = await updateRouteTypes(
@@ -451,10 +421,7 @@ export const POST: HTTP_POST = ($) => {
         );
         expect(secondMigration).toBe(false);
 
-        const afterSecondMigration = await fs.readFile(
-          $.path("routes/pet.ts"),
-          "utf8",
-        );
+        const afterSecondMigration = await $.read("routes/pet.ts");
 
         // Content should be identical after both runs
         expect(afterFirstMigration).toBe(afterSecondMigration);
@@ -492,10 +459,7 @@ export const GET: HTTP_GET = ($) => ({ status: 200 });`,
         await $.add("routes/_.context.ts", contextFile);
         await updateRouteTypes($.path(""), $.path("openapi.json"));
 
-        const contextContent = await fs.readFile(
-          $.path("routes/_.context.ts"),
-          "utf8",
-        );
+        const contextContent = await $.read("routes/_.context.ts");
 
         // Context file should remain unchanged
         expect(contextContent).toBe(contextFile);
@@ -558,7 +522,7 @@ export const config = {
 
         expect(migrated).toBe(false);
 
-        const content = await fs.readFile($.path("routes/config.ts"), "utf8");
+        const content = await $.read("routes/config.ts");
         expect(content).toBe(nonMigrationFile);
       });
     });
@@ -601,10 +565,7 @@ export const POST : HTTP_POST= ($) => {
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/pet.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/pet.ts");
 
         expect(updatedContent).toContain("getPet");
         expect(updatedContent).toContain("addPet");
@@ -671,10 +632,7 @@ export const OPTIONS: HTTP_OPTIONS = ($) => ({ status: 200 });
 
         expect(migrated).toBe(true);
 
-        const updatedContent = await fs.readFile(
-          $.path("routes/resource.ts"),
-          "utf8",
-        );
+        const updatedContent = await $.read("routes/resource.ts");
 
         expect(updatedContent).toContain("getResource");
         expect(updatedContent).toContain("createResource");