counterfact 0.35.0 → 0.37.0

package/README.md

@@ -62,4 +62,4 @@ If your mocking needs are relatively simple and you're shopping for someone who
 
 We value _all_ of your feedback and contributions, including 💌 love letters , 💡 feature requests, 🐞 bug reports, and ✍️ grammatical nit-picks in the docs. Please [create an issue](https://github.com/pmcelhaney/counterfact/issues/new), open a pull request, or reach out to <pmcelhaney@gmail.com>.
 
-**Welcom to the bottom of the README club! Since you've come this far, go ahead and smash that like and subsc… er, uh, give this project a ⭐️ on Github!** 🙏🏼
+**Welcome to the bottom of the README club! Since you've come this far, go ahead and smash that like and subsc… er, uh, give this project a ⭐️ on GitHub!** 🙏🏼

package/bin/counterfact.js

@@ -8,7 +8,6 @@ import { program } from "commander";
 import createDebug from "debug";
 import open from "open";
 
-import { migrate } from "../dist/migrations/0.27.js";
 import { counterfact } from "../dist/server/app.js";
 
 const taglinesFile = await readFile(
@@ -44,10 +43,6 @@ async function main(source, destination) {
     .join(process.cwd(), destination)
     .replaceAll("\\", "/");
 
-  debug("migrating code from before 0.27.0");
-  migrate(destinationPath);
-  debug("done with migration");
-
   const basePath = nodePath.resolve(destinationPath).replaceAll("\\", "/");
 
   debug("options: %o", options);

package/dist/client/index.html.hbs

@@ -132,7 +132,7 @@ it up later. In the mean time, I welcome pull requests. :)
       <a href="./swagger" class="button" target="_blank">Swagger UI</a>
       <a href="{{openApiHref}}" class="button" target="_blank">OpenAPI</a>
       <a href="https://counterfact.dev/docs/usage.html" target="_blank">Usage Guide</a>
-      <a href="https://github.com/pmcelhaney/counterfact" target="_blank">Github</a>
+      <a href="https://github.com/pmcelhaney/counterfact" target="_blank">GitHub</a>
     </div>
 
 

package/dist/server/code-generator.js

@@ -1,10 +1,12 @@
 import { watch } from "chokidar";
 import { generate } from "../typescript-generator/generate.js";
-export class CodeGenerator {
+import { waitForEvent } from "../util/wait-for-event.js";
+export class CodeGenerator extends EventTarget {
     openapiPath;
     destination;
     watcher;
     constructor(openApiPath, destination) {
+        super();
         this.openapiPath = openApiPath;
         this.destination = destination;
     }
@@ -14,8 +16,16 @@ export class CodeGenerator {
             return;
         }
         this.watcher = watch(this.openapiPath).on("change", () => {
-            void generate(this.openapiPath, this.destination);
+            // eslint-disable-next-line promise/prefer-await-to-then
+            void generate(this.openapiPath, this.destination).then(() => {
+                this.dispatchEvent(new Event("generate"));
+                return true;
+            }, () => {
+                this.dispatchEvent(new Event("failed"));
+                return false;
+            });
         });
+        await waitForEvent(this.watcher, "ready");
     }
     async stopWatching() {
         await this.watcher?.close();

package/dist/server/config.js

@@ -1 +1 @@
-export {};
+export const DUMMY_EXPORT_FOR_TEST_COVERAGE = 1;

package/dist/server/context-registry.js

@@ -1,20 +1,20 @@
+// eslint-disable-next-line max-classes-per-file
+export class Context {
+    // eslint-disable-next-line @typescript-eslint/no-useless-constructor, @typescript-eslint/no-empty-function
+    constructor() { }
+}
 export function parentPath(path) {
     return String(path.split("/").slice(0, -1).join("/")) || "/";
 }
 export class ContextRegistry {
     entries = new Map();
+    cache = new Map();
     constructor() {
         this.add("/", {});
     }
     add(path, context) {
-        if (context === 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);
+        this.cache.set(path, structuredClone(context));
     }
     find(path) {
         return this.entries.get(path) ?? this.find(parentPath(path));
@@ -25,12 +25,12 @@ export class ContextRegistry {
         }
         const context = this.find(path);
         for (const property in updatedContext) {
-            if (Object.prototype.hasOwnProperty.call(updatedContext, property) &&
-                !Object.prototype.hasOwnProperty.call(context, property)) {
+            if (updatedContext[property] !== this.cache.get(path)?.[property]) {
                 context[property] = updatedContext[property];
             }
         }
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         Object.setPrototypeOf(context, Object.getPrototypeOf(updatedContext));
+        this.cache.set(path, structuredClone(updatedContext));
     }
 }

package/dist/server/module-loader.js

@@ -7,6 +7,9 @@ import { watch } from "chokidar";
 import createDebug from "debug";
 import { ContextRegistry } from "./context-registry.js";
 const debug = createDebug("counterfact:typescript-generator:module-loader");
+function isContextModule(module) {
+    return "Context" in module && typeof module.Context === "function";
+}
 function reportLoadError(error, fileUrl) {
     if (String(error) ===
         "SyntaxError: Identifier 'Context' has already been declared") {
@@ -31,6 +34,10 @@ export class ModuleLoader extends EventTarget {
         // eslint-disable-next-line max-statements
         (eventName, pathNameOriginal) => {
             const pathName = pathNameOriginal.replaceAll("\\", "/");
+            if (pathName.includes("$.context") && eventName === "add") {
+                process.stdout.write(`\n\n!!! The file at ${pathName} needs a minor update.\n    See https://github.com/pmcelhaney/counterfact/blob/main/docs/context-change.md\n\n\n`);
+                return;
+            }
             if (!["add", "change", "unlink"].includes(eventName)) {
                 return;
             }
@@ -49,10 +56,11 @@ export class ModuleLoader extends EventTarget {
                 // eslint-disable-next-line promise/prefer-await-to-then
                 .then((endpoint) => {
                 this.dispatchEvent(new Event(eventName));
-                if (pathName.includes("$.context")) {
+                if (pathName.includes("_.context")) {
                     this.contextRegistry.update(parts.dir, 
-                    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-                    endpoint.default);
+                    // @ts-expect-error TS says Context has no constructable signatures but that's not true?
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/consistent-type-assertions
+                    new endpoint.Context());
                     return "context";
                 }
                 // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -92,15 +100,19 @@ export class ModuleLoader extends EventTarget {
         });
         await Promise.all(imports);
     }
+    // eslint-disable-next-line max-statements
     async loadEndpoint(fullPath, directory, file) {
         const fileUrl = `${pathToFileURL(fullPath).toString()}?cacheBust=${Date.now()}`;
         try {
             // eslint-disable-next-line import/no-dynamic-require, no-unsanitized/method, @typescript-eslint/consistent-type-assertions
             const endpoint = (await import(fileUrl));
-            if (file.name.includes("$.context")) {
-                this.contextRegistry.add(`/${directory.replaceAll("\\", "/")}`, 
-                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-                endpoint.default);
+            if (file.name.includes("_.context")) {
+                if (isContextModule(endpoint)) {
+                    this.contextRegistry.add(`/${directory.replaceAll("\\", "/")}`, 
+                    // @ts-expect-error TS says Context has no constructable signatures but that's not true?
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    new endpoint.Context());
+                }
             }
             else {
                 const url = `/${nodePath.join(directory, nodePath.parse(file.name).name)}`

package/dist/typescript-generator/context-file-token.js

@@ -0,0 +1 @@
+export const CONTEXT_FILE_TOKEN = "@@CONTEXT_FILE_TOKEN@@";

package/dist/typescript-generator/generate.js

@@ -3,7 +3,6 @@ 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";
@@ -29,11 +28,11 @@ async function buildCacheDirectory(destination) {
 }
 async function getPathsFromSpecification(specification) {
     try {
-        return await specification.requirementAt("#/paths");
+        return (await specification.requirementAt("#/paths")) ?? new Set();
     }
     catch (error) {
         process.stderr.write(`Could not find #/paths in the specification.\n${error}\n`);
-        return [];
+        return new Set();
     }
 }
 // eslint-disable-next-line max-statements
@@ -54,7 +53,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));
+    //   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/typescript-generator/operation-type-coder.js

@@ -1,6 +1,6 @@
 import nodePath from "node:path";
 import { Coder } from "./coder.js";
-import { ContextTypeCoder } from "./context-type-coder.js";
+import { CONTEXT_FILE_TOKEN } from "./context-file-token.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 contextTypeImportName = script.importType(new ContextTypeCoder(this.requirement));
+        const contextTypeImportName = script.importExternalType("Context", CONTEXT_FILE_TOKEN);
         const parameters = this.requirement.get("parameters");
         const queryType = parameters === undefined
             ? "never"

package/dist/typescript-generator/repository.js

@@ -1,8 +1,10 @@
+import { existsSync } from "node:fs";
 import fs from "node:fs/promises";
 import nodePath, { dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 import createDebug from "debug";
 import { ensureDirectoryExists } from "../util/ensure-directory-exists.js";
+import { CONTEXT_FILE_TOKEN } from "./context-file-token.js";
 import { Script } from "./script.js";
 const debug = createDebug("counterfact:server:repository");
 // eslint-disable-next-line no-underscore-dangle
@@ -30,10 +32,20 @@ export class Repository {
             await Promise.all(Array.from(this.scripts.values(), (script) => script.finished()));
         }
     }
-    copyCoreFiles(destination) {
+    async copyCoreFiles(destination) {
+        const sourcePath = nodePath
+            .join(__dirname, "../../dist/server/types.d.ts")
+            .replaceAll("\\", "/");
+        if (!existsSync(sourcePath)) {
+            return false;
+        }
+        const destinationPath = nodePath
+            .join(destination, "types.d.ts")
+            .replaceAll("\\", "/");
+        await ensureDirectoryExists(destination);
         return fs.copyFile(nodePath
             .join(__dirname, "../../dist/server/types.d.ts")
-            .replaceAll("\\", "/"), nodePath.join(destination, "types.d.ts").replaceAll("\\", "/"));
+            .replaceAll("\\", "/"), destinationPath);
     }
     async writeFiles(destination) {
         debug("waiting for %i or more scripts to finish before writing files", this.scripts.size);
@@ -52,10 +64,47 @@ export class Repository {
                 return;
             }
             debug("about to write", fullPath);
-            await fs.writeFile(fullPath, contents);
+            await fs.writeFile(fullPath, contents.replaceAll(CONTEXT_FILE_TOKEN, this.findContextPath(destination, path)));
             debug("did write", fullPath);
         });
         await Promise.all(writeFiles);
         await this.copyCoreFiles(destination);
+        await this.createDefaultContextFile(destination);
+    }
+    async createDefaultContextFile(destination) {
+        const contextFilePath = nodePath.join(destination, "paths", "_.context.ts");
+        if (existsSync(contextFilePath)) {
+            return;
+        }
+        await ensureDirectoryExists(contextFilePath);
+        await fs.writeFile(contextFilePath, `/**
+* This is the default context for Counterfact.
+*
+* It defines the context object in the REPL 
+* and the $.context object in the code.
+*
+* Add properties and methods to suit your needs.
+* 
+* See https://counterfact.dev/docs/usage.html#working-with-state-the-codecontextcode-object-and-codecontexttscode
+*/
+export class Context {
+
+}
+`);
+    }
+    findContextPath(destination, path) {
+        return nodePath.relative(nodePath.join(destination, nodePath.dirname(path)), this.nearestContextFile(destination, path));
+    }
+    nearestContextFile(destination, path) {
+        const directory = nodePath.dirname(path).replace("path-types", "paths");
+        const candidate = nodePath.join(destination, directory, "_.context.ts");
+        if (directory.length <= 1) {
+            // No _context.ts was found so import the one that should be in the root
+            return nodePath.join(destination, "paths", "_.context.ts");
+        }
+        if (existsSync(candidate)) {
+            return candidate;
+        }
+        return this.nearestContextFile(destination, nodePath.join(path, ".."));
     }
 }

package/dist/util/wait-for-event.js

@@ -0,0 +1,23 @@
+/**
+ * Creates a promise that resolves when a specified event is fired on the given EventTarget.
+ * @param {EventTarget | EventEmitter} target - The target to listen for the event on.
+ * @param {string} eventName - The name of the event to listen for.
+ * @returns {Promise<Event>} A promise that resolves with the event object when the event is fired.
+ */
+export async function waitForEvent(target, eventName) {
+    // eslint-disable-next-line promise/avoid-new
+    return await new Promise((resolve) => {
+        const handler = (event) => {
+            if (target instanceof EventTarget) {
+                target.removeEventListener(eventName, handler);
+            }
+            resolve(event);
+        };
+        if (target instanceof EventTarget) {
+            target.addEventListener(eventName, handler);
+        }
+        else {
+            target.once(eventName, handler);
+        }
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.35.0",
+  "version": "0.37.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -18,7 +18,7 @@
     "testing"
   ],
   "engines": {
-    "node": ">=16.9.0"
+    "node": ">=17.0.0"
   },
   "bin": {
     "counterfact": "./bin/counterfact.js"
@@ -28,7 +28,7 @@
     "dist"
   ],
   "scripts": {
-    "test": "yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest --testPathIgnorePatterns=black-box --forceExit",
+    "test": "yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest --testPathIgnorePatterns=black-box",
     "test:black-box": "rimraf dist && rimraf out && yarn build && yarn node --experimental-vm-modules ./node_modules/jest-cli/bin/jest black-box --forceExit --coverage=false",
     "test:mutants": "stryker run stryker.config.json",
     "build": "tsc && copyfiles -f \"src/client/**\" dist/client && copyfiles -f \"src/server/*.d.ts\" dist/server",
@@ -44,13 +44,13 @@
   },
   "devDependencies": {
     "@changesets/cli": "2.27.1",
-    "@stryker-mutator/core": "8.0.0",
-    "@stryker-mutator/jest-runner": "8.0.0",
-    "@stryker-mutator/typescript-checker": "8.0.0",
-    "@swc/core": "1.3.102",
-    "@swc/jest": "0.2.29",
+    "@stryker-mutator/core": "8.2.3",
+    "@stryker-mutator/jest-runner": "8.2.3",
+    "@stryker-mutator/typescript-checker": "8.2.3",
+    "@swc/core": "1.4.0",
+    "@swc/jest": "0.2.36",
     "@testing-library/dom": "9.3.4",
-    "@types/jest": "29.5.11",
+    "@types/jest": "29.5.12",
     "@types/js-yaml": "4.0.9",
     "@types/koa": "2.14.0",
     "@types/koa-bodyparser": "4.3.12",
@@ -68,21 +68,21 @@
     "eslint-plugin-jest-dom": "5.1.0",
     "eslint-plugin-no-explicit-type-exports": "0.12.1",
     "eslint-plugin-unused-imports": "3.0.0",
-    "husky": "8.0.3",
+    "husky": "9.0.10",
     "jest": "29.7.0",
     "node-mocks-http": "1.14.1",
-    "nodemon": "3.0.2",
+    "nodemon": "3.0.3",
     "patch-package": "8.0.0",
     "rimraf": "5.0.5",
     "stryker-cli": "1.0.2",
     "supertest": "6.3.4",
-    "using-temporary-files": "2.1.0"
+    "using-temporary-files": "2.1.1"
   },
   "dependencies": {
     "@hapi/accept": "6.0.3",
     "@types/json-schema": "7.0.15",
-    "chokidar": "3.5.3",
-    "commander": "11.1.0",
+    "chokidar": "3.6.0",
+    "commander": "12.0.0",
     "debug": "4.3.4",
     "fetch": "1.1.0",
     "fs-extra": "11.2.0",
@@ -98,7 +98,7 @@
     "koa2-swagger-ui": "5.10.0",
     "node-fetch": "3.3.2",
     "open": "10.0.3",
-    "prettier": "3.2.2",
+    "prettier": "3.2.5",
     "typescript": "5.3.3"
   }
 }

package/dist/migrations/0.27.js

@@ -1,39 +0,0 @@
-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 = 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/typescript-generator/context-coder.js

@@ -1,41 +0,0 @@
-import nodePath from "node:path";
-import { Coder } from "./coder.js";
-export class ContextCoder extends Coder {
-    pathString() {
-        return this.requirement.url
-            .split("/")
-            .at(-2)
-            .replaceAll("~1", "/")
-            .replaceAll("~0", "~");
-    }
-    get id() {
-        return "ContextCoder";
-    }
-    names() {
-        return super.names("Context");
-    }
-    beforeExport(path) {
-        return `/**
-* This is the default context for Counterfact.
-* Change the code to suit your needs.
-*/
-class Context {
-  // delete this line to make the class type safe
-  [key: string]: any; 
-
-  // A helper when you accessing the context object via the REPL. You can delete it if you like.
-  [Symbol.for('nodejs.util.inspect.custom')](depth, options, inspect) {
-    return inspect(this, { ...options, customInspect: false }) + "\\n\\n ^ This is the default context object. You can edit its definition at ${path}";
-  }
-}
-`;
-    }
-    write() {
-        return "new Context()";
-    }
-    modulePath() {
-        return nodePath
-            .join("paths", nodePath.dirname(this.pathString()), "$.context.ts")
-            .replaceAll("\\", "/");
-    }
-}

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

@@ -1,32 +0,0 @@
-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 "Context";
-        }
-        return { raw: 'export type { ContextType } from "../$.context"' };
-    }
-    modulePath() {
-        return nodePath
-            .join("paths", nodePath.dirname(this.pathString()), "$.context.ts")
-            .replaceAll("\\", "/");
-    }
-}