Puppeteer.js

/**
 * Copyright 2017 Google Inc. All rights reserved.
 *
 * 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.
 */
const Launcher = require('./Launcher');
const {BrowserFetcher} = require('./BrowserFetcher');
const Errors = require('./Errors');
const DeviceDescriptors = require('./DeviceDescriptors');
// Import used as typedef
// eslint-disable-next-line no-unused-vars
const {Browser} = require('./Browser');
const QueryHandler = require('./QueryHandler');

module.exports = class {
  /**
   * @param {string} projectRoot
   * @param {string} preferredRevision
   * @param {boolean} isPuppeteerCore
   * @param {string} productName
   */
  constructor(projectRoot, preferredRevision, isPuppeteerCore, productName) {
    this._projectRoot = projectRoot;
    this._preferredRevision = preferredRevision;
    this._isPuppeteerCore = isPuppeteerCore;
    // track changes to Launcher configuration via options or environment variables
    this.__productName = productName;
  }

  /**
   * @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions & {product?: string, extraPrefsFirefox?: !object})=} options
   * @return {!Promise<!Browser>}
   */
  launch(options = {}) {
    if (options.product)
      this._productName = options.product;
    return this._launcher.launch(options);
  }

  /**
   * @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport}) & {product?: string}=} options
   * @return {!Promise<!Browser>}
   */
  connect(options) {
    if (options.product)
      this._productName = options.product;
    return this._launcher.connect(options);
  }

  /**
   * @param {string} name
   */
  set _productName(name) {
    if (this.__productName !== name)
      this._changedProduct = true;
    this.__productName = name;
  }

  /**
   * @return {string}
   */
  get _productName() {
    return this.__productName;
  }

  /**
   * @return {string}
   */
  executablePath() {
    return this._launcher.executablePath();
  }

  /**
   * @return {!Puppeteer.ProductLauncher}
   */
  get _launcher() {
    if (!this._lazyLauncher || this._lazyLauncher.product !== this._productName || this._changedProduct) {
      // @ts-ignore
      const packageJson = require('../package.json');
      switch (this._productName) {
        case 'firefox':
          this._preferredRevision = packageJson.puppeteer.firefox_revision;
          break;
        case 'chrome':
        default:
          this._preferredRevision = packageJson.puppeteer.chromium_revision;
      }
      this._changedProduct = false;
      this._lazyLauncher = Launcher(this._projectRoot, this._preferredRevision, this._isPuppeteerCore, this._productName);
    }
    return this._lazyLauncher;
  }

  /**
   * @return {string}
   */
  get product() {
    return this._launcher.product;
  }

  /**
   * @return {Object}
   */
  get devices() {
    return DeviceDescriptors;
  }

  /**
   * @return {Object}
   */
  get errors() {
    return Errors;
  }

  /**
   * @param {!Launcher.ChromeArgOptions=} options
   * @return {!Array<string>}
   */
  defaultArgs(options) {
    return this._launcher.defaultArgs(options);
  }

  /** TODO(jacktfranklin@): Once this file is TS we can type this
  * using the BrowserFectcherOptions interface.
  */

  /**
  * @typedef {Object} BrowserFetcherOptions
  * @property {('linux'|'mac'|'win32'|'win64')=} platform
  * @property {('chrome'|'firefox')=} product
  * @property {string=} path
  * @property {string=} host
  */
  /**
   * @param {!BrowserFetcherOptions} options
   * @return {!BrowserFetcher}
   */
  createBrowserFetcher(options) {
    return new BrowserFetcher(this._projectRoot, options);
  }

  /**
   * @param {string} name
   * @param {!Function} queryHandler
   */
  __experimental_registerCustomQueryHandler(name, queryHandler) {
    QueryHandler.registerCustomQueryHandler(name, queryHandler);
  }

  /**
   * @param {string} name
   */
  __experimental_unregisterCustomQueryHandler(name) {
    QueryHandler.unregisterCustomQueryHandler(name);
  }

  __experimental_customQueryHandlers() {
    return QueryHandler.customQueryHandlers();
  }

  __experimental_clearQueryHandlers() {
    QueryHandler.clearQueryHandlers();
  }
};