chore: remove underscore from public members in page (#35820)

Author: yury-s

packages/playwright-core/src/server/bidi/bidiBrowser.ts

@@ -16,7 +16,7 @@
 
 import { eventsHelper } from '../utils/eventsHelper';
 import { Browser } from '../browser';
-import { BrowserContext, assertBrowserContextIsNotOwned, verifyGeolocation } from '../browserContext';
+import { BrowserContext, verifyGeolocation } from '../browserContext';
 import * as network from '../network';
 import { BidiConnection } from './bidiConnection';
 import { bidiBytesValueToString } from './bidiNetworkManager';
@@ -151,12 +151,12 @@ export class BidiBrowser extends Browser {
     if (event.parent) {
       const parentFrameId = event.parent;
       for (const page of this._bidiPages.values()) {
-        const parentFrame = page._page._frameManager.frame(parentFrameId);
+        const parentFrame = page._page.frameManager.frame(parentFrameId);
         if (!parentFrame)
           continue;
         page._session.addFrameBrowsingContext(event.context);
-        page._page._frameManager.frameAttached(event.context, parentFrameId);
-        const frame = page._page._frameManager.frame(event.context);
+        page._page.frameManager.frameAttached(event.context, parentFrameId);
+        const frame = page._page.frameManager.frame(event.context);
         if (frame)
           frame._url = event.url;
         return;
@@ -180,10 +180,10 @@ export class BidiBrowser extends Browser {
       this._browserSession.removeFrameBrowsingContext(event.context);
       const parentFrameId = event.parent;
       for (const page of this._bidiPages.values()) {
-        const parentFrame = page._page._frameManager.frame(parentFrameId);
+        const parentFrame = page._page.frameManager.frame(parentFrameId);
         if (!parentFrame)
           continue;
-        page._page._frameManager.frameDetached(event.context);
+        page._page.frameManager.frameDetached(event.context);
         return;
       }
       return;
@@ -266,7 +266,6 @@ export class BidiBrowserContext extends BrowserContext {
   }
 
   override async doCreateNewPage(): Promise<Page> {
-    assertBrowserContextIsNotOwned(this);
     const { context } = await this._browser._browserSession.send('browsingContext.create', {
       type: bidi.BrowsingContext.CreateType.Window,
       userContext: this._browserContextId,
@@ -368,7 +367,7 @@ export class BidiBrowserContext extends BrowserContext {
   async doSetHTTPCredentials(httpCredentials?: types.Credentials): Promise<void> {
     this._options.httpCredentials = httpCredentials;
     for (const page of this.pages())
-      await (page._delegate as BidiPage).updateHttpCredentials();
+      await (page.delegate as BidiPage).updateHttpCredentials();
   }
 
   async doAddInitScript(initScript: InitScript) {

packages/playwright-core/src/server/bidi/bidiNetworkManager.ts

@@ -59,7 +59,7 @@ export class BidiNetworkManager {
     if (param.request.url.startsWith('data:'))
       return;
     const redirectedFrom = param.redirectCount ? (this._requests.get(param.request.request) || null) : null;
-    const frame = redirectedFrom ? redirectedFrom.request.frame() : (param.context ? this._page._frameManager.frame(param.context) : null);
+    const frame = redirectedFrom ? redirectedFrom.request.frame() : (param.context ? this._page.frameManager.frame(param.context) : null);
     if (!frame)
       return;
     if (redirectedFrom)
@@ -82,7 +82,7 @@ export class BidiNetworkManager {
     }
     const request = new BidiRequest(frame, redirectedFrom, param, route);
     this._requests.set(request._id, request);
-    this._page._frameManager.requestStarted(request.request, route);
+    this._page.frameManager.requestStarted(request.request, route);
   }
 
   private _onResponseStarted(params: bidi.Network.ResponseStartedParameters) {
@@ -115,7 +115,7 @@ export class BidiNetworkManager {
     // "raw" headers are the same as "provisional" headers in Bidi.
     response.setRawResponseHeaders(null);
     response.setResponseHeadersSize(params.response.headersSize);
-    this._page._frameManager.requestReceivedResponse(response);
+    this._page.frameManager.requestReceivedResponse(response);
     if (params.navigation)
       this._onNavigationResponseStarted(params);
   }
@@ -139,7 +139,7 @@ export class BidiNetworkManager {
       response._requestFinished(responseEndTime);
     }
     response._setHttpVersion(params.response.protocol);
-    this._page._frameManager.reportRequestFinished(request.request, response);
+    this._page.frameManager.reportRequestFinished(request.request, response);
 
   }
 
@@ -156,12 +156,12 @@ export class BidiNetworkManager {
     }
     request.request._setFailureText(params.errorText);
     // TODO: support canceled flag
-    this._page._frameManager.requestFailed(request.request, params.errorText === 'NS_BINDING_ABORTED');
+    this._page.frameManager.requestFailed(request.request, params.errorText === 'NS_BINDING_ABORTED');
   }
 
   private _onAuthRequired(params: bidi.Network.AuthRequiredParameters) {
     const isBasic = params.response.authChallenges?.some(challenge => challenge.scheme.startsWith('Basic'));
-    const credentials = this._page._browserContext._options.httpCredentials;
+    const credentials = this._page.browserContext._options.httpCredentials;
     if (isBasic && credentials) {
       this._session.sendMayFail('network.continueWithAuth', {
         request: params.request.request,
@@ -230,7 +230,7 @@ class BidiRequest {
       redirectedFrom._redirectedTo = this;
     // TODO: missing in the spec?
     const postDataBuffer = null;
-    this.request = new network.Request(frame._page._browserContext, frame, null, redirectedFrom ? redirectedFrom.request : null, payload.navigation ?? undefined,
+    this.request = new network.Request(frame._page.browserContext, frame, null, redirectedFrom ? redirectedFrom.request : null, payload.navigation ?? undefined,
         payload.request.url, 'other', payload.request.method, postDataBuffer, fromBidiHeaders(payload.request.headers));
     // "raw" headers are the same as "provisional" headers in Bidi.
     this.request.setRawRequestHeaders(null);

packages/playwright-core/src/server/bidi/bidiPage.ts

@@ -103,7 +103,7 @@ export class BidiPage implements PageDelegate {
   }
 
   private _onFrameAttached(frameId: string, parentFrameId: string | null): frames.Frame {
-    return this._page._frameManager.frameAttached(frameId, parentFrameId);
+    return this._page.frameManager.frameAttached(frameId, parentFrameId);
   }
 
   private _removeContextsForFrame(frame: frames.Frame, notifyFrame: boolean) {
@@ -121,7 +121,7 @@ export class BidiPage implements PageDelegate {
       return;
     if (realmInfo.type !== 'window')
       return;
-    const frame = this._page._frameManager.frame(realmInfo.context);
+    const frame = this._page.frameManager.frame(realmInfo.context);
     if (!frame)
       return;
     let worldName: types.World;
@@ -172,47 +172,47 @@ export class BidiPage implements PageDelegate {
 
   private _onNavigationStarted(params: bidi.BrowsingContext.NavigationInfo) {
     const frameId = params.context;
-    this._page._frameManager.frameRequestedNavigation(frameId, params.navigation!);
+    this._page.frameManager.frameRequestedNavigation(frameId, params.navigation!);
 
     const url = params.url.toLowerCase();
     if (url.startsWith('file:') || url.startsWith('data:') || url === 'about:blank') {
       // Navigation to file urls doesn't emit network events, so we fire 'commit' event right when navigation is started.
       // Doing it in domcontentload would be too late as we'd clear frame tree.
-      const frame = this._page._frameManager.frame(frameId)!;
+      const frame = this._page.frameManager.frame(frameId)!;
       if (frame)
-        this._page._frameManager.frameCommittedNewDocumentNavigation(frameId, params.url, '', params.navigation!, /* initial */ false);
+        this._page.frameManager.frameCommittedNewDocumentNavigation(frameId, params.url, '', params.navigation!, /* initial */ false);
     }
   }
 
   // TODO: there is no separate event for committed navigation, so we approximate it with responseStarted.
   private _onNavigationResponseStarted(params: bidi.Network.ResponseStartedParameters) {
     const frameId = params.context!;
-    const frame = this._page._frameManager.frame(frameId);
+    const frame = this._page.frameManager.frame(frameId);
     assert(frame);
-    this._page._frameManager.frameCommittedNewDocumentNavigation(frameId, params.response.url, '', params.navigation!, /* initial */ false);
+    this._page.frameManager.frameCommittedNewDocumentNavigation(frameId, params.response.url, '', params.navigation!, /* initial */ false);
     // if (!initial)
     //   this._firstNonInitialNavigationCommittedFulfill();
   }
 
   private _onDomContentLoaded(params: bidi.BrowsingContext.NavigationInfo) {
     const frameId = params.context;
-    this._page._frameManager.frameLifecycleEvent(frameId, 'domcontentloaded');
+    this._page.frameManager.frameLifecycleEvent(frameId, 'domcontentloaded');
   }
 
   private _onLoad(params: bidi.BrowsingContext.NavigationInfo) {
-    this._page._frameManager.frameLifecycleEvent(params.context, 'load');
+    this._page.frameManager.frameLifecycleEvent(params.context, 'load');
   }
 
   private _onNavigationAborted(params: bidi.BrowsingContext.NavigationInfo) {
-    this._page._frameManager.frameAbortedNavigation(params.context, 'Navigation aborted', params.navigation || undefined);
+    this._page.frameManager.frameAbortedNavigation(params.context, 'Navigation aborted', params.navigation || undefined);
   }
 
   private _onNavigationFailed(params: bidi.BrowsingContext.NavigationInfo) {
-    this._page._frameManager.frameAbortedNavigation(params.context, 'Navigation failed', params.navigation || undefined);
+    this._page.frameManager.frameAbortedNavigation(params.context, 'Navigation failed', params.navigation || undefined);
   }
 
   private _onFragmentNavigated(params: bidi.BrowsingContext.NavigationInfo) {
-    this._page._frameManager.frameCommittedSameDocumentNavigation(params.context, params.url);
+    this._page.frameManager.frameCommittedSameDocumentNavigation(params.context, params.url);
   }
 
   private _onUserPromptOpened(event: bidi.BrowsingContext.UserPromptOpenedParameters) {
@@ -235,7 +235,7 @@ export class BidiPage implements PageDelegate {
       return;
     const callFrame = params.stackTrace?.callFrames[0];
     const location = callFrame ?? { url: '', lineNumber: 1, columnNumber: 1 };
-    this._page._addConsoleMessage(entry.method, entry.args.map(arg => createHandle(context, arg)), location, params.text || undefined);
+    this._page.addConsoleMessage(entry.method, entry.args.map(arg => createHandle(context, arg)), location, params.text || undefined);
   }
 
   async navigateFrame(frame: frames.Frame, url: string, referrer: string | undefined): Promise<frames.GotoResult> {
@@ -328,7 +328,7 @@ export class BidiPage implements PageDelegate {
       return;
     if (event.data.type !== 'string')
       return;
-    await this._page._onBindingCalled(event.data.value, context);
+    await this._page.onBindingCalled(event.data.value, context);
   }
 
   async addInitScript(initScript: InitScript): Promise<void> {
@@ -380,7 +380,7 @@ export class BidiPage implements PageDelegate {
     const frameId = await executionContext.contentFrameIdForFrame(handle);
     if (!frameId)
       return null;
-    return this._page._frameManager.frame(frameId);
+    return this._page.frameManager.frame(frameId);
   }
 
   async getOwnerFrame(handle: dom.ElementHandle): Promise<string | null> {

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

@@ -146,7 +146,7 @@ export abstract class Browser extends SdkObject {
     this._idToVideo.set(videoId, { context, artifact });
     pageOrError.then(page => {
       if (page instanceof Page) {
-        page._video = artifact;
+        page.video = artifact;
         page.emitOnContext(BrowserContext.Events.VideoStarted, artifact);
         page.emit(Page.Events.Video, artifact);
       }

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

@@ -216,11 +216,11 @@ export abstract class BrowserContext extends SdkObject {
     }
 
     // Unless dialogs are dismissed, setting extra http headers below does not respond.
-    page?._frameManager.setCloseAllOpeningDialogs(true);
-    await page?._frameManager.closeOpenDialogs();
+    page?.frameManager.setCloseAllOpeningDialogs(true);
+    await page?.frameManager.closeOpenDialogs();
     // Navigate to about:blank first to ensure no page scripts are running after this point.
     await page?.mainFrame().goto(metadata, 'about:blank', { timeout: 0 });
-    page?._frameManager.setCloseAllOpeningDialogs(false);
+    page?.frameManager.setCloseAllOpeningDialogs(false);
 
     await this._resetStorage();
     await this._removeExposedBindings();
@@ -544,7 +544,7 @@ export abstract class BrowserContext extends SdkObject {
     if (originsToSave.size)  {
       const internalMetadata = serverSideCallMetadata();
       const page = await this.newPage(internalMetadata);
-      await page._setServerRequestInterceptor(handler => {
+      await page.setServerRequestInterceptor(handler => {
         handler.fulfill({ body: '<html></html>' }).catch(() => {});
         return true;
       });
@@ -574,7 +574,7 @@ export abstract class BrowserContext extends SdkObject {
       // as a user-visible page.
       isServerSide: false,
     });
-    await page._setServerRequestInterceptor(handler => {
+    await page.setServerRequestInterceptor(handler => {
       handler.fulfill({ body: '<html></html>' }).catch(() => {});
       return true;
     });
@@ -585,7 +585,7 @@ export abstract class BrowserContext extends SdkObject {
       await frame.resetStorageForCurrentOriginBestEffort(newOrigins.get(origin));
     }
 
-    await page._setServerRequestInterceptor(undefined);
+    await page.setServerRequestInterceptor(undefined);
 
     this._origins = new Set([...newOrigins.keys()]);
     // It is safe to not restore the URL to about:blank since we are doing it in Page::resetForReuse.
@@ -609,7 +609,7 @@ export abstract class BrowserContext extends SdkObject {
       if (state.origins && state.origins.length)  {
         const internalMetadata = serverSideCallMetadata();
         const page = await this.newPage(internalMetadata);
-        await page._setServerRequestInterceptor(handler => {
+        await page.setServerRequestInterceptor(handler => {
           handler.fulfill({ body: '<html></html>' }).catch(() => {});
           return true;
         });
@@ -670,13 +670,6 @@ export abstract class BrowserContext extends SdkObject {
   }
 }
 
-export function assertBrowserContextIsNotOwned(context: BrowserContext) {
-  for (const page of context.pages()) {
-    if (page._ownedContext)
-      throw new Error('Please use browser.newContext() for multi-page scripts that share the context.');
-  }
-}
-
 export function validateBrowserContextOptions(options: types.BrowserContextOptions, browserOptions: BrowserOptions) {
   if (options.noDefaultViewport && options.deviceScaleFactor !== undefined)
     throw new Error(`"deviceScaleFactor" option is not supported with null "viewport"`);