@applitools/eyes-browser 1.4.7 → 1.4.8

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+## [1.4.8](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.4.7...js/eyes-browser@1.4.8) (2024-07-23)
+
+
+### Dependencies
+
+* @applitools/driver bumped to 1.18.0
+  #### Features
+
+  * disable broker url cache ([#2428](https://github.com/Applitools-Dev/sdk/issues/2428)) ([cb8d5fe](https://github.com/Applitools-Dev/sdk/commit/cb8d5fefb13d3ab42984d2bd4d4ac3d4e10646b0))
+
+
+  #### Bug Fixes
+
+  * executing web script on mobile environment ([#2380](https://github.com/Applitools-Dev/sdk/issues/2380)) ([da2e551](https://github.com/Applitools-Dev/sdk/commit/da2e551e01082d3cc21b9da5b43e6680233c080d))
+* @applitools/ufg-client bumped to 1.12.3
+  #### Bug Fixes
+
+  * update makeUploadResource to include apiKey in the cache key ([#2411](https://github.com/Applitools-Dev/sdk/issues/2411)) ([4114c58](https://github.com/Applitools-Dev/sdk/commit/4114c58ec16fa855374b23810cef1e36d4bb53a7))
+
+
+  #### Performance Improvements
+
+  * trim file content when logging it ([#2437](https://github.com/Applitools-Dev/sdk/issues/2437)) ([02ec1f7](https://github.com/Applitools-Dev/sdk/commit/02ec1f79a323af2e89a7428b75212707c761d1ca))
+* @applitools/core bumped to 4.18.0
+  #### Features
+
+  * disable broker url cache ([#2428](https://github.com/Applitools-Dev/sdk/issues/2428)) ([cb8d5fe](https://github.com/Applitools-Dev/sdk/commit/cb8d5fefb13d3ab42984d2bd4d4ac3d4e10646b0))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.11
+
+* @applitools/spec-driver-selenium bumped to 1.5.82
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.11
+
+* @applitools/screenshoter bumped to 3.8.35
+
+* @applitools/nml-client bumped to 1.8.9
+
+* @applitools/ec-client bumped to 1.9.3
+
+* @applitools/eyes bumped to 1.22.0
+  #### Features
+
+  * disable broker url cache ([#2428](https://github.com/Applitools-Dev/sdk/issues/2428)) ([cb8d5fe](https://github.com/Applitools-Dev/sdk/commit/cb8d5fefb13d3ab42984d2bd4d4ac3d4e10646b0))
+
+
+
+
 ## [1.4.7](https://github.com/Applitools-Dev/sdk/compare/js/eyes-browser@1.4.6...js/eyes-browser@1.4.7) (2024-06-26)
 
 

package/dist/index.js

@@ -32450,7 +32450,7 @@ var require_driver = __commonJS({
         await (scrollingElement === null || scrollingElement === void 0 ? void 0 : scrollingElement.refresh());
         return refreshThis;
       }
-      async refresh({ reset } = {}) {
+      async refresh({ reset, name } = {}) {
         if (reset) {
           if (utils34.general.getEnvValue("AVOID_DRIVER_STATE_REST", "boolean")) {
             this._logger.log(`Skipping reset of the driver state`);
@@ -32463,6 +32463,9 @@ var require_driver = __commonJS({
             this._state = {};
           }
         }
+        if (name === "NATIVE_APP") {
+          return reset ? resetReference(this) : this;
+        }
         const spec = this._spec;
         let currentContext = this.currentContext.target;
         let contextInfo;
@@ -32867,7 +32870,7 @@ var require_driver = __commonJS({
         }
         try {
           await this._spec.switchWorld(this.target, name);
-          await this.refresh({ reset: true });
+          await this.refresh({ reset: true, name });
         } catch (error) {
           this._logger.error("Unable to switch world due to the error", error);
           throw new Error(`Unable to switch world, the original error was: ${error.message}`);
@@ -36096,12 +36099,16 @@ var require_get_nml_client = __commonJS({
     var nml_client_1 = require_dist5();
     var clients = /* @__PURE__ */ new Map();
     function makeGetNMLClient({ client, logger: mainLogger }) {
-      return async function getNMLClient({ driver, settings, logger }) {
+      return {
+        getNMLClient,
+        clearNMLClientCache
+      };
+      async function getNMLClient({ driver, settings, logger }) {
         if (client)
           return client;
         logger = logger.extend(mainLogger);
         const { sessionId } = await driver.getDriverInfo();
-        const cacheKey = sessionId ? JSON.stringify({ sessionId, settings }) : JSON.stringify({ guid: driver.guid, settings });
+        const cacheKey = sessionId !== null && sessionId !== void 0 ? sessionId : driver.guid;
         const clientFromCache = clients.get(cacheKey);
         if (clientFromCache) {
           return clientFromCache;
@@ -36113,7 +36120,12 @@ var require_get_nml_client = __commonJS({
           clients.set(cacheKey, nmlClient);
           return nmlClient;
         }
-      };
+      }
+      async function clearNMLClientCache(driver) {
+        const { sessionId } = await driver.getDriverInfo();
+        const cacheKey = sessionId !== null && sessionId !== void 0 ? sessionId : driver.guid;
+        clients.delete(cacheKey);
+      }
     }
     exports.makeGetNMLClient = makeGetNMLClient;
   }
@@ -37623,7 +37635,7 @@ var require_core2 = __commonJS({
           locate: (0, locate_1.makeLocate)({ spec, core, logger }),
           locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),
           extractText: (0, extract_text_1.makeExtractText)({ spec, core, logger }),
-          getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
+          ...(0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
           openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, core, logger })
         };
       });
@@ -44472,6 +44484,7 @@ var require_req_ufg = __commonJS({
     exports.makeReqUFG = void 0;
     var req_1 = (init_dist(), __toCommonJS(dist_exports));
     var utils34 = __importStar(require_browser3());
+    var buffer_1 = require_buffer();
     function makeReqUFG({ settings, logger }) {
       var _a;
       return (0, req_1.makeReq)({
@@ -44511,7 +44524,19 @@ var require_req_ufg = __commonJS({
             requestId = `${counter++}--${guid}`;
             request.headers.set("x-applitools-eyes-client-request-id", requestId);
           }
-          logger === null || logger === void 0 ? void 0 : logger.log(`Request "${options === null || options === void 0 ? void 0 : options.name}" [${requestId}] will be sent to the address "[${request.method}]${request.url}" with body`, options === null || options === void 0 ? void 0 : options.body);
+          const { body, originalSize, isTrimmed } = trimBody();
+          logger === null || logger === void 0 ? void 0 : logger.log(`Request "${options === null || options === void 0 ? void 0 : options.name}" [${requestId}] will be sent to the address "[${request.method}]${request.url}" with body${isTrimmed ? ` (trimmed from ${originalSize})` : ""}`, body);
+          function trimBody() {
+            if ((options === null || options === void 0 ? void 0 : options.body) instanceof buffer_1.Buffer || (options === null || options === void 0 ? void 0 : options.body) instanceof Uint8Array) {
+              return {
+                body: options.body.subarray(0, 10),
+                originalSize: options.body.length,
+                isTrimmed: options.body.length > 10
+              };
+            } else {
+              return { body: options === null || options === void 0 ? void 0 : options.body };
+            }
+          }
         },
         beforeRetry({ request, attempt, error, response, options }) {
           var _a;
@@ -44737,7 +44762,7 @@ var require_requests3 = __commonJS({
       }
       async function checkResources({ resources, logger: logger2 = mainLogger }) {
         logger2 = logger2.extend(mainLogger, { tags: [`ufg-request-${utils34.general.shortid()}`] });
-        logger2.log('Request "checkResources" called for resources', resources);
+        logger2.log('Request "checkResources" called for resources', resources.map(trimValueForResource));
         const response = await req2("./resources/query/resources-exist", {
           name: "checkResources",
           method: "POST",
@@ -44754,7 +44779,7 @@ var require_requests3 = __commonJS({
       }
       async function uploadResource({ resource, logger: logger2 = mainLogger }) {
         logger2 = logger2.extend(mainLogger, { tags: [`ufg-request-${utils34.general.shortid()}`] });
-        logger2.log('Request "uploadResource" called for resource', resource);
+        logger2.log('Request "uploadResource" called for resource', trimValueForResource(resource));
         await req2(`./resources/sha256/${resource.hash.hash}`, {
           name: "uploadResource",
           method: "PUT",
@@ -44905,6 +44930,9 @@ var require_requests3 = __commonJS({
       }
       return pathSelector;
     }
+    function trimValueForResource(resource) {
+      return { ...resource, value: resource.value.subarray(0, 10) };
+    }
   }
 });
 
@@ -84846,14 +84874,14 @@ var require_upload_resource = __commonJS({
     var logger_1 = require_browser6();
     var throat_1 = __importDefault(require_throat());
     var utils34 = __importStar(require_browser3());
-    function makeUploadResource({ requests, batchingTimeout = 300, concurrency = 100, logger: mainLogger }) {
+    function makeUploadResource({ requests, batchingTimeout = 300, concurrency = 100, logger: mainLogger, apiKey }) {
       const uploadedResources = /* @__PURE__ */ new Set();
       const requestedResources = /* @__PURE__ */ new Map();
       const uploadResourceWithConcurrency = (0, throat_1.default)(concurrency, requests.uploadResource);
       const uploadResourceWithBatching = utils34.general.batchify(uploadResources, { timeout: batchingTimeout });
       return async function uploadResource({ resource, logger = mainLogger }) {
         logger = logger.extend(mainLogger, { tags: [`upload-resource-${utils34.general.shortid()}`] });
-        const hash = resource.hash.hash;
+        const hash = resource.hash.hash + "_" + apiKey;
         if (uploadedResources.has(hash)) {
           return Promise.resolve();
         } else if (requestedResources.has(hash)) {
@@ -84884,6 +84912,9 @@ var require_upload_resource = __commonJS({
               uploadResourceWithConcurrency(options).then(resolve, reject);
             }
           });
+          if (presentedResources.length !== batch.length) {
+            throw new Error(`Unexpected number of presented resources - ${presentedResources.length} instead of ${batch.length}`);
+          }
         } catch (err) {
           batch.forEach(([, { reject }]) => reject(err));
         }
@@ -84925,7 +84956,7 @@ var require_client2 = __commonJS({
         apiKey: settings.apiKey,
         logger
       });
-      const uploadResource = (0, upload_resource_1.makeUploadResource)({ requests, logger });
+      const uploadResource = (0, upload_resource_1.makeUploadResource)({ requests, logger, apiKey: settings.apiKey });
       const processResources = (0, process_resources_1.makeProcessResources)({
         fetchResource,
         cache,
@@ -85900,7 +85931,7 @@ var require_core3 = __commonJS({
           locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),
           extractText: (0, extract_text_1.makeExtractText)({ spec, core, logger }),
           getUFGClient: (0, get_ufg_client_1.makeGetUFGClient)({ client: clients === null || clients === void 0 ? void 0 : clients.ufg, fetchConcurrency, asyncCache, logger }),
-          getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
+          ...(0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
           openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, core, logger })
         };
       });
@@ -86767,6 +86798,9 @@ var require_open_eyes4 = __commonJS({
           },
           logger
         });
+        if (settings.disableBrokerUrlCache && driver) {
+          await core.clearNMLClientCache(driver);
+        }
         const getTypedEyes = (0, get_typed_eyes_1.makeGetTypedEyes)({
           type,
           settings,
@@ -87283,7 +87317,7 @@ var require_package2 = __commonJS({
   "../core/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/core",
-      version: "4.17.0",
+      version: "4.18.0",
       homepage: "https://applitools.com",
       bugs: {
         url: "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -87325,12 +87359,12 @@ var require_package2 = __commonJS({
       ],
       scripts: {
         lint: "run --top-level eslint '**/*.ts'",
-        build: "yarn build:dist",
+        build: "yarn build:dist && yarn build:bin",
+        "build:short": "yarn build:dist",
         "build:dist": "run --top-level tsc --project ./tsconfig.build.json",
         "build:bin": "sea",
         "build:bin:zip": "zip -j ./bin/core.zip $(find ./bin -type f -not -name '*.zip' -not -name '*.tar.gz' | xargs)",
         "build:bin:tgz": "tar -czf ./bin/core.tar.gz $(find ./bin -type f -not -name '*.zip' -not -name '*.tar.gz' | xargs)",
-        "build:full": "yarn build:dist && yarn build:bin",
         test: "run --top-level mocha './test/**/*.spec.ts' --exclude './test/bin/**' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
         "test:local": "MOCHA_OMIT_TAGS=sauce run test",
         "test:sauce": "MOCHA_ONLY_TAGS=sauce run test",
@@ -87377,7 +87411,7 @@ var require_package2 = __commonJS({
         "node-fetch": "2.6.7",
         semver: "7.6.2",
         webdriver: "7.31.1",
-        ws: "8.13.0",
+        ws: "8.17.1",
         yargs: "17.7.2"
       },
       devDependencies: {
@@ -87758,7 +87792,7 @@ var require_core4 = __commonJS({
           base,
           getViewportSize: spec && (0, get_viewport_size_1.makeGetViewportSize)({ spec, logger }),
           setViewportSize: spec && (0, set_viewport_size_1.makeSetViewportSize)({ spec, logger }),
-          getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
+          ...(0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
           getECClient: (0, get_ec_client_1.makeGetECClient)({ logger }),
           getAccountInfo: (0, get_account_info_1.makeGetAccountInfo)({ core, logger }),
           // Note: `defaultBase` is passesd for `base`, and `cores` is not passed here on purpose, so that a manager will create its own base, which would apply the correct concurrency value that was passed to the manager.
@@ -91402,7 +91436,7 @@ var require_package3 = __commonJS({
   "../eyes/package.json"(exports, module) {
     module.exports = {
       name: "@applitools/eyes",
-      version: "1.21.0",
+      version: "1.22.0",
       keywords: [
         "applitools",
         "eyes",
@@ -95007,6 +95041,19 @@ var ConfigurationData = class {
     this.dontCloseBatches = dontCloseBatches;
     return this;
   }
+  get disableNMLUrlCache() {
+    return this._config.disableNMLUrlCache;
+  }
+  set disableNMLUrlCache(disableNMLUrlCache) {
+    this._config.disableNMLUrlCache = disableNMLUrlCache;
+  }
+  getDisableNMLUrlCache() {
+    return this.disableNMLUrlCache;
+  }
+  setDisableNMLUrlCache(disableNMLUrlCache) {
+    this.disableNMLUrlCache = disableNMLUrlCache;
+    return this;
+  }
   /** @internal */
   toObject() {
     return this._config;
@@ -95046,7 +95093,8 @@ var ConfigurationData = class {
         gitBranchingTimestamp: this.gitMergeBaseTimestamp,
         ignoreGitBranching: this.ignoreGitMergeBase,
         saveDiffs: this.saveDiffs,
-        keepBatchOpen: this.dontCloseBatches
+        keepBatchOpen: this.dontCloseBatches,
+        disableBrokerUrlCache: this.disableNMLUrlCache
       }),
       screenshot: utils20.general.removeUndefinedProps({
         fully: this.forceFullPageScreenshot,

package/package.json

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

package/types/input/Configuration.d.ts

@@ -84,6 +84,7 @@ export type Configuration<TSpec extends Core.SpecType = Core.SpecType> = {
     };
     disableBrowserFetching?: boolean;
     waitBeforeCapture?: number;
+    disableNMLUrlCache?: boolean;
 };
 export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecType> implements Required<Configuration<TSpec>> {
     protected static readonly _spec: Core.SpecDriver<Core.SpecType>;
@@ -379,6 +380,10 @@ export declare class ConfigurationData<TSpec extends Core.SpecType = Core.SpecTy
     getDontCloseBatches(): boolean;
     /** @undocumented */
     setDontCloseBatches(dontCloseBatches: boolean): this;
+    get disableNMLUrlCache(): boolean;
+    set disableNMLUrlCache(disableNMLUrlCache: boolean);
+    getDisableNMLUrlCache(): boolean;
+    setDisableNMLUrlCache(disableNMLUrlCache: boolean): this;
     /** @internal */
     toObject(): Configuration<TSpec>;
     /** @internal */