From 950f3bcec2138bb1fe74d95b16a0dfd9ee28a5b0 Mon Sep 17 00:00:00 2001
From: Pavel Feldman <pavel.feldman@gmail.com>
Date: Thu, 24 Oct 2024 10:57:56 -0700
Subject: [PATCH] chore: disable debugger on test end

---
 packages/playwright-core/src/client/browserContext.ts |  6 ++++++
 packages/playwright-core/src/protocol/validator.ts    |  2 ++
 .../server/dispatchers/browserContextDispatcher.ts    |  4 ++++
 packages/playwright/src/index.ts                      | 11 +++++++++++
 packages/protocol/src/channels.ts                     |  4 ++++
 packages/protocol/src/protocol.yml                    |  2 ++
 6 files changed, 29 insertions(+)

diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index 5ff432ec60..3f9f4ba119 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -495,6 +495,12 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
   async _enableRecorder(params: channels.BrowserContextEnableRecorderParams) {
     await this._channel.enableRecorder(params);
   }
+
+  _disableDebugger() {
+    this._wrapApiCall(async () => {
+      this._channel.disableDebugger();
+    }, true).catch(() => {});
+  }
 }
 
 async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 24ddf0014c..8f5cb7884e 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -1047,6 +1047,8 @@ scheme.BrowserContextClockSetSystemTimeParams = tObject({
   timeString: tOptional(tString),
 });
 scheme.BrowserContextClockSetSystemTimeResult = tOptional(tObject({}));
+scheme.BrowserContextDisableDebuggerParams = tOptional(tObject({}));
+scheme.BrowserContextDisableDebuggerResult = tOptional(tObject({}));
 scheme.PageInitializer = tObject({
   mainFrame: tChannel(['Frame']),
   viewportSize: tOptional(tObject({
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index c6ffce49f7..6ad4eee19d 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -374,6 +374,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
       this._subscriptions.delete(params.event);
   }
 
+  async disableDebugger() {
+    this._context.debugger().setMuted(true);
+  }
+
   override _onDispose() {
     // Avoid protocol calls for the closed context.
     if (!this._context.isClosingOrClosed())
diff --git a/packages/playwright/src/index.ts b/packages/playwright/src/index.ts
index c2c9596b6e..99ed30c47e 100644
--- a/packages/playwright/src/index.ts
+++ b/packages/playwright/src/index.ts
@@ -595,11 +595,15 @@ class ArtifactsRecorder {
   }
 
   async didFinishTestFunction() {
+    this._disableDebugger();
+
     if (this._shouldCaptureScreenshotUponFinish())
       await this._screenshotOnTestFailure();
   }
 
   async didFinishTest() {
+    this._disableDebugger();
+
     const captureScreenshots = this._shouldCaptureScreenshotUponFinish();
     if (captureScreenshots)
       await this._screenshotOnTestFailure();
@@ -660,6 +664,13 @@ class ArtifactsRecorder {
     this._testInfo.attachments.push({ name: 'screenshot', path: screenshotPath, contentType: 'image/png' });
   }
 
+  private _disableDebugger() {
+    for (const browserType of [this._playwright.chromium, this._playwright.firefox, this._playwright.webkit]) {
+      for (const context of (browserType as any)._contexts)
+        context._disableDebugger();
+    }
+  }
+
   private async _screenshotOnTestFailure() {
     const contexts: BrowserContext[] = [];
     for (const browserType of [this._playwright.chromium, this._playwright.firefox, this._playwright.webkit])
diff --git a/packages/protocol/src/channels.ts b/packages/protocol/src/channels.ts
index 5ecc2f4077..9441c00de2 100644
--- a/packages/protocol/src/channels.ts
+++ b/packages/protocol/src/channels.ts
@@ -1539,6 +1539,7 @@ export interface BrowserContextChannel extends BrowserContextEventTarget, EventT
   clockRunFor(params: BrowserContextClockRunForParams, metadata?: CallMetadata): Promise<BrowserContextClockRunForResult>;
   clockSetFixedTime(params: BrowserContextClockSetFixedTimeParams, metadata?: CallMetadata): Promise<BrowserContextClockSetFixedTimeResult>;
   clockSetSystemTime(params: BrowserContextClockSetSystemTimeParams, metadata?: CallMetadata): Promise<BrowserContextClockSetSystemTimeResult>;
+  disableDebugger(params?: BrowserContextDisableDebuggerParams, metadata?: CallMetadata): Promise<BrowserContextDisableDebuggerResult>;
 }
 export type BrowserContextBindingCallEvent = {
   binding: BindingCallChannel,
@@ -1902,6 +1903,9 @@ export type BrowserContextClockSetSystemTimeOptions = {
   timeString?: string,
 };
 export type BrowserContextClockSetSystemTimeResult = void;
+export type BrowserContextDisableDebuggerParams = {};
+export type BrowserContextDisableDebuggerOptions = {};
+export type BrowserContextDisableDebuggerResult = void;
 
 export interface BrowserContextEvents {
   'bindingCall': BrowserContextBindingCallEvent;
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index c91cecbe6c..722cccba6e 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -1291,6 +1291,8 @@ BrowserContext:
         timeNumber: number?
         timeString: string?
 
+    disableDebugger:
+
   events:
 
     bindingCall: