test: fix flaky page.pause() tests affect unrelated tests and stall

Author: mxschmitt

packages/playwright/src/index.ts

@@ -288,7 +288,8 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
         step?.complete({ error });
       },
       onWillPause: () => {
-        currentTestInfo()?._setDebugMode();
+        if (!process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT)
+          currentTestInfo()?._setDebugMode();
       },
       runAfterCreateBrowserContext: async (context: BrowserContext) => {
         await artifactsRecorder?.didCreateBrowserContext(context);

tests/library/browsertype-connect.spec.ts

@@ -170,15 +170,21 @@ for (const kind of ['launchServer', 'run-server'] as const) {
     });
 
     test('should ignore page.pause when headed', async ({ connect, startRemoteServer, browserType, channel }) => {
-      const headless = (browserType as any)._defaultLaunchOptions.headless;
-      (browserType as any)._defaultLaunchOptions.headless = false;
-      const remoteServer = await startRemoteServer(kind);
-      const browser = await connect(remoteServer.wsEndpoint());
-      const browserContext = await browser.newContext();
-      const page = await browserContext.newPage();
-      await page.pause();
-      await browser.close();
-      (browserType as any)._defaultLaunchOptions.headless = headless;
+      // await page.pause() disables the test-runner timeout, so we opt-out of it.
+      process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT = '1';
+      try {
+        const headless = (browserType as any)._defaultLaunchOptions.headless;
+        (browserType as any)._defaultLaunchOptions.headless = false;
+        const remoteServer = await startRemoteServer(kind);
+        const browser = await connect(remoteServer.wsEndpoint());
+        const browserContext = await browser.newContext();
+        const page = await browserContext.newPage();
+        await page.pause();
+        await browser.close();
+        (browserType as any)._defaultLaunchOptions.headless = headless;
+      } finally {
+        delete process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT;
+      }
     });
 
     test('should be able to visit ipv6 through localhost', async ({ connect, startRemoteServer, ipV6ServerPort }) => {

tests/library/inspector/console-api.spec.ts

@@ -14,20 +14,24 @@
  * limitations under the License.
  */
 
-import { test as it, expect } from './inspectorTest';
+import { test as base, expect } from './inspectorTest';
 
-it.skip(({ mode }) => mode !== 'default');
-
-let scriptPromise: Promise<void>;
-
-it.beforeEach(async ({ page, recorderPageGetter }) => {
-  scriptPromise = (async () => {
-    await page.pause();
-  })();
-  await recorderPageGetter();
+const it = base.extend<{scriptPromise: Promise<void>}>({
+  scriptPromise: [async ({ page, recorderPageGetter }, use) => {
+    // await page.pause() disables the test-runner timeout, so we opt-out of it.
+    process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT = '1';
+    const scriptPromise = (async () => {
+      await page.pause();
+    })();
+    await recorderPageGetter();
+    await use(scriptPromise);
+    delete process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT;
+  }, { scope: 'test', auto: true }],
 });
 
-it.afterEach(async ({ recorderPageGetter }) => {
+it.skip(({ mode }) => mode !== 'default');
+
+it.afterEach(async ({ recorderPageGetter, scriptPromise }) => {
   const recorderPage = await recorderPageGetter();
   recorderPage.click('[title="Resume (F8)"]').catch(() => {});
   await scriptPromise;

tests/library/inspector/pause.spec.ts

@@ -15,11 +15,20 @@
  */
 
 import type { Page } from 'playwright-core';
-import { test as it, expect, Recorder } from './inspectorTest';
+import { test as base, expect, Recorder } from './inspectorTest';
 import { waitForTestLog } from '../../config/utils';
 import { roundBox } from '../../page/pageTest';
 import type { BoundingBox } from '../../page/pageTest';
 
+const it = base.extend<{testSetup: void}>({
+  testSetup: [async ({}, use) => {
+    // await page.pause() disables the test-runner timeout, so we opt-out of it.
+    process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT = '1';
+    await use();
+    delete process.env.PLAYWRIGHT_INTERNAL_DISABLE_PAGE_PAUSE_TEST_RUNNER_TIMEOUT;
+  }, { scope: 'test', auto: true }],
+});
+
 it('should resume when closing inspector', async ({ page, recorderPageGetter, closeRecorder, mode }) => {
   it.skip(mode !== 'default');