@applitools/eyes-webdriverio 5.49.4 → 5.50.0

package/CHANGELOG.md

@@ -1,5 +1,96 @@
 # Changelog
 
+## [5.50.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-webdriverio@5.49.4...js/eyes-webdriverio@5.50.0) (2023-11-21)
+
+
+### Features
+
+* 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))
+* 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))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.3
+  #### Bug Fixes
+
+  * 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))
+* @applitools/socket bumped to 1.1.13
+
+* @applitools/dom-snapshot bumped to 4.7.14
+  #### Bug Fixes
+
+  * preserve css declarations order in dom-snapshot ([#2037](https://github.com/applitools/eyes.sdk.javascript1/issues/2037)) ([1381851](https://github.com/applitools/eyes.sdk.javascript1/commit/1381851d46f28ea7e7724025c4eab33c81c4e144))
+* @applitools/spec-driver-webdriver bumped to 1.0.50
+  #### Bug Fixes
+
+  * send devtool commands in chromium ([#2039](https://github.com/applitools/eyes.sdk.javascript1/issues/2039)) ([ff42043](https://github.com/applitools/eyes.sdk.javascript1/commit/ff42043c3d9f110eb7b22ab1a8448d77859923b4))
+
+
+
+* @applitools/core bumped to 4.2.0
+  #### 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))
+  * log driver environment info to splank ([#2023](https://github.com/applitools/eyes.sdk.javascript1/issues/2023)) ([11d0546](https://github.com/applitools/eyes.sdk.javascript1/commit/11d0546e76962b4c231e140b0229b8402da27f69))
+
+
+  #### Bug Fixes
+
+  * return result when error in the ufg ([#2020](https://github.com/applitools/eyes.sdk.javascript1/issues/2020)) ([28cdcc5](https://github.com/applitools/eyes.sdk.javascript1/commit/28cdcc5a859641d0edde032165c5068fcc580c8d))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.5.64
+
+* @applitools/spec-driver-puppeteer bumped to 1.3.0
+  #### 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))
+
+
+
+* @applitools/screenshoter bumped to 3.8.16
+
+* @applitools/tunnel-client bumped to 1.3.1
+
+* @applitools/ec-client bumped to 1.7.16
+
+* @applitools/core-base bumped to 1.7.3
+  #### Bug Fixes
+
+  * remove connection timeout in case of a long running tasks ([#2006](https://github.com/applitools/eyes.sdk.javascript1/issues/2006)) ([49a596a](https://github.com/applitools/eyes.sdk.javascript1/commit/49a596ac1b022a66b5c07ecfee458cc061891ce0))
+  * return result when error in the ufg ([#2020](https://github.com/applitools/eyes.sdk.javascript1/issues/2020)) ([28cdcc5](https://github.com/applitools/eyes.sdk.javascript1/commit/28cdcc5a859641d0edde032165c5068fcc580c8d))
+
+
+
+* @applitools/eyes bumped to 1.12.0
+  #### Features
+
+  * 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))
+
+
+  #### 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))
+
+
+
+* @applitools/logger bumped to 2.0.13
+
+* @applitools/req bumped to 1.6.3
+
+* @applitools/image bumped to 1.1.8
+
+* @applitools/driver bumped to 1.15.1
+
+* @applitools/nml-client bumped to 1.5.16
+
+* @applitools/ufg-client bumped to 1.9.8
+
+
 ## [5.49.4](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-webdriverio@5.49.3...js/eyes-webdriverio@5.49.4) (2023-11-07)
 
 

package/dist/extract-environment.js

@@ -17,6 +17,14 @@ function extractEnvironment() {
     catch {
         // NOTE: ignore error
     }
-    return { versions };
+    let sdk = undefined;
+    try {
+        const { name, version } = require('../package.json');
+        sdk = { lang: 'js', name, currentVersion: version };
+    }
+    catch {
+        // NOTE: ignore error
+    }
+    return { versions, sdk };
 }
 exports.extractEnvironment = extractEnvironment;

package/dist/service.js

@@ -1,16 +1,5 @@
 "use strict";
-var _a;
 const api_1 = require("./api");
-if (!process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION) {
-    try {
-        const version = (_a = process.env.APPLITOOLS_FRAMEWORK_VERSION) !== null && _a !== void 0 ? _a : require('webdriverio/package.json').version;
-        const [major] = version.split('.', 1);
-        process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION = major;
-    }
-    catch {
-        // NOTE: ignore error
-    }
-}
 class EyesOverride extends api_1.Eyes {
 }
 EyesOverride._sdk = {
@@ -18,90 +7,102 @@ EyesOverride._sdk = {
     agentId: `eyes-webdriverio-service/${require('../package.json').version}`,
 };
 class EyesService {
-    constructor({ useVisualGrid, concurrency, eyes, ...config }) {
-        const wdioMajorVersion = Number(process.env.APPLITOOLS_FRAMEWORK_MAJOR_VERSION);
-        config = wdioMajorVersion < 6 ? { ...eyes } : config;
-        if (!useVisualGrid)
-            config.hideScrollbars = true;
-        this._eyes = new EyesOverride(useVisualGrid ? new api_1.VisualGridRunner({ testConcurrency: concurrency }) : new api_1.ClassicRunner(), config);
+    constructor(config) {
+        const { useExecutionCloud, useVisualGrid, concurrency, ...eyesConfig } = config;
+        this._config = { useExecutionCloud, useVisualGrid, concurrency };
+        this._eyes = new EyesOverride(this._config.useVisualGrid
+            ? new api_1.VisualGridRunner({ testConcurrency: this._config.concurrency })
+            : new api_1.ClassicRunner(), eyesConfig);
     }
     async _eyesOpen() {
-        if (!this._eyes.isOpen) {
-            this._testResults = undefined;
+        if (!this._eyes.isOpen)
             await this._eyes.open(browser);
-        }
     }
     async _eyesClose() {
-        if (this._eyes.isOpen) {
-            this._testResults = await this._eyes.close(false);
-        }
+        if (this._eyes.isOpen)
+            await this._eyes.closeAsync();
     }
-    beforeSession(config) {
-        this._appName = this._eyes.configuration.appName;
-        if (config.enableEyesLogs) {
+    async beforeSession(options) {
+        if (this._config.useExecutionCloud) {
+            const url = new URL(await this._eyes.getExecutionCloudUrl());
+            options.protocol = url.protocol ? url.protocol.replace(/:$/, '') : undefined;
+            options.hostname = url.hostname;
+            if (url.port)
+                options.port = Number(url.port);
+            else if (options.protocol === 'http')
+                options.port = 80;
+            else if (options.protocol === 'https')
+                options.port = 443;
+            options.path = url.pathname;
+        }
+        if (options.enableEyesLogs || this._config.enableEyesLogs) {
             this._eyes.setLogHandler({ type: 'console' });
         }
-    }
-    before() {
         browser.addCommand('getEyes', () => {
             return this._eyes;
         });
-        browser.addCommand('eyesCheck', async (title, checkSettings = { fully: true }) => {
+        browser.addCommand('eyesGetConfiguration', () => {
+            return this._eyes.getConfiguration();
+        });
+        browser.addCommand('eyesSetConfiguration', (configuration) => {
+            return this._eyes.setConfiguration(configuration);
+        });
+        browser.addCommand('eyesCheck', async (...args) => {
             await this._eyesOpen();
-            return this._eyes.check(title, checkSettings);
+            return this._eyes.check(...args);
+        });
+        browser.addCommand('eyesGetResults', async (throwErr) => {
+            await this._eyesClose();
+            return this._eyes.getResults(throwErr);
+        });
+        browser.addCommand('eyesGetAllTestResults', async (throwErr) => {
+            return this._eyes.runner.getAllTestResults(throwErr);
         });
-        // deprecated, alias of eyesCheck
+        // renamed
         browser.addCommand('eyesCheckWindow', async (...args) => {
             return browser.eyesCheck(...args);
         });
+        // renamed + improved
+        browser.addCommand('eyesGetTestResults', async () => {
+            const [result] = await browser.eyesGetResults();
+            return result;
+        });
+        // should be set through check settings or configuration
         browser.addCommand('eyesSetScrollRootElement', (element) => {
             this._eyes.getConfiguration().setScrollRootElement(element);
         });
+        // should be set through configuration
         browser.addCommand('eyesAddProperty', (key, value) => {
             this._eyes.getConfiguration().addProperty(key, value);
         });
+        // should be set through configuration
         browser.addCommand('eyesClearProperties', () => {
             this._eyes.getConfiguration().clearProperties();
         });
-        browser.addCommand('eyesGetTestResults', async () => {
-            // because `afterTest` executes after `afterEach`, this is the way to get results in `afterEach` or `it`
-            await this._eyesClose();
-            return this._testResults;
-        });
-        browser.addCommand('eyesSetConfiguration', (configuration) => {
-            return this._eyes.setConfiguration(configuration);
-        });
+        // useless
         browser.addCommand('eyesGetIsOpen', () => {
             return this._eyes.getIsOpen();
         });
-        browser.addCommand('eyesGetConfiguration', () => {
-            return this._eyes.getConfiguration();
-        });
-        browser.addCommand('eyesGetAllTestResults', async (throwErr) => {
-            return this._eyes.runner.getAllTestResults(throwErr);
-        });
     }
-    beforeTest(test) {
-        var _a, _b, _c;
-        const configuration = this._eyes.getConfiguration();
-        configuration.setTestName((_a = test.title) !== null && _a !== void 0 ? _a : test.description); // test.title is for mocha, and test.description is for jasmine
-        if (!this._appName) {
-            configuration.setAppName((_b = test.parent) !== null && _b !== void 0 ? _b : (_c = test.fullName) === null || _c === void 0 ? void 0 : _c.replace(` ${test.description}`, '')); // test.parent is for mocha, and test.id is for jasmine
-        }
-        if (!configuration.getViewportSize()) {
-            configuration.setViewportSize({ width: 800, height: 600 });
-        }
-        this._eyes.setConfiguration(configuration);
+    async before() {
+        var _a;
+        var _b;
+        (_a = (_b = this._eyes.configuration).viewportSize) !== null && _a !== void 0 ? _a : (_b.viewportSize = { width: 800, height: 600 });
+    }
+    async beforeTest(test) {
+        var _a, _b, _c, _d, _e;
+        var _f, _g;
+        (_a = (_f = this._eyes.configuration).appName) !== null && _a !== void 0 ? _a : (_f.appName = (_b = test.parent /* mocha */) !== null && _b !== void 0 ? _b : (_c = test.fullName) === null || _c === void 0 ? void 0 : _c.replace(` ${test.description}`, '')); /* jasmine */
+        (_d = (_g = this._eyes.configuration).testName) !== null && _d !== void 0 ? _d : (_g.testName = (_e = test.title /* mocha */) !== null && _e !== void 0 ? _e : test.description); /* jasmine */
     }
     async afterTest() {
-        // the next line is required because if we set an element in one test, then the following test
-        // will say that the element is not attached to the page (because different browsers are used)
-        this._eyes.getConfiguration().setScrollRootElement(null);
+        this._eyes.configuration.appName = undefined;
+        this._eyes.configuration.testName = undefined;
+        this._eyes.configuration.scrollRootElement = undefined;
         await this._eyesClose();
     }
     async after() {
         await this._eyes.runner.getAllTestResults(false);
-        await this._eyes.abort();
     }
 }
 module.exports = EyesService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-webdriverio",
-  "version": "5.49.4",
+  "version": "5.50.0",
   "description": "Applitools Eyes SDK for WebdriverIO",
   "keywords": [
     "eyes-webdriverio",
@@ -30,6 +30,9 @@
       "default": "./dist/service.js",
       "types": "./types/service.d.ts"
     },
+    "./v8": {
+      "types": "./types/v8.d.ts"
+    },
     "./v7": {
       "types": "./types/v7.d.ts"
     },
@@ -49,28 +52,6 @@
     "./types/*": "./dist/*.d.ts",
     "./package.json": "./package.json"
   },
-  "typesVersions": {
-    "*": {
-      "service": [
-        "./types/service.d.ts"
-      ],
-      "v7": [
-        "./types/v7.d.ts"
-      ],
-      "v6": [
-        "./types/v6.d.ts"
-      ],
-      "v5": [
-        "./types/v5-async.d.ts"
-      ],
-      "v5/async": [
-        "./types/v5-async.d.ts"
-      ],
-      "v5/sync": [
-        "./types/v5-sync.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "types"
@@ -84,19 +65,19 @@
     "test:local": "run test:it && run test:service && MOCHA_OMIT_TAGS=sauce run test:coverage",
     "test:local:cdp": "APPLITOOLS_FRAMEWORK_PROTOCOL=cdp run test:local",
     "test:sauce": "MOCHA_ONLY_TAGS=sauce run test:coverage",
-    "test:service": "MOCHA_GROUP=service run --top-level mocha './test/service/unit/*.spec.js' && wdio run ./test/service/wdio.conf.js --autoCompileOpts.autoCompile=0 && wdio run ./test/service/no-config/wdio.no-config.conf.js --autoCompileOpts.autoCompile=0 && wdio run ./test/service/vg/wdio.vg.conf.js --autoCompileOpts.autoCompile=0",
+    "test:service": "MOCHA_GROUP=service wdio run ./test/service/config/basic.config.js --autoCompileOpts.autoCompile=0 && wdio run ./test/service/config/ec.config.js --autoCompileOpts.autoCompile=0",
     "test:coverage": "APPLITOOLS_SHOW_LOGS=true APPLITOOLS_LOG_FILE=\"./logs/$(uuidgen).log\" APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-webdriverio' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage run --top-level mocha './test/generated-coverage/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
     "setup": "run --top-level browsers:setup",
     "up:framework": "echo \"$(jq '.devDependencies.webdriverio = $ENV.APPLITOOLS_FRAMEWORK_VERSION' ./package.json)\" > ./package.json"
   },
   "dependencies": {
-    "@applitools/driver": "1.15.0",
-    "@applitools/eyes": "1.11.4",
-    "@applitools/spec-driver-webdriver": "1.0.49"
+    "@applitools/driver": "1.15.1",
+    "@applitools/eyes": "1.12.0",
+    "@applitools/spec-driver-webdriver": "1.0.50"
   },
   "devDependencies": {
     "@applitools/api-extractor": "^1.2.22",
-    "@applitools/bongo": "^5.7.4",
+    "@applitools/bongo": "^5.7.6",
     "@applitools/generic": "^3.5.2",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^16.18.14",
@@ -105,6 +86,7 @@
     "@wdio/globals": "^8.14.3",
     "@wdio/local-runner": "^8.14.3",
     "@wdio/mocha-framework": "^8.14.0",
+    "@wdio/types": "^8.21.0",
     "devtools": "^8.15.4",
     "expect-webdriverio": "^4.0.1",
     "webdriverio": "^8.15.4"

package/types/index.d.ts

@@ -45,14 +45,7 @@ export class Eyes {
     open(appName?: undefined | string, testName?: undefined | string, viewportSize?: undefined | RectangleSizePlain, sessionType?: undefined | SessionTypePlain): Promise<void>;
     check(name: string, checkSettings: CheckSettingsAutomation): Promise<MatchResult>;
     check(name: string, checkSettings: CheckSettingsImage): Promise<MatchResult>;
-    check(target: {
-        image: string | URL | Buffer;
-        name?: undefined | string;
-        dom?: undefined | string;
-        locationInViewport?: undefined | LocationPlain;
-        locationInView?: undefined | LocationPlain;
-        fullViewSize?: undefined | RectangleSizePlain;
-    }, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
+    check(target: Image, checkSettings?: undefined | CheckSettingsImagePlain): Promise<MatchResult>;
     check(checkSettings?: undefined | CheckSettingsAutomationPlain): Promise<MatchResult>;
     checkWindow(name?: undefined | string, timeout?: undefined | number, fully?: undefined | boolean): Promise<MatchResult>;
     checkFrame(element: number, timeout?: undefined | number, name?: undefined | string): Promise<MatchResult>;
@@ -112,6 +105,7 @@ export class Eyes {
     abort(): Promise<TestResults>;
     abortAsync(): Promise<void>;
     abortIfNotClosed(): Promise<TestResultsPlain>;
+    getResults(throwErr?: undefined | boolean): Promise<Array<TestResults>>;
     getViewportSize(): Promise<RectangleSize>;
     setViewportSize(size: RectangleSizePlain): Promise<void>;
     getScrollRootElement(): Element | EyesSelector<Selector>;
@@ -1026,6 +1020,14 @@ export class BatchInfo implements Required<BatchInfoPlain> {
     addProperty(name: string, value: string): BatchInfo;
     addProperty(prop: PropertyDataPlain): BatchInfo;
 }
+export type Image = {
+    image: string | URL | Buffer;
+    name?: undefined | string;
+    dom?: undefined | string;
+    locationInViewport?: undefined | LocationPlain;
+    locationInView?: undefined | LocationPlain;
+    fullViewSize?: undefined | RectangleSizePlain;
+};
 export type CheckSettingsImagePlain = {
     name?: undefined | string;
     region?: undefined | RegionPlain;
@@ -1065,22 +1067,8 @@ export type CheckSettingsImagePlain = {
     densityMetrics?: undefined | { scaleRatio?: undefined | number; xdpi?: undefined | number; ydpi?: undefined | number; };
 };
 export class CheckSettingsImage {
-    constructor(settings?: undefined | CheckSettingsImage, target?: undefined | {
-        image: string | URL | Buffer;
-        name?: undefined | string;
-        dom?: undefined | string;
-        locationInViewport?: undefined | LocationPlain;
-        locationInView?: undefined | LocationPlain;
-        fullViewSize?: undefined | RectangleSizePlain;
-    });
-    constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | {
-        image: string | URL | Buffer;
-        name?: undefined | string;
-        dom?: undefined | string;
-        locationInViewport?: undefined | LocationPlain;
-        locationInView?: undefined | LocationPlain;
-        fullViewSize?: undefined | RectangleSizePlain;
-    });
+    constructor(settings?: undefined | CheckSettingsImage, target?: undefined | Image);
+    constructor(settings?: undefined | CheckSettingsImagePlain, target?: undefined | Image);
     image(image: string): CheckSettingsImage;
     image(image: URL): CheckSettingsImage;
     image(image: Buffer): CheckSettingsImage;

package/types/service.d.ts

@@ -1,20 +1,49 @@
-import { ConfigurationPlain } from './api';
-interface EyesServiceOptions extends ConfigurationPlain {
-    useVisualGrid?: boolean;
-    concurrency?: number;
-    eyes?: EyesServiceOptions;
+import type {
+  Element,
+  Selector,
+  Eyes,
+  ConfigurationPlain,
+  Configuration,
+  Image,
+  CheckSettingsImage,
+  CheckSettingsAutomation,
+  CheckSettingsImagePlain,
+  CheckSettingsAutomationPlain,
+  TestResults,
+  TestResultsSummary,
+} from './index'
+    
+declare global {
+  namespace WebdriverIO {
+    interface ServiceOption extends ConfigurationPlain {
+      useExecutionCloud?: boolean
+      useVisualGrid?: boolean
+      concurrency?: number
+      enableEyesLogs?: boolean
+      /** @deprecated */
+      eyes?: ServiceOption
+    }
+
+    interface Browser {
+      getEyes(): Eyes
+      eyesGetConfiguration(): Configuration
+      eyesSetConfiguration(configuration: ConfigurationPlain): void
+      eyesCheck(name: string, checkSettings: CheckSettingsImage | CheckSettingsAutomation): Promise<void>
+      eyesCheck(target: Image, checkSettings?: CheckSettingsImagePlain): Promise<void>
+      eyesCheck(checkSettings?: CheckSettingsAutomationPlain): Promise<void>
+      eyesGetResults(throwErr: boolean): Promise<TestResults[]>
+      eyesGetAllTestResults(throwErr: boolean): Promise<TestResultsSummary>
+      
+      /** @deprecated */
+      eyesGetIsOpen(): boolean
+      /** @deprecated */
+      eyesSetScrollRootElement(element: Element | Selector): void
+      /** @deprecated */
+      eyesAddProperty(key: string, value: string): void
+      /** @deprecated */
+      eyesClearProperties(): void
+      /** @deprecated */
+      eyesGetTestResults(throwErr: boolean): Promise<TestResults>
+    }
+  }
 }
-declare class EyesService {
-    private _eyes;
-    private _appName?;
-    private _testResults?;
-    constructor({ useVisualGrid, concurrency, eyes, ...config }: EyesServiceOptions);
-    private _eyesOpen;
-    private _eyesClose;
-    beforeSession(config: Record<string, unknown>): void;
-    before(): void;
-    beforeTest(test: any): void;
-    afterTest(): Promise<void>;
-    after(): Promise<void>;
-}
-export = EyesService;