counterfact 0.26.2 → 0.27.0

package/bin/counterfact.js

@@ -6,6 +6,7 @@ import { program } from "commander";
 import createDebug from "debug";
 import open from "open";
 
+import { migrate } from "../dist/src/migrations/0.27.js";
 import { startRepl } from "../dist/src/server/repl.js";
 import { start } from "../dist/src/server/start.js";
 import { generate } from "../dist/src/typescript-generator/generate.js";
@@ -30,6 +31,10 @@ async function main(source, destination) {
     .join(process.cwd(), destination)
     .replaceAll("\\", "/");
 
+  debug("migrating code from before 0.27.0");
+  migrate(destinationPath);
+  debug("done with migration");
+
   debug('generating code at "%s"', destinationPath);
 
   await generate(source, destinationPath);

package/dist/src/migrations/0.27.js

@@ -0,0 +1,39 @@
+import { existsSync, readdirSync, readFileSync, statSync, writeFileSync, } from "node:fs";
+import { join } from "node:path";
+function processFile(filePath) {
+    const content = readFileSync(filePath, "utf8");
+    if (content.includes("export type ContextType =") ||
+        content.includes("export type { ContextType }")) {
+        return;
+    }
+    if (content.includes("export default new Context")) {
+        writeFileSync(filePath, "export type ContextType = typeof Context;\n", {
+            flag: "a",
+        });
+    }
+    else {
+        writeFileSync(filePath, 'export type { ContextType } from "../$.context";\n');
+    }
+}
+function migrateContextFiles(path) {
+    if (!existsSync(path)) {
+        return;
+    }
+    const items = readdirSync(path);
+    for (const item of items) {
+        const itemPath = join(path, item);
+        const stats = statSync(itemPath);
+        if (stats.isDirectory()) {
+            migrateContextFiles(itemPath);
+        }
+        if (stats.isFile() && item === "$.context.ts") {
+            processFile(itemPath);
+        }
+    }
+}
+export function migrate(rootPath) {
+    if (!existsSync(rootPath)) {
+        return;
+    }
+    migrateContextFiles(join(rootPath, "paths"));
+}

package/dist/src/server/context-registry.js

@@ -8,7 +8,11 @@ export class ContextRegistry {
     }
     add(path, context) {
         if (context === undefined) {
-            throw new Error("context cannot be undefined");
+            // If $.context.ts exists but only exports a type, then the context object will be undefined here.
+            // This should be handled upstream, so that add() is not called in the first place.
+            // But module-loader.ts needs to be refactored a bit using type guards and the is operator
+            // before that can be done cleanly.
+            return;
         }
         this.entries.set(path, context);
     }

package/dist/src/server/dispatcher.js

@@ -75,6 +75,7 @@ export class Dispatcher {
             }
             const normalizedResponse = {
                 ...response,
+                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
                 body: content.body,
                 contentType: content.type,
             };
@@ -142,8 +143,11 @@ export class Dispatcher {
             tools: new Tools({ headers }),
         });
         const normalizedResponse = this.normalizeResponse(response, headers.accept ?? "*/*");
-        if (!mediaTypes(headers.accept ?? "*/*").some((type) => this.isMediaType(normalizedResponse.contentType, type))) {
-            return { body: mediaTypes(headers.accept ?? "*/*"), status: 406 };
+        if (!mediaTypes(headers.accept ?? "*/*").some((type) => this.isMediaType(normalizedResponse.contentType ?? "", type))) {
+            return {
+                body: JSON.stringify(mediaTypes(headers.accept ?? "*/*")),
+                status: 406,
+            };
         }
         return normalizedResponse;
     }

package/dist/src/server/koa-middleware.js

@@ -35,6 +35,11 @@ export function koaMiddleware(dispatcher, { proxyEnabled = false, proxyUrl = ""
         });
         /* eslint-disable require-atomic-updates */
         ctx.body = response.body;
+        if (response.headers) {
+            for (const [key, value] of Object.entries(response.headers)) {
+                ctx.set(key, value.toString());
+            }
+        }
         ctx.status = response.status ?? HTTP_STATUS_CODE_OK;
         /* eslint-enable require-atomic-updates */
         return undefined;

package/dist/src/typescript-generator/context-coder.js

@@ -30,15 +30,8 @@ class Context {
 }
 `;
     }
-    write(script) {
-        if (script.path === "paths/$.context.ts") {
-            return "new Context()";
-        }
-        const parentPath = nodePath
-            .normalize(nodePath.join(script.path, "../../$.context.ts"))
-            .replaceAll("\\", "/");
-        script.repository.get(parentPath).exportDefault(this);
-        return { raw: 'export { default } from "../$.context.mjs"' };
+    write() {
+        return "new Context()";
     }
     modulePath() {
         return nodePath

package/dist/src/typescript-generator/context-type-coder.js

@@ -0,0 +1,32 @@
+import nodePath from "node:path";
+import { Coder } from "./coder.js";
+export class ContextTypeCoder extends Coder {
+    constructor(requirement, isRoot) {
+        super(requirement);
+        this.isRoot = isRoot;
+    }
+    pathString() {
+        return this.requirement.url
+            .split("/")
+            .at(-2)
+            .replaceAll("~1", "/")
+            .replaceAll("~0", "~");
+    }
+    get id() {
+        return "ContextTypeCoder";
+    }
+    names() {
+        return super.names("ContextType");
+    }
+    write(script) {
+        if (script.path === "paths/$.context.ts") {
+            return "typeof Context";
+        }
+        return { raw: 'export type { ContextType } from "../$.context"' };
+    }
+    modulePath() {
+        return nodePath
+            .join("paths", nodePath.dirname(this.pathString()), "$.context.ts")
+            .replaceAll("\\", "/");
+    }
+}

package/dist/src/typescript-generator/generate.js

@@ -3,6 +3,7 @@ import fs from "node:fs/promises";
 import nodePath from "node:path";
 import createDebug from "debug";
 import { ensureDirectoryExists } from "../util/ensure-directory-exists.js";
+import { ContextCoder } from "./context-coder.js";
 import { OperationCoder } from "./operation-coder.js";
 import { Repository } from "./repository.js";
 import { Specification } from "./specification.js";
@@ -39,6 +40,7 @@ export async function generate(source, destination, repository = new Repository(
             repository.get(`paths${key}.ts`).export(new OperationCoder(operation));
         });
     });
+    repository.get("paths/$.context.ts").exportDefault(new ContextCoder(paths));
     debug("telling the repository to write the files to %s", destination);
     await repository.writeFiles(destination);
     debug("finished writing the files");

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

@@ -1,6 +1,6 @@
 import nodePath from "node:path";
 import { Coder } from "./coder.js";
-import { ContextCoder } from "./context-coder.js";
+import { ContextTypeCoder } from "./context-type-coder.js";
 import { ParametersTypeCoder } from "./parameters-type-coder.js";
 import { ResponseTypeCoder } from "./response-type-coder.js";
 import { SchemaTypeCoder } from "./schema-type-coder.js";
@@ -49,7 +49,7 @@ export class OperationTypeCoder extends Coder {
             .replaceAll("\\", "/")}.types.ts`;
     }
     write(script) {
-        const contextImportName = script.importDefault(new ContextCoder(this.requirement));
+        const contextTypeImportName = script.importType(new ContextTypeCoder(this.requirement));
         const parameters = this.requirement.get("parameters");
         const queryType = parameters === undefined
             ? "never"
@@ -71,6 +71,6 @@ export class OperationTypeCoder extends Coder {
         const responseType = new ResponseTypeCoder(this.requirement.get("responses"), this.requirement.get("produces")?.data ??
             this.requirement.specification?.rootRequirement?.get("produces")?.data).write(script);
         const proxyType = "(url: string) => { proxyUrl: string }";
-        return `({ query, path, header, body, context, proxy }: { query: ${queryType}, path: ${pathType}, header: ${headerType}, body: ${bodyType}, context: typeof ${contextImportName}, response: ${responseType}, proxy: ${proxyType} }) => ${this.responseTypes(script)} | { status: 415, contentType: "text/plain", body: string } | void`;
+        return `({ query, path, header, body, context, proxy }: { query: ${queryType}, path: ${pathType}, header: ${headerType}, body: ${bodyType}, context: ${contextTypeImportName}, response: ${responseType}, proxy: ${proxyType} }) => ${this.responseTypes(script)} | { status: 415, contentType: "text/plain", body: string } | void`;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.26.2",
+  "version": "0.27.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -44,10 +44,10 @@
   },
   "devDependencies": {
     "@changesets/cli": "2.26.2",
-    "@stryker-mutator/core": "7.1.1",
-    "@stryker-mutator/jest-runner": "7.1.1",
-    "@stryker-mutator/typescript-checker": "7.1.1",
-    "@swc/core": "1.3.88",
+    "@stryker-mutator/core": "7.2.0",
+    "@stryker-mutator/jest-runner": "7.2.0",
+    "@stryker-mutator/typescript-checker": "7.2.0",
+    "@swc/core": "1.3.92",
     "@swc/jest": "0.2.29",
     "@testing-library/dom": "9.3.3",
     "@types/jest": "29.5.5",
@@ -57,14 +57,14 @@
     "@types/koa-proxy": "1.0.5",
     "@types/koa-static": "4.0.2",
     "copyfiles": "2.4.1",
-    "eslint": "8.50.0",
-    "eslint-config-hardcore": "41.2.0",
+    "eslint": "8.51.0",
+    "eslint-config-hardcore": "41.3.0",
     "eslint-formatter-github-annotations": "0.1.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-etc": "2.0.3",
     "eslint-plugin-file-progress": "1.3.0",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jest": "27.4.0",
+    "eslint-plugin-jest": "27.4.2",
     "eslint-plugin-jest-dom": "5.1.0",
     "eslint-plugin-no-explicit-type-exports": "0.12.1",
     "eslint-plugin-unused-imports": "3.0.0",
@@ -73,12 +73,12 @@
     "node-mocks-http": "1.13.0",
     "nodemon": "3.0.1",
     "patch-package": "8.0.0",
-    "rimraf": "5.0.1",
+    "rimraf": "5.0.5",
     "stryker-cli": "1.0.2",
     "supertest": "6.3.3"
   },
   "dependencies": {
-    "@hapi/accept": "6.0.2",
+    "@hapi/accept": "6.0.3",
     "@types/json-schema": "7.0.13",
     "chokidar": "3.5.3",
     "commander": "11.0.0",
@@ -94,7 +94,7 @@
     "koa": "2.14.2",
     "koa-bodyparser": "4.4.1",
     "koa-proxy": "1.0.0-alpha.3",
-    "koa2-swagger-ui": "5.9.0",
+    "koa2-swagger-ui": "5.9.1",
     "node-fetch": "3.3.2",
     "open": "9.1.0",
     "prettier": "3.0.3",