@applitools/ec-client 1.7.12 → 1.7.14

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # Changelog
 
+## [1.7.14](https://github.com/applitools/eyes.sdk.javascript1/compare/js/ec-client@1.7.13...js/ec-client@1.7.14) (2023-10-25)
+
+
+### Dependencies
+
+* @applitools/tunnel-client bumped to 1.3.0
+  #### Features
+
+  * add more logs for tunnel worker ([60cf839](https://github.com/applitools/eyes.sdk.javascript1/commit/60cf839f23b214dff89ff4a9c59f231c96160daf))
+
+## [1.7.13](https://github.com/applitools/eyes.sdk.javascript1/compare/js/ec-client@1.7.12...js/ec-client@1.7.13) (2023-10-17)
+
+
+### Code Refactoring
+
+* disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.6.2
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+* @applitools/logger bumped to 2.0.12
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/socket bumped to 1.1.12
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/req bumped to 1.6.2
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/image bumped to 1.1.7
+  #### Bug Fixes
+
+  * avoid using ascii text decoder ([1b68d39](https://github.com/applitools/eyes.sdk.javascript1/commit/1b68d3945d96b17b9ab1f1a87d352206fd0c81d6))
+
+
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.0.48
+
+* @applitools/driver bumped to 1.14.4
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/tunnel-client bumped to 1.2.4
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+* @applitools/core-base bumped to 1.7.2
+  #### Code Refactoring
+
+  * disallow usage of global Buffer ([#1957](https://github.com/applitools/eyes.sdk.javascript1/issues/1957)) ([adcc082](https://github.com/applitools/eyes.sdk.javascript1/commit/adcc082f20f6b92e819b96424e995d9a69d99758))
+
+
+
+
 ## [1.7.12](https://github.com/applitools/eyes.sdk.javascript1/compare/js/ec-client-v1.7.11...js/ec-client@1.7.12) (2023-09-29)
 
 

package/dist/client.js

@@ -32,7 +32,7 @@ async function makeECClient({ settings, logger: defaultLogger, } = {}) {
     var _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28, _29;
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'ec-client' } });
     settings !== null && settings !== void 0 ? settings : (settings = {});
-    (_a = settings.serverUrl) !== null && _a !== void 0 ? _a : (settings.serverUrl = (_c = (_b = utils.general.getEnvValue('EXECUTION_CLOUD_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EG_SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://exec-wus.applitools.com');
+    (_a = settings.ecServerUrl) !== null && _a !== void 0 ? _a : (settings.ecServerUrl = (_c = (_b = utils.general.getEnvValue('EXECUTION_CLOUD_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('EG_SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://exec-wus.applitools.com');
     (_d = settings.proxy) !== null && _d !== void 0 ? _d : (settings.proxy = utils.general.getEnvValue('PROXY_URL') ? { url: utils.general.getEnvValue('PROXY_URL') } : undefined);
     (_e = settings.useDnsCache) !== null && _e !== void 0 ? _e : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
     (_f = settings.tunnel) !== null && _f !== void 0 ? _f : (settings.tunnel = {});

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, { baseUrl: session.serverUrl, io: { request, response }, logger });
+        await req(request.url, { baseUrl: session.ecServerUrl, 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

@@ -45,7 +45,7 @@ function makeExecuteScript({ req, core }) {
                 const driver = await (0, driver_1.makeDriver)({
                     driver: {
                         sessionId: session.sessionId,
-                        serverUrl: session.serverUrl,
+                        serverUrl: session.ecServerUrl,
                         capabilities: session.capabilities,
                         proxy: session.proxy,
                     },
@@ -107,7 +107,7 @@ function makeExecuteScript({ req, core }) {
                 return;
             }
         }
-        await req(request.url, { baseUrl: session.serverUrl, body: requestBody, io: { request, response }, logger });
+        await req(request.url, { baseUrl: session.ecServerUrl, body: requestBody, io: { request, response }, logger });
     };
 }
 exports.makeExecuteScript = makeExecuteScript;

package/dist/commands/find-element.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeFindElement = void 0;
+const buffer_1 = require("buffer");
 function makeFindElement({ req }) {
     return async function findElement({ session, request, response, logger, }) {
         var _a, _b, _c;
         logger.log('Inspecting element lookup request to collect self-healing metadata');
         const proxyResponse = await req(request.url, {
-            baseUrl: session.serverUrl,
+            baseUrl: session.ecServerUrl,
             io: { request, response, handle: false },
             logger,
         });
@@ -22,7 +23,7 @@ function makeFindElement({ req }) {
         }
         response
             .writeHead(proxyResponse.status, Object.fromEntries(proxyResponse.headers.entries()))
-            .end(Buffer.from(responseBody));
+            .end(buffer_1.Buffer.from(responseBody));
     };
 }
 exports.makeFindElement = makeFindElement;

package/dist/commands/start-session.js

@@ -24,8 +24,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeStartSession = void 0;
-const tunnel_client_1 = require("@applitools/tunnel-client");
 const abort_controller_1 = require("abort-controller");
+const buffer_1 = require("buffer");
+const tunnel_client_1 = require("@applitools/tunnel-client");
 const utils = __importStar(require("@applitools/utils"));
 const SERVER_URLS = {
     'us-west': 'https://exec-wus.applitools.com',
@@ -59,21 +60,21 @@ function makeStartSession({ settings, req, tunnels }) {
                 Object.fromEntries(Object.entries(capabilities).map(([key, value]) => [key.replace(/^applitools:/, ''), value]))),
         };
         const session = {
-            serverUrl: settings.serverUrl,
+            ecServerUrl: settings.ecServerUrl,
             proxy: settings.proxy,
             credentials: { eyesServerUrl: options.eyesServerUrl, apiKey: options.apiKey },
             options,
         };
         if (options.region) {
             if (SERVER_URLS[options.region])
-                session.serverUrl = SERVER_URLS[options.region];
+                session.ecServerUrl = SERVER_URLS[options.region];
             else
                 throw new Error(`Failed to create session in unknown region ${options.region}`);
         }
         if (options.tunnel && tunnels) {
             // TODO should be removed once tunnel spawning issue is solved
-            await (0, tunnel_client_1.prepareTunnelEnvironment)({ settings: { tunnelServerUrl: session.serverUrl }, logger });
-            session.tunnels = await tunnels.acquire({ ...session.credentials, tunnelServerUrl: session.serverUrl });
+            await (0, tunnel_client_1.prepareTunnelEnvironment)({ settings: { tunnelServerUrl: session.ecServerUrl }, logger });
+            session.tunnels = await tunnels.acquire({ ...session.credentials, tunnelServerUrl: session.ecServerUrl });
         }
         const applitoolsCapabilities = Object.fromEntries([
             ...Object.entries(options).map(([key, value]) => [`applitools:${key}`, value]),
@@ -109,7 +110,7 @@ function makeStartSession({ settings, req, tunnels }) {
             if (signal.aborted)
                 return queue.pause;
             const proxyResponse = await req(request.url, {
-                baseUrl: session.serverUrl,
+                baseUrl: session.ecServerUrl,
                 body: requestBody,
                 io: { request, response, handle: false },
                 // TODO uncomment when we can throw different abort reasons for task cancelation and timeout abortion
@@ -133,7 +134,7 @@ function makeStartSession({ settings, req, tunnels }) {
                     (_c = (_d = responseBody.value).capabilities) !== null && _c !== void 0 ? _c : (_d.capabilities = {});
                     responseBody.value.capabilities['applitools:isECClient'] = true;
                     if (proxyResponse.headers.has('content-length')) {
-                        proxyResponse.headers.set('content-length', Buffer.byteLength(JSON.stringify(responseBody)).toString());
+                        proxyResponse.headers.set('content-length', buffer_1.Buffer.byteLength(JSON.stringify(responseBody)).toString());
                     }
                     session.sessionId = responseBody.value.sessionId;
                     session.capabilities = responseBody.value.capabilities;

package/dist/req-proxy.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeReqProxy = void 0;
+const buffer_1 = require("buffer");
 const req_1 = require("@applitools/req");
 const utils = __importStar(require("@applitools/utils"));
 function makeReqProxy(config) {
@@ -48,7 +49,7 @@ function makeReqProxy(config) {
                     delete options.headers['content-type'];
                 }
                 else if (!utils.types.isFunction(options.body, 'pipe')) {
-                    options.headers['content-length'] = Buffer.byteLength(utils.types.isArray(options.body) || utils.types.isPlainObject(options.body) || options.body === null
+                    options.headers['content-length'] = buffer_1.Buffer.byteLength(utils.types.isArray(options.body) || utils.types.isPlainObject(options.body) || options.body === null
                         ? JSON.stringify(options.body)
                         : options.body).toString();
                 }

package/dist/server.js

@@ -56,7 +56,7 @@ async function makeServer({ settings, logger: mainLogger, }) {
     const core = (0, core_base_1.makeCore)({ agentId: `js/ec-client/${require('../package.json').version}` });
     const tunnels = ((_a = settings.tunnel) === null || _a === void 0 ? void 0 : _a.serviceUrl)
         ? await (0, manager_1.makeTunnelManager)({ settings: settings.tunnel, logger: serverLogger })
-        : await (0, manager_client_1.makeTunnelManagerClient)({ settings: settings.tunnel });
+        : await (0, manager_client_1.makeTunnelManagerClient)({ settings: settings.tunnel, logger: serverLogger });
     const sessions = new Map();
     const commands = {
         startSession: (0, start_session_1.makeStartSession)({ settings, req, tunnels }),
@@ -87,7 +87,7 @@ async function makeServer({ settings, logger: mainLogger, }) {
         router.any(/^\/session\/(?<sessionId>[^\/]+).*$/, async ({ match }) => {
             requestLogger.log('Passthrough request');
             const session = sessions.get(match.groups.sessionId);
-            await req(request.url, { baseUrl: session.serverUrl, io: { request, response }, logger: requestLogger });
+            await req(request.url, { baseUrl: session.ecServerUrl, io: { request, response }, logger: requestLogger });
         });
         router.fallback(async () => {
             throw new Error('Unknown request');

package/dist/tunnels/manager-client.js

@@ -5,7 +5,7 @@ const manager_server_1 = require("./manager-server");
 const socket_1 = require("@applitools/socket");
 const fs_1 = require("fs");
 const net_1 = require("net");
-async function makeTunnelManagerClient({ settings, } = {}) {
+async function makeTunnelManagerClient({ settings, logger, }) {
     const path = process.env.APPLITOOLS_TUNNEL_MANAGER_SOCK ||
         (process.platform === 'win32' ? '\\\\.\\pipe\\applitools-tunnel-manager' : '/tmp/applitools-tunnel-manager.sock');
     const socket = (0, socket_1.makeSocket)((0, net_1.createConnection)({ path }), { transport: 'ipc' });
@@ -19,7 +19,14 @@ async function makeTunnelManagerClient({ settings, } = {}) {
                     }
                     catch { }
                 }
-                server = await (0, manager_server_1.makeTunnelManagerServerProcess)({ settings, path });
+                logger.log(`Starting tunnel manager in separate process using path ${path} and settings`, settings);
+                try {
+                    server = await (0, manager_server_1.makeTunnelManagerServerProcess)({ settings, path });
+                }
+                catch (error) {
+                    if (error.code !== 'EADDRINUSE')
+                        throw error;
+                }
             }
         }
         finally {

package/dist/tunnels/manager-server.js

@@ -35,81 +35,95 @@ const os = __importStar(require("os"));
 const LOG_DIRNAME = (_a = process.env.APPLITOOLS_LOG_DIR) !== null && _a !== void 0 ? _a : path.resolve(os.tmpdir(), `applitools-tunnel-logs`);
 async function makeTunnelManagerServer({ settings, path, idleTimeout = 600000, // 10min
  }) {
-    var _a;
-    const server = await new Promise((resolve, reject) => {
-        const server = (0, net_1.createServer)().listen({ path });
-        server.on('error', error => reject(error));
-        server.on('listening', () => resolve(server));
-    });
-    const logger = (0, logger_1.makeLogger)({
-        handler: { type: 'rolling file', name: 'ec-tunnel-manager', dirname: LOG_DIRNAME },
-        level: 'info',
-        format: {
-            label: 'ec-tunnel-manager',
-            colors: false,
-        },
-    });
-    logger.log('Server is started');
-    const manager = await (0, manager_1.makeTunnelManager)({ settings, logger });
-    (_a = process.send) === null || _a === void 0 ? void 0 : _a.call(process, { name: 'started', payload: { path } }); // NOTE: this is a part of the js specific protocol
-    let idle;
-    let serverClosed = false;
-    if (idleTimeout)
-        idle = setTimeout(close, idleTimeout);
-    server.on('close', () => {
-        if (idle)
-            clearTimeout(idle);
-        serverClosed = true;
-    });
-    const sockets = new Set();
-    server.on('connection', client => {
-        const store = [];
-        if (idle)
-            idle = clearTimeout(idle);
-        const socket = (0, socket_1.makeSocket)(client, { transport: 'ipc', logger });
-        sockets.add(socket);
-        socket.on('close', async () => {
-            logger.log('Connection is closed, remaining tunnels are going to be released', store);
-            await Promise.all(store.map(manager.release)).catch(logger.error);
-            if (sockets.size === 0 && !serverClosed)
-                idle = setTimeout(close, idleTimeout);
+    var _a, _b;
+    try {
+        const server = await new Promise((resolve, reject) => {
+            const server = (0, net_1.createServer)().listen({ path });
+            server.on('error', error => reject(error));
+            server.on('listening', () => resolve(server));
         });
-        socket.command('Tunnel.acquire', async (credentials) => {
-            const tunnels = await manager.acquire(credentials);
-            store.push(tunnels);
-            return tunnels;
+        const logger = (0, logger_1.makeLogger)({
+            handler: { type: 'rolling file', name: 'ec-tunnel-manager', dirname: LOG_DIRNAME },
+            level: 'info',
+            format: {
+                label: 'ec-tunnel-manager',
+                colors: false,
+            },
         });
-        socket.command('Tunnel.release', async (tunnels) => {
-            await manager.release(tunnels);
-            const storeIndex = store.findIndex(storedTunnels => tunnels.every((tunnel, index) => tunnel.tunnelId === storedTunnels[index].tunnelId));
-            tunnels.splice(storeIndex, 1);
+        logger.log('Server is started');
+        const manager = await (0, manager_1.makeTunnelManager)({ settings, logger });
+        (_a = process.send) === null || _a === void 0 ? void 0 : _a.call(process, { name: 'started', payload: { path } });
+        let idle;
+        let serverClosed = false;
+        if (idleTimeout)
+            idle = setTimeout(close, idleTimeout);
+        server.on('close', () => {
+            if (idle)
+                clearTimeout(idle);
+            serverClosed = true;
         });
-    });
-    return { close };
-    async function close() {
-        logger.log('Server is going to be closed');
-        server.close();
-        await manager.close();
-        process.kill(0);
+        const sockets = new Set();
+        server.on('connection', client => {
+            const store = [];
+            if (idle)
+                idle = clearTimeout(idle);
+            const socket = (0, socket_1.makeSocket)(client, { transport: 'ipc', logger });
+            sockets.add(socket);
+            socket.on('close', async () => {
+                logger.log('Connection is closed, remaining tunnels are going to be released', store);
+                await Promise.all(store.map(manager.release)).catch(logger.error);
+                if (sockets.size === 0 && !serverClosed)
+                    idle = setTimeout(close, idleTimeout);
+            });
+            socket.command('Tunnel.acquire', async (credentials) => {
+                const tunnels = await manager.acquire(credentials);
+                store.push(tunnels);
+                return tunnels;
+            });
+            socket.command('Tunnel.release', async (tunnels) => {
+                await manager.release(tunnels);
+                const storeIndex = store.findIndex(storedTunnels => tunnels.every((tunnel, index) => tunnel.tunnelId === storedTunnels[index].tunnelId));
+                tunnels.splice(storeIndex, 1);
+            });
+        });
+        return { close };
+        async function close() {
+            logger.log('Server is going to be closed');
+            server.close();
+            await manager.close();
+            process.kill(0);
+        }
+    }
+    catch (error) {
+        (_b = process.send) === null || _b === void 0 ? void 0 : _b.call(process, { name: 'error', payload: { error: { message: error.message, code: error.code, stack: error.stack } } });
+        throw error;
     }
 }
 exports.makeTunnelManagerServer = makeTunnelManagerServer;
 async function makeTunnelManagerServerProcess(options) {
     return new Promise((resolve, reject) => {
         const server = (0, child_process_1.fork)(path.resolve(__dirname, '../../dist/cli/cli.js'), [`tunnel-manager`, `--config=${JSON.stringify(options)}`], {
-            stdio: ['ignore', 'ignore', 'ignore', 'ipc'],
+            stdio: ['ignore', 'ignore', 'inherit', 'ipc'],
             detached: true,
         });
         const timeout = setTimeout(() => {
             reject(new Error(`Server didn't respond for 10s after being started`));
             server.kill();
-        }, 5000);
+        }, 10000);
         server.on('error', reject);
-        server.once('message', ({ name }) => {
+        server.once('message', (message) => {
+            const { name, payload } = message;
+            server.channel.unref();
             if (name === 'started') {
                 resolve({ close: async () => void server.kill() });
                 clearTimeout(timeout);
-                server.channel.unref();
+            }
+            else if (name === 'error') {
+                const error = new Error(payload.error.message);
+                error.code = payload.error.code;
+                error.stack = payload.error.stack;
+                reject(error);
+                clearTimeout(timeout);
             }
         });
         server.unref();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/ec-client",
-  "version": "1.7.12",
+  "version": "1.7.14",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -52,14 +52,14 @@
     "test:it": "MOCHA_GROUP=it run --top-level mocha './test/it/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core-base": "1.7.1",
-    "@applitools/driver": "1.14.3",
-    "@applitools/logger": "2.0.11",
-    "@applitools/req": "1.6.1",
-    "@applitools/socket": "1.1.11",
-    "@applitools/spec-driver-webdriver": "1.0.47",
-    "@applitools/tunnel-client": "1.2.3",
-    "@applitools/utils": "1.6.1",
+    "@applitools/core-base": "1.7.2",
+    "@applitools/driver": "1.14.4",
+    "@applitools/logger": "2.0.12",
+    "@applitools/req": "1.6.2",
+    "@applitools/socket": "1.1.12",
+    "@applitools/spec-driver-webdriver": "1.0.48",
+    "@applitools/tunnel-client": "1.3.0",
+    "@applitools/utils": "1.6.2",
     "abort-controller": "3.0.0",
     "webdriver": "7.31.1",
     "yargs": "^17.7.2"

package/types/tunnels/manager-client.d.ts

@@ -1,7 +1,9 @@
 import type { TunnelManagerSettings } from '../types';
+import { type Logger } from '@applitools/logger';
 import { type TunnelManager } from './manager';
-export declare function makeTunnelManagerClient({ settings, }?: {
+export declare function makeTunnelManagerClient({ settings, logger, }: {
     settings?: TunnelManagerSettings;
+    logger: Logger;
 }): Promise<TunnelManager & {
     close(): Promise<void>;
 }>;

package/types/types.d.ts

@@ -8,7 +8,7 @@ export interface ECClient {
     close(): void;
 }
 export interface ECClientSettings {
-    serverUrl: string;
+    ecServerUrl: string;
     proxy?: Proxy;
     useDnsCache?: boolean;
     options?: ECCapabilitiesOptions;
@@ -32,7 +32,7 @@ export interface ECCapabilitiesOptions {
     selfHealingMaxRetryTime?: number;
 }
 export interface ECSession {
-    serverUrl: string;
+    ecServerUrl: string;
     proxy?: Proxy;
     sessionId: string;
     credentials: {