@applitools/eyes-cypress 3.40.6 → 3.41.0

package/CHANGELOG.md

@@ -1,5 +1,137 @@
 # Changelog
 
+## [3.41.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-cypress-v3.40.8...js/eyes-cypress@3.41.0) (2024-02-13)
+
+
+### Features
+
+* added notification about outdated sdk version ([#2012](https://github.com/applitools/eyes.sdk.javascript1/issues/2012)) ([0f0a646](https://github.com/applitools/eyes.sdk.javascript1/commit/0f0a6462a56e7c97f9a22173c3b63af91e220adb))
+
+
+### Bug Fixes
+
+* docs for eyes setup and concurrency message output ([#1953](https://github.com/applitools/eyes.sdk.javascript1/issues/1953)) ([13704da](https://github.com/applitools/eyes.sdk.javascript1/commit/13704dac39fa899c5e8bdb268539cd46aee5ccfb))
+* don't throw error for missing configuration file ([#2034](https://github.com/applitools/eyes.sdk.javascript1/issues/2034)) ([d084e7b](https://github.com/applitools/eyes.sdk.javascript1/commit/d084e7bf6e1727e3969622b4e597881f18241eb3))
+* fix mapping for iosVersion ([#1994](https://github.com/applitools/eyes.sdk.javascript1/issues/1994)) ([f499256](https://github.com/applitools/eyes.sdk.javascript1/commit/f499256a191927edc5583a2747cb22c4fa5b1c3b))
+* losing root context after layout breakpoints reload ([#2113](https://github.com/applitools/eyes.sdk.javascript1/issues/2113)) ([afa1473](https://github.com/applitools/eyes.sdk.javascript1/commit/afa14735e5539ab0f79aa610e6ec1ea8989a5922))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.7.17
+  #### Bug Fixes
+
+  * throw error for encoding none unicode char ([#2171](https://github.com/applitools/eyes.sdk.javascript1/issues/2171)) ([4edb9cf](https://github.com/applitools/eyes.sdk.javascript1/commit/4edb9cfb27d8db2ff4cb09c8ebf1b95ab020633d))
+* @applitools/spec-driver-webdriver bumped to 1.0.57
+  #### Bug Fixes
+
+  * fixed issue with cdp commands on chromium browsers ([#2180](https://github.com/applitools/eyes.sdk.javascript1/issues/2180)) ([550fc77](https://github.com/applitools/eyes.sdk.javascript1/commit/550fc772d3988aae29e6f4a1a11d2a408072dc38))
+* @applitools/spec-driver-puppeteer bumped to 1.4.0
+  #### Features
+
+  * added support for puppeteer >= 22 ([#2185](https://github.com/applitools/eyes.sdk.javascript1/issues/2185)) ([59d23a9](https://github.com/applitools/eyes.sdk.javascript1/commit/59d23a9689d77c7db06df53b67fa293a3b3f166e))
+* @applitools/nml-client bumped to 1.7.0
+  #### Features
+
+  * add support for regions and calculated regions ([#2161](https://github.com/applitools/eyes.sdk.javascript1/issues/2161)) ([fea4b1f](https://github.com/applitools/eyes.sdk.javascript1/commit/fea4b1fca3d8f59eada2b5186cd32d47352ccf1a))
+
+
+  #### Bug Fixes
+
+  * missing viewport when using system screenshot and multi viewport ([#2173](https://github.com/applitools/eyes.sdk.javascript1/issues/2173)) ([411283c](https://github.com/applitools/eyes.sdk.javascript1/commit/411283c7bebc09f178d73b6b47e81e5ce4244d5e))
+
+
+
+* @applitools/eyes bumped to 1.14.0
+  #### Features
+
+  * add Eyes.getResults method ([#2046](https://github.com/applitools/eyes.sdk.javascript1/issues/2046)) ([#2069](https://github.com/applitools/eyes.sdk.javascript1/issues/2069)) ([4d263e1](https://github.com/applitools/eyes.sdk.javascript1/commit/4d263e19cb5e5708790a1a7ef90ff8f3eee50d91))
+  * added `enableEyesLogs` configuration to the eyes service ([639ca8a](https://github.com/applitools/eyes.sdk.javascript1/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+  * added `useExecutionCloud` configuration to the eyes service ([#2033](https://github.com/applitools/eyes.sdk.javascript1/issues/2033)) ([639ca8a](https://github.com/applitools/eyes.sdk.javascript1/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+  * generate more enums ([#2179](https://github.com/applitools/eyes.sdk.javascript1/issues/2179)) ([5f4f916](https://github.com/applitools/eyes.sdk.javascript1/commit/5f4f91621b791a02464191123f69b12f590b9efe))
+
+
+  #### Bug Fixes
+
+  * error to unknown type in exception ([#2035](https://github.com/applitools/eyes.sdk.javascript1/issues/2035)) ([16d78c3](https://github.com/applitools/eyes.sdk.javascript1/commit/16d78c3cce90a5cb50cc2aa4e9ab6a58b7b93f89))
+  * fixed `serverUrl` configuration propagation ([247b7d8](https://github.com/applitools/eyes.sdk.javascript1/commit/247b7d88853dd1a9068d2d963582ad795752ace4))
+  * fixed default value in `useSystemScreenshot` method of check settings ([42a773c](https://github.com/applitools/eyes.sdk.javascript1/commit/42a773cc57e8e5de528a049b376159615892003b))
+  * fixed issue when w3c properties were added to legacy capabilities object in `Eyes.setMobileCapabilities` method ([94d785f](https://github.com/applitools/eyes.sdk.javascript1/commit/94d785f0428df101c207d6f09a55c46f2bdbf19e))
+
+
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/screenshoter bumped to 3.8.23
+
+* @applitools/ec-client bumped to 1.7.25
+
+* @applitools/core bumped to 4.8.0
+  #### Features
+
+  * add support for regions and calculated regions ([#2161](https://github.com/applitools/eyes.sdk.javascript1/issues/2161)) ([fea4b1f](https://github.com/applitools/eyes.sdk.javascript1/commit/fea4b1fca3d8f59eada2b5186cd32d47352ccf1a))
+
+
+  #### Bug Fixes
+
+  * missing viewport when using system screenshot and multi viewport ([#2173](https://github.com/applitools/eyes.sdk.javascript1/issues/2173)) ([411283c](https://github.com/applitools/eyes.sdk.javascript1/commit/411283c7bebc09f178d73b6b47e81e5ce4244d5e))
+  * nml coded region integration with universal ([6fb0934](https://github.com/applitools/eyes.sdk.javascript1/commit/6fb09348238dfe4698856f88e762a9abf80c686f))
+  * throw error for encoding none unicode char ([#2171](https://github.com/applitools/eyes.sdk.javascript1/issues/2171)) ([4edb9cf](https://github.com/applitools/eyes.sdk.javascript1/commit/4edb9cfb27d8db2ff4cb09c8ebf1b95ab020633d))
+
+
+
+
+## [3.40.7](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-cypress@3.40.6...js/eyes-cypress@3.40.7) (2024-01-30)
+
+
+### Bug Fixes
+
+* losing root context after layout breakpoints reload ([#2113](https://github.com/applitools/eyes.sdk.javascript1/issues/2113)) ([afa1473](https://github.com/applitools/eyes.sdk.javascript1/commit/afa14735e5539ab0f79aa610e6ec1ea8989a5922))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.4.25
+  #### Bug Fixes
+
+  * losing root context after layout breakpoints reload ([#2113](https://github.com/applitools/eyes.sdk.javascript1/issues/2113)) ([afa1473](https://github.com/applitools/eyes.sdk.javascript1/commit/afa14735e5539ab0f79aa610e6ec1ea8989a5922))
+* @applitools/driver bumped to 1.16.2
+  #### Bug Fixes
+
+  * losing root context after layout breakpoints reload ([#2113](https://github.com/applitools/eyes.sdk.javascript1/issues/2113)) ([afa1473](https://github.com/applitools/eyes.sdk.javascript1/commit/afa14735e5539ab0f79aa610e6ec1ea8989a5922))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.0.55
+
+* @applitools/spec-driver-selenium bumped to 1.5.69
+
+* @applitools/spec-driver-puppeteer bumped to 1.3.5
+
+* @applitools/screenshoter bumped to 3.8.21
+
+* @applitools/nml-client bumped to 1.6.5
+
+* @applitools/ec-client bumped to 1.7.23
+
+* @applitools/core bumped to 4.7.0
+  #### Features
+
+  * added support of proxy server url env var ([#2159](https://github.com/applitools/eyes.sdk.javascript1/issues/2159)) ([2f69c3d](https://github.com/applitools/eyes.sdk.javascript1/commit/2f69c3d37d7af9be1f459fd3d5f41b361161b5bf))
+
+
+  #### Bug Fixes
+
+  * losing root context after layout breakpoints reload ([#2113](https://github.com/applitools/eyes.sdk.javascript1/issues/2113)) ([afa1473](https://github.com/applitools/eyes.sdk.javascript1/commit/afa14735e5539ab0f79aa610e6ec1ea8989a5922))
+
+
+
+* @applitools/eyes bumped to 1.13.6
+
+
 ## [3.40.6](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-cypress@3.40.5...js/eyes-cypress@3.40.6) (2024-01-16)
 
 

package/dist/browser/spec-driver.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
+exports.reload = exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
 function executeScript(context, script, arg) {
     let scriptToExecute;
     if (script.includes('dom-snapshot') || script.includes('dom-capture') || script.includes('dom-shared')) {
@@ -12,7 +12,7 @@ function executeScript(context, script, arg) {
     }
     if (!context.defaultView) {
         // after reload the window is null
-        context = fallBackToMainContext();
+        context = mainContext();
     }
     const executor = new context.defaultView.Function('arg', scriptToExecute);
     return executor(arg);
@@ -20,7 +20,10 @@ function executeScript(context, script, arg) {
 exports.executeScript = executeScript;
 function mainContext() {
     //@ts-ignore
-    return cy.state('window').document;
+    const win = cy.state('window');
+    // after reload the marker may be lost
+    win.parent.document['applitools-marker'] = 'root-context';
+    return win.document;
 }
 exports.mainContext = mainContext;
 function parentContext(context) {
@@ -30,7 +33,7 @@ function parentContext(context) {
     }
     else if (!context.defaultView) {
         // after reload the window is null
-        return fallBackToMainContext();
+        return mainContext();
     }
     return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
 }
@@ -104,7 +107,7 @@ exports.getTitle = getTitle;
 function getUrl(context) {
     if (context && !context.location) {
         // after reload, the location is null
-        context = fallBackToMainContext();
+        context = mainContext();
     }
     return context.location.href;
 }
@@ -114,12 +117,14 @@ function getCookies() {
     return Cypress.automation('get:cookies', {});
 }
 exports.getCookies = getCookies;
-function fallBackToMainContext() {
-    const context = mainContext();
-    //@ts-ignore
-    context['applitools-marker'] = 'root-context';
-    return context;
+function reload() {
+    return new Promise(resolve => {
+        cy.once('window:load', resolve);
+        //@ts-ignore
+        return cy.state('window').location.reload();
+    });
 }
+exports.reload = reload;
 // export function takeScreenshot(page: Driver): Promise<Buffer>;
 // export function visit(page: Driver, url: string): Promise<void>; (??)
 // export function isStaleElementError(err: any): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.40.6",
+  "version": "3.41.0",
   "homepage": "https://applitools.com/docs/api-ref/sdk-api/cypress/",
   "license": "SEE LICENSE IN LICENSE",
   "main": "./index.js",
@@ -42,6 +42,7 @@
     "test:ts:run:13": "yarn cypress13 run --project ./test/e2e/ts --config-file ./cypress-13.config.ts",
     "test:ts:run": "yarn cypress$APPLITOOLS_FRAMEWORK_VERSION run --project ./test/e2e/ts --config-file ./cypress-$APPLITOOLS_FRAMEWORK_VERSION.config.ts",
     "test:coverage": "cd test/generic && yarn && MOCHA_GROUP=coverage APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run",
+    "test:coverage:chrome": "cd test/generic && yarn && MOCHA_GROUP=coverage APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-cypress' APPLITOOLS_BATCH_ID=$(uuidgen) npx cypress run --browser chrome",
     "test:e2e": "MOCHA_GROUP=e2e mkdir -p test/fixtures/testAppCopies && run --top-level mocha --no-timeouts --parallel --jobs ${MOCHA_JOBS:-2} 'test/e2e/**/*.test.js'",
     "test:components": "cd test/components && yarn && npx cypress run --component",
     "cypress": "cypress open --config-file test/fixtures/cypress-play.json",
@@ -53,8 +54,8 @@
     "setup": "run --top-level xvfb:setup"
   },
   "dependencies": {
-    "@applitools/core": "4.6.0",
-    "@applitools/eyes": "1.13.5",
+    "@applitools/core": "4.8.0",
+    "@applitools/eyes": "1.14.0",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "2.0.14",
     "@applitools/utils": "1.7.0",
@@ -66,8 +67,8 @@
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.22",
-    "@applitools/bongo": "^5.7.6",
-    "@applitools/generic": "^3.5.2",
+    "@applitools/bongo": "^5.10.0",
+    "@applitools/generic": "^3.9.1",
     "@applitools/snaptdout": "^1.0.1",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",

package/src/browser/commands.js

@@ -159,7 +159,6 @@ Cypress.Commands.add('eyesCheckWindow', (args = {}) =>
   cy.then({timeout: 86400000}, () => {
     if (isCurrentTestDisabled) return
 
-    setRootContext()
     const target = refer.ref(cy.state('window').document)
 
     Cypress.log({name: 'Eyes: check window'})
@@ -203,5 +202,5 @@ Cypress.Commands.add('debugHistory', async function () {
 })
 
 function setRootContext() {
-  cy.state('window').document['applitools-marker'] = 'root-context'
+  cy.state('window').parent.document['applitools-marker'] = 'root-context'
 }

package/src/browser/socketCommands.js

@@ -45,6 +45,10 @@ function socketCommands(socket, refer) {
     return await spec.getCookies()
   })
 
+  socket.command('Driver.reload', async () => {
+    await spec.reload()
+  })
+
   // utils
 
   function derefArgs(arg) {

package/src/browser/spec-driver.ts

@@ -13,7 +13,7 @@ export function executeScript(context: Context, script: string, arg: any): any {
   }
   if (!context.defaultView) {
     // after reload the window is null
-    context = fallBackToMainContext()
+    context = mainContext()
   }
   const executor = new context.defaultView.Function('arg', scriptToExecute)
   return executor(arg)
@@ -21,7 +21,10 @@ export function executeScript(context: Context, script: string, arg: any): any {
 
 export function mainContext(): Context {
   //@ts-ignore
-  return cy.state('window').document
+  const win = cy.state('window')
+  // after reload the marker may be lost
+  win.parent.document['applitools-marker'] = 'root-context'
+  return win.document
 }
 
 export function parentContext(context: Context): Context {
@@ -30,7 +33,7 @@ export function parentContext(context: Context): Context {
     throw new Error('Context is not accessible')
   } else if (!context.defaultView) {
     // after reload the window is null
-    return fallBackToMainContext()
+    return mainContext()
   }
 
   return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument
@@ -107,7 +110,7 @@ export function getTitle(context: Context): string {
 export function getUrl(context: Context): string {
   if (context && !context.location) {
     // after reload, the location is null
-    context = fallBackToMainContext()
+    context = mainContext()
   }
   return context.location.href
 }
@@ -117,11 +120,12 @@ export function getCookies(): Array<any> {
   return Cypress.automation('get:cookies', {})
 }
 
-function fallBackToMainContext(): Context {
-  const context = mainContext()
-  //@ts-ignore
-  context['applitools-marker'] = 'root-context'
-  return context
+export function reload(): Promise<void> {
+  return new Promise(resolve => {
+    cy.once('window:load', resolve)
+    //@ts-ignore
+    return cy.state('window').location.reload()
+  })
 }
 
 // export function takeScreenshot(page: Driver): Promise<Buffer>;