@applitools/eyes-cypress 3.22.3 → 3.22.7

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 ## Unreleased
 
 
+## 3.22.7 - 2021/11/7
+
+- replace legacy logger construction with new
+- Support running user defined run hooks in Cypress
+- Fix cypress tests not being cleaned up
+- Fix duplicate batch start/end events in cypress
+- updated to @applitools/dom-snapshot@4.5.10 (from 4.5.9)
+- updated to @applitools/visual-grid-client@15.8.43 (from 15.8.36)
+
+## 3.22.6 - 2021/10/18
+
+- updated to @applitools/dom-snapshot@4.5.9 (from 4.5.8)
+- updated to @applitools/visual-grid-client@15.8.36 (from 15.8.31)
+
+ ## 3.22.5 - 2021/9/29
+
+ - fix layout-breakpoints should not hit cypress timeout
+- updated to @applitools/dom-snapshot@4.5.8 (from 4.5.7)
+- updated to @applitools/visual-grid-client@15.8.31 (from 15.8.24)
+
+## 3.22.4 - 2021/9/7
+
+- Update README to include an example about region within shadow DOM
+- updated to @applitools/visual-grid-client@15.8.24 (from 15.8.21)
 
 ## 3.22.3 - 2021/8/16
 

package/README.md

@@ -187,6 +187,7 @@ Applitools will take screenshots and perform the visual comparisons in the backg
     - [strict](#strict)
     - [content](#content)
     - [accessibility](#accessibility)
+    - [region in shadow DOM](#region-in-shadow-dom)
     - [scriptHooks](#scriptHooks)
     - [layoutBreakpoints](#layoutBreakpoints)
     - [sendDom](#sendDom)
@@ -387,6 +388,24 @@ cy.eyesCheckWindow({
 
   Possible accessibilityType values are: `IgnoreContrast`,`RegularText`,`LargeText`,`BoldText` and `GraphicalObject`.
 
+##### `region in shadow DOM`
+
+When the target region is within shadow DOM, there is a need to specify the path to that region by passing an array of selectors. Each entry in the array should contain a `json` with the following entries: `type:css` ***only***, `selector` and `nodeType`. The element that contains the `shadowRoot` should be specified as `nodeType:'shadow-root'` and the final target region should contain `nodeType:'element'`
+
+```js
+cy.eyesCheckWindow({
+      target: 'region',
+      selector: [{
+        type: 'css',
+        selector: 'ContainShadowRoot' ,
+        nodeType: 'shadow-root'
+      },{
+        type: 'css',
+        selector: 'targetRegion',
+        nodeType: 'element'
+      }]
+    });
+```
 ##### `scriptHooks`
 
 (optional): A set of scripts to be run by the browser during the rendering. It is intended to be used as a means to alter the page's state and structure at the time of rendering.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.22.3",
+  "version": "3.22.7",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -35,12 +35,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/applitools/eyes.sdk.javascript1.git"
+    "url": "git://github.com/applitools/eyes.sdk.javascript1.git",
+    "directory": "packages/eyes-cypress"
   },
   "dependencies": {
-    "@applitools/dom-snapshot": "4.5.7",
+    "@applitools/dom-snapshot": "4.5.10",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/visual-grid-client": "15.8.21",
+    "@applitools/logger": "1.0.5",
+    "@applitools/visual-grid-client": "15.8.43",
     "body-parser": "1.19.0",
     "chalk": "3.0.0",
     "cors": "2.8.5",
@@ -49,10 +51,10 @@
   },
   "devDependencies": {
     "@applitools/scripts": "^1.0.1",
-    "@applitools/sdk-release-kit": "0.13.0",
-    "@applitools/sdk-shared": "0.9.5",
+    "@applitools/sdk-release-kit": "0.13.4",
+    "@applitools/sdk-shared": "0.9.7",
     "@applitools/snaptdout": "1.0.1",
-    "@applitools/test-server": "1.0.4",
+    "@applitools/test-server": "1.0.6",
     "chai": "^4.2.0",
     "chai-spies": "^1.0.0",
     "cookie-parser": "^1.4.4",

package/src/browser/commands.js

@@ -18,7 +18,7 @@ function getGlobalConfigProperty(prop) {
   const shouldParse = ['eyesBrowser', 'eyesLayoutBreakpoints'];
   return property ? (shouldParse.includes(prop) ? JSON.parse(property) : property) : undefined;
 }
-if (!getGlobalConfigProperty('eyesIsDisabled') && getGlobalConfigProperty('eyesLegacyHooks')) {
+if (!getGlobalConfigProperty('eyesIsDisabled') && getGlobalConfigProperty('isInteractive')) {
   const batchEnd = poll(() => {
     return sendRequest({command: 'batchEnd'});
   });

package/src/plugin/config.js

@@ -42,7 +42,6 @@ function makeConfig() {
     eyesFailCypressOnDiff:
       config.failCypressOnDiff === undefined ? true : !!config.failCypressOnDiff,
     eyesDisableBrowserFetching: !!config.disableBrowserFetching,
-    eyesLegacyHooks: true,
     eyesTestConcurrency: config.testConcurrency || DEFAULT_TEST_CONCURRENCY,
   };
 

package/src/plugin/hooks.js

@@ -4,41 +4,39 @@ const makeHandleBatchResultsFile = require('./makeHandleBatchResultsFile');
 const getErrorsAndDiffs = require('./getErrorsAndDiffs');
 const processCloseAndAbort = require('./processCloseAndAbort');
 const errorDigest = require('./errorDigest');
-const {tests} = require('./runningTests');
+const runningTests = require('./runningTests');
 
-function setGlobalRunHooks(on, {visualGridClient, logger, eyesConfig}) {
+function makeGlobalRunHooks({visualGridClient, logger}) {
   let waitForBatch;
 
-  on('before:run', ({config}) => {
-    const {isTextTerminal, eyesTestConcurrency: testConcurrency} = config;
-    // ugly but neccessary here - as this is the only place that cypress exposes the run mode on config
-    if (!isTextTerminal) return;
-    eyesConfig.eyesLegacyHooks = false;
+  return {
+    'before:run': ({config}) => {
+      const {isTextTerminal, eyesTestConcurrency: testConcurrency} = config;
+      if (!config.isTextTerminal) return;
 
-    waitForBatch = makeWaitForBatch({
-      logger: (logger.extend && logger.extend('waitForBatch')) || console,
-      testConcurrency,
-      processCloseAndAbort,
-      getErrorsAndDiffs,
-      errorDigest,
-      isInteractive: !isTextTerminal,
-      handleBatchResultsFile: makeHandleBatchResultsFile(config),
-    });
-  });
+      waitForBatch = makeWaitForBatch({
+        logger: (logger.extend && logger.extend('waitForBatch')) || console,
+        testConcurrency,
+        processCloseAndAbort,
+        getErrorsAndDiffs,
+        errorDigest,
+        isInteractive: !isTextTerminal,
+        handleBatchResultsFile: makeHandleBatchResultsFile(config),
+      });
+    },
 
-  on('after:run', async ({config}) => {
-    if (!config.isTextTerminal) return;
+    'after:run': async ({config}) => {
+      if (!config.isTextTerminal) return;
 
-    try {
-      // we rely on the fact that `runningTests.reset()` wasn't called
-      // so that tests that were added in `open` are available here (through `tests` in `runningTests.js`)
-      await waitForBatch(tests, visualGridClient.closeBatch);
-    } catch (e) {
-      if (!!config.eyesFailCypressOnDiff) {
-        throw e;
+      try {
+        await waitForBatch(runningTests.tests, visualGridClient.closeBatch);
+      } catch (e) {
+        if (!!config.eyesFailCypressOnDiff) {
+          throw e;
+        }
       }
-    }
-  });
+    },
+  };
 }
 
-module.exports = setGlobalRunHooks;
+module.exports = makeGlobalRunHooks;

package/src/plugin/pluginExport.js

@@ -1,22 +1,38 @@
 'use strict';
-const setGlobalRunHooks = require('./hooks');
 const shouldSetGlobalHooks = require('./shouldSetGlobalHooks');
+const {presult} = require('@applitools/functional-commons');
 
-function makePluginExport({startServer, eyesConfig, visualGridClient, logger}) {
+function makePluginExport({startServer, eyesConfig, globalHooks}) {
   return function pluginExport(pluginModule) {
     let closeEyesServer;
     const pluginModuleExports = pluginModule.exports;
     pluginModule.exports = async (...args) => {
       const {eyesPort, closeServer} = await startServer();
       closeEyesServer = closeServer;
-      const moduleExportsResult = await pluginModuleExports(...args);
-      const [on, config] = args;
+      const [origOn, config] = args;
+      const moduleExportsResult = await pluginModuleExports(onThatCallsUserDefinedHandler, config);
+      return Object.assign({}, eyesConfig, {eyesPort}, moduleExportsResult);
 
-      if (shouldSetGlobalHooks({...config, ...eyesConfig})) {
-        setGlobalRunHooks(on, {visualGridClient, logger, eyesConfig});
-      }
+      // This piece of code exists because at the point of writing, Cypress does not support multiple event handlers:
+      // https://github.com/cypress-io/cypress/issues/5240#issuecomment-948277554
+      // So we wrap Cypress' `on` function in order to wrap the user-defined handler. This way we can call our own handler
+      // in addition to the user's handler
+      function onThatCallsUserDefinedHandler(eventName, handler) {
+        const isRunEvent = eventName === 'before:run' || eventName === 'after:run';
+        const handlerToCall =
+          shouldSetGlobalHooks(config) && isRunEvent ? handlerThatCallsUserDefinedHandler : handler;
+        return origOn.call(this, eventName, handlerToCall);
 
-      return Object.assign({}, eyesConfig, {eyesPort}, moduleExportsResult);
+        async function handlerThatCallsUserDefinedHandler() {
+          const [err] = await presult(
+            Promise.resolve(globalHooks[eventName].apply(this, arguments)),
+          );
+          await handler.apply(this, arguments);
+          if (err) {
+            throw err;
+          }
+        }
+      }
     };
     return function getCloseServer() {
       return closeEyesServer;

package/src/plugin/runningTests.js

@@ -9,8 +9,10 @@ const runningTests = {
     this.tests = [];
   },
   async abortTests() {
+    const tests = this.tests;
+    this.reset();
     return Promise.all(
-      this.tests.map(async test => {
+      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;

package/src/plugin/startPlugin.js

@@ -1,5 +1,6 @@
 'use strict';
-const {makeVisualGridClient, Logger} = require('@applitools/visual-grid-client');
+const {makeVisualGridClient} = require('@applitools/visual-grid-client');
+const {makeLogger} = require('@applitools/logger');
 const makeStartServer = require('./server');
 const makePluginExport = require('./pluginExport');
 const {startApp} = require('./app');
@@ -8,13 +9,12 @@ const processCloseAndAbort = require('./processCloseAndAbort');
 const errorDigest = require('./errorDigest');
 const makeHandlers = require('./handlers');
 const makeConfig = require('./config');
+const makeGlobalRunHooks = require('./hooks');
 
 const {config, eyesConfig} = makeConfig();
-const logger = new Logger(config.showLogs, 'eyes');
+const logger = makeLogger({level: config.showLogs ? 'info' : 'silent', label: 'eyes'});
 
-const visualGridClient = makeVisualGridClient(
-  Object.assign(config, {logger: (logger.extend && logger.extend('vgc')) || logger}),
-);
+const visualGridClient = makeVisualGridClient({...config, logger: logger.extend('vgc')});
 
 const handlers = makeHandlers({
   logger,
@@ -25,8 +25,10 @@ const handlers = makeHandlers({
   errorDigest,
 });
 
+const globalHooks = makeGlobalRunHooks({visualGridClient, logger});
+
 const app = startApp({handlers, logger});
 const startServer = makeStartServer({app, logger});
 logger.log('eyes-cypress plugin running with config:', config);
 
-module.exports = makePluginExport({startServer, eyesConfig, visualGridClient, logger});
+module.exports = makePluginExport({startServer, eyesConfig, globalHooks});

package/test/fixtures/testAppCopies/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore