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

package/lib/EyesVisualGrid.js

@@ -1,345 +0,0 @@
-'use strict'
-
-const {makeVisualGridClient, takeDomSnapshot} = require('@applitools/visual-grid-client')
-const {
-  ArgumentGuard,
-  TypeUtils,
-  EyesError,
-  UserAgent,
-  BrowserType,
-} = require('@applitools/eyes-common')
-const {
-  CorsIframeHandle,
-  CorsIframeHandler,
-  IgnoreRegionByRectangle,
-} = require('@applitools/eyes-sdk-core')
-
-const {TestResultsSummary} = require('./runner/TestResultsSummary')
-const {VisualGridRunner} = require('./runner/VisualGridRunner')
-const {Eyes} = require('./Eyes')
-
-const VERSION = require('../package.json').version
-
-/**
- * @ignore
- */
-class EyesVisualGrid extends Eyes {
-  /** @var {Logger} EyesVisualGrid#_logger */
-  /** @var {Configuration} EyesVisualGrid#_configuration */
-
-  /**
-   * Creates a new (possibly disabled) Eyes instance that interacts with the Eyes Server at the specified url.
-   *
-   * @param {string} [serverUrl] - The Eyes server URL.
-   * @param {boolean} [isDisabled=false] - Set {@code true} to disable Applitools Eyes and use the WebDriver directly.
-   * @param {VisualGridRunner} [runner] - Set shared VisualGridRunner if you want to group results.
-   */
-  constructor(serverUrl, isDisabled, runner = new VisualGridRunner()) {
-    super(serverUrl, isDisabled, runner)
-
-    this._isVisualGrid = true
-    /** @type {UserAgent} */
-    this._userAgent = undefined
-
-    /** @function */ this._checkWindowCommand = undefined
-    /** @function */ this._closeCommand = undefined
-    /** @function */ this._abortCommand = undefined
-    /** @type {Promise} */ this._closePromise = undefined
-  }
-
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @override
-   * @protected
-   * @return {string} - The base agent id of the SDK.
-   */
-  getBaseAgentId() {
-    // TODO - change user agent ?
-    return `eyes-testcafe-visualgrid/${VERSION}`
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async open(driver, appName, testName, viewportSize, sessionType) {
-    ArgumentGuard.notNull(driver, 'driver')
-
-    // noinspection NonBlockStatementBodyJS
-    if (appName) this._configuration.setAppName(appName)
-    // noinspection NonBlockStatementBodyJS
-    if (testName) this._configuration.setTestName(testName)
-    // noinspection NonBlockStatementBodyJS
-    if (viewportSize) this._configuration.setViewportSize(viewportSize)
-    // noinspection NonBlockStatementBodyJS
-    if (sessionType) this._configuration.setSessionType(sessionType)
-
-    // noinspection NonBlockStatementBodyJS
-    if (this._runner.getConcurrentSessions()) {
-      this._configuration.setConcurrentSessions(this._runner.getConcurrentSessions())
-    }
-
-    await this._initDriver(driver)
-
-    const uaString = await this._driver.getUserAgent()
-    if (uaString) {
-      this._userAgent = UserAgent.parseUserAgentString(uaString, true)
-    }
-
-    const {openEyes} = makeVisualGridClient({
-      logger: this._logger,
-      agentId: this.getFullAgentId(),
-      apiKey: this._configuration.getApiKey(),
-      showLogs: this._configuration.getShowLogs(),
-      saveDebugData: this._configuration.getSaveDebugData(),
-      proxy: this._configuration.getProxy(),
-      serverUrl: this._configuration.getServerUrl(),
-      // concurrency: this._configuration.getConcurrentSessions(),
-      renderConcurrencyFactor: this._configuration.getConcurrentSessions(),
-    })
-
-    if (this._configuration.getViewportSize()) {
-      await this.setViewportSize(this._configuration.getViewportSize())
-
-      if (this._configuration.getBrowsersInfo().length === 0) {
-        this._configuration.addBrowser(
-          this._configuration.getViewportSize().getWidth(),
-          this._configuration.getViewportSize().getHeight(),
-          BrowserType.CHROME,
-        )
-      }
-    }
-
-    const {checkWindow, close, abort} = await openEyes({
-      appName: this._configuration.getAppName(),
-      testName: this._configuration.getTestName(),
-      displayName: this._configuration.getDisplayName(),
-      browser: this._configuration.getBrowsersInfo(),
-      properties: this._configuration.getProperties(),
-      batchSequenceName:
-        this._configuration.getBatch() && this._configuration.getBatch().getSequenceName(),
-      batchName: this._configuration.getBatch() && this._configuration.getBatch().getName(),
-      batchId: this._configuration.getBatch() && this._configuration.getBatch().getId(),
-      baselineBranchName: this._configuration.getBaselineBranchName(),
-      baselineEnvName: this._configuration.getBaselineEnvName(),
-      baselineName: this._configuration.getBaselineEnvName(),
-      envName: this._configuration.getEnvironmentName(),
-      branchName: this._configuration.getBranchName(),
-      saveFailedTests: this._configuration.getSaveFailedTests(),
-      saveNewTests: this._configuration.getSaveNewTests(),
-      compareWithParentBranch: this._configuration.getCompareWithParentBranch(),
-      ignoreBaseline: this._configuration.getIgnoreBaseline(),
-      parentBranchName: this._configuration.getParentBranchName(),
-      isDisabled: this._configuration.getIsDisabled(),
-      matchTimeout: this._configuration.getMatchTimeout(),
-
-      ignoreCaret: this._configuration.getIgnoreCaret(),
-      matchLevel: this._configuration.getMatchLevel(),
-      useDom: this._configuration.getUseDom(),
-      enablePatterns: this._configuration.getEnablePatterns(),
-      ignoreDisplacements: this._configuration.getIgnoreDisplacements(),
-      saveDebugData: this._configuration.getSaveDebugData(),
-    })
-
-    this._isOpen = true
-    this._checkWindowCommand = checkWindow
-    this._closeCommand = async () =>
-      close(true).catch(err => {
-        if (Array.isArray(err)) {
-          return err
-        }
-
-        throw err
-      })
-    this._abortCommand = async () => abort(true)
-
-    return this._driver
-  }
-
-  /**
-   * @package
-   * @param {boolean} [throwEx=true]
-   * @return {Promise<TestResultsSummary>}
-   */
-  async closeAndReturnResults(throwEx = true) {
-    try {
-      const resultsPromise = this._closePromise || this._closeCommand()
-      const res = await resultsPromise
-      const testResultsSummary = new TestResultsSummary(res)
-
-      if (throwEx === true) {
-        for (const result of testResultsSummary.getAllResults()) {
-          if (result.getException()) {
-            throw result.getException()
-          }
-        }
-      }
-
-      return testResultsSummary
-    } finally {
-      this._isOpen = false
-      this._closePromise = undefined
-    }
-  }
-
-  /**
-   * @return {Promise}
-   */
-  async closeAsync() {
-    if (!this._closePromise) {
-      this._closePromise = this._closeCommand()
-    }
-  }
-
-  /**
-   * @param {boolean} [throwEx]
-   * @return {Promise<TestResults>}
-   */
-  async close(throwEx = true) {
-    const results = await this.closeAndReturnResults(throwEx)
-
-    for (const result of results.getAllResults()) {
-      if (result.getException()) {
-        return result.getTestResults()
-      }
-    }
-
-    return results.getAllResults()[0].getTestResults()
-  }
-
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @return {Promise<?TestResults>}
-   */
-  async abort() {
-    if (typeof this._abortCommand === 'function') {
-      if (this._closePromise) {
-        this._logger.verbose('Can not abort while closing async, abort added to close promise.')
-        return this._closePromise.then(() => this._abortCommand(true))
-      }
-
-      return this._abortCommand()
-    }
-    return null
-  }
-
-  /**
-   * @return {Promise}
-   */
-  async abortAsync() {
-    this._closePromise = this.abort()
-  }
-
-  /**
-   * @inheritDoc
-   */
-  async check(name, checkSettings) {
-    ArgumentGuard.notNull(checkSettings, 'checkSettings')
-
-    if (TypeUtils.isNotNull(name)) {
-      checkSettings.withName(name)
-    }
-
-    // check if we need a region of screenshot, add custom tag if by selector (SHOULD BE BEFORE CAPTURING DOM)
-    let targetSelector = await checkSettings.getTargetProvider()
-    if (targetSelector) {
-      targetSelector = await targetSelector.getSelector(this)
-    }
-
-    // prepare regions, add custom tag if by selector (SHOULD BE BEFORE CAPTURING DOM)
-    const ignoreRegions = await this._prepareRegions(checkSettings.getIgnoreRegions())
-
-    try {
-      this._logger.verbose(`Dom extraction starting   (${checkSettings.toString()})   $$$$$$$$$$$$`)
-
-      const pageDomResults = await takeDomSnapshot({
-        executeScript: this._driver.executeScript.bind(this._driver),
-        browser: this._userAgent.getBrowser(),
-      })
-
-      const {cdt, url: pageUrl, blobs, resourceUrls, frames} = pageDomResults
-
-      if (this.getCorsIframeHandle() === CorsIframeHandle.BLANK) {
-        CorsIframeHandler.blankCorsIframeSrcOfCdt(cdt, frames)
-      }
-
-      const resourceContents = this._blobsToResourceContents(blobs)
-      if (frames && frames.length > 0) {
-        for (let i = 0; i < frames.length; i += 1) {
-          frames[i].resourceContents = this._blobsToResourceContents(frames[i].blobs)
-          delete frames[i].blobs
-        }
-      }
-
-      this._logger.verbose(`Dom extracted  (${checkSettings.toString()})   $$$$$$$$$$$$`)
-
-      const source = await this._driver.getCurrentUrl()
-
-      await this._checkWindowCommand({
-        resourceUrls,
-        resourceContents,
-        frames,
-        url: pageUrl,
-        cdt,
-        tag: checkSettings.getName(),
-        sizeMode:
-          checkSettings.getSizeMode() === 'viewport' && this.getForceFullPageScreenshot()
-            ? 'full-page'
-            : checkSettings.getSizeMode(),
-        selector: targetSelector,
-        region: checkSettings.getTargetRegion(),
-        scriptHooks: checkSettings.getScriptHooks(),
-        ignore: ignoreRegions,
-        floating: checkSettings.getFloatingRegions(),
-        sendDom: checkSettings.getSendDom() ? checkSettings.getSendDom() : this.getSendDom(),
-        matchLevel: checkSettings.getMatchLevel()
-          ? checkSettings.getMatchLevel()
-          : this.getMatchLevel(),
-        source,
-      })
-    } catch (e) {
-      throw new EyesError(`Failed to extract DOM from the page: ${e.toString()}`)
-    }
-  }
-
-  /**
-   * @private
-   * @param {{type: string, url: string, value: string}[]} blobs
-   * @return {{type: string, url: string, value: Buffer}[]}
-   */
-  _blobsToResourceContents(blobs) {
-    return blobs.map(({url, type, value}) => ({
-      url,
-      type,
-      value: Buffer.from(value, 'base64'),
-    }))
-  }
-
-  /**
-   * @private
-   * @param {GetRegion[]} regions
-   * @return {{type: string, url: string, value: Buffer}[]}
-   */
-  async _prepareRegions(regions) {
-    if (regions && regions.length > 0) {
-      const newRegions = []
-
-      for (const region of regions) {
-        if (region instanceof IgnoreRegionByRectangle) {
-          const plainRegions = await region.getRegion(this, undefined)
-          plainRegions.forEach(plainRegion => {
-            newRegions.push(plainRegion.toJSON())
-          })
-        } else {
-          const selector = await region.getSelector(this)
-          newRegions.push({selector})
-        }
-      }
-
-      return newRegions
-    }
-
-    return regions
-  }
-}
-
-exports.EyesVisualGrid = EyesVisualGrid

package/lib/ImageOrientationHandler.js

@@ -1,31 +0,0 @@
-'use strict'
-
-/* eslint-disable no-unused-vars */
-
-/**
- * @ignore
- * @abstract
- */
-class ImageOrientationHandler {
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @param {IWebDriver} driver
-   * @return {Promise<boolean>}
-   */
-  async isLandscapeOrientation(driver) {
-    throw Error('Method is not implemented!')
-  }
-
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @param {Logger} logger
-   * @param {IWebDriver} driver
-   * @param {MutableImage} image
-   * @return {Promise<number>}
-   */
-  async tryAutomaticRotation(logger, driver, image) {
-    throw Error('Method is not implemented!')
-  }
-}
-
-exports.ImageOrientationHandler = ImageOrientationHandler

package/lib/JavascriptHandler.js

@@ -1,20 +0,0 @@
-'use strict'
-
-/* eslint-disable no-unused-vars */
-
-/**
- * @ignore
- */
-class JavascriptHandler {
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @param {!string} script
-   * @param {...object} args
-   * @return {Promise}
-   */
-  async handle(script, ...args) {
-    return null // do nothing
-  }
-}
-
-exports.JavascriptHandler = JavascriptHandler

package/lib/TestCafeExecutor.js

@@ -1,57 +0,0 @@
-'use strict'
-
-const {EyesJsExecutor} = require('@applitools/eyes-sdk-core')
-const {TypeUtils} = require('@applitools/eyes-common')
-const isTestcafeSelector = require('./isTestcafeSelector')
-const makeSafeExecuteFunction = require('./safeExecuteFunction')
-
-/**
- * @ignore
- */
-class TestCafeExecutor extends EyesJsExecutor {
-  /**
-   * @param {EyesWebDriver|WebDriver} driver
-   */
-  constructor(driver) {
-    super()
-    this._driver = driver
-    this._safeExecuteFunction = makeSafeExecuteFunction(driver)
-  }
-
-  /**
-   * @inheritDoc
-   */
-  executeScript(script, ...args) {
-    if (!TypeUtils.isString(script)) {
-      return this.executeFunction(script)
-    }
-
-    const dependencies = {}
-    for (let i = 0; i < args.length; i++) {
-      // eslint-disable-line no-plusplus
-      dependencies[`arg${i}`] = args[i]
-    }
-
-    const mapSelector =
-      args.length === 1 && isTestcafeSelector(args[0])
-        ? 'arguments[0] = arguments[0] && arguments[0]()'
-        : 'void(0)'
-    const func = new Function(
-      `return (function() {${mapSelector}; ${script}})(${Object.keys(dependencies).join(',')})`,
-    ) // eslint-disable-line no-new-func
-    return this._driver.eval(func, {dependencies})
-  }
-
-  async executeFunction(func) {
-    return this._safeExecuteFunction(func)
-  }
-
-  /**
-   * @inheritDoc
-   */
-  sleep(_millis) {
-    throw new Error('sleep not implemented in test cafe')
-  }
-}
-
-exports.TestCafeExecutor = TestCafeExecutor