puppeteer/packages/puppeteer-core/src/node/PuppeteerNode.ts

/**
 * Copyright 2020 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.
 */

import {Browser} from '../api/Browser.js';
import {BrowserConnectOptions} from '../common/BrowserConnector.js';
import {Product} from '../common/Product.js';
import {
  CommonPuppeteerSettings,
  ConnectOptions,
  Puppeteer,
} from '../common/Puppeteer.js';
import {PUPPETEER_REVISIONS} from '../revisions.js';
import {BrowserFetcher, BrowserFetcherOptions} from './BrowserFetcher.js';
import {BrowserLaunchArgumentOptions, LaunchOptions} from './LaunchOptions.js';
import {createLauncher, ProductLauncher} from './ProductLauncher.js';

/**
 * @public
 */
export interface PuppeteerLaunchOptions
  extends LaunchOptions,
    BrowserLaunchArgumentOptions,
    BrowserConnectOptions {
  product?: Product;
  extraPrefsFirefox?: Record<string, unknown>;
}

/**
 * Extends the main {@link Puppeteer} class with Node specific behaviour for
 * fetching and downloading browsers.
 *
 * If you're using Puppeteer in a Node environment, this is the class you'll get
 * when you run `require('puppeteer')` (or the equivalent ES `import`).
 *
 * @remarks
 * The most common method to use is {@link PuppeteerNode.launch | launch}, which
 * is used to launch and connect to a new browser instance.
 *
 * See {@link Puppeteer | the main Puppeteer class} for methods common to all
 * environments, such as {@link Puppeteer.connect}.
 *
 * @example
 * The following is a typical example of using Puppeteer to drive automation:
 *
 * ```ts
 * const puppeteer = require('puppeteer');
 *
 * (async () => {
 *   const browser = await puppeteer.launch();
 *   const page = await browser.newPage();
 *   await page.goto('https://www.google.com');
 *   // other actions...
 *   await browser.close();
 * })();
 * ```
 *
 * Once you have created a `page` you have access to a large API to interact
 * with the page, navigate, or find certain elements in that page.
 * The {@link Page | `page` documentation} lists all the available methods.
 *
 * @public
 */
export class PuppeteerNode extends Puppeteer {
  #launcher?: ProductLauncher;
  #projectRoot?: string;
  #productName?: Product;

  /**
   * @internal
   */
  _preferredRevision = PUPPETEER_REVISIONS.chromium;

  /**
   * @internal
   */
  constructor(
    settings: {
      projectRoot?: string;
      preferredRevision?: string;
      productName?: Product;
    } & CommonPuppeteerSettings
  ) {
    const {projectRoot, preferredRevision, productName, ...commonSettings} =
      settings;
    super(commonSettings);
    this.#projectRoot = projectRoot;
    this.#productName = productName;
    if (preferredRevision) {
      this._preferredRevision = preferredRevision;
    }

    this.connect = this.connect.bind(this);
    this.launch = this.launch.bind(this);
    this.executablePath = this.executablePath.bind(this);
    this.defaultArgs = this.defaultArgs.bind(this);
    this.createBrowserFetcher = this.createBrowserFetcher.bind(this);
  }

  /**
   * This method attaches Puppeteer to an existing browser instance.
   *
   * @param options - Set of configurable options to set on the browser.
   * @returns Promise which resolves to browser instance.
   */
  override connect(options: ConnectOptions): Promise<Browser> {
    return super.connect(options);
  }

  /**
   * @internal
   */
  get _productName(): Product | undefined {
    return this.#productName;
  }
  set _productName(name: Product | undefined) {
    if (this.#productName !== name) {
      this._changedProduct = true;
    }
    this.#productName = name;
  }

  /**
   * Launches puppeteer and launches a browser instance with given arguments and
   * options when specified.
   *
   * @example
   * You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
   *
   * ```ts
   * const browser = await puppeteer.launch({
   *   ignoreDefaultArgs: ['--mute-audio'],
   * });
   * ```
   *
   * @remarks
   * **NOTE** Puppeteer can also be used to control the Chrome browser, but it
   * works best with the version of Chromium it is bundled with. There is no
   * guarantee it will work with any other version. Use `executablePath` option
   * with extreme caution. If Google Chrome (rather than Chromium) is preferred,
   * a {@link https://www.google.com/chrome/browser/canary.html | Chrome Canary}
   * or
   * {@link https://www.chromium.org/getting-involved/dev-channel | Dev Channel}
   * build is suggested. In `puppeteer.launch([options])`, any mention of
   * Chromium also applies to Chrome. See
   * {@link https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/ | this article}
   * for a description of the differences between Chromium and Chrome.
   * {@link https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md | This article}
   * describes some differences for Linux users.
   *
   * @param options - Set of configurable options to set on the browser.
   * @returns Promise which resolves to browser instance.
   */
  launch(options: PuppeteerLaunchOptions = {}): Promise<Browser> {
    if (options.product) {
      this._productName = options.product;
    }
    return this._launcher.launch(options);
  }

  /**
   * @remarks
   * **NOTE** `puppeteer.executablePath()` is affected by the
   * `PUPPETEER_EXECUTABLE_PATH` and `PUPPETEER_CHROMIUM_REVISION` environment
   * variables.
   *
   * @returns A path where Puppeteer expects to find the bundled browser. The
   * browser binary might not be there if the download was skipped with the
   * `PUPPETEER_SKIP_DOWNLOAD` environment variable.
   */
  executablePath(channel?: string): string {
    return this._launcher.executablePath(channel);
  }

  /**
   * @internal
   */
  get _launcher(): ProductLauncher {
    if (
      !this.#launcher ||
      this.#launcher.product !== this._productName ||
      this._changedProduct
    ) {
      switch (this._productName) {
        case 'firefox':
          this._preferredRevision = PUPPETEER_REVISIONS.firefox;
          break;
        case 'chrome':
        default:
          this._preferredRevision = PUPPETEER_REVISIONS.chromium;
      }
      this._changedProduct = false;
      this.#launcher = createLauncher(
        this.#projectRoot,
        this._preferredRevision,
        this._isPuppeteerCore,
        this._productName
      );
    }
    return this.#launcher;
  }

  /**
   * The name of the browser that is under automation (`"chrome"` or
   * `"firefox"`)
   *
   * @remarks
   * The product is set by the `PUPPETEER_PRODUCT` environment variable or the
   * `product` option in `puppeteer.launch([options])` and defaults to `chrome`.
   * Firefox support is experimental.
   */
  get product(): string {
    return this._launcher.product;
  }

  /**
   * @param options - Set of configurable options to set on the browser.
   * @returns The default flags that Chromium will be launched with.
   */
  defaultArgs(options: BrowserLaunchArgumentOptions = {}): string[] {
    return this._launcher.defaultArgs(options);
  }

  /**
   * @param options - Set of configurable options to specify the settings of the
   * BrowserFetcher.
   * @returns A new BrowserFetcher instance.
   */
  createBrowserFetcher(options: BrowserFetcherOptions): BrowserFetcher {
    if (!this.#projectRoot) {
      throw new Error(
        '_projectRoot is undefined. Unable to create a BrowserFetcher.'
      );
    }
    return new BrowserFetcher(this.#projectRoot, options);
  }
}