1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392/**
* Copyright 2017 Google Inc. All rights reserved.
* Modifications copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { assert } from '../../utils';
import { Browser } from '../browser';
import { BrowserContext, verifyGeolocation } from '../browserContext';
import * as network from '../network';
import { WKConnection, WKSession, kPageProxyMessageReceived } from './wkConnection';
import { WKPage } from './wkPage';
import { TargetClosedError } from '../errors';
import { translatePathToWSL } from './webkit';
import type { BrowserOptions } from '../browser';
import type { SdkObject } from '../instrumentation';
import type { InitScript, Page } from '../page';
import type { ConnectionTransport } from '../transport';
import type * as types from '../types';
import type { Protocol } from './protocol';
import type { PageProxyMessageReceivedPayload } from './wkConnection';
import type * as channels from '@protocol/channels';
const BROWSER_VERSION = '26.0';
const DEFAULT_USER_AGENT = `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/${BROWSER_VERSION} Safari/605.1.15`;
export class WKBrowser extends Browser {
private readonly _connection: WKConnection;
readonly _browserSession: WKSession;
readonly _contexts = new Map<string, WKBrowserContext>();
readonly _wkPages = new Map<string, WKPage>();
static async connect(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions): Promise<WKBrowser> {
const browser = new WKBrowser(parent, transport, options);
if ((options as any).__testHookOnConnectToBrowser)
await (options as any).__testHookOnConnectToBrowser();
const promises: Promise<any>[] = [
browser._browserSession.send('Playwright.enable'),
];
if (options.persistent) {
options.persistent.userAgent ||= DEFAULT_USER_AGENT;
browser._defaultContext = new WKBrowserContext(browser, undefined, options.persistent);
promises.push((browser._defaultContext as WKBrowserContext)._initialize());
}
await Promise.all(promises);
return browser;
}
constructor(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions) {
super(parent, options);
this._connection = new WKConnection(transport, this._onDisconnect.bind(this), options.protocolLogger, options.browserLogsCollector);
this._browserSession = this._connection.browserSession;
this._browserSession.on('Playwright.pageProxyCreated', this._onPageProxyCreated.bind(this));
this._browserSession.on('Playwright.pageProxyDestroyed', this._onPageProxyDestroyed.bind(this));
this._browserSession.on('Playwright.provisionalLoadFailed', event => this._onProvisionalLoadFailed(event));
this._browserSession.on('Playwright.windowOpen', event => this._onWindowOpen(event));
this._browserSession.on('Playwright.downloadCreated', this._onDownloadCreated.bind(this));
this._browserSession.on('Playwright.downloadFilenameSuggested', this._onDownloadFilenameSuggested.bind(this));
this._browserSession.on('Playwright.downloadFinished', this._onDownloadFinished.bind(this));
this._browserSession.on(kPageProxyMessageReceived, this._onPageProxyMessageReceived.bind(this));
}
_onDisconnect() {
for (const wkPage of this._wkPages.values())
wkPage.didClose();
this._wkPages.clear();
for (const video of this._idToVideo.values())
video.artifact.reportFinished(new TargetClosedError(this.closeReason()));
this._idToVideo.clear();
this._didClose();
}
async doCreateNewContext(options: types.BrowserContextOptions): Promise<BrowserContext> {
const proxy = options.proxyOverride || options.proxy;
const createOptions = proxy ? {
// Enable socks5 hostname resolution on Windows.
// See https://github.com/microsoft/playwright/issues/20451
proxyServer: process.platform === 'win32' && this.attribution.browser?.options.channel !== 'webkit-wsl' ? proxy.server.replace(/^socks5:\/\//, 'socks5h://') : proxy.server,
proxyBypassList: proxy.bypass
} : undefined;
const { browserContextId } = await this._browserSession.send('Playwright.createContext', createOptions);
options.userAgent = options.userAgent || DEFAULT_USER_AGENT;
const context = new WKBrowserContext(this, browserContextId, options);
await context._initialize();
this._contexts.set(browserContextId, context);
return context;
}
contexts(): BrowserContext[] {
return Array.from(this._contexts.values());
}
version(): string {
return BROWSER_VERSION;
}
userAgent(): string {
return DEFAULT_USER_AGENT;
}
_onDownloadCreated(payload: Protocol.Playwright.downloadCreatedPayload) {
const page = this._wkPages.get(payload.pageProxyId);
if (!page)
return;
// In some cases, e.g. blob url download, we receive only frameScheduledNavigation
// but no signals that the navigation was canceled and replaced by download. Fix it
// here by simulating cancelled provisional load which matches downloads from network.
//
// TODO: this is racy, because download might be unrelated any navigation, and we will
// abort navigation that is still running. We should be able to fix this by
// instrumenting policy decision start/proceed/cancel.
//
// Since https://commits.webkit.org/298732@main, WebKit doesn't provide frame id for
// navigations converted into downloads and the download has a fake frameId. We map it
// to the main frame.
let frameId = payload.frameId;
if (!page._page.frameManager.frame(frameId))
frameId = page._page.mainFrame()._id;
page._page.frameManager.frameAbortedNavigation(frameId, 'Download is starting');
let originPage = page._page.initializedOrUndefined();
// If it's a new window download, report it on the opener page.
if (!originPage) {
// Resume the page creation with an error. The page will automatically close right
// after the download begins.
page._firstNonInitialNavigationCommittedReject(new Error('Starting new page download'));
if (page._opener)
originPage = page._opener._page.initializedOrUndefined();
}
if (!originPage)
return;
this._downloadCreated(originPage, payload.uuid, payload.url);
}
_onDownloadFilenameSuggested(payload: Protocol.Playwright.downloadFilenameSuggestedPayload) {
this._downloadFilenameSuggested(payload.uuid, payload.suggestedFilename);
}
_onDownloadFinished(payload: Protocol.Playwright.downloadFinishedPayload) {
this._downloadFinished(payload.uuid, payload.error);
}
_onPageProxyCreated(event: Protocol.Playwright.pageProxyCreatedPayload) {
const pageProxyId = event.pageProxyId;
let context: WKBrowserContext | null = null;
if (event.browserContextId) {
// FIXME: we don't know about the default context id, so assume that all targets from
// unknown contexts are created in the 'default' context which can in practice be represented
// by multiple actual contexts in WebKit. Solving this properly will require adding context
// lifecycle events.
context = this._contexts.get(event.browserContextId) || null;
}
if (!context)
context = this._defaultContext as WKBrowserContext;
if (!context)
return;
const pageProxySession = new WKSession(this._connection, pageProxyId, (message: any) => {
this._connection.rawSend({ ...message, pageProxyId });
});
const opener = event.openerId ? this._wkPages.get(event.openerId) : undefined;
const wkPage = new WKPage(context, pageProxySession, opener || null);
this._wkPages.set(pageProxyId, wkPage);
}
_onPageProxyDestroyed(event: Protocol.Playwright.pageProxyDestroyedPayload) {
const pageProxyId = event.pageProxyId;
const wkPage = this._wkPages.get(pageProxyId);
if (!wkPage)
return;
this._wkPages.delete(pageProxyId);
wkPage.didClose();
}
_onPageProxyMessageReceived(event: PageProxyMessageReceivedPayload) {
const wkPage = this._wkPages.get(event.pageProxyId);
if (!wkPage)
return;
wkPage.dispatchMessageToSession(event.message);
}
_onProvisionalLoadFailed(event: Protocol.Playwright.provisionalLoadFailedPayload) {
const wkPage = this._wkPages.get(event.pageProxyId);
if (!wkPage)
return;
wkPage.handleProvisionalLoadFailed(event);
}
_onWindowOpen(event: Protocol.Playwright.windowOpenPayload) {
const wkPage = this._wkPages.get(event.pageProxyId);
if (!wkPage)
return;
wkPage.handleWindowOpen(event);
}
isConnected(): boolean {
return !this._connection.isClosed();
}
}
export class WKBrowserContext extends BrowserContext {
declare readonly _browser: WKBrowser;
constructor(browser: WKBrowser, browserContextId: string | undefined, options: types.BrowserContextOptions) {
super(browser, options, browserContextId);
this._validateEmulatedViewport(options.viewport);
this._authenticateProxyViaHeader();
}
override async _initialize() {
assert(!this._wkPages().length);
const browserContextId = this._browserContextId;
const promises: Promise<any>[] = [super._initialize()];
promises.push(this._browser._browserSession.send('Playwright.setDownloadBehavior', {
behavior: this._options.acceptDownloads === 'accept' ? 'allow' : 'deny',
downloadPath: this._browser.options.channel === 'webkit-wsl' ? await translatePathToWSL(this._browser.options.downloadsPath) : this._browser.options.downloadsPath,
browserContextId
}));
if (this._options.ignoreHTTPSErrors || this._options.internalIgnoreHTTPSErrors)
promises.push(this._browser._browserSession.send('Playwright.setIgnoreCertificateErrors', { browserContextId, ignore: true }));
if (this._options.locale)
promises.push(this._browser._browserSession.send('Playwright.setLanguages', { browserContextId, languages: [this._options.locale] }));
if (this._options.geolocation)
promises.push(this.setGeolocation(this._options.geolocation));
if (this._options.offline)
promises.push(this.doUpdateOffline());
if (this._options.httpCredentials)
promises.push(this.setHTTPCredentials(this._options.httpCredentials));
await Promise.all(promises);
}
_wkPages(): WKPage[] {
return Array.from(this._browser._wkPages.values()).filter(wkPage => wkPage._browserContext === this);
}
override possiblyUninitializedPages(): Page[] {
return this._wkPages().map(wkPage => wkPage._page);
}
override async doCreateNewPage(): Promise<Page> {
const { pageProxyId } = await this._browser._browserSession.send('Playwright.createPage', { browserContextId: this._browserContextId });
return this._browser._wkPages.get(pageProxyId)!._page;
}
async doGetCookies(urls: string[]): Promise<channels.NetworkCookie[]> {
const { cookies } = await this._browser._browserSession.send('Playwright.getAllCookies', { browserContextId: this._browserContextId });
return network.filterCookies(cookies.map((c: channels.NetworkCookie) => {
const { name, value, domain, path, expires, httpOnly, secure, sameSite } = c;
const copy: channels.NetworkCookie = {
name,
value,
domain,
path,
expires: expires === -1 ? -1 : expires / 1000,
httpOnly,
secure,
sameSite,
};
return copy;
}), urls);
}
async addCookies(cookies: channels.SetNetworkCookie[]) {
const cc = network.rewriteCookies(cookies).map(c => {
const { name, value, domain, path, expires, httpOnly, secure, sameSite } = c;
const copy: Protocol.Playwright.SetCookieParam = {
name,
value,
domain: domain!,
path: path!,
expires: expires && expires !== -1 ? expires * 1000 : expires,
httpOnly,
secure,
sameSite,
session: expires === -1 || expires === undefined,
};
return copy;
});
await this._browser._browserSession.send('Playwright.setCookies', { cookies: cc, browserContextId: this._browserContextId });
}
async doClearCookies() {
await this._browser._browserSession.send('Playwright.deleteAllCookies', { browserContextId: this._browserContextId });
}
async doGrantPermissions(origin: string, permissions: string[]) {
await Promise.all(this.pages().map(page => (page.delegate as WKPage)._grantPermissions(origin, permissions)));
}
async doClearPermissions() {
await Promise.all(this.pages().map(page => (page.delegate as WKPage)._clearPermissions()));
}
async setGeolocation(geolocation?: types.Geolocation): Promise<void> {
verifyGeolocation(geolocation);
this._options.geolocation = geolocation;
const payload: any = geolocation ? { ...geolocation, timestamp: Date.now() } : undefined;
await this._browser._browserSession.send('Playwright.setGeolocationOverride', { browserContextId: this._browserContextId, geolocation: payload });
}
async doUpdateExtraHTTPHeaders(): Promise<void> {
for (const page of this.pages())
await (page.delegate as WKPage).updateExtraHTTPHeaders();
}
async setUserAgent(userAgent: string | undefined): Promise<void> {
this._options.userAgent = userAgent;
for (const page of this.pages())
await (page.delegate as WKPage).updateUserAgent();
}
async doUpdateOffline(): Promise<void> {
for (const page of this.pages())
await (page.delegate as WKPage).updateOffline();
}
async doSetHTTPCredentials(httpCredentials?: types.Credentials): Promise<void> {
this._options.httpCredentials = httpCredentials;
for (const page of this.pages())
await (page.delegate as WKPage).updateHttpCredentials();
}
async doAddInitScript(initScript: InitScript) {
for (const page of this.pages())
await (page.delegate as WKPage)._updateBootstrapScript();
}
async doRemoveInitScripts(initScripts: InitScript[]) {
for (const page of this.pages())
await (page.delegate as WKPage)._updateBootstrapScript();
}
async doUpdateRequestInterception(): Promise<void> {
for (const page of this.pages())
await (page.delegate as WKPage).updateRequestInterception();
}
override async doUpdateDefaultViewport() {
// No-op, because each page resets its own viewport.
}
override async doUpdateDefaultEmulatedMedia() {
// No-op, because each page resets its own color scheme.
}
override async doExposePlaywrightBinding() {
for (const page of this.pages())
await (page.delegate as WKPage).exposePlaywrightBinding();
}
onClosePersistent() {}
override async clearCache(): Promise<void> {
// We use ephemeral contexts so there is no disk cache.
await this._browser._browserSession.send('Playwright.clearMemoryCache', {
browserContextId: this._browserContextId!
});
}
async doClose(reason: string | undefined) {
if (!this._browserContextId) {
await Promise.all(this._wkPages().map(wkPage => wkPage._page.screencast.stopVideoRecording()));
// Closing persistent context should close the browser.
await this._browser.close({ reason });
} else {
await this._browser._browserSession.send('Playwright.deleteContext', { browserContextId: this._browserContextId });
this._browser._contexts.delete(this._browserContextId);
}
}
async cancelDownload(uuid: string) {
await this._browser._browserSession.send('Playwright.cancelDownload', { uuid });
}
_validateEmulatedViewport(viewportSize: types.Size | undefined) {
if (!viewportSize)
return;
if (process.platform === 'win32' && this._browser.options.headful && (viewportSize.width < 250 || viewportSize.height < 240))
throw new Error(`WebKit on Windows has a minimal viewport of 250x240.`);
}
}