@testim/testim-cli 3.266.0 → 3.268.0

package/commons/socket/baseSocketServiceSocketIO.js

@@ -4,6 +4,7 @@ const Promise = require('bluebird');
 const pRetry = require('p-retry');
 const io = require('socket.io-client');
 const config = require('../config');
+const utils = require('../../utils');
 
 const MAX_SOCKET_RECONNECT_ATTEMPT = 50;
 const MAX_RECONNECT_ATTEMPT_BEFORE_SWITCH = 10;
@@ -15,7 +16,9 @@ const logger = require('../logger').getLogger('base socket service');
 class BaseSocketServiceSocketIO {
     constructor() {
         this.attempts = 0;
+        /** @type {{ [testResultId: string]: testId }} */
         this.rooms = {};
+        /** @type {undefined | Promise<void>} */
         this.emitPromiseQueue = undefined;
     }
 
@@ -28,10 +31,18 @@ class BaseSocketServiceSocketIO {
         });
     }
 
+    /**
+     * @param {string} resultId
+     * @param {string} testId
+     */
     joinRoom(resultId, testId) {
         this.rooms[resultId] = testId;
     }
 
+    /**
+     * @param {string} resultId
+     * @param {string} testId
+     */
     leaveRoom(resultId) {
         delete this.rooms[resultId];
     }
@@ -97,6 +108,10 @@ class BaseSocketServiceSocketIO {
         });
     }
 
+    /**
+     * @param {string} projectId
+     * @param {string} ns
+     */
     initNewSocket(projectId, ns) {
         const opts = {
             query: { projectId },
@@ -124,6 +139,10 @@ class BaseSocketServiceSocketIO {
         });
     }
 
+    /**
+     * @param {string} projectId
+     * @param {string} ns
+     */
     init(projectId, ns) {
         const opts = {
             query: { projectId },
@@ -146,6 +165,10 @@ class BaseSocketServiceSocketIO {
         this.addSocketHandlers();
     }
 
+    /**
+     * @param {string} eventName
+     * @param {*} eventData
+     */
     emitPromise(eventName, eventData) {
         const errorneousEvents = {};
 
@@ -158,10 +181,10 @@ class BaseSocketServiceSocketIO {
 
                 return reject(new Error('bad ack'));
             });
-        }).timeout(EMIT_PROMISE_TIMEOUT);
+        });
 
         this.emitPromiseQueue = (this.emitPromiseQueue || Promise.resolve())
-            .then(() => pRetry(emitAndWait, { retries: 200, minTimeout: 3000 }))
+            .then(() => pRetry(() => utils.promiseTimeout(emitAndWait(), EMIT_PROMISE_TIMEOUT), { retries: 200, minTimeout: 3000, factor: 1 }))
             .finally(() => {
                 if (Object.keys(errorneousEvents).length > 0) {
                     logger.error('Bad acknowledge from socket emit', { errorneousEvents });

package/commons/socket/testResultService.js

@@ -5,7 +5,6 @@ const { EventEmitter } = require('events');
 const featureFlags = require('../featureFlags');
 
 const { socketEventTypes } = require('../constants');
-const Promise = require('bluebird');
 
 class TestResultService extends EventEmitter {
     init(projectId) {

package/commons/testimDesiredCapabilitiesBuilder.js

@@ -561,11 +561,11 @@ function buildSeleniumOptions(browserOptions, testName, testRunConfig, gridInfo,
 }
 
 //testRunConfig not in used for now
-function buildAppiumOptions({ projectType, gridInfo, testRunConfig, nativeApp, options }) {
+function buildAppiumOptions({ projectType, gridInfo, testRunConfig, nativeApp, options, appPath }) {
     const { deviceModel, osVersion, deviceUdid } = options;
     const headspinSelector = {};
 
-    if (!nativeApp) {
+    if (!nativeApp && !appPath) {
         throw Error('missing mobile app!');
     }
     if (gridInfo.type !== gridTypes.TESTIM_HEADSPIN) {
@@ -578,21 +578,29 @@ function buildAppiumOptions({ projectType, gridInfo, testRunConfig, nativeApp, o
         path: `/v0/${gridInfo.accessToken}/wd/hub`,
     };
 
-    let appCaps = {};
+    let appCaps = {
+        'headspin:capture': true,
+    };
     switch (projectType) {
         case 'ios':
             appCaps = {
-                'appium:bundleId': nativeApp.id,
+                ...appCaps,
                 platformName: 'iOS',
                 'appium:automationName': 'XCUITest',
+                ...(nativeApp && { 'appium:bundleId': nativeApp.id }),
+                ...(appPath && { 'appium:app': appPath }),
             };
             break;
         case 'android':
             appCaps = {
+                ...appCaps,
                 platformName: 'Android',
                 'appium:automationName': 'UiAutomator2',
-                'appium:appPackage': nativeApp.packageName,
-                'appium:appActivity': nativeApp.activity,
+                ...(nativeApp && {
+                    'appium:appPackage': nativeApp.packageName,
+                    'appium:appActivity': nativeApp.activity,
+                }),
+                ...(appPath && { 'appium:app': appPath }),
             };
             break;
         default:
@@ -609,7 +617,6 @@ function buildAppiumOptions({ projectType, gridInfo, testRunConfig, nativeApp, o
         delete headspinSelector.model;
         delete headspinSelector.os_version;
     }
-
     if (!_.isEmpty(headspinSelector)) {
         appCaps['headspin:selector'] = headspinSelector;
     }

package/commons/testimServicesApi.js

@@ -237,6 +237,15 @@ function getSuiteTestList({
     }), { retries: DEFAULT_REQUEST_RETRY });
 }
 
+async function getAppDetails({ appId, projectId }) {
+    try {
+        return await pRetry(() => getWithAuth(`/mobile-app/app/${appId}?projectId=${projectId}`), { retries: DEFAULT_REQUEST_RETRY, factor: 1 });
+    } catch (error) {
+        logger.error('failed getting application details', { appId, error });
+        return undefined;
+    }
+}
+
 function getUsageForCurrentBillingPeriod(projectId) {
     return pRetry(() => getWithAuth(`/plan/project/${projectId}/usage-current-billing-period`), { retries: DEFAULT_REQUEST_RETRY })
         .catch((error) => {
@@ -395,10 +404,16 @@ function saveRemoteStep(projectId, resultId, stepId, remoteStep) {
     }), { retries: DEFAULT_REQUEST_RETRY });
 }
 
+/** @param {string} uri */
 function relativize(uri) {
     return uri.startsWith('/') ? uri : `/${uri}`;
 }
 
+/**
+ * @param {string} filePath
+ * @param {string} bucket
+ * @param {string} projectId
+ */
 function getStorageRelativePath(filePath, bucket, projectId) {
     let fullPath = relativize(filePath);
     if (projectId) {
@@ -411,7 +426,15 @@ function getStorageRelativePath(filePath, bucket, projectId) {
     return fullPath;
 }
 
-function uploadArtifact(projectId, testId, testResultId, content, subType, mimeType = 'application/octet-stream') {
+/**
+ * @param {string} projectId
+ * @param {string} testId
+ * @param {string} testResultId
+ * @param {*} content
+ * @param {string} subType
+ * @param {string} mimeType
+ */
+async function uploadArtifact(projectId, testId, testResultId, content, subType, mimeType = 'application/octet-stream') {
     let fileSuffix = null;
     if (mimeType === 'application/json') {
         fileSuffix = '.json';
@@ -431,9 +454,11 @@ function uploadArtifact(projectId, testId, testResultId, content, subType, mimeT
         },
     };
 
-    return pRetry(() => postAuthFormData(`/storage${storagePath}`, {}, files, {
-        'X-Asset-Encoding': 'gzip',
-    }), { retries: DEFAULT_REQUEST_RETRY }).then(() => storagePath);
+    await pRetry(
+        () => postAuthFormData(`/storage${storagePath}`, {}, files, { 'X-Asset-Encoding': 'gzip' }),
+        { retries: DEFAULT_REQUEST_RETRY, factor: 1 }
+    );
+    return storagePath;
 }
 
 const uploadRunDataArtifact = _.memoize(async (projectId, testId, testResultId, runData) => {
@@ -530,6 +555,7 @@ function updateRemoteRunFailure(body) {
 }
 
 module.exports = {
+    getAppDetails,
     getS3Artifact,
     getTestPlan,
     saveTestPlanResult,
@@ -553,7 +579,7 @@ module.exports = {
     saveRemoteStep,
     getEditorUrl,
     getLabFeaturesByProjectId,
-    uploadRunDataArtifact: Promise.method(uploadRunDataArtifact),
+    uploadRunDataArtifact,
     updateTestDataArtifact: Promise.method(updateTestDataArtifact),
     initializeUserWithAuth,
     addTestRetry,

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.266.0",
+  "version": "3.268.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@testim/testim-cli",
-      "version": "3.266.0",
+      "version": "3.268.0",
       "license": "Proprietary",
       "dependencies": {
         "@applitools/eyes-sdk-core": "13.11.21",
@@ -1460,9 +1460,9 @@
       }
     },
     "node_modules/@wdio/types/node_modules/@types/node": {
-      "version": "18.11.11",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-      "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+      "version": "18.11.13",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+      "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
     },
     "node_modules/@wdio/utils": {
       "version": "7.24.0",
@@ -4416,9 +4416,9 @@
       "integrity": "sha512-+iipnm2hvmlWs4MVNx7HwSTxhDxsXnQyK5F1OalZVXeUhdPgP/23T42NCyg0TK3wL/Yg92SVrSuGKqdg12o54w=="
     },
     "node_modules/devtools/node_modules/@types/node": {
-      "version": "18.11.11",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-      "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+      "version": "18.11.13",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+      "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
     },
     "node_modules/devtools/node_modules/ua-parser-js": {
       "version": "1.0.32",
@@ -6216,9 +6216,9 @@
       }
     },
     "node_modules/got": {
-      "version": "11.8.5",
-      "resolved": "https://registry.npmjs.org/got/-/got-11.8.5.tgz",
-      "integrity": "sha512-o0Je4NvQObAuZPHLFoRSkdG2lTgtcynqymzg2Vupdx6PorhaT5MCbIyXG6d4D94kk8ZG57QeosgdiqfJWhEhlQ==",
+      "version": "11.8.6",
+      "resolved": "https://registry.npmjs.org/got/-/got-11.8.6.tgz",
+      "integrity": "sha512-6tfZ91bOr7bOXnK7PRDCGBLa1H4U080YHNaAQ2KsMGlLEzRbk44nsZF2E1IeRc3vtJHPVbKCYgdFbaGO2ljd8g==",
       "dependencies": {
         "@sindresorhus/is": "^4.0.0",
         "@szmarczak/http-timer": "^4.0.5",
@@ -15393,9 +15393,9 @@
       }
     },
     "node_modules/vm2": {
-      "version": "3.9.12",
-      "resolved": "https://registry.npmjs.org/vm2/-/vm2-3.9.12.tgz",
-      "integrity": "sha512-OMmRsKh1gmdosFzuqmj6O43hqIStqXA24YbwjtUTO0TkOBP8yLNHLplbr4odnAzEcMnm9lt2r3R8kTivn8urMg==",
+      "version": "3.9.13",
+      "resolved": "https://registry.npmjs.org/vm2/-/vm2-3.9.13.tgz",
+      "integrity": "sha512-0rvxpB8P8Shm4wX2EKOiMp7H2zq+HUE/UwodY0pCZXs9IffIKZq6vUti5OgkVCTakKo9e/fgO4X1fkwfjWxE3Q==",
       "dependencies": {
         "acorn": "^8.7.0",
         "acorn-walk": "^8.2.0"
@@ -15468,9 +15468,9 @@
       }
     },
     "node_modules/webdriver/node_modules/@types/node": {
-      "version": "18.11.11",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-      "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+      "version": "18.11.13",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+      "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
     },
     "node_modules/webdriverio": {
       "version": "7.24.0",
@@ -15510,9 +15510,9 @@
       }
     },
     "node_modules/webdriverio/node_modules/@types/node": {
-      "version": "18.11.11",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-      "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+      "version": "18.11.13",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+      "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
     },
     "node_modules/webdriverio/node_modules/brace-expansion": {
       "version": "2.0.1",
@@ -17129,9 +17129,9 @@
       },
       "dependencies": {
         "@types/node": {
-          "version": "18.11.11",
-          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-          "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+          "version": "18.11.13",
+          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+          "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
         }
       }
     },
@@ -19496,9 +19496,9 @@
       },
       "dependencies": {
         "@types/node": {
-          "version": "18.11.11",
-          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-          "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+          "version": "18.11.13",
+          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+          "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
         },
         "ua-parser-js": {
           "version": "1.0.32",
@@ -20937,9 +20937,9 @@
       }
     },
     "got": {
-      "version": "11.8.5",
-      "resolved": "https://registry.npmjs.org/got/-/got-11.8.5.tgz",
-      "integrity": "sha512-o0Je4NvQObAuZPHLFoRSkdG2lTgtcynqymzg2Vupdx6PorhaT5MCbIyXG6d4D94kk8ZG57QeosgdiqfJWhEhlQ==",
+      "version": "11.8.6",
+      "resolved": "https://registry.npmjs.org/got/-/got-11.8.6.tgz",
+      "integrity": "sha512-6tfZ91bOr7bOXnK7PRDCGBLa1H4U080YHNaAQ2KsMGlLEzRbk44nsZF2E1IeRc3vtJHPVbKCYgdFbaGO2ljd8g==",
       "requires": {
         "@sindresorhus/is": "^4.0.0",
         "@szmarczak/http-timer": "^4.0.5",
@@ -27933,9 +27933,9 @@
       }
     },
     "vm2": {
-      "version": "3.9.12",
-      "resolved": "https://registry.npmjs.org/vm2/-/vm2-3.9.12.tgz",
-      "integrity": "sha512-OMmRsKh1gmdosFzuqmj6O43hqIStqXA24YbwjtUTO0TkOBP8yLNHLplbr4odnAzEcMnm9lt2r3R8kTivn8urMg==",
+      "version": "3.9.13",
+      "resolved": "https://registry.npmjs.org/vm2/-/vm2-3.9.13.tgz",
+      "integrity": "sha512-0rvxpB8P8Shm4wX2EKOiMp7H2zq+HUE/UwodY0pCZXs9IffIKZq6vUti5OgkVCTakKo9e/fgO4X1fkwfjWxE3Q==",
       "requires": {
         "acorn": "^8.7.0",
         "acorn-walk": "^8.2.0"
@@ -27994,9 +27994,9 @@
       },
       "dependencies": {
         "@types/node": {
-          "version": "18.11.11",
-          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-          "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+          "version": "18.11.13",
+          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+          "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
         }
       }
     },
@@ -28035,9 +28035,9 @@
       },
       "dependencies": {
         "@types/node": {
-          "version": "18.11.11",
-          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.11.tgz",
-          "integrity": "sha512-KJ021B1nlQUBLopzZmPBVuGU9un7WJd/W4ya7Ih02B4Uwky5Nja0yGYav2EfYIk0RR2Q9oVhf60S2XR1BCWJ2g=="
+          "version": "18.11.13",
+          "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.13.tgz",
+          "integrity": "sha512-IASpMGVcWpUsx5xBOrxMj7Bl8lqfuTY7FKAnPmu5cHkfQVWF8GulWS1jbRqA934qZL35xh5xN/+Xe/i26Bod4w=="
         },
         "brace-expansion": {
           "version": "2.0.1",

package/package.json

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

package/reports/consoleReporter.js

@@ -8,6 +8,8 @@ const featureAvailabilityService = require('../commons/featureAvailabilityServic
 const { getAbortedTests, getFailedTests, getPassedTests, getFailureEvaluatingCount, getSkippedCount } = require('./reporterUtils');
 
 const colorize = { success: chalk.green, warn: chalk.yellow, error: chalk.red };
+const { CLI_MODE } = constants;
+const DEVICE = 'device';
 
 class ConsoleReporter {
     constructor(options, branchToUse) {
@@ -143,13 +145,15 @@ class ConsoleReporter {
 
     onGetSlot(workerId, browser) {
         const gridNameOrId = this.options.grid || this.options.gridId;
+        const instanceType = this.options.mode === CLI_MODE.APPIUM ? DEVICE : browser;
         if (gridNameOrId) {
-            console.log(this.toWorkerIdPrefix(workerId), `Get ${chalk.underline(browser)} slot from ${chalk.underline(gridNameOrId)}`);
+            console.log(this.toWorkerIdPrefix(workerId), `Get ${chalk.underline(instanceType)} slot from ${chalk.underline(gridNameOrId)}`);
         }
     }
 
     onGetSession(workerId, testName, mode) {
-        console.log(this.toWorkerIdPrefix(workerId), `Get browser to run ${chalk.underline(testName)}`);
+        const instanceType = mode === CLI_MODE.APPIUM ? DEVICE : 'browser';
+        console.log(this.toWorkerIdPrefix(workerId), `Get ${instanceType} to run ${chalk.underline(testName)}`);
     }
 
     onWaitToTestStart(workerId) {

package/runOptions.d.ts

@@ -109,9 +109,10 @@ interface RunnerOptions extends Partial<Omit<TunnelOptions, 'tunnelOnlyMode' | '
     retries?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20;
 
     //# region mobile flags
-    deviceModel: string;
-    deviceUdid: string;
-    osVersion: string;
+    deviceModel?: string;
+    deviceUdid?: string;
+    osVersion?: string;
+    appId?: string;
     // #endregion
 
 

package/runOptions.js

@@ -220,6 +220,7 @@ program
     .option('--device-model [device-model]', 'The device model	to use, iPhone 12, Nexus 5X, SM-G900P etc....')
     .option('--device-udid [device-udid]', 'the device unique  id')
     .option('--os-version [os-version]', 'The operating system version number')
+    .option('--app-id [app-id]', 'The application id from app library on Testim Editor App')
 
     .option('-str --suppress-tms-reporting [suppress-tms-reporting]', 'disable test management reporting', false)
     .option('-tsr --tms-suppress-reporting [tms-suppress-reporting]', 'disable test management reporting', false)
@@ -1037,7 +1038,6 @@ module.exports = {
         if (program.deviceUdid && (program.deviceModel || program.osVersion)) {
             throw new ArgError('It is not possible to use --osVersion or  --deviceModel with  --device-udid. device-udid is unique and cannot be combined with another flag');
         }
-
         if (program.lightweightMode) {
             try {
                 const DEFAULTS = {
@@ -1154,10 +1154,11 @@ module.exports = {
             retentionDays: program.setRetention,
             passZeroTests: Boolean(program.passZeroTests),
             runQuarantinedTests: Boolean(program.runQuarantinedTests),
-
+            //Mobile-Flags
             deviceModel: program.deviceModel,
             deviceUdid: program.deviceUdid,
             osVersion: program.osVersion,
+            appId: program.appId,
 
             // Extension
             ext: program.ext,

package/runner.js

@@ -254,7 +254,7 @@ async function runRunner(options, customExtensionLocalLocation) {
         options.source = (useLocalChromeDriver || useChromeLauncher) ? 'cli-local' : 'cli';
     }
 
-    npmDriver.checkNpmVersion();
+    await npmDriver.checkNpmVersion();
     perf.log('in runner.js after checkNpmVersion');
 
     await validateCliAccount(options);

package/runners/ParallelWorkerManager.js

@@ -14,11 +14,18 @@ const { StopRunOnError } = require('../errors');
 
 require('../player/webdriver'); // preload
 
+/**
+ * @template {unknown[]} T
+ * @typedef {T extends [infer H, ...infer R] ? R : T} RemoveFirst
+ */
+
 class ParallelWorkerManager {
+    /** @param {string=} customExtensionLocalLocation */
     constructor(customExtensionLocalLocation) {
         this.customExtensionLocalLocation = customExtensionLocalLocation;
     }
 
+    /** @param {typeof CLI_MODE[keyof typeof CLI_MODE]} mode */
     getWorkerType(mode) {
         switch (mode) {
             case CLI_MODE.SELENIUM:
@@ -33,6 +40,12 @@ class ParallelWorkerManager {
         }
     }
 
+    /**
+     * @param {number} count
+     * @param {ExecutionQueue} queue
+     * @param {typeof CLI_MODE[keyof typeof CLI_MODE]} mode
+     * @param  {...RemoveFirst<ConstructorParameters<typeof import('../workers/BaseWorker')>>} args
+     */
     createWorkers(count, queue, mode, ...args) {
         const Worker = this.getWorkerType(mode);
         const createWorker = () => {
@@ -47,6 +60,17 @@ class ParallelWorkerManager {
         return Array.from(new Array(count), createWorker);
     }
 
+    /**
+     * @param {import('./TestPlanRunner').ExecutionList} testList
+     * @param {import('../testRunStatus')} testStatus
+     * @param {string} executionId
+     * @param {string} executionName
+     * @param {import('../runOptions').RunnerOptions} options
+     * @param {string} branchToUse
+     * @param {ReturnType<typeof testimCustomToken['getTokenV3UserData']>} authData
+     * @param {number} workerCount
+     * @param {boolean} stopOnError
+     */
     async runTests(testList, testStatus, executionId, executionName, options, branchToUse, authData, workerCount, stopOnError) {
         if (testList && testList.length === 0) {
             return undefined;
@@ -72,6 +96,13 @@ class ParallelWorkerManager {
             const lightweightMode = options.lightweightMode;
             const sessionType = utils.getSessionType(options);
 
+            /**
+             * @param {number} wid
+             * @param {string} testId
+             * @param {string} resultId
+             * @param {boolean | undefined} isRerun
+             * @param {`${number}:${number}`} testRetryKey
+             */
             const onTestStarted = (wid, testId, resultId, isRerun, testRetryKey) => {
                 runningTests++;
                 analyticsService.analyticsTestStart({
@@ -93,6 +124,13 @@ class ParallelWorkerManager {
                 return testStatus.testStartAndReport(wid, executionId, resultId, isRerun, testRetryKey);
             };
 
+            /**
+             * @param {number} wid
+             * @param {string} testId
+             * @param {*} testResult
+             * @param {string} sessionId
+             * @param {boolean | undefined} isRerun
+             */
             const onTestCompleted = async (wid, testId, testResult, sessionId, isRerun) => {
                 runningTests--;
                 const update = {};
@@ -135,7 +173,7 @@ class ParallelWorkerManager {
                     .catch(err => logger.error('testEndAndReport threw an error', { err }));
 
                 if (isRerun) {
-                    return undefined;
+                    return;
                 }
                 combinedTestResults[testResult.resultId] = testResult;
                 analyticsService.analyticsTestEnd({
@@ -163,11 +201,13 @@ class ParallelWorkerManager {
                 const completedTests = Object.keys(combinedTestResults).length;
                 if (completedTests === testCount || (stoppedOnError && runningTests === 0)) {
                     resolve(combinedTestResults);
-                    return undefined;
                 }
-                return undefined;
             };
 
+            /**
+             * @param {number} wid
+             * @param {{ name: string; testId: string; resultId: string; runnerStatus: 'SKIPPED'; testStatus: 'quarantine' }} testResult
+             */
             const onTestIgnored = (wid, testResult) => {
                 combinedTestResults[testResult.resultId] = testResult;
                 testStatus.onTestIgnored(wid, testResult.resultId);
@@ -178,7 +218,7 @@ class ParallelWorkerManager {
                 }
             };
 
-            const onGridSlot = (_executionId, resultId, gridInfo) => testStatus.onGridSlot(_executionId, resultId, gridInfo);
+            const onGridSlot = (resultId, gridInfo) => testStatus.onGridSlot(resultId, gridInfo);
 
             options.userData = {
                 loginData: Object.assign({}, testimCustomToken.getTokenV3UserData(), {
@@ -191,14 +231,24 @@ class ParallelWorkerManager {
                 servicesUrl: config.SERVICES_HOST,
             };
             perf.log('in localStrategy before createWorker');
-            this.createWorkers(workerCount, executionQueue, options.mode, options, this.customExtensionLocalLocation, executionId, onTestStarted, onTestCompleted, onGridSlot, onTestIgnored)
-                .forEach((worker, index) => {
-                    perf.log('before schedule worker.run after createWorkers');
-                    schedule(() => {
-                        perf.log('right before worker.run');
-                        worker.run();
-                    }, index);
-                });
+            this.createWorkers(
+                workerCount,
+                executionQueue,
+                options.mode,
+                options,
+                this.customExtensionLocalLocation,
+                executionId,
+                onTestStarted,
+                onTestCompleted,
+                onGridSlot,
+                onTestIgnored,
+            ).forEach((worker, index) => {
+                perf.log('before schedule worker.run after createWorkers');
+                schedule(() => {
+                    perf.log('right before worker.run');
+                    worker.run();
+                }, index);
+            });
         });
 
         try {
@@ -215,6 +265,10 @@ class ParallelWorkerManager {
     }
 }
 
+/**
+ * @param {Function} fn
+ * @param {number} index
+ */
 function schedule(fn, index) {
     if (index === 0) {
         fn();

package/runners/TestPlanRunner.js

@@ -26,9 +26,7 @@ const TDK_CHILD_RESULTS_TIMEOUT = 1000 * 60 * 5;
 /** @typedef {Awaited<ReturnType<typeof getSuite>>['tests'][number]} ExecutionList */
 
 class TestPlanRunner {
-    /**
-     * @param {string=} customExtensionLocalLocation
-     */
+    /** @param {string=} customExtensionLocalLocation */
     constructor(customExtensionLocalLocation) {
         this.workerManager = new ParallelWorkerManager(customExtensionLocalLocation);
         this.startTime = Date.now();
@@ -115,7 +113,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.closeBatch({ settings: { batchId: executionId, serverUrl, apiKey } });
+                await tmpSDK.closeBatches({ settings: { batchIds: [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'))) {