@applitools/eyes-testcafe 2.0.0-beta.9 → 2.0.0

package/lib/positioning/ElementPositionProvider.js

@@ -1,88 +0,0 @@
-'use strict'
-
-const {ArgumentGuard, Location} = require('@applitools/eyes-common')
-const {PositionProvider} = require('@applitools/eyes-sdk-core')
-
-const {ElementPositionMemento} = require('./ElementPositionMemento')
-const {EyesWebElement} = require('../wrappers/EyesWebElement')
-
-class ElementPositionProvider extends PositionProvider {
-  /**
-   * @param {Logger} logger
-   * @param {EyesWebDriver} driver
-   * @param {EyesWebElement} element
-   */
-  constructor(logger, driver, element) {
-    super()
-
-    ArgumentGuard.notNull(logger, 'logger')
-    ArgumentGuard.notNull(driver, 'driver')
-    ArgumentGuard.notNull(element, 'element')
-
-    this._logger = logger
-    this._element =
-      element instanceof EyesWebElement ? element : new EyesWebElement(logger, driver, element)
-
-    this._logger.verbose('creating ElementPositionProvider')
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async getCurrentPosition() {
-    this._logger.verbose('getCurrentScrollPosition()')
-    const location = await this._element.getScrollLocation()
-    this._logger.verbose('Current position:', location)
-    return location
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async setPosition(location) {
-    this._logger.verbose('Scrolling element to:', location)
-    const result = await this._element.scrollTo(location)
-    this._logger.verbose('Done scrolling element! result:', result)
-    return result
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async getEntireSize() {
-    this._logger.verbose('enter')
-    const scrollSize = await this._element.getScrollSize()
-    this._logger.verbose('Entire size:', scrollSize)
-    return scrollSize
-  }
-
-  /**
-   * @inheritDoc
-   * @return {Promise<ElementPositionMemento>}
-   */
-  async getState() {
-    const position = await this.getCurrentPosition()
-    return new ElementPositionMemento(position)
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {ElementPositionMemento} state - The initial state of position
-   * @return {Promise}
-   */
-  async restoreState(state) {
-    const newLocation = new Location(state.getX(), state.getY())
-    await this.setPosition(newLocation)
-    this._logger.verbose('Position restored.')
-  }
-
-  /**
-   * @return {WebElement}
-   */
-  getScrolledElement() {
-    return this._element
-  }
-}
-
-exports.ElementPositionProvider = ElementPositionProvider

package/lib/positioning/FirefoxRegionPositionCompensation.js

@@ -1,45 +0,0 @@
-'use strict'
-
-const {Region} = require('@applitools/eyes-common')
-const {RegionPositionCompensation} = require('@applitools/eyes-sdk-core')
-
-/**
- * @ignore
- */
-class FirefoxRegionPositionCompensation extends RegionPositionCompensation {
-  /**
-   * @param {Eyes} eyes
-   * @param {Logger} logger
-   */
-  constructor(eyes, logger) {
-    super()
-
-    this._eyes = eyes
-    this._logger = logger
-  }
-
-  /**
-   * @inheritDoc
-   */
-  compensateRegionPosition(region, pixelRatio) {
-    if (pixelRatio === 1) {
-      return region
-    }
-
-    const eyesWebDriver = this._eyes.getDriver()
-    const frameChain = eyesWebDriver.getFrameChain()
-    if (frameChain.size() > 0) {
-      return region
-    }
-
-    region = region.offset(0, -Math.ceil(pixelRatio / 2))
-
-    if (region.getWidth() <= 0 || region.getHeight() <= 0) {
-      return Region.EMPTY
-    }
-
-    return region
-  }
-}
-
-exports.FirefoxRegionPositionCompensation = FirefoxRegionPositionCompensation

package/lib/positioning/ImageRotation.js

@@ -1,22 +0,0 @@
-'use strict'
-
-/**
- * Encapsulates rotation data for images.
- */
-class ImageRotation {
-  /**
-   * @param {number} rotation - The degrees by which to rotate.
-   */
-  constructor(rotation) {
-    this._rotation = rotation
-  }
-
-  /**
-   * @return {number} - The degrees by which to rotate.
-   */
-  getRotation() {
-    return this._rotation
-  }
-}
-
-exports.ImageRotation = ImageRotation

package/lib/positioning/OverflowAwareCssTranslatePositionProvider.js

@@ -1,17 +0,0 @@
-'use strict'
-
-const {CssTranslatePositionProvider} = require('./CssTranslatePositionProvider')
-const {EyesTestcafeUtils} = require('../EyesTestcafeUtils')
-
-class OverflowAwareCssTranslatePositionProvider extends CssTranslatePositionProvider {
-  /**
-   * @inheritDoc
-   */
-  async getEntireSize() {
-    const result = await EyesTestcafeUtils.getOverflowAwareContentEntireSize(this._executor)
-    this._logger.verbose(`OverflowAwareCssTranslatePositionProvider - Entire size: ${result}`)
-    return result
-  }
-}
-
-exports.OverflowAwareCssTranslatePositionProvider = OverflowAwareCssTranslatePositionProvider

package/lib/positioning/OverflowAwareScrollPositionProvider.js

@@ -1,17 +0,0 @@
-'use strict'
-
-const {ScrollPositionProvider} = require('./ScrollPositionProvider')
-const {EyesTestcafeUtils} = require('../EyesTestcafeUtils')
-
-class OverflowAwareScrollPositionProvider extends ScrollPositionProvider {
-  /**
-   * @inheritDoc
-   */
-  async getEntireSize() {
-    const result = await EyesTestcafeUtils.getOverflowAwareContentEntireSize(this._executor)
-    this._logger.verbose(`OverflowAwareScrollPositionProvider - Entire size: ${result}`)
-    return result
-  }
-}
-
-exports.OverflowAwareScrollPositionProvider = OverflowAwareScrollPositionProvider

package/lib/positioning/RegionPositionCompensationFactory.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const {BrowserNames} = require('@applitools/eyes-common')
-const {NullRegionPositionCompensation} = require('@applitools/eyes-sdk-core')
-
-const {FirefoxRegionPositionCompensation} = require('./FirefoxRegionPositionCompensation')
-const {SafariRegionPositionCompensation} = require('./SafariRegionPositionCompensation')
-
-/**
- * @ignore
- */
-class RegionPositionCompensationFactory {
-  /**
-   * @param {UserAgent} userAgent
-   * @param {Eyes} eyes
-   * @param {Logger} logger
-   * @return {RegionPositionCompensation}
-   */
-  static getRegionPositionCompensation(userAgent, eyes, logger) {
-    if (userAgent) {
-      if (userAgent.getBrowser() === BrowserNames.Firefox) {
-        try {
-          if (parseInt(userAgent.getBrowserMajorVersion(), 10) >= 48) {
-            return new FirefoxRegionPositionCompensation(eyes, logger)
-          }
-        } catch (ignore) {
-          return new NullRegionPositionCompensation()
-        }
-      } else if (userAgent.getBrowser() === BrowserNames.Safari) {
-        return new SafariRegionPositionCompensation()
-      }
-    }
-    return new NullRegionPositionCompensation()
-  }
-}
-
-exports.RegionPositionCompensationFactory = RegionPositionCompensationFactory

package/lib/positioning/SafariRegionPositionCompensation.js

@@ -1,26 +0,0 @@
-'use strict'
-
-const {Region} = require('@applitools/eyes-common')
-const {RegionPositionCompensation} = require('@applitools/eyes-sdk-core')
-
-/**
- * @ignore
- */
-class SafariRegionPositionCompensation extends RegionPositionCompensation {
-  /**
-   * @inheritDoc
-   */
-  compensateRegionPosition(region, pixelRatio) {
-    if (pixelRatio === 1) {
-      return region
-    }
-
-    if (region.getWidth() <= 0 || region.getHeight() <= 0) {
-      return Region.EMPTY
-    }
-
-    return region.offset(0, Math.ceil(pixelRatio))
-  }
-}
-
-exports.SafariRegionPositionCompensation = SafariRegionPositionCompensation

package/lib/positioning/ScrollPositionMemento.js

@@ -1,36 +0,0 @@
-'use strict'
-
-const {Location} = require('@applitools/eyes-common')
-const {PositionMemento} = require('@applitools/eyes-sdk-core')
-
-/**
- * Encapsulates state for {@link ScrollPositionProvider} instances.
- *
- * @ignore
- */
-class ScrollPositionMemento extends PositionMemento {
-  /**
-   * @param {Location} position - The current location to be saved.
-   */
-  constructor(position) {
-    super()
-
-    this._position = new Location(position)
-  }
-
-  /**
-   * @return {number}
-   */
-  getX() {
-    return this._position.getX()
-  }
-
-  /**
-   * @return {number}
-   */
-  getY() {
-    return this._position.getY()
-  }
-}
-
-exports.ScrollPositionMemento = ScrollPositionMemento

package/lib/positioning/ScrollPositionProvider.js

@@ -1,118 +0,0 @@
-'use strict'
-
-const {ArgumentGuard, Location, RectangleSize, EyesError} = require('@applitools/eyes-common')
-const {PositionProvider} = require('@applitools/eyes-sdk-core')
-
-const {ScrollPositionMemento} = require('./ScrollPositionMemento')
-
-class ScrollPositionProvider extends PositionProvider {
-  /**
-   * @param {Logger} logger
-   * @param {EyesJsExecutor} executor
-   * @param {WebElement} scrollRootElement
-   */
-  constructor(logger, executor, scrollRootElement) {
-    super()
-
-    ArgumentGuard.notNull(logger, 'logger')
-    ArgumentGuard.notNull(executor, 'executor')
-    ArgumentGuard.notNull(scrollRootElement, 'scrollRootElement')
-
-    this._logger = logger
-    this._executor = executor
-    this._scrollRootElement = scrollRootElement
-
-    this._logger.verbose('creating ScrollPositionProvider')
-  }
-
-  /**
-   * @param {EyesJsExecutor} executor
-   * @param {WebElement} scrollRootElement
-   * @return {Promise<Location>}
-   */
-  static async getCurrentPositionStatic(executor, scrollRootElement) {
-    const script = 'const el = arguments[0]; return [el.scrollLeft, el.scrollTop];'
-
-    const result = await executor.executeScript(script, scrollRootElement)
-    return new Location(Math.ceil(result[0]) || 0, Math.ceil(result[1]) || 0)
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async getCurrentPosition() {
-    return ScrollPositionProvider.getCurrentPositionStatic(this._executor, this._scrollRootElement)
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async setPosition(location) {
-    try {
-      this._logger.verbose(`setting position of ${this._scrollRootElement} to ${location}`)
-      const script = `
-         if (arguments[0] === document.documentElement && window.scrollTo) {
-           window.scrollTo(${location.getX()}, ${location.getY()});
-         } else {
-           arguments[0].scrollLeft=${location.getX()}; arguments[0].scrollTop=${location.getY()};
-         }
-         return [arguments[0].scrollLeft, arguments[0].scrollTop];
-      `
-
-      const result = await this._executor.executeScript(script, this._scrollRootElement)
-      return new Location(Math.ceil(result[0]) || 0, Math.ceil(result[1]) || 0)
-    } catch (err) {
-      throw new EyesError('Could not get scroll position!', err)
-    }
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async getEntireSize() {
-    this._logger.verbose('enter')
-
-    const script =
-      'var el = arguments[0]; var width = Math.max(el.clientWidth, el.scrollWidth);' +
-      'var height = Math.max(el.clientHeight, el.scrollHeight);' +
-      'return [width, height];'
-
-    const entireSizeStr = await this._executor.executeScript(script, this._scrollRootElement)
-    const result = new RectangleSize(
-      Math.ceil(entireSizeStr[0]) || 0,
-      Math.ceil(entireSizeStr[1]) || 0,
-    )
-    this._logger.verbose(`ScrollPositionProvider - Entire size: ${result}`)
-    return result
-  }
-
-  /**
-   * @inheritDoc
-   * @return {Promise<ScrollPositionMemento>}
-   */
-  async getState() {
-    const position = await this.getCurrentPosition()
-    return new ScrollPositionMemento(position)
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {ScrollPositionMemento} state - The initial state of position
-   * @return {Promise}
-   */
-  async restoreState(state) {
-    const newPosition = new Location(state.getX(), state.getY())
-    await this.setPosition(newPosition)
-  }
-
-  /**
-   * @override
-   * @return {WebElement}
-   */
-  getScrolledElement() {
-    return this._scrollRootElement
-  }
-}
-
-exports.ScrollPositionProvider = ScrollPositionProvider

package/lib/positioning/fixImageMarkPosition.js

@@ -1,36 +0,0 @@
-'use strict'
-
-function makeFixImageMarkPosition({executor, logger}) {
-  return async function(transformLeft, transformTop) {
-    const isZeroPosition = transformLeft === 0 && transformTop === 0
-    const fixTestcafeMark = !isZeroPosition
-      ? `
-      const pageHeight = document.documentElement.getBoundingClientRect().height
-      const styleContent = \`img.screenshot-mark-hammerhead-shadow-ui { 
-        bottom: calc(\${pageHeight\}px - 100vh + ${transformTop}px) !important;
-        top: auto !important;
-        left: auto !important;
-        height: 
-        right: calc(5px + ${transformLeft}px) !important;
-      }\`
-      let style = document.getElementById('applitools-mark-fix')
-      if(!style) {
-        style = document.createElement('style')
-        style.id = 'applitools-mark-fix'
-        document.body.appendChild(style);
-      }
-      style.innerText = styleContent`
-      : `
-      const style = document.getElementById('applitools-mark-fix')
-      style && style.parentNode.removeChild(style)`
-
-    try {
-      logger.verbose('fixImageMarkPosition - fixing testacfe mark, isZeroPosition', isZeroPosition)
-      await executor.executeScript(fixTestcafeMark)
-    } catch (e) {
-      logger.verbose('fixImageMarkPosition - failed to fix testcafe mark', e)
-    }
-  }
-}
-
-module.exports = makeFixImageMarkPosition

package/lib/regionVisibility/MoveToRegionVisibilityStrategy.js

@@ -1,55 +0,0 @@
-'use strict'
-
-const {Location} = require('@applitools/eyes-common')
-
-const {RegionVisibilityStrategy} = require('./RegionVisibilityStrategy')
-
-const VISIBILITY_OFFSET = 100 // Pixels
-
-/**
- * @ignore
- */
-class MoveToRegionVisibilityStrategy extends RegionVisibilityStrategy {
-  /**
-   * @param {Logger} logger
-   */
-  constructor(logger) {
-    super()
-
-    this._logger = logger
-    /** @type {PositionMemento} */
-    this._originalPosition = undefined
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async moveToRegion(positionProvider, location) {
-    this._logger.verbose('Getting current position state...')
-
-    this._originalPosition = await positionProvider.getState()
-    this._logger.verbose('Done! Setting position...')
-
-    // We set the location to "almost" the location we were asked. This is because sometimes, moving the browser
-    // to the specific pixel where the element begins, causes the element to be slightly out of the viewport.
-    let dstX = location.getX() - VISIBILITY_OFFSET
-    dstX = dstX < 0 ? 0 : dstX
-    let dstY = location.getY() - VISIBILITY_OFFSET
-    dstY = dstY < 0 ? 0 : dstY
-
-    await positionProvider.setPosition(new Location(dstX, dstY))
-    this._logger.verbose('Done!')
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async returnToOriginalPosition(positionProvider) {
-    this._logger.verbose('Returning to original position...')
-
-    await positionProvider.restoreState(this._originalPosition)
-    this._logger.verbose('Done!')
-  }
-}
-
-exports.MoveToRegionVisibilityStrategy = MoveToRegionVisibilityStrategy

package/lib/regionVisibility/NopRegionVisibilityStrategy.js

@@ -1,35 +0,0 @@
-'use strict'
-
-const {RegionVisibilityStrategy} = require('./RegionVisibilityStrategy')
-
-/**
- * @ignore
- */
-class NopRegionVisibilityStrategy extends RegionVisibilityStrategy {
-  /**
-   * @param {Logger} logger
-   */
-  constructor(logger) {
-    super()
-
-    this._logger = logger
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async moveToRegion(positionProvider, location) {
-    // eslint-disable-line no-unused-vars
-    this._logger.verbose('Ignored (no op).')
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async returnToOriginalPosition(positionProvider) {
-    // eslint-disable-line no-unused-vars
-    this._logger.verbose('Ignored (no op).')
-  }
-}
-
-exports.NopRegionVisibilityStrategy = NopRegionVisibilityStrategy

package/lib/regionVisibility/RegionVisibilityStrategy.js

@@ -1,30 +0,0 @@
-'use strict'
-
-/* eslint-disable no-unused-vars */
-
-/**
- * @ignore
- * @abstract
- */
-class RegionVisibilityStrategy {
-  // noinspection JSMethodCanBeStatic, JSUnusedGlobalSymbols
-  /**
-   * @param {PositionProvider} positionProvider
-   * @param {Location} location
-   * @return {Promise}
-   */
-  async moveToRegion(positionProvider, location) {
-    throw new TypeError('The method is not implemented!')
-  }
-
-  // noinspection JSMethodCanBeStatic, JSUnusedGlobalSymbols
-  /**
-   * @param {PositionProvider} positionProvider
-   * @return {Promise}
-   */
-  async returnToOriginalPosition(positionProvider) {
-    throw new TypeError('The method is not implemented!')
-  }
-}
-
-exports.RegionVisibilityStrategy = RegionVisibilityStrategy

package/lib/runner/ClassicRunner.js

@@ -1,49 +0,0 @@
-'use strict'
-
-const {makeGetRenderingInfo} = require('@applitools/eyes-sdk-core')
-const {EyesRunner} = require('./EyesRunner')
-const {TestResultsSummary} = require('./TestResultsSummary')
-const {TestResultContainer} = require('./TestResultContainer')
-
-class ClassicRunner extends EyesRunner {
-  constructor() {
-    super()
-
-    /** @type {TestResults[]} */
-    this._allTestResult = []
-    this._getRenderingInfo = undefined
-  }
-
-  /**
-   * @param {boolean} [shouldThrowException=true]
-   * @return {Promise<TestResultsSummary>}
-   */
-  async getAllTestResults(_shouldThrowException = true) {
-    // eslint-disable-line no-unused-vars
-    const allResults = []
-    for (const testResults of this._allTestResult) {
-      allResults.push(new TestResultContainer(testResults))
-    }
-
-    await this._closeAllBatches()
-    return new TestResultsSummary(allResults)
-  }
-
-  makeGetRenderingInfo(getRenderingInfo) {
-    if (!this._getRenderingInfo) {
-      this._getRenderingInfo = makeGetRenderingInfo(getRenderingInfo)
-    }
-  }
-
-  async getRenderingInfoWithCache() {
-    if (this._getRenderingInfo) {
-      return this._getRenderingInfo()
-    } else {
-      throw new Error(
-        'Eyes runner could not get rendering info since makeGetRenderingInfo was not called before',
-      )
-    }
-  }
-}
-
-exports.ClassicRunner = ClassicRunner

package/lib/runner/EyesRunner.js

@@ -1,41 +0,0 @@
-'use strict'
-
-class EyesRunner {
-  constructor() {
-    /** @type {Eyes[]} */
-    this._eyesInstances = []
-  }
-
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @abstract
-   * @param {boolean} [shouldThrowException=true]
-   * @return {Promise<TestResultsSummary>}
-   */
-  async getAllTestResults(shouldThrowException) {
-    // eslint-disable-line no-unused-vars
-    throw new TypeError('The method is not implemented!')
-  }
-
-  /**
-   * @protected
-   * @return {Promise<void>}
-   */
-  async _closeAllBatches() {
-    if (this._eyesInstances.length > 0) {
-      const promises = []
-      const batchIds = new Set()
-      for (const eyesInstance of this._eyesInstances) {
-        const batchId = eyesInstance.getBatch().getId()
-        if (!batchIds.has(batchId)) {
-          batchIds.add(batchId)
-          promises.push(eyesInstance.closeBatch())
-        }
-      }
-
-      await Promise.all(promises)
-    }
-  }
-}
-
-exports.EyesRunner = EyesRunner