@squide/msw 4.0.20 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @squide/msw
 
+## 4.1.0
+
+### Minor Changes
+
+- [#631](https://github.com/workleap/wl-squide/pull/631) [`9bbcd7e`](https://github.com/workleap/wl-squide/commit/9bbcd7e1597d0c473a1477f608e3596390553bb4) Thanks [@patricklafrance](https://github.com/patricklafrance)! - `registerRequestHandlers` now accepts a `prepend` option (mirroring `registerRoute`'s `hoist` flag). Prepended handlers are placed before the appended ones, with registration order preserved within each group.
+
+  MSW evaluates handlers in registration order and a handler returning nothing falls through to the next matching handler, so `prepend` enables middleware-like fall-through handlers (artificial latency, request logging, chaos testing) that must run before the regular handlers — regardless of module registration timing:
+
+  ```ts
+  runtime.registerRequestHandlers([latencyRequestHandler], { prepend: true });
+  ```
+
 ## 4.0.20
 
 ### Patch Changes

package/dist/MswPlugin.d.ts

@@ -8,6 +8,7 @@ export interface MswPluginOptions {
 }
 export interface MswPluginRegisterRequestHandlersOptions {
     logger?: Logger;
+    prepend?: true;
 }
 export declare class MswPlugin extends Plugin {
     #private;

package/dist/MswPlugin.js

@@ -22,8 +22,10 @@ class MswPlugin extends Plugin {
         return this.#mswState;
     }
     registerRequestHandlers(handlers, options = {}) {
-        const { logger } = options;
-        this.#requestHandlerRegistry.add(handlers);
+        const { logger, prepend } = options;
+        this.#requestHandlerRegistry.add(handlers, {
+            prepend
+        });
         (logger ? logger : this._runtime.logger).withText("[squide] The following MSW request handlers has been registered:").withObject(handlers).debug();
     }
     get requestHandlers() {

package/dist/MswPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"MswPlugin.js","sources":["../src/MswPlugin.ts"],"sourcesContent":["import { Plugin, type Runtime } from \"@squide/core\";\nimport type { Logger } from \"@workleap/logging\";\nimport type { RequestHandler } from \"msw\";\nimport { MswState } from \"./MswState.ts\";\nimport { RequestHandlerRegistry } from \"./RequestHandlerRegistry.ts\";\n\nexport const MswPluginName = \"msw-plugin\";\n\nexport interface MswPluginOptions {\n    state?: MswState;\n}\n\nexport interface MswPluginRegisterRequestHandlersOptions {\n    logger?: Logger;\n}\n\nexport class MswPlugin extends Plugin {\n    readonly #mswState: MswState;\n    readonly #requestHandlerRegistry: RequestHandlerRegistry;\n\n    constructor(runtime: Runtime, options: MswPluginOptions = {}) {\n        const {\n            state = new MswState()\n        } = options;\n\n        super(MswPluginName, runtime);\n\n        this.#mswState = state;\n        this.#requestHandlerRegistry = new RequestHandlerRegistry(this.#mswState);\n    }\n\n    get mswState() {\n        return this.#mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: MswPluginRegisterRequestHandlersOptions = {}) {\n        const {\n            logger\n        } = options;\n\n        this.#requestHandlerRegistry.add(handlers);\n\n        (logger ? logger : this._runtime.logger)\n            .withText(\"[squide] The following MSW request handlers has been registered:\")\n            .withObject(handlers)\n            .debug();\n    }\n\n    get requestHandlers(): RequestHandler[] {\n        return this.#requestHandlerRegistry.handlers;\n    }\n}\n\nexport function getMswPlugin(runtime: Runtime) {\n    const plugin = runtime.getPlugin(MswPluginName, {\n        throwOnNotFound: false\n    }) as MswPlugin;\n\n    if (!plugin) {\n        throw new Error(\"[squide] The getMswPlugin function is called but no MswPlugin instance has been registered with the runtime. Did you provide a MswPlugin instance to the runtime instance or set the useMsw option of the initializeFirefly function to true?\");\n    }\n\n    return plugin;\n}\n"],"names":["Plugin","MswState","RequestHandlerRegistry","MswPluginName","MswPlugin","runtime","options","state","handlers","logger","getMswPlugin","plugin","Error"],"mappings":";;;;;;;AAAoD;AAGX;AAC4B;AAE9D,MAAMG,aAAaA,GAAG,aAAa;AAUnC,MAAMC,SAASA,SAASJ,MAAMA;IACxB,SAAS,CAAW;IACpB,uBAAuB,CAAyB;IAEzD,YAAYK,OAAgB,EAAEC,UAA4B,CAAC,CAAC,CAAE;QAC1D,MAAM,EACFC,QAAQ,IAAIN,QAAQA,EAAE,EACzB,GAAGK;QAEJ,KAAK,CAACH,aAAaA,EAAEE;QAErB,IAAI,CAAC,SAAS,GAAGE;QACjB,IAAI,CAAC,uBAAuB,GAAG,IAAIL,sBAAsBA,CAAC,IAAI,CAAC,SAAS;IAC5E;IAEA,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,wBAAwBM,QAA0B,EAAEF,UAAmD,CAAC,CAAC,EAAE;QACvG,MAAM,EACFG,MAAM,EACT,GAAGH;QAEJ,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAACE;QAEhCC,CAAAA,SAASA,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAK,EACjC,QAAQ,CAAC,oEACT,UAAU,CAACD,UACX,KAAK;IACd;IAEA,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ;IAChD;AACJ;AAEO,SAASE,YAAYA,CAACL,OAAgB;IACzC,MAAMM,SAASN,QAAQ,SAAS,CAACF,aAAaA,EAAE;QAC5C,iBAAiB;IACrB;IAEA,IAAI,CAACQ,QAAQ;QACT,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOD;AACX"}
+{"version":3,"file":"MswPlugin.js","sources":["../src/MswPlugin.ts"],"sourcesContent":["import { Plugin, type Runtime } from \"@squide/core\";\nimport type { Logger } from \"@workleap/logging\";\nimport type { RequestHandler } from \"msw\";\nimport { MswState } from \"./MswState.ts\";\nimport { RequestHandlerRegistry } from \"./RequestHandlerRegistry.ts\";\n\nexport const MswPluginName = \"msw-plugin\";\n\nexport interface MswPluginOptions {\n    state?: MswState;\n}\n\nexport interface MswPluginRegisterRequestHandlersOptions {\n    logger?: Logger;\n    prepend?: true;\n}\n\nexport class MswPlugin extends Plugin {\n    readonly #mswState: MswState;\n    readonly #requestHandlerRegistry: RequestHandlerRegistry;\n\n    constructor(runtime: Runtime, options: MswPluginOptions = {}) {\n        const {\n            state = new MswState()\n        } = options;\n\n        super(MswPluginName, runtime);\n\n        this.#mswState = state;\n        this.#requestHandlerRegistry = new RequestHandlerRegistry(this.#mswState);\n    }\n\n    get mswState() {\n        return this.#mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: MswPluginRegisterRequestHandlersOptions = {}) {\n        const {\n            logger,\n            prepend\n        } = options;\n\n        this.#requestHandlerRegistry.add(handlers, { prepend });\n\n        (logger ? logger : this._runtime.logger)\n            .withText(\"[squide] The following MSW request handlers has been registered:\")\n            .withObject(handlers)\n            .debug();\n    }\n\n    get requestHandlers(): RequestHandler[] {\n        return this.#requestHandlerRegistry.handlers;\n    }\n}\n\nexport function getMswPlugin(runtime: Runtime) {\n    const plugin = runtime.getPlugin(MswPluginName, {\n        throwOnNotFound: false\n    }) as MswPlugin;\n\n    if (!plugin) {\n        throw new Error(\"[squide] The getMswPlugin function is called but no MswPlugin instance has been registered with the runtime. Did you provide a MswPlugin instance to the runtime instance or set the useMsw option of the initializeFirefly function to true?\");\n    }\n\n    return plugin;\n}\n"],"names":["Plugin","MswState","RequestHandlerRegistry","MswPluginName","MswPlugin","runtime","options","state","handlers","logger","prepend","getMswPlugin","plugin","Error"],"mappings":";;;;;;;AAAoD;AAGX;AAC4B;AAE9D,MAAMG,aAAaA,GAAG,aAAa;AAWnC,MAAMC,SAASA,SAASJ,MAAMA;IACxB,SAAS,CAAW;IACpB,uBAAuB,CAAyB;IAEzD,YAAYK,OAAgB,EAAEC,UAA4B,CAAC,CAAC,CAAE;QAC1D,MAAM,EACFC,QAAQ,IAAIN,QAAQA,EAAE,EACzB,GAAGK;QAEJ,KAAK,CAACH,aAAaA,EAAEE;QAErB,IAAI,CAAC,SAAS,GAAGE;QACjB,IAAI,CAAC,uBAAuB,GAAG,IAAIL,sBAAsBA,CAAC,IAAI,CAAC,SAAS;IAC5E;IAEA,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,SAAS;IACzB;IAEA,wBAAwBM,QAA0B,EAAEF,UAAmD,CAAC,CAAC,EAAE;QACvG,MAAM,EACFG,MAAM,EACNC,OAAO,EACV,GAAGJ;QAEJ,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAACE,UAAU;YAAEE;QAAQ;QAEpDD,CAAAA,SAASA,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAK,EACjC,QAAQ,CAAC,oEACT,UAAU,CAACD,UACX,KAAK;IACd;IAEA,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ;IAChD;AACJ;AAEO,SAASG,YAAYA,CAACN,OAAgB;IACzC,MAAMO,SAASP,QAAQ,SAAS,CAACF,aAAaA,EAAE;QAC5C,iBAAiB;IACrB;IAEA,IAAI,CAACS,QAAQ;QACT,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOD;AACX"}

package/dist/RequestHandlerRegistry.d.ts

@@ -1,8 +1,11 @@
 import type { RequestHandler } from "msw";
 import { MswState } from "./MswState.ts";
+export interface RequestHandlerRegistryAddOptions {
+    prepend?: true;
+}
 export declare class RequestHandlerRegistry {
     #private;
     constructor(mswState: MswState);
-    add(handlers: RequestHandler[]): void;
+    add(handlers: RequestHandler[], options?: RequestHandlerRegistryAddOptions): void;
     get handlers(): RequestHandler[];
 }

package/dist/RequestHandlerRegistry.js

@@ -1,19 +1,31 @@
 class RequestHandlerRegistry {
     #mswState;
-    #handlers = [];
+    #prependedHandlers = [];
+    #appendedHandlers = [];
     constructor(mswState){
         this.#mswState = mswState;
     }
-    add(handlers) {
+    add(handlers, options = {}) {
+        const { prepend = false } = options;
         if (this.#mswState.isReady) {
-            throw new Error("[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of a MSW request handler?");
+            throw new Error("[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of an MSW request handler?");
+        }
+        if (prepend) {
+            this.#prependedHandlers.push(...handlers);
+        } else {
+            this.#appendedHandlers.push(...handlers);
         }
-        this.#handlers.push(...handlers);
     }
+    // Prepended handlers are returned before the appended ones; within each group, the registration
+    // order is preserved. MSW evaluates handlers in order, which allows fall-through middleware
+    // handlers to be registered ahead of the regular handlers.
     // Must specify the return type, otherwise we get a TS2742: The inferred type cannot be named without a reference to X. This is likely not portable.
     // A type annotation is necessary.
     get handlers() {
-        return this.#handlers;
+        return [
+            ...this.#prependedHandlers,
+            ...this.#appendedHandlers
+        ];
     }
 }
 

package/dist/RequestHandlerRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"RequestHandlerRegistry.js","sources":["../src/RequestHandlerRegistry.ts"],"sourcesContent":["import type { RequestHandler } from \"msw\";\nimport { MswState } from \"./MswState.ts\";\n\nexport class RequestHandlerRegistry {\n    readonly #mswState: MswState;\n    readonly #handlers: RequestHandler[] = [];\n\n    constructor(mswState: MswState) {\n        this.#mswState = mswState;\n    }\n\n    add(handlers: RequestHandler[]) {\n        if (this.#mswState.isReady) {\n            throw new Error(\"[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of a MSW request handler?\");\n        }\n\n        this.#handlers.push(...handlers);\n    }\n\n    // Must specify the return type, otherwise we get a TS2742: The inferred type cannot be named without a reference to X. This is likely not portable.\n    // A type annotation is necessary.\n    get handlers(): RequestHandler[] {\n        return this.#handlers;\n    }\n}\n\n"],"names":["RequestHandlerRegistry","mswState","handlers","Error"],"mappings":"AAGO,MAAMA,sBAAsBA;IACtB,SAAS,CAAW;IACpB,SAAS,GAAqB,EAAE,CAAC;IAE1C,YAAYC,QAAkB,CAAE;QAC5B,IAAI,CAAC,SAAS,GAAGA;IACrB;IAEA,IAAIC,QAA0B,EAAE;QAC5B,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,IAAIC,MAAM;QACpB;QAEA,IAAI,CAAC,SAAS,CAAC,IAAI,IAAID;IAC3B;IAEA,oJAAoJ;IACpJ,kCAAkC;IAClC,IAAI,WAA6B;QAC7B,OAAO,IAAI,CAAC,SAAS;IACzB;AACJ"}
+{"version":3,"file":"RequestHandlerRegistry.js","sources":["../src/RequestHandlerRegistry.ts"],"sourcesContent":["import type { RequestHandler } from \"msw\";\nimport { MswState } from \"./MswState.ts\";\n\nexport interface RequestHandlerRegistryAddOptions {\n    prepend?: true;\n}\n\nexport class RequestHandlerRegistry {\n    readonly #mswState: MswState;\n    readonly #prependedHandlers: RequestHandler[] = [];\n    readonly #appendedHandlers: RequestHandler[] = [];\n\n    constructor(mswState: MswState) {\n        this.#mswState = mswState;\n    }\n\n    add(handlers: RequestHandler[], options: RequestHandlerRegistryAddOptions = {}) {\n        const {\n            prepend = false\n        } = options;\n\n        if (this.#mswState.isReady) {\n            throw new Error(\"[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of an MSW request handler?\");\n        }\n\n        if (prepend) {\n            this.#prependedHandlers.push(...handlers);\n        } else {\n            this.#appendedHandlers.push(...handlers);\n        }\n    }\n\n    // Prepended handlers are returned before the appended ones; within each group, the registration\n    // order is preserved. MSW evaluates handlers in order, which allows fall-through middleware\n    // handlers to be registered ahead of the regular handlers.\n    // Must specify the return type, otherwise we get a TS2742: The inferred type cannot be named without a reference to X. This is likely not portable.\n    // A type annotation is necessary.\n    get handlers(): RequestHandler[] {\n        return [...this.#prependedHandlers, ...this.#appendedHandlers];\n    }\n}\n\n"],"names":["RequestHandlerRegistry","mswState","handlers","options","prepend","Error"],"mappings":"AAOO,MAAMA,sBAAsBA;IACtB,SAAS,CAAW;IACpB,kBAAkB,GAAqB,EAAE,CAAC;IAC1C,iBAAiB,GAAqB,EAAE,CAAC;IAElD,YAAYC,QAAkB,CAAE;QAC5B,IAAI,CAAC,SAAS,GAAGA;IACrB;IAEA,IAAIC,QAA0B,EAAEC,UAA4C,CAAC,CAAC,EAAE;QAC5E,MAAM,EACFC,UAAU,KAAK,EAClB,GAAGD;QAEJ,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,IAAIE,MAAM;QACpB;QAEA,IAAID,SAAS;YACT,IAAI,CAAC,kBAAkB,CAAC,IAAI,IAAIF;QACpC,OAAO;YACH,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAIA;QACnC;IACJ;IAEA,gGAAgG;IAChG,4FAA4F;IAC5F,2DAA2D;IAC3D,oJAAoJ;IACpJ,kCAAkC;IAClC,IAAI,WAA6B;QAC7B,OAAO;eAAI,IAAI,CAAC,kBAAkB;eAAK,IAAI,CAAC,iBAAiB;SAAC;IAClE;AACJ"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["export { getMswPlugin, MswPlugin, MswPluginName, type MswPluginOptions, type MswPluginRegisterRequestHandlersOptions } from \"./MswPlugin.ts\";\nexport { MswState, type MswReadyListener, type MswStateOptions } from \"./MswState.ts\";\n\n"],"names":["getMswPlugin","MswPlugin","MswPluginName","MswState"],"mappings":";;AAA6I;AACvD"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["export { getMswPlugin, MswPlugin, MswPluginName, type MswPluginOptions, type MswPluginRegisterRequestHandlersOptions } from \"./MswPlugin.ts\";\nexport { MswState, type MswReadyListener, type MswStateOptions } from \"./MswState.ts\";\n"],"names":["getMswPlugin","MswPlugin","MswPluginName","MswState"],"mappings":";;AAA6I;AACvD"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/msw",
   "author": "Workleap",
-  "version": "4.0.20",
+  "version": "4.1.0",
   "description": "Add support for MSW to @squide application shell.",
   "license": "Apache-2.0",
   "repository": {
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "@workleap/logging": "^1.3.8",
-    "@squide/core": "^7.0.1"
+    "@squide/core": "^7.1.0"
   },
   "devDependencies": {
     "@eslint/js": "9.39.2",

package/src/MswPlugin.ts

@@ -12,6 +12,7 @@ export interface MswPluginOptions {
 
 export interface MswPluginRegisterRequestHandlersOptions {
     logger?: Logger;
+    prepend?: true;
 }
 
 export class MswPlugin extends Plugin {
@@ -35,10 +36,11 @@ export class MswPlugin extends Plugin {
 
     registerRequestHandlers(handlers: RequestHandler[], options: MswPluginRegisterRequestHandlersOptions = {}) {
         const {
-            logger
+            logger,
+            prepend
         } = options;
 
-        this.#requestHandlerRegistry.add(handlers);
+        this.#requestHandlerRegistry.add(handlers, { prepend });
 
         (logger ? logger : this._runtime.logger)
             .withText("[squide] The following MSW request handlers has been registered:")

package/src/RequestHandlerRegistry.ts

@@ -1,26 +1,42 @@
 import type { RequestHandler } from "msw";
 import { MswState } from "./MswState.ts";
 
+export interface RequestHandlerRegistryAddOptions {
+    prepend?: true;
+}
+
 export class RequestHandlerRegistry {
     readonly #mswState: MswState;
-    readonly #handlers: RequestHandler[] = [];
+    readonly #prependedHandlers: RequestHandler[] = [];
+    readonly #appendedHandlers: RequestHandler[] = [];
 
     constructor(mswState: MswState) {
         this.#mswState = mswState;
     }
 
-    add(handlers: RequestHandler[]) {
+    add(handlers: RequestHandler[], options: RequestHandlerRegistryAddOptions = {}) {
+        const {
+            prepend = false
+        } = options;
+
         if (this.#mswState.isReady) {
-            throw new Error("[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of a MSW request handler?");
+            throw new Error("[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of an MSW request handler?");
         }
 
-        this.#handlers.push(...handlers);
+        if (prepend) {
+            this.#prependedHandlers.push(...handlers);
+        } else {
+            this.#appendedHandlers.push(...handlers);
+        }
     }
 
+    // Prepended handlers are returned before the appended ones; within each group, the registration
+    // order is preserved. MSW evaluates handlers in order, which allows fall-through middleware
+    // handlers to be registered ahead of the regular handlers.
     // Must specify the return type, otherwise we get a TS2742: The inferred type cannot be named without a reference to X. This is likely not portable.
     // A type annotation is necessary.
     get handlers(): RequestHandler[] {
-        return this.#handlers;
+        return [...this.#prependedHandlers, ...this.#appendedHandlers];
     }
 }
 

package/src/index.ts

@@ -1,3 +1,2 @@
 export { getMswPlugin, MswPlugin, MswPluginName, type MswPluginOptions, type MswPluginRegisterRequestHandlersOptions } from "./MswPlugin.ts";
 export { MswState, type MswReadyListener, type MswStateOptions } from "./MswState.ts";
-