@applitools/eyes-browser 1.2.3 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,85 @@
 # Changelog
 
+## [1.3.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.3.0...js/eyes-browser@1.3.1) (2024-04-01)
+
+
+### Dependencies
+
+* @applitools/spec-driver-selenium bumped to 1.5.74
+  #### Bug Fixes
+
+  * trigger JS release ([6022ac8](https://github.com/Applitools-Dev/sdk/commit/6022ac85626287a37101b65732e9d46c63bbd8b8))
+* @applitools/ec-client bumped to 1.7.32
+
+* @applitools/core-base bumped to 1.10.1
+  #### Bug Fixes
+
+  * trigger JS release ([6022ac8](https://github.com/Applitools-Dev/sdk/commit/6022ac85626287a37101b65732e9d46c63bbd8b8))
+* @applitools/core bumped to 4.11.1
+
+* @applitools/eyes bumped to 1.17.1
+  #### Bug Fixes
+
+  * trigger JS release ([6022ac8](https://github.com/Applitools-Dev/sdk/commit/6022ac85626287a37101b65732e9d46c63bbd8b8))
+
+
+
+
+## [1.3.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser-v1.2.4...js/eyes-browser@1.3.0) (2024-03-31)
+
+
+### Features
+
+* add support for browser in eyes ([#2054](https://github.com/Applitools-Dev/sdk/issues/2054)) ([4af82dd](https://github.com/Applitools-Dev/sdk/commit/4af82dd2a667c13adfed0be98a026181755256c6))
+
+
+### Dependencies
+
+* @applitools/spec-driver-selenium bumped to 1.5.73
+  #### Bug Fixes
+
+  * remove getSessionDetails call in JS Selenium ([#2280](https://github.com/Applitools-Dev/sdk/issues/2280)) ([d15748f](https://github.com/Applitools-Dev/sdk/commit/d15748f68c931f2f84c13efd8472399c1ff72e25))
+* @applitools/ec-client bumped to 1.7.31
+
+* @applitools/core-base bumped to 1.10.0
+  #### Features
+
+  * Add GitMergeBaseTimestamp support ([#2281](https://github.com/Applitools-Dev/sdk/issues/2281)) ([5489608](https://github.com/Applitools-Dev/sdk/commit/54896085445663a51b5e5595a2517e48fa8736f3))
+  * batch buildId ([#2263](https://github.com/Applitools-Dev/sdk/issues/2263)) ([f19ac38](https://github.com/Applitools-Dev/sdk/commit/f19ac38612bc55d870f59161a39b5b7eb01e25f3))
+  * send heartbeat to keep test alive ([#2246](https://github.com/Applitools-Dev/sdk/issues/2246)) ([58636e7](https://github.com/Applitools-Dev/sdk/commit/58636e7dd353f06eb2b3bee1120ab81c3f9fcc94))
+
+
+  #### Bug Fixes
+
+  * retry Eyes request on ECONNREFUSED to improve stability during deployment ([d1e4dca](https://github.com/Applitools-Dev/sdk/commit/d1e4dcae79185578808b4f2c5f94fa79d7d914a3))
+* @applitools/core bumped to 4.11.0
+  #### Features
+
+  * Add GitMergeBaseTimestamp support ([#2281](https://github.com/Applitools-Dev/sdk/issues/2281)) ([5489608](https://github.com/Applitools-Dev/sdk/commit/54896085445663a51b5e5595a2517e48fa8736f3))
+  * batch buildId ([#2263](https://github.com/Applitools-Dev/sdk/issues/2263)) ([f19ac38](https://github.com/Applitools-Dev/sdk/commit/f19ac38612bc55d870f59161a39b5b7eb01e25f3))
+
+
+
+* @applitools/eyes bumped to 1.17.0
+  #### Features
+
+  * add Eyes.getResults method ([#2046](https://github.com/Applitools-Dev/sdk/issues/2046)) ([#2069](https://github.com/Applitools-Dev/sdk/issues/2069)) ([4d263e1](https://github.com/Applitools-Dev/sdk/commit/4d263e19cb5e5708790a1a7ef90ff8f3eee50d91))
+  * Add GitMergeBaseTimestamp support ([#2281](https://github.com/Applitools-Dev/sdk/issues/2281)) ([5489608](https://github.com/Applitools-Dev/sdk/commit/54896085445663a51b5e5595a2517e48fa8736f3))
+  * added `enableEyesLogs` configuration to the eyes service ([639ca8a](https://github.com/Applitools-Dev/sdk/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+  * added `useExecutionCloud` configuration to the eyes service ([#2033](https://github.com/Applitools-Dev/sdk/issues/2033)) ([639ca8a](https://github.com/Applitools-Dev/sdk/commit/639ca8a021008d06fc09d19ca58ac3d00a18e4c3))
+  * generate more enums ([#2179](https://github.com/Applitools-Dev/sdk/issues/2179)) ([5f4f916](https://github.com/Applitools-Dev/sdk/commit/5f4f91621b791a02464191123f69b12f590b9efe))
+  * ios multi device target ([#2160](https://github.com/Applitools-Dev/sdk/issues/2160)) ([3874fb8](https://github.com/Applitools-Dev/sdk/commit/3874fb8ad77039abbb5ab78c00ffb45829b2db28))
+
+
+  #### Bug Fixes
+
+  * error to unknown type in exception ([#2035](https://github.com/Applitools-Dev/sdk/issues/2035)) ([16d78c3](https://github.com/Applitools-Dev/sdk/commit/16d78c3cce90a5cb50cc2aa4e9ab6a58b7b93f89))
+  * fixed default value in `useSystemScreenshot` method of check settings ([42a773c](https://github.com/Applitools-Dev/sdk/commit/42a773cc57e8e5de528a049b376159615892003b))
+  * fixed issue when w3c properties were added to legacy capabilities object in `Eyes.setMobileCapabilities` method ([94d785f](https://github.com/Applitools-Dev/sdk/commit/94d785f0428df101c207d6f09a55c46f2bdbf19e))
+
+
+
+
 ## [1.2.3](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.2.2...js/eyes-browser@1.2.3) (2024-03-18)
 
 

package/dist/index.js

@@ -13316,7 +13316,7 @@ var require_req_eyes = __commonJS({
             limit: 5,
             timeout: 200,
             statuses: [404, 500, 502, 503, 504],
-            codes: ["ECONNRESET", "ECONNABORTED", "ETIMEDOUT", "ENOTFOUND", "EAI_AGAIN", "STUCK_REQUEST"]
+            codes: ["ECONNRESET", "ECONNABORTED", "ECONNREFUSED", "ETIMEDOUT", "ENOTFOUND", "EAI_AGAIN", "STUCK_REQUEST"]
           }
         ],
         hooks: [handleLongRequests({ req: req_1.default }), handleLogs({ logger }), handleUnexpectedResponse()],
@@ -13364,7 +13364,9 @@ var require_req_eyes = __commonJS({
         async afterResponse({ request, response, options }) {
           if ((options === null || options === void 0 ? void 0 : options.expected) && (utils34.types.isArray(options === null || options === void 0 ? void 0 : options.expected) ? !options.expected.includes(response.status) : options.expected !== response.status)) {
             const requestId = request.headers.get("x-applitools-eyes-client-request-id");
-            throw new Error(`Request "${options === null || options === void 0 ? void 0 : options.name}" [${requestId}] that was sent to the address "[${request.method}]${request.url}" failed due to unexpected status ${response.statusText}(${response.status})`);
+            const body = await response.clone().text();
+            const bodyStr = body ? ` and body "${body}"` : "";
+            throw new Error(`Request "${options === null || options === void 0 ? void 0 : options.name}" [${requestId}] that was sent to the address "[${request.method}]${request.url}" failed due to unexpected status ${response.statusText}(${response.status})${bodyStr}`);
           }
         }
       };
@@ -13384,7 +13386,7 @@ var require_req_eyes = __commonJS({
             const pollResponse = await req2(response.headers.get("Location"), options !== null && options !== void 0 ? options : {}, {
               method: "GET",
               body: void 0,
-              expected: void 0,
+              expected: [200, 201],
               retry: {
                 statuses: [200],
                 timeout: [
@@ -13395,13 +13397,16 @@ var require_req_eyes = __commonJS({
                 ]
               },
               connectionTimeout: 0,
-              hooks: {
-                beforeRetry({ request, response: response2 }) {
-                  if (response2 && response2.status === 200 && response2.headers.has("Location")) {
-                    return { request, url: response2.headers.get("Location") };
+              hooks: [
+                {
+                  beforeRetry({ request, response: response2 }) {
+                    if (response2 && response2.status === 200 && response2.headers.has("Location")) {
+                      return { request, url: response2.headers.get("Location") };
+                    }
                   }
-                }
-              }
+                },
+                handleUnexpectedResponse()
+              ]
             });
             return await req2(pollResponse.headers.get("Location"), options !== null && options !== void 0 ? options : {}, {
               method: "DELETE",
@@ -20548,15 +20553,27 @@ var require_requests = __commonJS({
         extractText,
         closeBatch: closeBatch2,
         deleteTest,
-        logEvent
+        logEvent,
+        sendHeartbeat
       };
       return core;
-      async function openEyes({ settings, logger = mainLogger }) {
-        var _a, _b, _c, _d, _e, _f;
+      async function openEyes({ settings, heartbeat, logger = mainLogger }) {
+        var _a, _b, _c, _d, _e, _f, _g;
         logger = logger.extend(mainLogger, { tags: [`core-request-${utils34.general.shortid()}`] });
         const req2 = (0, req_eyes_1.makeReqEyes)({ settings, fetch: fetch2, logger });
         logger.log('Request "openEyes" called with settings', settings);
-        const accountPromise = getAccountInfoWithCache({ settings });
+        const account = await getAccountInfoWithCache({ settings });
+        if (account.processKeepaliveIntervalSec) {
+          heartbeat.startPeriodicHeartbeatMessaging({
+            eyesServerUrl: settings.eyesServerUrl,
+            apiKey: settings.apiKey,
+            proxy: settings.proxy,
+            useDnsCache: settings.useDnsCache,
+            agentId: settings.agentId,
+            processId: settings.processId,
+            interval: (_a = utils34.general.getEnvValue("HEARTBEAT_INTERVAL", "number")) !== null && _a !== void 0 ? _a : account.processKeepaliveIntervalSec * 1e3
+          });
+        }
         const initializedAt = (/* @__PURE__ */ new Date()).toISOString();
         const response = await req2("./api/sessions/running", {
           name: "openEyes",
@@ -20570,17 +20587,18 @@ var require_requests = __commonJS({
               appIdOrName: settings.appName,
               scenarioIdOrName: settings.testName,
               displayName: settings.displayName,
-              properties: [...(_a = settings.properties) !== null && _a !== void 0 ? _a : [], ...(_c = (_b = settings.environment) === null || _b === void 0 ? void 0 : _b.properties) !== null && _c !== void 0 ? _c : []],
+              properties: [...(_b = settings.properties) !== null && _b !== void 0 ? _b : [], ...(_d = (_c = settings.environment) === null || _c === void 0 ? void 0 : _c.properties) !== null && _d !== void 0 ? _d : []],
               batchInfo: settings.batch && {
                 id: settings.batch.id,
                 name: settings.batch.name,
                 batchSequenceName: settings.batch.sequenceName,
                 startedAt: settings.batch.startedAt,
                 notifyOnCompletion: settings.batch.notifyOnCompletion,
-                properties: settings.batch.properties
+                properties: settings.batch.properties,
+                buildId: settings.batch.buildId
               },
-              egSessionId: (_e = (_d = settings.environment) === null || _d === void 0 ? void 0 : _d.ecSessionId) !== null && _e !== void 0 ? _e : null,
-              environment: settings.environment && ((_f = settings.environment.rawEnvironment) !== null && _f !== void 0 ? _f : {
+              egSessionId: (_f = (_e = settings.environment) === null || _e === void 0 ? void 0 : _e.ecSessionId) !== null && _f !== void 0 ? _f : null,
+              environment: settings.environment && ((_g = settings.environment.rawEnvironment) !== null && _g !== void 0 ? _g : {
                 deviceInfo: settings.environment.deviceName,
                 os: settings.environment.os,
                 osInfo: settings.environment.displayOs,
@@ -20600,8 +20618,8 @@ var require_requests = __commonJS({
               saveDiffs: settings.saveDiffs,
               timeout: settings.abortIdleTestTimeout,
               isComponentAgent: settings.isComponentTest,
-              fallbackExpectedOutput: settings.fallbackBaselineId
-              // mapping to the right field is the api
+              fallbackExpectedOutput: settings.fallbackBaselineId,
+              processId: settings.processId
             }
           },
           expected: [200, 201],
@@ -20609,7 +20627,6 @@ var require_requests = __commonJS({
         });
         const test = await response.json().then(async (result) => {
           var _a2, _b2, _c2;
-          const account = await accountPromise;
           return {
             testId: result.id,
             // TODO revisit the need for it
@@ -20663,7 +20680,8 @@ var require_requests = __commonJS({
                 batchSequenceName: settings.batch.sequenceName,
                 startedAt: settings.batch.startedAt,
                 notifyOnCompletion: settings.batch.notifyOnCompletion,
-                properties: settings.batch.properties
+                properties: settings.batch.properties,
+                buildId: settings.batch.buildId
               },
               egSessionId: (_e = (_d = settings.environment) === null || _d === void 0 ? void 0 : _d.ecSessionId) !== null && _e !== void 0 ? _e : null,
               environment: settings.environment && ((_f = settings.environment.rawEnvironment) !== null && _f !== void 0 ? _f : {
@@ -20852,7 +20870,7 @@ var require_requests = __commonJS({
         logger = logger.extend(mainLogger, { tags: [`core-request-${utils34.general.shortid()}`] });
         const req2 = (0, req_eyes_1.makeReqEyes)({ settings, fetch: fetch2, logger });
         logger.log('Request "closeBatch" called with settings', settings);
-        await req2(`./api/sessions/batches/${settings.batchId}/close/bypointerId`, {
+        await req2(settings.batchBuildId ? `./api/sessions/batches/${settings.batchId}/${settings.batchBuildId}/close/bypointerId` : `./api/sessions/batches/${settings.batchId}/close/bypointerId`, {
           name: "closeBatch",
           method: "DELETE",
           expected: 200,
@@ -20898,6 +20916,31 @@ var require_requests = __commonJS({
         });
         logger.log('Request "logEvent" finished successfully');
       }
+      async function sendHeartbeat({ settings, logger = mainLogger }) {
+        logger = logger.extend(mainLogger, { tags: [`core-request-${utils34.general.shortid()}`] });
+        const req2 = (0, req_eyes_1.makeReqEyes)({ settings, fetch: fetch2, logger });
+        logger.log('Request "heartbeat" called with settings', settings);
+        await req2(`./api/sessions/sdkprocess/keepalive`, {
+          name: "heartbeat",
+          method: "POST",
+          body: {
+            processId: settings.processId
+          },
+          hooks: {
+            afterError({ error }) {
+              if (error.message.includes("Bad Request(400)")) {
+                error.message = "This process is expired. All its sessions were abandoned";
+              }
+            }
+          },
+          retry: {
+            limit: 0
+          },
+          expected: 200,
+          logger
+        });
+        logger.log('Request "heartbeat" finished successfully');
+      }
     }
     function makeEyesRequests({ core, test, req: req2, upload, logger: mainLogger }) {
       let resultResponsePromise;
@@ -28076,16 +28119,19 @@ var require_open_eyes = __commonJS({
     var get_results_1 = require_get_results();
     var throat_1 = __importDefault(require_throat());
     var utils34 = __importStar(require_browser3());
-    function makeOpenEyes({ requests, agentId: defaultAgentId, concurrency, cwd = process.cwd(), logger: mainLogger }) {
+    function makeOpenEyes({ requests, agentId: defaultAgentId, concurrency, cwd = process.cwd(), heartbeat, logger: mainLogger }) {
       const throttle = concurrency ? (0, throat_1.default)(concurrency) : (fn) => fn();
       return async function openEyes({ settings, logger = mainLogger }) {
-        var _a;
+        var _a, _b;
         logger = logger.extend(mainLogger, { tags: [`eyes-base-${utils34.general.shortid()}`] });
-        if (!settings.ignoreGitBranching && !settings.gitBranchingTimestamp) {
+        (_a = settings.processId) !== null && _a !== void 0 ? _a : settings.processId = heartbeat.processId;
+        if (settings.ignoreGitBranching) {
+          settings.gitBranchingTimestamp = void 0;
+        } else if (!settings.gitBranchingTimestamp) {
           let branchName = settings.branchName;
           let parentBranchName = settings.parentBranchName;
           try {
-            if (!branchName && !parentBranchName && ((_a = settings.batch) === null || _a === void 0 ? void 0 : _a.id) && !settings.batch.id.startsWith("generated")) {
+            if (!branchName && !parentBranchName && ((_b = settings.batch) === null || _b === void 0 ? void 0 : _b.id) && !settings.batch.id.startsWith("generated")) {
               const branches = await requests.getBatchBranches({ settings: { ...settings, batchId: settings.batch.id } });
               branchName = branches.branchName;
               parentBranchName = branches.parentBranchName;
@@ -28102,8 +28148,6 @@ var require_open_eyes = __commonJS({
           } catch (err) {
             logger.error("Error during extracting merge timestamp", err);
           }
-        } else {
-          settings.gitBranchingTimestamp = void 0;
         }
         settings.agentId = `${defaultAgentId} ${settings.agentId ? `[${settings.agentId}]` : ""}`.trim();
         logger.log('Command "openEyes" is called with settings', settings);
@@ -28113,7 +28157,7 @@ var require_open_eyes = __commonJS({
               var _a2;
               try {
                 const controller = new abort_controller_1.AbortController();
-                const eyesRequests = await requests.openEyes({ settings, logger });
+                const eyesRequests = await requests.openEyes({ settings, heartbeat, logger });
                 eyesRequests.test.ufgServer = {
                   ...eyesRequests.test.ufgServer,
                   ufgServerUrl: (_a2 = settings.ufgServerUrl) !== null && _a2 !== void 0 ? _a2 : eyesRequests.test.ufgServer.ufgServerUrl
@@ -28602,6 +28646,79 @@ var require_get_account_info = __commonJS({
   }
 });
 
+// ../core-base/dist/heartbeat.js
+var require_heartbeat = __commonJS({
+  "../core-base/dist/heartbeat.js"(exports) {
+    "use strict";
+    init_process();
+    init_setImmediate();
+    init_buffer();
+    init_setInterval();
+    var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function() {
+          return m[k];
+        } };
+      }
+      Object.defineProperty(o, k2, desc);
+    } : function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      o[k2] = m[k];
+    });
+    var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? function(o, v) {
+      Object.defineProperty(o, "default", { enumerable: true, value: v });
+    } : function(o, v) {
+      o["default"] = v;
+    });
+    var __importStar = exports && exports.__importStar || function(mod) {
+      if (mod && mod.__esModule)
+        return mod;
+      var result = {};
+      if (mod != null) {
+        for (var k in mod)
+          if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+            __createBinding(result, mod, k);
+      }
+      __setModuleDefault(result, mod);
+      return result;
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.makeHeartbeat = void 0;
+    var utils34 = __importStar(require_browser3());
+    function makeHeartbeat({ requests, logger: mainLogger }) {
+      const logger = mainLogger.extend(mainLogger, { tags: [`heartbeat-base-${utils34.general.shortid()}`] });
+      const processId = utils34.general.guid();
+      let isStarted = false;
+      return {
+        processId,
+        async startPeriodicHeartbeatMessaging(settings) {
+          var _a;
+          if (!isStarted) {
+            isStarted = true;
+            const interval = (_a = settings.interval) !== null && _a !== void 0 ? _a : 1e4;
+            await requests.sendHeartbeat({ settings, logger });
+            const intervalId = setIntervalBrowser(async () => {
+              try {
+                await requests.sendHeartbeat({ settings, logger });
+              } catch (error) {
+                if (error.message === "This process is expired. All its sessions were abandoned") {
+                  clearInterval(intervalId);
+                }
+              }
+            }, interval);
+            intervalId.unref();
+          }
+        }
+      };
+    }
+    exports.makeHeartbeat = makeHeartbeat;
+  }
+});
+
 // ../core-base/dist/core.js
 var require_core = __commonJS({
   "../core-base/dist/core.js"(exports) {
@@ -28622,15 +28739,17 @@ var require_core = __commonJS({
     var close_batch_1 = require_close_batch();
     var delete_test_1 = require_delete_test();
     var get_account_info_1 = require_get_account_info();
+    var heartbeat_1 = require_heartbeat();
     function makeCore({ agentId = "core-base", concurrency, cwd = process.cwd(), logger: defaultLogger }) {
       const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: "core-base" } });
       logger.log(`Core is initialized in directory ${cwd} for agent ${agentId}`);
       const requests = (0, requests_1.makeCoreRequestsWithCache)({ logger });
+      const heartbeat = (0, heartbeat_1.makeHeartbeat)({ requests, logger });
       return {
         get concurrency() {
           return concurrency;
         },
-        openEyes: (0, open_eyes_1.makeOpenEyes)({ requests, agentId, concurrency, cwd, logger }),
+        openEyes: (0, open_eyes_1.makeOpenEyes)({ requests, agentId, concurrency, cwd, heartbeat, logger }),
         openFunctionalSession: (0, open_functional_session_1.makeOpenFunctionalSession)({ requests, agentId, concurrency, cwd, logger }),
         locate: (0, locate_1.makeLocate)({ requests, agentId, logger }),
         locateText: (0, locate_text_1.makeLocateText)({ requests, agentId, logger }),
@@ -37192,16 +37311,17 @@ var require_open_eyes2 = __commonJS({
         const controller = new abort_controller_1.AbortController();
         const account = await core.getAccountInfo({ settings, logger });
         return utils34.general.extend({}, (eyes) => {
-          var _a2, _b2, _c2;
+          var _a2, _b2, _c2, _d;
           return {
             type: "classic",
             core,
             test: {
               userTestId: settings.userTestId,
               batchId: (_a2 = settings.batch) === null || _a2 === void 0 ? void 0 : _a2.id,
+              batchBuildId: (_b2 = settings.batch) === null || _b2 === void 0 ? void 0 : _b2.buildId,
               keepBatchOpen: settings.keepBatchOpen,
               eyesServer: account.eyesServer,
-              ufgServer: { ...account.ufgServer, ufgServerUrl: (_b2 = settings.ufgServerUrl) !== null && _b2 !== void 0 ? _b2 : (_c2 = account.ufgServer) === null || _c2 === void 0 ? void 0 : _c2.ufgServerUrl },
+              ufgServer: { ...account.ufgServer, ufgServerUrl: (_c2 = settings.ufgServerUrl) !== null && _c2 !== void 0 ? _c2 : (_d = account.ufgServer) === null || _d === void 0 ? void 0 : _d.ufgServerUrl },
               uploadUrl: account.uploadUrl,
               stitchingServiceUrl: account.stitchingServiceUrl,
               supportedEnvironmentsUrl: account.supportedEnvironmentsUrl,
@@ -85326,16 +85446,17 @@ var require_open_eyes3 = __commonJS({
         const controller = new abort_controller_1.AbortController();
         const account = await core.getAccountInfo({ settings, logger });
         return utils34.general.extend({}, (eyes) => {
-          var _a2, _b2, _c2;
+          var _a2, _b2, _c2, _d;
           return {
             type: "ufg",
             core,
             test: {
               userTestId: settings.userTestId,
               batchId: (_a2 = settings.batch) === null || _a2 === void 0 ? void 0 : _a2.id,
+              batchBuildId: (_b2 = settings.batch) === null || _b2 === void 0 ? void 0 : _b2.buildId,
               keepBatchOpen: settings.keepBatchOpen,
               eyesServer: account.eyesServer,
-              ufgServer: { ...account.ufgServer, ufgServerUrl: (_b2 = settings.ufgServerUrl) !== null && _b2 !== void 0 ? _b2 : (_c2 = account.ufgServer) === null || _c2 === void 0 ? void 0 : _c2.ufgServerUrl },
+              ufgServer: { ...account.ufgServer, ufgServerUrl: (_c2 = settings.ufgServerUrl) !== null && _c2 !== void 0 ? _c2 : (_d = account.ufgServer) === null || _d === void 0 ? void 0 : _d.ufgServerUrl },
               uploadUrl: account.uploadUrl,
               stitchingServiceUrl: account.stitchingServiceUrl,
               supportedEnvironmentsUrl: account.supportedEnvironmentsUrl,
@@ -85885,24 +86006,26 @@ var require_open_eyes4 = __commonJS({
     var utils34 = __importStar(require_browser3());
     function makeOpenEyes({ type: defaultType = "classic", clients, batch, core, cores, spec, environment, logger: mainLogger, asyncCache }) {
       return async function openEyes({ type = defaultType, settings, config, target, logger = mainLogger }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
-        var _r, _s, _t, _u;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+        var _t, _u, _v, _w, _x;
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils34.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...settings };
         (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : settings.userTestId = `${settings.testName}--${utils34.general.guid()}`;
         settings.batch = { ...batch, ...settings.batch };
-        (_b = (_r = settings.batch).id) !== null && _b !== void 0 ? _b : _r.id = (_c = utils34.general.getEnvValue("BATCH_ID")) !== null && _c !== void 0 ? _c : `generated-${utils34.general.guid()}`;
-        (_d = (_s = settings.batch).name) !== null && _d !== void 0 ? _d : _s.name = utils34.general.getEnvValue("BATCH_NAME");
-        (_e = (_t = settings.batch).sequenceName) !== null && _e !== void 0 ? _e : _t.sequenceName = utils34.general.getEnvValue("BATCH_SEQUENCE");
-        (_f = (_u = settings.batch).notifyOnCompletion) !== null && _f !== void 0 ? _f : _u.notifyOnCompletion = utils34.general.getEnvValue("BATCH_NOTIFY", "boolean");
-        (_g = settings.keepBatchOpen) !== null && _g !== void 0 ? _g : settings.keepBatchOpen = utils34.general.getEnvValue("DONT_CLOSE_BATCHES", "boolean");
-        (_h = settings.branchName) !== null && _h !== void 0 ? _h : settings.branchName = utils34.general.getEnvValue("BRANCH");
-        (_j = settings.parentBranchName) !== null && _j !== void 0 ? _j : settings.parentBranchName = utils34.general.getEnvValue("PARENT_BRANCH");
-        (_k = settings.baselineBranchName) !== null && _k !== void 0 ? _k : settings.baselineBranchName = utils34.general.getEnvValue("BASELINE_BRANCH");
-        (_l = settings.ufgServerUrl) !== null && _l !== void 0 ? _l : settings.ufgServerUrl = utils34.general.getEnvValue("UFG_SERVER_URL");
-        (_m = settings.ignoreBaseline) !== null && _m !== void 0 ? _m : settings.ignoreBaseline = false;
-        (_o = settings.compareWithParentBranch) !== null && _o !== void 0 ? _o : settings.compareWithParentBranch = false;
+        (_b = (_t = settings.batch).id) !== null && _b !== void 0 ? _b : _t.id = (_c = utils34.general.getEnvValue("BATCH_ID")) !== null && _c !== void 0 ? _c : `generated-${utils34.general.guid()}`;
+        (_d = (_u = settings.batch).buildId) !== null && _d !== void 0 ? _d : _u.buildId = utils34.general.getEnvValue("BATCH_BUILD_ID");
+        (_e = (_v = settings.batch).name) !== null && _e !== void 0 ? _e : _v.name = utils34.general.getEnvValue("BATCH_NAME");
+        (_f = (_w = settings.batch).sequenceName) !== null && _f !== void 0 ? _f : _w.sequenceName = utils34.general.getEnvValue("BATCH_SEQUENCE");
+        (_g = (_x = settings.batch).notifyOnCompletion) !== null && _g !== void 0 ? _g : _x.notifyOnCompletion = utils34.general.getEnvValue("BATCH_NOTIFY", "boolean");
+        (_h = settings.keepBatchOpen) !== null && _h !== void 0 ? _h : settings.keepBatchOpen = utils34.general.getEnvValue("DONT_CLOSE_BATCHES", "boolean");
+        (_j = settings.branchName) !== null && _j !== void 0 ? _j : settings.branchName = utils34.general.getEnvValue("BRANCH");
+        (_k = settings.parentBranchName) !== null && _k !== void 0 ? _k : settings.parentBranchName = utils34.general.getEnvValue("PARENT_BRANCH");
+        (_l = settings.baselineBranchName) !== null && _l !== void 0 ? _l : settings.baselineBranchName = utils34.general.getEnvValue("BASELINE_BRANCH");
+        (_m = settings.gitBranchingTimestamp) !== null && _m !== void 0 ? _m : settings.gitBranchingTimestamp = utils34.general.getEnvValue("GIT_MERGE_BASE_TIMESTAMP");
+        (_o = settings.ufgServerUrl) !== null && _o !== void 0 ? _o : settings.ufgServerUrl = utils34.general.getEnvValue("UFG_SERVER_URL");
+        (_p = settings.ignoreBaseline) !== null && _p !== void 0 ? _p : settings.ignoreBaseline = false;
+        (_q = settings.compareWithParentBranch) !== null && _q !== void 0 ? _q : settings.compareWithParentBranch = false;
         const driver = target && await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings });
         const driverEnvironment = await (driver === null || driver === void 0 ? void 0 : driver.getEnvironment());
         const driverUrl = await (driver === null || driver === void 0 ? void 0 : driver.getDriverUrl());
@@ -85913,7 +86036,7 @@ var require_open_eyes4 = __commonJS({
             event: {
               type: "openEyes",
               userTestId: settings.userTestId,
-              concurrency: (_p = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _p !== void 0 ? _p : core.concurrency,
+              concurrency: (_r = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _r !== void 0 ? _r : core.concurrency,
               environment,
               driver: {
                 deviceName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.deviceName,
@@ -85921,7 +86044,7 @@ var require_open_eyes4 = __commonJS({
                 browserVersion: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.browserVersion,
                 platformName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.platformName,
                 platformVersion: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.platformVersion,
-                isApplitoolsLib: (_q = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _q === void 0 ? void 0 : _q.instrumented,
+                isApplitoolsLib: (_s = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _s === void 0 ? void 0 : _s.instrumented,
                 isEC: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.isEC
               },
               driverUrl
@@ -86115,7 +86238,7 @@ var require_get_manager_results = __commonJS({
         }
         const batches = storage.reduce((batches2, eyes) => {
           if (!eyes.test.keepBatchOpen) {
-            const settings2 = { ...eyes.test.eyesServer, batchId: eyes.test.batchId };
+            const settings2 = { ...eyes.test.eyesServer, batchId: eyes.test.batchId, batchBuildId: eyes.test.batchBuildId };
             batches2[`${settings2.eyesServerUrl}:${settings2.apiKey}:${settings2.batchId}`] = settings2;
           }
           return batches2;
@@ -86206,14 +86329,15 @@ var require_make_manager = __commonJS({
     var utils34 = __importStar(require_browser3());
     function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, asyncCache }) {
       return async function makeManager({ type = "classic", settings, logger = mainLogger } = {}) {
-        var _a, _b, _c, _d, _e, _f;
-        var _g;
+        var _a, _b, _c, _d, _e, _f, _g;
+        var _h, _j;
         logger = logger.extend(mainLogger, { tags: [`manager-${type}-${utils34.general.shortid()}`] });
         settings !== null && settings !== void 0 ? settings : settings = {};
         (_a = settings.concurrency) !== null && _a !== void 0 ? _a : settings.concurrency = (_b = utils34.general.getEnvValue("CONCURRENCY", "number")) !== null && _b !== void 0 ? _b : utils34.types.isInteger(settings.legacyConcurrency) ? settings.legacyConcurrency * 5 : 100;
         (_c = settings.batch) !== null && _c !== void 0 ? _c : settings.batch = {};
-        (_d = (_g = settings.batch).id) !== null && _d !== void 0 ? _d : _g.id = (_e = utils34.general.getEnvValue("BATCH_ID")) !== null && _e !== void 0 ? _e : `generated-${utils34.general.guid()}`;
-        (_f = settings.agentId) !== null && _f !== void 0 ? _f : settings.agentId = type === "ufg" ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, ".visualgrid$1") : defaultAgentId;
+        (_d = (_h = settings.batch).id) !== null && _d !== void 0 ? _d : _h.id = (_e = utils34.general.getEnvValue("BATCH_ID")) !== null && _e !== void 0 ? _e : `generated-${utils34.general.guid()}`;
+        (_f = (_j = settings.batch).buildId) !== null && _f !== void 0 ? _f : _j.buildId = utils34.general.getEnvValue("BATCH_BUILD_ID");
+        (_g = settings.agentId) !== null && _g !== void 0 ? _g : settings.agentId = type === "ufg" ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, ".visualgrid$1") : defaultAgentId;
         logger.log('Command "makeManager" is called with settings', settings);
         const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, cwd, logger });
         const cores = {
@@ -86417,7 +86541,7 @@ var require_package2 = __commonJS({
   "../core/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/core",
-      version: "4.10.2",
+      version: "4.11.1",
       homepage: "https://applitools.com",
       bugs: {
         url: "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -86483,7 +86607,7 @@ var require_package2 = __commonJS({
           }
         },
         targets: {
-          "node20-linux-x64-glibc-217": "./bin/core-linux",
+          "node20.11-linux-x64-glibc-217": "./bin/core-linux",
           "node20-linux-x64-musl": "./bin/core-alpine",
           "node20-linux-arm64": "./bin/core-linux-arm64",
           "node20-darwin-x64": "./bin/core-macos",
@@ -90193,7 +90317,7 @@ var require_package3 = __commonJS({
   "../eyes/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/eyes",
-      version: "1.16.2",
+      version: "1.17.1",
       keywords: [
         "applitools",
         "eyes",
@@ -93177,6 +93301,20 @@ var ConfigurationData = class {
     this.baselineBranchName = baselineBranchName;
     return this;
   }
+  get gitMergeBaseTimestamp() {
+    return this._config.gitMergeBaseTimestamp;
+  }
+  set gitMergeBaseTimestamp(gitMergeBaseTimestamp) {
+    utils20.guard.isString(gitMergeBaseTimestamp, { name: "gitMergeBaseTimestamp" });
+    this._config.gitMergeBaseTimestamp = gitMergeBaseTimestamp;
+  }
+  getGitMergeBaseTimestamp() {
+    return this.gitMergeBaseTimestamp;
+  }
+  setGitMergeBaseTimestamp(gitMergeBaseTimestamp) {
+    this.gitMergeBaseTimestamp = gitMergeBaseTimestamp;
+    return this;
+  }
   get compareWithParentBranch() {
     return this._config.compareWithParentBranch;
   }
@@ -93752,6 +93890,7 @@ var ConfigurationData = class {
         baselineBranchName: this.baselineBranchName,
         compareWithParentBranch: this.compareWithParentBranch,
         ignoreBaseline: this.ignoreBaseline,
+        gitBranchingTimestamp: this.gitMergeBaseTimestamp,
         ignoreGitBranching: this.ignoreGitMergeBase,
         saveDiffs: this.saveDiffs,
         keepBatchOpen: this.dontCloseBatches

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-browser",
-  "version": "1.2.3",
+  "version": "1.3.1",
   "keywords": [
     "applitools",
     "browser",
@@ -48,7 +48,7 @@
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/eyes": "1.16.2"
+    "@applitools/eyes": "1.17.1"
   },
   "devDependencies": {
     "@types/node": "^12.20.55",

package/types/input/Configuration.d.ts

@@ -52,6 +52,7 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     environmentName?: string;
     branchName?: string;
     parentBranchName?: string;
+    gitMergeBaseTimestamp?: string;
     baselineBranchName?: string;
     compareWithParentBranch?: boolean;
     ignoreBaseline?: boolean;
@@ -206,6 +207,10 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
     set baselineBranchName(baselineBranchName: string);
     getBaselineBranchName(): string;
     setBaselineBranchName(baselineBranchName: string): this;
+    get gitMergeBaseTimestamp(): string;
+    set gitMergeBaseTimestamp(gitMergeBaseTimestamp: string);
+    getGitMergeBaseTimestamp(): string;
+    setGitMergeBaseTimestamp(gitMergeBaseTimestamp: string): this;
     get compareWithParentBranch(): boolean;
     set compareWithParentBranch(compareWithParentBranch: boolean);
     getCompareWithParentBranch(): boolean;