@warp-drive/holodeck 0.0.1 → 0.1.0-alpha.14

package/README.md

@@ -1,15 +1,15 @@
 <p align="center">
   <img
     class="project-logo"
-    src="./logos/NCC-1701-a-blue.svg#gh-light-mode-only"
+    src="./logos/warp-drive-logo-dark.svg#gh-light-mode-only"
     alt="WarpDrive"
-    width="120px"
+    width="200px"
     title="WarpDrive" />
   <img
     class="project-logo"
-    src="./logos/NCC-1701-a.svg#gh-dark-mode-only"
+    src="./logos/warp-drive-logo-gold.svg#gh-dark-mode-only"
     alt="WarpDrive"
-    width="120px"
+    width="200px"
     title="WarpDrive" />
 </p>
 
@@ -163,10 +163,10 @@ const MockHost = `https://${window.location.hostname}:${Number(window.location.p
 setConfig({ host: MockHost });
 
 QUnit.hooks.beforeEach(function (assert) {
-  setTestId(assert.test.testId);
+  setTestId(this, assert.test.testId);
 });
 QUnit.hooks.afterEach(function (assert) {
-  setTestId(null);
+  setTestId(this, null);
 });
 ```
 
@@ -249,7 +249,7 @@ await launch({
     img.project-logo {
        padding: 0 5em 1em 5em;
        width: 100px;
-       border-bottom: 2px solid #0969da;
+       border-bottom: 2px solid #bbb;
        margin: 0 auto;
        display: block;
      }
@@ -265,7 +265,7 @@ await launch({
       display: inline-block;
       padding: .2rem 0;
       color: #000;
-      border-bottom: 3px solid #0969da;
+      border-bottom: 3px solid #bbb;
     }
 
     details > details {

package/declarations/index.d.ts

@@ -0,0 +1,58 @@
+import type { Handler, NextFn } from "@warp-drive/core/request";
+import type { RequestContext, StructuredDataDocument } from "@warp-drive/core/types/request";
+import type { MinimumAdapterInterface } from "@warp-drive/legacy/compat";
+import type { Store } from "@warp-drive/legacy/store";
+import type { ScaffoldGenerator } from "./mock.js";
+/**
+* @public
+*/
+export declare function setConfig({ host }: {
+	host: string;
+}): void;
+/**
+* @public
+*/
+export declare function setTestId(context: object, str: string | null): void;
+/**
+* @public
+*/
+export declare function setIsRecording(value: boolean): void;
+/**
+* @public
+*/
+export declare function getIsRecording(): boolean;
+/**
+* A request handler that intercepts requests and routes them through
+* the Holodeck mock server.
+*
+* This handler modifies the request URL to include test identifiers
+* and manages request counts for accurate mocking.
+*
+* Requires that the test context be configured with a testId using `setTestId`.
+*
+* @param owner - the test context object used to retrieve the test ID.
+*/
+export declare class MockServerHandler implements Handler {
+	owner: object;
+	constructor(owner: object);
+	request<T>(context: RequestContext, next: NextFn<T>): Promise<StructuredDataDocument<T>>;
+}
+interface HasAdapterForFn {
+	adapterFor(this: Store, modelName: string): MinimumAdapterInterface;
+	adapterFor(this: Store, modelName: string, _allowMissing?: true): MinimumAdapterInterface | undefined;
+}
+/**
+* Creates an adapterFor function that wraps the provided adapterFor function
+* to override the adapter's _fetchRequest method to route requests through
+* the Holodeck mock server.
+*
+* @param owner - The test context object used to retrieve the test ID.
+*/
+export declare function createAdapterFor(owner: object, store: HasAdapterForFn): HasAdapterForFn["adapterFor"];
+/**
+* Mock a request by sending the scaffold to the mock server.
+*
+* @public
+*/
+export declare function mock(owner: object, generate: ScaffoldGenerator, isRecording?: boolean): Promise<void>;
+export {};

package/declarations/mock.d.ts

@@ -0,0 +1,65 @@
+/**
+* @public
+*/
+export interface Scaffold {
+	status: number;
+	statusText?: string;
+	headers: Record<string, string>;
+	body: Record<string, string> | string | null;
+	method: string;
+	url: string;
+	response: Record<string, unknown>;
+}
+/**
+* @public
+*/
+export type ScaffoldGenerator = () => Scaffold;
+/**
+* @public
+*/
+export type ResponseGenerator = () => Record<string, unknown>;
+/**
+* Sets up Mocking for a GET request on the mock server
+* for the supplied url.
+*
+* The response body is generated by the supplied response function.
+*
+* Available options:
+* - status: the status code to return (default: 200)
+* - headers: the headers to return (default: {})
+* - body: the body to match against for the request (default: null)
+* - RECORD: whether to record the request (default: false)
+*
+* @param url the url to mock, relative to the mock server host (e.g. `users/1`)
+* @param response a function which generates the response to return
+* @param options status, headers for the response, body to match against for the request, and whether to record the request
+* @return
+*/
+export declare function GET(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
+	RECORD?: boolean;
+}): Promise<void>;
+/**
+* Mock a POST request
+*/
+export declare function POST(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
+	RECORD?: boolean;
+}): Promise<void>;
+/**
+* mock a PUT request
+*/
+export declare function PUT(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
+	RECORD?: boolean;
+}): Promise<void>;
+/**
+* mock a PATCH request
+*
+*/
+export declare function PATCH(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
+	RECORD?: boolean;
+}): Promise<void>;
+/**
+* mock a DELETE request
+*/
+export declare function DELETE(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
+	RECORD?: boolean;
+}): Promise<void>;

package/dist/index.js

@@ -1,10 +1,26 @@
+import { SHOULD_RECORD } from '@warp-drive/core/build-config/env';
+
+/**
+ * @module
+ * @mergeModuleWith <project>
+ */
 const TEST_IDS = new WeakMap();
 let HOST = 'https://localhost:1135/';
+
+/**
+ * @public
+ */
+
 function setConfig({
   host
 }) {
   HOST = host.endsWith('/') ? host : `${host}/`;
 }
+
+/**
+ * @public
+ */
+
 function setTestId(context, str) {
   if (str && TEST_IDS.has(context)) {
     throw new Error(`MockServerHandler is already configured with a testId.`);
@@ -12,37 +28,72 @@ function setTestId(context, str) {
   if (str) {
     TEST_IDS.set(context, {
       id: str,
-      request: 0,
-      mock: 0
+      mock: {
+        GET: {},
+        PUT: {},
+        PATCH: {},
+        DELETE: {},
+        POST: {},
+        QUERY: {},
+        OPTIONS: {},
+        HEAD: {},
+        CONNECT: {},
+        TRACE: {}
+      },
+      request: {
+        GET: {},
+        PUT: {},
+        PATCH: {},
+        DELETE: {},
+        POST: {},
+        QUERY: {},
+        OPTIONS: {},
+        HEAD: {},
+        CONNECT: {},
+        TRACE: {}
+      }
     });
   } else {
     TEST_IDS.delete(context);
   }
 }
-let IS_RECORDING = false;
+const shouldRecord = SHOULD_RECORD ? true : false;
+let IS_RECORDING = null;
+
+/**
+ * @public
+ */
 function setIsRecording(value) {
-  IS_RECORDING = Boolean(value);
+  IS_RECORDING = value === null ? value : Boolean(value);
 }
+
+/**
+ * @public
+ */
 function getIsRecording() {
-  return IS_RECORDING;
+  return IS_RECORDING === null ? shouldRecord : IS_RECORDING;
 }
+
+/**
+ * A request handler that intercepts requests and routes them through
+ * the Holodeck mock server.
+ *
+ * This handler modifies the request URL to include test identifiers
+ * and manages request counts for accurate mocking.
+ *
+ * Requires that the test context be configured with a testId using `setTestId`.
+ *
+ * @param owner - the test context object used to retrieve the test ID.
+ */
 class MockServerHandler {
   constructor(owner) {
     this.owner = owner;
   }
   async request(context, next) {
-    const test = TEST_IDS.get(this.owner);
-    if (!test) {
-      throw new Error(`MockServerHandler is not configured with a testId. Use setTestId to set the testId for each test`);
-    }
-    const request = Object.assign({}, context.request);
-    const isRecording = request.url.endsWith('/__record');
-    const firstChar = request.url.includes('?') ? '&' : '?';
-    const queryForTest = `${firstChar}__xTestId=${test.id}&__xTestRequestNumber=${isRecording ? test.mock++ : test.request++}`;
-    request.url = request.url + queryForTest;
-    request.mode = 'cors';
-    request.credentials = 'omit';
-    request.referrerPolicy = '';
+    const {
+      request,
+      queryForTest
+    } = setupHolodeckFetch(this.owner, Object.assign({}, context.request));
     try {
       const future = next(request);
       context.setStream(future.getStream());
@@ -55,17 +106,102 @@ class MockServerHandler {
     }
   }
 }
-async function mock(owner, generate, isRecording) {
+function setupHolodeckFetch(owner, request) {
   const test = TEST_IDS.get(owner);
   if (!test) {
-    throw new Error(`Cannot call "mock" before configuring a testId. Use setTestId to set the testId for each test`);
+    throw new Error(`MockServerHandler is not configured with a testId. Use setTestId to set the testId for each test`);
+  }
+  const url = request.url;
+  const firstChar = url.includes('?') ? '&' : '?';
+  const method = request.method?.toUpperCase() ?? 'GET';
+
+  // enable custom methods
+  if (!test.request[method]) {
+    // eslint-disable-next-line no-console
+    console.log(`⚠️ Using custom HTTP method ${method} for response to request ${url}`);
+    test.request[method] = {};
   }
-  const testMockNum = test.mock++;
+  if (!(url in test.request[method])) {
+    test.request[method][url] = 0;
+  }
+  const queryForTest = `${firstChar}__xTestId=${test.id}&__xTestRequestNumber=${test.request[method][url]++}`;
+  request.url = url + queryForTest;
+  request.mode = 'cors';
+  request.credentials = 'omit';
+  request.referrerPolicy = '';
+  return {
+    request,
+    queryForTest
+  };
+}
+
+/**
+ * Creates an adapterFor function that wraps the provided adapterFor function
+ * to override the adapter's _fetchRequest method to route requests through
+ * the Holodeck mock server.
+ *
+ * @param owner - The test context object used to retrieve the test ID.
+ */
+function createAdapterFor(owner, store) {
+  // eslint-disable-next-line @typescript-eslint/unbound-method
+  const adapterFor = store.adapterFor;
+  return function holodeckAdapterFor(modelName, _allowMissing) {
+    const adapter = adapterFor.call(this, modelName, _allowMissing);
+    if (adapter) {
+      if (!adapter.hasOverriddenFetch) {
+        adapter.hasOverriddenFetch = true;
+        adapter.useFetch = true;
+        const originalFetch = adapter._fetchRequest?.bind(adapter);
+        adapter._fetchRequest = function (options) {
+          if (!originalFetch) {
+            throw new Error(`Adapter ${String(modelName)} does not implement _fetchRequest`);
+          }
+          const {
+            request
+          } = setupHolodeckFetch(owner, options);
+          return originalFetch(request);
+        };
+      }
+    }
+    return adapter;
+  };
+}
+
+/**
+ * Mock a request by sending the scaffold to the mock server.
+ *
+ * @public
+ */
+async function mock(owner, generate, isRecording) {
   if (getIsRecording() || isRecording) {
+    const test = TEST_IDS.get(owner);
+    if (!test) {
+      throw new Error(`Cannot call "mock" before configuring a testId. Use setTestId to set the testId for each test`);
+    }
+    const requestToMock = generate();
+    const {
+      url: mockUrl,
+      method
+    } = requestToMock;
+    if (!mockUrl || !method) {
+      throw new Error(`MockError: Cannot mock a request without providing a URL and Method`);
+    }
+    const mockMethod = method?.toUpperCase() ?? 'GET';
+
+    // enable custom methods
+    if (!test.mock[mockMethod]) {
+      // eslint-disable-next-line no-console
+      console.log(`⚠️ Using custom HTTP method ${mockMethod} for response to request ${mockUrl}`);
+      test.mock[mockMethod] = {};
+    }
+    if (!(mockUrl in test.mock[mockMethod])) {
+      test.mock[mockMethod][mockUrl] = 0;
+    }
+    const testMockNum = test.mock[mockMethod][mockUrl]++;
     const url = `${HOST}__record?__xTestId=${test.id}&__xTestRequestNumber=${testMockNum}`;
     await fetch(url, {
       method: 'POST',
-      body: JSON.stringify(generate()),
+      body: JSON.stringify(requestToMock),
       mode: 'cors',
       credentials: 'omit',
       referrerPolicy: ''
@@ -73,5 +209,4 @@ async function mock(owner, generate, isRecording) {
   }
 }
 
-export { MockServerHandler, getIsRecording, mock, setConfig, setIsRecording, setTestId };
-//# sourceMappingURL=index.js.map
+export { MockServerHandler, createAdapterFor, getIsRecording, mock, setConfig, setIsRecording, setTestId };

package/dist/mock.js

@@ -1,5 +1,17 @@
 import { mock, getIsRecording } from './index.js';
 
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
 /**
  * Sets up Mocking for a GET request on the mock server
  * for the supplied url.
@@ -28,11 +40,81 @@ function GET(owner, url, response, options) {
     response: response()
   }), getIsRecording() || (options?.RECORD ?? false));
 }
-function POST() {}
-function PUT() {}
-function PATCH() {}
-function DELETE() {}
-function QUERY() {}
+const STATUS_TEXT_FOR = new Map([[200, 'OK'], [201, 'Created'], [202, 'Accepted'], [203, 'Non-Authoritative Information'], [204, 'No Content'], [205, 'Reset Content'], [206, 'Partial Content'], [207, 'Multi-Status'], [208, 'Already Reported'], [226, 'IM Used'], [300, 'Multiple Choices'], [301, 'Moved Permanently'], [302, 'Found'], [303, 'See Other'], [304, 'Not Modified'], [307, 'Temporary Redirect'], [308, 'Permanent Redirect'], [400, 'Bad Request'], [401, 'Unauthorized'], [402, 'Payment Required'], [403, 'Forbidden'], [404, 'Not Found'], [405, 'Method Not Allowed'], [406, 'Not Acceptable'], [407, 'Proxy Authentication Required'], [408, 'Request Timeout'], [409, 'Conflict'], [410, 'Gone'], [411, 'Length Required'], [412, 'Precondition Failed'], [413, 'Payload Too Large'], [414, 'URI Too Long'], [415, 'Unsupported Media Type'], [416, 'Range Not Satisfiable'], [417, 'Expectation Failed'], [419, 'Page Expired'], [420, 'Enhance Your Calm'], [421, 'Misdirected Request'], [422, 'Unprocessable Entity'], [423, 'Locked'], [424, 'Failed Dependency'], [425, 'Too Early'], [426, 'Upgrade Required'], [428, 'Precondition Required'], [429, 'Too Many Requests'], [430, 'Request Header Fields Too Large'], [431, 'Request Header Fields Too Large'], [450, 'Blocked By Windows Parental Controls'], [451, 'Unavailable For Legal Reasons'], [500, 'Internal Server Error'], [501, 'Not Implemented'], [502, 'Bad Gateway'], [503, 'Service Unavailable'], [504, 'Gateway Timeout'], [505, 'HTTP Version Not Supported'], [506, 'Variant Also Negotiates'], [507, 'Insufficient Storage'], [508, 'Loop Detected'], [509, 'Bandwidth Limit Exceeded'], [510, 'Not Extended'], [511, 'Network Authentication Required']]);
+
+/**
+ * Mock a POST request
+ */
+function POST(owner, url, response, options) {
+  return mock(owner, () => {
+    const body = response();
+    const status = options?.status ?? (body ? 201 : 204);
+    return {
+      status: status,
+      statusText: options?.statusText ?? STATUS_TEXT_FOR.get(status) ?? '',
+      headers: options?.headers ?? {},
+      body: options?.body ?? null,
+      method: 'POST',
+      url,
+      response: body
+    };
+  }, getIsRecording() || (options?.RECORD ?? false));
+}
+
+/**
+ * mock a PUT request
+ */
+function PUT(owner, url, response, options) {
+  return mock(owner, () => {
+    const body = response();
+    const status = options?.status ?? (body ? 200 : 204);
+    return {
+      status: status,
+      statusText: options?.statusText ?? STATUS_TEXT_FOR.get(status) ?? '',
+      headers: options?.headers ?? {},
+      body: options?.body ?? null,
+      method: 'PUT',
+      url,
+      response: body
+    };
+  }, getIsRecording() || (options?.RECORD ?? false));
+}
+/**
+ * mock a PATCH request
+ *
+ */
+function PATCH(owner, url, response, options) {
+  return mock(owner, () => {
+    const body = response();
+    const status = options?.status ?? (body ? 200 : 204);
+    return {
+      status: status,
+      statusText: options?.statusText ?? STATUS_TEXT_FOR.get(status) ?? '',
+      headers: options?.headers ?? {},
+      body: options?.body ?? null,
+      method: 'PATCH',
+      url,
+      response: body
+    };
+  }, getIsRecording() || (options?.RECORD ?? false));
+}
+/**
+ * mock a DELETE request
+ */
+function DELETE(owner, url, response, options) {
+  return mock(owner, () => {
+    const body = response();
+    const status = options?.status ?? (body ? 200 : 204);
+    return {
+      status: status,
+      statusText: options?.statusText ?? STATUS_TEXT_FOR.get(status) ?? '',
+      headers: options?.headers ?? {},
+      body: options?.body ?? null,
+      method: 'DELETE',
+      url,
+      response: body
+    };
+  }, getIsRecording() || (options?.RECORD ?? false));
+}
 
-export { DELETE, GET, PATCH, POST, PUT, QUERY };
-//# sourceMappingURL=mock.js.map
+export { DELETE, GET, PATCH, POST, PUT };

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@warp-drive/holodeck",
   "description": "⚡️ Simple, Fast HTTP Mocking for Tests",
-  "version": "0.0.1",
+  "version": "0.1.0-alpha.14",
   "license": "MIT",
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com:emberjs/data.git",
+    "url": "git+ssh://git@github.com:warp-drive-data/warp-drive.git",
     "directory": "packages/holodeck"
   },
-  "homepage": "https://github.com/emberjs/data",
-  "bugs": "https://github.com/emberjs/data/issues",
+  "homepage": "https://github.com/warp-drive-data/warp-drive",
+  "bugs": "https://github.com/warp-drive-data/warp-drive/issues",
   "engines": {
     "node": ">= 18.20.8"
   },
@@ -21,9 +21,9 @@
     "extends": "../../package.json"
   },
   "dependencies": {
-    "chalk": "^5.3.0",
-    "hono": "^4.7.6",
-    "@hono/node-server": "^1.14.0"
+    "chalk": "^5.5.0",
+    "hono": "^4.9.4",
+    "@hono/node-server": "^1.19.0"
   },
   "type": "module",
   "files": [
@@ -32,25 +32,36 @@
     "README.md",
     "LICENSE.md",
     "server",
+    "declarations",
     "logos"
   ],
   "bin": {
     "ensure-cert": "./server/ensure-cert.js"
   },
   "peerDependencies": {
-    "@ember-data/request": "5.4.1",
-    "@warp-drive/core-types": "5.4.1"
+    "@warp-drive/utilities": "5.8.0-alpha.14",
+    "@warp-drive/legacy": "5.8.0-alpha.14",
+    "@warp-drive/core": "5.8.0-alpha.14"
+  },
+  "peerDependenciesMeta": {
+    "@warp-drive/utilities": {
+      "optional": true
+    },
+    "@warp-drive/legacy": {
+      "optional": true
+    }
   },
   "devDependencies": {
-    "@babel/core": "^7.26.10",
-    "@babel/plugin-transform-typescript": "^7.27.0",
-    "@babel/preset-env": "^7.26.9",
-    "@babel/preset-typescript": "^7.27.0",
-    "@babel/runtime": "^7.27.0",
-    "@ember-data/request": "5.4.1",
-    "@warp-drive/core-types": "5.4.1",
-    "@warp-drive/internal-config": "5.4.1",
-    "vite": "^5.4.15"
+    "@babel/core": "^7.28.3",
+    "@babel/plugin-transform-typescript": "^7.28.0",
+    "@babel/preset-env": "^7.28.3",
+    "@babel/preset-typescript": "^7.27.1",
+    "@babel/runtime": "^7.28.3",
+    "@warp-drive/utilities": "5.8.0-alpha.14",
+    "@warp-drive/legacy": "5.8.0-alpha.14",
+    "@warp-drive/core": "5.8.0-alpha.14",
+    "@warp-drive/internal-config": "5.8.0-alpha.14",
+    "vite": "^7.1.3"
   },
   "exports": {
     ".": {
@@ -58,14 +69,17 @@
       "bun": "./server/index.js",
       "deno": "./server/index.js",
       "browser": {
+        "types": "./declarations/index.d.ts",
         "default": "./dist/index.js"
       },
       "import": {
+        "types": "./declarations/index.d.ts",
         "default": "./dist/index.js"
       },
       "default": "./server/index.js"
     },
     "./mock": {
+      "types": "./declarations/mock.d.ts",
       "default": "./dist/mock.js"
     }
   },

package/server/ensure-cert.js

@@ -11,6 +11,10 @@ function getShellConfigFilePath() {
       return path.join(homedir(), '.zshrc');
     case '/bin/bash':
       return path.join(homedir(), '.bashrc');
+    case '/opt/homebrew/bin/fish':
+    case '/usr/local/bin/fish':
+    case '/bin/fish':
+      return path.join(homedir(), '.config', 'fish', 'config.fish');
     default:
       throw Error(
         `Unable to determine configuration file for shell: ${shell}. Manual SSL Cert Setup Required for Holodeck.`

package/server/index.js

@@ -11,6 +11,7 @@ import fs from 'node:fs';
 import zlib from 'node:zlib';
 import { homedir } from 'os';
 import path from 'path';
+import { threadId, parentPort } from 'node:worker_threads';
 
 const isBun = typeof Bun !== 'undefined';
 const DEBUG =
@@ -106,11 +107,21 @@ function generateFilepath(options) {
   const { body } = options;
   const bodyHash = body ? crypto.createHash('md5').update(JSON.stringify(body)).digest('hex') : null;
   const cacheDir = generateFileDir(options);
-  return `${cacheDir}/${bodyHash ? `${bodyHash}-` : 'res'}`;
+  return `${cacheDir}/${bodyHash ? bodyHash : 'res'}`;
 }
+
+/*
+ Generate a human scannable file name for the test assets to be stored in,
+ the `.mock-cache` directory should be checked-in to the codebase.
+*/
 function generateFileDir(options) {
   const { projectRoot, testId, url, method, testRequestNumber } = options;
-  return `${projectRoot}/.mock-cache/${testId}/${method}-${testRequestNumber}-${url}`;
+  const normalizedUrl = url.startsWith('/') ? url.slice(1) : url;
+  // make path look nice but not be a sub-directory
+  // using alternative `/`-like characters would be nice but results in odd encoding
+  // on disk path
+  const pathUrl = normalizedUrl.replaceAll('/', '_');
+  return `${projectRoot}/.mock-cache/${testId}/${method}::${pathUrl}::${testRequestNumber}`;
 }
 
 async function replayRequest(context, cacheKey) {
@@ -131,34 +142,54 @@ async function replayRequest(context, cacheKey) {
             status: '400',
             code: 'MOCK_NOT_FOUND',
             title: 'Mock not found',
-            detail: `No meta was found for ${context.req.method} ${context.req.url}. You may need to record a mock for this request.`,
+            detail: `No meta was found for ${context.req.method} ${context.req.url}. The expected cacheKey was ${cacheKey}. You may need to record a mock for this request.`,
           },
         ],
       })
     );
   }
 
-  const bodyPath = `${cacheKey}.body.br`;
-  const bodyInit =
-    metaJson.status !== 204 && metaJson.status < 500
-      ? isBun
-        ? Bun.file(bodyPath)
-        : fs.createReadStream(bodyPath)
-      : '';
-
-  const headers = new Headers(metaJson.headers || {});
-  // @ts-expect-error - createReadStream is supported in node
-  const response = new Response(bodyInit, {
-    status: metaJson.status,
-    statusText: metaJson.statusText,
-    headers,
-  });
+  try {
+    const bodyPath = `${cacheKey}.body.br`;
+    const bodyInit =
+      metaJson.status !== 204 && metaJson.status < 500
+        ? isBun
+          ? Bun.file(bodyPath)
+          : fs.createReadStream(bodyPath)
+        : '';
+
+    const headers = new Headers(metaJson.headers || {});
+    // @ts-expect-error - createReadStream is supported in node
+    const response = new Response(bodyInit, {
+      status: metaJson.status,
+      statusText: metaJson.statusText,
+      headers,
+    });
 
-  if (metaJson.status > 400) {
-    throw new HTTPException(metaJson.status, { res: response, message: metaJson.statusText });
-  }
+    if (metaJson.status > 400) {
+      throw new HTTPException(metaJson.status, { res: response, message: metaJson.statusText });
+    }
 
-  return response;
+    return response;
+  } catch (e) {
+    if (e instanceof HTTPException) {
+      throw e;
+    }
+    context.header('Content-Type', 'application/vnd.api+json');
+    context.status(500);
+    return context.body(
+      JSON.stringify({
+        errors: [
+          {
+            status: '500',
+            code: 'MOCK_SERVER_ERROR',
+            title: 'Mock Replay Failed',
+            detail: `Failed to create the response for ${context.req.method} ${context.req.url}.\n\n\n${e.message}\n${e.stack}`,
+          },
+        ],
+      })
+    );
+  }
 }
 
 function createTestHandler(projectRoot) {
@@ -208,7 +239,7 @@ function createTestHandler(projectRoot) {
         );
       }
 
-      if (req.method === 'POST' || niceUrl === '__record') {
+      if (req.method === 'POST' && niceUrl === '__record') {
         const payload = await req.json();
         const { url, headers, method, status, statusText, body, response } = payload;
         const cacheKey = generateFilepath({
@@ -216,7 +247,7 @@ function createTestHandler(projectRoot) {
           testId,
           url,
           method,
-          body: body ? JSON.stringify(body) : null,
+          body,
           testRequestNumber,
         });
         const compressedResponse = compress(JSON.stringify(response));
@@ -252,24 +283,34 @@ function createTestHandler(projectRoot) {
           fs.writeFileSync(`${cacheKey}.body.br`, compressedResponse);
         }
 
-        context.status(204);
-        return context.body(null);
+        context.status(201);
+        return context.body(
+          JSON.stringify({
+            message: `Recorded ${method} ${url} for test ${testId} request #${testRequestNumber}`,
+            cacheKey,
+            cacheDir,
+          })
+        );
       } else {
-        const body = req.body;
+        const body = req.raw.body ? await req.text() : null;
         const cacheKey = generateFilepath({
           projectRoot,
           testId,
           url: niceUrl,
           method: req.method,
-          body: body ? JSON.stringify(body) : null,
+          body: body ? body : null,
           testRequestNumber,
         });
         return replayRequest(context, cacheKey);
       }
     } catch (e) {
       if (e instanceof HTTPException) {
+        console.log(`HTTPException Encountered`);
+        console.error(e);
         throw e;
       }
+      console.log(`500 MOCK_SERVER_ERROR Encountered`);
+      console.error(e);
       context.header('Content-Type', 'application/vnd.api+json');
       context.status(500);
       return context.body(
@@ -302,6 +343,7 @@ export function startNodeServer() {
 export function startWorker() {
   // listen for launch message
   globalThis.onmessage = async (event) => {
+    console.log('starting holodeck worker');
     const { options } = event.data;
 
     const { server } = await _createServer(options);
@@ -317,6 +359,16 @@ export function startWorker() {
   };
 }
 
+async function waitForLog(server, logMessage) {
+  for await (const chunk of server.stdout) {
+    process.stdout.write(chunk);
+    const txt = new TextDecoder().decode(chunk);
+    if (txt.includes(logMessage)) {
+      return;
+    }
+  }
+}
+
 /*
 { port?: number, projectRoot: string }
 */
@@ -324,14 +376,16 @@ export async function createServer(options, useBun = false) {
   if (!useBun) {
     const CURRENT_FILE = new URL(import.meta.url).pathname;
     const START_FILE = path.join(CURRENT_FILE, '../start-node.js');
-    const server = Bun.spawn(['node', '--experimental-default-type=module', START_FILE, JSON.stringify(options)], {
-      env: process.env,
+    const server = Bun.spawn(['node', START_FILE, JSON.stringify(options)], {
+      env: Object.assign({}, process.env, { FORCE_COLOR: 1 }),
       cwd: process.cwd(),
       stdin: 'inherit',
-      stdout: 'inherit',
+      stdout: 'pipe',
       stderr: 'inherit',
     });
 
+    await waitForLog(server, 'Serving Holodeck HTTP Mocks');
+
     return {
       terminate() {
         server.kill();
@@ -340,6 +394,7 @@ export async function createServer(options, useBun = false) {
     };
   }
 
+  console.log('starting holodeck worker');
   const worker = new Worker(new URL('./worker.js', import.meta.url), { type: 'module' });
 
   worker.postMessage({
@@ -347,7 +402,15 @@ export async function createServer(options, useBun = false) {
     options,
   });
 
-  return worker;
+  return new Promise((resolve) => {
+    // @ts-expect-error
+    worker.onmessage((v) => {
+      console.log('worker message received', v);
+      if (v.data === 'launched') {
+        resolve(worker);
+      }
+    });
+  });
 }
 
 async function _createServer(options) {
@@ -383,9 +446,13 @@ async function _createServer(options) {
   });
 
   console.log(
-    `\tMock server running at ${chalk.yellow('https://') + chalk.magenta((options.hostname ?? 'localhost') + ':') + chalk.yellow(options.port ?? DEFAULT_PORT)}`
+    `\tServing Holodeck HTTP Mocks from ${chalk.yellow('https://') + chalk.magenta((options.hostname ?? 'localhost') + ':') + chalk.yellow(options.port ?? DEFAULT_PORT)}\n`
   );
 
+  if (typeof threadId === 'number' && threadId !== 0) {
+    parentPort.postMessage('launched');
+  }
+
   return { app, server };
 }
 

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import type { Handler, NextFn, RequestContext, RequestInfo, StructuredDataDocument } from '@ember-data/request';\n\nimport type { ScaffoldGenerator } from './mock';\n\nconst TEST_IDS = new WeakMap<object, { id: string; request: number; mock: number }>();\n\nlet HOST = 'https://localhost:1135/';\nexport function setConfig({ host }: { host: string }) {\n  HOST = host.endsWith('/') ? host : `${host}/`;\n}\n\nexport function setTestId(context: object, str: string | null) {\n  if (str && TEST_IDS.has(context)) {\n    throw new Error(`MockServerHandler is already configured with a testId.`);\n  }\n  if (str) {\n    TEST_IDS.set(context, { id: str, request: 0, mock: 0 });\n  } else {\n    TEST_IDS.delete(context);\n  }\n}\n\nlet IS_RECORDING = false;\nexport function setIsRecording(value: boolean) {\n  IS_RECORDING = Boolean(value);\n}\nexport function getIsRecording() {\n  return IS_RECORDING;\n}\n\nexport class MockServerHandler implements Handler {\n  declare owner: object;\n  constructor(owner: object) {\n    this.owner = owner;\n  }\n  async request<T>(context: RequestContext, next: NextFn<T>): Promise<StructuredDataDocument<T>> {\n    const test = TEST_IDS.get(this.owner);\n    if (!test) {\n      throw new Error(\n        `MockServerHandler is not configured with a testId. Use setTestId to set the testId for each test`\n      );\n    }\n\n    const request: RequestInfo = Object.assign({}, context.request);\n    const isRecording = request.url!.endsWith('/__record');\n    const firstChar = request.url!.includes('?') ? '&' : '?';\n    const queryForTest = `${firstChar}__xTestId=${test.id}&__xTestRequestNumber=${\n      isRecording ? test.mock++ : test.request++\n    }`;\n    request.url = request.url + queryForTest;\n\n    request.mode = 'cors';\n    request.credentials = 'omit';\n    request.referrerPolicy = '';\n\n    try {\n      const future = next(request);\n      context.setStream(future.getStream());\n      return await future;\n    } catch (e) {\n      if (e instanceof Error && !(e instanceof DOMException)) {\n        e.message = e.message.replace(queryForTest, '');\n      }\n      throw e;\n    }\n  }\n}\n\nexport async function mock(owner: object, generate: ScaffoldGenerator, isRecording?: boolean) {\n  const test = TEST_IDS.get(owner);\n  if (!test) {\n    throw new Error(`Cannot call \"mock\" before configuring a testId. Use setTestId to set the testId for each test`);\n  }\n  const testMockNum = test.mock++;\n  if (getIsRecording() || isRecording) {\n    const port = window.location.port ? `:${window.location.port}` : '';\n    const url = `${HOST}__record?__xTestId=${test.id}&__xTestRequestNumber=${testMockNum}`;\n    await fetch(url, {\n      method: 'POST',\n      body: JSON.stringify(generate()),\n      mode: 'cors',\n      credentials: 'omit',\n      referrerPolicy: '',\n    });\n  }\n}\n"],"names":["TEST_IDS","WeakMap","HOST","setConfig","host","endsWith","setTestId","context","str","has","Error","set","id","request","mock","delete","IS_RECORDING","setIsRecording","value","Boolean","getIsRecording","MockServerHandler","constructor","owner","next","test","get","Object","assign","isRecording","url","firstChar","includes","queryForTest","mode","credentials","referrerPolicy","future","setStream","getStream","e","DOMException","message","replace","generate","testMockNum","fetch","method","body","JSON","stringify"],"mappings":"AAIA,MAAMA,QAAQ,GAAG,IAAIC,OAAO,EAAyD;AAErF,IAAIC,IAAI,GAAG,yBAAyB;AAC7B,SAASC,SAASA,CAAC;AAAEC,EAAAA;AAAuB,CAAC,EAAE;AACpDF,EAAAA,IAAI,GAAGE,IAAI,CAACC,QAAQ,CAAC,GAAG,CAAC,GAAGD,IAAI,GAAG,CAAGA,EAAAA,IAAI,CAAG,CAAA,CAAA;AAC/C;AAEO,SAASE,SAASA,CAACC,OAAe,EAAEC,GAAkB,EAAE;EAC7D,IAAIA,GAAG,IAAIR,QAAQ,CAACS,GAAG,CAACF,OAAO,CAAC,EAAE;AAChC,IAAA,MAAM,IAAIG,KAAK,CAAC,CAAA,sDAAA,CAAwD,CAAC;AAC3E;AACA,EAAA,IAAIF,GAAG,EAAE;AACPR,IAAAA,QAAQ,CAACW,GAAG,CAACJ,OAAO,EAAE;AAAEK,MAAAA,EAAE,EAAEJ,GAAG;AAAEK,MAAAA,OAAO,EAAE,CAAC;AAAEC,MAAAA,IAAI,EAAE;AAAE,KAAC,CAAC;AACzD,GAAC,MAAM;AACLd,IAAAA,QAAQ,CAACe,MAAM,CAACR,OAAO,CAAC;AAC1B;AACF;AAEA,IAAIS,YAAY,GAAG,KAAK;AACjB,SAASC,cAAcA,CAACC,KAAc,EAAE;AAC7CF,EAAAA,YAAY,GAAGG,OAAO,CAACD,KAAK,CAAC;AAC/B;AACO,SAASE,cAAcA,GAAG;AAC/B,EAAA,OAAOJ,YAAY;AACrB;AAEO,MAAMK,iBAAiB,CAAoB;EAEhDC,WAAWA,CAACC,KAAa,EAAE;IACzB,IAAI,CAACA,KAAK,GAAGA,KAAK;AACpB;AACA,EAAA,MAAMV,OAAOA,CAAIN,OAAuB,EAAEiB,IAAe,EAAsC;IAC7F,MAAMC,IAAI,GAAGzB,QAAQ,CAAC0B,GAAG,CAAC,IAAI,CAACH,KAAK,CAAC;IACrC,IAAI,CAACE,IAAI,EAAE;AACT,MAAA,MAAM,IAAIf,KAAK,CACb,CAAA,gGAAA,CACF,CAAC;AACH;AAEA,IAAA,MAAMG,OAAoB,GAAGc,MAAM,CAACC,MAAM,CAAC,EAAE,EAAErB,OAAO,CAACM,OAAO,CAAC;IAC/D,MAAMgB,WAAW,GAAGhB,OAAO,CAACiB,GAAG,CAAEzB,QAAQ,CAAC,WAAW,CAAC;AACtD,IAAA,MAAM0B,SAAS,GAAGlB,OAAO,CAACiB,GAAG,CAAEE,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG;IACxD,MAAMC,YAAY,GAAG,CAAGF,EAAAA,SAAS,aAAaN,IAAI,CAACb,EAAE,CACnDiB,sBAAAA,EAAAA,WAAW,GAAGJ,IAAI,CAACX,IAAI,EAAE,GAAGW,IAAI,CAACZ,OAAO,EAAE,CAC1C,CAAA;AACFA,IAAAA,OAAO,CAACiB,GAAG,GAAGjB,OAAO,CAACiB,GAAG,GAAGG,YAAY;IAExCpB,OAAO,CAACqB,IAAI,GAAG,MAAM;IACrBrB,OAAO,CAACsB,WAAW,GAAG,MAAM;IAC5BtB,OAAO,CAACuB,cAAc,GAAG,EAAE;IAE3B,IAAI;AACF,MAAA,MAAMC,MAAM,GAAGb,IAAI,CAACX,OAAO,CAAC;MAC5BN,OAAO,CAAC+B,SAAS,CAACD,MAAM,CAACE,SAAS,EAAE,CAAC;AACrC,MAAA,OAAO,MAAMF,MAAM;KACpB,CAAC,OAAOG,CAAC,EAAE;MACV,IAAIA,CAAC,YAAY9B,KAAK,IAAI,EAAE8B,CAAC,YAAYC,YAAY,CAAC,EAAE;AACtDD,QAAAA,CAAC,CAACE,OAAO,GAAGF,CAAC,CAACE,OAAO,CAACC,OAAO,CAACV,YAAY,EAAE,EAAE,CAAC;AACjD;AACA,MAAA,MAAMO,CAAC;AACT;AACF;AACF;AAEO,eAAe1B,IAAIA,CAACS,KAAa,EAAEqB,QAA2B,EAAEf,WAAqB,EAAE;AAC5F,EAAA,MAAMJ,IAAI,GAAGzB,QAAQ,CAAC0B,GAAG,CAACH,KAAK,CAAC;EAChC,IAAI,CAACE,IAAI,EAAE;AACT,IAAA,MAAM,IAAIf,KAAK,CAAC,CAAA,6FAAA,CAA+F,CAAC;AAClH;AACA,EAAA,MAAMmC,WAAW,GAAGpB,IAAI,CAACX,IAAI,EAAE;AAC/B,EAAA,IAAIM,cAAc,EAAE,IAAIS,WAAW,EAAE;IAEnC,MAAMC,GAAG,GAAG,CAAA,EAAG5B,IAAI,CAAA,mBAAA,EAAsBuB,IAAI,CAACb,EAAE,CAAyBiC,sBAAAA,EAAAA,WAAW,CAAE,CAAA;IACtF,MAAMC,KAAK,CAAChB,GAAG,EAAE;AACfiB,MAAAA,MAAM,EAAE,MAAM;MACdC,IAAI,EAAEC,IAAI,CAACC,SAAS,CAACN,QAAQ,EAAE,CAAC;AAChCV,MAAAA,IAAI,EAAE,MAAM;AACZC,MAAAA,WAAW,EAAE,MAAM;AACnBC,MAAAA,cAAc,EAAE;AAClB,KAAC,CAAC;AACJ;AACF;;;;"}

package/dist/mock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mock.js","sources":["../src/mock.ts"],"sourcesContent":["import { getIsRecording, mock } from '.';\n\nexport interface Scaffold {\n  status: number;\n  statusText?: string;\n  headers: Record<string, string>;\n  body: Record<string, string> | string | null;\n  method: string;\n  url: string;\n  response: Record<string, unknown>;\n}\n\nexport type ScaffoldGenerator = () => Scaffold;\nexport type ResponseGenerator = () => Record<string, unknown>;\n\n/**\n * Sets up Mocking for a GET request on the mock server\n * for the supplied url.\n *\n * The response body is generated by the supplied response function.\n *\n * Available options:\n * - status: the status code to return (default: 200)\n * - headers: the headers to return (default: {})\n * - body: the body to match against for the request (default: null)\n * - RECORD: whether to record the request (default: false)\n *\n * @param url the url to mock, relative to the mock server host (e.g. `users/1`)\n * @param response a function which generates the response to return\n * @param options status, headers for the response, body to match against for the request, and whether to record the request\n * @return\n */\nexport function GET(\n  owner: object,\n  url: string,\n  response: ResponseGenerator,\n  options?: Partial<Omit<Scaffold, 'response' | 'url' | 'method'>> & { RECORD?: boolean }\n): Promise<void> {\n  return mock(\n    owner,\n    () => ({\n      status: options?.status ?? 200,\n      statusText: options?.statusText ?? 'OK',\n      headers: options?.headers ?? {},\n      body: options?.body ?? null,\n      method: 'GET',\n      url,\n      response: response(),\n    }),\n    getIsRecording() || (options?.RECORD ?? false)\n  );\n}\nexport function POST() {}\nexport function PUT() {}\nexport function PATCH() {}\nexport function DELETE() {}\nexport function QUERY() {}\n"],"names":["GET","owner","url","response","options","mock","status","statusText","headers","body","method","getIsRecording","RECORD","POST","PUT","PATCH","DELETE","QUERY"],"mappings":";;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,GAAGA,CACjBC,KAAa,EACbC,GAAW,EACXC,QAA2B,EAC3BC,OAAuF,EACxE;AACf,EAAA,OAAOC,IAAI,CACTJ,KAAK,EACL,OAAO;AACLK,IAAAA,MAAM,EAAEF,OAAO,EAAEE,MAAM,IAAI,GAAG;AAC9BC,IAAAA,UAAU,EAAEH,OAAO,EAAEG,UAAU,IAAI,IAAI;AACvCC,IAAAA,OAAO,EAAEJ,OAAO,EAAEI,OAAO,IAAI,EAAE;AAC/BC,IAAAA,IAAI,EAAEL,OAAO,EAAEK,IAAI,IAAI,IAAI;AAC3BC,IAAAA,MAAM,EAAE,KAAK;IACbR,GAAG;IACHC,QAAQ,EAAEA,QAAQ;AACpB,GAAC,CAAC,EACFQ,cAAc,EAAE,KAAKP,OAAO,EAAEQ,MAAM,IAAI,KAAK,CAC/C,CAAC;AACH;AACO,SAASC,IAAIA,GAAG;AAChB,SAASC,GAAGA,GAAG;AACf,SAASC,KAAKA,GAAG;AACjB,SAASC,MAAMA,GAAG;AAClB,SAASC,KAAKA,GAAG;;;;"}