counterfact 1.3.0 → 1.4.1

package/bin/counterfact.js

@@ -111,7 +111,7 @@ async function main(source, destination) {
 
   // If no action-related option is provided, default to all options
 
-  const actions = ["repl", "serve", "watch", "generate"];
+  const actions = ["repl", "serve", "watch", "generate", "buildCache"];
   if (
     !Object.keys(options).some((argument) =>
       actions.some((action) => argument.startsWith(action)),
@@ -143,13 +143,15 @@ async function main(source, destination) {
         options.generate ||
         options.generateRoutes ||
         options.watch ||
-        options.watchRoutes,
+        options.watchRoutes ||
+        options.buildCache,
 
       types:
         options.generate ||
         options.generateTypes ||
         options.watch ||
-        options.watchTypes,
+        options.watchTypes ||
+        options.buildCache,
     },
 
     openApiPath: source,
@@ -159,6 +161,7 @@ async function main(source, destination) {
     routePrefix: options.prefix,
     startRepl: options.repl,
     startServer: options.serve,
+    buildCache: options.buildCache || false,
 
     watch: {
       routes: options.watch || options.watchRoutes,
@@ -262,6 +265,7 @@ program
   .option("--watch-types", "generate + watch types for changes")
   .option("--watch-routes", "generate + watch routes for changes")
   .option("-s, --serve", "start the server")
+  .option("-b, --build-cache", "builds the cache of compiled routes and types")
   .option("-r, --repl", "start the REPL")
   .option("--proxy-url <string>", "proxy URL")
   .option(

package/dist/app.js

@@ -1,4 +1,4 @@
-import { rm } from "node:fs/promises";
+import fs, { rm } from "node:fs/promises";
 import nodePath from "node:path";
 import { dereference } from "@apidevtools/json-schema-ref-parser";
 import { createHttpTerminator } from "http-terminator";
@@ -6,14 +6,24 @@ import yaml from "js-yaml";
 import { startRepl } from "./repl/repl.js";
 import { ContextRegistry } from "./server/context-registry.js";
 import { createKoaApp } from "./server/create-koa-app.js";
-import { Dispatcher } from "./server/dispatcher.js";
+import { Dispatcher, } from "./server/dispatcher.js";
 import { koaMiddleware } from "./server/koa-middleware.js";
 import { ModuleLoader } from "./server/module-loader.js";
 import { Registry } from "./server/registry.js";
 import { Transpiler } from "./server/transpiler.js";
 import { CodeGenerator } from "./typescript-generator/code-generator.js";
 import { readFile } from "./util/read-file.js";
-async function loadOpenApiDocument(source) {
+const allowedMethods = [
+    "all",
+    "head",
+    "get",
+    "post",
+    "put",
+    "delete",
+    "patch",
+    "options",
+];
+export async function loadOpenApiDocument(source) {
     try {
         const text = await readFile(source);
         const openApiDocument = await yaml.load(text);
@@ -23,6 +33,50 @@ async function loadOpenApiDocument(source) {
         return undefined;
     }
 }
+const mswHandlers = {};
+export async function handleMswRequest(request) {
+    const { method, rawPath } = request;
+    const handler = mswHandlers[`${method}:${rawPath}`];
+    if (handler) {
+        return handler(request);
+    }
+    console.warn(`No handler found for ${method} ${rawPath}`);
+    return { error: `No handler found for ${method} ${rawPath}`, status: 404 };
+}
+export async function createMswHandlers(config, ModuleLoaderClass = ModuleLoader) {
+    // TODO: For some reason the Vitest Custom Commands needed by Vitest Browser mode fail on fs.readFile when they are called from the nested loadOpenApiDocument function.
+    // If we "pre-read" the file here it works. This is a workaround to avoid the issue.
+    const _ = await fs.readFile(config.openApiPath);
+    const openApiDocument = await loadOpenApiDocument(config.openApiPath);
+    if (openApiDocument === undefined) {
+        throw new Error(`Could not load OpenAPI document from ${config.openApiPath}`);
+    }
+    const modulesPath = config.basePath;
+    const compiledPathsDirectory = nodePath
+        .join(modulesPath, ".cache")
+        .replaceAll("\\", "/");
+    const registry = new Registry();
+    const contextRegistry = new ContextRegistry();
+    const dispatcher = new Dispatcher(registry, contextRegistry, openApiDocument, config);
+    const moduleLoader = new ModuleLoaderClass(compiledPathsDirectory, registry, contextRegistry);
+    await moduleLoader.load();
+    const routes = registry.routes;
+    const handlers = routes.flatMap((route) => {
+        const { methods, path } = route;
+        return Object.keys(methods)
+            .filter((method) => allowedMethods.includes(method.toLowerCase()))
+            .map((method) => {
+            const lowerMethod = method.toLowerCase();
+            const apiPath = `${openApiDocument.basePath ?? ""}${path.replaceAll("{", ":").replaceAll("}", "")}`;
+            const handler = async (request) => {
+                return await dispatcher.request(request);
+            };
+            mswHandlers[`${method}:${apiPath}`] = handler;
+            return { method: lowerMethod, path: apiPath };
+        });
+    });
+    return handlers;
+}
 export async function counterfact(config) {
     const modulesPath = config.basePath;
     const compiledPathsDirectory = nodePath
@@ -38,7 +92,7 @@ export async function counterfact(config) {
     const middleware = koaMiddleware(dispatcher, config);
     const koaApp = createKoaApp(registry, middleware, config);
     async function start(options) {
-        const { generate, startRepl: shouldStartRepl, startServer, watch, } = options;
+        const { generate, startRepl: shouldStartRepl, startServer, watch, buildCache, } = options;
         if (generate.routes || generate.types) {
             await codeGenerator.generate();
         }
@@ -57,6 +111,11 @@ export async function counterfact(config) {
                 server,
             });
         }
+        else if (buildCache) {
+            // If we are not starting the server, we still want to transpile and load modules
+            await transpiler.watch();
+            await transpiler.stopWatching();
+        }
         const replServer = shouldStartRepl && startRepl(contextRegistry, config);
         return {
             replServer,

package/dist/server/module-tree.js

@@ -67,7 +67,15 @@ export class ModuleTree {
         return file.module[method] !== undefined;
     }
     buildMatch(directory, segment, pathVariables, matchedPath, method) {
-        const match = directory.files[segment.toLowerCase()] ??
+        function normalizedSegment(segment, directory) {
+            for (const file in directory.files) {
+                if (file.toLowerCase() === segment.toLowerCase()) {
+                    return file;
+                }
+            }
+            return "";
+        }
+        const match = directory.files[normalizedSegment(segment, directory)] ??
             Object.values(directory.files).find((file) => file.isWildcard && this.fileModuleDefined(file, method));
         if (match === undefined) {
             return undefined;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "counterfact",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
-  "main": "./src/server/counterfact.js",
-  "exports": "./src/server/counterfact.js",
-  "types": "./src/counterfact.d.ts",
+  "main": "./dist/app.js",
+  "exports": "./dist/app.js",
+  "types": "./dist/server/types.d.ts",
   "author": "Patrick McElhaney <pmcelhaney@gmail.com> (https://patrickmcelhaney.com)",
   "license": "MIT",
   "repository": "github:pmcelhaney/counterfact",
@@ -44,50 +44,50 @@
     "postinstall": "patch-package"
   },
   "devDependencies": {
-    "@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.11.21",
-    "@swc/jest": "0.2.37",
+    "@changesets/cli": "2.29.4",
+    "@stryker-mutator/core": "9.0.1",
+    "@stryker-mutator/jest-runner": "9.0.1",
+    "@stryker-mutator/typescript-checker": "9.0.1",
+    "@swc/core": "1.12.1",
+    "@swc/jest": "0.2.38",
     "@testing-library/dom": "10.4.0",
-    "@types/jest": "29.5.14",
+    "@types/jest": "30.0.0",
     "@types/js-yaml": "4.0.9",
     "@types/koa": "2.15.0",
     "@types/koa-bodyparser": "4.3.12",
     "@types/koa-proxy": "1.0.7",
     "@types/koa-static": "4.0.4",
-    "@types/lodash": "4.17.16",
+    "@types/lodash": "4.17.17",
     "copyfiles": "2.4.1",
-    "eslint": "9.25.0",
+    "eslint": "9.28.0",
     "eslint-config-hardcore": "47.0.1",
     "eslint-formatter-github-annotations": "0.1.0",
-    "eslint-import-resolver-typescript": "4.3.2",
+    "eslint-import-resolver-typescript": "4.4.3",
     "eslint-plugin-etc": "2.0.3",
     "eslint-plugin-file-progress": "3.0.2",
     "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-jest": "28.11.0",
+    "eslint-plugin-jest": "28.14.0",
     "eslint-plugin-jest-dom": "5.5.0",
     "eslint-plugin-no-explicit-type-exports": "0.12.1",
-    "eslint-plugin-prettier": "5.2.6",
+    "eslint-plugin-prettier": "5.4.1",
     "eslint-plugin-unused-imports": "4.1.4",
     "husky": "9.1.7",
-    "jest": "29.7.0",
+    "jest": "30.0.0",
     "jest-retries": "1.0.1",
-    "node-mocks-http": "1.16.2",
+    "node-mocks-http": "1.17.2",
     "rimraf": "6.0.1",
     "stryker-cli": "1.0.2",
-    "supertest": "7.1.0",
+    "supertest": "7.1.1",
     "using-temporary-files": "2.2.1"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "12.0.1",
+    "@apidevtools/json-schema-ref-parser": "13.0.5",
     "@hapi/accept": "6.0.3",
     "@types/json-schema": "7.0.15",
     "ast-types": "0.14.2",
     "chokidar": "4.0.3",
-    "commander": "13.1.0",
-    "debug": "4.4.0",
+    "commander": "14.0.0",
+    "debug": "4.4.1",
     "fetch": "1.1.0",
     "fs-extra": "11.3.0",
     "handlebars": "4.7.8",
@@ -95,17 +95,18 @@
     "js-yaml": "4.1.0",
     "json-schema-faker": "0.5.9",
     "jsonwebtoken": "9.0.2",
-    "koa": "2.16.1",
+    "koa": "3.0.0",
     "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.1",
+    "open": "10.1.2",
     "patch-package": "8.0.0",
     "precinct": "12.2.0",
     "prettier": "3.5.3",
     "recast": "0.23.11",
     "typescript": "5.8.3"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }