@testim/testim-cli 3.202.0 → 3.203.0

package/commons/featureFlags.js

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

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/package.json

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

package/player/stepActions/pixelValidationStepAction.js

@@ -9,7 +9,8 @@ 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() || {};
         try {
             const openedEye = await eyeManager.openEyes({ driver: this.driver.client, config });

package/player/utils/eyeSdkService.js

@@ -226,9 +226,9 @@ class EyeSdkService {
             VisualGridClient: require('@applitools/visual-grid-client'),
         });
     }
-    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);
+        sessionPlayer.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,41 @@ 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) {
+                    /**
+                     * @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);
+                    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 });
+                }
             });
     }