test: fix flaky page.pause() tests end up stalling

packages/playwright-core/src/client/clientInstrumentation.ts

@@ -24,7 +24,7 @@ export interface ClientInstrumentation {
   removeAllListeners(): void;
   onApiCallBegin(apiCall: string, params: Record<string, any>, frames: StackFrame[], userData: any, out: { stepId?: string }): void;
   onApiCallEnd(userData: any, error?: Error): void;
-  onWillPause(): void;
+  onWillPause(options: { keepTestTimeout: boolean }): void;
 
   runAfterCreateBrowserContext(context: BrowserContext): Promise<void>;
   runAfterCreateRequestContext(context: APIRequestContext): Promise<void>;
@@ -35,7 +35,7 @@ export interface ClientInstrumentation {
 export interface ClientInstrumentationListener {
   onApiCallBegin?(apiName: string, params: Record<string, any>, frames: StackFrame[], userData: any, out: { stepId?: string }): void;
   onApiCallEnd?(userData: any, error?: Error): void;
-  onWillPause?(): void;
+  onWillPause?(options: { keepTestTimeout: boolean }): void;
 
   runAfterCreateBrowserContext?(context: BrowserContext): Promise<void>;
   runAfterCreateRequestContext?(context: APIRequestContext): Promise<void>;

packages/playwright-core/src/client/page.ts

@@ -786,14 +786,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
     return [...this._workers];
   }
 
-  async pause() {
+  async pause(_options?: { __testHookKeepTestTimeout: boolean }) {
     if (require('inspector').url())
       return;
     const defaultNavigationTimeout = this._browserContext._timeoutSettings.defaultNavigationTimeout();
     const defaultTimeout = this._browserContext._timeoutSettings.defaultTimeout();
     this._browserContext.setDefaultNavigationTimeout(0);
     this._browserContext.setDefaultTimeout(0);
-    this._instrumentation?.onWillPause();
+    this._instrumentation?.onWillPause({ keepTestTimeout: !!_options?.__testHookKeepTestTimeout });
     await this._closedOrCrashedScope.safeRace(this.context()._channel.pause());
     this._browserContext.setDefaultNavigationTimeout(defaultNavigationTimeout);
     this._browserContext.setDefaultTimeout(defaultTimeout);

packages/playwright/src/index.ts

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

tests/library/browsertype-connect.spec.ts

@@ -176,7 +176,8 @@ for (const kind of ['launchServer', 'run-server'] as const) {
       const browser = await connect(remoteServer.wsEndpoint());
       const browserContext = await browser.newContext();
       const page = await browserContext.newPage();
-      await page.pause();
+      // @ts-ignore
+      await page.pause({ __testHookKeepTestTimeout: true });
       await browser.close();
       (browserType as any)._defaultLaunchOptions.headless = headless;
     });

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

@@ -22,7 +22,8 @@ let scriptPromise: Promise<void>;
 
 it.beforeEach(async ({ page, recorderPageGetter }) => {
   scriptPromise = (async () => {
-    await page.pause();
+    // @ts-ignore
+    await page.pause({ __testHookKeepTestTimeout: true });
   })();
   await recorderPageGetter();
 });