Skip to content

fix(browser): wait for the pipe to disconnect in browser.close #1652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2020
Merged

fix(browser): wait for the pipe to disconnect in browser.close #1652

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e39e22f
fix(browser): wait for the pipe to disconnect in browser.close
JoelEinbinder Apr 3, 2020
2488729
only wait if the browser isn't already closed
JoelEinbinder Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions src/browser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,27 @@ import { Page } from './page';
import { EventEmitter } from 'events';
import { Download } from './download';
import { debugProtocol } from './transport';
import type { BrowserServer } from './server/browserServer';
import { Events } from './events';

export interface Browser extends EventEmitter {
newContext(options?: BrowserContextOptions): Promise<BrowserContext>;
contexts(): BrowserContext[];
newPage(options?: BrowserContextOptions): Promise<Page>;
isConnected(): boolean;
close(): Promise<void>;
_disconnect(): Promise<void>;
}

export abstract class BrowserBase extends EventEmitter implements Browser {
_downloadsPath: string = '';
private _downloads = new Map<string, Download>();
_debugProtocol = debugProtocol;
_ownedServer: BrowserServer | null = null;

abstract newContext(options?: BrowserContextOptions): Promise<BrowserContext>;
abstract contexts(): BrowserContext[];
abstract isConnected(): boolean;
abstract close(): Promise<void>;
abstract _disconnect(): Promise<void>;
abstract _disconnect(): void;

async newPage(options?: BrowserContextOptions): Promise<Page> {
const context = await this.newContext(options);
Expand All @@ -59,6 +60,17 @@ export abstract class BrowserBase extends EventEmitter implements Browser {
download._reportFinished(error);
this._downloads.delete(uuid);
}

async close() {
const disconnectEventPromise = new Promise(x => this.once(Events.Browser.Disconnected, x));
if (this._ownedServer) {
await this._ownedServer.close();
} else {
await Promise.all(this.contexts().map(context => context.close()));
this._disconnect();
}
await disconnectEventPromise;
}
}

export type LaunchType = 'local' | 'server' | 'persistent';
14 changes: 1 addition & 13 deletions src/chromium/crBrowser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import { readProtocolStream } from './crProtocolHelper';
import { Events } from './events';
import { Protocol } from './protocol';
import { CRExecutionContext } from './crExecutionContext';
import { BrowserServer } from '../server/browserServer';

export class CRBrowser extends BrowserBase {
readonly _connection: CRConnection;
Expand All @@ -46,7 +45,6 @@ export class CRBrowser extends BrowserBase {
private _tracingRecording = false;
private _tracingPath: string | null = '';
private _tracingClient: CRSession | undefined;
_ownedServer: BrowserServer | null = null;

static async connect(transport: ConnectionTransport, isPersistent: boolean, slowMo?: number): Promise<CRBrowser> {
const connection = new CRConnection(SlowMoTransport.wrap(transport, slowMo));
Expand Down Expand Up @@ -180,18 +178,8 @@ export class CRBrowser extends BrowserBase {
await this._session.send('Target.closeTarget', { targetId: crPage._targetId });
}

async _disconnect() {
const disconnected = new Promise(f => this._connection.once(ConnectionEvents.Disconnected, f));
await Promise.all(this.contexts().map(context => context.close()));
_disconnect() {
this._connection.close();
await disconnected;
}

async close() {
if (this._ownedServer)
await this._ownedServer.close();
else
await this._disconnect();
}

async newBrowserCDPSession(): Promise<CRSession> {
Expand Down
14 changes: 1 addition & 13 deletions src/firefox/ffBrowser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import { ConnectionEvents, FFConnection } from './ffConnection';
import { headersArray } from './ffNetworkManager';
import { FFPage } from './ffPage';
import { Protocol } from './protocol';
import { BrowserServer } from '../server/browserServer';

export class FFBrowser extends BrowserBase {
_connection: FFConnection;
Expand All @@ -37,7 +36,6 @@ export class FFBrowser extends BrowserBase {
private _eventListeners: RegisteredListener[];
readonly _firstPagePromise: Promise<void>;
private _firstPageCallback = () => {};
_ownedServer: BrowserServer | null = null;

static async connect(transport: ConnectionTransport, attachToDefaultContext: boolean, slowMo?: number): Promise<FFBrowser> {
const connection = new FFConnection(SlowMoTransport.wrap(transport, slowMo));
Expand Down Expand Up @@ -137,19 +135,9 @@ export class FFBrowser extends BrowserBase {
});
}

async _disconnect() {
await Promise.all(this.contexts().map(context => context.close()));
_disconnect() {
helper.removeEventListeners(this._eventListeners);
const disconnected = new Promise(f => this.once(Events.Browser.Disconnected, f));
this._connection.close();
await disconnected;
}

async close() {
if (this._ownedServer)
await this._ownedServer.close();
else
await this._disconnect();
}
}

Expand Down
5 changes: 3 additions & 2 deletions src/server/webkit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export class WebKit implements BrowserType<WKBrowser> {
async launch(options: LaunchOptions = {}): Promise<WKBrowser> {
assert(!(options as any).userDataDir, 'userDataDir option is not supported in `browserType.launch`. Use `browserType.launchPersistentContext` instead');
const { browserServer, transport, downloadsPath } = await this._launchServer(options, 'local');
const browser = await WKBrowser.connect(transport!, options.slowMo, false, () => browserServer.close());
const browser = await WKBrowser.connect(transport!, options.slowMo, false);
browser._ownedServer = browserServer;
browser._downloadsPath = downloadsPath;
return browser;
Expand All @@ -64,7 +64,8 @@ export class WebKit implements BrowserType<WKBrowser> {
slowMo = 0,
} = options;
const { transport, browserServer } = await this._launchServer(options, 'persistent', userDataDir);
const browser = await WKBrowser.connect(transport!, slowMo, true, () => browserServer.close());
const browser = await WKBrowser.connect(transport!, slowMo, true);
browser._ownedServer = browserServer;
await helper.waitWithTimeout(browser._waitForFirstPageTarget(), 'first page', timeout);
return browser._defaultContext;
}
Expand Down
21 changes: 4 additions & 17 deletions src/webkit/wkBrowser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import * as types from '../types';
import { Protocol } from './protocol';
import { kPageProxyMessageReceived, PageProxyMessageReceivedPayload, WKConnection, WKSession } from './wkConnection';
import { WKPage } from './wkPage';
import { BrowserServer } from '../server/browserServer';

const DEFAULT_USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.4 Safari/605.1.15';

Expand All @@ -43,18 +42,16 @@ export class WKBrowser extends BrowserBase {

private _firstPageCallback: () => void = () => {};
private readonly _firstPagePromise: Promise<void>;
_ownedServer: BrowserServer | null = null;

static async connect(transport: ConnectionTransport, slowMo: number = 0, attachToDefaultContext: boolean = false, closeOverride?: () => Promise<void>): Promise<WKBrowser> {
const browser = new WKBrowser(SlowMoTransport.wrap(transport, slowMo), attachToDefaultContext, closeOverride);
static async connect(transport: ConnectionTransport, slowMo: number = 0, attachToDefaultContext: boolean = false): Promise<WKBrowser> {
const browser = new WKBrowser(SlowMoTransport.wrap(transport, slowMo), attachToDefaultContext);
return browser;
}

constructor(transport: ConnectionTransport, attachToDefaultContext: boolean, closeOverride?: () => Promise<void>) {
constructor(transport: ConnectionTransport, attachToDefaultContext: boolean) {
super();
this._connection = new WKConnection(transport, this._onDisconnect.bind(this));
this._attachToDefaultContext = attachToDefaultContext;
this._closeOverride = closeOverride;
this._browserSession = this._connection.browserSession;

this._defaultContext = new WKBrowserContext(this, undefined, validateBrowserContextOptions({}));
Expand Down Expand Up @@ -190,19 +187,9 @@ export class WKBrowser extends BrowserBase {
return !this._connection.isClosed();
}

async _disconnect() {
_disconnect() {
helper.removeEventListeners(this._eventListeners);
const disconnected = new Promise(f => this.once(Events.Browser.Disconnected, f));
await Promise.all(this.contexts().map(context => context.close()));
this._connection.close();
await disconnected;
}

async close() {
if (this._closeOverride)
await this._closeOverride();
else
await this._disconnect();
}
}

Expand Down