@msw/playwright 0.6.2 → 0.6.4

package/README.md

@@ -41,7 +41,7 @@ interface Fixtures {
 
 const test = testBase.extend<Fixtures>({
   // Initial list of the network handlers.
-  handlers: [[handlers], { option: true }],
+  handlers: [handlers, { option: true }],
 
   // A fixture you use to control the network in your tests.
   network: [

package/build/index.js

@@ -24,7 +24,8 @@ var SetupPlaywrightApi = class extends SetupApi {
 		this.options = options;
 	}
 	async enable() {
-		await this.options.context.route(INTERNAL_MATCH_ALL_REG_EXP, async (route, request) => {
+		const { context } = this.options;
+		await context.route(INTERNAL_MATCH_ALL_REG_EXP, async (route, request) => {
 			const fetchRequest = new Request(request.url(), {
 				method: request.method(),
 				headers: new Headers(await request.allHeaders()),
@@ -36,7 +37,7 @@ var SetupPlaywrightApi = class extends SetupApi {
 			* requests through the matching logic below.
 			* @see https://github.com/mswjs/playwright/issues/13
 			*/
-			if (this.options.skipAssetRequests && isCommonAssetRequest(fetchRequest)) return route.continue();
+			if (this.options.skipAssetRequests && isCommonAssetRequest(fetchRequest)) return this.safelyHandleRoute(() => route.fallback());
 			const handlers = this.handlersController.currentHandlers().filter((handler) => {
 				return handler instanceof RequestHandler;
 			});
@@ -50,16 +51,18 @@ var SetupPlaywrightApi = class extends SetupApi {
 				baseUrl
 			} });
 			if (response) {
-				if (response.status === 0) return route.abort();
-				return route.fulfill({
-					status: response.status,
-					headers: Object.fromEntries(response.headers),
-					body: response.body ? Buffer.from(await response.arrayBuffer()) : void 0
+				if (response.status === 0) return this.safelyHandleRoute(() => route.abort());
+				return this.safelyHandleRoute(async () => {
+					return route.fulfill({
+						status: response.status,
+						headers: Object.fromEntries(response.headers),
+						body: response.body ? Buffer.from(await response.arrayBuffer()) : void 0
+					});
 				});
 			}
-			return route.continue();
+			return this.safelyHandleRoute(() => route.fallback());
 		});
-		await this.options.context.routeWebSocket(INTERNAL_MATCH_ALL_REG_EXP, async (route) => {
+		await context.routeWebSocket(INTERNAL_MATCH_ALL_REG_EXP, async (route) => {
 			const allWebSocketHandlers = this.handlersController.currentHandlers().filter((handler) => {
 				return handler instanceof WebSocketHandler;
 			});
@@ -89,6 +92,21 @@ var SetupPlaywrightApi = class extends SetupApi {
 		if (url === "about:blank") return;
 		return decodeURI(new URL(encodeURI(url)).origin);
 	}
+	async safelyHandleRoute(callback) {
+		try {
+			await callback();
+		} catch (error) {
+			/**
+			* @note Ignore "Route is already handled!" errors.
+			* Playwright has a bug where requests terminated due to navigation
+			* cause your in-flight route handlers to throw. There's no means to
+			* detect that scenario as both "route.handled" and "route._handlingPromise" are internal.
+			* @see https://github.com/mswjs/playwright/issues/35
+			*/
+			if (error instanceof Error && /route is already handled/i.test(error.message)) return;
+			throw error;
+		}
+	}
 };
 var PlaywrightWebSocketClientConnection = class {
 	id;

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@msw/playwright",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Mock Service Worker binding for Playwright",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",

package/src/fixture.ts

@@ -77,8 +77,10 @@ class SetupPlaywrightApi extends SetupApi<LifeCycleEventsMap> {
   }
 
   public async enable(): Promise<void> {
+    const { context } = this.options
+
     // Handle HTTP requests.
-    await this.options.context.route(
+    await context.route(
       INTERNAL_MATCH_ALL_REG_EXP,
       async (route: Route, request: PlaywrightRequest) => {
         const fetchRequest = new Request(request.url(), {
@@ -97,7 +99,7 @@ class SetupPlaywrightApi extends SetupApi<LifeCycleEventsMap> {
           this.options.skipAssetRequests &&
           isCommonAssetRequest(fetchRequest)
         ) {
-          return route.continue()
+          return this.safelyHandleRoute(() => route.fallback())
         }
 
         const handlers = this.handlersController
@@ -132,58 +134,57 @@ class SetupPlaywrightApi extends SetupApi<LifeCycleEventsMap> {
 
         if (response) {
           if (response.status === 0) {
-            return route.abort()
+            return this.safelyHandleRoute(() => route.abort())
           }
 
-          return route.fulfill({
-            status: response.status,
-            headers: Object.fromEntries(response.headers),
-            body: response.body
-              ? Buffer.from(await response.arrayBuffer())
-              : undefined,
+          return this.safelyHandleRoute(async () => {
+            return route.fulfill({
+              status: response.status,
+              headers: Object.fromEntries(response.headers),
+              body: response.body
+                ? Buffer.from(await response.arrayBuffer())
+                : undefined,
+            })
           })
         }
 
-        return route.continue()
+        return this.safelyHandleRoute(() => route.fallback())
       },
     )
 
     // Handle WebSocket connections.
-    await this.options.context.routeWebSocket(
-      INTERNAL_MATCH_ALL_REG_EXP,
-      async (route) => {
-        const allWebSocketHandlers = this.handlersController
-          .currentHandlers()
-          .filter((handler) => {
-            return handler instanceof WebSocketHandler
-          })
+    await context.routeWebSocket(INTERNAL_MATCH_ALL_REG_EXP, async (route) => {
+      const allWebSocketHandlers = this.handlersController
+        .currentHandlers()
+        .filter((handler) => {
+          return handler instanceof WebSocketHandler
+        })
 
-        if (allWebSocketHandlers.length === 0) {
-          route.connectToServer()
-          return
-        }
+      if (allWebSocketHandlers.length === 0) {
+        route.connectToServer()
+        return
+      }
 
-        const client = new PlaywrightWebSocketClientConnection(route)
-        const server = new PlaywrightWebSocketServerConnection(route)
+      const client = new PlaywrightWebSocketClientConnection(route)
+      const server = new PlaywrightWebSocketServerConnection(route)
 
-        const pages = this.options.context.pages()
-        const lastPage = pages[pages.length - 1]
-        const baseUrl = lastPage ? this.getPageUrl(lastPage) : undefined
+      const pages = this.options.context.pages()
+      const lastPage = pages[pages.length - 1]
+      const baseUrl = lastPage ? this.getPageUrl(lastPage) : undefined
 
-        for (const handler of allWebSocketHandlers) {
-          await handler.run(
-            {
-              client,
-              server,
-              info: { protocols: [] },
-            },
-            {
-              baseUrl,
-            },
-          )
-        }
-      },
-    )
+      for (const handler of allWebSocketHandlers) {
+        await handler.run(
+          {
+            client,
+            server,
+            info: { protocols: [] },
+          },
+          {
+            baseUrl,
+          },
+        )
+      }
+    })
   }
 
   public async disable(): Promise<void> {
@@ -202,6 +203,30 @@ class SetupPlaywrightApi extends SetupApi<LifeCycleEventsMap> {
     // Encode/decode to preserve escape characters.
     return decodeURI(new URL(encodeURI(url)).origin)
   }
+
+  private async safelyHandleRoute(
+    callback: () => Promise<void>,
+  ): Promise<void> {
+    try {
+      await callback()
+    } catch (error) {
+      /**
+       * @note Ignore "Route is already handled!" errors.
+       * Playwright has a bug where requests terminated due to navigation
+       * cause your in-flight route handlers to throw. There's no means to
+       * detect that scenario as both "route.handled" and "route._handlingPromise" are internal.
+       * @see https://github.com/mswjs/playwright/issues/35
+       */
+      if (
+        error instanceof Error &&
+        /route is already handled/i.test(error.message)
+      ) {
+        return
+      }
+
+      throw error
+    }
+  }
 }
 
 class PlaywrightWebSocketClientConnection implements WebSocketClientConnectionProtocol {