@warp-drive/holodeck 0.0.1 → 0.0.3-beta.1

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);
 });
 ```
 
@@ -225,7 +225,7 @@ holodeck can be launched and cleaned up using the lifecycle hooks in the launch
 for diagnostic in `diagnostic.js`:
 
 ```ts
-import launch from '@warp-drive/diagnostic/server/default-setup.js';
+import { launch } from '@warp-drive/diagnostic/server';
 import holodeck from '@warp-drive/holodeck';
 
 await launch({
@@ -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,52 @@
+import type { Handler, NextFn } from "@warp-drive/core/request";
+import type { RequestContext, StructuredDataDocument } from "@warp-drive/core/types/request";
+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>>;
+}
+/**
+* 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 installAdapterFor(owner: object, store: Store): void;
+/**
+* Mock a request by sending the scaffold to the mock server.
+*
+* @public
+*/
+export declare function mock(owner: object, generate: ScaffoldGenerator, isRecording?: boolean): Promise<void>;

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/';
+let HOST = '/';
+
+/**
+ * @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,127 @@ 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] = {};
+  }
+  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.method = method;
+  request.mode = 'cors';
+  request.credentials = 'omit';
+  request.referrerPolicy = '';
+
+  // since holodeck currently runs on a separate port
+  // and we don't want to trigger cors pre-flight
+  // we convert PUT to POST to keep the request in the
+  // "simple" cors category.
+  // if (request.method === 'PUT') {
+  //   request.method = 'POST';
+  // }
+
+  const headers = new Headers(request.headers);
+  if (headers.has('Content-Type')) {
+    // under the rules of simple-cors, content-type can only be
+    // one of three things, none of which are what folks typically
+    // set this to. Since holodeck always expects body to be JSON
+    // this "just works".
+    headers.set('Content-Type', 'text/plain');
+    request.headers = headers;
+  }
+  return {
+    request,
+    queryForTest
+  };
+}
+function upgradeStore(store) {
+  if (typeof store.adapterFor !== 'function') {
+    throw new Error('Store is not compatible with Holodeck. Missing adapterFor method.');
   }
-  const testMockNum = test.mock++;
+}
+
+/**
+ * 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 installAdapterFor(owner, store) {
+  upgradeStore(store);
+  const fn = store.adapterFor;
+  function holodeckAdapterFor(modelName, _allowMissing) {
+    const adapter = fn.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;
+  }
+  store.adapterFor = holodeckAdapterFor;
+}
+
+/**
+ * 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 +234,4 @@ async function mock(owner, generate, isRecording) {
   }
 }
 
-export { MockServerHandler, getIsRecording, mock, setConfig, setIsRecording, setTestId };
-//# sourceMappingURL=index.js.map
+export { MockServerHandler, getIsRecording, installAdapterFor, 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.0.3-beta.1",
   "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-beta.0",
+    "@warp-drive/legacy": "5.8.0-beta.0",
+    "@warp-drive/core": "5.8.0-beta.0"
+  },
+  "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-beta.0",
+    "@warp-drive/legacy": "5.8.0-beta.0",
+    "@warp-drive/core": "5.8.0-beta.0",
+    "@warp-drive/internal-config": "5.8.0-beta.0",
+    "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/bun-worker.js

@@ -0,0 +1,3 @@
+import { startWorker } from './bun.js';
+
+startWorker();