@applitools/core 2.5.2 → 2.5.3-legacy

package/dist/ufg/close.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeClose = void 0;
-const driver_1 = require("@applitools/driver");
-function makeClose({ storage, target, spec, logger: defaultLogger }) {
-    return async function close({ settings, logger = defaultLogger, } = {}) {
-        logger.log('Command "close" is called with settings', settings);
-        settings !== null && settings !== void 0 ? settings : (settings = {});
-        if (!settings.testMetadata) {
-            try {
-                const driver = (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : null;
-                settings.testMetadata = await (driver === null || driver === void 0 ? void 0 : driver.getSessionMetadata());
-            }
-            catch (error) {
-                logger.warn('Command "close" received an error during extracting driver metadata', error);
-            }
-        }
-        storage.forEach(async (promises) => {
-            var _a, _b;
-            try {
-                const [{ eyes }] = await Promise.all(promises);
-                try {
-                    await eyes.close({ settings, logger });
-                }
-                catch (error) {
-                    logger.warn('Command "close" received an error during performing, trying to perform abort instead', error);
-                    await eyes.abort({ settings, logger });
-                }
-            }
-            catch (error) {
-                logger.warn('Command "close" received an error during waiting for eyes instances in background', error);
-                await ((_b = (_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes) === null || _b === void 0 ? void 0 : _b.abort({ settings, logger }));
-            }
-        });
-    };
-}
-exports.makeClose = makeClose;

package/dist/ufg/get-results.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeGetResults = void 0;
-const abort_error_1 = require("../errors/abort-error");
-function makeGetResults({ storage, logger: defaultLogger }) {
-    return async function getResults({ settings, logger = defaultLogger, } = {}) {
-        logger.log('Command "getResults" is called with settings', settings);
-        return Promise.all(Array.from(storage.values(), async (promises) => {
-            var _a;
-            try {
-                const [{ eyes, renderer }] = await Promise.all(promises);
-                const [result] = await eyes.getResults({ settings, logger });
-                return { ...result, renderer };
-            }
-            catch (error) {
-                if (error instanceof abort_error_1.AbortError && ((_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes)) {
-                    logger.warn('Command "getResults" received an abort error during performing', settings);
-                    const [result] = await error.info.eyes.getResults({ settings, logger });
-                    return { ...result, renderer: error.info.renderer };
-                }
-                logger.fatal('Command "getResults" received an error during performing', settings);
-                throw error;
-            }
-        }));
-    };
-}
-exports.makeGetResults = makeGetResults;

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/dist/ufg/utils/uniquify-renderers.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uniquifyRenderers = void 0;
-function uniquifyRenderers(renderers) {
-    const duplications = new Map(renderers.map(renderer => [JSON.stringify(renderer), 0]));
-    return renderers.reduce((uniqueRenderers, renderer) => {
-        const key = JSON.stringify(renderer);
-        let index = duplications.get(key);
-        if (index > 0) {
-            if (!renderer.id) {
-                let uniqueRenderer;
-                do {
-                    uniqueRenderer = { ...renderer, id: `${index}` };
-                    index += 1;
-                } while (duplications.has(JSON.stringify(uniqueRenderer)));
-                uniqueRenderers.push(uniqueRenderer);
-            }
-        }
-        else {
-            index += 1;
-            uniqueRenderers.push(renderer);
-        }
-        duplications.set(key, index);
-        return uniqueRenderers;
-    }, []);
-}
-exports.uniquifyRenderers = uniquifyRenderers;

package/dist/utils/extract-ci-provider.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractCIProvider = void 0;
-function extractCIProvider() {
-    if (process.env.TF_BUILD)
-        return 'Azure';
-    if (process.env['bamboo.buildKey'])
-        return 'Bamboo';
-    if (process.env.BUILDKITE)
-        return 'Buildkite';
-    if (process.env.CIRCLECI)
-        return 'Circle';
-    if (process.env.CIRRUS_CI)
-        return 'Cirrus';
-    if (process.env.CODEBUILD_BUILD_ID)
-        return 'CodeBuild';
-    if (process.env.GITHUB_ACTIONS)
-        return 'GitHub Actions';
-    if (process.env.GITLAB_CI)
-        return 'GitLab';
-    if (process.env.HEROKU_TEST_RUN_ID)
-        return 'Heroku';
-    if (process.env.BUILD_ID)
-        return 'Jenkins';
-    if (process.env.TEAMCITY_VERSION)
-        return 'TeamCity';
-    if (process.env.TRAVIS)
-        return 'Travis';
-    return null;
-}
-exports.extractCIProvider = extractCIProvider;

package/types/classic/abort.d.ts

@@ -1,16 +0,0 @@
-import type { AbortSettings } from './types';
-import type { Eyes } from './types';
-import { type Logger } from '@applitools/logger';
-import type { DriverTarget } from './types';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-type Options<TSpec extends SpecType> = {
-    eyes: Eyes<TSpec>;
-    target?: DriverTarget<TSpec>;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-export declare function makeAbort<TSpec extends SpecType>({ eyes, target, spec, logger: defaultLogger }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: AbortSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

package/types/classic/close.d.ts

@@ -1,16 +0,0 @@
-import type { CloseSettings } from './types';
-import type { Eyes } from './types';
-import { type Logger } from '@applitools/logger';
-import type { DriverTarget } from './types';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-type Options<TSpec extends SpecType> = {
-    eyes: Eyes<TSpec>;
-    target?: DriverTarget<TSpec>;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-export declare function makeClose<TSpec extends SpecType>({ eyes, target, spec, logger: defaultLogger }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: CloseSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

package/types/ufg/abort.d.ts

@@ -1,21 +0,0 @@
-import type { DriverTarget, AbortSettings } from './types';
-import { type Eyes as BaseEyes } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-import { type AbortController } from 'abort-controller';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-import { Renderer } from '@applitools/ufg-client';
-type Options<TSpec extends SpecType> = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
-    controller: AbortController;
-    target?: DriverTarget<TSpec>;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-export declare function makeAbort<TSpec extends SpecType>({ storage, target, spec, controller, logger: defaultLogger, }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: AbortSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

package/types/ufg/close.d.ts

@@ -1,19 +0,0 @@
-import type { DriverTarget, CloseSettings } from './types';
-import { type Eyes as BaseEyes } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-import { type SpecType, type SpecDriver } from '@applitools/driver';
-import { Renderer } from '@applitools/ufg-client';
-type Options<TSpec extends SpecType> = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
-    target?: DriverTarget<TSpec>;
-    spec?: SpecDriver<TSpec>;
-    logger: Logger;
-};
-export declare function makeClose<TSpec extends SpecType>({ storage, target, spec, logger: defaultLogger }: Options<TSpec>): ({ settings, logger, }?: {
-    settings?: CloseSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<void>;
-export {};

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

@@ -1,17 +0,0 @@
-import { type SpecType, type Driver } from '@applitools/driver';
-import { type Logger } from '@applitools/logger';
-import { type NMLClient, type NMLRequestsConfig } from '@applitools/nml-client';
-type Options = {
-    client?: NMLClient;
-    logger: Logger;
-};
-export declare function makeGetNMLClient({ client, logger: defaultLogger }: Options): (({ driver, config, logger, }: {
-    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;
-    clearCache(): void;
-};
-export {};

package/types/ufg/get-results.d.ts

@@ -1,16 +0,0 @@
-import type { GetResultsSettings, TestResult } from './types';
-import { type Eyes as BaseEyes } from '@applitools/core-base';
-import { type Logger } from '@applitools/logger';
-import { Renderer } from '@applitools/ufg-client';
-type Options = {
-    storage: Map<string, Promise<{
-        renderer: Renderer;
-        eyes: BaseEyes;
-    }>[]>;
-    logger: Logger;
-};
-export declare function makeGetResults({ storage, logger: defaultLogger }: Options): ({ settings, logger, }?: {
-    settings?: GetResultsSettings | undefined;
-    logger?: Logger | undefined;
-}) => Promise<TestResult[]>;
-export {};

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[]>;

package/types/ufg/utils/uniquify-renderers.d.ts

@@ -1,2 +0,0 @@
-import { type Renderer } from '@applitools/ufg-client';
-export declare function uniquifyRenderers(renderers: Renderer[]): Renderer[];

package/types/utils/extract-ci-provider.d.ts

@@ -1 +0,0 @@
-export declare function extractCIProvider(): string | null;