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

package/lib/capture/FirefoxScreenshotImageProvider.js

@@ -1,63 +0,0 @@
-'use strict'
-
-const {MutableImage, Region} = require('@applitools/eyes-common')
-const {ImageProvider} = require('@applitools/eyes-sdk-core')
-
-const {EyesWebDriverScreenshot} = require('./EyesWebDriverScreenshot')
-
-/**
- * This class is needed because in certain versions of firefox, a frame screenshot only brings the frame viewport.
- * To solve this issue, we create an image with the full size of the browser viewport and place the frame image on it
- * in the appropriate place.
- *
- * @ignore
- */
-class FirefoxScreenshotImageProvider extends ImageProvider {
-  /**
-   * @param {Eyes} eyes
-   * @param {Logger} logger
-   * @param {EyesWebDriver} tsInstance
-   */
-  constructor(eyes, logger, tsInstance) {
-    super()
-
-    this._eyes = eyes
-    this._logger = logger
-    this._tsInstance = tsInstance
-  }
-
-  /**
-   * @inheritDoc
-   * @return {Promise<MutableImage>}
-   */
-  async getImage() {
-    this._logger.verbose('Getting screenshot as base64...')
-    const screenshot64 = await this._tsInstance.takeScreenshot()
-    this._logger.verbose('Done getting base64! Creating BufferedImage...')
-
-    const image = new MutableImage(screenshot64)
-    await this._eyes.getDebugScreenshotsProvider().save(image, 'FIREFOX_FRAME')
-
-    const frameChain = this._eyes.getDriver().getFrameChain()
-    if (frameChain.size() > 0) {
-      // Frame frame = frameChain.peek();
-      // Region region = this._eyes.getRegionToCheck();
-      const screenshot = await EyesWebDriverScreenshot.fromScreenshotType(
-        this._logger,
-        this._eyes.getDriver(),
-        image,
-      )
-
-      const viewportSize = await this._eyes.getViewportSize()
-      const location = screenshot.getFrameWindow().getLocation()
-      this._logger.verbose(`frame.getLocation(): ${location}`)
-
-      const scaleRatio = this._eyes.getDevicePixelRatio()
-      return image.crop(new Region(location.scale(scaleRatio), viewportSize.scale(scaleRatio)))
-    }
-
-    return image
-  }
-}
-
-exports.FirefoxScreenshotImageProvider = FirefoxScreenshotImageProvider

package/lib/capture/ImageProviderFactory.js

@@ -1,38 +0,0 @@
-'use strict'
-
-const {BrowserNames} = require('@applitools/eyes-common')
-
-const {TakesScreenshotImageProvider} = require('./TakesScreenshotImageProvider')
-const {FirefoxScreenshotImageProvider} = require('./FirefoxScreenshotImageProvider')
-const {SafariScreenshotImageProvider} = require('./SafariScreenshotImageProvider')
-
-/**
- * @ignore
- */
-class ImageProviderFactory {
-  /**
-   * @param {UserAgent} userAgent
-   * @param {Eyes} eyes
-   * @param {Logger} logger
-   * @param {EyesWebDriver} driver
-   * @return {ImageProvider}
-   */
-  static getImageProvider(userAgent, eyes, logger, driver) {
-    if (userAgent) {
-      if (userAgent.getBrowser() === BrowserNames.Firefox) {
-        try {
-          if (parseInt(userAgent.getBrowserMajorVersion(), 10) >= 48) {
-            return new FirefoxScreenshotImageProvider(eyes, logger, driver)
-          }
-        } catch (ignored) {
-          return new TakesScreenshotImageProvider(logger, driver)
-        }
-      } else if (userAgent.getBrowser() === BrowserNames.Safari) {
-        return new SafariScreenshotImageProvider(eyes, logger, driver, userAgent)
-      }
-    }
-    return new TakesScreenshotImageProvider(logger, driver)
-  }
-}
-
-exports.ImageProviderFactory = ImageProviderFactory

package/lib/capture/SafariScreenshotImageProvider.js

@@ -1,254 +0,0 @@
-'use strict'
-
-const {MutableImage, Region, OSNames} = require('@applitools/eyes-common')
-const {ImageProvider} = require('@applitools/eyes-sdk-core')
-
-const {TestCafeExecutor} = require('../TestCafeExecutor')
-
-/**
- * @private
- * @ignore
- */
-class DeviceData {
-  constructor(width, height, vpWidth, vpHeight) {
-    this.width = width
-    this.height = height
-    this.vpWidth = vpWidth
-    this.vpHeight = vpHeight
-  }
-
-  hashCode() {
-    return this.width * 100000 + this.height * 1000 + this.vpWidth * 100 + this.vpHeight
-  }
-}
-
-/**
- * @private
- * @ignore
- */
-class RegionAndVersion {
-  constructor(version, region) {
-    this.majorVersion = version
-    this.region = region
-  }
-
-  getMajorVersion() {
-    return this.majorVersion
-  }
-
-  getRegion() {
-    return this.region
-  }
-}
-
-/**
- * @ignore
- */
-class SafariScreenshotImageProvider extends ImageProvider {
-  /**
-   * @param {EyesTestCafe} eyes
-   * @param {Logger} logger - A Logger instance.
-   * @param {EyesWebDriver} tsInstance
-   * @param {UserAgent} userAgent
-   */
-  constructor(eyes, logger, tsInstance, userAgent) {
-    super()
-
-    this._eyes = eyes
-    this._logger = logger
-    this._tsInstance = tsInstance
-    this._userAgent = userAgent
-
-    /** @type {Map<int, RegionAndVersion>} */
-    this._devicesRegions = undefined
-    this._jsExecutor = new TestCafeExecutor(tsInstance.getDriver())
-  }
-
-  /**
-   * @inheritDoc
-   * @return {Promise<MutableImage>}
-   */
-  async getImage() {
-    this._logger.verbose('Getting screenshot as base64...')
-    let screenshot64 = await this._tsInstance.takeScreenshot()
-    screenshot64 = screenshot64.toString('base64')
-    screenshot64 = screenshot64.replace(/\r\n/g, '') // Because of SauceLabs returns image with line breaks
-
-    this._logger.verbose('Done getting base64! Creating MutableImage...')
-    const image = new MutableImage(screenshot64)
-    await this._eyes.getDebugScreenshotsProvider().save(image, 'SAFARI')
-
-    if (this._eyes.getIsCutProviderExplicitlySet()) {
-      return image
-    }
-
-    const originalViewportSize = await this._eyes.getViewportSize()
-    this._logger.verbose(`logical viewport size: ${originalViewportSize}`)
-
-    if (this._userAgent.getOS() === OSNames.IOS) {
-      if (!this._devicesRegions) {
-        this._initDeviceRegionsTable()
-      }
-
-      const imageWidth = image.getWidth()
-      const imageHeight = image.getHeight()
-
-      this._logger.verbose(`physical device pixel size: ${imageWidth} x ${imageHeight}`)
-
-      const deviceData = new DeviceData(
-        imageWidth,
-        imageHeight,
-        originalViewportSize.getWidth(),
-        originalViewportSize.getHeight(),
-      )
-
-      if (this._devicesRegions.has(deviceData.hashCode())) {
-        const majorVersion = parseInt(this._userAgent.getBrowserMajorVersion(), 10)
-        this._logger.verbose('device model found in hash table')
-        const cropByVersion = this._devicesRegions.get(deviceData.hashCode())
-        if (cropByVersion.getMajorVersion() <= majorVersion) {
-          await image.crop(cropByVersion.getRegion())
-        } else {
-          this._logger.verbose('device version not found in list. returning original image.')
-        }
-      } else {
-        this._logger.verbose('device not found in list. returning original image.')
-      }
-    }
-
-    return image
-  }
-
-  _initDeviceRegionsTable() {
-    this._devicesRegions = new Map()
-
-    // In JS, we need to maintain object reference if we want to use object as a key of Map.
-    // But if we use primitive type, we don't need to. So, we call `hashCode` method to convert class to primitive
-    this._devicesRegions.set(
-      new DeviceData(828, 1792, 414, 719).hashCode(),
-      new RegionAndVersion(12, new Region(0, 189, 828, 1436)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(1792, 828, 808, 364).hashCode(),
-      new RegionAndVersion(12, new Region(88, 101, 1616, 685)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(1242, 2688, 414, 719).hashCode(),
-      new RegionAndVersion(12, new Region(0, 283, 1242, 2155)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2688, 1242, 808, 364).hashCode(),
-      new RegionAndVersion(12, new Region(132, 151, 2424, 1028)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1125, 2436, 375, 635).hashCode(),
-      new RegionAndVersion(11, new Region(0, 283, 1125, 1903)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2436, 1125, 724, 325).hashCode(),
-      new RegionAndVersion(11, new Region(132, 151, 2436, 930)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1242, 2208, 414, 622).hashCode(),
-      new RegionAndVersion(11, new Region(0, 211, 1242, 1863)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2208, 1242, 736, 364).hashCode(),
-      new RegionAndVersion(11, new Region(0, 151, 2208, 1090)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1242, 2208, 414, 628).hashCode(),
-      new RegionAndVersion(10, new Region(0, 193, 1242, 1882)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2208, 1242, 736, 337).hashCode(),
-      new RegionAndVersion(10, new Region(0, 231, 2208, 1010)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(750, 1334, 375, 553).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 750, 1104)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(1334, 750, 667, 325).hashCode(),
-      new RegionAndVersion(11, new Region(0, 101, 1334, 648)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(750, 1334, 375, 559).hashCode(),
-      new RegionAndVersion(10, new Region(0, 129, 750, 1116)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(1334, 750, 667, 331).hashCode(),
-      new RegionAndVersion(10, new Region(0, 89, 1334, 660)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(640, 1136, 320, 460).hashCode(),
-      new RegionAndVersion(10, new Region(0, 129, 640, 918)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(1136, 640, 568, 232).hashCode(),
-      new RegionAndVersion(10, new Region(0, 89, 1136, 462)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1536, 2048, 768, 954).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 1536, 1907)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2048, 1536, 1024, 698).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 2048, 1395)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1536, 2048, 768, 922).hashCode(),
-      new RegionAndVersion(11, new Region(0, 206, 1536, 1842)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2048, 1536, 1024, 666).hashCode(),
-      new RegionAndVersion(11, new Region(0, 206, 2048, 1330)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1536, 2048, 768, 960).hashCode(),
-      new RegionAndVersion(10, new Region(0, 129, 1536, 1919)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2048, 1536, 1024, 704).hashCode(),
-      new RegionAndVersion(10, new Region(0, 129, 2048, 1407)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1536, 2048, 768, 928).hashCode(),
-      new RegionAndVersion(10, new Region(0, 194, 1536, 1854)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2048, 1536, 1024, 672).hashCode(),
-      new RegionAndVersion(10, new Region(0, 194, 2048, 1342)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(2048, 2732, 1024, 1296).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 2048, 2591)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2732, 2048, 1366, 954).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 2732, 1907)),
-    )
-
-    this._devicesRegions.set(
-      new DeviceData(1668, 2224, 834, 1042).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 1668, 2083)),
-    )
-    this._devicesRegions.set(
-      new DeviceData(2224, 1668, 1112, 764).hashCode(),
-      new RegionAndVersion(11, new Region(0, 141, 2224, 1527)),
-    )
-  }
-}
-
-exports.SafariScreenshotImageProvider = SafariScreenshotImageProvider

package/lib/capture/TakesScreenshotImageProvider.js

@@ -1,35 +0,0 @@
-'use strict'
-
-const {MutableImage} = require('@applitools/eyes-common')
-const {ImageProvider} = require('@applitools/eyes-sdk-core')
-
-/**
- * An image provider based on WebDriver's interface.
- *
- * @ignore
- */
-class TakesScreenshotImageProvider extends ImageProvider {
-  /**
-   * @param {Logger} logger - A Logger instance.
-   * @param {EyesWebDriver} tsInstance
-   */
-  constructor(logger, tsInstance) {
-    super()
-
-    this._logger = logger
-    this._tsInstance = tsInstance
-  }
-
-  /**
-   * @override
-   * @return {Promise<MutableImage>}
-   */
-  async getImage() {
-    this._logger.verbose('Getting screenshot as base64...')
-    const screenshot64 = await this._tsInstance.takeScreenshot()
-    this._logger.verbose('Done getting base64! Creating MutableImage...')
-    return new MutableImage(screenshot64)
-  }
-}
-
-exports.TakesScreenshotImageProvider = TakesScreenshotImageProvider

package/lib/errors/EyesDriverOperationError.js

@@ -1,10 +0,0 @@
-'use strict'
-
-const {EyesError} = require('@applitools/eyes-common')
-
-/**
- * Encapsulates an error when trying to perform an action using WebDriver.
- */
-class EyesDriverOperationError extends EyesError {}
-
-exports.EyesDriverOperationError = EyesDriverOperationError

package/lib/errors/NoFramesError.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const {EyesError} = require('@applitools/eyes-common')
-
-class NoFramesError extends EyesError {}
-
-exports.NoFramesError = NoFramesError

package/lib/fluent/AccessibilityRegionByElement.js

@@ -1,46 +0,0 @@
-'use strict'
-
-const {Location, CoordinatesType} = require('@applitools/eyes-common')
-const {GetAccessibilityRegion, AccessibilityMatchSettings} = require('@applitools/eyes-sdk-core')
-
-/**
- * @ignore
- */
-class AccessibilityRegionByElement extends GetAccessibilityRegion {
-  /**
-   * @param {WebElement} regionSelector
-   * @param {AccessibilityRegionType} regionType
-   */
-  constructor(regionSelector, regionType) {
-    super()
-    this._element = regionSelector
-    this._regionType = regionType
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @param {EyesScreenshot} screenshot
-   * @return {Promise<AccessibilityMatchSettings[]>}
-   */
-  async getRegion(eyes, screenshot) {
-    const rect = await this._element.getRect()
-    const pTag = screenshot.convertLocation(
-      new Location(rect),
-      CoordinatesType.CONTEXT_RELATIVE,
-      CoordinatesType.SCREENSHOT_AS_IS,
-    )
-
-    const accessibilityRegion = new AccessibilityMatchSettings({
-      left: pTag.getX(),
-      top: pTag.getY(),
-      width: rect.width,
-      height: rect.height,
-      type: this._regionType,
-    })
-    return [accessibilityRegion]
-  }
-}
-
-exports.AccessibilityRegionByElement = AccessibilityRegionByElement

package/lib/fluent/AccessibilityRegionBySelector.js

@@ -1,58 +0,0 @@
-'use strict'
-
-const {
-  GetAccessibilityRegion,
-  Location,
-  CoordinatesType,
-  AccessibilityMatchSettings,
-} = require('@applitools/eyes-sdk-core')
-
-/**
- * @ignore
- */
-class AccessibilityRegionBySelector extends GetAccessibilityRegion {
-  /**
-   * @param {By} regionSelector
-   * @param {AccessibilityRegionType} regionType
-   */
-  constructor(regionSelector, regionType) {
-    super()
-    this._selector = regionSelector
-    this._regionType = regionType
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @param {EyesScreenshot} screenshot
-   * @return {Promise<AccessibilityMatchSettings[]>}
-   */
-  async getRegion(eyes, screenshot) {
-    const elements = await eyes.getDriver().findElements(this._selector)
-
-    const values = []
-    if (elements && elements.length > 0) {
-      for (let i = 0; i < elements.length; i += 1) {
-        const rect = await elements[i].getRect()
-        const lTag = screenshot.convertLocation(
-          new Location(rect),
-          CoordinatesType.CONTEXT_RELATIVE,
-          CoordinatesType.SCREENSHOT_AS_IS,
-        )
-        const accessibilityRegion = new AccessibilityMatchSettings({
-          left: lTag.getX(),
-          top: lTag.getY(),
-          width: rect.width,
-          height: rect.height,
-          type: this._regionType,
-        })
-        values.push(accessibilityRegion)
-      }
-    }
-
-    return values
-  }
-}
-
-exports.AccessibilityRegionBySelector = AccessibilityRegionBySelector

package/lib/fluent/FloatingRegionByElement.js

@@ -1,56 +0,0 @@
-'use strict'
-
-const {Location, CoordinatesType, FloatingMatchSettings} = require('@applitools/eyes-common')
-const {GetFloatingRegion} = require('@applitools/eyes-sdk-core')
-
-/**
- * @ignore
- */
-class FloatingRegionByElement extends GetFloatingRegion {
-  /**
-   * @param {WebElement} webElement
-   * @param {number} maxUpOffset
-   * @param {number} maxDownOffset
-   * @param {number} maxLeftOffset
-   * @param {number} maxRightOffset
-   */
-  constructor(webElement, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
-    super()
-    this._element = webElement
-    this._maxUpOffset = maxUpOffset
-    this._maxDownOffset = maxDownOffset
-    this._maxLeftOffset = maxLeftOffset
-    this._maxRightOffset = maxRightOffset
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @param {EyesScreenshot} screenshot
-   * @return {Promise<FloatingMatchSettings[]>}
-   */
-  async getRegion(eyes, screenshot) {
-    // eslint-disable-line no-unused-vars
-    const rect = await this._element.getRect()
-    const lTag = screenshot.convertLocation(
-      new Location(rect),
-      CoordinatesType.CONTEXT_RELATIVE,
-      CoordinatesType.SCREENSHOT_AS_IS,
-    )
-
-    const floatingRegion = new FloatingMatchSettings({
-      left: lTag.getX(),
-      top: lTag.getY(),
-      width: rect.width,
-      height: rect.height,
-      maxUpOffset: this._maxUpOffset,
-      maxDownOffset: this._maxDownOffset,
-      maxLeftOffset: this._maxLeftOffset,
-      maxRightOffset: this._maxRightOffset,
-    })
-    return [floatingRegion]
-  }
-}
-
-exports.FloatingRegionByElement = FloatingRegionByElement

package/lib/fluent/FloatingRegionBySelector.js

@@ -1,63 +0,0 @@
-'use strict'
-
-const {Location, CoordinatesType, FloatingMatchSettings} = require('@applitools/eyes-common')
-const {GetFloatingRegion} = require('@applitools/eyes-sdk-core')
-
-/**
- * @ignore
- */
-class FloatingRegionBySelector extends GetFloatingRegion {
-  /**
-   * @param {By} regionSelector
-   * @param {number} maxUpOffset
-   * @param {number} maxDownOffset
-   * @param {number} maxLeftOffset
-   * @param {number} maxRightOffset
-   */
-  constructor(regionSelector, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
-    super()
-    this._selector = regionSelector
-    this._maxUpOffset = maxUpOffset
-    this._maxDownOffset = maxDownOffset
-    this._maxLeftOffset = maxLeftOffset
-    this._maxRightOffset = maxRightOffset
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @param {EyesScreenshot} screenshot
-   * @return {Promise<FloatingMatchSettings[]>}
-   */
-  async getRegion(eyes, screenshot) {
-    const elements = await eyes.getDriver().findElements(this._selector)
-
-    const values = []
-    if (elements && elements.length > 0) {
-      for (let i = 0; i < elements.length; i += 1) {
-        const rect = await elements[i].getRect()
-        const lTag = screenshot.convertLocation(
-          new Location(rect),
-          CoordinatesType.CONTEXT_RELATIVE,
-          CoordinatesType.SCREENSHOT_AS_IS,
-        )
-        const floatingRegion = new FloatingMatchSettings({
-          left: lTag.getX(),
-          top: lTag.getY(),
-          width: rect.width,
-          height: rect.height,
-          maxUpOffset: this._maxUpOffset,
-          maxDownOffset: this._maxDownOffset,
-          maxLeftOffset: this._maxLeftOffset,
-          maxRightOffset: this._maxRightOffset,
-        })
-        values.push(floatingRegion)
-      }
-    }
-
-    return values
-  }
-}
-
-exports.FloatingRegionBySelector = FloatingRegionBySelector