@testim/testim-cli 3.202.0 → 3.206.0

package/commons/featureFlags.js

@@ -54,6 +54,8 @@ class FeatureFlagsService {
             useSameBrowserForMultiTests: new LabFeatureFlag('labs'),
             highSpeedMode: new LabFeatureFlag(),
             usePortedHtml5DragDrop: new Rox.Flag(),
+            applitoolsNewIntegration: new Rox.Flag(),
+            testNamesToBeforeSuiteHook: new Rox.Flag(),
         };
         Rox.register('default', this.flags);
     }

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/commons/testimServicesApi.js

@@ -428,6 +428,19 @@ function addTestRetry({
     }), DEFAULT_REQUEST_RETRY);
 }
 
+/**
+ * @param {string} projectId
+ * @returns {Promise<import('../../../clickim/src/common/api/testimApplitoolsApi').ApplitoolsIntegrationData>}
+ */
+function getApplitoolsIntegrationData(projectId) {
+    try {
+        return getWithAuth(`/integration/applitools/v3/connected?projectId=${projectId}`);
+    } catch (err) {
+        logger.warn('could\'nt get applitools integration data.', { err });
+        return {};
+    }
+}
+
 module.exports = {
     getS3Artifact,
     getTestPlan,
@@ -459,4 +472,5 @@ module.exports = {
     getHybridGridProvider,
     loadTest,
     isTestResultCompleted,
+    getApplitoolsIntegrationData,
 };

package/lib/coralogix-winston.transport.js

@@ -15,8 +15,9 @@ const severityMap = {
     debug: Severity.debug,
 };
 
+const errorProps = ['err', 'error', 'reason', 'e'];
+
 class CoralogixTransport extends TransportStream {
-    static options;
     constructor(options) {
         options = Object.assign({}, CoralogixTransport.options, options);
         super(options);
@@ -59,26 +60,18 @@ class CoralogixTransport extends TransportStream {
                 meta.msg = `${msg}\n${meta.msg}`;
             }
         }
-        if (infoMeta.err instanceof Error) {
-            meta.err = {
-                message: infoMeta.err.message,
-                stack: infoMeta.err.stack,
-                name: infoMeta.err.name,
-                type: infoMeta.err.type,
-                cause: infoMeta.err.cause,
-                ...infoMeta.err,
-            };
-        }
 
-        if (infoMeta.reason instanceof Error) {
-            meta.reason = {
-                message: infoMeta.reason.message,
-                stack: infoMeta.reason.stack,
-                name: infoMeta.reason.name,
-                type: infoMeta.reason.type,
-                cause: infoMeta.reason.cause,
-                ...infoMeta.reason,
-            };
+        for (const prop of errorProps) {
+            if (infoMeta[prop] instanceof Error) {
+                meta[prop] = {
+                    message: infoMeta[prop].message,
+                    stack: infoMeta[prop].stack,
+                    name: infoMeta[prop].name,
+                    type: infoMeta[prop].type,
+                    cause: infoMeta[prop].cause,
+                    ...infoMeta[prop],
+                };
+            }
         }
 
         // still have keys after deleting the above

package/npm-shrinkwrap.json

@@ -2552,9 +2552,9 @@
       },
       "dependencies": {
         "@types/node": {
-          "version": "16.11.10",
-          "resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.10.tgz",
-          "integrity": "sha512-3aRnHa1KlOEEhJ6+CvyHKK5vE9BcLGjtUpwvqYLRvYNQKMfabu3BwfJaA/SLW8dxe28LsNDjtHwePTuzn3gmOA=="
+          "version": "16.11.11",
+          "resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.11.tgz",
+          "integrity": "sha512-KB0sixD67CeecHC33MYn+eYARkqTheIRNuu97y2XMjR7Wu3XibO1vaY6VBV6O/a89SPI81cEUIYT87UqUWlZNw=="
         },
         "mkdirp": {
           "version": "0.5.5",
@@ -2758,9 +2758,9 @@
       "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
     },
     "color-string": {
-      "version": "1.6.0",
-      "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.6.0.tgz",
-      "integrity": "sha512-c/hGS+kRWJutUBEngKKmk4iH3sD59MBkoxVapS/0wgpCz2u7XsNloxknyvBhzwEs1IbV36D9PwqLPJ2DTu3vMA==",
+      "version": "1.8.2",
+      "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.8.2.tgz",
+      "integrity": "sha512-w5ZkKRdLsc5NOYsmnpS2DpyRW71npwZGwbRpLrJTuqjfTs2Bhrba7UiV59IX9siBlCPl2pne5NtiwnVWUzvYFA==",
       "requires": {
         "color-name": "^1.0.0",
         "simple-swizzle": "^0.2.2"
@@ -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.7",
+      "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.7.tgz",
+      "integrity": "sha512-UPy2MsQw1OdcbxR7fvwWZH/rXcv+V26+uvQVHx0fGa1kqRfydtfOw+NMGAvZJ63hyaH4aEBxbhSEtqbpliSNWA==",
       "dev": true
     },
     "emoji-regex": {
@@ -6116,9 +6116,9 @@
       "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w=="
     },
     "json-schema": {
-      "version": "0.2.3",
-      "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz",
-      "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM="
+      "version": "0.4.0",
+      "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz",
+      "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA=="
     },
     "json-schema-traverse": {
       "version": "0.4.1",
@@ -6178,13 +6178,13 @@
       }
     },
     "jsprim": {
-      "version": "1.4.1",
-      "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz",
-      "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=",
+      "version": "1.4.2",
+      "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.2.tgz",
+      "integrity": "sha512-P2bSOMAc/ciLz6DzgjVlGJP9+BrJWu5UDGK70C2iweC5QBIeFf0ZXRvGjEj2uYgrY2MkAAhsSWHDWlFtEroZWw==",
       "requires": {
         "assert-plus": "1.0.0",
         "extsprintf": "1.3.0",
-        "json-schema": "0.2.3",
+        "json-schema": "0.4.0",
         "verror": "1.10.0"
       }
     },
@@ -12949,9 +12949,9 @@
       },
       "dependencies": {
         "debug": {
-          "version": "4.3.2",
-          "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.2.tgz",
-          "integrity": "sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==",
+          "version": "4.3.3",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz",
+          "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==",
           "requires": {
             "ms": "2.1.2"
           }

package/package.json

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

package/player/stepActions/pixelValidationStepAction.js

@@ -9,19 +9,22 @@ class PixelValidationStepAction extends StepAction {
     async performAction() {
         const { shouldUseVisualGrid, applitoolsSdkConfig: config, testResultId } = this.context;
         this.runContext = this.context.getRunContext(undefined);
-        const eyeManager = await eyeSdkService.getManager(shouldUseVisualGrid, this.context.config.applitoolsConcurrency || 5, testResultId);
+        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) {
+    async getManager(useVisualGrid, concurrency, batchId, applitoolsIntegrationData) {
         const manager = await this.sdk.makeManager({ type: useVisualGrid ? 'vg' : 'classic', concurrency });
-        sessionPlayer.EyeSdkBuilder.rememberCreatedBatch(batchId);
+        EyeSdkBuilder.rememberCreatedBatch(batchId, applitoolsIntegrationData);
         return manager;
     }
 }

package/runners/TestPlanRunner.js

@@ -19,6 +19,7 @@ const { getSuite, calcTestResultStatus, validateConfig } = require('./runnerUtil
 const { StopRunOnError, ArgError } = require('../errors');
 const Logger = require('../commons/logger');
 const perf = require('../commons/performance-logger');
+const featureFlags = require('../commons/featureFlags');
 
 const guid = utils.guid;
 const logger = Logger.getLogger('test-plan-runner');
@@ -75,6 +76,34 @@ class TestPlanRunner {
                     return catchBeforeTestsFailed(executionId);
                 }
                 throw err;
+            })
+            .finally(async () => {
+                if ((tpOptions.lightweightMode && tpOptions.lightweightMode.disablePixelValidation) || !featureFlags.flags.applitoolsNewIntegration.isEnabled()) {
+                    return;
+                }
+                // When sessionPlayer is available, use it - as it only attempts to close batches that exist.
+                if (tpOptions.mode === constants.CLI_MODE.SELENIUM) {
+                    const { EyeSdkBuilder } = require('../commons/getSessionPlayerRequire');
+                    await EyeSdkBuilder.closeBatch(executionId);
+                    return;
+                }
+                try {
+                    if (!tpOptions.company || !tpOptions.company.activePlan || !tpOptions.company.activePlan.premiumFeatures || !tpOptions.company.activePlan.premiumFeatures.applitools) {
+                        return;
+                    }
+                    const applitoolsIntegrationData = await testimServicesApi.getApplitoolsIntegrationData(tpOptions.project);
+                    if (_.isEmpty(applitoolsIntegrationData)) {
+                        return;
+                    }
+                    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 });
+                } catch (err) {
+                    if (err.message && err.message.startsWith('Request failed with status code 404')) { // If a batch with this name did not exist, do not log an error.
+                        return;
+                    }
+                    logger.error('Failed closing batch in extension mode', { err, projectId: tpOptions.project });
+                }
             });
     }
 
@@ -149,10 +178,11 @@ class TestPlanRunner {
         const configName = configs && configs.length === 1 ? configs[0] : null;
 
         const isCodeMode = tpOptions.files.length > 0;
+        const testNames = tpOptions.lightweightMode && tpOptions.lightweightMode.onlyTestIdsNoSuite ? [] : _.concat(beforeTests, tests, afterTests).map(test => test.name);
 
         const testListInfoPromise = tpOptions.lightweightMode && tpOptions.lightweightMode.onlyTestIdsNoSuite ?
             { beforeTests, tests, afterTests } :
-            testStatus.executionStart(executionId, projectId, this.startTime, testPlanName);
+            testStatus.executionStart(executionId, projectId, this.startTime, testPlanName, testNames);
         let childTestResults;
         if (isCodeMode) {
             childTestResults = Bluebird.try(async () => {

package/testRunStatus.js

@@ -15,6 +15,7 @@ const _ = require('lodash');
 const { registerExitHook } = require('./processHandler');
 const { calculateCoverage } = require('./coverage/jsCoverage');
 const featureAvailabilityService = require('./commons/featureAvailabilityService');
+const featureFlags = require('./commons/featureFlags');
 const { mapFilesToLocalDrive } = require('./services/localRCASaver');
 
 const gitBranch = utils.getEnvironmentGitBranch();
@@ -333,7 +334,7 @@ RunStatus.prototype.calcTestRunStatus = function () {
     }, {});
 };
 
-RunStatus.prototype.executionStart = function (executionId, projectId, startTime, testPlanName) {
+RunStatus.prototype.executionStart = function (executionId, projectId, startTime, testPlanName, testNames) {
     logger.info('execution started', { executionId });
     const { options } = this;
     const { remoteRunId, projectData } = options;
@@ -352,8 +353,11 @@ RunStatus.prototype.executionStart = function (executionId, projectId, startTime
     ]));
 
     this.startTime = startTime || Date.now();
-
-    return runHook(options.beforeSuite, { projectId, executionId })
+    const runHooksProps = { projectId, executionId };
+    if (featureFlags.flags.testNamesToBeforeSuiteHook.isEnabled()) {
+        runHooksProps.testNames = testNames;
+    }
+    return runHook(options.beforeSuite, runHooksProps)
         .then(params => {
             const overrideTestDataBuilder = new OverrideTestDataBuilder(params, _.cloneDeep(this.testInfoList), projectId);
             this.testInfoList = overrideTestDataBuilder.overrideTestData();