msw 2.12.8 → 2.12.10

package/lib/mockServiceWorker.js

@@ -7,7 +7,7 @@
  * - Please do NOT modify this file.
  */
 
-const PACKAGE_VERSION = '2.12.8'
+const PACKAGE_VERSION = '2.12.10'
 const INTEGRITY_CHECKSUM = '4db4a41e972cec1b64cc569c66952d82'
 const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
 const activeClientIds = new Set()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msw",
-  "version": "2.12.8",
+  "version": "2.12.10",
   "description": "Seamless REST/GraphQL API mocking library for browser and Node.js.",
   "type": "commonjs",
   "main": "./lib/core/index.js",
@@ -215,7 +215,7 @@
   "sideEffects": false,
   "dependencies": {
     "@inquirer/confirm": "^5.0.0",
-    "@mswjs/interceptors": "^0.41.0",
+    "@mswjs/interceptors": "^0.41.2",
     "@open-draft/deferred-promise": "^2.2.0",
     "@types/statuses": "^2.0.6",
     "cookie": "^1.0.2",
@@ -285,7 +285,7 @@
     "vitest-environment-miniflare": "^2.14.4",
     "webpack": "^5.95.0",
     "webpack-http-server": "^0.5.0",
-    "msw": "2.12.8"
+    "msw": "2.12.10"
   },
   "peerDependencies": {
     "typescript": ">= 4.8.x"

package/src/core/handlers/WebSocketHandler.ts

@@ -1,5 +1,5 @@
 import { Emitter } from 'strict-event-emitter'
-import { createRequestId } from '@mswjs/interceptors'
+import { createRequestId, resolveWebSocketUrl } from '@mswjs/interceptors'
 import type {
   WebSocketClientConnectionProtocol,
   WebSocketConnectionData,
@@ -46,7 +46,7 @@ export class WebSocketHandler {
 
   protected [kEmitter]: Emitter<WebSocketHandlerEventMap>
 
-  constructor(private readonly url: Path) {
+  constructor(protected readonly url: Path) {
     this.id = createRequestId()
 
     this[kEmitter] = new Emitter()
@@ -60,6 +60,15 @@ export class WebSocketHandler {
   }): WebSocketHandlerParsedResult {
     const clientUrl = new URL(args.url)
 
+    // Resolve the WebSocket handler path:
+    // - Plain string URLs resolved as per the specification (via Interceptors).
+    // - String URLs starting with a wildcard are preserved (prepending a scheme there will break them).
+    // - RegExp paths are preserved.
+    const resolvedHandlerUrl =
+      this.url instanceof RegExp || this.url.startsWith('*')
+        ? this.url
+        : this.#resolveWebSocketUrl(this.url, args.resolutionContext?.baseUrl)
+
     /**
      * @note Remove the Socket.IO path prefix from the WebSocket
      * client URL. This is an exception to keep the users from
@@ -69,7 +78,7 @@ export class WebSocketHandler {
 
     const match = matchRequestUrl(
       clientUrl,
-      this.url,
+      resolvedHandlerUrl,
       args.resolutionContext?.baseUrl,
     )
 
@@ -138,6 +147,26 @@ export class WebSocketHandler {
     // This is what the developer adds listeners for.
     return this[kEmitter].emit('connection', connection)
   }
+
+  #resolveWebSocketUrl(url: string, baseUrl?: string): string {
+    const resolvedUrl = resolveWebSocketUrl(
+      baseUrl
+        ? /**
+           * @note Resolve against the base URL preemtively because `resolveWebSocketUrl` only
+           * resolves against `location.href`, which is missing in Node.js. Base URL allows
+           * the handler to accept a relative URL in Node.js.
+           */
+          new URL(url, baseUrl)
+        : url,
+    )
+
+    /**
+     * @note Omit the trailing slash.
+     * While the browser always produces a trailing slash at the end of a WebSocket URL,
+     * having it in as the handler's predicate would mean it is *required* in the actual URL.
+     */
+    return resolvedUrl.replace(/\/$/, '')
+  }
 }
 
 function createStopPropagationListener(handler: WebSocketHandler) {

package/src/core/index.ts

@@ -26,6 +26,12 @@ export {
   type ServerSentEventMessage,
 } from './sse'
 
+import type { HttpHandler } from './handlers/HttpHandler'
+import type { GraphQLHandler } from './handlers/GraphQLHandler'
+import type { WebSocketHandler } from './handlers/WebSocketHandler'
+
+export type AnyHandler = HttpHandler | GraphQLHandler | WebSocketHandler
+
 /* Utils */
 export { matchRequestUrl } from './utils/matching/matchRequestUrl'
 export * from './utils/handleRequest'

package/src/core/utils/matching/matchRequestUrl.test.ts

@@ -5,71 +5,85 @@ import { coercePath, matchRequestUrl } from './matchRequestUrl'
 
 describe('matchRequestUrl', () => {
   test('returns true when matches against an exact URL', () => {
-    const match = matchRequestUrl(
-      new URL('https://test.mswjs.io'),
-      'https://test.mswjs.io',
-    )
-    expect(match).toHaveProperty('matches', true)
-    expect(match).toHaveProperty('params', {})
+    expect(
+      matchRequestUrl(
+        new URL('https://test.mswjs.io'),
+        'https://test.mswjs.io',
+      ),
+    ).toEqual({
+      matches: true,
+      params: {},
+    })
   })
 
   test('returns true when matched against a wildcard', () => {
-    const match = matchRequestUrl(new URL('https://test.mswjs.io'), '*')
-    expect(match).toHaveProperty('matches', true)
-    expect(match).toHaveProperty('params', {
-      '0': 'https://test.mswjs.io/',
+    expect(matchRequestUrl(new URL('https://test.mswjs.io'), '*')).toEqual({
+      matches: true,
+      params: {
+        '0': 'https://test.mswjs.io/',
+      },
     })
   })
 
   test('returns true when matched against a RegExp', () => {
-    const match = matchRequestUrl(
-      new URL('https://test.mswjs.io'),
-      /test\.mswjs\.io/,
-    )
-    expect(match).toHaveProperty('matches', true)
-    expect(match).toHaveProperty('params', {})
+    expect(
+      matchRequestUrl(new URL('https://test.mswjs.io'), /test\.mswjs\.io/),
+    ).toEqual({
+      matches: true,
+      params: {},
+    })
   })
 
   test('returns path parameters when matched', () => {
-    const match = matchRequestUrl(
-      new URL('https://test.mswjs.io/user/abc-123'),
-      'https://test.mswjs.io/user/:userId',
-    )
-    expect(match).toHaveProperty('matches', true)
-    expect(match).toHaveProperty('params', {
-      userId: 'abc-123',
+    expect(
+      matchRequestUrl(
+        new URL('https://test.mswjs.io/user/abc-123'),
+        'https://test.mswjs.io/user/:userId',
+      ),
+    ).toEqual({
+      matches: true,
+      params: {
+        userId: 'abc-123',
+      },
     })
   })
 
   test('decodes path parameters', () => {
     const url = 'http://example.com:5001/example'
-    const match = matchRequestUrl(
-      new URL(`https://test.mswjs.io/reflect-url/${encodeURIComponent(url)}`),
-      'https://test.mswjs.io/reflect-url/:url',
-    )
-    expect(match).toHaveProperty('matches', true)
-    expect(match).toHaveProperty('params', {
-      url,
+
+    expect(
+      matchRequestUrl(
+        new URL(`https://test.mswjs.io/reflect-url/${encodeURIComponent(url)}`),
+        'https://test.mswjs.io/reflect-url/:url',
+      ),
+    ).toEqual({
+      matches: true,
+      params: {
+        url,
+      },
     })
   })
 
   test('returns false when does not match against the request URL', () => {
-    const match = matchRequestUrl(
-      new URL('https://test.mswjs.io'),
-      'https://google.com',
-    )
-    expect(match).toHaveProperty('matches', false)
-    expect(match).toHaveProperty('params', {})
+    expect(
+      matchRequestUrl(new URL('https://test.mswjs.io'), 'https://google.com'),
+    ).toEqual({
+      matches: false,
+      params: {},
+    })
   })
 
   test('returns true when matching optional path parameters', () => {
-    const match = matchRequestUrl(
-      new URL('https://test.mswjs.io/user'),
-      'https://test.mswjs.io/user/:userId?',
-    )
-    expect(match).toHaveProperty('matches', true)
-    expect(match).toHaveProperty('params', {
-      userId: undefined,
+    expect(
+      matchRequestUrl(
+        new URL('https://test.mswjs.io/user/123'),
+        'https://test.mswjs.io/user/:userId?',
+      ),
+    ).toEqual({
+      matches: true,
+      params: {
+        userId: '123',
+      },
     })
   })