@applitools/core 3.1.0 → 3.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 3.2.0 - 2023/5/31
+
+### Features
+- Drop support of legacy vhs extraction
+### Bug fixes
+- Fixed issue when logs are not show up
+
 ## 3.1.0 - 2023/5/22
 
 ### Features

package/dist/ufg/check-and-close.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
-const take_vhses_1 = require("./utils/take-vhses");
 const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
@@ -137,12 +136,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger:
             }
             else {
                 const nmlClient = await eyes.core.getNMLClient({ config: eyes.test.server, driver, logger });
-                if (nmlClient) {
-                    snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
-                }
-                else {
-                    snapshots = await (0, take_vhses_1.takeVHSes)({ driver, ...snapshotOptions, logger });
-                }
+                snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
             }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
@@ -244,12 +238,14 @@ function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger:
                     return { ...result, userTestId: eyes.test.userTestId, eyes: baseEyes, renderer };
                 }
                 catch (error) {
+                    rendererLogger.error(`Renderer with id ${baseEyes.test.rendererId} failed due to an error`, error);
                     await baseEyes.abort({ logger: rendererLogger });
                     error.info = { eyes: baseEyes };
                     throw error;
                 }
             }
             catch (error) {
+                rendererLogger.error(`Renderer with id ${renderer.id} failed before rendering started due to an error`, error);
                 error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
                 throw error;
             }

package/dist/ufg/check.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
-const take_vhses_1 = require("./utils/take-vhses");
 const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
@@ -138,12 +137,7 @@ function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: mainLogg
             }
             else {
                 const nmlClient = await eyes.core.getNMLClient({ config: eyes.test.server, driver, logger });
-                if (nmlClient) {
-                    snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
-                }
-                else {
-                    snapshots = await (0, take_vhses_1.takeVHSes)({ driver, ...snapshotOptions, logger });
-                }
+                snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
             }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
@@ -249,6 +243,7 @@ function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: mainLogg
                     return { ...result, eyes: baseEyes, renderer };
                 }
                 catch (error) {
+                    rendererLogger.error(`Renderer with id ${baseEyes.test.rendererId} failed due to an error`, error);
                     if (baseEyes.running && !(signal === null || signal === void 0 ? void 0 : signal.aborted))
                         await baseEyes.abort({ logger: rendererLogger });
                     error.info = { eyes: baseEyes };
@@ -256,6 +251,7 @@ function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: mainLogg
                 }
             }
             catch (error) {
+                rendererLogger.error(`Renderer with id ${renderer.id} failed before rendering started due to an error`, error);
                 error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
                 throw error;
             }

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

@@ -35,7 +35,7 @@ function makeGetNMLClient({ client, logger: mainLogger }) {
         logger = logger.extend(mainLogger);
         const brokerUrl = await driver.extractBrokerUrl();
         if (!brokerUrl)
-            return null;
+            throw new Error('Unable to extract broker url from the device');
         return (0, nml_client_1.makeNMLClient)({ config: { brokerUrl, ...config }, logger });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -78,19 +78,19 @@
     ]
   },
   "dependencies": {
-    "@applitools/core-base": "1.1.55",
+    "@applitools/core-base": "1.1.56",
     "@applitools/dom-capture": "11.2.2",
     "@applitools/dom-snapshot": "4.7.9",
-    "@applitools/driver": "1.12.0",
-    "@applitools/ec-client": "1.2.31",
-    "@applitools/logger": "2.0.1",
-    "@applitools/nml-client": "1.3.54",
+    "@applitools/driver": "1.12.1",
+    "@applitools/ec-client": "1.2.32",
+    "@applitools/logger": "2.0.2",
+    "@applitools/nml-client": "1.3.55",
     "@applitools/req": "1.3.0",
-    "@applitools/screenshoter": "3.7.45",
+    "@applitools/screenshoter": "3.7.46",
     "@applitools/snippets": "2.4.21",
-    "@applitools/socket": "1.1.0",
-    "@applitools/spec-driver-webdriver": "1.0.32",
-    "@applitools/ufg-client": "1.2.16",
+    "@applitools/socket": "1.1.1",
+    "@applitools/spec-driver-webdriver": "1.0.33",
+    "@applitools/ufg-client": "1.2.17",
     "@applitools/utils": "1.3.37",
     "@types/ws": "8.5.4",
     "abort-controller": "3.0.0",
@@ -101,12 +101,12 @@
     "yargs": "17.6.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^3.0.4",
+    "@applitools/bongo": "^4.0.0",
     "@applitools/sdk-coverage-tests": "^3.0.2",
-    "@applitools/spec-driver-puppeteer": "^1.1.63",
-    "@applitools/spec-driver-selenium": "^1.5.46",
-    "@applitools/spec-driver-webdriverio": "^1.5.1",
-    "@applitools/test-server": "^1.2.1",
+    "@applitools/spec-driver-puppeteer": "^1.1.64",
+    "@applitools/spec-driver-selenium": "^1.5.47",
+    "@applitools/spec-driver-webdriverio": "^1.5.2",
+    "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",

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

@@ -9,9 +9,9 @@ export declare function makeGetNMLClient({ client, logger: mainLogger }: Options
     driver: Driver<SpecType>;
     config: Omit<NMLRequestsConfig, 'brokerUrl'>;
     logger?: Logger | undefined;
-}) => Promise<NMLClient | null>) & {
-    getCachedValues(): Promise<NMLClient | null>[];
-    setCachedValue(key: any, value: Promise<NMLClient | null>): void;
+}) => Promise<NMLClient>) & {
+    getCachedValues(): Promise<NMLClient>[];
+    setCachedValue(key: any, value: Promise<NMLClient>): void;
     clearCache(): void;
 };
 export {};

package/types/ufg/types.d.ts

@@ -20,7 +20,7 @@ export interface Core<TSpec extends SpecType> extends AutomationCore.Core<TSpec>
         config: Omit<NMLRequestsConfig, 'brokerUrl'>;
         driver: Driver<TSpec>;
         logger?: Logger;
-    }): Promise<NMLClient | null>;
+    }): Promise<NMLClient>;
     openEyes(options: {
         target?: AutomationCore.DriverTarget<TSpec>;
         settings: AutomationCore.OpenSettings;

package/dist/ufg/utils/take-vhses.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.takeVHSes = void 0;
-async function takeVHSes({ driver, settings, hooks, logger, }) {
-    var _a;
-    logger.log('taking VHS');
-    const environment = await driver.getEnvironment();
-    if (!environment.isAndroid && !environment.isIOS) {
-        throw new Error('cannot take VHS on mobile device other than iOS or Android');
-    }
-    await ((_a = hooks === null || hooks === void 0 ? void 0 : hooks.beforeSnapshots) === null || _a === void 0 ? void 0 : _a.call(hooks));
-    const trigger = await driver.waitFor(environment.isAndroid
-        ? { type: 'xpath', selector: `//android.widget.Button[@content-desc="UFG_TriggerArea"]` }
-        : { type: 'accessibility id', selector: 'UFG_TriggerArea' }, { timeout: 30000 });
-    if (!trigger)
-        throw new Error('Trigger element could not be found');
-    if (environment.isAndroid) {
-        const apiKeyInput = await driver.element({
-            type: 'xpath',
-            selector: `//android.widget.EditText[@content-desc="UFG_Apikey"]`,
-        });
-        if (apiKeyInput) {
-            // in case 'apiKeyInput' does not exist, it means it was already triggered on previous cycle
-            // this condition is to avoid re-sending 'inputJson' multiple times
-            const inputString = JSON.stringify({
-                serverUrl: settings.serverUrl,
-                apiKey: settings.apiKey,
-                proxy: settings.proxy && transformProxy(settings.proxy),
-            });
-            logger.log('sending API key to UFG lib', inputString);
-            await apiKeyInput.type(inputString);
-            const ready = await driver.element({
-                type: 'xpath',
-                selector: `//android.widget.Button[@content-desc="UFG_ApikeyReady"]`,
-            });
-            if (!ready)
-                throw new Error('Api key readiness element could not be found');
-            await ready.click();
-        }
-        else {
-            logger.log('UFG_Apikey was skipped');
-        }
-    }
-    await trigger.click(); // TODO handle stale element exception and then find the trigger again and click it
-    let label = await driver.waitFor(environment.isAndroid
-        ? { type: 'xpath', selector: `//android.widget.TextView[@content-desc="UFG_SecondaryLabel"]` }
-        : { type: 'accessibility id', selector: 'UFG_SecondaryLabel' }, { timeout: 10000 });
-    if (!label) {
-        // This might happen if the tap on the trigger area didn't happen due to Appium bug. So we try to find the trigger again and if it's present, we'll tap it.
-        // If the trigger area is not present, then we're probably at the middle of taking the VHS - give it 50 seconds more until we give up
-        logger.log('UFG_SecondaryLabel was not found after 10 seconds, trying to click UFG_TriggerArea again');
-        const triggerRetry = await driver.waitFor(environment.isAndroid
-            ? { type: 'xpath', selector: `//android.widget.Button[@content-desc="UFG_TriggerArea"]` }
-            : { type: 'accessibility id', selector: 'UFG_TriggerArea' }, { timeout: 30000 });
-        if (triggerRetry) {
-            logger.log('UFG_TriggerArea was found on retry. clicking it.');
-            await triggerRetry.click();
-        }
-        else {
-            logger.log('UFG_TriggerArea was NOT found on retry. Probably VHS is being taken.');
-        }
-        label = await driver.waitFor(environment.isAndroid
-            ? { type: 'xpath', selector: `//android.widget.TextView[@content-desc="UFG_SecondaryLabel"]` }
-            : { type: 'accessibility id', selector: 'UFG_SecondaryLabel' }, { timeout: 50000 });
-        if (!label) {
-            logger.log('UFG_SecondaryLabel was not found eventually. Giving up.');
-            throw new Error('Secondary label element could not be found');
-        }
-    }
-    const info = JSON.parse(await label.getText());
-    logger.log('VHS info', info);
-    if (info.error)
-        throw new Error(`Error while taking VHS - ${info.error}`);
-    let vhs = '';
-    if (environment.isIOS) {
-        const label = await driver.element({ type: 'accessibility id', selector: 'UFG_Label' });
-        if (!label)
-            throw new Error('VHS label element could not be found');
-        vhs = await label.getText();
-    }
-    else if (info.mode === 'labels') {
-        const labels = [
-            await driver.element({ type: 'xpath', selector: `//android.widget.TextView[@content-desc="UFG_Label_0"]` }),
-            await driver.element({ type: 'xpath', selector: `//android.widget.TextView[@content-desc="UFG_Label_1"]` }),
-            await driver.element({ type: 'xpath', selector: `//android.widget.TextView[@content-desc="UFG_Label_2"]` }),
-        ];
-        if (labels.some(label => !label))
-            throw new Error('VHS label element could not be found');
-        for (let chunk = 0; chunk < info.partsCount / labels.length; ++chunk) {
-            for (let label = 0; label < Math.min(labels.length, info.partsCount - chunk * labels.length); ++label) {
-                vhs += await labels[label].getText();
-            }
-            if (chunk * labels.length < info.partsCount)
-                await trigger.click();
-        }
-    }
-    else if (info.mode === 'network') {
-        // do nothing
-    }
-    else {
-        throw new Error(`unknown mode for android: ${info.mode}`);
-    }
-    const clear = await driver.waitFor(environment.isAndroid
-        ? { type: 'xpath', selector: `//android.widget.Button[@content-desc="UFG_ClearArea"]` }
-        : { type: 'accessibility id', selector: 'UFG_ClearArea' }, { timeout: 30000 });
-    if (!clear)
-        throw new Error('Clear element could not be found');
-    await clear.click();
-    let snapshot;
-    if (environment.isAndroid) {
-        snapshot = {
-            platformName: 'android',
-            vhsType: info.flavorName,
-            vhsHash: {
-                hashFormat: 'sha256',
-                hash: info.vhsHash,
-                contentType: `x-applitools-vhs/${info.flavorName}`,
-            },
-        };
-    }
-    else {
-        snapshot = {
-            platformName: 'ios',
-            resourceContents: {
-                vhs: {
-                    value: Buffer.from(vhs, 'base64'),
-                    type: 'x-applitools-vhs/ios',
-                },
-            },
-            vhsCompatibilityParams: {
-                UIKitLinkTimeVersionNumber: info.UIKitLinkTimeVersionNumber,
-                UIKitRunTimeVersionNumber: info.UIKitRunTimeVersionNumber,
-            },
-        };
-    }
-    return Array(settings.renderers.length).fill(snapshot);
-}
-exports.takeVHSes = takeVHSes;
-function transformProxy(proxy) {
-    const url = new URL(proxy.url);
-    const transformedProxy = {
-        protocol: url.protocol,
-        host: url.hostname,
-        port: url.port,
-    };
-    if (proxy.username) {
-        transformedProxy.auth = { username: proxy.username, password: proxy.password };
-    }
-    else if (url.username) {
-        transformedProxy.auth = { username: url.username, password: proxy.password };
-    }
-    return transformedProxy;
-}

package/types/ufg/utils/take-vhses.d.ts

@@ -1,17 +0,0 @@
-import type { ServerSettings } from '../types';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type Driver } from '@applitools/driver';
-import { type Renderer, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
-export type VHSesSettings = ServerSettings & {
-    renderers: Renderer[];
-    waitBeforeCapture?: number;
-};
-export declare function takeVHSes<TSpec extends SpecType>({ driver, settings, hooks, logger, }: {
-    driver: Driver<TSpec>;
-    settings: VHSesSettings;
-    hooks?: {
-        beforeSnapshots?(): void | Promise<void>;
-        beforeEachSnapshot?(): void | Promise<void>;
-    };
-    logger: Logger;
-}): Promise<AndroidSnapshot[] | IOSSnapshot[]>;