@testim/testim-cli 3.203.0 → 3.204.0

package/commons/getSessionPlayerRequire.js

@@ -1,10 +1,30 @@
-"use strict";
+'use strict';
 
 const perf = require('./performance-logger');
 
 perf.log('getSessionPlayerRequire start');
 const getSessionPlayerFolder = require('./prepareRunnerAndTestimStartUtils').getSessionPlayerFolder;
+
 const testimAppDataFolder = getSessionPlayerFolder();
-const sessionPlayer = require(require('path').join(testimAppDataFolder, "sessionPlayer.js"));
+/**
+ * @type {{
+        sessionPlayer: typeof import('../../../clickim/src/background/session/sessionPlayer').SessionPlayer;
+        utils: typeof import('../../../clickim/src/lib/utils').utils;
+        commonConstants: typeof import('../../../clickim/src/common/commonConstantsStrong');
+        locatorBuilderUtils: import('../../../clickim/src/locators/locatorBuilderUtils')['locatorBuilderUtils'];
+        assetService: import('../../../clickim/src/background/assetService')['assetService'];
+        localAssetService: import('../../../clickim/src/background/localAssetService');
+        urlUtils: import('../../../clickim/src/background/portMatch/urlUtils');
+        positionUtils: import('../../../clickim/src/lib/positionUtils');
+        visibilityUtils: import('../../../clickim/src/background/visibilityUtils');
+        apiCall: import('../../../clickim/src/common/playback/apiCall')['apiCall'];
+        stepParamBuilder: typeof import('../../../clickim/src/common/stepParamsBuilder').StepParamsBuilder;
+        stepParamExpressionEvaluator: import('../../../clickim/src/common/stepParamExpressionEvaluator');
+        manifestVersion: string | undefined;
+        EyeSdkBuilder: typeof import('../../../clickim/src/background/eyeSdkBuilder').EyeSdkBuilder
+    }}
+ */
+const sessionPlayer = require(require('path').join(testimAppDataFolder, 'sessionPlayer.js')); // eslint-disable-line import/no-dynamic-require
+
 module.exports = sessionPlayer;
 perf.log('getSessionPlayerRequire end');

package/lib/coralogix-winston.transport.js

@@ -16,7 +16,6 @@ const severityMap = {
 };
 
 class CoralogixTransport extends TransportStream {
-    static options;
     constructor(options) {
         options = Object.assign({}, CoralogixTransport.options, options);
         super(options);

package/npm-shrinkwrap.json

@@ -3554,9 +3554,9 @@
       "integrity": "sha512-GJCAeDBKfREgkBtgrYSf9hQy9kTb3helv0zGdzqhM7iAkW8FA/ZF97VQDbwFiwIT8MQLLOe5VlPZOEvZAqtUAQ=="
     },
     "electron-to-chromium": {
-      "version": "1.4.1",
-      "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.1.tgz",
-      "integrity": "sha512-9ldvb6QMHiDpUNF1iSwBTiTT0qXEN+xIO5WlCJrC5gt0z74ofOiqR698vaJqYWnri0XZiF0YmnrFmGq/EmpGAA==",
+      "version": "1.4.2",
+      "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.2.tgz",
+      "integrity": "sha512-SxHMmlSvpT83M/MLxTXQBqfqo3bK+UOk6Uup6w1paX86l+af1xwwTMLlyK3xJwE3Kq8/QnecuFKmnmRlAUJCXw==",
       "dev": true
     },
     "emoji-regex": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.203.0",
+  "version": "3.204.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{

package/player/stepActions/pixelValidationStepAction.js

@@ -12,17 +12,19 @@ class PixelValidationStepAction extends StepAction {
         const batchId = (config.batch && config.batch.id) || testResultId;
         const eyeManager = await eyeSdkService.getManager(shouldUseVisualGrid, this.context.config.applitoolsConcurrency || 5, batchId, this.runContext.applitoolsIntegrationData);
         const targetElementData = this.getTarget() || {};
+        let result;
         try {
             const openedEye = await eyeManager.openEyes({ driver: this.driver.client, config });
             const region = (this.step.action === 'element' && targetElementData.seleniumElement) || undefined;
             await openedEye.check({ settings: { region, fully: this.step.action === 'stitched' } });
             const eyesResults = await openedEye.close();
 
-            return { isApplitoolsSdkResult: true, success: true, eyesResults };
+            result = { isApplitoolsSdkResult: true, success: true, eyesResults };
         } catch (err) {
             logger.error('Applitools SDK step failed', { err, info: err.info });
-            return { isApplitoolsSdkResult: true, success: false, err };
+            result = { isApplitoolsSdkResult: true, success: false, err };
         }
+        return await eyeSdkService.handleApplitoolsSdkResult(this.context, result);
     }
 }
 

package/player/utils/eyeSdkService.js

@@ -1,9 +1,10 @@
-// https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-webdriverio-4/src/spec-driver.ts
-
 /**
- * @type {{ EyeSdkBuilder: typeof import('../../../../clickim/src/background/eyeSdkBuilder').EyeSdkBuilder }}
+ * @typedef {typeof import('../../../../clickim/src/background/eyeSdkBuilder').EyeSdkBuilder} EyeSdkBuilder
+ * @typedef {import('@applitools/types').SpecDriver} SpecDriver
+ * @typedef {import('@applitools/types').Core} Core
  */
-const sessionPlayer = require('../../commons/getSessionPlayerRequire');
+
+const { EyeSdkBuilder } = require('../../commons/getSessionPlayerRequire');
 const { makeSDK } = require('@applitools/eyes-sdk-core');
 const { W3C_ELEMENT_ID } = require('../constants');
 const _ = require('lodash');
@@ -31,7 +32,8 @@ function getValueOrFallbackIfNullOrUndefined(value, fallback) {
 }
 
 /**
- * @typedef {import('@applitools/types').SpecDriver} SpecDriver
+ * Applitools Spec Driver for webdriverIO 4.
+ * @see https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-webdriverio-4/src/spec-driver.ts
  * @implements {SpecDriver}
  */
 class EyesSpec {
@@ -215,20 +217,19 @@ class EyesSpec {
 
 class EyeSdkService {
     constructor() {
-        /**
-         * @typedef {import('@applitools/types').Core} Core
-         * @type {Core}
-         */
+        /** @type {Core} */
         this.sdk = makeSDK({
             name: 'Testim.io',
             version: '4.0.0',
             spec: new EyesSpec(),
             VisualGridClient: require('@applitools/visual-grid-client'),
         });
+        /** @type {EyeSdkBuilder['handleApplitoolsSdkResult']} */
+        this.handleApplitoolsSdkResult = EyeSdkBuilder.handleApplitoolsSdkResult;
     }
     async getManager(useVisualGrid, concurrency, batchId, applitoolsIntegrationData) {
         const manager = await this.sdk.makeManager({ type: useVisualGrid ? 'vg' : 'classic', concurrency });
-        sessionPlayer.EyeSdkBuilder.rememberCreatedBatch(batchId, applitoolsIntegrationData);
+        EyeSdkBuilder.rememberCreatedBatch(batchId, applitoolsIntegrationData);
         return manager;
     }
 }

package/runners/TestPlanRunner.js

@@ -83,15 +83,8 @@ class TestPlanRunner {
                 }
                 // When sessionPlayer is available, use it - as it only attempts to close batches that exist.
                 if (tpOptions.mode === constants.CLI_MODE.SELENIUM) {
-                    /**
-                     * @type {{ EyeSdkBuilder: typeof import('../../../clickim/src/background/eyeSdkBuilder').EyeSdkBuilder }}
-                     */
-                    const sessionPlayerInit = require('../commons/getSessionPlayerRequire');
-                    // TODO: remove once session player released.
-                    if (typeof sessionPlayerInit.EyeSdkBuilder.closeBatch !== 'function') {
-                        return;
-                    }
-                    await sessionPlayerInit.EyeSdkBuilder.closeBatch(executionId);
+                    const { EyeSdkBuilder } = require('../commons/getSessionPlayerRequire');
+                    await EyeSdkBuilder.closeBatch(executionId);
                     return;
                 }
                 try {