puppeteer/lib/NavigatorWatcher.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 NetworkManager = require('./NetworkManager');

class NavigatorWatcher {
  /**
   * @param {!Connection} client
   * @param {!NetworkManager} networkManager
   * @param {!Object=} options
   */
  constructor(client, networkManager, options = {}) {
    this._client = client;
    this._networkManager = networkManager;
    this._maxTime = typeof options['maxTime'] === 'number' ? options['maxTime'] : 30000;
    this._idleTime = typeof options['networkIdleTimeout'] === 'number' ? options['networkIdleTimeout'] : 1000;
    this._idleInflight = typeof options['networkIdleInflight'] === 'number' ? options['networkIdleInflight'] : 2;
    this._waitUntil = typeof options['waitUntil'] === 'string' ? options['waitUntil'] : 'load';
    console.assert(this._waitUntil === 'load' || this._waitUntil === 'networkidle', 'Unknown value for options.waitUntil: ' + this._waitUntil);
  }


  /**
   * @return {!Promise<!Map<string, !Response>>}
   */
  async waitForNavigation() {
    this._init();

    let certificateError = new Promise(fulfill => this._client.once('Security.certificateError', fulfill))
        .then(error => new Error('SSL Certiciate error: ' + error.errorType));
    let networkIdle = new Promise(fulfill => this._networkIdleCallback = fulfill).then(() => null);
    let loadEventFired = new Promise(fulfill => this._client.once('Page.loadEventFired', fulfill)).then(() => null);
    let watchdog = new Promise(fulfill => this._maximumTimer = setTimeout(fulfill, this._maxTime)).then(() => new Error('Navigation Timeout Exceeded: ' + this._maxTime + 'ms exceeded'));

    try {
      // Await for the command to throw exception in case of illegal arguments.
      const error = await Promise.race([certificateError, watchdog, this._waitUntil === 'load' ? loadEventFired : networkIdle]);
      if (error)
        throw error;
      return this._responses;
    } finally {
      this._cleanup();
    }
  }

  cancel() {
    this._cleanup();
  }

  /**
   * @param {!Object} event
   */
  _onLoadingStarted(event) {
    this._requestIds.add(event.requestId);
    if (!event.redirectResponse)
      ++this._inflightRequests;
    if (this._inflightRequests > this._idleInflight) {
      clearTimeout(this._idleTimer);
      this._idleTimer = null;
    }
  }

  /**
   * @param {!Object} event
   */
  _onLoadingCompleted(event) {
    if (!this._requestIds.has(event.requestId))
      return;

    --this._inflightRequests;
    if (this._inflightRequests <= this._idleInflight && !this._idleTimer)
      this._idleTimer = setTimeout(this._networkIdleCallback, this._idleTime);
  }

  _init() {
    this._loadingStartedHandler = this._onLoadingStarted.bind(this);
    this._loadingCompletedHandler = this._onLoadingCompleted.bind(this);
    this._onResponseHandler = this._onResponse.bind(this);
    this._client.on('Network.requestWillBeSent', this._loadingStartedHandler);
    this._client.on('Network.loadingFinished', this._loadingCompletedHandler);
    this._client.on('Network.loadingFailed', this._loadingCompletedHandler);
    this._client.on('Network.webSocketCreated', this._loadingStartedHandler);
    this._client.on('Network.webSocketClosed', this._loadingCompletedHandler);
    this._networkManager.on(NetworkManager.Events.Response, this._onResponseHandler);

    this._inflightRequests = 0;
    this._requestIds = new Set();
    /** @type {!Map<string, !Response>} */
    this._responses = new Map();
  }

  _cleanup() {
    this._client.removeListener('Network.requestWillBeSent', this._loadingStartedHandler);
    this._client.removeListener('Network.loadingFinished', this._loadingCompletedHandler);
    this._client.removeListener('Network.loadingFailed', this._loadingCompletedHandler);
    this._client.removeListener('Network.webSocketCreated', this._loadingStartedHandler);
    this._client.removeListener('Network.webSocketClosed', this._loadingCompletedHandler);
    this._networkManager.removeListener(NetworkManager.Events.Response, this._onResponseHandler);

    clearTimeout(this._idleTimer);
    clearTimeout(this._maximumTimer);
    this._responses = new Map();
  }

  /**
   * @param {!Response} response
   */
  _onResponse(response) {
    this._responses.set(response.url, response);
  }
}

module.exports = NavigatorWatcher;