@applitools/eyes.selenium/lib/wrappers/EyesWebElementPromise.js

Applitools Eyes SDK for Selenium WebDriver

'use strict';

const { WebElementPromise } = require('selenium-webdriver');
const { CancellableThenable } = require('selenium-webdriver/lib/promise');

const { EyesWebElement } = require('./EyesWebElement');

/**
 * EyesWebElementPromise is a promise that will be fulfilled with a WebElement.
 * This serves as a forward proxy on WebElement, allowing calls to be scheduled without directly on this instance
 * before the underlying WebElement has been fulfilled. In other words, the following two statements are equivalent:
 *
 *     driver.findElement({id: 'my-button'}).click();
 *     driver.findElement({id: 'my-button'}).then(function(el) {
 *       return el.click();
 *     });
 *
 * @implements {CancellableThenable<!EyesWebElement>}
 * @final
 */
class EyesWebElementPromise extends EyesWebElement {
  /**
   * @param {Logger} logger
   * @param {!EyesWebDriver} driver The parent WebDriver instance for this element.
   * @param {!promise.Thenable<!WebElement>} el A promise that will resolve to the promised element.
   */
  constructor(logger, driver, el) {
    const webElement = new WebElementPromise(driver.getRemoteWebDriver(), el);
    super(logger, driver, webElement);

    /**
     * Cancel operation is only supported if the wrapped thenable is also cancellable.
     * @param {(string|Error)=} optReason
     * @override
     */
    this.cancel = optReason => {
      if (CancellableThenable.isImplementation(el)) {
        // noinspection JSUnresolvedFunction
        /** @type {!CancellableThenable} */ el.cancel(optReason);
      }
    };

    // noinspection JSUnresolvedVariable
    /** @override */
    this.then = el.then.bind(el);

    // noinspection JSUnresolvedVariable
    /** @override */
    this.catch = el.catch.bind(el);

    // For Remote web elements, we can keep the IDs, for Id based lookup (mainly used for Javascript related
    // activities).
    driver._elementsIds.set(el, this);
  }
}

CancellableThenable.addImplementation(EyesWebElementPromise);

exports.EyesWebElementPromise = EyesWebElementPromise;