@testim/testim-cli 3.264.0 → 3.266.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.264.0",
+  "version": "3.266.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{
@@ -43,8 +43,7 @@
     "multer": "1.4.4"
   },
   "dependencies": {
-    "@applitools/eyes-sdk-core": "13.6.23",
-    "@applitools/visual-grid-client": "15.12.34",
+    "@applitools/eyes-sdk-core": "13.11.21",
     "@testim/coralogix-logger": "1.1.27-beta.1",
     "@testim/webdriverio": "0.0.5",
     "abort-controller": "3.0.0",

package/player/stepActions/pixelValidationStepAction.js

@@ -3,11 +3,13 @@
 const _ = require('lodash');
 const StepAction = require('./stepAction');
 const { eyeSdkService } = require('../utils/eyeSdkService');
-const logger = require('../../commons/logger').getLogger('pixel-validation-step-action');
+const { getLogger } = require('../../commons/logger');
+
+const logger = getLogger('pixel-validation-step-action');
 
 class PixelValidationStepAction extends StepAction {
     async performAction() {
-        const { shouldUseVisualGrid, applitoolsSdkConfig: config, testResultId } = this.context;
+        const { shouldUseVisualGrid, applitoolsSdkConfig: config, applitoolsSdkLogger, testResultId } = this.context;
         this.runContext = this.context.getRunContext(undefined);
         const finalParams = this.runContext.incomingParams?.final || {};
         const batchId = config.batch?.id || testResultId;
@@ -15,10 +17,10 @@ class PixelValidationStepAction extends StepAction {
         const targetElementData = this.getTarget() || {};
         let result;
         try {
-            const openedEye = await eyeManager.openEyes({ driver: this.driver.client, config });
+            const openedEye = await eyeManager.openEyes({ driver: this.driver.client, config, logger: applitoolsSdkLogger });
             const region = (this.step.action === 'element' && targetElementData.seleniumElement) || undefined;
             const settings = { region, fully: this.step.action === 'stitched' };
-            if (finalParams.applitoolsStepSettings && _.isPlainObject(finalParams.applitoolsStepSettings)) {
+            if (_.isPlainObject(finalParams.applitoolsStepSettings)) {
                 Object.assign(settings, finalParams.applitoolsStepSettings);
                 logger.info('Applitools SDK step executed with applitoolsStepSettings parameter', { applitoolsStepSettings: finalParams.applitoolsStepSettings });
             }

package/player/utils/eyeSdkService.js

@@ -4,10 +4,10 @@
  * @typedef {import('@applitools/types').Core} Core
  */
 
-const { EyeSdkBuilder } = require('../../commons/getSessionPlayerRequire');
+const _ = require('lodash');
 const { makeSDK } = require('@applitools/eyes-sdk-core');
 const { W3C_ELEMENT_ID } = require('../constants');
-const _ = require('lodash');
+const { EyeSdkBuilder } = require('../../commons/getSessionPlayerRequire');
 
 let packageJson;
 // There is a difference in the folder structure in prod vs. dev
@@ -41,13 +41,6 @@ function extractElementId(element) {
     }
     return undefined;
 }
-/** implements the ?? capability for backward compatibility */
-function getValueOrFallbackIfNullOrUndefined(value, fallback) {
-    if (value === null || value === undefined) {
-        return fallback;
-    }
-    return value;
-}
 
 /**
  * Applitools Spec Driver for webdriverIO 4.
@@ -57,7 +50,7 @@ function getValueOrFallbackIfNullOrUndefined(value, fallback) {
 class EyesSpec {
     // #region UTILITY
     isDriver(driver) {
-        return Boolean(driver && driver.getPrototype && driver.desiredCapabilities && driver.requestHandler);
+        return Boolean(driver?.getPrototype && driver.desiredCapabilities && driver.requestHandler);
     }
 
     isElement(element) {
@@ -69,7 +62,7 @@ class EyesSpec {
     }
 
     isSelector(selector) {
-        return _.isString(selector);
+        return typeof selector === 'string';
     }
 
     transformDriver(driver) {
@@ -176,8 +169,8 @@ class EyesSpec {
             deviceName: desiredCapabilities.deviceName,
             platformName: desiredCapabilities.platformName || desiredCapabilities.platform,
             platformVersion: desiredCapabilities.platformVersion,
-            browserName: getValueOrFallbackIfNullOrUndefined(desiredCapabilities.browserName, desiredCapabilities.name),
-            browserVersion: getValueOrFallbackIfNullOrUndefined(desiredCapabilities.browserVersion, desiredCapabilities.version),
+            browserName: desiredCapabilities.browserName ?? desiredCapabilities.name,
+            browserVersion: desiredCapabilities.browserVersion ?? desiredCapabilities.version,
             pixelRatio: desiredCapabilities.pixelRatio,
         };
     }
@@ -209,7 +202,7 @@ class EyesSpec {
         if (this.isSelector(element)) {
             element = await this.findElement(driver, element);
         }
-        await driver.moveTo(extractElementId(element), offset && offset.x, offset && offset.y);
+        await driver.moveTo(extractElementId(element), offset?.x, offset?.y);
     }
 
     async type(driver, element, keys) {
@@ -242,7 +235,6 @@ class EyeSdkService {
             name: 'Testim.io',
             version: `4.0.0/eyes-sdk-core/${sdkVersion}`,
             spec: new EyesSpec(),
-            VisualGridClient: require('@applitools/visual-grid-client'),
         });
         /** @type {EyeSdkBuilder['handleApplitoolsSdkResult']} */
         this.handleApplitoolsSdkResult = EyeSdkBuilder.handleApplitoolsSdkResult;

package/runners/TestPlanRunner.js

@@ -106,7 +106,7 @@ class TestPlanRunner {
             /** @type {Awaited<ReturnType<typeof testimServicesApi['getApplitoolsIntegrationData']>>} */
             let applitoolsIntegrationData;
             try {
-                if (!tpOptions.company || !tpOptions.company.activePlan || !tpOptions.company.activePlan.premiumFeatures || !tpOptions.company.activePlan.premiumFeatures.applitools) {
+                if (!tpOptions.company?.activePlan?.premiumFeatures?.applitools) {
                     return;
                 }
                 applitoolsIntegrationData = await testimServicesApi.getApplitoolsIntegrationData(tpOptions.project);
@@ -115,7 +115,7 @@ class TestPlanRunner {
                 }
                 const { runKey: apiKey, url: serverUrl } = applitoolsIntegrationData;
                 const tmpSDK = require('@applitools/eyes-sdk-core').makeSDK({ name: 'Testim.io', version: '4.0.0', spec: {} });
-                await tmpSDK.closeBatches({ batchIds: [executionId], serverUrl, apiKey });
+                await tmpSDK.closeBatch({ settings: { batchId: executionId, serverUrl, apiKey } });
             } catch (err) {
                 // If a batch with this name did not exist, do not log an error.
                 if (err.message && (err.message.startsWith('Request failed with status code 404') || err.message.startsWith('no batchIds were set'))) {

package/utils/promiseUtils.js

@@ -39,9 +39,10 @@ function delay(time) {
  * @param {string=} errMsg
  */
 function promiseTimeout(promise, timeout, errMsg = 'Timeout Error') {
+    const timeoutErr = new TimeoutError(errMsg);
     return Promise.race([
         promise,
-        delay(timeout).then(() => { throw new TimeoutError(errMsg); }),
+        delay(timeout).then(() => { throw timeoutErr; }),
     ]);
 }