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

package/lib/frames/Frame.js

@@ -1,149 +0,0 @@
-'use strict'
-
-const {ArgumentGuard} = require('@applitools/eyes-common')
-const {ScrollPositionMemento} = require('../positioning/ScrollPositionMemento')
-const {ScrollPositionProvider} = require('../positioning/ScrollPositionProvider')
-
-/**
- * Encapsulates a frame/iframe. This is a generic type class, and it's actual type is determined by the reference used
- * by the user in order to switch into the frame.
- */
-class Frame {
-  /**
-   * @param {Logger} logger - A Logger instance.
-   * @param {WebElement} reference - The web element for the frame, used as a reference to switch into the frame.
-   * @param {Location} location - The location of the frame within the current frame.
-   * @param {RectangleSize} outerSize - The frame element size (i.e., the size of the frame on the screen, not the
-   *   internal document size).
-   * @param {RectangleSize} innerSize - The frame element inner size (i.e., the size of the frame actual size, without
-   *   borders).
-   * @param {Location} originalLocation - The scroll location of the frame.
-   * @param {string} jsExecutor - The Javascript Executor to use. Usually that will be the WebDriver.
-   */
-  constructor(logger, reference, location, outerSize, innerSize, originalLocation, jsExecutor) {
-    ArgumentGuard.notNull(logger, 'logger')
-    ArgumentGuard.notNull(reference, 'reference')
-    ArgumentGuard.notNull(location, 'location')
-    ArgumentGuard.notNull(outerSize, 'outerSize')
-    ArgumentGuard.notNull(innerSize, 'innerSize')
-    ArgumentGuard.notNull(originalLocation, 'originalLocation')
-    ArgumentGuard.notNull(jsExecutor, 'jsExecutor')
-
-    logger.verbose(
-      `Frame(logger, reference, ${location}, ${outerSize}, ${innerSize}, ${originalLocation})`,
-    )
-
-    this._logger = logger
-    this._reference = reference
-    this._location = location
-    this._outerSize = outerSize
-    this._innerSize = innerSize
-    this._originalLocation = originalLocation
-    this._positionMemento = new ScrollPositionMemento(originalLocation)
-    this._jsExecutor = jsExecutor
-  }
-
-  /**
-   * @return {WebElement}
-   */
-  getReference() {
-    return this._reference
-  }
-
-  /**
-   * @return {Location}
-   */
-  getLocation() {
-    return this._location
-  }
-
-  /**
-   * @return {RectangleSize}
-   */
-  getOuterSize() {
-    return this._outerSize
-  }
-
-  /**
-   * @return {RectangleSize}
-   */
-  getInnerSize() {
-    return this._innerSize
-  }
-
-  /**
-   * @return {Location}
-   */
-  getOriginalLocation() {
-    return this._originalLocation
-  }
-
-  /**
-   * @return {WebElement}
-   */
-  getScrollRootElement() {
-    return this._scrollRootElement
-  }
-
-  /**
-   * @param {EyesWebDriver} driver
-   * @return {Promise<WebElement>}
-   */
-  async getForceScrollRootElement(driver) {
-    if (!this._scrollRootElement) {
-      this._logger.verbose('no scroll root element. selecting default.')
-      this._scrollRootElement = await driver.findElement('html')
-    }
-
-    return this._scrollRootElement
-  }
-
-  /**
-   * @param {WebElement} scrollRootElement
-   */
-  setScrollRootElement(scrollRootElement) {
-    this._scrollRootElement = scrollRootElement
-  }
-
-  /**
-   * @param {EyesWebDriver} driver
-   * @return {Promise}
-   */
-  async hideScrollbars(driver) {
-    const scrollRootElement = await this.getForceScrollRootElement(driver)
-    this._logger.verbose('hiding scrollbars of element:', scrollRootElement)
-    this._originalOverflow = await this._jsExecutor.executeScript(
-      "var origOF = arguments[0].style.overflow; arguments[0].style.overflow='hidden'; return origOF;",
-      scrollRootElement,
-    )
-  }
-
-  /**
-   * @param {EyesWebDriver} driver
-   * @return {Promise}
-   */
-  async returnToOriginalOverflow(driver) {
-    const scrollRootElement = await this.getForceScrollRootElement(driver)
-    this._logger.verbose('returning overflow of element to its original value:', scrollRootElement)
-    await this._jsExecutor.executeScript(
-      `arguments[0].style.overflow='${this._originalOverflow}';`,
-      scrollRootElement,
-    )
-  }
-
-  /**
-   * @param {EyesWebDriver} driver
-   * @return {Promise}
-   */
-  async returnToOriginalPosition(driver) {
-    const scrollRootElement = await this.getForceScrollRootElement(driver)
-    const positionProvider = new ScrollPositionProvider(
-      this._logger,
-      this._jsExecutor,
-      scrollRootElement,
-    )
-    await positionProvider.restoreState(this._positionMemento)
-  }
-}
-
-exports.Frame = Frame

package/lib/frames/FrameChain.js

@@ -1,175 +0,0 @@
-'use strict'
-
-const {ArgumentGuard, Location} = require('@applitools/eyes-common')
-
-const {NoFramesError} = require('../errors/NoFramesError')
-
-/**
- * @implements {Iterable<Frame>}
- */
-class FrameChain {
-  /**
-   * Creates a new frame chain.
-   *
-   * @param {Logger} logger - A Logger instance.
-   * @param {FrameChain} [other] - A frame chain from which the current frame chain will be created.
-   */
-  constructor(logger, other) {
-    ArgumentGuard.notNull(logger, 'logger')
-
-    this._logger = logger
-    this._frames = []
-
-    if (other) {
-      this._frames = other.getFrames().slice(0)
-    }
-  }
-
-  /**
-   * Compares two frame chains.
-   *
-   * @param {FrameChain} c1 - Frame chain to be compared against c2.
-   * @param {FrameChain} c2 - Frame chain to be compared against c1.
-   * @return {boolean} - True if both frame chains represent the same frame, false otherwise.
-   */
-  static isSameFrameChain(c1, c2) {
-    const lc1 = c1.size()
-    const lc2 = c2.size()
-
-    // different chains size means different frames
-    if (lc1 !== lc2) {
-      return false
-    }
-
-    for (let i = 0; i < lc1; i += 1) {
-      if (c1.getFrame(i).getReference() !== c2.getFrame(i).getReference()) {
-        return false
-      }
-    }
-
-    return true
-  }
-
-  /**
-   * @return {number} - The number of frames in the chain.
-   */
-  size() {
-    return this._frames.length
-  }
-
-  /**
-   * Removes all current frames in the frame chain.
-   */
-  clear() {
-    this._frames = []
-  }
-
-  /**
-   * Removes the last inserted frame element. Practically means we switched back to the parent of the current frame
-   *
-   * @return {Frame}
-   */
-  pop() {
-    return this._frames.pop()
-  }
-
-  /**
-   * @return {?Frame} - Returns the top frame in the chain.
-   */
-  peek() {
-    if (this._frames.length === 0) {
-      return null
-    }
-
-    return this._frames[this._frames.length - 1]
-  }
-
-  /**
-   * Appends a frame to the frame chain.
-   *
-   * @param {Frame} frame - The frame to be added.
-   */
-  push(frame) {
-    return this._frames.push(frame)
-  }
-
-  /**
-   * @return {Location} - The location of the current frame in the page.
-   */
-  getCurrentFrameOffset() {
-    let result = new Location(Location.ZERO)
-
-    this._frames.forEach(frame => {
-      result = result.offsetByLocation(frame.getLocation())
-    })
-
-    return result
-  }
-
-  /**
-   * @return {Location} - The outermost frame's location, or NoFramesException.
-   */
-  getDefaultContentScrollPosition() {
-    if (this._frames.length === 0) {
-      throw new NoFramesError('No frames in frame chain')
-    }
-    return new Location(this._frames[0].getOriginalLocation())
-  }
-
-  // noinspection JSUnusedGlobalSymbols
-  /**
-   * @return {RectangleSize} - The size of the current frame.
-   */
-  getCurrentFrameSize() {
-    this._logger.verbose('getCurrentFrameSize()')
-    const result = this._frames[this._frames.length - 1].getOuterSize()
-    this._logger.verbose('Done!')
-    return result
-  }
-
-  /**
-   * @return {RectangleSize} - The inner size of the current frame.
-   */
-  getCurrentFrameInnerSize() {
-    this._logger.verbose('getCurrentFrameInnerSize()')
-    const result = this._frames[this._frames.length - 1].getInnerSize()
-    this._logger.verbose('Done!')
-    return result
-  }
-
-  /**
-   * @return {IterableIterator<Frame>} iterator to go over the frames in the chain.
-   */
-  [Symbol.iterator]() {
-    // noinspection JSValidateTypes
-    return this._frames[Symbol.iterator]()
-  }
-
-  /**
-   * @return {Frame[]} - All frames stored in chain
-   */
-  getFrames() {
-    return this._frames
-  }
-
-  /**
-   * @param {number} index - Index of needed frame
-   * @return {Frame} - Frame by index in array
-   */
-  getFrame(index) {
-    if (this._frames.length > index) {
-      return this._frames[index]
-    }
-
-    throw new Error('No frames for given index')
-  }
-
-  /**
-   * @return {FrameChain}
-   */
-  clone() {
-    return new FrameChain(this._logger, this)
-  }
-}
-
-exports.FrameChain = FrameChain

package/lib/getCaptureDomScript.js

@@ -1,14 +0,0 @@
-'use strict'
-
-const {BrowserNames, UserAgent} = require('@applitools/eyes-common')
-const captureFrameAndPoll = require('../dist/captureFrameAndPoll')
-const captureFrameAndPollForIE = require('../dist/captureFrameAndPollForIE')
-
-async function getCaptureDomScript({webDriver, logger}) {
-  const userAgent = await webDriver.getUserAgent()
-  const isIE = UserAgent.parseUserAgentString(userAgent).getBrowser() === BrowserNames.IE
-  logger.log(`using ${isIE ? 'IE' : 'standard'} dom capture`)
-  return !isIE ? captureFrameAndPoll : captureFrameAndPollForIE
-}
-
-module.exports = getCaptureDomScript

package/lib/hash.js

@@ -1,15 +0,0 @@
-'use strict'
-
-function hash(str) {
-  let hash = 0
-  let i, chr
-  if (str.length === 0) return hash
-  for (i = 0; i < str.length; i++) {
-    chr = str.charCodeAt(i)
-    hash = (hash << 5) - hash + chr
-    hash |= 0
-  }
-  return hash
-}
-
-module.exports = hash

package/lib/isTestcafeSelector.js

@@ -1,7 +0,0 @@
-'use strict'
-
-function isTestcafeSelector(obj) {
-  return !!(obj && obj.addCustomMethods && obj.find && obj.parent)
-}
-
-module.exports = isTestcafeSelector

package/lib/makeClientFunctionWrapper.js

@@ -1,61 +0,0 @@
-'use strict'
-
-const {ClientFunction} = require('testcafe')
-const {TypeUtils} = require('@applitools/eyes-common')
-const EYES_NAME_SPACE = '__EYES__APPLITOOLS__'
-const MAX_OBJECT_SIZE = 1024 * 1024 * 4.0 // 4 MB
-const {isString} = TypeUtils
-
-/*
- * Split the result to smaller chunks if it is too big.
- * See: https://github.com/DevExpress/testcafe/issues/1110
- */
-function makeClientFunctionWrapper({
-  clientFunctionExecuter = ClientFunction,
-  maxObjectSize = MAX_OBJECT_SIZE,
-  logger = {log: () => {}},
-  window,
-}) {
-  return (browserFunction, dependencies = {}) => {
-    const getResultMeta = clientFunctionExecuter(
-      () => {
-        const browserFunctionPromised = browserFunction.then
-          ? browserFunction
-          : () => Promise.resolve(browserFunction())
-        return browserFunctionPromised().then((result = {}) => {
-          const resultStr = isString(result) ? result : JSON.stringify(result)
-          if (!window[EYES_NAME_SPACE]) {
-            window[EYES_NAME_SPACE] = {}
-          }
-          window[EYES_NAME_SPACE].clientFunctionResult = resultStr
-          return {size: resultStr.length, isString: isString(result)}
-        })
-      },
-      {
-        dependencies: Object.assign({EYES_NAME_SPACE, browserFunction, isString}, dependencies),
-      },
-    )
-
-    const getResult = clientFunctionExecuter(
-      (start, end) => window[EYES_NAME_SPACE].clientFunctionResult.substring(start, end),
-      {dependencies: {EYES_NAME_SPACE}},
-    )
-
-    return async t => {
-      const getResultMetaWithT = getResultMeta.with({boundTestRun: t})
-      const getResultWithT = getResult.with({boundTestRun: t})
-      const {size, isString} = await getResultMetaWithT()
-      const splits = Math.ceil(size / maxObjectSize)
-      logger.log(`starting to collect ClientFunction result of size ${size}`)
-      let result = ''
-      for (let i = 0; i < splits; i += 1) {
-        const start = i * maxObjectSize
-        logger.log(`getting ClientFunction result chunk ${i + 1} of ${splits}`)
-        result += await getResultWithT(start, start + maxObjectSize)
-      }
-      return isString ? result : JSON.parse(result)
-    }
-  }
-}
-
-exports.makeClientFunctionWrapper = makeClientFunctionWrapper

package/lib/positioning/CssTranslatePositionMemento.js

@@ -1,39 +0,0 @@
-'use strict'
-
-const {PositionMemento} = require('@applitools/eyes-sdk-core')
-
-/**
- * Encapsulates state for {@link CssTranslatePositionProvider} instances.
- *
- * @ignore
- */
-class CssTranslatePositionMemento extends PositionMemento {
-  /**
-   * @param {String} transforms - The current transforms. The keys are the style keys from which each of the transforms
-   *   were taken.
-   * @param {Location} position
-   */
-  constructor(transforms, position) {
-    super()
-
-    this._transforms = transforms
-    this._position = position
-  }
-
-  /**
-   * @return {String} - The current transforms. The keys are the style keys from which each of the transforms
-   *  were taken.
-   */
-  getTransform() {
-    return this._transforms
-  }
-
-  /**
-   * @return {Location}
-   */
-  getPosition() {
-    return this._position
-  }
-}
-
-exports.CssTranslatePositionMemento = CssTranslatePositionMemento

package/lib/positioning/CssTranslatePositionProvider.js

@@ -1,130 +0,0 @@
-'use strict'
-
-const {ArgumentGuard} = require('@applitools/eyes-common')
-const {PositionProvider} = require('@applitools/eyes-sdk-core')
-
-const {EyesTestcafeUtils} = require('../EyesTestcafeUtils')
-const makeFixImageMarkPosition = require('./fixImageMarkPosition')
-const {CssTranslatePositionMemento} = require('./CssTranslatePositionMemento')
-
-/**
- * A {@link PositionProvider} which is based on CSS translates. This is useful when we want to stitch a page which
- * contains fixed position elements.
- */
-class CssTranslatePositionProvider extends PositionProvider {
-  /**
-   * @param {Logger} logger
-   * @param {TestcafeExecutor} 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
-
-    /** @type {Location} */
-    this._lastSetPosition = undefined
-
-    this._logger.verbose('creating CssTranslatePositionProvider')
-    this._fixImageMarkPosition = makeFixImageMarkPosition({
-      executor: this._executor,
-      logger: this._logger,
-    })
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async getCurrentPosition() {
-    this._logger.verbose(`position to return: ${this._lastSetPosition}`)
-    return this._lastSetPosition
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async setPosition(location) {
-    ArgumentGuard.notNull(location, 'location')
-    this._logger.verbose(`CssTranslatePositionProvider - Setting position to: ${location}`)
-
-    let translate = `translate(-${location.getX()}px, -${location.getY()}px)`
-    if (location.getX() === 0 && location.getY() === 0) {
-      translate = ''
-    }
-
-    await this._fixImageMarkPosition(-location.getX(), -location.getY())
-    await this._executor.executeScript(
-      `arguments[0].style.transform = '${translate}';`,
-      this._scrollRootElement,
-    )
-
-    this._logger.verbose('Done!')
-    this._lastSetPosition = location
-    return this._lastSetPosition
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async getEntireSize() {
-    const entireSize = await EyesTestcafeUtils.getEntireElementSize(
-      this._executor,
-      this._scrollRootElement,
-    )
-    this._logger.verbose('CssTranslatePositionProvider - Entire size:', entireSize)
-    return entireSize
-  }
-
-  /**
-   * @inheritDoc
-   * @return {Promise<CssTranslatePositionMemento>}
-   */
-  async getState() {
-    let transforms = await this._executor.executeScript(
-      'return arguments[0].style.transform;',
-      this._scrollRootElement,
-    )
-    // TODO
-    // maybe we can do something else here ? check, since if later we
-    // try to update to this translate we set it to "" as well..
-    if (!transforms) {
-      transforms = 'translate(0px, 0px)'
-    }
-    this._logger.verbose('Current transform', transforms)
-    return new CssTranslatePositionMemento(transforms, this._lastSetPosition)
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {CssTranslatePositionMemento} state - The initial state of position
-   * @return {Promise}
-   */
-  async restoreState(state) {
-    let transform = state.getTransform()
-    if (transform === 'translate(0px, 0px)') {
-      transform = ''
-    }
-    const script = `arguments[0].style.transform = '${transform}';`
-
-    await this._fixImageMarkPosition(0, 0)
-    await this._executor.executeScript(script, this._scrollRootElement)
-    this._logger.verbose('Transform (position) restored.')
-    this._lastSetPosition = state.getPosition()
-  }
-
-  /**
-   * @return {WebElement}
-   */
-  getScrolledElement() {
-    return this._scrollRootElement
-  }
-}
-
-exports.CssTranslatePositionProvider = CssTranslatePositionProvider

package/lib/positioning/ElementPositionMemento.js

@@ -1,36 +0,0 @@
-'use strict'
-
-const {Location} = require('@applitools/eyes-common')
-const {PositionMemento} = require('@applitools/eyes-sdk-core')
-
-/**
- * Encapsulates state for {@link ElementPositionProvider} instances.
- *
- * @ignore
- */
-class ElementPositionMemento 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.ElementPositionMemento = ElementPositionMemento