@applitools/ec-client 1.2.33 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## [1.3.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/ec-client@1.2.34...js/ec-client@1.3.0) (2023-06-21)
+
+
+### Features
+
+* put in a queue create tunnel requests which cannot succeed due to a limit ([3309147](https://github.com/applitools/eyes.sdk.javascript1/commit/33091473f3fcbc4dd5fc853624bbe441ce11ce87))
+
+
+### Dependencies
+
+* @applitools/core-base bumped from 1.1.58 to 1.2.0
+  #### Features
+
+  * **js/core-base:** new feature ([dd5705d](https://github.com/applitools/eyes.sdk.javascript1/commit/dd5705d5e99d34f9492e890a0b4af6c52d6b33e3))
+
+
+  #### Bug Fixes
+
+  * rerelease ([2d46d0c](https://github.com/applitools/eyes.sdk.javascript1/commit/2d46d0c9ee14a72406e60350d4cce92991272afd))
+
+
+
+* @applitools/driver bumped from 1.12.2 to 1.12.3
+
+* @applitools/logger bumped from 2.0.3 to 2.0.4
+  #### Bug Fixes
+
+  * fixed issue when extended logger didn't preserve base's handler ([7c5e029](https://github.com/applitools/eyes.sdk.javascript1/commit/7c5e0299522f792aad72b7b3827df31a1ab2d68f))
+* @applitools/socket bumped from 1.1.3 to 1.1.4
+
+* @applitools/spec-driver-webdriver bumped from 1.0.34 to 1.0.35
+
+
+## [1.2.34](https://github.com/applitools/eyes.sdk.javascript1/compare/js/ec-client@1.2.33...js/ec-client@1.2.34) (2023-06-15)
+
+
+### Bug Fixes
+
+* solve mismatch between content type and body in some commands ([#1660](https://github.com/applitools/eyes.sdk.javascript1/issues/1660)) ([8d1d486](https://github.com/applitools/eyes.sdk.javascript1/commit/8d1d4863d09af8266e93c59f99fa9f5a497652a9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @applitools/core-base bumped from 1.1.57 to 1.1.58
+    * @applitools/req bumped from 1.3.1 to 1.3.2
+    * @applitools/socket bumped from 1.1.2 to 1.1.3
+
 ## [1.2.33](https://github.com/applitools/eyes.sdk.javascript1/compare/js/ec-client-v1.2.32...js/ec-client@1.2.33) (2023-06-13)
 
 

package/dist/commands/end-session.js

@@ -6,7 +6,7 @@ function makeEndSession({ req, tunnels }) {
         var _a, _b;
         var _c;
         logger.log(`Request was intercepted with sessionId:`, session.sessionId);
-        await req(request.url, { io: { request, response }, logger });
+        await req(request.url, { body: null, io: { request, response }, logger });
         if ((_a = session.tests) === null || _a === void 0 ? void 0 : _a.current) {
             await session.tests.current.abort({ settings: { testMetadata: session.metadata }, logger });
             (_b = (_c = session.tests).ended) !== null && _b !== void 0 ? _b : (_c.ended = []);

package/dist/commands/execute-script.js

@@ -72,7 +72,7 @@ function makeExecuteScript({ req, core }) {
                     },
                     logger,
                 });
-                response.writeHead(200).end(JSON.stringify({ value: null }));
+                response.writeHead(200, { 'content-type': 'application/json' }).end(JSON.stringify({ value: null }));
                 return;
             }
             else if (requestBody.script === 'applitools:endTest') {
@@ -85,22 +85,24 @@ function makeExecuteScript({ req, core }) {
                     session.tests.ended.push(session.tests.current);
                     session.tests.current = undefined;
                 }
-                response.writeHead(200).end(JSON.stringify({ value: null }));
+                response.writeHead(200, { 'content-type': 'application/json' }).end(JSON.stringify({ value: null }));
                 return;
             }
             else if (requestBody.script === 'applitools:getResults') {
                 if ((_q = session.tests) === null || _q === void 0 ? void 0 : _q.ended) {
                     const results = await Promise.all(session.tests.ended.map(test => test.getResults({ logger })));
-                    response.writeHead(200).end(JSON.stringify({ value: results.flat() }));
+                    response.writeHead(200, { 'content-type': 'application/json' }).end(JSON.stringify({ value: results.flat() }));
                 }
                 else {
-                    response.writeHead(200).end(JSON.stringify({ value: [] }));
+                    response.writeHead(200, { 'content-type': 'application/json' }).end(JSON.stringify({ value: [] }));
                 }
                 return;
             }
             else if (requestBody.script === 'applitools:metadata') {
                 logger.log('Session metadata requested, returning', session.metadata);
-                response.writeHead(200).end(JSON.stringify({ value: (_r = session.metadata) !== null && _r !== void 0 ? _r : [] }));
+                response
+                    .writeHead(200, { 'content-type': 'application/json' })
+                    .end(JSON.stringify({ value: (_r = session.metadata) !== null && _r !== void 0 ? _r : [] }));
                 session.metadata = [];
                 return;
             }

package/dist/tunnels/manager.js

@@ -25,9 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeTunnelManager = void 0;
 const req_1 = require("@applitools/req");
+const queue_1 = require("../utils/queue");
 //@ts-ignore
 const execution_grid_tunnel_1 = require("@applitools/execution-grid-tunnel");
 const utils = __importStar(require("@applitools/utils"));
+const RETRY_BACKOFF = [
+    ...Array(5).fill(2000),
+    ...Array(4).fill(5000),
+    10000, // all next tries with delay 10s
+];
 async function makeTunnelManager({ settings, logger, }) {
     let server;
     const getTunnelServiceUrl = utils.general.cachify(async () => {
@@ -42,24 +48,8 @@ async function makeTunnelManager({ settings, logger, }) {
         };
         return `http://localhost:${port}`;
     });
-    const req = (0, req_1.makeReq)({
-        retry: {
-            validate: async ({ response }) => {
-                if (!response)
-                    return false;
-                const body = await response
-                    .clone()
-                    .json()
-                    .catch(() => null);
-                return ['CONCURRENCY_LIMIT_REACHED', 'NO_AVAILABLE_TUNNEL_PROXY'].includes(body === null || body === void 0 ? void 0 : body.message);
-            },
-            timeout: [
-                ...Array(5).fill(2000),
-                ...Array(4).fill(5000),
-                10000, // all next tries with delay 10s
-            ],
-        },
-    });
+    const req = (0, req_1.makeReq)({});
+    const queues = new Map();
     const pools = new Map();
     return { create, destroy, acquire, release, close: async () => server === null || server === void 0 ? void 0 : server.close() };
     async function acquire(credentials) {
@@ -83,24 +73,48 @@ async function makeTunnelManager({ settings, logger, }) {
         await pool.release(tunnels);
     }
     async function create(credentials) {
-        var _a, _b;
         if (!(settings === null || settings === void 0 ? void 0 : settings.serverUrl)) {
             settings !== null && settings !== void 0 ? settings : (settings = {});
             settings.serverUrl = await getTunnelServiceUrl();
         }
-        const response = await req('/tunnels', {
-            method: 'POST',
-            baseUrl: settings.serverUrl,
-            headers: {
-                'x-eyes-api-key': credentials.apiKey,
-                'x-eyes-server-url': credentials.eyesServerUrl,
-            },
-        });
-        const body = await response.json().catch(() => null);
-        if (response.status === 201)
-            return { tunnelId: body, credentials };
-        logger.error(`Failed to create tunnel with status ${response.status} and code ${(_a = body === null || body === void 0 ? void 0 : body.message) !== null && _a !== void 0 ? _a : 'UNKNOWN_ERROR'}`);
-        throw new Error(`Failed to create tunnel with code ${(_b = body === null || body === void 0 ? void 0 : body.message) !== null && _b !== void 0 ? _b : 'UNKNOWN_ERROR'}`);
+        const queueKey = JSON.stringify(credentials);
+        let queue = queues.get(queueKey);
+        if (!queue) {
+            queue = (0, queue_1.makeQueue)({ logger: logger.extend({ tags: [`queue-${queueKey}`] }) });
+            queues.set(queueKey, queue);
+        }
+        return queue.run(task);
+        async function task(signal, attempt = 1) {
+            var _a, _b;
+            if (signal.aborted)
+                return queue.pause;
+            const response = await req('/tunnels', {
+                method: 'POST',
+                baseUrl: settings.serverUrl,
+                headers: {
+                    'x-eyes-api-key': credentials.apiKey,
+                    'x-eyes-server-url': credentials.eyesServerUrl,
+                },
+                // TODO uncomment when we can throw different abort reasons for task cancelation and timeout abortion
+                // signal,
+            });
+            const body = await response.json().catch(() => null);
+            if (['CONCURRENCY_LIMIT_REACHED', 'NO_AVAILABLE_TUNNEL_PROXY'].includes(body === null || body === void 0 ? void 0 : body.message)) {
+                queue.cork();
+                // after query is corked the task might be aborted
+                if (signal.aborted)
+                    return queue.pause;
+                await utils.general.sleep(RETRY_BACKOFF[Math.min(attempt, RETRY_BACKOFF.length - 1)]);
+                return task(signal, attempt + 1);
+            }
+            else {
+                queue.uncork();
+                if (response.status === 201)
+                    return { tunnelId: body, credentials };
+                logger.error(`Failed to create tunnel with status ${response.status} and code ${(_a = body === null || body === void 0 ? void 0 : body.message) !== null && _a !== void 0 ? _a : 'UNKNOWN_ERROR'}`);
+                throw new Error(`Failed to create tunnel with code ${(_b = body === null || body === void 0 ? void 0 : body.message) !== null && _b !== void 0 ? _b : 'UNKNOWN_ERROR'}`);
+            }
+        }
     }
     async function destroy(tunnel) {
         var _a, _b;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/ec-client",
-  "version": "1.2.33",
+  "version": "1.3.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -52,13 +52,13 @@
     "test:it": "MOCHA_GROUP=it run --top-level mocha './test/it/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core-base": "1.1.57",
-    "@applitools/driver": "1.12.2",
+    "@applitools/core-base": "1.2.0",
+    "@applitools/driver": "1.12.3",
     "@applitools/execution-grid-tunnel": "2.1.0",
-    "@applitools/logger": "2.0.3",
-    "@applitools/req": "1.3.1",
-    "@applitools/socket": "1.1.2",
-    "@applitools/spec-driver-webdriver": "1.0.34",
+    "@applitools/logger": "2.0.4",
+    "@applitools/req": "1.3.2",
+    "@applitools/socket": "1.1.4",
+    "@applitools/spec-driver-webdriver": "1.0.35",
     "@applitools/utils": "1.4.0",
     "abort-controller": "3.0.0",
     "webdriver": "7",
@@ -72,9 +72,12 @@
     "@types/selenium-webdriver": "^4.0.19",
     "@types/yargs": "^17.0.19",
     "nock": "^13.2.4",
-    "selenium-webdriver": "^4.1.2"
+    "selenium-webdriver": "^4.10.0"
   },
   "engines": {
     "node": ">=12.13.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }