461 lines
16 KiB
JavaScript
461 lines
16 KiB
JavaScript
"use strict";
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.FFBrowserContext = exports.FFBrowser = void 0;
|
|
|
|
var _errors = require("../../utils/errors");
|
|
|
|
var _utils = require("../../utils/utils");
|
|
|
|
var _browser = require("../browser");
|
|
|
|
var _browserContext = require("../browserContext");
|
|
|
|
var network = _interopRequireWildcard(require("../network"));
|
|
|
|
var _ffConnection = require("./ffConnection");
|
|
|
|
var _ffPage = require("./ffPage");
|
|
|
|
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
|
|
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
|
|
/**
|
|
* Copyright 2018 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.
|
|
*/
|
|
class FFBrowser extends _browser.Browser {
|
|
static async connect(transport, options) {
|
|
const connection = new _ffConnection.FFConnection(transport, options.protocolLogger, options.browserLogsCollector);
|
|
const browser = new FFBrowser(connection, options);
|
|
if (options.__testHookOnConnectToBrowser) await options.__testHookOnConnectToBrowser();
|
|
const promises = [connection.send('Browser.enable', {
|
|
attachToDefaultContext: !!options.persistent
|
|
}), browser._initVersion()];
|
|
|
|
if (options.persistent) {
|
|
browser._defaultContext = new FFBrowserContext(browser, undefined, options.persistent);
|
|
promises.push(browser._defaultContext._initialize());
|
|
}
|
|
|
|
if (options.proxy) promises.push(browser._connection.send('Browser.setBrowserProxy', toJugglerProxyOptions(options.proxy)));
|
|
await Promise.all(promises);
|
|
return browser;
|
|
}
|
|
|
|
constructor(connection, options) {
|
|
super(options);
|
|
this._connection = void 0;
|
|
this._ffPages = void 0;
|
|
this._contexts = void 0;
|
|
this._version = '';
|
|
this._userAgent = '';
|
|
this._connection = connection;
|
|
this._ffPages = new Map();
|
|
this._contexts = new Map();
|
|
|
|
this._connection.on(_ffConnection.ConnectionEvents.Disconnected, () => this._onDisconnect());
|
|
|
|
this._connection.on('Browser.attachedToTarget', this._onAttachedToTarget.bind(this));
|
|
|
|
this._connection.on('Browser.detachedFromTarget', this._onDetachedFromTarget.bind(this));
|
|
|
|
this._connection.on('Browser.downloadCreated', this._onDownloadCreated.bind(this));
|
|
|
|
this._connection.on('Browser.downloadFinished', this._onDownloadFinished.bind(this));
|
|
|
|
this._connection.on('Browser.videoRecordingFinished', this._onVideoRecordingFinished.bind(this));
|
|
}
|
|
|
|
async _initVersion() {
|
|
const result = await this._connection.send('Browser.getInfo');
|
|
this._version = result.version.substring(result.version.indexOf('/') + 1);
|
|
this._userAgent = result.userAgent;
|
|
}
|
|
|
|
isConnected() {
|
|
return !this._connection._closed;
|
|
}
|
|
|
|
async newContext(options) {
|
|
(0, _browserContext.validateBrowserContextOptions)(options, this.options);
|
|
if (options.isMobile) throw new Error('options.isMobile is not supported in Firefox');
|
|
const {
|
|
browserContextId
|
|
} = await this._connection.send('Browser.createBrowserContext', {
|
|
removeOnDetach: true
|
|
});
|
|
const context = new FFBrowserContext(this, browserContextId, options);
|
|
await context._initialize();
|
|
|
|
this._contexts.set(browserContextId, context);
|
|
|
|
return context;
|
|
}
|
|
|
|
contexts() {
|
|
return Array.from(this._contexts.values());
|
|
}
|
|
|
|
version() {
|
|
return this._version;
|
|
}
|
|
|
|
userAgent() {
|
|
return this._userAgent;
|
|
}
|
|
|
|
_onDetachedFromTarget(payload) {
|
|
const ffPage = this._ffPages.get(payload.targetId);
|
|
|
|
this._ffPages.delete(payload.targetId);
|
|
|
|
ffPage.didClose();
|
|
}
|
|
|
|
_onAttachedToTarget(payload) {
|
|
const {
|
|
targetId,
|
|
browserContextId,
|
|
openerId,
|
|
type
|
|
} = payload.targetInfo;
|
|
(0, _utils.assert)(type === 'page');
|
|
const context = browserContextId ? this._contexts.get(browserContextId) : this._defaultContext;
|
|
(0, _utils.assert)(context, `Unknown context id:${browserContextId}, _defaultContext: ${this._defaultContext}`);
|
|
|
|
const session = this._connection.createSession(payload.sessionId);
|
|
|
|
const opener = openerId ? this._ffPages.get(openerId) : null;
|
|
const ffPage = new _ffPage.FFPage(session, context, opener);
|
|
|
|
this._ffPages.set(targetId, ffPage);
|
|
}
|
|
|
|
_onDownloadCreated(payload) {
|
|
const ffPage = this._ffPages.get(payload.pageTargetId);
|
|
|
|
(0, _utils.assert)(ffPage);
|
|
if (!ffPage) return;
|
|
let originPage = ffPage._initializedPage; // 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.
|
|
ffPage._markAsError(new Error('Starting new page download'));
|
|
|
|
if (ffPage._opener) originPage = ffPage._opener._initializedPage;
|
|
}
|
|
|
|
if (!originPage) return;
|
|
|
|
this._downloadCreated(originPage, payload.uuid, payload.url, payload.suggestedFileName);
|
|
}
|
|
|
|
_onDownloadFinished(payload) {
|
|
const error = payload.canceled ? 'canceled' : payload.error;
|
|
|
|
this._downloadFinished(payload.uuid, error);
|
|
}
|
|
|
|
_onVideoRecordingFinished(payload) {
|
|
var _this$_takeVideo;
|
|
|
|
(_this$_takeVideo = this._takeVideo(payload.screencastId)) === null || _this$_takeVideo === void 0 ? void 0 : _this$_takeVideo.reportFinished();
|
|
}
|
|
|
|
_onDisconnect() {
|
|
for (const video of this._idToVideo.values()) video.artifact.reportFinished(_errors.kBrowserClosedError);
|
|
|
|
this._idToVideo.clear();
|
|
|
|
this._didClose();
|
|
}
|
|
|
|
}
|
|
|
|
exports.FFBrowser = FFBrowser;
|
|
|
|
class FFBrowserContext extends _browserContext.BrowserContext {
|
|
constructor(browser, browserContextId, options) {
|
|
super(browser, options, browserContextId);
|
|
}
|
|
|
|
async _initialize() {
|
|
(0, _utils.assert)(!this._ffPages().length);
|
|
const browserContextId = this._browserContextId;
|
|
const promises = [super._initialize()];
|
|
promises.push(this._browser._connection.send('Browser.setDownloadOptions', {
|
|
browserContextId,
|
|
downloadOptions: {
|
|
behavior: this._options.acceptDownloads ? 'saveToDisk' : 'cancel',
|
|
downloadsDir: this._browser.options.downloadsPath
|
|
}
|
|
}));
|
|
|
|
if (this._options.viewport) {
|
|
const viewport = {
|
|
viewportSize: {
|
|
width: this._options.viewport.width,
|
|
height: this._options.viewport.height
|
|
},
|
|
deviceScaleFactor: this._options.deviceScaleFactor || 1
|
|
};
|
|
promises.push(this._browser._connection.send('Browser.setDefaultViewport', {
|
|
browserContextId,
|
|
viewport
|
|
}));
|
|
}
|
|
|
|
if (this._options.hasTouch) promises.push(this._browser._connection.send('Browser.setTouchOverride', {
|
|
browserContextId,
|
|
hasTouch: true
|
|
}));
|
|
if (this._options.userAgent) promises.push(this._browser._connection.send('Browser.setUserAgentOverride', {
|
|
browserContextId,
|
|
userAgent: this._options.userAgent
|
|
}));
|
|
if (this._options.bypassCSP) promises.push(this._browser._connection.send('Browser.setBypassCSP', {
|
|
browserContextId,
|
|
bypassCSP: true
|
|
}));
|
|
if (this._options.ignoreHTTPSErrors) promises.push(this._browser._connection.send('Browser.setIgnoreHTTPSErrors', {
|
|
browserContextId,
|
|
ignoreHTTPSErrors: true
|
|
}));
|
|
if (this._options.javaScriptEnabled === false) promises.push(this._browser._connection.send('Browser.setJavaScriptDisabled', {
|
|
browserContextId,
|
|
javaScriptDisabled: true
|
|
}));
|
|
if (this._options.locale) promises.push(this._browser._connection.send('Browser.setLocaleOverride', {
|
|
browserContextId,
|
|
locale: this._options.locale
|
|
}));
|
|
if (this._options.timezoneId) promises.push(this._browser._connection.send('Browser.setTimezoneOverride', {
|
|
browserContextId,
|
|
timezoneId: this._options.timezoneId
|
|
}));
|
|
if (this._options.permissions) promises.push(this.grantPermissions(this._options.permissions));
|
|
if (this._options.extraHTTPHeaders || this._options.locale) promises.push(this.setExtraHTTPHeaders(this._options.extraHTTPHeaders || []));
|
|
if (this._options.httpCredentials) promises.push(this.setHTTPCredentials(this._options.httpCredentials));
|
|
if (this._options.geolocation) promises.push(this.setGeolocation(this._options.geolocation));
|
|
if (this._options.offline) promises.push(this.setOffline(this._options.offline));
|
|
promises.push(this._browser._connection.send('Browser.setColorScheme', {
|
|
browserContextId,
|
|
colorScheme: this._options.colorScheme !== undefined ? this._options.colorScheme : 'light'
|
|
}));
|
|
promises.push(this._browser._connection.send('Browser.setReducedMotion', {
|
|
browserContextId,
|
|
reducedMotion: this._options.reducedMotion !== undefined ? this._options.reducedMotion : 'no-preference'
|
|
}));
|
|
promises.push(this._browser._connection.send('Browser.setForcedColors', {
|
|
browserContextId,
|
|
forcedColors: this._options.forcedColors !== undefined ? this._options.forcedColors : 'none'
|
|
}));
|
|
|
|
if (this._options.recordVideo) {
|
|
promises.push(this._ensureVideosPath().then(() => {
|
|
return this._browser._connection.send('Browser.setVideoRecordingOptions', {
|
|
// validateBrowserContextOptions ensures correct video size.
|
|
options: { ...this._options.recordVideo.size,
|
|
dir: this._options.recordVideo.dir
|
|
},
|
|
browserContextId: this._browserContextId
|
|
});
|
|
}));
|
|
}
|
|
|
|
if (this._options.proxy) {
|
|
promises.push(this._browser._connection.send('Browser.setContextProxy', {
|
|
browserContextId: this._browserContextId,
|
|
...toJugglerProxyOptions(this._options.proxy)
|
|
}));
|
|
}
|
|
|
|
await Promise.all(promises);
|
|
}
|
|
|
|
_ffPages() {
|
|
return Array.from(this._browser._ffPages.values()).filter(ffPage => ffPage._browserContext === this);
|
|
}
|
|
|
|
pages() {
|
|
return this._ffPages().map(ffPage => ffPage._initializedPage).filter(pageOrNull => !!pageOrNull);
|
|
}
|
|
|
|
async newPageDelegate() {
|
|
(0, _browserContext.assertBrowserContextIsNotOwned)(this);
|
|
const {
|
|
targetId
|
|
} = await this._browser._connection.send('Browser.newPage', {
|
|
browserContextId: this._browserContextId
|
|
}).catch(e => {
|
|
if (e.message.includes('Failed to override timezone')) throw new Error(`Invalid timezone ID: ${this._options.timezoneId}`);
|
|
throw e;
|
|
});
|
|
return this._browser._ffPages.get(targetId);
|
|
}
|
|
|
|
async _doCookies(urls) {
|
|
const {
|
|
cookies
|
|
} = await this._browser._connection.send('Browser.getCookies', {
|
|
browserContextId: this._browserContextId
|
|
});
|
|
return network.filterCookies(cookies.map(c => {
|
|
const copy = { ...c
|
|
};
|
|
delete copy.size;
|
|
delete copy.session;
|
|
return copy;
|
|
}), urls);
|
|
}
|
|
|
|
async addCookies(cookies) {
|
|
const cc = network.rewriteCookies(cookies).map(c => ({ ...c,
|
|
expires: c.expires && c.expires !== -1 ? c.expires : undefined
|
|
}));
|
|
await this._browser._connection.send('Browser.setCookies', {
|
|
browserContextId: this._browserContextId,
|
|
cookies: cc
|
|
});
|
|
}
|
|
|
|
async clearCookies() {
|
|
await this._browser._connection.send('Browser.clearCookies', {
|
|
browserContextId: this._browserContextId
|
|
});
|
|
}
|
|
|
|
async _doGrantPermissions(origin, permissions) {
|
|
const webPermissionToProtocol = new Map([['geolocation', 'geo'], ['persistent-storage', 'persistent-storage'], ['push', 'push'], ['notifications', 'desktop-notification']]);
|
|
const filtered = permissions.map(permission => {
|
|
const protocolPermission = webPermissionToProtocol.get(permission);
|
|
if (!protocolPermission) throw new Error('Unknown permission: ' + permission);
|
|
return protocolPermission;
|
|
});
|
|
await this._browser._connection.send('Browser.grantPermissions', {
|
|
origin: origin,
|
|
browserContextId: this._browserContextId,
|
|
permissions: filtered
|
|
});
|
|
}
|
|
|
|
async _doClearPermissions() {
|
|
await this._browser._connection.send('Browser.resetPermissions', {
|
|
browserContextId: this._browserContextId
|
|
});
|
|
}
|
|
|
|
async setGeolocation(geolocation) {
|
|
(0, _browserContext.verifyGeolocation)(geolocation);
|
|
this._options.geolocation = geolocation;
|
|
await this._browser._connection.send('Browser.setGeolocationOverride', {
|
|
browserContextId: this._browserContextId,
|
|
geolocation: geolocation || null
|
|
});
|
|
}
|
|
|
|
async setExtraHTTPHeaders(headers) {
|
|
this._options.extraHTTPHeaders = headers;
|
|
let allHeaders = this._options.extraHTTPHeaders;
|
|
if (this._options.locale) allHeaders = network.mergeHeaders([allHeaders, network.singleHeader('Accept-Language', this._options.locale)]);
|
|
await this._browser._connection.send('Browser.setExtraHTTPHeaders', {
|
|
browserContextId: this._browserContextId,
|
|
headers: allHeaders
|
|
});
|
|
}
|
|
|
|
async setOffline(offline) {
|
|
this._options.offline = offline;
|
|
await this._browser._connection.send('Browser.setOnlineOverride', {
|
|
browserContextId: this._browserContextId,
|
|
override: offline ? 'offline' : 'online'
|
|
});
|
|
}
|
|
|
|
async _doSetHTTPCredentials(httpCredentials) {
|
|
this._options.httpCredentials = httpCredentials;
|
|
await this._browser._connection.send('Browser.setHTTPCredentials', {
|
|
browserContextId: this._browserContextId,
|
|
credentials: httpCredentials || null
|
|
});
|
|
}
|
|
|
|
async _doAddInitScript(source) {
|
|
await this._browser._connection.send('Browser.addScriptToEvaluateOnNewDocument', {
|
|
browserContextId: this._browserContextId,
|
|
script: source
|
|
});
|
|
}
|
|
|
|
async _doExposeBinding(binding) {
|
|
await this._browser._connection.send('Browser.addBinding', {
|
|
browserContextId: this._browserContextId,
|
|
name: binding.name,
|
|
script: binding.source
|
|
});
|
|
}
|
|
|
|
async _doUpdateRequestInterception() {
|
|
await this._browser._connection.send('Browser.setRequestInterception', {
|
|
browserContextId: this._browserContextId,
|
|
enabled: !!this._requestInterceptor
|
|
});
|
|
}
|
|
|
|
_onClosePersistent() {}
|
|
|
|
async _doClose() {
|
|
(0, _utils.assert)(this._browserContextId);
|
|
await this._browser._connection.send('Browser.removeBrowserContext', {
|
|
browserContextId: this._browserContextId
|
|
});
|
|
|
|
this._browser._contexts.delete(this._browserContextId);
|
|
}
|
|
|
|
async _doCancelDownload(uuid) {
|
|
await this._browser._connection.send('Browser.cancelDownload', {
|
|
uuid
|
|
});
|
|
}
|
|
|
|
}
|
|
|
|
exports.FFBrowserContext = FFBrowserContext;
|
|
|
|
function toJugglerProxyOptions(proxy) {
|
|
const proxyServer = new URL(proxy.server);
|
|
let port = parseInt(proxyServer.port, 10);
|
|
let type = 'http';
|
|
if (proxyServer.protocol === 'socks5:') type = 'socks';else if (proxyServer.protocol === 'socks4:') type = 'socks4';else if (proxyServer.protocol === 'https:') type = 'https';
|
|
|
|
if (proxyServer.port === '') {
|
|
if (proxyServer.protocol === 'http:') port = 80;else if (proxyServer.protocol === 'https:') port = 443;
|
|
}
|
|
|
|
return {
|
|
type,
|
|
bypass: proxy.bypass ? proxy.bypass.split(',').map(domain => domain.trim()) : [],
|
|
host: proxyServer.hostname,
|
|
port,
|
|
username: proxy.username,
|
|
password: proxy.password
|
|
};
|
|
} |