@applitools/eyes-cypress 3.23.7 → 3.24.0-beta.0

package/bin/eyes-setup.js

@@ -1,21 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-const chalk = require('chalk');
-const handlePlugin = require('../src/setup/handlePlugin');
-const handleCommands = require('../src/setup/handleCommands');
-const handleTypeScript = require('../src/setup/handleTypeScript');
-const {version} = require('../package');
-const cwd = process.cwd();
-
-console.log(chalk.cyan('Setup eyes-cypress', version));
-
-try {
-  handlePlugin(cwd);
-  handleCommands(cwd);
-  handleTypeScript(cwd);
-} catch (e) {
-  console.log(chalk.red('Setup error:\n', e));
-}
-
-console.log(chalk.cyan('Setup done!'));

package/src/browser/eyesCheckWindow.js

@@ -1,132 +0,0 @@
-/* global cy*/
-'use strict';
-
-const getAllBlobs = require('./getAllBlobs');
-const getBrowserInfo = require('./getBrowserInfo');
-
-function makeEyesCheckWindow({sendRequest, processPage, domSnapshotOptions, cypress = cy}) {
-  return function eyesCheckWindow(doc, args = {}) {
-    return takeDomSnapshots(domSnapshotOptions).then(snapshot => {
-      // console.log("%cDone taking snapshots!", "color:chartreuse");
-      return sendRequest({
-        command: 'checkWindow',
-        data: {
-          url: Array.isArray(snapshot) ? snapshot[0].url : snapshot.url,
-          snapshot,
-          ...args,
-        },
-      });
-    });
-
-    function takeDomSnapshots(options) {
-      const browser = args.browser;
-      const breakpoints = args.layoutBreakpoints;
-      const waitBeforeCapture = args.waitBeforeCapture ? args.waitBeforeCapture : 100;
-      const browsers = Array.isArray(browser) ? browser : [browser];
-
-      if (!breakpoints) {
-        //console.log('no breakpoints, taking single dom snapshot');
-        return cypress
-          .wrap({}, {log: false})
-          .wait(waitBeforeCapture)
-          .then({log: false, timeout: 900000}, () => {
-            return takeDomSnapshot(options);
-          });
-      }
-
-      return browsers
-        .reduce((widths, browser, index) => {
-          return widths.then(widthsMap => {
-            return getBrowserInfo(browser, sendRequest).then(({name, width}) => {
-              const requiredWidth = getBreakpointWidth(breakpoints, width);
-              let groupedBrowsers = widthsMap[requiredWidth];
-              if (!groupedBrowsers) {
-                groupedBrowsers = [];
-                widthsMap[requiredWidth] = groupedBrowsers;
-              }
-              groupedBrowsers.push({index, width, name});
-              return widthsMap;
-            });
-          });
-        }, cypress.wrap({}, {log: false}))
-        .then(requiredWidths => {
-          const {innerWidth: width, innerHeight: height} = doc.defaultView;
-          const snapshots = Array(browsers.length);
-          const requiredWidthsKeys = Object.keys(requiredWidths);
-          for (const requiredWidth of requiredWidthsKeys) {
-            const browsersInfo = requiredWidths[requiredWidth];
-            // console.log(`taking dom snapshot for width ${requiredWidth}`);
-            cypress
-              .viewport(Number(requiredWidth), height, {log: false})
-              .wait(waitBeforeCapture, {log: false})
-              .then({log: false, timeout: 900000}, () => {
-                return takeDomSnapshot(options).then(snapshot => {
-                  browsersInfo.forEach(({index}) => (snapshots[index] = snapshot));
-                });
-              });
-          }
-          return cypress
-            .viewport(width, height, {log: false})
-            .wait(0, {log: false})
-            .then(() => snapshots);
-        });
-    }
-
-    function takeDomSnapshot(options) {
-      // console.log(`take dom snapshot with ${doc.defaultView.innerWidth}`);
-      return processPage(Object.assign({doc}, options)).then(mainFrame => {
-        const allBlobs = getAllBlobs(mainFrame)
-          .filter(blob => !blob.errorStatusCode)
-          .map(mapBlob);
-        const snapshot = replaceBlobsWithBlobDataInFrame(mainFrame);
-        return Promise.all(allBlobs.map(putResource)).then(() => snapshot);
-
-        function putResource({url, value}) {
-          return sendRequest({
-            command: `resource/${encodeURIComponent(url)}`,
-            data: value,
-            method: 'PUT',
-            headers: {'Content-Type': 'application/octet-stream'},
-          }).catch(_e => {
-            snapshot.blobData.splice(
-              snapshot.blobData.findIndex(({url: blobUrl}) => blobUrl === url),
-              1,
-            );
-            snapshot.resourceUrls.push(url);
-          });
-        }
-      });
-    }
-
-    function getBreakpointWidth(breakpoints, width) {
-      if (!Array.isArray(breakpoints) || breakpoints.length === 0) return width;
-      const sortedBreakpoints = Array.from(new Set(breakpoints)).sort((a, b) => (a < b ? 1 : -1));
-      const breakpoint = sortedBreakpoints.find(sortedBreakpoint => width >= sortedBreakpoint);
-      return breakpoint || sortedBreakpoints[breakpoints.length - 1] - 1;
-    }
-  };
-}
-
-function replaceBlobsWithBlobDataInFrame({url, cdt, resourceUrls, blobs, frames}) {
-  return {
-    url,
-    cdt,
-    resourceUrls,
-    blobData: blobs.map(mapBlobData),
-    frames: frames.map(replaceBlobsWithBlobDataInFrame),
-  };
-}
-
-function mapBlobData(blob) {
-  if (blob.errorStatusCode) {
-    return {url: blob.url, errorStatusCode: blob.errorStatusCode};
-  } else {
-    return {url: blob.url, type: blob.type || 'application/x-applitools-unknown'};
-  }
-}
-
-function mapBlob({url, type, value}) {
-  return {url, type: type || 'application/x-applitools-unknown', value};
-}
-
-module.exports = makeEyesCheckWindow;

package/src/browser/getAllBlobs.js

@@ -1,14 +0,0 @@
-'use strict';
-
-function getAllBlobs(frame) {
-  return uniq([
-    ...frame.blobs,
-    ...frame.frames.reduce((acc, frame) => [...acc, ...getAllBlobs(frame)], []),
-  ]);
-}
-
-function uniq(arr) {
-  return Array.from(new Set(arr)).filter(x => !!x);
-}
-
-module.exports = getAllBlobs;

package/src/browser/getBrowserInfo.js

@@ -1,39 +0,0 @@
-function getBrowserInfo(browser, sendRequest) {
-  const isMobile =
-    browser.deviceName || browser.mobile || browser.iosDeviceInfo || browser.chromeEmulationInfo;
-  if (isMobile) {
-    const {deviceName, screenOrientation = 'portrait'} =
-      browser.iosDeviceInfo || browser.chromeEmulationInfo || browser;
-    const command = browser.iosDeviceInfo ? 'getIosDevicesSizes' : 'getEmulatedDevicesSizes';
-    return sendRequest({command}).then(devicesSizes => {
-      if (!devicesSizes.hasOwnProperty(deviceName)) {
-        handleDeviceError(browser);
-      }
-      const size = devicesSizes[deviceName][screenOrientation];
-      return {name: deviceName, ...size};
-    });
-  } else {
-    const {name, width} = browser;
-    return Promise.resolve({name, width});
-  }
-}
-
-function handleDeviceError(browser) {
-  const baseUrl =
-    'https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-sdk-core/lib/config';
-  const deviceName = browser.deviceName;
-  const category = browser.iosDeviceInfo
-    ? {
-        name: 'iOS',
-        url: `${baseUrl}/IosDeviceName.js`,
-      }
-    : {
-        name: 'emulated',
-        url: `${baseUrl}/DeviceName.js`,
-      };
-  throw new Error(
-    `'${deviceName}' does not exist in the list of ${category.name} devices.\nplease see the device list at: ${category.url}`,
-  );
-}
-
-module.exports = getBrowserInfo;

package/src/browser/makeHandleCypressViewport.js

@@ -1,22 +0,0 @@
-'use strict';
-
-const makeHandleCypressViewport = ({cy}) => {
-  return browser => {
-    let rv = cy;
-    if (Array.isArray(browser) && browser.length === 1) {
-      browser = browser[0];
-    }
-
-    if (
-      typeof browser === 'object' &&
-      browser !== null &&
-      browser.width !== undefined &&
-      browser.height !== undefined
-    ) {
-      rv = rv.viewport(browser.width, browser.height, {log: false});
-    }
-    return rv;
-  };
-};
-
-module.exports = makeHandleCypressViewport;

package/src/browser/poll.js

@@ -1,25 +0,0 @@
-'use strict';
-function poll(doWork) {
-  function doPoll(args) {
-    return doWork(args).then(result => {
-      if (result.status === 'WIP' || result.status === 'IDLE') {
-        return new Promise((resolve, reject) => {
-          setTimeout(() => {
-            doPoll(args).then(
-              results => resolve(results),
-              err => reject(err),
-            );
-          }, 1000);
-        });
-      } else if (result.status === 'DONE') {
-        return result.results;
-      } else {
-        throw new Error(result);
-      }
-    });
-  }
-
-  return doPoll;
-}
-
-module.exports = poll;

package/src/plugin/app.js

@@ -1,42 +0,0 @@
-'use strict';
-const express = require('express');
-const bodyParser = require('body-parser');
-const cors = require('cors');
-
-function startApp({handlers, logger = console} = {}) {
-  const app = express();
-  app.use(cors());
-  app.get('/hb', (_req, res) => res.sendStatus(200));
-  app.get('/err', (_req, res) => res.status(500).send('this is a test error'));
-
-  app.put('/eyes/resource/:id', bodyParser.raw({type: '*/*', limit: '100mb'}), async (req, res) => {
-    try {
-      if (!req.params || !req.params.id) throw new Error('missing resource url');
-      const id = req.params.id; // already decoded by express with decodeURIComponent
-      if (!(req.body instanceof Buffer)) throw new Error(`could not process resource ${id}`); // body-parser returned non-buffer body: https://github.com/expressjs/body-parser/blob/bd386d3a7d540bac90bbdaff88f653414f6647fc/lib/types/raw.js#L62
-      const buffer = req.body;
-      logger.log('[server] PUT resource:', id, buffer.length);
-      handlers.putResource(id, buffer);
-      res.status(200).send({success: true});
-    } catch (ex) {
-      logger.log('[server] error in PUT resource', req.params.id, ex);
-      res.status(200).send({success: false, error: ex.message});
-    }
-  });
-
-  app.post('/eyes/:command', express.json({limit: '100mb'}), async (req, res) => {
-    logger.log(`[server] eyes api: ${req.params.command}`, Object.keys(req.body));
-    try {
-      const result = await handlers[req.params.command](req.body);
-      res.set('Content-Type', 'application/json');
-      res.status(200).send({success: true, result});
-    } catch (ex) {
-      logger.log('[server] error in eyes api:', ex);
-      res.status(200).send({success: false, error: ex.message});
-    }
-  });
-
-  return app;
-}
-
-module.exports = {startApp};

package/src/plugin/handlers.js

@@ -1,205 +0,0 @@
-'use strict';
-const {presult} = require('@applitools/functional-commons');
-const pollingHandler = require('./pollingHandler');
-const makeWaitForBatch = require('./waitForBatch');
-const makeHandleBatchResultsFile = require('./makeHandleBatchResultsFile');
-const {GeneralUtils} = require('@applitools/visual-grid-client');
-const runningTests = require('./runningTests');
-
-function makeHandlers({
-  config = {},
-  visualGridClient,
-  logger = console,
-  processCloseAndAbort,
-  getErrorsAndDiffs,
-  errorDigest,
-}) {
-  logger.log('[handlers] creating handlers with the following config:', config);
-  let pollBatchEnd, checkWindow, close, resources, openErr;
-
-  return {
-    open: async args => {
-      try {
-        logger.log(`[handlers] open: close=${typeof close}, args=`, args);
-        args.accessibilitySettings = args.accessibilityValidation;
-        delete args.accessibilityValidation;
-        const eyes = await visualGridClient.openEyes(args);
-        const runningTest = {
-          abort: eyes.abort,
-          closePromise: undefined,
-        };
-        checkWindow = eyes.checkWindow;
-        close = makeClose(eyes.close, runningTest);
-        resources = {};
-        runningTests.add(runningTest);
-        logger.log('[handlers] open finished');
-        return eyes;
-      } catch (err) {
-        logger.log(`[handlers] openEyes error ${err}`);
-        openErr = err;
-        throw err;
-      }
-    },
-    batchStart: data => {
-      logger.log('[handlers] batchStart with data', data);
-      // this is due to Cypress' weird behavior of firing the event that triggers batchStart twice - once in the global hook, and once in cy.visit
-      runningTests.abortTests().catch(err => {
-        logger.log('error when aborting tests at the beginning of batchStart', err);
-      });
-      const {testConcurrency} = config;
-      const waitForBatch = makeWaitForBatch({
-        logger: (logger.extend && logger.extend('waitForBatch')) || logger,
-        testConcurrency,
-        processCloseAndAbort,
-        getErrorsAndDiffs,
-        errorDigest,
-        isInteractive: GeneralUtils.getPropertyByPath(data, 'isInteractive'),
-        handleBatchResultsFile: makeHandleBatchResultsFile(config),
-      });
-      pollBatchEnd = pollingHandler(
-        waitForBatch.bind(null, runningTests.tests, visualGridClient.closeBatch),
-      );
-      return visualGridClient;
-    },
-    getIosDevicesSizes: () => visualGridClient.getIosDevicesSizes(),
-    getEmulatedDevicesSizes: () => visualGridClient.getEmulatedDevicesSizes(),
-    batchEnd: async () => {
-      logger.log(`[handlers] batchEnd`);
-      return await pollBatchEnd();
-    },
-
-    putResource: (id, buffer) => {
-      if (!resources) {
-        throw new Error('Please call cy.eyesOpen() before calling cy.eyesCheckWindow()');
-      }
-      resources[id] = buffer;
-    },
-
-    checkWindow: async ({
-      url,
-      snapshot = {},
-      tag,
-      sizeMode,
-      target,
-      fully,
-      selector,
-      region,
-      scriptHooks,
-      ignore,
-      floating,
-      layout,
-      content,
-      strict,
-      sendDom,
-      useDom,
-      enablePatterns,
-      ignoreDisplacements,
-      accessibility,
-      matchLevel,
-      visualGridOptions,
-      variationGroupId,
-    }) => {
-      logger.log(`[handlers] checkWindow: checkWindow=${typeof checkWindow}`);
-      if (!checkWindow) {
-        throw new Error('Please call cy.eyesOpen() before calling cy.eyesCheckWindow()');
-      }
-
-      const snapshotsWithResourceContents = Array.isArray(snapshot)
-        ? snapshot.map(getSnapshotWithResourceContents)
-        : getSnapshotWithResourceContents(snapshot);
-
-      if (sizeMode) {
-        console.warn(
-          'WARNING! "sizeMode" is deprecated and will be removed in the future, please use target instead.',
-          '\nSee: https://github.com/applitools/eyes-cypress#target for more details.',
-        );
-      }
-
-      return await checkWindow({
-        url,
-        snapshot: snapshotsWithResourceContents,
-        tag,
-        sizeMode,
-        target,
-        fully,
-        selector,
-        region,
-        scriptHooks,
-        ignore,
-        floating,
-        layout,
-        content,
-        strict,
-        sendDom,
-        useDom,
-        enablePatterns,
-        ignoreDisplacements,
-        accessibility,
-        matchLevel,
-        visualGridOptions,
-        variationGroupId,
-      });
-    },
-
-    close: async () => {
-      logger.log(
-        `[handlers] close: openErr=${openErr}, close=${typeof close}, checkWindow=${typeof checkWindow}, resources=${
-          resources ? `count:${Object.keys(resources).length}` : resources
-        }`,
-      );
-      if (openErr) {
-        return;
-      }
-
-      if (!close) {
-        throw new Error('Please call cy.eyesOpen() before calling cy.eyesClose()');
-      }
-
-      // not returning this promise because we don't to wait on it before responding to the client
-      close();
-
-      resources = null;
-      close = null;
-      checkWindow = null;
-      openErr = null;
-    },
-  };
-
-  function makeClose(doClose, runningTest) {
-    return async function() {
-      return (runningTest.closePromise = presult(doClose(false)));
-    };
-  }
-
-  function getSnapshotWithResourceContents(snapshot) {
-    const target = {};
-    Object.assign(target, snapshot, {
-      resourceContents: blobDataToResourceContents(snapshot.blobData),
-      frames: createResourceContents(snapshot.frames),
-    });
-    delete target.blobData;
-    return target;
-  }
-
-  function createResourceContents(frames = []) {
-    return frames.map(frame => {
-      return {
-        url: frame.url,
-        cdt: frame.cdt,
-        resourceUrls: frame.resourceUrls,
-        resourceContents: blobDataToResourceContents(frame.blobData),
-        frames: frame.frames ? createResourceContents(frame.frames) : undefined,
-      };
-    });
-  }
-
-  function blobDataToResourceContents(blobData = []) {
-    return blobData.reduce((acc, {url, type, errorStatusCode}) => {
-      const data = errorStatusCode ? {url, errorStatusCode} : {url, type, value: resources[url]};
-      acc[url] = data;
-      return acc;
-    }, {});
-  }
-}
-
-module.exports = makeHandlers;

package/src/plugin/makeHandleBatchResultsFile.js

@@ -1,17 +0,0 @@
-const {TestResultsFormatter} = require('@applitools/visual-grid-client');
-const {resolve} = require('path');
-const {promisify} = require('util');
-const fs = require('fs');
-const writeFile = promisify(fs.writeFile);
-
-const makeHandleBatchResultsFile = config => {
-  if (!config.tapDirPath) return () => {};
-  return async function handleBatchResultsFile(results) {
-    const formatter = new TestResultsFormatter(results);
-    const fileName = config.tapFileName || `${new Date().toISOString()}-eyes.tap`;
-    const tapFile = resolve(config.tapDirPath, fileName);
-    await writeFile(tapFile, formatter.asHierarchicTAPString(false, true));
-  };
-};
-
-module.exports = makeHandleBatchResultsFile;

package/src/plugin/pollingHandler.js

@@ -1,46 +0,0 @@
-'use strict';
-const PollingStatus = {
-  IDLE: 'IDLE',
-  WIP: 'WIP',
-  DONE: 'DONE',
-  ERROR: 'ERROR',
-};
-
-function pollingHandler(doWork) {
-  let pollingStatus = PollingStatus.IDLE,
-    workError,
-    workResults;
-
-  return () => {
-    switch (pollingStatus) {
-      case PollingStatus.IDLE:
-        pollingStatus = PollingStatus.WIP;
-        doWork()
-          .then(results => {
-            pollingStatus = PollingStatus.DONE;
-            workResults = results;
-          })
-          .catch(ex => {
-            pollingStatus = PollingStatus.ERROR;
-            workError = ex;
-          });
-        return {status: PollingStatus.IDLE};
-      case PollingStatus.WIP:
-        return {status: PollingStatus.WIP};
-
-      case PollingStatus.DONE:
-        pollingStatus = PollingStatus.IDLE;
-        return {status: PollingStatus.DONE, results: workResults};
-
-      case PollingStatus.ERROR:
-        pollingStatus = PollingStatus.IDLE;
-        throw workError;
-
-      default:
-        throw new Error('Unknown error during cy.eyesClose()');
-    }
-  };
-}
-
-module.exports = pollingHandler;
-module.exports.PollingStatus = PollingStatus;

package/src/plugin/processCloseAndAbort.js

@@ -1,33 +0,0 @@
-'use strict';
-const {presult} = require('@applitools/functional-commons');
-
-async function processCloseAndAbort({runningTests, closeBatch, logger}) {
-  const closeAll = runningTests.map(async ({closePromise, abort}) => {
-    if (closePromise) {
-      const [closeErr, closeResult] = await closePromise;
-      if (closeErr) {
-        return (await abort()).map(testResult => {
-          if (testResult) {
-            testResult.error = closeErr;
-            return testResult;
-          } else {
-            return closeErr;
-          }
-        });
-      } else {
-        return closeResult;
-      }
-    } else {
-      return (await abort()).filter(x => !!x);
-    }
-  });
-
-  const results = await Promise.all(closeAll);
-  const [err] = await presult(closeBatch());
-  if (err) {
-    logger.log('failed to close batch', err);
-  }
-  return results;
-}
-
-module.exports = processCloseAndAbort;

package/src/plugin/runningTests.js

@@ -1,27 +0,0 @@
-'use strict';
-
-const runningTests = {
-  tests: [],
-  add(test) {
-    this.tests.push(test);
-  },
-  reset() {
-    this.tests = [];
-  },
-  async abortTests() {
-    const tests = this.tests;
-    this.reset();
-    return Promise.all(
-      tests.map(async test => {
-        if (test.closePromise) {
-          // this condition doesn't really happen in the code, but it's here for purity. This is used in handlers' batchStart in order to cleanup the state in case a zombie open was called.
-          await test.closePromise;
-        } else {
-          await test.abort();
-        }
-      }),
-    );
-  },
-};
-
-module.exports = runningTests;

package/src/plugin/waitForBatch.js

@@ -1,33 +0,0 @@
-'use strict';
-const {concurrencyMsg} = require('./concurrencyMsg');
-const flatten = require('lodash.flatten');
-
-function makeWaitForBatch({
-  logger,
-  testConcurrency,
-  processCloseAndAbort,
-  getErrorsAndDiffs,
-  errorDigest,
-  handleBatchResultsFile,
-  isInteractive,
-}) {
-  return async function(runningTests, closeBatch) {
-    logger.log(`Waiting for test results of ${runningTests.length} tests.`);
-
-    const testResultsArr = flatten(await processCloseAndAbort({runningTests, closeBatch, logger}));
-    const {failed, diffs, passed} = getErrorsAndDiffs(testResultsArr);
-    await handleBatchResultsFile(testResultsArr);
-
-    if (Number(testConcurrency) === 5) {
-      console.log(concurrencyMsg);
-    }
-
-    if (failed.length || diffs.length) {
-      throw new Error(errorDigest({passed, failed, diffs, logger, isInteractive}));
-    }
-
-    return passed.length;
-  };
-}
-
-module.exports = makeWaitForBatch;