@msw/playwright 0.4.2 → 0.4.3

package/build/index.js

@@ -40,7 +40,7 @@ var NetworkFixture = class extends SetupApi {
 		this.#page = args.page;
 	}
 	async start() {
-		await this.#page.route(/.+/, async (route, request) => {
+		const httpRequestListener = async (route, request) => {
 			const fetchRequest = new Request(request.url(), {
 				method: request.method(),
 				headers: new Headers(await request.allHeaders()),
@@ -62,7 +62,8 @@ var NetworkFixture = class extends SetupApi {
 				return;
 			}
 			route.continue();
-		});
+		};
+		await this.#page.route(/.+/, httpRequestListener);
 		await this.#page.routeWebSocket(/.+/, async (ws) => {
 			const allWebSocketHandlers = this.handlersController.currentHandlers().filter((handler) => {
 				return handler instanceof WebSocketHandler;

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@msw/playwright",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Mock Service Worker binding for Playwright",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -20,8 +20,7 @@
   "funding": "https://github.com/sponsors/mswjs",
   "homepage": "https://mswjs.io",
   "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mswjs/playwright.git"
+    "url": "https://github.com/mswjs/playwright"
   },
   "author": {
     "name": "Artem Zakharchenko",
@@ -38,13 +37,13 @@
   },
   "devDependencies": {
     "@epic-web/test-server": "^0.1.6",
-    "@ossjs/release": "^0.8.1",
-    "@playwright/test": "^1.52.0",
+    "@ossjs/release": "^0.10.1",
+    "@playwright/test": "^1.57.0",
     "@types/node": "^22.15.29",
     "msw": "^2.10.3",
     "tsdown": "^0.12.7",
     "typescript": "^5.8.3",
-    "vite": "^7.0.2"
+    "vite": "^7.3.1"
   },
   "dependencies": {
     "@mswjs/interceptors": "^0.39.2",

package/src/fixture.ts

@@ -0,0 +1,411 @@
+import { invariant } from 'outvariant'
+import type {
+  Page,
+  PlaywrightTestArgs,
+  PlaywrightWorkerArgs,
+  Request,
+  Route,
+  TestFixture,
+  WebSocketRoute,
+} from '@playwright/test'
+import {
+  type LifeCycleEventsMap,
+  SetupApi,
+  RequestHandler,
+  WebSocketHandler,
+  getResponse,
+} from 'msw'
+import {
+  type WebSocketClientEventMap,
+  type WebSocketData,
+  type WebSocketServerEventMap,
+  CancelableMessageEvent,
+  CancelableCloseEvent,
+  WebSocketClientConnectionProtocol,
+  WebSocketServerConnectionProtocol,
+} from '@mswjs/interceptors/WebSocket'
+
+export interface CreateNetworkFixtureArgs {
+  initialHandlers: Array<RequestHandler | WebSocketHandler>
+}
+
+/**
+ * Creates a fixture that controls the network in your tests.
+ *
+ * @note The returned fixture already has the `auto` option set to `true`.
+ *
+ * **Usage**
+ * ```ts
+ * import { test as testBase } from '@playwright/test'
+ * import { createNetworkFixture, type WorkerFixture } from '@msw/playwright'
+ *
+ * interface Fixtures {
+ *  network: WorkerFixture
+ * }
+ *
+ * export const test = testBase.extend<Fixtures>({
+ *   network: createNetworkFixture()
+ * })
+ * ```
+ */
+export function createNetworkFixture(
+  args?: CreateNetworkFixtureArgs,
+  /** @todo `onUnhandledRequest`? */
+): [
+  TestFixture<NetworkFixture, PlaywrightTestArgs & PlaywrightWorkerArgs>,
+  { auto: boolean },
+] {
+  return [
+    async ({ page }, use) => {
+      const worker = new NetworkFixture({
+        page,
+        initialHandlers: args?.initialHandlers || [],
+      })
+
+      await worker.start()
+      await use(worker)
+      await worker.stop()
+    },
+    { auto: true },
+  ]
+}
+
+/**
+ * @note Use a match-all RegExp with an optional group as the predicate
+ * for the `page.route()`/`page.unroute()` calls. Playwright treats given RegExp
+ * as the handler ID, which allows us to remove only those handlers introduces by us
+ * without carrying the reference to the handler function around.
+ */
+export const INTERNAL_MATCH_ALL_REG_EXP = /.+(__MSW_PLAYWRIGHT_PREDICATE__)?/
+
+export class NetworkFixture extends SetupApi<LifeCycleEventsMap> {
+  #page: Page
+
+  constructor(args: {
+    page: Page
+    initialHandlers: Array<RequestHandler | WebSocketHandler>
+  }) {
+    super(...args.initialHandlers)
+    this.#page = args.page
+  }
+
+  public async start(): Promise<void> {
+    // Handle HTTP requests.
+    await this.#page.route(
+      INTERNAL_MATCH_ALL_REG_EXP,
+      async (route: Route, request: Request) => {
+        const fetchRequest = new Request(request.url(), {
+          method: request.method(),
+          headers: new Headers(await request.allHeaders()),
+          body: request.postDataBuffer(),
+        })
+
+        const response = await getResponse(
+          this.handlersController.currentHandlers().filter((handler) => {
+            return handler instanceof RequestHandler
+          }),
+          fetchRequest,
+          {
+            baseUrl: this.getPageUrl(),
+          },
+        )
+
+        if (response) {
+          if (response.status === 0) {
+            route.abort()
+            return
+          }
+
+          route.fulfill({
+            status: response.status,
+            headers: Object.fromEntries(response.headers),
+            body: response.body
+              ? Buffer.from(await response.arrayBuffer())
+              : undefined,
+          })
+          return
+        }
+
+        route.continue()
+      },
+    )
+
+    // Handle WebSocket connections.
+    await this.#page.routeWebSocket(INTERNAL_MATCH_ALL_REG_EXP, async (ws) => {
+      const allWebSocketHandlers = this.handlersController
+        .currentHandlers()
+        .filter((handler) => {
+          return handler instanceof WebSocketHandler
+        })
+
+      if (allWebSocketHandlers.length === 0) {
+        ws.connectToServer()
+        return
+      }
+
+      const client = new PlaywrightWebSocketClientConnection(ws)
+      const server = new PlaywrightWebSocketServerConnection(ws)
+
+      for (const handler of allWebSocketHandlers) {
+        await handler.run(
+          {
+            client,
+            server,
+            info: { protocols: [] },
+          },
+          {
+            baseUrl: this.getPageUrl(),
+          },
+        )
+      }
+    })
+  }
+
+  public async stop(): Promise<void> {
+    super.dispose()
+    await this.#page.unroute(INTERNAL_MATCH_ALL_REG_EXP)
+    await unrouteWebSocket(this.#page, INTERNAL_MATCH_ALL_REG_EXP)
+  }
+
+  private getPageUrl(): string | undefined {
+    const url = this.#page.url()
+    return url !== 'about:blank' ? url : undefined
+  }
+}
+
+class PlaywrightWebSocketClientConnection
+  implements WebSocketClientConnectionProtocol
+{
+  public id: string
+  public url: URL
+
+  constructor(protected readonly ws: WebSocketRoute) {
+    this.id = crypto.randomUUID()
+    this.url = new URL(ws.url())
+  }
+
+  public send(data: WebSocketData): void {
+    if (data instanceof Blob) {
+      /**
+       * @note Playwright does not support sending Blob data.
+       * Read the blob as buffer, then send the buffer instead.
+       */
+      data.bytes().then((bytes) => {
+        this.ws.send(Buffer.from(bytes))
+      })
+      return
+    }
+
+    if (typeof data === 'string') {
+      this.ws.send(data)
+      return
+    }
+
+    this.ws.send(
+      /**
+       * @note Forcefully cast all data to Buffer because Playwright
+       * has trouble digesting ArrayBuffer and Blob directly.
+       */
+      Buffer.from(
+        /**
+         * @note Playwright type definitions are tailored to Node.js
+         * while MSW describes all data types that can be sent over
+         * the WebSocket protocol, like ArrayBuffer and Blob.
+         */
+        data as any,
+      ),
+    )
+  }
+
+  public close(code?: number, reason?: string): void {
+    const resolvedCode = code ?? 1000
+    this.ws.close({ code: resolvedCode, reason })
+  }
+
+  public addEventListener<EventType extends keyof WebSocketClientEventMap>(
+    type: EventType,
+    listener: (
+      this: WebSocket,
+      event: WebSocketClientEventMap[EventType],
+    ) => void,
+    options?: AddEventListenerOptions | boolean,
+  ): void {
+    /**
+     * @note Playwright does not expose the actual WebSocket reference.
+     */
+    const target = {} as WebSocket
+
+    switch (type) {
+      case 'message': {
+        this.ws.onMessage((data) => {
+          listener.call(
+            target,
+            new CancelableMessageEvent('message', {
+              data,
+            }) as any,
+          )
+        })
+        break
+      }
+
+      case 'close': {
+        this.ws.onClose((code, reason) => {
+          listener.call(
+            target,
+            new CancelableCloseEvent('close', {
+              code,
+              reason,
+            }) as any,
+          )
+        })
+        break
+      }
+    }
+  }
+
+  public removeEventListener<EventType extends keyof WebSocketClientEventMap>(
+    event: EventType,
+    listener: (
+      this: WebSocket,
+      event: WebSocketClientEventMap[EventType],
+    ) => void,
+    options?: EventListenerOptions | boolean,
+  ): void {
+    console.warn(
+      '@msw/playwright: WebSocketRoute does not support removing event listeners',
+    )
+  }
+}
+
+class PlaywrightWebSocketServerConnection
+  implements WebSocketServerConnectionProtocol
+{
+  #server?: WebSocketRoute
+  #bufferedEvents: Array<
+    Parameters<WebSocketServerConnectionProtocol['addEventListener']>
+  >
+  #bufferedData: Array<WebSocketData>
+
+  constructor(protected readonly ws: WebSocketRoute) {
+    this.#bufferedEvents = []
+    this.#bufferedData = []
+  }
+
+  public connect(): void {
+    this.#server = this.ws.connectToServer()
+
+    /**
+     * @note Playwright does not support event buffering.
+     * Manually add event listeners that might have been registered
+     * before `connect()` was called.
+     */
+    for (const [type, listener, options] of this.#bufferedEvents) {
+      this.addEventListener(type, listener, options)
+    }
+    this.#bufferedEvents.length = 0
+
+    // Same for the buffered data.
+    for (const data of this.#bufferedData) {
+      this.send(data)
+    }
+    this.#bufferedData.length = 0
+  }
+
+  public send(data: WebSocketData): void {
+    if (this.#server == null) {
+      this.#bufferedData.push(data)
+      return
+    }
+
+    this.#server.send(data as any)
+  }
+
+  public close(code?: number, reason?: string): void {
+    invariant(
+      this.#server,
+      'Failed to close connection to the actual WebSocket server: connection not established. Did you forget to call `connect()`?',
+    )
+
+    this.#server.close({ code, reason })
+  }
+
+  public addEventListener<EventType extends keyof WebSocketServerEventMap>(
+    type: EventType,
+    listener: (
+      this: WebSocket,
+      event: WebSocketServerEventMap[EventType],
+    ) => void,
+    options?: AddEventListenerOptions | boolean,
+  ): void {
+    if (this.#server == null) {
+      this.#bufferedEvents.push([type, listener as any, options])
+      return
+    }
+
+    const target = {} as WebSocket
+    switch (type) {
+      case 'message': {
+        this.#server.onMessage((data) => {
+          listener.call(
+            target,
+            new CancelableMessageEvent('message', { data }) as any,
+          )
+        })
+        break
+      }
+
+      case 'close': {
+        this.#server.onClose((code, reason) => {
+          listener.call(
+            target,
+            new CancelableCloseEvent('close', { code, reason }) as any,
+          )
+        })
+        break
+      }
+    }
+  }
+
+  public removeEventListener<EventType extends keyof WebSocketServerEventMap>(
+    type: EventType,
+    listener: (
+      this: WebSocket,
+      event: WebSocketServerEventMap[EventType],
+    ) => void,
+    options?: EventListenerOptions | boolean,
+  ): void {
+    console.warn(
+      '@msw/playwright: WebSocketRoute does not support removing event listeners',
+    )
+  }
+}
+
+interface InternalWebSocketRoute {
+  url: Parameters<Page['routeWebSocket']>[0]
+  handler: Parameters<Page['routeWebSocket']>[1]
+}
+
+/**
+ * Custom implementation of the missing `page.unrouteWebSocket()` to remove
+ * WebSocket route handlers from the page. Loosely inspired by `page.unroute()`.
+ */
+async function unrouteWebSocket(
+  page: Page,
+  url: InternalWebSocketRoute['url'],
+  handler?: InternalWebSocketRoute['handler'],
+): Promise<void> {
+  if (!('_webSocketRoutes' in page && Array.isArray(page._webSocketRoutes))) {
+    return
+  }
+
+  for (let i = page._webSocketRoutes.length - 1; i >= 0; i--) {
+    const route = page._webSocketRoutes[i] as InternalWebSocketRoute
+
+    if (
+      route.url === url &&
+      (handler != null ? route.handler === handler : true)
+    ) {
+      page._webSocketRoutes.splice(i, 1)
+    }
+  }
+}

package/src/index.ts

@@ -1,367 +1,5 @@
-import { invariant } from 'outvariant'
-import type {
-  Page,
-  PlaywrightTestArgs,
-  PlaywrightWorkerArgs,
-  TestFixture,
-  WebSocketRoute,
-} from '@playwright/test'
-import {
-  type LifeCycleEventsMap,
-  SetupApi,
-  RequestHandler,
-  WebSocketHandler,
-  getResponse,
-} from 'msw'
-import {
-  type WebSocketClientEventMap,
-  type WebSocketData,
-  type WebSocketServerEventMap,
-  CancelableMessageEvent,
-  CancelableCloseEvent,
-  WebSocketClientConnectionProtocol,
-  WebSocketServerConnectionProtocol,
-} from '@mswjs/interceptors/WebSocket'
-
-export interface CreateNetworkFixtureArgs {
-  initialHandlers: Array<RequestHandler | WebSocketHandler>
-}
-
-/**
- * Creates a fixture that controls the network in your tests.
- *
- * @note The returned fixture already has the `auto` option set to `true`.
- *
- * **Usage**
- * ```ts
- * import { test as testBase } from '@playwright/test'
- * import { createNetworkFixture, type WorkerFixture } from '@msw/playwright'
- *
- * interface Fixtures {
- *  network: WorkerFixture
- * }
- *
- * export const test = testBase.extend<Fixtures>({
- *   network: createNetworkFixture()
- * })
- * ```
- */
-export function createNetworkFixture(
-  args?: CreateNetworkFixtureArgs,
-  /** @todo `onUnhandledRequest`? */
-): [
-  TestFixture<NetworkFixture, PlaywrightTestArgs & PlaywrightWorkerArgs>,
-  { auto: boolean },
-] {
-  return [
-    async ({ page }, use) => {
-      const worker = new NetworkFixture({
-        page,
-        initialHandlers: args?.initialHandlers || [],
-      })
-
-      await worker.start()
-      await use(worker)
-      await worker.stop()
-    },
-    { auto: true },
-  ]
-}
-
-export class NetworkFixture extends SetupApi<LifeCycleEventsMap> {
-  #page: Page
-
-  constructor(args: {
-    page: Page
-    initialHandlers: Array<RequestHandler | WebSocketHandler>
-  }) {
-    super(...args.initialHandlers)
-    this.#page = args.page
-  }
-
-  public async start() {
-    // Handle HTTP requests.
-    await this.#page.route(/.+/, async (route, request) => {
-      const fetchRequest = new Request(request.url(), {
-        method: request.method(),
-        headers: new Headers(await request.allHeaders()),
-        body: request.postDataBuffer(),
-      })
-
-      const response = await getResponse(
-        this.handlersController.currentHandlers().filter((handler) => {
-          return handler instanceof RequestHandler
-        }),
-        fetchRequest,
-        {
-          baseUrl: this.getPageUrl(),
-        },
-      )
-
-      if (response) {
-        if (response.status === 0) {
-          route.abort()
-          return
-        }
-
-        route.fulfill({
-          status: response.status,
-          headers: Object.fromEntries(response.headers),
-          body: response.body
-            ? Buffer.from(await response.arrayBuffer())
-            : undefined,
-        })
-        return
-      }
-
-      route.continue()
-    })
-
-    // Handle WebSocket connections.
-    await this.#page.routeWebSocket(/.+/, async (ws) => {
-      const allWebSocketHandlers = this.handlersController
-        .currentHandlers()
-        .filter((handler) => {
-          return handler instanceof WebSocketHandler
-        })
-
-      if (allWebSocketHandlers.length === 0) {
-        ws.connectToServer()
-        return
-      }
-
-      const client = new PlaywrightWebSocketClientConnection(ws)
-      const server = new PlaywrightWebSocketServerConnection(ws)
-
-      for (const handler of allWebSocketHandlers) {
-        await handler.run(
-          {
-            client,
-            server,
-            info: { protocols: [] },
-          },
-          {
-            baseUrl: this.getPageUrl(),
-          },
-        )
-      }
-    })
-  }
-
-  public async stop() {
-    super.dispose()
-    await this.#page.unroute(/.+/)
-  }
-
-  private getPageUrl(): string | undefined {
-    const url = this.#page.url()
-    return url !== 'about:blank' ? url : undefined
-  }
-}
-
-class PlaywrightWebSocketClientConnection
-  implements WebSocketClientConnectionProtocol
-{
-  public id: string
-  public url: URL
-
-  constructor(protected readonly ws: WebSocketRoute) {
-    this.id = crypto.randomUUID()
-    this.url = new URL(ws.url())
-  }
-
-  public send(data: WebSocketData): void {
-    if (data instanceof Blob) {
-      /**
-       * @note Playwright does not support sending Blob data.
-       * Read the blob as buffer, then send the buffer instead.
-       */
-      data.bytes().then((bytes) => {
-        this.ws.send(Buffer.from(bytes))
-      })
-      return
-    }
-
-    if (typeof data === 'string') {
-      this.ws.send(data)
-      return
-    }
-
-    this.ws.send(
-      /**
-       * @note Forcefully cast all data to Buffer because Playwright
-       * has trouble digesting ArrayBuffer and Blob directly.
-       */
-      Buffer.from(
-        /**
-         * @note Playwright type definitions are tailored to Node.js
-         * while MSW describes all data types that can be sent over
-         * the WebSocket protocol, like ArrayBuffer and Blob.
-         */
-        data as any,
-      ),
-    )
-  }
-
-  public close(code?: number, reason?: string): void {
-    const resolvedCode = code ?? 1000
-    this.ws.close({ code: resolvedCode, reason })
-  }
-
-  public addEventListener<EventType extends keyof WebSocketClientEventMap>(
-    type: EventType,
-    listener: (
-      this: WebSocket,
-      event: WebSocketClientEventMap[EventType],
-    ) => void,
-    options?: AddEventListenerOptions | boolean,
-  ): void {
-    /**
-     * @note Playwright does not expose the actual WebSocket reference.
-     */
-    const target = {} as WebSocket
-
-    switch (type) {
-      case 'message': {
-        this.ws.onMessage((data) => {
-          listener.call(
-            target,
-            new CancelableMessageEvent('message', {
-              data,
-            }) as any,
-          )
-        })
-        break
-      }
-
-      case 'close': {
-        this.ws.onClose((code, reason) => {
-          listener.call(
-            target,
-            new CancelableCloseEvent('close', {
-              code,
-              reason,
-            }) as any,
-          )
-        })
-        break
-      }
-    }
-  }
-
-  public removeEventListener<EventType extends keyof WebSocketClientEventMap>(
-    event: EventType,
-    listener: (
-      this: WebSocket,
-      event: WebSocketClientEventMap[EventType],
-    ) => void,
-    options?: EventListenerOptions | boolean,
-  ): void {
-    console.warn(
-      '@msw/playwright: WebSocketRoute does not support removing event listeners',
-    )
-  }
-}
-
-class PlaywrightWebSocketServerConnection
-  implements WebSocketServerConnectionProtocol
-{
-  #server?: WebSocketRoute
-  #bufferedEvents: Array<
-    Parameters<WebSocketServerConnectionProtocol['addEventListener']>
-  >
-  #bufferedData: Array<WebSocketData>
-
-  constructor(protected readonly ws: WebSocketRoute) {
-    this.#bufferedEvents = []
-    this.#bufferedData = []
-  }
-
-  public connect(): void {
-    this.#server = this.ws.connectToServer()
-
-    /**
-     * @note Playwright does not support event buffering.
-     * Manually add event listeners that might have been registered
-     * before `connect()` was called.
-     */
-    for (const [type, listener, options] of this.#bufferedEvents) {
-      this.addEventListener(type, listener, options)
-    }
-    this.#bufferedEvents.length = 0
-
-    // Same for the buffered data.
-    for (const data of this.#bufferedData) {
-      this.send(data)
-    }
-    this.#bufferedData.length = 0
-  }
-
-  public send(data: WebSocketData): void {
-    if (this.#server == null) {
-      this.#bufferedData.push(data)
-      return
-    }
-
-    this.#server.send(data as any)
-  }
-
-  public close(code?: number, reason?: string): void {
-    invariant(
-      this.#server,
-      'Failed to close connection to the actual WebSocket server: connection not established. Did you forget to call `connect()`?',
-    )
-
-    this.#server.close({ code, reason })
-  }
-
-  public addEventListener<EventType extends keyof WebSocketServerEventMap>(
-    type: EventType,
-    listener: (
-      this: WebSocket,
-      event: WebSocketServerEventMap[EventType],
-    ) => void,
-    options?: AddEventListenerOptions | boolean,
-  ): void {
-    if (this.#server == null) {
-      this.#bufferedEvents.push([type, listener as any, options])
-      return
-    }
-
-    const target = {} as WebSocket
-    switch (type) {
-      case 'message': {
-        this.#server.onMessage((data) => {
-          listener.call(
-            target,
-            new CancelableMessageEvent('message', { data }) as any,
-          )
-        })
-        break
-      }
-
-      case 'close': {
-        this.#server.onClose((code, reason) => {
-          listener.call(
-            target,
-            new CancelableCloseEvent('close', { code, reason }) as any,
-          )
-        })
-        break
-      }
-    }
-  }
-
-  public removeEventListener<EventType extends keyof WebSocketServerEventMap>(
-    type: EventType,
-    listener: (
-      this: WebSocket,
-      event: WebSocketServerEventMap[EventType],
-    ) => void,
-    options?: EventListenerOptions | boolean,
-  ): void {
-    console.warn(
-      '@msw/playwright: WebSocketRoute does not support removing event listeners',
-    )
-  }
-}
+export {
+  type CreateNetworkFixtureArgs,
+  type NetworkFixture,
+  createNetworkFixture,
+} from './fixture.js'