msw 2.7.4 → 2.7.5

package/lib/mockServiceWorker.js

@@ -8,7 +8,7 @@
  * - Please do NOT serve this file on production.
  */
 
-const PACKAGE_VERSION = '2.7.4'
+const PACKAGE_VERSION = '2.7.5'
 const INTEGRITY_CHECKSUM = '00729d72e3b82faf54ca8b9621dbb96f'
 const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
 const activeClientIds = new Set()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msw",
-  "version": "2.7.4",
+  "version": "2.7.5",
   "description": "Seamless REST/GraphQL API mocking library for browser and Node.js.",
   "main": "./lib/core/index.js",
   "module": "./lib/core/index.mjs",

package/src/core/handlers/WebSocketHandler.test.ts

@@ -0,0 +1,160 @@
+import type { WebSocketConnectionData } from '@mswjs/interceptors/WebSocket'
+import { WebSocketHandler } from './WebSocketHandler'
+
+describe('parse', () => {
+  it('matches an exact url', () => {
+    expect(
+      new WebSocketHandler('ws://localhost:3000').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL('ws://localhost:3000'),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: true,
+        params: {},
+      },
+    })
+  })
+
+  it('ignores trailing slash', () => {
+    expect(
+      new WebSocketHandler('ws://localhost:3000').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL('ws://localhost:3000/'),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: true,
+        params: {},
+      },
+    })
+
+    expect(
+      new WebSocketHandler('ws://localhost:3000/').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL('ws://localhost:3000'),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: true,
+        params: {},
+      },
+    })
+  })
+
+  it('supports path parameters', () => {
+    expect(
+      new WebSocketHandler('ws://localhost:3000/:serviceName').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL('ws://localhost:3000/auth'),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: true,
+        params: {
+          serviceName: 'auth',
+        },
+      },
+    })
+  })
+
+  it('ignores "/socket.io/" prefix in the client url', () => {
+    expect(
+      new WebSocketHandler('ws://localhost:3000').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL(
+                'ws://localhost:3000/socket.io/?EIO=4&transport=websocket',
+              ),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: true,
+        params: {},
+      },
+    })
+
+    expect(
+      new WebSocketHandler('ws://localhost:3000/non-matching').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL(
+                'ws://localhost:3000/socket.io/?EIO=4&transport=websocket',
+              ),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: false,
+        params: {},
+      },
+    })
+  })
+
+  it('preserves non-prefix "/socket.io/" path segment', () => {
+    /**
+     * @note It is highly unlikely but we still shouldn't modify the
+     * WebSocket client URL if it contains a user-defined "socket.io" segment.
+     */
+    expect(
+      new WebSocketHandler('ws://localhost:3000/clients/socket.io/123').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL('ws://localhost:3000/clients/socket.io/123'),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: true,
+        params: {},
+      },
+    })
+
+    expect(
+      new WebSocketHandler('ws://localhost:3000').parse({
+        event: new MessageEvent('connection', {
+          data: {
+            client: {
+              url: new URL('ws://localhost:3000/clients/socket.io/123'),
+            },
+          } as WebSocketConnectionData,
+        }),
+      }),
+    ).toEqual({
+      match: {
+        matches: false,
+        params: {},
+      },
+    })
+  })
+})

package/src/core/handlers/WebSocketHandler.ts

@@ -47,8 +47,17 @@ export class WebSocketHandler {
   public parse(args: {
     event: MessageEvent<WebSocketConnectionData>
   }): WebSocketHandlerParsedResult {
-    const connection = args.event.data
-    const match = matchRequestUrl(connection.client.url, this.url)
+    const { data: connection } = args.event
+    const { url: clientUrl } = connection.client
+
+    /**
+     * @note Remove the Socket.IO path prefix from the WebSocket
+     * client URL. This is an exception to keep the users from
+     * including the implementation details in their handlers.
+     */
+    clientUrl.pathname = clientUrl.pathname.replace(/^\/socket.io\//, '/')
+
+    const match = matchRequestUrl(clientUrl, this.url)
 
     return {
       match,