@applitools/eyes-cypress 3.22.7 → 3.22.8

package/CHANGELOG.md

@@ -3,6 +3,11 @@
 ## Unreleased
 
 
+## 3.22.8 - 2021/11/9
+
+- fix not calling the global hooks before:run and after:run at all, unless the user also called them in his plugins file.
+- fix not calling the browser hooks for Cypress versions < 6.2.0 (where global hooks are not supported).
+
 ## 3.22.7 - 2021/11/7
 
 - replace legacy logger construction with new

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.22.7",
+  "version": "3.22.8",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {

package/src/browser/commands.js

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

package/src/plugin/{shouldSetGlobalHooks.js → isGlobalHooksSupported.js}

@@ -1,7 +1,7 @@
 const CYPRESS_SUPPORTED_VERSION = '6.2.0';
 const CYPRESS_NO_FLAG_VERSION = '6.7.0';
 
-function shouldSetGlobalHooks(config) {
+function isGlobalHooksSupported(config) {
   const {version, experimentalRunEvents} = config;
 
   return (
@@ -10,4 +10,4 @@ function shouldSetGlobalHooks(config) {
   );
 }
 
-module.exports = shouldSetGlobalHooks;
+module.exports = isGlobalHooksSupported;

package/src/plugin/pluginExport.js

@@ -1,16 +1,23 @@
 'use strict';
-const shouldSetGlobalHooks = require('./shouldSetGlobalHooks');
+const isGlobalHooksSupported = require('./isGlobalHooksSupported');
 const {presult} = require('@applitools/functional-commons');
 
 function makePluginExport({startServer, eyesConfig, globalHooks}) {
   return function pluginExport(pluginModule) {
     let closeEyesServer;
     const pluginModuleExports = pluginModule.exports;
-    pluginModule.exports = async (...args) => {
+    pluginModule.exports = async function(...args) {
       const {eyesPort, closeServer} = await startServer();
       closeEyesServer = closeServer;
       const [origOn, config] = args;
+      let isGlobalHookCalledFromUserHandler = false;
+      eyesConfig.eyesIsGlobalHooksSupported = isGlobalHooksSupported(config);
       const moduleExportsResult = await pluginModuleExports(onThatCallsUserDefinedHandler, config);
+      if (eyesConfig.eyesIsGlobalHooksSupported && !isGlobalHookCalledFromUserHandler) {
+        for (const [eventName, eventHandler] of Object.entries(globalHooks)) {
+          origOn.call(this, eventName, eventHandler);
+        }
+      }
       return Object.assign({}, eyesConfig, {eyesPort}, moduleExportsResult);
 
       // This piece of code exists because at the point of writing, Cypress does not support multiple event handlers:
@@ -19,8 +26,11 @@ function makePluginExport({startServer, eyesConfig, globalHooks}) {
       // 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;
+        let handlerToCall = handler;
+        if (eyesConfig.eyesIsGlobalHooksSupported && isRunEvent) {
+          handlerToCall = handlerThatCallsUserDefinedHandler;
+          isGlobalHookCalledFromUserHandler = true;
+        }
         return origOn.call(this, eventName, handlerToCall);
 
         async function handlerThatCallsUserDefinedHandler() {