counterfact 1.1.7 → 1.3.0

package/bin/counterfact.js

@@ -135,6 +135,7 @@ async function main(source, destination) {
   const swaggerUrl = `${url}/counterfact/swagger/`;
 
   const config = {
+    alwaysFakeOptionals: options.alwaysFakeOptionals,
     basePath,
 
     generate: {
@@ -268,5 +269,9 @@ program
     "base path from which routes will be served (e.g. /api/v1)",
     "",
   )
+  .option(
+    "--always-fake-optionals",
+    "random responses will include optional fields",
+  )
   .action(main)
   .parse(process.argv);

package/dist/app.js

@@ -32,7 +32,7 @@ export async function counterfact(config) {
     const registry = new Registry();
     const contextRegistry = new ContextRegistry();
     const codeGenerator = new CodeGenerator(config.openApiPath, config.basePath, config.generate);
-    const dispatcher = new Dispatcher(registry, contextRegistry, await loadOpenApiDocument(config.openApiPath));
+    const dispatcher = new Dispatcher(registry, contextRegistry, await loadOpenApiDocument(config.openApiPath), config);
     const transpiler = new Transpiler(nodePath.join(modulesPath, "routes").replaceAll("\\", "/"), compiledPathsDirectory, "commonjs");
     const moduleLoader = new ModuleLoader(compiledPathsDirectory, registry, contextRegistry);
     const middleware = koaMiddleware(dispatcher, config);

package/dist/server/dispatcher.js

@@ -9,11 +9,13 @@ export class Dispatcher {
     contextRegistry;
     openApiDocument;
     fetch;
-    constructor(registry, contextRegistry, openApiDocument) {
+    config; // Add config property
+    constructor(registry, contextRegistry, openApiDocument, config) {
         this.registry = registry;
         this.contextRegistry = contextRegistry;
         this.openApiDocument = openApiDocument;
         this.fetch = fetch;
+        this.config = config;
     }
     parameterTypes(parameters) {
         const types = {
@@ -60,14 +62,6 @@ export class Dispatcher {
         return operation;
     }
     normalizeResponse(response, acceptHeader) {
-        if (typeof response === "string") {
-            return {
-                body: response,
-                contentType: "text/plain",
-                headers: {},
-                status: 200,
-            };
-        }
         if (response.content !== undefined) {
             const content = this.selectContent(acceptHeader, response.content);
             if (content === undefined) {
@@ -87,7 +81,9 @@ export class Dispatcher {
         }
         return {
             ...response,
-            contentType: response.headers?.["content-type"]?.toString() ?? "unknown/unknown",
+            contentType: response.headers?.["content-type"]?.toString() ??
+                response.contentType ??
+                "unknown/unknown",
         };
     }
     selectContent(acceptHeader, content) {
@@ -147,7 +143,7 @@ export class Dispatcher {
             },
             query,
             // @ts-expect-error - Might be pushing the limits of what TypeScript can do here
-            response: createResponseBuilder(operation ?? { responses: {} }),
+            response: createResponseBuilder(operation ?? { responses: {} }, this.config), // Pass config
             tools: new Tools({ headers }),
         });
         if (response === undefined) {

package/dist/server/module-loader.js

@@ -15,6 +15,11 @@ const debug = createDebug("counterfact:server:module-loader");
 function isContextModule(module) {
     return "Context" in module && typeof module.Context === "function";
 }
+function isMiddlewareModule(module) {
+    return ("middleware" in module &&
+        typeof Object.getOwnPropertyDescriptor(module, "middleware")?.value ===
+            "function");
+}
 export class ModuleLoader extends EventTarget {
     basePath;
     registry;
@@ -96,23 +101,27 @@ export class ModuleLoader extends EventTarget {
             const doImport = (await determineModuleKind(pathName)) === "commonjs"
                 ? uncachedRequire
                 : uncachedImport;
-            const endpoint = (await doImport(pathName));
+            const endpoint = (await doImport(pathName).catch((err) => {
+                console.log("ERROR");
+            }));
             this.dispatchEvent(new Event("add"));
-            if (basename(pathName).startsWith("_.context")) {
-                if (isContextModule(endpoint)) {
-                    const loadContext = (path) => this.contextRegistry.find(path);
-                    this.contextRegistry.update(directory, 
-                    // @ts-expect-error TS says Context has no constructable signatures but that's not true?
-                    new endpoint.Context({
-                        loadContext,
-                    }));
-                }
+            if (basename(pathName).startsWith("_.context.") &&
+                isContextModule(endpoint)) {
+                const loadContext = (path) => this.contextRegistry.find(path);
+                this.contextRegistry.update(directory, 
+                // @ts-expect-error TS says Context has no constructable signatures but that's not true?
+                new endpoint.Context({
+                    loadContext,
+                }));
+                return;
             }
-            else {
-                if (url === "/index")
-                    this.registry.add("/", endpoint);
-                this.registry.add(url, endpoint);
+            if (basename(pathName).startsWith("_.middleware.") &&
+                isMiddlewareModule(endpoint)) {
+                this.registry.addMiddleware(url.slice(0, url.lastIndexOf("/")) || "/", endpoint.middleware);
             }
+            if (url === "/index")
+                this.registry.add("/", endpoint);
+            this.registry.add(url, endpoint);
         }
         catch (error) {
             if (String(error) ===
@@ -120,8 +129,8 @@ export class ModuleLoader extends EventTarget {
                 // Not sure why Node throws this error. It doesn't seem to matter.
                 return;
             }
-            throw error;
             process.stdout.write(`\nError loading ${pathName}:\n${String(error)}\n`);
+            throw error;
         }
     }
 }

package/dist/server/module-tree.js

@@ -9,31 +9,38 @@ export class ModuleTree {
         name: "",
         rawName: "",
     };
-    addModuleToDirectory(directory, segments, module) {
-        if (directory === undefined) {
-            return;
-        }
+    putDirectory(directory, segments) {
         const [segment, ...remainingSegments] = segments;
         if (segment === undefined) {
             throw new Error("segments array is empty");
         }
         if (remainingSegments.length === 0) {
-            directory.files[segment.toLowerCase()] = {
-                isWildcard: segment.startsWith("{"),
-                module,
-                name: segment.replace(/^\{(?<name>.*)\}$/u, "$<name>"),
-                rawName: segment,
-            };
-            return;
+            return directory;
         }
-        directory.directories[segment.toLowerCase()] ??= {
+        const nextDirectory = (directory.directories[segment.toLowerCase()] ??= {
             directories: {},
             files: {},
             isWildcard: segment.startsWith("{"),
             name: segment.replace(/^\{(?<name>.*)\}$/u, "$<name>"),
             rawName: segment,
+        });
+        return this.putDirectory(nextDirectory, remainingSegments);
+    }
+    addModuleToDirectory(directory, segments, module) {
+        if (directory === undefined) {
+            return;
+        }
+        const targetDirectory = this.putDirectory(directory, segments);
+        const filename = segments.at(-1);
+        if (filename === undefined) {
+            throw new Error("The file name (the last segment of the URL) is undefined. This is theoretically impossible but TypeScript can't enforce it.");
+        }
+        targetDirectory.files[filename] = {
+            isWildcard: filename.startsWith("{"),
+            module,
+            name: filename.replace(/^\{(?<name>.*)\}$/u, "$<name>"),
+            rawName: filename,
         };
-        this.addModuleToDirectory(directory.directories[segment.toLocaleLowerCase()], remainingSegments, module);
     }
     add(url, module) {
         this.addModuleToDirectory(this.root, url.split("/").slice(1), module);

package/dist/server/registry.js

@@ -25,12 +25,19 @@ function castParameters(parameters = {}, parameterTypes = {}) {
 }
 export class Registry {
     moduleTree = new ModuleTree();
+    middlewares = new Map();
+    constructor() {
+        this.middlewares.set("/", ($, respondTo) => respondTo($));
+    }
     get routes() {
         return this.moduleTree.routes;
     }
     add(url, module) {
         this.moduleTree.add(url, module);
     }
+    addMiddleware(url, callback) {
+        this.middlewares.set(url, callback);
+    }
     remove(url) {
         this.moduleTree.remove(url);
     }
@@ -66,7 +73,37 @@ export class Registry {
                 query: castParameters(requestData.query, parameterTypes.query),
             };
             operationArgument.x = operationArgument;
-            return await execute(operationArgument);
+            const executeAndNormalizeResponse = async (requestData) => {
+                const result = await execute(requestData);
+                if (typeof result === "string") {
+                    return {
+                        headers: {},
+                        status: 200,
+                        body: result,
+                        contentType: "text/plain",
+                    };
+                }
+                if (typeof result === "undefined") {
+                    return {
+                        headers: {},
+                        body: `The ${httpRequestMethod} function did not return anything. Did you forget a return statement?`,
+                        status: 500,
+                    };
+                }
+                return result;
+            };
+            const middlewares = this.middlewares;
+            function recurse(path, respondTo) {
+                if (path === null)
+                    return respondTo;
+                const nextPath = path === "" ? null : path.slice(0, path.lastIndexOf("/"));
+                const middleware = middlewares.get(path);
+                if (middleware !== undefined) {
+                    return recurse(nextPath, ($) => middleware($, respondTo));
+                }
+                return recurse(nextPath, respondTo);
+            }
+            return recurse(operationArgument.matchedPath ?? "/", executeAndNormalizeResponse)(operationArgument);
         };
     }
 }

package/dist/server/response-builder.js

@@ -29,7 +29,7 @@ function unknownStatusCodeResponse(statusCode) {
         status: 500,
     };
 }
-export function createResponseBuilder(operation) {
+export function createResponseBuilder(operation, config) {
     return new Proxy({}, {
         get: (target, statusCode) => ({
             header(name, value) {
@@ -55,7 +55,7 @@ export function createResponseBuilder(operation) {
                 return {
                     ...this,
                     content: [
-                        ...(this.content ?? []),
+                        ...(this.content ?? []).filter((response) => response.type !== contentType),
                         {
                             body: convertToXmlIfNecessary(contentType, body, operation.responses[this.status ?? "default"]?.content?.[contentType]?.schema),
                             type: contentType,
@@ -64,6 +64,11 @@ export function createResponseBuilder(operation) {
                 };
             },
             random() {
+                if (config?.alwaysFakeOptionals) {
+                    JSONSchemaFaker.option("alwaysFakeOptionals", true);
+                    JSONSchemaFaker.option("fixedProbabilities", true);
+                    JSONSchemaFaker.option("optionalsProbability", 1.0);
+                }
                 if (operation.produces) {
                     return this.randomLegacy();
                 }

package/dist/server/types.ts

@@ -278,4 +278,5 @@ export type {
   ResponseBuilder,
   ResponseBuilderFactory,
   WideOperationArgument,
+  WideResponseBuilder,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "1.1.7",
+  "version": "1.3.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -44,11 +44,11 @@
     "postinstall": "patch-package"
   },
   "devDependencies": {
-    "@changesets/cli": "2.27.11",
+    "@changesets/cli": "2.29.2",
     "@stryker-mutator/core": "8.7.1",
     "@stryker-mutator/jest-runner": "8.7.1",
     "@stryker-mutator/typescript-checker": "8.7.1",
-    "@swc/core": "1.10.7",
+    "@swc/core": "1.11.21",
     "@swc/jest": "0.2.37",
     "@testing-library/dom": "10.4.0",
     "@types/jest": "29.5.14",
@@ -57,19 +57,19 @@
     "@types/koa-bodyparser": "4.3.12",
     "@types/koa-proxy": "1.0.7",
     "@types/koa-static": "4.0.4",
-    "@types/lodash": "4.17.14",
+    "@types/lodash": "4.17.16",
     "copyfiles": "2.4.1",
-    "eslint": "9.18.0",
+    "eslint": "9.25.0",
     "eslint-config-hardcore": "47.0.1",
     "eslint-formatter-github-annotations": "0.1.0",
-    "eslint-import-resolver-typescript": "3.7.0",
+    "eslint-import-resolver-typescript": "4.3.2",
     "eslint-plugin-etc": "2.0.3",
-    "eslint-plugin-file-progress": "3.0.1",
+    "eslint-plugin-file-progress": "3.0.2",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-jest": "28.11.0",
     "eslint-plugin-jest-dom": "5.5.0",
     "eslint-plugin-no-explicit-type-exports": "0.12.1",
-    "eslint-plugin-prettier": "5.2.2",
+    "eslint-plugin-prettier": "5.2.6",
     "eslint-plugin-unused-imports": "4.1.4",
     "husky": "9.1.7",
     "jest": "29.7.0",
@@ -77,35 +77,35 @@
     "node-mocks-http": "1.16.2",
     "rimraf": "6.0.1",
     "stryker-cli": "1.0.2",
-    "supertest": "7.0.0",
+    "supertest": "7.1.0",
     "using-temporary-files": "2.2.1"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "11.7.3",
+    "@apidevtools/json-schema-ref-parser": "12.0.1",
     "@hapi/accept": "6.0.3",
     "@types/json-schema": "7.0.15",
     "ast-types": "0.14.2",
     "chokidar": "4.0.3",
-    "commander": "13.0.0",
+    "commander": "13.1.0",
     "debug": "4.4.0",
     "fetch": "1.1.0",
     "fs-extra": "11.3.0",
     "handlebars": "4.7.8",
     "http-terminator": "3.2.0",
     "js-yaml": "4.1.0",
-    "json-schema-faker": "0.5.8",
+    "json-schema-faker": "0.5.9",
     "jsonwebtoken": "9.0.2",
-    "koa": "2.15.3",
+    "koa": "2.16.1",
     "koa-bodyparser": "4.4.1",
     "koa-proxies": "0.12.4",
     "koa2-swagger-ui": "5.11.0",
     "lodash": "4.17.21",
     "node-fetch": "3.3.2",
-    "open": "10.1.0",
+    "open": "10.1.1",
     "patch-package": "8.0.0",
-    "precinct": "12.1.2",
-    "prettier": "3.4.2",
-    "recast": "0.23.9",
-    "typescript": "5.7.3"
+    "precinct": "12.2.0",
+    "prettier": "3.5.3",
+    "recast": "0.23.11",
+    "typescript": "5.8.3"
   }
 }