@applitools/nml-client 1.5.9 → 1.5.11

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## [1.5.11](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.5.10...js/nml-client@1.5.11) (2023-09-21)
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.4.24
+  #### Bug Fixes
+
+  * add support to shadow dom iframe ([#1925](https://github.com/applitools/eyes.sdk.javascript1/issues/1925)) ([a06b955](https://github.com/applitools/eyes.sdk.javascript1/commit/a06b9555a3b37918fe43a90e92c0a94f765151cc))
+* @applitools/spec-driver-webdriver bumped to 1.0.45
+
+* @applitools/driver bumped to 1.14.1
+
+
+## [1.5.10](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.5.9...js/nml-client@1.5.10) (2023-09-04)
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.0
+  #### Features
+
+  * add support for fallback in `req` ([#1899](https://github.com/applitools/eyes.sdk.javascript1/issues/1899)) ([d69c4b5](https://github.com/applitools/eyes.sdk.javascript1/commit/d69c4b5830370c471dfc25b6e2caddca8b458df9))
+* @applitools/req bumped to 1.6.0
+  #### Features
+
+  * add support for fallback in `req` ([#1899](https://github.com/applitools/eyes.sdk.javascript1/issues/1899)) ([d69c4b5](https://github.com/applitools/eyes.sdk.javascript1/commit/d69c4b5830370c471dfc25b6e2caddca8b458df9))
+  * update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+
+* @applitools/driver bumped to 1.14.0
+  #### Features
+
+  * update testcafe ([#1884](https://github.com/applitools/eyes.sdk.javascript1/issues/1884)) ([104f1b6](https://github.com/applitools/eyes.sdk.javascript1/commit/104f1b6cc0d4f107ba46404383de2fa11fe99dcf))
+
+
+
+* @applitools/logger bumped to 2.0.10
+
+* @applitools/spec-driver-webdriver bumped to 1.0.44
+
+
 ## [1.5.9](https://github.com/applitools/eyes.sdk.javascript1/compare/js/nml-client@1.5.8...js/nml-client@1.5.9) (2023-08-30)
 
 

package/dist/server/req-broker.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeReqBroker = void 0;
 const req_1 = __importStar(require("@applitools/req"));
+const utils = __importStar(require("@applitools/utils"));
 function makeReqBroker({ settings, logger }) {
     return (0, req_1.makeReq)({
         method: 'POST',
@@ -82,17 +83,21 @@ function handleLongRequests({ req }) {
 function handleUnexpectedResponse() {
     return {
         async afterResponse({ response }) {
-            var _a;
             if (response.status !== 200) {
                 throw new Error(`Something went wrong when communicating with the mobile application, please try running your test again (error code: ${response.status})`);
             }
             else {
                 const body = await response.text();
                 const result = JSON.parse(body);
-                if ((_a = result === null || result === void 0 ? void 0 : result.payload) === null || _a === void 0 ? void 0 : _a.error) {
-                    const error = new Error(`There was a problem when interacting with the mobile application. The provided error message was "${result.payload.error.message}" and had a stack trace of "${result.payload.error.stack}"`);
-                    error.nextPath = result.nextPath;
-                    throw error;
+                if (result === null || result === void 0 ? void 0 : result.payload) {
+                    const error = utils.types.isArray(result.payload)
+                        ? result.payload.find(payload => payload.error)
+                        : result.payload.error;
+                    if (error) {
+                        const nmlError = new Error(`There was a problem when interacting with the mobile application. The provided error message was "${error.message}" and had a stack trace of "${error.stack}"`);
+                        nmlError.nextPath = result.nextPath;
+                        throw nmlError;
+                    }
                 }
                 return { response, body };
             }

package/dist/server/requests.js

@@ -30,10 +30,10 @@ exports.makeNMLRequests = void 0;
 const req_broker_1 = require("./req-broker");
 const req_1 = __importDefault(require("@applitools/req"));
 const utils = __importStar(require("@applitools/utils"));
-function makeNMLRequests({ settings, logger: defaultLogger, }) {
+function makeNMLRequests({ settings, logger: mainLogger, }) {
     let brokerUrl = settings.brokerUrl;
-    const req = (0, req_broker_1.makeReqBroker)({ settings, logger: defaultLogger });
-    const getSupportedRenderEnvironmentsWithCache = utils.general.cachify(getSupportedRenderEnvironments);
+    const req = (0, req_broker_1.makeReqBroker)({ settings, logger: mainLogger });
+    const getSupportedRenderEnvironmentsWithCache = utils.general.cachify(getSupportedRenderEnvironments, () => 'default');
     return {
         getSupportedRenderEnvironments: getSupportedRenderEnvironmentsWithCache,
         takeScreenshots,
@@ -44,7 +44,9 @@ function makeNMLRequests({ settings, logger: defaultLogger, }) {
         const result = await response.json();
         return result;
     }
-    async function takeScreenshots({ settings, logger = defaultLogger, }) {
+    async function takeScreenshots({ settings, logger = mainLogger, }) {
+        logger = logger.extend(mainLogger, { tags: [`nml-request-${utils.general.shortid()}`] });
+        logger.log('Request "takeScreenshots" called with settings', settings);
         const supportedRenderEnvironments = await getSupportedRenderEnvironmentsWithCache({ logger });
         const { localEnvironment, renderEnvironments, rendererSettings } = settings.renderers.reduce((result, renderer) => {
             var _a;
@@ -89,14 +91,13 @@ function makeNMLRequests({ settings, logger: defaultLogger, }) {
             });
             const result = await response.json();
             brokerUrl = result.nextPath;
-            if (localEnvironment) {
-                return [{ image: result.payload.result.screenshotUrl, renderEnvironment: localEnvironment }];
-            }
-            else {
-                return renderEnvironments.map((renderEnvironment, index) => {
+            const screenshots = localEnvironment
+                ? [{ image: result.payload.result.screenshotUrl, renderEnvironment: localEnvironment }]
+                : renderEnvironments.map((renderEnvironment, index) => {
                     return { image: result.payload[index].result.screenshotUrl, renderEnvironment };
                 });
-            }
+            logger.log('Request "takeScreenshots" finished successfully with body', screenshots);
+            return screenshots;
         }
         catch (error) {
             if (error.nextPath)
@@ -104,7 +105,7 @@ function makeNMLRequests({ settings, logger: defaultLogger, }) {
             throw error;
         }
     }
-    async function takeSnapshots({ settings, logger = defaultLogger, }) {
+    async function takeSnapshots({ settings, logger = mainLogger, }) {
         try {
             const response = await req(brokerUrl, {
                 name: 'TAKE_SNAPSHOT',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/nml-client",
-  "version": "1.5.9",
+  "version": "1.5.11",
   "description": "Client to integrate the SDKs to the Native Mobile Library (NML)",
   "homepage": "https://applitools.com",
   "bugs": {
@@ -36,12 +36,12 @@
     "test": "run --top-level mocha './test/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15}"
   },
   "dependencies": {
-    "@applitools/logger": "2.0.9",
-    "@applitools/req": "1.5.4",
-    "@applitools/utils": "1.5.2"
+    "@applitools/logger": "2.0.10",
+    "@applitools/req": "1.6.0",
+    "@applitools/utils": "1.6.0"
   },
   "devDependencies": {
-    "@applitools/spec-driver-webdriver": "^1.0.43",
+    "@applitools/spec-driver-webdriver": "^1.0.45",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55",

package/types/server/requests.d.ts

@@ -13,7 +13,7 @@ export interface NMLRequests {
         logger?: Logger;
     }): Promise<TSnapshot[]>;
 }
-export declare function makeNMLRequests({ settings, logger: defaultLogger, }: {
+export declare function makeNMLRequests({ settings, logger: mainLogger, }: {
     settings: BrokerServerSettings;
     logger: Logger;
 }): NMLRequests;