Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: push browser to the client when launching persistent (#36037)

Dmitry Gozmana87dc8396382
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index 0862264e32..765551fb1f 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -69,7 +69,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
readonly _serviceWorkers = new Set<Worker>();
readonly _isChromium: boolean;
private _harRecorders = new Map<string, { path: string, content: 'embed' | 'attach' | 'omit' | undefined }>();
- _closeWasCalled = false;
+ _closingStatus: 'none' | 'closing' | 'closed' = 'none';
private _closeReason: string | undefined;
private _harRouters: HarRouter[] = [];
@@ -218,7 +218,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
const routeHandlers = this._routes.slice();
for (const routeHandler of routeHandlers) {
// If the page or the context was closed we stall all requests right away.
- if (page?._closeWasCalled || this._closeWasCalled)
+ if (page?._closeWasCalled || this._closingStatus !== 'none')
return;
if (!routeHandler.matches(route.request().url()))
continue;
@@ -465,6 +465,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
}
_onClose() {
+ this._closingStatus = 'closed';
if (this._browser)
this._browser._contexts.delete(this);
this._browserType?._contexts?.delete(this);
@@ -478,10 +479,10 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
}
async close(options: { reason?: string } = {}): Promise<void> {
- if (this._closeWasCalled)
+ if (this._closingStatus !== 'none')
return;
this._closeReason = options.reason;
- this._closeWasCalled = true;
+ this._closingStatus = 'closing';
await this.request.dispose(options);
await this._wrapApiCall(async () => {
await this._browserType?._willCloseContext(this);
diff --git a/packages/playwright-core/src/client/browserType.ts b/packages/playwright-core/src/client/browserType.ts
index b0dc15ab11..119fbef970 100644
--- a/packages/playwright-core/src/client/browserType.ts
+++ b/packages/playwright-core/src/client/browserType.ts
@@ -112,6 +112,8 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
};
return await this._wrapApiCall(async () => {
const result = await this._channel.launchPersistentContext(persistentParams);
+ const browser = Browser.from(result.browser);
+ this._didLaunchBrowser(browser, options, logger);
const context = BrowserContext.from(result.context);
await context._initializeHarFromOptions(options.recordHar);
await this._didCreateContext(context, contextParams, options, logger);
diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.ts
index 155e68d6bf..68a7ea04f9 100644
--- a/packages/playwright-core/src/client/page.ts
+++ b/packages/playwright-core/src/client/page.ts
@@ -192,7 +192,7 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
const routeHandlers = this._routes.slice();
for (const routeHandler of routeHandlers) {
// If the page was closed we stall all requests right away.
- if (this._closeWasCalled || this._browserContext._closeWasCalled)
+ if (this._closeWasCalled || this._browserContext._closingStatus !== 'none')
return;
if (!routeHandler.matches(route.request().url()))
continue;
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index fe2d07b8e8..68c6ec930a 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -640,6 +640,7 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
slowMo: tOptional(tNumber),
});
scheme.BrowserTypeLaunchPersistentContextResult = tObject({
+ browser: tChannel(['Browser']),
context: tChannel(['BrowserContext']),
});
scheme.BrowserTypeConnectOverCDPParams = tObject({
diff --git a/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
index 40bf3eb9d8..2c14c685e7 100644
--- a/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
@@ -39,7 +39,9 @@ export class BrowserTypeDispatcher extends Dispatcher<BrowserType, channels.Brow
async launchPersistentContext(params: channels.BrowserTypeLaunchPersistentContextParams, metadata: CallMetadata): Promise<channels.BrowserTypeLaunchPersistentContextResult> {
const browserContext = await this._object.launchPersistentContext(metadata, params.userDataDir, params);
- return { context: new BrowserContextDispatcher(this, browserContext) };
+ const browserDispatcher = new BrowserDispatcher(this, browserContext._browser);
+ const contextDispatcher = new BrowserContextDispatcher(browserDispatcher, browserContext);
+ return { browser: browserDispatcher, context: contextDispatcher };
}
async connectOverCDP(params: channels.BrowserTypeConnectOverCDPParams, metadata: CallMetadata): Promise<channels.BrowserTypeConnectOverCDPResult> {
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index d3b1c29b84..30e63c71be 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -1135,6 +1135,7 @@ export type BrowserTypeLaunchPersistentContextOptions = {
slowMo?: number,
};
export type BrowserTypeLaunchPersistentContextResult = {
+ browser: BrowserChannel,
context: BrowserContextChannel,
};
export type BrowserTypeConnectOverCDPParams = {
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index f3f6fdaad3..da8f500cb6 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -1033,6 +1033,7 @@ BrowserType:
userDataDir: string
slowMo: number?
returns:
+ browser: Browser
context: BrowserContext
connectOverCDP:
diff --git a/tests/library/defaultbrowsercontext-2.spec.ts b/tests/library/defaultbrowsercontext-2.spec.ts
index ea5de96322..80158bf5e1 100644
--- a/tests/library/defaultbrowsercontext-2.spec.ts
+++ b/tests/library/defaultbrowsercontext-2.spec.ts
@@ -269,3 +269,16 @@ it('dialog.accept should work', {
expect(shown).toBe(true);
await context.close();
});
+
+it('exposes browser', async ({ launchPersistent }) => {
+ const { context } = await launchPersistent();
+ const browser = context.browser();
+ expect(browser.version()).toBeTruthy();
+ const page = await browser.newPage();
+ await page.goto('data:text/html,<html><title>Title</title></html>');
+ expect(await page.title()).toBe('Title');
+ await browser.close();
+ expect(context.pages().length).toBe(0);
+ // Next line should not throw.
+ await context.close();
+});