counterfact 2.4.0 → 2.5.0

package/README.md

@@ -206,7 +206,7 @@ npx counterfact@latest [openapi.yaml] [destination] [options]
 | `--proxy-url <url>` | Forward all requests to this URL by default |
 | `--prefix <path>`   | Base path prefix (e.g. `/api/v1`)           |
 
-Run `npx counterfact --help` for the full list of options.
+Run `npx counterfact@latest --help` for the full list of options.
 
 ---
 

package/bin/README.md

@@ -11,7 +11,7 @@ This directory contains the executable script that is run when a developer invok
 ## How It Works
 
 ```
-npx counterfact openapi.yaml ./api [options]
+npx counterfact@latest openapi.yaml ./api [options]
         │
         ▼
 ┌────────────────────────────┐
@@ -40,5 +40,6 @@ npx counterfact openapi.yaml ./api [options]
 | `--spec <path>` | Path or URL to the OpenAPI document (alternative to positional argument) |
 | `--proxy-url <url>` | Forward all unmatched requests to this upstream URL |
 | `--prefix <path>` | Base path prefix for all routes (e.g. `/api/v1`) |
+| `--no-update-check` | Disable the npm update check on startup |
 
-Run `npx counterfact --help` to see the full option list.
+Run `npx counterfact@latest --help` to see the full option list.

package/bin/counterfact.js

@@ -23,6 +23,18 @@ if (Number.parseInt(process.versions.node.split("."), 10) < MIN_NODE_VERSION) {
   process.exit(1);
 }
 
+const packageJson = JSON.parse(
+  await readFile(
+    nodePath.join(
+      nodePath.dirname(fileURLToPath(import.meta.url)),
+      "../package.json",
+    ),
+    "utf8",
+  ),
+);
+
+const CURRENT_VERSION = packageJson.version;
+
 const taglinesFile = await readFile(
   nodePath.join(
     nodePath.dirname(fileURLToPath(import.meta.url)),
@@ -37,6 +49,48 @@ const DEFAULT_PORT = 3100;
 
 const debug = createDebug("counterfact:bin:counterfact");
 
+function isOutdated(current, latest) {
+  const [cMajor, cMinor, cPatch] = current.split(".").map(Number);
+  const [lMajor, lMinor, lPatch] = latest.split(".").map(Number);
+
+  if (lMajor > cMajor) return true;
+  if (lMajor === cMajor && lMinor > cMinor) return true;
+  if (lMajor === cMajor && lMinor === cMinor && lPatch > cPatch) return true;
+
+  return false;
+}
+
+async function checkForUpdates(currentVersion) {
+  if (process.env.CI) {
+    debug("skipping update check in CI environment");
+    return;
+  }
+
+  try {
+    const response = await fetch(
+      "https://registry.npmjs.org/counterfact/latest",
+    );
+
+    if (!response.ok) {
+      debug("update check failed with status %d", response.status);
+      return;
+    }
+
+    const data = await response.json();
+    const latestVersion = data.version;
+
+    if (isOutdated(currentVersion, latestVersion)) {
+      process.stdout.write(
+        `\n⚠️  You're running counterfact ${currentVersion}\n`,
+      );
+      process.stdout.write(`   Latest version is ${latestVersion}\n`);
+      process.stdout.write(`   Run: npx counterfact@latest\n`);
+    }
+  } catch (error) {
+    debug("update check error: %o", error);
+  }
+}
+
 debug("running ./bin/counterfact.js");
 
 function padTagLine(tagLine) {
@@ -102,6 +156,11 @@ async function main(source, destination) {
 
   const options = program.opts();
 
+  const updateCheckPromise =
+    options.updateCheck === false
+      ? Promise.resolve()
+      : checkForUpdates(CURRENT_VERSION);
+
   // --spec takes precedence over the positional [openapi.yaml] argument.
   // When --spec is provided, the [openapi.yaml] positional slot shifts to
   // become the [destination] argument (so `counterfact --spec api.yaml ./api`
@@ -226,6 +285,7 @@ async function main(source, destination) {
     String.raw`   |___ [__] |__| |\|  |  |=== |--< |--- |--| |___  | `,
     "   " + padTagLine(taglines[Math.floor(Math.random() * taglines.length)]),
     "",
+    `   Version       ${CURRENT_VERSION}`,
     `   API Base URL  ${url}`,
     source === "_" ? undefined : `   Swagger UI    ${swaggerUrl}`,
     "",
@@ -254,6 +314,8 @@ async function main(source, destination) {
   await start(config);
   debug("started server");
 
+  await updateCheckPromise;
+
   if (config.startRepl) {
     startRepl();
   }
@@ -346,5 +408,6 @@ program
     "--spec <string>",
     "path or URL to OpenAPI document (alternative to the positional [openapi.yaml] argument)",
   )
+  .option("--no-update-check", "disable the npm update check on startup")
   .action(main)
   .parse(process.argv);

package/dist/repl/{RawHttpClient.js → raw-http-client.js}

@@ -89,6 +89,12 @@ export class RawHttpClient {
     #send(method, path, bodyAsStringOrObject, headers) {
         const requestNumber = ++this.requestNumber;
         const body = stringifyBody(bodyAsStringOrObject);
+        const effectiveHeaders = { ...headers };
+        if (typeof bodyAsStringOrObject === "object" &&
+            bodyAsStringOrObject !== null &&
+            !Object.keys(effectiveHeaders).some((k) => k.toLowerCase() === "content-type")) {
+            effectiveHeaders["Content-Type"] = "application/json";
+        }
         return new Promise((resolve, reject) => {
             const socket = net.createConnection({ host: this.host, port: this.port }, () => {
                 let request = `${method} ${path} HTTP/1.1\r\n`;
@@ -97,7 +103,7 @@ export class RawHttpClient {
                 if (body != null) {
                     request += `Content-Length: ${Buffer.byteLength(body)}\r\n`;
                 }
-                for (const [key, value] of Object.entries(headers)) {
+                for (const [key, value] of Object.entries(effectiveHeaders)) {
                     request += `${key}: ${value}\r\n`;
                 }
                 request += `\r\n`;

package/dist/repl/repl.js

@@ -1,5 +1,5 @@
 import repl from "node:repl";
-import { RawHttpClient } from "./RawHttpClient.js";
+import { RawHttpClient } from "./raw-http-client.js";
 function printToStdout(line) {
     process.stdout.write(`${line}\n`);
 }

package/dist/server/counterfact-types/index.ts

@@ -1,4 +1,4 @@
-import { OpenApiHeader } from "./OpenApiHeader";
+import { OpenApiHeader } from "./open-api-header";
 
 interface OpenApiContent {
   schema: unknown;

package/dist/server/koa-middleware.js

@@ -19,10 +19,10 @@ const HEADERS_TO_DROP = new Set([
     "trailer",
     "trailers",
 ]);
-function addCors(ctx, headers) {
+function addCors(ctx, allowedMethods, headers) {
     // Always append CORS headers, reflecting back the headers requested if any
     ctx.set("Access-Control-Allow-Origin", headers?.origin ?? "*");
-    ctx.set("Access-Control-Allow-Methods", "GET,HEAD,PUT,POST,DELETE,PATCH");
+    ctx.set("Access-Control-Allow-Methods", allowedMethods);
     ctx.set("Access-Control-Allow-Headers", headers?.["access-control-request-headers"] ?? []);
     ctx.set("Access-Control-Expose-Headers", headers?.["access-control-request-headers"] ?? []);
     ctx.set("Access-Control-Allow-Credentials", "true");
@@ -55,7 +55,7 @@ export function koaMiddleware(dispatcher, config, proxy = koaProxy) {
         if (isProxyEnabledForPath(path, config) && proxyUrl) {
             return proxy("/", { changeOrigin: true, target: proxyUrl })(ctx, next);
         }
-        addCors(ctx, headers);
+        addCors(ctx, dispatcher.registry.allowedMethods(path), headers);
         if (method === "OPTIONS") {
             ctx.status = HTTP_STATUS_CODE_OK;
             return undefined;

package/dist/server/module-loader.js

@@ -55,6 +55,7 @@ export class ModuleLoader extends EventTarget {
             if (eventName === "unlink") {
                 this.registry.remove(url);
                 this.dispatchEvent(new Event("remove"));
+                return;
             }
             const dependencies = this.dependencyGraph.dependentsOf(pathName);
             void this.loadEndpoint(pathName);
@@ -102,9 +103,39 @@ export class ModuleLoader extends EventTarget {
             const doImport = (await determineModuleKind(pathName)) === "commonjs"
                 ? uncachedRequire
                 : uncachedImport;
-            const endpoint = (await doImport(pathName).catch(() => {
-                console.log("ERROR");
+            let importError;
+            const endpoint = (await doImport(pathName).catch((error) => {
+                importError = error;
             }));
+            if (importError !== undefined) {
+                const isSyntaxError = importError instanceof SyntaxError ||
+                    String(importError).startsWith("SyntaxError:");
+                const displayPath = nodePath
+                    .relative(process.cwd(), unescapePathForWindows(pathName))
+                    .replaceAll("\\", "/");
+                const message = isSyntaxError
+                    ? `There is a syntax error in the route file: ${displayPath}`
+                    : `There was an error loading the route file: ${displayPath}`;
+                const errorResponse = () => ({
+                    body: message,
+                    status: 500,
+                });
+                this.registry.add(url, {
+                    DELETE: errorResponse,
+                    GET: errorResponse,
+                    HEAD: errorResponse,
+                    OPTIONS: errorResponse,
+                    PATCH: errorResponse,
+                    POST: errorResponse,
+                    PUT: errorResponse,
+                    TRACE: errorResponse,
+                });
+                this.dispatchEvent(new Event("add"));
+                return;
+            }
+            if (!endpoint) {
+                return;
+            }
             this.dispatchEvent(new Event("add"));
             if (basename(pathName).startsWith("_.context.") &&
                 isContextModule(endpoint)) {

package/dist/server/uncached-require.cjs

@@ -2,9 +2,13 @@
 
 module.exports = {
   uncachedRequire: function uncachedRequire(moduleName) {
-    delete require.cache[require.resolve(moduleName)];
+    try {
+      delete require.cache[require.resolve(moduleName)];
 
-    // eslint-disable-next-line security/detect-non-literal-require
-    return Promise.resolve(require(moduleName));
+      // eslint-disable-next-line security/detect-non-literal-require
+      return Promise.resolve(require(moduleName));
+    } catch (error) {
+      return Promise.reject(error);
+    }
   },
 };

package/dist/typescript-generator/operation-type-coder.js

@@ -6,6 +6,56 @@ import { ResponsesTypeCoder } from "./responses-type-coder.js";
 import { SchemaTypeCoder } from "./schema-type-coder.js";
 import { TypeCoder } from "./type-coder.js";
 import { ParameterExportTypeCoder } from "./parameter-export-type-coder.js";
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#reserved_words
+const RESERVED_WORDS = new Set([
+    "break",
+    "case",
+    "catch",
+    "class",
+    "const",
+    "continue",
+    "debugger",
+    "default",
+    "delete",
+    "do",
+    "else",
+    "export",
+    "extends",
+    "false",
+    "finally",
+    "for",
+    "function",
+    "if",
+    "import",
+    "in",
+    "instanceof",
+    "new",
+    "null",
+    "return",
+    "static",
+    "super",
+    "switch",
+    "this",
+    "throw",
+    "true",
+    "try",
+    "typeof",
+    "var",
+    "void",
+    "while",
+    "with",
+    "yield",
+    "await",
+    "enum",
+    "implements",
+    "interface",
+    "let",
+    "package",
+    "private",
+    "protected",
+    "public",
+    "type",
+]);
 function sanitizeIdentifier(value) {
     // Treat any run of non-identifier characters as a camelCase separator
     let result = value.replaceAll(/[^\w$]+(?<next>.)/gu, (_, char) => char.toUpperCase());
@@ -15,6 +65,10 @@ function sanitizeIdentifier(value) {
     if (/^\d/u.test(result)) {
         result = `_${result}`;
     }
+    // If the identifier is a reserved word, append an underscore
+    if (RESERVED_WORDS.has(result)) {
+        result = `${result}_`;
+    }
     return result || "_";
 }
 export class OperationTypeCoder extends TypeCoder {
@@ -56,7 +110,7 @@ export class OperationTypeCoder extends TypeCoder {
                 return response.get("content").map((content, contentType) => `{  
               status: ${status}, 
               contentType?: "${contentType}",
-              body?: ${new SchemaTypeCoder(content.get("schema")).write(script)}
+              body?: ${content.has("schema") ? new SchemaTypeCoder(content.get("schema")).write(script) : "unknown"}
             }`);
             }
             if (response.has("schema")) {

package/dist/typescript-generator/response-type-coder.js

@@ -14,7 +14,7 @@ export class ResponseTypeCoder extends TypeCoder {
             return response.get("content").map((content, mediaType) => [
                 mediaType,
                 `{ 
-            schema:  ${new SchemaTypeCoder(content.get("schema")).write(script)}
+            schema:  ${content.has("schema") ? new SchemaTypeCoder(content.get("schema")).write(script) : "unknown"}
          }`,
             ]);
         }

package/dist/typescript-generator/script.js

@@ -1,6 +1,7 @@
 import nodePath from "node:path";
 import createDebugger from "debug";
 import { format } from "prettier";
+import { escapePathForWindows } from "../util/windows-escape.js";
 const debug = createDebugger("counterfact:typescript-generator:script");
 export class Script {
     constructor(repository, path) {
@@ -117,9 +118,9 @@ export class Script {
     }
     importStatements() {
         return Array.from(this.imports, ([name, { isDefault, isType, script }]) => {
-            const resolvedPath = nodePath
+            const resolvedPath = escapePathForWindows(nodePath
                 .relative(nodePath.dirname(this.path).replaceAll("\\", "/"), script.path.replace(/\.ts$/u, ".js"))
-                .replaceAll("\\", "/");
+                .replaceAll("\\", "/"));
             return `import${isType ? " type" : ""} ${isDefault ? name : `{ ${name} }`} from "${resolvedPath.includes("../") ? "" : "./"}${resolvedPath}";`;
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Generate a TypeScript-based mock server from an OpenAPI spec in seconds — with stateful routes, hot reload, and REPL support.",
   "type": "module",
   "main": "./dist/app.js",
@@ -66,13 +66,13 @@
   "scripts": {
     "test": "yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest --testPathIgnorePatterns=black-box",
     "test:black-box": "rimraf dist && yarn build && python3 -m pytest test-black-box/ -v",
-    "test:mutants": "stryker run stryker.config.json",
     "test:tsd": "tsd --typings ./dist/server/counterfact-types/index.ts --files ./test/**/*.test-d.ts",
     "build": "rm -rf dist && tsc && copyfiles -f \"src/client/**\" dist/client && copyfiles -f \"src/counterfact-types/*.ts\" dist/server/counterfact-types && copyfiles -f \"src/server/*.cjs\" dist/server",
     "prepack": "yarn build",
     "release": "npx changeset publish",
     "prepare": "husky install",
     "lint": "eslint . --plugin file-progress --rule 'file-progress/activate: 1' --ignore-pattern dist --ignore-pattern out --ignore-pattern coverage",
+    "lint:fix": "eslint --fix . --ignore-pattern dist --ignore-pattern out --ignore-pattern coverage",
     "lint:quickfix": "eslint --fix . eslint --fix demo-ts --rule=\"import/namespace: 0,etc/no-deprecated:0,import/no-cycle:0,no-explicit-type-exports/no-explicit-type-exports:0,import/no-deprecated:0,import/no-self-import:0,import/default:0,import/no-named-as-default:0\" --ignore-pattern dist --ignore-pattern out",
     "go:petstore": "yarn build && yarn counterfact https://petstore3.swagger.io/api/v3/openapi.json out",
     "go:petstore2": "yarn build && yarn counterfact  https://petstore.swagger.io/v2/swagger.json out",
@@ -84,9 +84,6 @@
     "@changesets/cli": "2.30.0",
     "@eslint/js": "10.0.1",
     "@jest/globals": "^30.3.0",
-    "@stryker-mutator/core": "9.6.0",
-    "@stryker-mutator/jest-runner": "9.6.0",
-    "@stryker-mutator/typescript-checker": "9.6.0",
     "@swc/core": "1.15.21",
     "@swc/jest": "0.2.39",
     "@testing-library/dom": "10.4.1",
@@ -122,7 +119,6 @@
     "jest-retries": "1.0.1",
     "node-mocks-http": "1.17.2",
     "rimraf": "6.1.3",
-    "stryker-cli": "1.1.0",
     "supertest": "7.2.2",
     "tsd": "0.33.0",
     "using-temporary-files": "2.2.1"
@@ -141,11 +137,11 @@
     "js-yaml": "4.1.1",
     "json-schema-faker": "0.6.0",
     "jsonwebtoken": "9.0.3",
-    "koa": "3.1.2",
+    "koa": "3.2.0",
     "koa-bodyparser": "4.4.1",
     "koa-proxies": "0.12.4",
     "koa2-swagger-ui": "5.12.0",
-    "lodash": "4.17.23",
+    "lodash": "4.18.1",
     "node-fetch": "3.3.2",
     "open": "11.0.0",
     "patch-package": "8.0.1",