@applitools/core 4.17.0 → 4.18.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## [4.18.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.17.0...js/core@4.18.0) (2024-07-23)
+
+
+### Features
+
+* disable broker url cache ([#2428](https://github.com/Applitools-Dev/sdk/issues/2428)) ([cb8d5fe](https://github.com/Applitools-Dev/sdk/commit/cb8d5fefb13d3ab42984d2bd4d4ac3d4e10646b0))
+
+
+### 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/spec-driver-puppeteer bumped to 1.4.11
+
+* @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/spec-driver-webdriver bumped to 1.1.11
+
+* @applitools/spec-driver-selenium bumped to 1.5.82
+
+* @applitools/screenshoter bumped to 3.8.35
+
+* @applitools/nml-client bumped to 1.8.9
+
+* @applitools/ec-client bumped to 1.9.3
+
+
 ## [4.17.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.16.5...js/core@4.17.0) (2024-06-26)
 
 

package/dist/automation/get-nml-client.js

@@ -4,12 +4,16 @@ exports.makeGetNMLClient = void 0;
 const nml_client_1 = require("@applitools/nml-client");
 const clients = 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;
@@ -22,6 +26,11 @@ function makeGetNMLClient({ client, logger: mainLogger }) {
             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;

package/dist/classic/core.js

@@ -47,7 +47,7 @@ function makeCore({ spec, clients, base: defaultBase, concurrency, agentId = 'co
             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 }),
         };
     });

package/dist/cli/cli.js

@@ -31,6 +31,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_server_1 = require("../universal/core-server");
 const core_server_process_1 = require("../universal/core-server-process");
 const logs_1 = require("../troubleshoot/logs");
+const check_network_1 = require("../troubleshoot/check-network");
 const yargs_1 = __importDefault(require("yargs"));
 const utils = __importStar(require("@applitools/utils"));
 yargs_1.default
@@ -142,5 +143,11 @@ yargs_1.default
             console.log(JSON.stringify(logs, null, 2));
         }
     },
+})
+    .command({
+    command: 'check-network',
+    handler: async () => {
+        await (0, check_network_1.checkNetwork)();
+    },
 })
     .wrap(yargs_1.default.terminalWidth()).argv;

package/dist/core.js

@@ -61,7 +61,7 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
             base: 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.

package/dist/open-eyes.js

@@ -85,6 +85,9 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
             },
             logger,
         });
+        if (settings.disableBrokerUrlCache && driver) {
+            await core.clearNMLClientCache(driver);
+        }
         const getTypedEyes = (0, get_typed_eyes_1.makeGetTypedEyes)({
             type,
             settings: settings,

package/dist/troubleshoot/check-network.js

@@ -65,9 +65,11 @@ async function checkNetwork({ stream = process.stdout, eyes = eyes_1.default, uf
     const proxyMsg = '\nYour proxy seems to be blocking requests to Applitools. Please make sure the following command succeeds:';
     if (curlRenderErr) {
         printErr(proxyMsg, '\n', eyes.cmd, '\n');
+        throw new Error('Your proxy seems to be blocking requests to Applitools.');
     }
     else if (curlVgErr) {
         printErr(proxyMsg, '\n', await ufg.getCmd());
+        throw new Error('Your proxy seems to be blocking requests to Applitools.');
     }
     async function doTest(func, name) {
         const delimiterLength = 30 - name.length;
@@ -111,4 +113,6 @@ async function checkNetwork({ stream = process.stdout, eyes = eyes_1.default, uf
     }
 }
 exports.checkNetwork = checkNetwork;
-checkNetwork();
+if (require.main === module) {
+    checkNetwork();
+}

package/dist/troubleshoot/eyes.js

@@ -40,7 +40,7 @@ const validateRawAccountInfo = (res) => {
     }
 };
 const validateAccountInfo = (res) => {
-    if (!res || !res.ufg || !res.ufg.accessToken || !res.uploadUrl) {
+    if (!res || !res.ufgServer || !res.ufgServer.accessToken || !res.uploadUrl) {
         throw new Error(`bad render info result ${JSON.stringify(res)}`);
     }
 };
@@ -59,7 +59,7 @@ exports.default = {
     },
     async testServer() {
         const server = (0, core_base_1.makeCoreRequestsWithCache)();
-        const result = await server.getAccountInfo({ settings: utils_1.config });
+        const result = await server.getAccountInfo({ settings: { eyesServerUrl: utils_1.config.serverUrl, ...utils_1.config } });
         validateAccountInfo(result);
     },
     testHttps: async () => {

package/dist/troubleshoot/ufg.js

@@ -35,13 +35,15 @@ const utils_1 = require("./utils");
 const eyes_1 = require("./eyes");
 const utils = __importStar(require("@applitools/utils"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
-const value = new TextEncoder().encode(JSON.stringify({ resources: {}, domNodes: [] }));
-const hash = (0, crypto_1.createHash)('sha256').update(value).digest('hex');
+const rawValue = JSON.stringify({ resources: {}, domNodes: [] });
+const encodedValue = new TextEncoder().encode(rawValue);
+const hash = (0, crypto_1.createHash)('sha256').update(encodedValue).digest('hex');
 const contentType = 'x-applitools-html/cdt';
 const resource = {
     id: 'id',
     url: 'https://localhost:2107',
-    value,
+    value: encodedValue,
+    rawValue: rawValue,
     hash: { hashFormat: 'sha256', hash, contentType },
     contentType,
 };
@@ -55,7 +57,7 @@ const accessTokenPromise = new Promise(async (resolve) => {
         throw new Error('could not receive auth token since cURL command to get it failed.');
     resolve(accessToken);
 });
-const getCmd = async () => `curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: ${await accessTokenPromise}" -d '${resource.value}' ${UFG_PUT_RESOURCE_URL} ${(0, utils_1.getProxyCurlArg)()}`;
+const getCmd = async () => `curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: ${await accessTokenPromise}" -d '${resource.rawValue}' ${UFG_PUT_RESOURCE_URL} ${(0, utils_1.getProxyCurlArg)()}`;
 exports.getCmd = getCmd;
 const validateVgResult = (res, sha) => {
     if (!res || res.hash !== sha) {

package/dist/ufg/core.js

@@ -51,7 +51,7 @@ function makeCore({ spec, clients, base: defaultBase, asyncCache, concurrency, f
             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 }),
         };
     });

package/dist/universal/core.js

@@ -50,6 +50,9 @@ function makeCore(options) {
             // TODO
             return null;
         },
+        async clearNMLClientCache(_driver) {
+            return null;
+        },
         async getECClient(options) {
             const socket = await socketPromise;
             return socket.request('Core.makeECClient', options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "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"
@@ -42,12 +42,12 @@
   ],
   "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",
@@ -77,16 +77,16 @@
     "@applitools/core-base": "1.16.0",
     "@applitools/dom-capture": "11.3.0",
     "@applitools/dom-snapshot": "4.11.3",
-    "@applitools/driver": "1.17.5",
-    "@applitools/ec-client": "1.9.2",
+    "@applitools/driver": "1.18.0",
+    "@applitools/ec-client": "1.9.3",
     "@applitools/logger": "2.0.18",
-    "@applitools/nml-client": "1.8.8",
+    "@applitools/nml-client": "1.8.9",
     "@applitools/req": "1.7.2",
-    "@applitools/screenshoter": "3.8.34",
+    "@applitools/screenshoter": "3.8.35",
     "@applitools/snippets": "2.4.27",
     "@applitools/socket": "1.1.18",
-    "@applitools/spec-driver-webdriver": "1.1.10",
-    "@applitools/ufg-client": "1.12.2",
+    "@applitools/spec-driver-webdriver": "1.1.11",
+    "@applitools/ufg-client": "1.12.3",
     "@applitools/utils": "1.7.4",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
@@ -94,14 +94,14 @@
     "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": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.10",
-    "@applitools/spec-driver-selenium": "^1.5.81",
+    "@applitools/spec-driver-puppeteer": "^1.4.11",
+    "@applitools/spec-driver-selenium": "^1.5.82",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.5.7",

package/types/automation/get-nml-client.d.ts

@@ -5,9 +5,12 @@ type Options = {
     client?: NMLClient;
     logger: Logger;
 };
-export declare function makeGetNMLClient({ client, logger: mainLogger }: Options): ({ driver, settings, logger, }: {
-    driver: Driver<SpecType>;
-    settings: Omit<NMLClientSettings, 'brokerUrl'>;
-    logger: Logger;
-}) => Promise<NMLClient>;
+export declare function makeGetNMLClient({ client, logger: mainLogger }: Options): {
+    getNMLClient: ({ driver, settings, logger, }: {
+        driver: Driver<SpecType>;
+        settings: Omit<NMLClientSettings, 'brokerUrl'>;
+        logger: Logger;
+    }) => Promise<NMLClient>;
+    clearNMLClientCache: (driver: Driver<SpecType>) => Promise<void>;
+};
 export {};

package/types/automation/types.d.ts

@@ -62,6 +62,7 @@ export interface Core<TSpec extends SpecType> extends Omit<BaseCore.Core, 'openE
         driver: Driver<TSpec>;
         logger: Logger;
     }): Promise<NMLClient>;
+    clearNMLClientCache(driver: Driver<TSpec>): Promise<void>;
     openEyes(options: {
         target?: DriverTarget<TSpec>;
         settings: BaseCore.OpenSettings;
@@ -163,3 +164,6 @@ export type AbortSettings = BaseCore.AbortSettings & {
 export type TestResult = BaseCore.TestResult & {
     readonly environment: ExactEnvironment;
 };
+export type OpenSettings = BaseCore.OpenSettings & {
+    disableBrokerUrlCache?: boolean;
+};