lib/browser.ts

import {BPClient} from 'blocking-proxy';
import {By, Navigation, WebDriver, WebElement, WebElementPromise} from 'selenium-webdriver';
import {Command, ICommandName} from 'selenium-webdriver/lib/command';
import * as url from 'url';

const CommandName = require('selenium-webdriver/lib/command').Name as ICommandName;

import {build$, build$$, ElementArrayFinder, ElementFinder} from './element';
import {IError} from './exitCodes';
import {ProtractorExpectedConditions} from './expectedConditions';
import {Locator, ProtractorBy} from './locators';
import {Logger} from './logger';
import {Plugins} from './plugins';

const clientSideScripts = require('./clientsidescripts');

// jshint browser: true

const DEFER_LABEL = 'NG_DEFER_BOOTSTRAP!';
const DEFAULT_RESET_URL = 'data:text/html,<html></html>';
const DEFAULT_GET_PAGE_TIMEOUT = 10000;

let logger = new Logger('browser');

// TODO(cnishina): either remove for loop entirely since this does not export anything
// the user might need since everything is composed (with caveat that this could be a
// potential breaking change) or export the types with `export * from 'selenium-webdriver'`;
/*
 * Mix in other webdriver functionality to be accessible via protractor.
 */
for (let foo in require('selenium-webdriver')) {
  exports[foo] = require('selenium-webdriver')[foo];
}

/**
 * Mix a function from one object onto another. The function will still be
 * called in the context of the original object.  Any arguments of type
 * `ElementFinder` will be unwrapped to their underlying `WebElement` instance
 *
 * @private
 * @param {Object} to
 * @param {Object} from
 * @param {string} fnName
 * @param {function=} setupFn
 */
function ptorMixin(to: any, from: any, fnName: string, setupFn?: Function) {
  to[fnName] = function() {
    const args = arguments;
    for (let i = 0; i < args.length; i++) {
      if (args[i] instanceof ElementFinder) {
        args[i] = args[i].getWebElement();
      }
    }
    const run = () => {
      return from[fnName].apply(from, args);
    };
    if (setupFn) {
      const setupResult = setupFn();
      if (setupResult && (typeof setupResult.then === 'function')) {
        return setupResult.then(run);
      }
    }
    return run();
  };
}

export interface ElementHelper extends Function {
  (locator: Locator): ElementFinder;
  all: (locator: Locator) => ElementArrayFinder;
}

/**
 * Build the helper 'element' function for a given instance of Browser.
 *
 * @private
 * @param {Browser} browser A browser instance.
 * @returns {function(webdriver.Locator): ElementFinder}
 */
function buildElementHelper(browser: ProtractorBrowser): ElementHelper {
  let element = ((locator: Locator) => {
                  return new ElementArrayFinder(browser).all(locator).toElementFinder_();
                }) as ElementHelper;

  element.all = (locator: Locator) => {
    return new ElementArrayFinder(browser).all(locator);
  };

  return element;
}

/**
 * @alias browser
 * @constructor
 * @extends {webdriver_extensions.ExtendedWebDriver}
 * @param {webdriver.WebDriver} webdriver
 * @param {string=} opt_baseUrl A base URL to run get requests against.
 * @param {string|Promise<string>=} opt_rootElement  Selector element that has an
 *     ng-app in scope.
 * @param {boolean=} opt_untrackOutstandingTimeouts Whether Protractor should
 *     stop tracking outstanding $timeouts.
 */
export class ProtractorBrowser {
  /**
   * @type {ProtractorBy}
   */
  static By = new ProtractorBy();

  /**
   * @type {ExpectedConditions}
   */
  ExpectedConditions: ProtractorExpectedConditions;

  /**
   * The browser's WebDriver instance
   *
   * @type {webdriver.WebDriver}
   */
  driver: WebDriver;

  /**
   * The client used to control the BlockingProxy. If unset, BlockingProxy is
   * not being used and Protractor will handle client-side synchronization.
   */
  bpClient: BPClient;

  /**
   * Helper function for finding elements.
   *
   * @type {function(webdriver.Locator): ElementFinder}
   */
  element: ElementHelper;

  /**
   * Shorthand function for finding elements by css.
   *
   * @type {function(string): ElementFinder}
   */
  $: (query: string) => ElementFinder;

  /**
   * Shorthand function for finding arrays of elements by css.
   *
   * @type {function(string): ElementArrayFinder}
   */
  $$: (query: string) => ElementArrayFinder;

  /**
   * All get methods will be resolved against this base URL. Relative URLs are =
   * resolved the way anchor tags resolve.
   *
   * @type {string}
   */
  baseUrl: string;

  /**
   * The css selector for an element on which to find Angular. This is usually
   * 'body' but if your ng-app is on a subsection of the page it may be
   * a subelement.
   *
   * This property is deprecated - please use angularAppRoot() instead.
   *
   * @deprecated
   * @type {string}
   */
  set rootEl(value: string) {
    this.angularAppRoot(value);
  }

  get rootEl() {
    return this.internalRootEl;
  }

  private internalRootEl: string;

  /**
   * Set the css selector for an element on which to find Angular. This is usually
   * 'body' but if your ng-app is on a subsection of the page it may be
   * a subelement.
   *
   * @param {string|Promise<string>} valuePromise The new selector.
   * @returns A promise that resolves with the value of the selector.
   */
  async angularAppRoot(valuePromise: string|Promise<string> = null): Promise<string> {
    if (valuePromise != null) {
      const value = await valuePromise;
      this.internalRootEl = value;
      if (this.bpClient) {
        await this.bpClient.setWaitParams(value);
      }
    }
    return this.internalRootEl;
  }

  /**
   * If true, Protractor will not attempt to synchronize with the page before
   * performing actions. This can be harmful because Protractor will not wait
   * until $timeouts and $http calls have been processed, which can cause
   * tests to become flaky. This should be used only when necessary, such as
   * when a page continuously polls an API using $timeout.
   *
   * Initialized to `false` by the runner.
   *
   * ignoreSynchornization is deprecated.
   *
   * Please use waitForAngularEnabled instead.
   *
   * @deprecated
   * @type {boolean}
   */
  private internalIgnoreSynchronization: boolean;

  /**
   * Timeout in milliseconds to wait for pages to load when calling `get`.
   *
   * @type {number}
   */
  getPageTimeout: number;

  /**
   * An object that holds custom test parameters.
   *
   * @type {Object}
   */
  params: any;

  /**
   * Resolved when the browser is ready for use.  Resolves to the browser, so
   * you can do:
   *
   *   forkedBrowser = await browser.forkNewDriverInstance();
   *
   * Set by the runner.
   *
   * @type {Promise<ProtractorBrowser>}
   */
  ready: Promise<ProtractorBrowser>;

  /*
   * Set by the runner.
   *
   * @type {Plugins} Object containing plugin funtions from config.
   */
  plugins_: Plugins;

  /**
   * The reset URL to use between page loads.
   *
   * @type {string}
   */
  resetUrl: string;

  /**
   * If true, Protractor will track outstanding $timeouts and report them in the
   * error message if Protractor fails to synchronize with Angular in time.
   * @private {boolean}
   */
  trackOutstandingTimeouts_: boolean;

  /*
   * Copy of `config.allScriptsTimeout`.  Used for plugins and nothing else.
   *
   * Set by the runner.
   */
  allScriptsTimeout: number;

  /**
   * Information about mock modules that will be installed during every
   * get().
   *
   * @type {Array<{name: string, script: function|string, args: Array.<string>}>}
   */
  mockModules_: {name: string, script: string|Function, args: any[]}[];

  /**
   * If specified, start a debugger server at specified port instead of repl
   * when running element explorer.
   * @public {number}
   */
  public debuggerServerPort: number;

  /**
   * If true, Protractor will interpret any angular apps it comes across as
   * hybrid angular1/angular2 apps.
   *
   * @type {boolean}
   */
  ng12Hybrid: boolean;

  // This index type allows looking up methods by name so we can do mixins.
  [key: string]: any;

  constructor(
      webdriverInstance: WebDriver, opt_baseUrl?: string, opt_rootElement?: string|Promise<string>,
      opt_untrackOutstandingTimeouts?: boolean, opt_blockingProxyUrl?: string) {
    // These functions should delegate to the webdriver instance, but should
    // wait for Angular to sync up before performing the action. This does not
    // include functions which are overridden by protractor below.
    let methodsToSync = ['getCurrentUrl', 'getPageSource', 'getTitle'];

    // Mix all other driver functionality into Protractor.
    Object.getOwnPropertyNames(WebDriver.prototype).forEach(method => {
      if (!this[method] && typeof(webdriverInstance as any)[method] === 'function') {
        if (methodsToSync.indexOf(method) !== -1) {
          ptorMixin(this, webdriverInstance, method, this.waitForAngular.bind(this));
        } else {
          ptorMixin(this, webdriverInstance, method);
        }
      }
    });

    this.driver = webdriverInstance;
    if (opt_blockingProxyUrl) {
      logger.info('Starting BP client for ' + opt_blockingProxyUrl);
      this.bpClient = new BPClient(opt_blockingProxyUrl);
    }
    this.element = buildElementHelper(this);
    this.$ = build$(this.element, By);
    this.$$ = build$$(this.element, By);
    this.baseUrl = opt_baseUrl || '';
    this.getPageTimeout = DEFAULT_GET_PAGE_TIMEOUT;
    this.params = {};
    this.resetUrl = DEFAULT_RESET_URL;

    let ng12Hybrid_ = false;
    Object.defineProperty(this, 'ng12Hybrid', {
      get: function() {
        return ng12Hybrid_;
      },
      set: function(ng12Hybrid) {
        if (ng12Hybrid) {
          logger.warn(
              'You have set ng12Hybrid.  As of Protractor 4.1.0, ' +
              'Protractor can automatically infer if you are using an ' +
              'ngUpgrade app (as long as ng1 is loaded before you call ' +
              'platformBrowserDynamic()), and this flag is no longer needed ' +
              'for most users');
        }
        ng12Hybrid_ = ng12Hybrid;
      }
    });

    this.trackOutstandingTimeouts_ = !opt_untrackOutstandingTimeouts;
    this.mockModules_ = [];
    this.addBaseMockModules_();

    // set up expected conditions
    this.ExpectedConditions = new ProtractorExpectedConditions(this);
  }

  /**
   * If set to false, Protractor will not wait for Angular $http and $timeout
   * tasks to complete before interacting with the browser. This can cause
   * flaky tests, but should be used if, for instance, your app continuously
   * polls an API with $timeout.
   *
   * Call waitForAngularEnabled() without passing a value to read the current
   * state without changing it.
   */
  async waitForAngularEnabled(enabledPromise: boolean|Promise<boolean> = null): Promise<boolean> {
    if (enabledPromise != null) {
      const enabled = await enabledPromise;
      if (this.bpClient) {
        logger.debug('Setting waitForAngular' + !enabled);
        await this.bpClient.setWaitEnabled(enabled);
      }
      this.internalIgnoreSynchronization = !enabled;
    }
    return !this.internalIgnoreSynchronization;
  }

  /**
   * Get the processed configuration object that is currently being run. This
   * will contain the specs and capabilities properties of the current runner
   * instance.
   *
   * Set by the runner.
   *
   * @returns {Promise} A promise which resolves to the
   * capabilities object.
   */
  getProcessedConfig(): Promise<any> {
    return null;
  }

  /**
   * Fork another instance of browser for use in interactive tests.
   *
   * @example
   * var forked = await browser.forkNewDriverInstance();
   * await forked.get('page1'); // 'page1' gotten by forked browser
   *
   * @param {boolean=} useSameUrl Whether to navigate to current url on creation
   * @param {boolean=} copyMockModules Whether to apply same mock modules on creation
   * @param {boolean=} copyConfigUpdates Whether to copy over changes to `baseUrl` and similar
   *   properties initialized to values in the the config.  Defaults to `true`
   *
   * @returns {ProtractorBrowser} A browser instance.
   */
  async forkNewDriverInstance(
      useSameUrl?: boolean, copyMockModules?: boolean,
      copyConfigUpdates = true): Promise<ProtractorBrowser> {
    return null;
  }

  /**
   * Restart the browser.  This is done by closing this browser instance and creating a new one.
   * A promise resolving to the new instance is returned, and if this function was called on the
   * global `browser` instance then Protractor will automatically overwrite the global `browser`
   * variable.
   *
   * When restarting a forked browser, it is the caller's job to overwrite references to the old
   * instance.
   *
   * Set by the runner.
   *
   * @example
   * // Running against global browser
   * await browser.get('page1');
   * await browser.restart();
   * await browser.get('page2'); // 'page2' gotten by restarted browser
   *
   * // Running against forked browsers
   * var forked = await browser.forkNewDriverInstance();
   * await fork.get('page1');
   * fork = await fork.restart();
   * await fork.get('page2'); // 'page2' gotten by restarted fork
   *
   * // Unexpected behavior can occur if you save references to the global `browser`
   * var savedBrowser = browser;
   * browser.get('foo').then(function() {
   *   console.log(browser === savedBrowser); // false
   * });
   * browser.restart();
   *
   * @returns {Promise<ProtractorBrowser>} A promise resolving to the restarted
   *   browser
   */
  restart(): Promise<ProtractorBrowser> {
    return;
  }

  /**
   * Instead of using a single root element, search through all angular apps
   * available on the page when finding elements or waiting for stability.
   * Only compatible with Angular2.
   */
  useAllAngular2AppRoots() {
    // The empty string is an invalid css selector, so we use it to easily
    // signal to scripts to not find a root element.
    this.angularAppRoot('');
  }

  /**
   * The same as {@code webdriver.WebDriver.prototype.executeScript},
   * but with a customized description for debugging.
   *
   * @private
   * @param {!(string|Function)} script The script to execute.
   * @param {string} description A description of the command for debugging.
   * @param {...*} var_args The arguments to pass to the script.
   * @returns {!Promise<T>} A promise that will resolve to
   * the scripts return value.
   * @template T
   */
  public executeScriptWithDescription(
      script: string|Function, description: string, ...scriptArgs: any[]): Promise<any> {
    if (typeof script === 'function') {
      script = 'return (' + script + ').apply(null, arguments);';
    }

    // TODO(selenium4): schedule does not exist on driver. Should use execute instead.
    return this.driver.execute((new Command(CommandName.EXECUTE_SCRIPT) as Command)
                                   .setParameter('script', script)
                                   .setParameter('args', scriptArgs));
  }

  /**
   * The same as {@code webdriver.WebDriver.prototype.executeAsyncScript},
   * but with a customized description for debugging.
   *
   * @private
   * @param {!(string|Function)} script The script to execute.
   * @param {string} description A description for debugging purposes.
   * @param {...*} var_args The arguments to pass to the script.
   * @returns {!Promise<T>} A promise that will resolve to
   * the
   *    scripts return value.
   * @template T
   */
  private executeAsyncScript_(script: string|Function, description: string, ...scriptArgs: any[]):
      Promise<any> {
    // TODO(selenium4): decide what to do with description.
    if (typeof script === 'function') {
      script = 'return (' + script + ').apply(null, arguments);';
    }
    // TODO(selenium4): fix typings. driver.execute should exist
    return (this.driver as any)
        .execute(new Command(CommandName.EXECUTE_ASYNC_SCRIPT)
                     .setParameter('script', script)
                     .setParameter('args', scriptArgs));
  }

  /**
   * Instruct webdriver to wait until Angular has finished rendering and has
   * no outstanding $http or $timeout calls before continuing.
   * Note that Protractor automatically applies this command before every
   * WebDriver action.
   *
   * @param {string=} opt_description An optional description to be added
   *     to webdriver logs.
   * @returns {!Promise} A promise that will resolve to the
   *    scripts return value.
   */
  async waitForAngular(opt_description?: string): Promise<any> {
    let description = opt_description ? ' - ' + opt_description : '';
    if (!await this.waitForAngularEnabled()) {
      return true;
    }

    let runWaitForAngularScript = async(): Promise<any> => {
      if (this.plugins_.skipAngularStability() || this.bpClient) {
        return null;
      } else {
        let rootEl = await this.angularAppRoot();
        return this.executeAsyncScript_(
            clientSideScripts.waitForAngular, `Protractor.waitForAngular() ${description}`, rootEl);
      }
    };

    try {
      let browserErr = await runWaitForAngularScript();
      if (browserErr) {
        throw new Error(
            'Error while waiting for Protractor to ' +
            'sync with the page: ' + JSON.stringify(browserErr));
      }
      await this.plugins_.waitForPromise(this);

      await this.driver.wait(async () => {
        let results = await this.plugins_.waitForCondition(this);
        return results.reduce((x, y) => x && y, true);
      }, this.allScriptsTimeout, 'Plugins.waitForCondition()');
    } catch (err) {
      let timeout: RegExpExecArray;
      if (/asynchronous script timeout/.test(err.message)) {
        // Timeout on Chrome
        timeout = /-?[\d\.]*\ seconds/.exec(err.message);
      } else if (/Timed out waiting for async script/.test(err.message)) {
        // Timeout on Firefox
        timeout = /-?[\d\.]*ms/.exec(err.message);
      } else if (/Timed out waiting for an asynchronous script/.test(err.message)) {
        // Timeout on Safari
        timeout = /-?[\d\.]*\ ms/.exec(err.message);
      }
      if (timeout) {
        let errMsg = `Timed out waiting for asynchronous Angular tasks to finish after ` +
            `${timeout}. This may be because the current page is not an Angular ` +
            `application. Please see the FAQ for more details: ` +
            `https://github.com/angular/protractor/blob/master/docs/timeouts.md#waiting-for-angular`;
        if (description.indexOf(' - Locator: ') == 0) {
          errMsg += '\nWhile waiting for element with locator' + description;
        }
        let pendingTimeoutsPromise: Promise<any>;
        if (this.trackOutstandingTimeouts_) {
          pendingTimeoutsPromise = this.executeScriptWithDescription(
              'return window.NG_PENDING_TIMEOUTS',
              'Protractor.waitForAngular() - getting pending timeouts' + description);
        } else {
          pendingTimeoutsPromise = Promise.resolve();
        }
        let pendingHttpsPromise = this.executeScriptWithDescription(
            clientSideScripts.getPendingHttpRequests,
            'Protractor.waitForAngular() - getting pending https' + description,
            this.internalRootEl);

        let arr = await Promise.all([pendingTimeoutsPromise, pendingHttpsPromise]);

        let pendingTimeouts = arr[0] || [];
        let pendingHttps = arr[1] || [];

        let key: string, pendingTasks: string[] = [];
        for (key in pendingTimeouts) {
          if (pendingTimeouts.hasOwnProperty(key)) {
            pendingTasks.push(' - $timeout: ' + pendingTimeouts[key]);
          }
        }
        for (key in pendingHttps) {
          pendingTasks.push(' - $http: ' + pendingHttps[key].url);
        }
        if (pendingTasks.length) {
          errMsg += '. \nThe following tasks were pending:\n';
          errMsg += pendingTasks.join('\n');
        }
        err.message = errMsg;
      }
      throw err;
    }
  }

  /**
   * Waits for Angular to finish renderActionSequenceing before searching for elements.
   * @see webdriver.WebDriver.findElement
   * @returns {!webdriver.WebElementPromise} A promise that will be resolved to
   *      the located {@link webdriver.WebElement}.
   */
  findElement(locator: Locator): WebElementPromise {
    return this.element(locator).getWebElement();
  }

  /**
   * Waits for Angular to finish rendering before searching for elements.
   * @see webdriver.WebDriver.findElements
   * @returns {!Promise} A promise that will be resolved to an
   *     array of the located {@link webdriver.WebElement}s.
   */
  findElements(locator: Locator): Promise<WebElement[]> {
    return this.element.all(locator).getWebElements();
  }

  /**
   * Tests if an element is present on the page.
   * @see webdriver.WebDriver.isElementPresent
   * @returns {!Promise} A promise that will resolve to whether
   *     the element is present on the page.
   */
  isElementPresent(locatorOrElement: Locator|WebElement|ElementFinder): Promise<any> {
    let element: ElementFinder;
    if (locatorOrElement instanceof ElementFinder) {
      element = locatorOrElement;
    } else if (locatorOrElement instanceof WebElement) {
      element = ElementFinder.fromWebElement_(this, locatorOrElement);
    } else {
      element = this.element(locatorOrElement);
    }
    return element.isPresent();
  }

  /**
   * Add a module to load before Angular whenever Protractor.get is called.
   * Modules will be registered after existing modules already on the page,
   * so any module registered here will override preexisting modules with the
   * same name.
   *
   * @example
   * browser.addMockModule('modName', function() {
   *   angular.module('modName', []).value('foo', 'bar');
   * });
   *
   * @param {!string} name The name of the module to load or override.
   * @param {!string|Function} script The JavaScript to load the module.
   *     Note that this will be executed in the browser context, so it cannot
   *     access variables from outside its scope.
   * @param {...*} varArgs Any additional arguments will be provided to
   *     the script and may be referenced using the `arguments` object.
   */
  addMockModule(name: string, script: string|Function, ...moduleArgs: any[]) {
    this.mockModules_.push({name: name, script: script, args: moduleArgs});
  }

  /**
   * Clear the list of registered mock modules.
   */
  clearMockModules() {
    this.mockModules_ = [];
    this.addBaseMockModules_();
  }

  /**
   * Remove a registered mock module.
   *
   * @example
   * browser.removeMockModule('modName');
   *
   * @param {!string} name The name of the module to remove.
   */
  removeMockModule(name: string) {
    for (let i = 0; i < this.mockModules_.length; ++i) {
      if (this.mockModules_[i].name == name) {
        this.mockModules_.splice(i--, 1);
      }
    }
  }

  /**
   * Get a list of the current mock modules.
   *
   * @returns {Array.<!string|Function>} The list of mock modules.
   */
  getRegisteredMockModules(): Array<string|Function> {
    return this.mockModules_.map(module => module.script);
  }

  /**
   * Add the base mock modules used for all Protractor tests.
   *
   * @private
   */
  private addBaseMockModules_() {
    this.addMockModule(
        'protractorBaseModule_', clientSideScripts.protractorBaseModuleFn,
        this.trackOutstandingTimeouts_);
  }

  /**
   * @see webdriver.WebDriver.get
   *
   * Navigate to the given destination and loads mock modules before
   * Angular. Assumes that the page being loaded uses Angular.
   * If you need to access a page which does not have Angular on load, use
   * the wrapped webdriver directly.
   *
   * @example
   * await browser.get('https://angularjs.org/');
   * expect(await browser.getCurrentUrl()).toBe('https://angularjs.org/');
   *
   * @param {string} destination Destination URL.
   * @param {number=} opt_timeout Number of milliseconds to wait for Angular to
   *     start.
   */
  async get(destination: string, timeout = this.getPageTimeout) {
    destination = this.baseUrl.indexOf('file://') === 0 ? this.baseUrl + destination :
                                                          url.resolve(this.baseUrl, destination);
    if (!await this.waitForAngularEnabled()) {
      await this.driver.get(destination);
      await this.plugins_.onPageLoad(this);
      return;
    }

    let msg = (str: string) => {
      return 'Protractor.get(' + destination + ') - ' + str;
    };

    if (this.bpClient) {
      await this.bpClient.setWaitEnabled(false);
    }
    // Go to reset url
    await this.driver.get(this.resetUrl);

    // Set defer label and navigate
    await this.executeScriptWithDescription(
        'window.name = "' + DEFER_LABEL + '" + window.name;' +
            'window.location.replace("' + destination + '");',
        msg('reset url'));

    // We need to make sure the new url has loaded before
    // we try to execute any asynchronous scripts.
    await this.driver.wait(() => {
      return this.executeScriptWithDescription('return window.location.href;', msg('get url'))
          .then(
              (url: any) => {
                return url !== this.resetUrl;
              },
              (err: IError) => {
                if (err.code == 13 || err.name === 'JavascriptError') {
                  // Ignore the error, and continue trying. This is
                  // because IE driver sometimes (~1%) will throw an
                  // unknown error from this execution. See
                  // https://github.com/angular/protractor/issues/841
                  // This shouldn't mask errors because it will fail
                  // with the timeout anyway.
                  return false;
                } else {
                  throw err;
                }
              });
    }, timeout, 'waiting for page to load for ' + timeout + 'ms');

    // Run Plugins
    await this.plugins_.onPageLoad(this);

    let angularVersion: number;
    try {
      // Make sure the page is an Angular page.
      const angularTestResult: {ver: number, message: string} = await this.executeAsyncScript_(
          clientSideScripts.testForAngular, msg('test for angular'), Math.floor(timeout / 1000),
          this.ng12Hybrid);
      angularVersion = angularTestResult.ver;

      if (!angularVersion) {
        let message = angularTestResult.message;
        logger.error(`Could not find Angular on page ${destination} : ${message}`);
        throw new Error(
            `Angular could not be found on the page ${destination}. ` +
            `If this is not an Angular application, you may need to turn off waiting for Angular.
            Please see
            https://github.com/angular/protractor/blob/master/docs/timeouts.md#waiting-for-angular-on-page-load`);
      }
    } catch (err) {
      throw new Error('Error while running testForAngular: ' + err.message);
    }

    // Load Angular Mocks
    if (angularVersion === 1) {
      // At this point, Angular will pause for us until angular.resumeBootstrap is called.
      let moduleNames: string[] = [];
      for (const {name, script, args} of this.mockModules_) {
        moduleNames.push(name);
        let executeScriptArgs = [script, msg('add mock module ' + name), ...args];
        await this.executeScriptWithDescription.apply(this, executeScriptArgs)
            .then(null, (err: Error) => {
              throw new Error('Error while running module script ' + name + ': ' + err.message);
            });
      }

      await this.executeScriptWithDescription(
          'window.__TESTABILITY__NG1_APP_ROOT_INJECTOR__ = ' +
              'angular.resumeBootstrap(arguments[0]);',
          msg('resume bootstrap'), moduleNames);
    } else {
      // TODO: support mock modules in Angular2. For now, error if someone
      // has tried to use one.
      if (this.mockModules_.length > 1) {
        throw 'Trying to load mock modules on an Angular v2+ app is not yet supported.';
      }
    }

    // Reset bpClient sync
    if (this.bpClient) {
      await this.bpClient.setWaitEnabled(!this.internalIgnoreSynchronization);
    }

    // Run Plugins
    await this.plugins_.onPageStable(this);
  }

  /**
   * @see webdriver.WebDriver.refresh
   *
   * Makes a full reload of the current page and loads mock modules before
   * Angular. Assumes that the page being loaded uses Angular.
   * If you need to access a page which does not have Angular on load, use
   * the wrapped webdriver directly.
   *
   * @param {number=} opt_timeout Number of milliseconds to wait for Angular to start.
   */
  async refresh(opt_timeout?: number) {
    if (!await this.waitForAngularEnabled()) {
      return this.driver.navigate().refresh();
    }

    const href = await this.executeScriptWithDescription(
        'return window.location.href', 'Protractor.refresh() - getUrl');
    return this.get(href, opt_timeout);
  }

  /**
   * Mixin navigation methods back into the navigation object so that
   * they are invoked as before, i.e. driver.navigate().refresh()
   */
  navigate(): Navigation {
    let nav = this.driver.navigate();
    ptorMixin(nav, this, 'refresh');
    return nav;
  }

  /**
   * Browse to another page using in-page navigation.
   *
   * @example
   * await browser.get('http://angular.github.io/protractor/#/tutorial');
   * await browser.setLocation('api');
   * expect(await browser.getCurrentUrl())
   *     .toBe('http://angular.g../../ithub.io/protractor/#/api');
   *
   * @param {string} url In page URL using the same syntax as $location.url()
   * @returns {!Promise} A promise that will resolve once
   *    page has been changed.
   */
  async setLocation(url: string): Promise<any> {
    await this.waitForAngular();
    const rootEl = await this.angularAppRoot();
    const browserErr = await this.executeScriptWithDescription(
        clientSideScripts.setLocation, 'Protractor.setLocation()', rootEl, url);
    if (browserErr) {
      throw 'Error while navigating to \'' + url + '\' : ' + JSON.stringify(browserErr);
    }
  }

  /**
   * Deprecated, use `browser.getCurrentUrl()` instead.
   *
   * Despite its name, this function will generally return `$location.url()`, though in some
   * cases it will return `$location.absUrl()` instead.  This function is only here for legacy
   * users, and will probably be removed in Protractor 6.0.
   *
   * @deprecated Please use `browser.getCurrentUrl()`
   * @example
   * await browser.get('http://angular.github.io/protractor/#/api');
   * expect(await browser.getLocationAbsUrl())
   *     .toBe('http://angular.github.io/protractor/#/api');
   * @returns {Promise<string>} The current absolute url from
   * AngularJS.
   */
  async getLocationAbsUrl(): Promise<any> {
    logger.warn(
        '`browser.getLocationAbsUrl()` is deprecated, please use `browser.getCurrentUrl` instead.');
    await this.waitForAngular();
    const rootEl = await this.angularAppRoot();
    return await this.executeScriptWithDescription(
        clientSideScripts.getLocationAbsUrl, 'Protractor.getLocationAbsUrl()', rootEl);
  }
}