ffBrowser.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.FFBrowserContext = exports.FFBrowser = void 0;
  6. var _errors = require("../errors");
  7. var _utils = require("../../utils");
  8. var _browser = require("../browser");
  9. var _browserContext = require("../browserContext");
  10. var network = _interopRequireWildcard(require("../network"));
  11. var _ffConnection = require("./ffConnection");
  12. var _ffPage = require("./ffPage");
  13. 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); }
  14. 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; }
  15. /**
  16. * Copyright 2018 Google Inc. All rights reserved.
  17. * Modifications copyright (c) Microsoft Corporation.
  18. *
  19. * Licensed under the Apache License, Version 2.0 (the 'License');
  20. * you may not use this file except in compliance with the License.
  21. * You may obtain a copy of the License at
  22. *
  23. * http://www.apache.org/licenses/LICENSE-2.0
  24. *
  25. * Unless required by applicable law or agreed to in writing, software
  26. * distributed under the License is distributed on an 'AS IS' BASIS,
  27. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  28. * See the License for the specific language governing permissions and
  29. * limitations under the License.
  30. */
  31. class FFBrowser extends _browser.Browser {
  32. static async connect(parent, transport, options) {
  33. var _options$originalLaun;
  34. const connection = new _ffConnection.FFConnection(transport, options.protocolLogger, options.browserLogsCollector);
  35. const browser = new FFBrowser(parent, connection, options);
  36. if (options.__testHookOnConnectToBrowser) await options.__testHookOnConnectToBrowser();
  37. let firefoxUserPrefs = (_options$originalLaun = options.originalLaunchOptions.firefoxUserPrefs) !== null && _options$originalLaun !== void 0 ? _options$originalLaun : {};
  38. if (Object.keys(kBandaidFirefoxUserPrefs).length) firefoxUserPrefs = {
  39. ...kBandaidFirefoxUserPrefs,
  40. ...firefoxUserPrefs
  41. };
  42. const promises = [browser.session.send('Browser.enable', {
  43. attachToDefaultContext: !!options.persistent,
  44. userPrefs: Object.entries(firefoxUserPrefs).map(([name, value]) => ({
  45. name,
  46. value
  47. }))
  48. }), browser._initVersion()];
  49. if (options.persistent) {
  50. browser._defaultContext = new FFBrowserContext(browser, undefined, options.persistent);
  51. promises.push(browser._defaultContext._initialize());
  52. }
  53. if (options.proxy) promises.push(browser.session.send('Browser.setBrowserProxy', toJugglerProxyOptions(options.proxy)));
  54. await Promise.all(promises);
  55. return browser;
  56. }
  57. constructor(parent, connection, options) {
  58. super(parent, options);
  59. this._connection = void 0;
  60. this.session = void 0;
  61. this._ffPages = void 0;
  62. this._contexts = void 0;
  63. this._version = '';
  64. this._userAgent = '';
  65. this._connection = connection;
  66. this.session = connection.rootSession;
  67. this._ffPages = new Map();
  68. this._contexts = new Map();
  69. this._connection.on(_ffConnection.ConnectionEvents.Disconnected, () => this._onDisconnect());
  70. this.session.on('Browser.attachedToTarget', this._onAttachedToTarget.bind(this));
  71. this.session.on('Browser.detachedFromTarget', this._onDetachedFromTarget.bind(this));
  72. this.session.on('Browser.downloadCreated', this._onDownloadCreated.bind(this));
  73. this.session.on('Browser.downloadFinished', this._onDownloadFinished.bind(this));
  74. this.session.on('Browser.videoRecordingFinished', this._onVideoRecordingFinished.bind(this));
  75. }
  76. async _initVersion() {
  77. const result = await this.session.send('Browser.getInfo');
  78. this._version = result.version.substring(result.version.indexOf('/') + 1);
  79. this._userAgent = result.userAgent;
  80. }
  81. isConnected() {
  82. return !this._connection._closed;
  83. }
  84. async doCreateNewContext(options) {
  85. if (options.isMobile) throw new Error('options.isMobile is not supported in Firefox');
  86. const {
  87. browserContextId
  88. } = await this.session.send('Browser.createBrowserContext', {
  89. removeOnDetach: true
  90. });
  91. const context = new FFBrowserContext(this, browserContextId, options);
  92. await context._initialize();
  93. this._contexts.set(browserContextId, context);
  94. return context;
  95. }
  96. contexts() {
  97. return Array.from(this._contexts.values());
  98. }
  99. version() {
  100. return this._version;
  101. }
  102. userAgent() {
  103. return this._userAgent;
  104. }
  105. _onDetachedFromTarget(payload) {
  106. const ffPage = this._ffPages.get(payload.targetId);
  107. this._ffPages.delete(payload.targetId);
  108. ffPage.didClose();
  109. }
  110. _onAttachedToTarget(payload) {
  111. const {
  112. targetId,
  113. browserContextId,
  114. openerId,
  115. type
  116. } = payload.targetInfo;
  117. (0, _utils.assert)(type === 'page');
  118. const context = browserContextId ? this._contexts.get(browserContextId) : this._defaultContext;
  119. (0, _utils.assert)(context, `Unknown context id:${browserContextId}, _defaultContext: ${this._defaultContext}`);
  120. const session = this._connection.createSession(payload.sessionId);
  121. const opener = openerId ? this._ffPages.get(openerId) : null;
  122. const ffPage = new _ffPage.FFPage(session, context, opener);
  123. this._ffPages.set(targetId, ffPage);
  124. }
  125. _onDownloadCreated(payload) {
  126. const ffPage = this._ffPages.get(payload.pageTargetId);
  127. if (!ffPage) return;
  128. // Abort the navigation that turned into download.
  129. ffPage._page._frameManager.frameAbortedNavigation(payload.frameId, 'Download is starting');
  130. let originPage = ffPage._initializedPage;
  131. // If it's a new window download, report it on the opener page.
  132. if (!originPage) {
  133. // Resume the page creation with an error. The page will automatically close right
  134. // after the download begins.
  135. ffPage._markAsError(new Error('Starting new page download'));
  136. if (ffPage._opener) originPage = ffPage._opener._initializedPage;
  137. }
  138. if (!originPage) return;
  139. this._downloadCreated(originPage, payload.uuid, payload.url, payload.suggestedFileName);
  140. }
  141. _onDownloadFinished(payload) {
  142. const error = payload.canceled ? 'canceled' : payload.error;
  143. this._downloadFinished(payload.uuid, error);
  144. }
  145. _onVideoRecordingFinished(payload) {
  146. var _this$_takeVideo;
  147. (_this$_takeVideo = this._takeVideo(payload.screencastId)) === null || _this$_takeVideo === void 0 ? void 0 : _this$_takeVideo.reportFinished();
  148. }
  149. _onDisconnect() {
  150. for (const video of this._idToVideo.values()) video.artifact.reportFinished(new _errors.TargetClosedError());
  151. this._idToVideo.clear();
  152. for (const ffPage of this._ffPages.values()) ffPage.didClose();
  153. this._ffPages.clear();
  154. this._didClose();
  155. }
  156. }
  157. exports.FFBrowser = FFBrowser;
  158. class FFBrowserContext extends _browserContext.BrowserContext {
  159. constructor(browser, browserContextId, options) {
  160. super(browser, options, browserContextId);
  161. }
  162. async _initialize() {
  163. (0, _utils.assert)(!this._ffPages().length);
  164. const browserContextId = this._browserContextId;
  165. const promises = [super._initialize()];
  166. if (this._options.acceptDownloads !== 'internal-browser-default') {
  167. promises.push(this._browser.session.send('Browser.setDownloadOptions', {
  168. browserContextId,
  169. downloadOptions: {
  170. behavior: this._options.acceptDownloads === 'accept' ? 'saveToDisk' : 'cancel',
  171. downloadsDir: this._browser.options.downloadsPath
  172. }
  173. }));
  174. }
  175. if (this._options.viewport) {
  176. const viewport = {
  177. viewportSize: {
  178. width: this._options.viewport.width,
  179. height: this._options.viewport.height
  180. },
  181. deviceScaleFactor: this._options.deviceScaleFactor || 1
  182. };
  183. promises.push(this._browser.session.send('Browser.setDefaultViewport', {
  184. browserContextId,
  185. viewport
  186. }));
  187. }
  188. if (this._options.hasTouch) promises.push(this._browser.session.send('Browser.setTouchOverride', {
  189. browserContextId,
  190. hasTouch: true
  191. }));
  192. if (this._options.userAgent) promises.push(this._browser.session.send('Browser.setUserAgentOverride', {
  193. browserContextId,
  194. userAgent: this._options.userAgent
  195. }));
  196. if (this._options.bypassCSP) promises.push(this._browser.session.send('Browser.setBypassCSP', {
  197. browserContextId,
  198. bypassCSP: true
  199. }));
  200. if (this._options.ignoreHTTPSErrors) promises.push(this._browser.session.send('Browser.setIgnoreHTTPSErrors', {
  201. browserContextId,
  202. ignoreHTTPSErrors: true
  203. }));
  204. if (this._options.javaScriptEnabled === false) promises.push(this._browser.session.send('Browser.setJavaScriptDisabled', {
  205. browserContextId,
  206. javaScriptDisabled: true
  207. }));
  208. if (this._options.locale) promises.push(this._browser.session.send('Browser.setLocaleOverride', {
  209. browserContextId,
  210. locale: this._options.locale
  211. }));
  212. if (this._options.timezoneId) promises.push(this._browser.session.send('Browser.setTimezoneOverride', {
  213. browserContextId,
  214. timezoneId: this._options.timezoneId
  215. }));
  216. if (this._options.extraHTTPHeaders || this._options.locale) promises.push(this.setExtraHTTPHeaders(this._options.extraHTTPHeaders || []));
  217. if (this._options.httpCredentials) promises.push(this.setHTTPCredentials(this._options.httpCredentials));
  218. if (this._options.geolocation) promises.push(this.setGeolocation(this._options.geolocation));
  219. if (this._options.offline) promises.push(this.setOffline(this._options.offline));
  220. if (this._options.colorScheme !== 'no-override') {
  221. promises.push(this._browser.session.send('Browser.setColorScheme', {
  222. browserContextId,
  223. colorScheme: this._options.colorScheme !== undefined ? this._options.colorScheme : 'light'
  224. }));
  225. }
  226. if (this._options.reducedMotion !== 'no-override') {
  227. promises.push(this._browser.session.send('Browser.setReducedMotion', {
  228. browserContextId,
  229. reducedMotion: this._options.reducedMotion !== undefined ? this._options.reducedMotion : 'no-preference'
  230. }));
  231. }
  232. if (this._options.forcedColors !== 'no-override') {
  233. promises.push(this._browser.session.send('Browser.setForcedColors', {
  234. browserContextId,
  235. forcedColors: this._options.forcedColors !== undefined ? this._options.forcedColors : 'none'
  236. }));
  237. }
  238. if (this._options.recordVideo) {
  239. promises.push(this._ensureVideosPath().then(() => {
  240. return this._browser.session.send('Browser.setVideoRecordingOptions', {
  241. // validateBrowserContextOptions ensures correct video size.
  242. options: {
  243. ...this._options.recordVideo.size,
  244. dir: this._options.recordVideo.dir
  245. },
  246. browserContextId: this._browserContextId
  247. });
  248. }));
  249. }
  250. if (this._options.proxy) {
  251. promises.push(this._browser.session.send('Browser.setContextProxy', {
  252. browserContextId: this._browserContextId,
  253. ...toJugglerProxyOptions(this._options.proxy)
  254. }));
  255. }
  256. await Promise.all(promises);
  257. }
  258. _ffPages() {
  259. return Array.from(this._browser._ffPages.values()).filter(ffPage => ffPage._browserContext === this);
  260. }
  261. pages() {
  262. return this._ffPages().map(ffPage => ffPage._initializedPage).filter(pageOrNull => !!pageOrNull);
  263. }
  264. async newPageDelegate() {
  265. (0, _browserContext.assertBrowserContextIsNotOwned)(this);
  266. const {
  267. targetId
  268. } = await this._browser.session.send('Browser.newPage', {
  269. browserContextId: this._browserContextId
  270. }).catch(e => {
  271. if (e.message.includes('Failed to override timezone')) throw new Error(`Invalid timezone ID: ${this._options.timezoneId}`);
  272. throw e;
  273. });
  274. return this._browser._ffPages.get(targetId);
  275. }
  276. async doGetCookies(urls) {
  277. const {
  278. cookies
  279. } = await this._browser.session.send('Browser.getCookies', {
  280. browserContextId: this._browserContextId
  281. });
  282. return network.filterCookies(cookies.map(c => {
  283. const copy = {
  284. ...c
  285. };
  286. delete copy.size;
  287. delete copy.session;
  288. return copy;
  289. }), urls);
  290. }
  291. async addCookies(cookies) {
  292. const cc = network.rewriteCookies(cookies).map(c => ({
  293. ...c,
  294. expires: c.expires === -1 ? undefined : c.expires
  295. }));
  296. await this._browser.session.send('Browser.setCookies', {
  297. browserContextId: this._browserContextId,
  298. cookies: cc
  299. });
  300. }
  301. async clearCookies() {
  302. await this._browser.session.send('Browser.clearCookies', {
  303. browserContextId: this._browserContextId
  304. });
  305. }
  306. async doGrantPermissions(origin, permissions) {
  307. const webPermissionToProtocol = new Map([['geolocation', 'geo'], ['persistent-storage', 'persistent-storage'], ['push', 'push'], ['notifications', 'desktop-notification']]);
  308. const filtered = permissions.map(permission => {
  309. const protocolPermission = webPermissionToProtocol.get(permission);
  310. if (!protocolPermission) throw new Error('Unknown permission: ' + permission);
  311. return protocolPermission;
  312. });
  313. await this._browser.session.send('Browser.grantPermissions', {
  314. origin: origin,
  315. browserContextId: this._browserContextId,
  316. permissions: filtered
  317. });
  318. }
  319. async doClearPermissions() {
  320. await this._browser.session.send('Browser.resetPermissions', {
  321. browserContextId: this._browserContextId
  322. });
  323. }
  324. async setGeolocation(geolocation) {
  325. (0, _browserContext.verifyGeolocation)(geolocation);
  326. this._options.geolocation = geolocation;
  327. await this._browser.session.send('Browser.setGeolocationOverride', {
  328. browserContextId: this._browserContextId,
  329. geolocation: geolocation || null
  330. });
  331. }
  332. async setExtraHTTPHeaders(headers) {
  333. this._options.extraHTTPHeaders = headers;
  334. let allHeaders = this._options.extraHTTPHeaders;
  335. if (this._options.locale) allHeaders = network.mergeHeaders([allHeaders, network.singleHeader('Accept-Language', this._options.locale)]);
  336. await this._browser.session.send('Browser.setExtraHTTPHeaders', {
  337. browserContextId: this._browserContextId,
  338. headers: allHeaders
  339. });
  340. }
  341. async setUserAgent(userAgent) {
  342. await this._browser.session.send('Browser.setUserAgentOverride', {
  343. browserContextId: this._browserContextId,
  344. userAgent: userAgent || null
  345. });
  346. }
  347. async setOffline(offline) {
  348. this._options.offline = offline;
  349. await this._browser.session.send('Browser.setOnlineOverride', {
  350. browserContextId: this._browserContextId,
  351. override: offline ? 'offline' : 'online'
  352. });
  353. }
  354. async doSetHTTPCredentials(httpCredentials) {
  355. this._options.httpCredentials = httpCredentials;
  356. await this._browser.session.send('Browser.setHTTPCredentials', {
  357. browserContextId: this._browserContextId,
  358. credentials: httpCredentials || null
  359. });
  360. }
  361. async doAddInitScript(source) {
  362. await this._browser.session.send('Browser.setInitScripts', {
  363. browserContextId: this._browserContextId,
  364. scripts: this.initScripts.map(script => ({
  365. script
  366. }))
  367. });
  368. }
  369. async doRemoveInitScripts() {
  370. await this._browser.session.send('Browser.setInitScripts', {
  371. browserContextId: this._browserContextId,
  372. scripts: []
  373. });
  374. }
  375. async doExposeBinding(binding) {
  376. await this._browser.session.send('Browser.addBinding', {
  377. browserContextId: this._browserContextId,
  378. name: binding.name,
  379. script: binding.source
  380. });
  381. }
  382. async doRemoveExposedBindings() {
  383. // TODO: implement me.
  384. // This is not a critical problem, what ends up happening is
  385. // an old binding will be restored upon page reload and will point nowhere.
  386. }
  387. async doUpdateRequestInterception() {
  388. await this._browser.session.send('Browser.setRequestInterception', {
  389. browserContextId: this._browserContextId,
  390. enabled: !!this._requestInterceptor
  391. });
  392. }
  393. onClosePersistent() {}
  394. async clearCache() {
  395. // Clearing only the context cache does not work: https://bugzilla.mozilla.org/show_bug.cgi?id=1819147
  396. await this._browser.session.send('Browser.clearCache');
  397. }
  398. async doClose(reason) {
  399. if (!this._browserContextId) {
  400. if (this._options.recordVideo) {
  401. await this._browser.session.send('Browser.setVideoRecordingOptions', {
  402. options: undefined,
  403. browserContextId: this._browserContextId
  404. });
  405. }
  406. // Closing persistent context should close the browser.
  407. await this._browser.close({
  408. reason
  409. });
  410. } else {
  411. await this._browser.session.send('Browser.removeBrowserContext', {
  412. browserContextId: this._browserContextId
  413. });
  414. this._browser._contexts.delete(this._browserContextId);
  415. }
  416. }
  417. async cancelDownload(uuid) {
  418. await this._browser.session.send('Browser.cancelDownload', {
  419. uuid
  420. });
  421. }
  422. }
  423. exports.FFBrowserContext = FFBrowserContext;
  424. function toJugglerProxyOptions(proxy) {
  425. const proxyServer = new URL(proxy.server);
  426. let port = parseInt(proxyServer.port, 10);
  427. let type = 'http';
  428. if (proxyServer.protocol === 'socks5:') type = 'socks';else if (proxyServer.protocol === 'socks4:') type = 'socks4';else if (proxyServer.protocol === 'https:') type = 'https';
  429. if (proxyServer.port === '') {
  430. if (proxyServer.protocol === 'http:') port = 80;else if (proxyServer.protocol === 'https:') port = 443;
  431. }
  432. return {
  433. type,
  434. bypass: proxy.bypass ? proxy.bypass.split(',').map(domain => domain.trim()) : [],
  435. host: proxyServer.hostname,
  436. port,
  437. username: proxy.username,
  438. password: proxy.password
  439. };
  440. }
  441. // Prefs for quick fixes that didn't make it to the build.
  442. // Should all be moved to `playwright.cfg`.
  443. const kBandaidFirefoxUserPrefs = {};