@next/playwright 16.2.0-canary.76 → 16.2.0-canary.78

package/dist/index.d.ts

@@ -37,6 +37,9 @@ interface PlaywrightPage {
  *     await page.goto(url)
  *     // ...
  *   }, { baseURL: 'http://localhost:3000' })
+ *
+ * When `@playwright/test` is installed, acquire/release actions appear
+ * as labeled steps in the Playwright UI.
  */
 export declare function instant<T>(page: PlaywrightPage, fn: () => Promise<T>, options?: {
     baseURL?: string;

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.instant = instant;
+const step_1 = require("./step");
 const INSTANT_COOKIE = 'next-instant-navigation-testing';
 /**
  * Runs a function with instant navigation enabled. Within this scope,
@@ -19,6 +20,9 @@ const INSTANT_COOKIE = 'next-instant-navigation-testing';
  *     await page.goto(url)
  *     // ...
  *   }, { baseURL: 'http://localhost:3000' })
+ *
+ * When `@playwright/test` is installed, acquire/release actions appear
+ * as labeled steps in the Playwright UI.
  */
 async function instant(page, fn, options) {
     // Acquire the lock by setting the cookie via the browser context. This
@@ -26,11 +30,11 @@ async function instant(page, fn, options) {
     // The cookie triggers the CookieStore change event in
     // navigation-testing-lock.ts, which acquires the in-memory navigation lock.
     const { hostname } = new URL(resolveURL(page, options));
-    await page
+    await (0, step_1.step)('Acquire Instant Lock', () => page
         .context()
         .addCookies([
         { name: INSTANT_COOKIE, value: '1', domain: hostname, path: '/' },
-    ]);
+    ]));
     try {
         return await fn();
     }
@@ -39,7 +43,7 @@ async function instant(page, fn, options) {
         // triggers the CookieStore change event which resolves the in-memory
         // lock. For MPA navigations (reload, plain anchor), the listener in
         // app-bootstrap.ts triggers a page reload to fetch dynamic data.
-        await page.context().clearCookies({ name: INSTANT_COOKIE });
+        await (0, step_1.step)('Release Instant Lock', () => page.context().clearCookies({ name: INSTANT_COOKIE }));
     }
 }
 /**

package/dist/step.d.ts

@@ -0,0 +1,8 @@
+export type Step = <T>(title: string, body: () => Promise<T>) => Promise<T>;
+/**
+ * When `@playwright/test` is installed and we're running inside the Playwright
+ * test runner, wraps the body in a `test.step()` so it appears as a labeled
+ * step in the Playwright UI. Otherwise just executes the body directly.
+ */
+declare let step: Step;
+export { step };

package/dist/step.js

@@ -0,0 +1,33 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.step = void 0;
+/**
+ * When `@playwright/test` is installed and we're running inside the Playwright
+ * test runner, wraps the body in a `test.step()` so it appears as a labeled
+ * step in the Playwright UI. Otherwise just executes the body directly.
+ */
+let step = (_title, body) => body();
+exports.step = step;
+try {
+    const pw = require('@playwright/test');
+    if (typeof ((_a = pw.test) === null || _a === void 0 ? void 0 : _a.step) === 'function') {
+        const playwrightStep = pw.test.step;
+        exports.step = step = async (title, body) => {
+            try {
+                return await playwrightStep(title, body);
+            }
+            catch (e) {
+                // If test.step fails because we're not inside the Playwright test
+                // runner (e.g., running under Jest), fall back to executing the body
+                // directly without step labels.
+                if (e instanceof Error &&
+                    e.message.includes('can only be called from a test')) {
+                    return body();
+                }
+                throw e;
+            }
+        };
+    }
+}
+catch { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next/playwright",
-  "version": "16.2.0-canary.76",
+  "version": "16.2.0-canary.78",
   "repository": {
     "url": "vercel/next.js",
     "directory": "packages/next-playwright"
@@ -17,6 +17,14 @@
     "dev": "tsc -d -w -p tsconfig.json",
     "typescript": "tsec --noEmit -p tsconfig.json"
   },
+  "peerDependencies": {
+    "@playwright/test": ">=1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@playwright/test": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "typescript": "5.9.2"
   }