@warp-drive/holodeck 0.0.0-beta.11 → 0.0.0-beta.13

package/README.md

@@ -94,6 +94,152 @@ and `brotli` minification in a way that can be replayed over and over again.
 
 Basically, pay the cost when you write the test. Forever after skip the cost until you need to edit the test again.
 
+## Setup
+
+### Use with WarpDrive
+
+First, you will need to add the holodeck handler to the request manager chain prior to `Fetch` (or any equivalent handler that proceeds to network).
+
+For instance:
+
+```ts
+import RequestManager from '@ember-data/request';
+import Fetch from '@ember-data/request/fetch';
+import { MockServerHandler } from '@warp-drive/holodeck';
+
+const manager = new RequestManager();
+manager.use([new MockServerHandler(testContext), Fetch]);
+```
+
+From within a test this might look like:
+
+```ts
+import RequestManager from '@ember-data/request';
+import Fetch from '@ember-data/request/fetch';
+import { MockServerHandler } from '@warp-drive/holodeck';
+import { module, test } from 'qunit';
+
+module('my module', function() {
+  test('my test', async function() {
+    const manager = new RequestManager();
+    manager.use([new MockServerHandler(this), Fetch]);
+  });
+});
+```
+
+Next, you will need to configure holodeck to understand your tests contexts. For qunit and diagnostic
+in a project using Ember this is typically done in `tests/test-helper.js`
+
+#### With Diagnostic
+
+```ts
+import { setupGlobalHooks } from '@warp-drive/diagnostic';
+import { setConfig, setTestId } from '@warp-drive/holodeck';
+
+// if not proxying the port / set port to the correct value here
+const MockHost = `https://${window.location.hostname}:${Number(window.location.port) + 1}`;
+
+setConfig({ host: MockHost });
+
+setupGlobalHooks((hooks) => {
+  hooks.beforeEach(function (assert) {
+    setTestId(this, assert.test.testId);
+  });
+  hooks.afterEach(function () {
+    setTestId(this, null);
+  });
+});
+```
+
+#### With QUnit
+
+```ts
+import * as QUnit from 'qunit';
+import { setConfig, setTestId } from '@warp-drive/holodeck';
+
+// if not proxying the port / set port to the correct value here
+const MockHost = `https://${window.location.hostname}:${Number(window.location.port) + 1}`;
+
+setConfig({ host: MockHost });
+
+QUnit.hooks.beforeEach(function (assert) {
+  setTestId(assert.test.testId);
+});
+QUnit.hooks.afterEach(function (assert) {
+  setTestId(null);
+});
+```
+
+### Testem
+
+You can integrate holodeck with Testem using testem's [async config capability](https://github.com/testem/testem/blob/master/docs/config_file.md#returning-a-promise-from-testemjs):
+
+```ts
+module.exports = async function () {
+  const holodeck = (await import('@warp-drive/holodeck')).default;
+  await holodeck.launchProgram({
+    port: 7373,
+  });
+
+  process.on('beforeExit', async () => {
+    await holodeck.endProgram();
+  });
+
+  return {
+    // ... testem config
+  };
+};
+```
+
+If you need the API mock to run on the same port as the test suite, you can use Testem's [API Proxy](https://github.com/testem/testem/tree/master?tab=readme-ov-file#api-proxy)
+
+```ts
+module.exports = async function () {
+  const holodeck = (await import('@warp-drive/holodeck')).default;
+  await holodeck.launchProgram({
+    port: 7373,
+  });
+
+  process.on('beforeExit', async () => {
+    await holodeck.endProgram();
+  });
+
+  return {
+    "proxies": {
+      "/api": {
+        // holodeck always runs on https
+        // the proxy is transparent so this means /api/v1 will route to https://localhost:7373/api/v1
+        "target": "https://localhost:7373",
+        // "onlyContentTypes": ["xml", "json"],
+        // if test suite is on http, set this to false
+        // "secure": false,
+      },
+    }
+  };
+};
+```
+
+### Diagnostic
+
+holodeck can be launched and cleaned up using the lifecycle hooks in the launch config
+for diagnostic in `diagnostic.js`:
+
+```ts
+import launch from '@warp-drive/diagnostic/server/default-setup.js';
+import holodeck from '@warp-drive/holodeck';
+
+await launch({
+  async setup(options) {
+    await holodeck.launchProgram({
+      port: options.port + 1,
+    });
+  },
+  async cleanup() {
+    await holodeck.endProgram();
+  },
+});
+```
+
 ### ♥️ Credits
 
  <details>

package/dist/index.js.map

@@ -1 +1 @@
-{"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,CAAA;AAErF,IAAIC,IAAI,GAAG,yBAAyB,CAAA;AAC7B,SAASC,SAASA,CAAC;AAAEC,EAAAA,IAAAA;AAAuB,CAAC,EAAE;AACpDF,EAAAA,IAAI,GAAGE,IAAI,CAACC,QAAQ,CAAC,GAAG,CAAC,GAAGD,IAAI,GAAI,CAAEA,EAAAA,IAAK,CAAE,CAAA,CAAA,CAAA;AAC/C,CAAA;AAEO,SAASE,SAASA,CAACC,OAAe,EAAEC,GAAkB,EAAE;EAC7D,IAAIA,GAAG,IAAIR,QAAQ,CAACS,GAAG,CAACF,OAAO,CAAC,EAAE;AAChC,IAAA,MAAM,IAAIG,KAAK,CAAE,CAAA,sDAAA,CAAuD,CAAC,CAAA;AAC3E,GAAA;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,CAAA;AAAE,KAAC,CAAC,CAAA;AACzD,GAAC,MAAM;AACLd,IAAAA,QAAQ,CAACe,MAAM,CAACR,OAAO,CAAC,CAAA;AAC1B,GAAA;AACF,CAAA;AAEA,IAAIS,YAAY,GAAG,KAAK,CAAA;AACjB,SAASC,cAAcA,CAACC,KAAc,EAAE;AAC7CF,EAAAA,YAAY,GAAGG,OAAO,CAACD,KAAK,CAAC,CAAA;AAC/B,CAAA;AACO,SAASE,cAAcA,GAAG;AAC/B,EAAA,OAAOJ,YAAY,CAAA;AACrB,CAAA;AAEO,MAAMK,iBAAiB,CAAoB;EAEhDC,WAAWA,CAACC,KAAa,EAAE;IACzB,IAAI,CAACA,KAAK,GAAGA,KAAK,CAAA;AACpB,GAAA;AACA,EAAA,MAAMV,OAAOA,CAAIN,OAAuB,EAAEiB,IAAe,EAAsC;IAC7F,MAAMC,IAAI,GAAGzB,QAAQ,CAAC0B,GAAG,CAAC,IAAI,CAACH,KAAK,CAAC,CAAA;IACrC,IAAI,CAACE,IAAI,EAAE;AACT,MAAA,MAAM,IAAIf,KAAK,CACZ,CAAA,gGAAA,CACH,CAAC,CAAA;AACH,KAAA;AAEA,IAAA,MAAMG,OAAoB,GAAGc,MAAM,CAACC,MAAM,CAAC,EAAE,EAAErB,OAAO,CAACM,OAAO,CAAC,CAAA;IAC/D,MAAMgB,WAAW,GAAGhB,OAAO,CAACiB,GAAG,CAAEzB,QAAQ,CAAC,WAAW,CAAC,CAAA;AACtD,IAAA,MAAM0B,SAAS,GAAGlB,OAAO,CAACiB,GAAG,CAAEE,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAA;IACxD,MAAMC,YAAY,GAAI,CAAEF,EAAAA,SAAU,aAAYN,IAAI,CAACb,EAAG,CACpDiB,sBAAAA,EAAAA,WAAW,GAAGJ,IAAI,CAACX,IAAI,EAAE,GAAGW,IAAI,CAACZ,OAAO,EACzC,CAAC,CAAA,CAAA;AACFA,IAAAA,OAAO,CAACiB,GAAG,GAAGjB,OAAO,CAACiB,GAAG,GAAGG,YAAY,CAAA;IAExCpB,OAAO,CAACqB,IAAI,GAAG,MAAM,CAAA;IACrBrB,OAAO,CAACsB,WAAW,GAAG,MAAM,CAAA;IAC5BtB,OAAO,CAACuB,cAAc,GAAG,EAAE,CAAA;IAE3B,IAAI;AACF,MAAA,MAAMC,MAAM,GAAGb,IAAI,CAACX,OAAO,CAAC,CAAA;MAC5BN,OAAO,CAAC+B,SAAS,CAACD,MAAM,CAACE,SAAS,EAAE,CAAC,CAAA;AACrC,MAAA,OAAO,MAAMF,MAAM,CAAA;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,CAAA;AACjD,OAAA;AACA,MAAA,MAAMO,CAAC,CAAA;AACT,KAAA;AACF,GAAA;AACF,CAAA;AAEO,eAAe1B,IAAIA,CAACS,KAAa,EAAEqB,QAA2B,EAAEf,WAAqB,EAAE;AAC5F,EAAA,MAAMJ,IAAI,GAAGzB,QAAQ,CAAC0B,GAAG,CAACH,KAAK,CAAC,CAAA;EAChC,IAAI,CAACE,IAAI,EAAE;AACT,IAAA,MAAM,IAAIf,KAAK,CAAE,CAAA,6FAAA,CAA8F,CAAC,CAAA;AAClH,GAAA;AACA,EAAA,MAAMmC,WAAW,GAAGpB,IAAI,CAACX,IAAI,EAAE,CAAA;AAC/B,EAAA,IAAIM,cAAc,EAAE,IAAIS,WAAW,EAAE;IAEnC,MAAMC,GAAG,GAAI,CAAA,EAAE5B,IAAK,CAAA,mBAAA,EAAqBuB,IAAI,CAACb,EAAG,CAAwBiC,sBAAAA,EAAAA,WAAY,CAAC,CAAA,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,EAAA;AAClB,KAAC,CAAC,CAAA;AACJ,GAAA;AACF;;;;"}
+{"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,CAAA;AAErF,IAAIC,IAAI,GAAG,yBAAyB,CAAA;AAC7B,SAASC,SAASA,CAAC;AAAEC,EAAAA,IAAAA;AAAuB,CAAC,EAAE;AACpDF,EAAAA,IAAI,GAAGE,IAAI,CAACC,QAAQ,CAAC,GAAG,CAAC,GAAGD,IAAI,GAAG,CAAGA,EAAAA,IAAI,CAAG,CAAA,CAAA,CAAA;AAC/C,CAAA;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,CAAA;AAC3E,GAAA;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,CAAA;AAAE,KAAC,CAAC,CAAA;AACzD,GAAC,MAAM;AACLd,IAAAA,QAAQ,CAACe,MAAM,CAACR,OAAO,CAAC,CAAA;AAC1B,GAAA;AACF,CAAA;AAEA,IAAIS,YAAY,GAAG,KAAK,CAAA;AACjB,SAASC,cAAcA,CAACC,KAAc,EAAE;AAC7CF,EAAAA,YAAY,GAAGG,OAAO,CAACD,KAAK,CAAC,CAAA;AAC/B,CAAA;AACO,SAASE,cAAcA,GAAG;AAC/B,EAAA,OAAOJ,YAAY,CAAA;AACrB,CAAA;AAEO,MAAMK,iBAAiB,CAAoB;EAEhDC,WAAWA,CAACC,KAAa,EAAE;IACzB,IAAI,CAACA,KAAK,GAAGA,KAAK,CAAA;AACpB,GAAA;AACA,EAAA,MAAMV,OAAOA,CAAIN,OAAuB,EAAEiB,IAAe,EAAsC;IAC7F,MAAMC,IAAI,GAAGzB,QAAQ,CAAC0B,GAAG,CAAC,IAAI,CAACH,KAAK,CAAC,CAAA;IACrC,IAAI,CAACE,IAAI,EAAE;AACT,MAAA,MAAM,IAAIf,KAAK,CACb,CAAA,gGAAA,CACF,CAAC,CAAA;AACH,KAAA;AAEA,IAAA,MAAMG,OAAoB,GAAGc,MAAM,CAACC,MAAM,CAAC,EAAE,EAAErB,OAAO,CAACM,OAAO,CAAC,CAAA;IAC/D,MAAMgB,WAAW,GAAGhB,OAAO,CAACiB,GAAG,CAAEzB,QAAQ,CAAC,WAAW,CAAC,CAAA;AACtD,IAAA,MAAM0B,SAAS,GAAGlB,OAAO,CAACiB,GAAG,CAAEE,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAA;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,CAAA;AACFA,IAAAA,OAAO,CAACiB,GAAG,GAAGjB,OAAO,CAACiB,GAAG,GAAGG,YAAY,CAAA;IAExCpB,OAAO,CAACqB,IAAI,GAAG,MAAM,CAAA;IACrBrB,OAAO,CAACsB,WAAW,GAAG,MAAM,CAAA;IAC5BtB,OAAO,CAACuB,cAAc,GAAG,EAAE,CAAA;IAE3B,IAAI;AACF,MAAA,MAAMC,MAAM,GAAGb,IAAI,CAACX,OAAO,CAAC,CAAA;MAC5BN,OAAO,CAAC+B,SAAS,CAACD,MAAM,CAACE,SAAS,EAAE,CAAC,CAAA;AACrC,MAAA,OAAO,MAAMF,MAAM,CAAA;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,CAAA;AACjD,OAAA;AACA,MAAA,MAAMO,CAAC,CAAA;AACT,KAAA;AACF,GAAA;AACF,CAAA;AAEO,eAAe1B,IAAIA,CAACS,KAAa,EAAEqB,QAA2B,EAAEf,WAAqB,EAAE;AAC5F,EAAA,MAAMJ,IAAI,GAAGzB,QAAQ,CAAC0B,GAAG,CAACH,KAAK,CAAC,CAAA;EAChC,IAAI,CAACE,IAAI,EAAE;AACT,IAAA,MAAM,IAAIf,KAAK,CAAC,CAAA,6FAAA,CAA+F,CAAC,CAAA;AAClH,GAAA;AACA,EAAA,MAAMmC,WAAW,GAAGpB,IAAI,CAACX,IAAI,EAAE,CAAA;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,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,EAAA;AAClB,KAAC,CAAC,CAAA;AACJ,GAAA;AACF;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warp-drive/holodeck",
   "description": "⚡️ Simple, Fast HTTP Mocking for Tests",
-  "version": "0.0.0-beta.11",
+  "version": "0.0.0-beta.13",
   "license": "MIT",
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
@@ -12,7 +12,7 @@
   "homepage": "https://github.com/emberjs/data",
   "bugs": "https://github.com/emberjs/data/issues",
   "engines": {
-    "node": ">= 18.20.3"
+    "node": ">= 18.20.4"
   },
   "keywords": [
     "http-mock"
@@ -23,7 +23,7 @@
   "dependencies": {
     "@hono/node-server": "^1.11.1",
     "chalk": "^5.3.0",
-    "hono": "^4.3.6"
+    "hono": "^4.6.5"
   },
   "type": "module",
   "files": [
@@ -38,14 +38,9 @@
   "bin": {
     "ensure-cert": "./server/ensure-cert.js"
   },
-  "scripts": {
-    "check:pkg-types": "tsc --noEmit",
-    "build:pkg": "vite build;",
-    "sync-hardlinks": "bun run sync-dependencies-meta-injected"
-  },
   "peerDependencies": {
-    "@ember-data/request": "5.4.0-beta.11",
-    "@warp-drive/core-types": "0.0.0-beta.11"
+    "@ember-data/request": "5.4.0-beta.13",
+    "@warp-drive/core-types": "0.0.0-beta.13"
   },
   "devDependencies": {
     "@babel/core": "^7.24.5",
@@ -53,11 +48,11 @@
     "@babel/preset-env": "^7.24.5",
     "@babel/preset-typescript": "^7.24.1",
     "@babel/runtime": "^7.24.5",
-    "@ember-data/request": "5.4.0-beta.11",
-    "@warp-drive/core-types": "0.0.0-beta.11",
-    "@warp-drive/internal-config": "5.4.0-beta.11",
+    "@ember-data/request": "5.4.0-beta.13",
+    "@warp-drive/core-types": "0.0.0-beta.13",
+    "@warp-drive/internal-config": "5.4.0-beta.13",
     "pnpm-sync-dependencies-meta-injected": "0.0.14",
-    "typescript": "^5.4.5",
+    "typescript": "^5.7.2",
     "vite": "^5.2.11"
   },
   "exports": {
@@ -84,5 +79,10 @@
     "@warp-drive/core-types": {
       "injected": true
     }
+  },
+  "scripts": {
+    "check:pkg-types": "tsc --noEmit",
+    "build:pkg": "vite build;",
+    "sync-hardlinks": "bun run sync-dependencies-meta-injected"
   }
-}
+}

package/server/ensure-cert.js

@@ -23,18 +23,26 @@ function main() {
   let KEY_PATH = process.env.HOLODECK_SSL_KEY_PATH;
   const configFilePath = getShellConfigFilePath();
 
-  if (!CERT_PATH) {
-    CERT_PATH = path.join(homedir(), 'holodeck-localhost.pem');
-    process.env.HOLODECK_SSL_CERT_PATH = CERT_PATH;
-    execSync(`echo '\nexport HOLODECK_SSL_CERT_PATH="${CERT_PATH}"' >> ${configFilePath}`);
-    console.log(`Added HOLODECK_SSL_CERT_PATH to ${configFilePath}`);
-  }
-
-  if (!KEY_PATH) {
-    KEY_PATH = path.join(homedir(), 'holodeck-localhost-key.pem');
-    process.env.HOLODECK_SSL_KEY_PATH = KEY_PATH;
-    execSync(`echo '\nexport HOLODECK_SSL_KEY_PATH="${KEY_PATH}"' >> ${configFilePath}`);
-    console.log(`Added HOLODECK_SSL_KEY_PATH to ${configFilePath}`);
+  if (!CERT_PATH || !KEY_PATH) {
+    console.log(`Environment variables not found, updating the environment config file...\n`);
+
+    if (!CERT_PATH) {
+      CERT_PATH = path.join(homedir(), 'holodeck-localhost.pem');
+      process.env.HOLODECK_SSL_CERT_PATH = CERT_PATH;
+      execSync(`echo '\nexport HOLODECK_SSL_CERT_PATH="${CERT_PATH}"' >> ${configFilePath}`);
+      console.log(`Added HOLODECK_SSL_CERT_PATH to ${configFilePath}`);
+    }
+
+    if (!KEY_PATH) {
+      KEY_PATH = path.join(homedir(), 'holodeck-localhost-key.pem');
+      process.env.HOLODECK_SSL_KEY_PATH = KEY_PATH;
+      execSync(`echo '\nexport HOLODECK_SSL_KEY_PATH="${KEY_PATH}"' >> ${configFilePath}`);
+      console.log(`Added HOLODECK_SSL_KEY_PATH to ${configFilePath}`);
+    }
+
+    console.log(
+      `\n*** Please restart your terminal session to apply the changes or run \`source ${configFilePath}\`. ***\n`
+    );
   }
 
   if (!fs.existsSync(CERT_PATH) || !fs.existsSync(KEY_PATH)) {

package/server/index.js

@@ -5,12 +5,11 @@ import { Hono } from 'hono';
 import { cors } from 'hono/cors';
 import { HTTPException } from 'hono/http-exception';
 import { logger } from 'hono/logger';
-import { execSync } from 'node:child_process';
 import crypto from 'node:crypto';
 import fs from 'node:fs';
 import http2 from 'node:http2';
 import zlib from 'node:zlib';
-import { homedir, userInfo } from 'os';
+import { homedir } from 'os';
 import path from 'path';
 
 /** @type {import('bun-types')} */
@@ -18,41 +17,30 @@ const isBun = typeof Bun !== 'undefined';
 const DEBUG = process.env.DEBUG?.includes('holodeck') || process.env.DEBUG === '*';
 const CURRENT_FILE = new URL(import.meta.url).pathname;
 
-function getShellConfigFilePath() {
-  const shell = userInfo().shell;
-  switch (shell) {
-    case '/bin/zsh':
-      return path.join(homedir(), '.zshrc');
-    case '/bin/bash':
-      return path.join(homedir(), '.bashrc');
-    default:
-      throw Error(
-        `Unable to determine configuration file for shell: ${shell}. Manual SSL Cert Setup Required for Holodeck.`
-      );
-  }
-}
-
 function getCertInfo() {
   let CERT_PATH = process.env.HOLODECK_SSL_CERT_PATH;
   let KEY_PATH = process.env.HOLODECK_SSL_KEY_PATH;
-  const configFilePath = getShellConfigFilePath();
 
   if (!CERT_PATH) {
     CERT_PATH = path.join(homedir(), 'holodeck-localhost.pem');
     process.env.HOLODECK_SSL_CERT_PATH = CERT_PATH;
-    execSync(`echo '\nexport HOLODECK_SSL_CERT_PATH="${CERT_PATH}"' >> ${configFilePath}`);
-    console.log(`Added HOLODECK_SSL_CERT_PATH to ${configFilePath}`);
+
+    console.log(
+      `HOLODECK_SSL_CERT_PATH was not found in the current environment. Setting it to default value of ${CERT_PATH}`
+    );
   }
 
   if (!KEY_PATH) {
     KEY_PATH = path.join(homedir(), 'holodeck-localhost-key.pem');
     process.env.HOLODECK_SSL_KEY_PATH = KEY_PATH;
-    execSync(`echo '\nexport HOLODECK_SSL_KEY_PATH="${KEY_PATH}"' >> ${configFilePath}`);
-    console.log(`Added HOLODECK_SSL_KEY_PATH to ${configFilePath}`);
+
+    console.log(
+      `HOLODECK_SSL_KEY_PATH was not found in the current environment. Setting it to default value of ${KEY_PATH}`
+    );
   }
 
   if (!fs.existsSync(CERT_PATH) || !fs.existsSync(KEY_PATH)) {
-    throw new Error('SSL certificate or key not found, you may need to run `npx -p @warp-drive/holodeck ensure-cert`');
+    throw new Error('SSL certificate or key not found, you may need to run `pnpx @warp-drive/holodeck ensure-cert`');
   }
 
   return {
@@ -147,96 +135,116 @@ function replayRequest(context, cacheKey) {
 
 function createTestHandler(projectRoot) {
   const TestHandler = async (context) => {
-    const { req } = context;
-
-    const testId = req.query('__xTestId');
-    const testRequestNumber = req.query('__xTestRequestNumber');
-    const niceUrl = getNiceUrl(req.url);
+    try {
+      const { req } = context;
+
+      const testId = req.query('__xTestId');
+      const testRequestNumber = req.query('__xTestRequestNumber');
+      const niceUrl = getNiceUrl(req.url);
+
+      if (!testId) {
+        context.header('Content-Type', 'application/vnd.api+json');
+        context.status(400);
+        return context.body(
+          JSON.stringify({
+            errors: [
+              {
+                status: '400',
+                code: 'MISSING_X_TEST_ID_HEADER',
+                title: 'Request to the http mock server is missing the `X-Test-Id` header',
+                detail:
+                  "The `X-Test-Id` header is used to identify the test that is making the request to the mock server. This is used to ensure that the mock server is only used for the test that is currently running. If using @ember-data/request add import { MockServerHandler } from '@warp-drive/holodeck'; to your request handlers.",
+                source: { header: 'X-Test-Id' },
+              },
+            ],
+          })
+        );
+      }
 
-    if (!testId) {
-      context.header('Content-Type', 'application/vnd.api+json');
-      context.status(400);
-      return context.body(
-        JSON.stringify({
-          errors: [
-            {
-              status: '400',
-              code: 'MISSING_X_TEST_ID_HEADER',
-              title: 'Request to the http mock server is missing the `X-Test-Id` header',
-              detail:
-                "The `X-Test-Id` header is used to identify the test that is making the request to the mock server. This is used to ensure that the mock server is only used for the test that is currently running. If using @ember-data/request add import { MockServerHandler } from '@warp-drive/holodeck'; to your request handlers.",
-              source: { header: 'X-Test-Id' },
-            },
-          ],
-        })
-      );
-    }
+      if (!testRequestNumber) {
+        context.header('Content-Type', 'application/vnd.api+json');
+        context.status(400);
+        return context.body(
+          JSON.stringify({
+            errors: [
+              {
+                status: '400',
+                code: 'MISSING_X_TEST_REQUEST_NUMBER_HEADER',
+                title: 'Request to the http mock server is missing the `X-Test-Request-Number` header',
+                detail:
+                  "The `X-Test-Request-Number` header is used to identify the request number for the current test. This is used to ensure that the mock server response is deterministic for the test that is currently running. If using @ember-data/request add import { MockServerHandler } from '@warp-drive/holodeck'; to your request handlers.",
+                source: { header: 'X-Test-Request-Number' },
+              },
+            ],
+          })
+        );
+      }
 
-    if (!testRequestNumber) {
+      if (req.method === 'POST' || niceUrl === '__record') {
+        const payload = await req.json();
+        const { url, headers, method, status, statusText, body, response } = payload;
+        const cacheKey = generateFilepath({
+          projectRoot,
+          testId,
+          url,
+          method,
+          body: body ? JSON.stringify(body) : null,
+          testRequestNumber,
+        });
+        // allow Content-Type to be overridden
+        headers['Content-Type'] = headers['Content-Type'] || 'application/vnd.api+json';
+        // We always compress and chunk the response
+        headers['Content-Encoding'] = 'br';
+        // we don't cache since tests will often reuse similar urls for different payload
+        headers['Cache-Control'] = 'no-store';
+
+        const cacheDir = generateFileDir({
+          projectRoot,
+          testId,
+          url,
+          method,
+          testRequestNumber,
+        });
+
+        fs.mkdirSync(cacheDir, { recursive: true });
+        fs.writeFileSync(
+          `${cacheKey}.meta.json`,
+          JSON.stringify({ url, status, statusText, headers, method, requestBody: body }, null, 2)
+        );
+        fs.writeFileSync(`${cacheKey}.body.br`, compress(JSON.stringify(response)));
+        context.status(204);
+        return context.body(null);
+      } else {
+        const body = await req.text();
+        const cacheKey = generateFilepath({
+          projectRoot,
+          testId,
+          url: niceUrl,
+          method: req.method,
+          body,
+          testRequestNumber,
+        });
+        return replayRequest(context, cacheKey);
+      }
+    } catch (e) {
+      if (e instanceof HTTPException) {
+        throw e;
+      }
       context.header('Content-Type', 'application/vnd.api+json');
-      context.status(400);
+      context.status(500);
       return context.body(
         JSON.stringify({
           errors: [
             {
-              status: '400',
-              code: 'MISSING_X_TEST_REQUEST_NUMBER_HEADER',
-              title: 'Request to the http mock server is missing the `X-Test-Request-Number` header',
-              detail:
-                "The `X-Test-Request-Number` header is used to identify the request number for the current test. This is used to ensure that the mock server response is deterministic for the test that is currently running. If using @ember-data/request add import { MockServerHandler } from '@warp-drive/holodeck'; to your request handlers.",
-              source: { header: 'X-Test-Request-Number' },
+              status: '500',
+              code: 'MOCK_SERVER_ERROR',
+              title: 'Mock Server Error during Request',
+              detail: e.message,
             },
           ],
         })
       );
     }
-
-    if (req.method === 'POST' || niceUrl === '__record') {
-      const payload = await req.json();
-      const { url, headers, method, status, statusText, body, response } = payload;
-      const cacheKey = generateFilepath({
-        projectRoot,
-        testId,
-        url,
-        method,
-        body: body ? JSON.stringify(body) : null,
-        testRequestNumber,
-      });
-      // allow Content-Type to be overridden
-      headers['Content-Type'] = headers['Content-Type'] || 'application/vnd.api+json';
-      // We always compress and chunk the response
-      headers['Content-Encoding'] = 'br';
-      // we don't cache since tests will often reuse similar urls for different payload
-      headers['Cache-Control'] = 'no-store';
-
-      const cacheDir = generateFileDir({
-        projectRoot,
-        testId,
-        url,
-        method,
-        testRequestNumber,
-      });
-
-      fs.mkdirSync(cacheDir, { recursive: true });
-      fs.writeFileSync(
-        `${cacheKey}.meta.json`,
-        JSON.stringify({ url, status, statusText, headers, method, requestBody: body }, null, 2)
-      );
-      fs.writeFileSync(`${cacheKey}.body.br`, compress(JSON.stringify(response)));
-      context.status(204);
-      return context.body(null);
-    } else {
-      const body = await req.text();
-      const cacheKey = generateFilepath({
-        projectRoot,
-        testId,
-        url: niceUrl,
-        method: req.method,
-        body,
-        testRequestNumber,
-      });
-      return replayRequest(context, cacheKey);
-    }
   };
 
   return TestHandler;
@@ -342,11 +350,11 @@ export default {
   async endProgram() {
     console.log(chalk.grey(`\n\tEnding Subroutines (mode:${chalk.cyan(isBun ? 'bun' : 'node')})`));
     const projectRoot = process.cwd();
-    const name = await import(path.join(projectRoot, 'package.json'), { with: { type: 'json' } }).then(
-      (pkg) => pkg.name
-    );
 
     if (!servers.has(projectRoot)) {
+      const name = await import(path.join(projectRoot, 'package.json'), { with: { type: 'json' } }).then(
+        (pkg) => pkg.name
+      );
       throw new Error(`Holodeck was not running for project '${name}' at '${projectRoot}'`);
     }