counterfact 0.25.0 → 0.25.1

package/.github/workflows/debug-windows.yaml

@@ -35,5 +35,5 @@ jobs:
       - name: Install Packages
         run: yarn install --frozen-lockfile --network-timeout 100000
       - name: Try running the petstore
-        run: npx . https://petstore3.swagger.io/api/v3/openapi.json out
+        run: npx . ./openapi-example.yaml out
         timeout-minutes: 2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # counterfact
 
+## 0.25.1
+
+### Patch Changes
+
+- 226ce37: fixed a couple more issues in Windows
+
 ## 0.25.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.25.0",
+  "version": "0.25.1",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",

package/src/server/module-loader.js

@@ -2,12 +2,16 @@ import fs from "node:fs/promises";
 import { existsSync } from "node:fs";
 import nodePath from "node:path";
 import { once } from "node:events";
+import { pathToFileURL } from "node:url";
 
 import chokidar from "chokidar";
+import createDebug from "debug";
 
 import { ContextRegistry } from "./context-registry.js";
 import { CHOKIDAR_OPTIONS } from "./constants.js";
 
+const debug = createDebug("counterfact:typescript-generator:module-loader");
+
 export class ModuleLoader extends EventTarget {
   basePath;
 
@@ -28,6 +32,7 @@ export class ModuleLoader extends EventTarget {
     this.watcher = chokidar
       .watch(`${this.basePath}/**/*.{js,mjs,ts,mts}`, CHOKIDAR_OPTIONS)
 
+      // eslint-disable-next-line max-statements
       .on("all", (eventName, pathNameOriginal) => {
         const pathName = pathNameOriginal.replaceAll("\\", "/");
 
@@ -47,10 +52,15 @@ export class ModuleLoader extends EventTarget {
           return;
         }
 
+        const fileUrl = `${pathToFileURL(pathName)}?cacheBust=${Date.now()}`;
+
+        debug("importing module: %s", fileUrl);
+
         // eslint-disable-next-line  import/no-dynamic-require, no-unsanitized/method
-        import(`${pathName}?cacheBust=${Date.now()}`)
+        import(fileUrl)
           // eslint-disable-next-line promise/prefer-await-to-then
           .then((endpoint) => {
+            debug("imported module: %s", fileUrl);
             this.dispatchEvent(new Event(eventName), pathName);
 
             if (pathName.includes("$.context")) {
@@ -65,7 +75,7 @@ export class ModuleLoader extends EventTarget {
           })
           // eslint-disable-next-line promise/prefer-await-to-then
           .catch((error) => {
-            process.stdout.write(`\nError loading ${pathName}:\n${error}\n`);
+            process.stdout.write(`\nError loading ${fileUrl}:\n${error}\n`);
           });
       });
 
@@ -111,8 +121,14 @@ export class ModuleLoader extends EventTarget {
         .replaceAll("\\", "/");
 
       try {
-        // eslint-disable-next-line  import/no-dynamic-require, no-unsanitized/method
-        const endpoint = await import(fullPath);
+        const fileUrl = `${pathToFileURL(fullPath)}?cacheBust=${Date.now()}`;
+
+        debug("* importing module: %s", fileUrl);
+
+        // eslint-disable-next-line import/no-dynamic-require, no-unsanitized/method
+        const endpoint = await import(fileUrl);
+
+        debug("* imported module: %s", fileUrl);
 
         if (file.name.includes("$.context")) {
           this.contextRegistry.add(`/${directory}`, endpoint.default);

package/src/server/start.js

@@ -1,6 +1,6 @@
 /* eslint-disable max-statements */
-import nodePath from "node:path";
-import { pathToFileURL } from "node:url";
+import nodePath, { dirname } from "node:path";
+import { pathToFileURL, fileURLToPath } from "node:url";
 
 import yaml from "js-yaml";
 import Koa from "koa";
@@ -13,7 +13,7 @@ import { readFile } from "../util/read-file.js";
 import { counterfact } from "./counterfact.js";
 
 // eslint-disable-next-line no-underscore-dangle
-const __dirname = nodePath.dirname(new URL(import.meta.url).pathname);
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 const DEFAULT_PORT = 3100;
 

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

@@ -41,11 +41,7 @@ class Context {
       return "new Context()";
     }
 
-    const parentPath = nodePath.normalize(
-      nodePath.join(script.path, "../../$.context.ts").replaceAll("\\", "/")
-    );
-
-    script.repository.get(parentPath).exportDefault(this);
+    script.repository.get(script.path).exportDefault(this);
 
     return { raw: 'export { default } from "../$.context.mjs"' };
   }

package/src/typescript-generator/generate.js

@@ -6,6 +6,7 @@ import { OperationCoder } from "./operation-coder.js";
 
 const debug = createDebug("counterfact:typescript-generator:generate");
 
+// eslint-disable-next-line max-statements
 export async function generate(
   source,
   destination,
@@ -23,7 +24,7 @@ export async function generate(
 
   const paths = await specification.requirementAt("#/paths");
 
-  debug("got %n paths", paths.size);
+  debug("got %i paths", paths.size);
 
   paths.forEach((pathDefinition, key) => {
     debug("processing path %s", key);
@@ -35,4 +36,6 @@ export async function generate(
   debug("telling the repository to write the files to %s", destination);
 
   await repository.writeFiles(destination);
+
+  debug("finished writing the files");
 }

package/src/typescript-generator/repository.js

@@ -1,13 +1,19 @@
-import nodePath from "node:path";
+import nodePath, { dirname } from "node:path";
 import fs from "node:fs/promises";
 import { constants as fsConstants } from "node:fs";
+import { fileURLToPath } from "node:url";
 
 import prettier from "prettier";
+import createDebug from "debug";
 
 import { Script } from "./script.js";
 
+const debug = createDebug("counterfact:typescript-generator:repository");
+
 // eslint-disable-next-line no-underscore-dangle
-const __dirname = nodePath.dirname(new URL(import.meta.url).pathname);
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+debug("dirname is %s", __dirname);
 
 async function ensureDirectoryExists(filePath) {
   const directory = nodePath.dirname(filePath);
@@ -25,10 +31,16 @@ export class Repository {
   }
 
   get(path) {
+    debug("getting script at %s", path);
+
     if (this.scripts.has(path)) {
+      debug("already have script %s, returning it", path);
+
       return this.scripts.get(path);
     }
 
+    debug("don't have %s, creating it", path);
+
     const script = new Script(this, path);
 
     this.scripts.set(path, script);
@@ -40,6 +52,7 @@ export class Repository {
     while (
       Array.from(this.scripts.values()).some((script) => script.isInProgress())
     ) {
+      debug("waiting for %i scripts to finish", this.scripts.size);
       // eslint-disable-next-line no-await-in-loop
       await Promise.all(
         Array.from(this.scripts.values(), (script) => script.finished())
@@ -48,7 +61,7 @@ export class Repository {
   }
 
   copyCoreFiles(destination) {
-    const files = ["package.json", "response-builder-factory.ts"];
+    const files = ["response-builder-factory.ts"];
 
     return files.map((file) => {
       const path = nodePath.join(destination, file).replaceAll("\\", "/");
@@ -65,7 +78,12 @@ export class Repository {
   }
 
   async writeFiles(destination) {
+    debug(
+      "waiting for %i or more scripts to finish before writing files",
+      this.scripts.size
+    );
     await this.finished();
+    debug("all %i scripts are finished", this.scripts.size);
 
     const writeFiles = Array.from(
       this.scripts.entries(),
@@ -90,7 +108,9 @@ export class Repository {
           return;
         }
 
+        debug("about to write", fullPath);
         await fs.writeFile(fullPath, contents);
+        debug("did write", fullPath);
 
         process.stdout.write(`writing ${fullPath}\n`);
       }

package/src/typescript-generator/script.js

@@ -1,6 +1,9 @@
 import nodePath from "node:path";
 
 import prettier from "prettier";
+import createDebugger from "debug";
+
+const debug = createDebugger("counterfact:typescript-generator:script");
 
 export class Script {
   constructor(repository, path) {
@@ -73,15 +76,24 @@ export class Script {
     this.export(coder, isType, true);
   }
 
+  // eslint-disable-next-line max-statements
   import(coder, isType = false, isDefault = false) {
+    debug("import coder: %s", coder.id);
+
     const modulePath = coder.modulePath();
 
     const cacheKey = `${coder.id}@${modulePath}:${isType}:${isDefault}`;
 
+    debug("cache key: %s", cacheKey);
+
     if (this.cache.has(cacheKey)) {
+      debug("cache hit: %s", cacheKey);
+
       return this.cache.get(cacheKey);
     }
 
+    debug("cache miss: %s", cacheKey);
+
     const name = this.firstUniqueName(coder);
 
     this.cache.set(cacheKey, name);

package/templates/package.json

@@ -1,4 +0,0 @@
-{
-    "description": "This file ensures the .ts files herein are treated as ESM modules. If you have another package.json with type: module in a parent directory, you can delete this file.",
-    "type": "module"
-}