fix: npx playwright open should include console api (#38721)

Author: dgozman

packages/playwright-core/src/cli/program.ts

@@ -552,6 +552,7 @@ async function openPage(context: BrowserContext, url: string | undefined): Promi
 
 async function open(options: Options, url: string | undefined) {
   const { context } = await launchContext(options, { headless: !!process.env.PWTEST_CLI_HEADLESS, executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH });
+  await context._exposeConsoleApi();
   await openPage(context, url);
 }
 

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

@@ -542,6 +542,10 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
     await this._channel.disableRecorder();
   }
 
+  async _exposeConsoleApi() {
+    await this._channel.exposeConsoleApi();
+  }
+
   _setAllowedProtocols(protocols: string[]) {
     this._allowedProtocols = protocols;
   }

packages/playwright-core/src/protocol/validator.ts

@@ -1112,6 +1112,8 @@ scheme.BrowserContextEnableRecorderParams = tObject({
 scheme.BrowserContextEnableRecorderResult = tOptional(tObject({}));
 scheme.BrowserContextDisableRecorderParams = tOptional(tObject({}));
 scheme.BrowserContextDisableRecorderResult = tOptional(tObject({}));
+scheme.BrowserContextExposeConsoleApiParams = tOptional(tObject({}));
+scheme.BrowserContextExposeConsoleApiResult = tOptional(tObject({}));
 scheme.BrowserContextNewCDPSessionParams = tObject({
   page: tOptional(tChannel(['Page'])),
   frame: tOptional(tChannel(['Frame'])),

packages/playwright-core/src/server/browserContext.ts

@@ -115,6 +115,7 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
   _clientCertificatesProxy: ClientCertificatesProxy | undefined;
   private _playwrightBindingExposed?: Promise<void>;
   readonly dialogManager: DialogManager;
+  private _consoleApiExposed = false;
 
   constructor(browser: Browser, options: types.BrowserContextOptions, browserContextId: string | undefined) {
     super(browser, 'browser-context');
@@ -159,12 +160,9 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
         RecorderApp.showInspectorNoReply(this);
     });
 
-    if (debugMode() === 'console') {
-      await this.extendInjectedScript(`
-        function installConsoleApi(injectedScript) { injectedScript.consoleApi.install(); }
-        module.exports = { default: () => installConsoleApi };
-      `);
-    }
+    if (debugMode() === 'console')
+      await this.exposeConsoleApi();
+
     if (this._options.serviceWorkers === 'block')
       await this.addInitScript(undefined, `\nif (navigator.serviceWorker) navigator.serviceWorker.register = async () => { console.warn('Service Worker registration blocked by Playwright'); };\n`);
 
@@ -176,6 +174,16 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
     return this._debugger;
   }
 
+  async exposeConsoleApi() {
+    if (this._consoleApiExposed)
+      return;
+    this._consoleApiExposed = true;
+    await this.extendInjectedScript(`
+      function installConsoleApi(injectedScript) { injectedScript.consoleApi.install(); }
+      module.exports = { default: () => installConsoleApi };
+    `);
+  }
+
   async _ensureVideosPath() {
     if (this._options.recordVideo)
       await mkdirIfNeeded(path.join(this._options.recordVideo.dir, 'dummy'));

packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts

@@ -349,6 +349,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
       recorder.setMode('none');
   }
 
+  async exposeConsoleApi(params: channels.BrowserContextExposeConsoleApiParams, progress: Progress): Promise<void> {
+    await this._context.exposeConsoleApi();
+  }
+
   async pause(params: channels.BrowserContextPauseParams, progress: Progress) {
     // Debugger will take care of this.
   }

packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts

@@ -87,6 +87,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
   ['BrowserContext.pause', { title: 'Pause', }],
   ['BrowserContext.enableRecorder', { internal: true, }],
   ['BrowserContext.disableRecorder', { internal: true, }],
+  ['BrowserContext.exposeConsoleApi', { internal: true, }],
   ['BrowserContext.newCDPSession', { title: 'Create CDP session', group: 'configuration', }],
   ['BrowserContext.harStart', { internal: true, }],
   ['BrowserContext.harExport', { internal: true, }],

packages/protocol/src/channels.d.ts

@@ -1674,6 +1674,7 @@ export interface BrowserContextChannel extends BrowserContextEventTarget, EventT
   pause(params?: BrowserContextPauseParams, progress?: Progress): Promise<BrowserContextPauseResult>;
   enableRecorder(params: BrowserContextEnableRecorderParams, progress?: Progress): Promise<BrowserContextEnableRecorderResult>;
   disableRecorder(params?: BrowserContextDisableRecorderParams, progress?: Progress): Promise<BrowserContextDisableRecorderResult>;
+  exposeConsoleApi(params?: BrowserContextExposeConsoleApiParams, progress?: Progress): Promise<BrowserContextExposeConsoleApiResult>;
   newCDPSession(params: BrowserContextNewCDPSessionParams, progress?: Progress): Promise<BrowserContextNewCDPSessionResult>;
   harStart(params: BrowserContextHarStartParams, progress?: Progress): Promise<BrowserContextHarStartResult>;
   harExport(params: BrowserContextHarExportParams, progress?: Progress): Promise<BrowserContextHarExportResult>;
@@ -1953,6 +1954,9 @@ export type BrowserContextEnableRecorderResult = void;
 export type BrowserContextDisableRecorderParams = {};
 export type BrowserContextDisableRecorderOptions = {};
 export type BrowserContextDisableRecorderResult = void;
+export type BrowserContextExposeConsoleApiParams = {};
+export type BrowserContextExposeConsoleApiOptions = {};
+export type BrowserContextExposeConsoleApiResult = void;
 export type BrowserContextNewCDPSessionParams = {
   page?: PageChannel,
   frame?: FrameChannel,

packages/protocol/src/protocol.yml

@@ -1353,6 +1353,9 @@ BrowserContext:
     disableRecorder:
       internal: true
 
+    exposeConsoleApi:
+      internal: true
+
     newCDPSession:
       title: Create CDP session
       group: configuration