@wdio/browserstack-service 9.0.0-alpha.9 → 9.0.0

package/build/accessibility-handler.js

@@ -1,287 +0,0 @@
-import util from 'node:util';
-import { getA11yResultsSummary, getA11yResults, performA11yScan, getUniqueIdentifier, getUniqueIdentifierForCucumber, isAccessibilityAutomationSession, isBrowserstackSession, o11yClassErrorHandler, shouldScanTestForAccessibility, validateCapsWithA11y, isTrue } from './util.js';
-import accessibilityScripts from './scripts/accessibility-scripts.js';
-import { BStackLogger } from './bstackLogger.js';
-class _AccessibilityHandler {
-    _browser;
-    _capabilities;
-    _framework;
-    _accessibilityAutomation;
-    _accessibilityOpts;
-    _platformA11yMeta;
-    _caps;
-    _suiteFile;
-    _accessibility;
-    _accessibilityOptions;
-    _testMetadata = {};
-    static _a11yScanSessionMap = {};
-    _sessionId = null;
-    constructor(_browser, _capabilities, isAppAutomate, _framework, _accessibilityAutomation, _accessibilityOpts) {
-        this._browser = _browser;
-        this._capabilities = _capabilities;
-        this._framework = _framework;
-        this._accessibilityAutomation = _accessibilityAutomation;
-        this._accessibilityOpts = _accessibilityOpts;
-        const caps = this._browser.capabilities;
-        this._platformA11yMeta = {
-            browser_name: caps.browserName,
-            browser_version: caps?.browserVersion || caps?.version || 'latest',
-            os_name: this._getCapabilityValue(_capabilities, 'os', 'os'),
-            os_version: this._getCapabilityValue(_capabilities, 'osVersion', 'os_version')
-        };
-        this._caps = _capabilities;
-        this._accessibility = isTrue(_accessibilityAutomation);
-        this._accessibilityOptions = _accessibilityOpts;
-    }
-    setSuiteFile(filename) {
-        this._suiteFile = filename;
-    }
-    _getCapabilityValue(caps, capType, legacyCapType) {
-        if (caps) {
-            if (capType === 'accessibility') {
-                if (caps['bstack:options'] && (isTrue(caps['bstack:options']?.accessibility))) {
-                    return caps['bstack:options']?.accessibility;
-                }
-                else if (isTrue(caps['browserstack.accessibility'])) {
-                    return caps['browserstack.accessibility'];
-                }
-            }
-            else if (capType === 'deviceName') {
-                if (caps['bstack:options'] && caps['bstack:options']?.deviceName) {
-                    return caps['bstack:options']?.deviceName;
-                }
-                else if (caps['bstack:options'] && caps['bstack:options']?.device) {
-                    return caps['bstack:options']?.device;
-                }
-                else if (caps['appium:deviceName']) {
-                    return caps['appium:deviceName'];
-                }
-            }
-            else if (capType === 'goog:chromeOptions' && caps['goog:chromeOptions']) {
-                return caps['goog:chromeOptions'];
-            }
-            else {
-                const bstackOptions = caps['bstack:options'];
-                if (bstackOptions && bstackOptions?.[capType]) {
-                    return bstackOptions?.[capType];
-                }
-                else if (caps[legacyCapType]) {
-                    return caps[legacyCapType];
-                }
-            }
-        }
-    }
-    async before(sessionId) {
-        this._sessionId = sessionId;
-        this._accessibility = isTrue(this._getCapabilityValue(this._caps, 'accessibility', 'browserstack.accessibility'));
-        if (isBrowserstackSession(this._browser) && isAccessibilityAutomationSession(this._accessibility)) {
-            const deviceName = this._getCapabilityValue(this._caps, 'deviceName', 'device');
-            const chromeOptions = this._getCapabilityValue(this._caps, 'goog:chromeOptions', '');
-            this._accessibility = validateCapsWithA11y(deviceName, this._platformA11yMeta, chromeOptions);
-        }
-        this._browser.getAccessibilityResultsSummary = async () => {
-            return await getA11yResultsSummary(this._browser, isBrowserstackSession(this._browser), this._accessibility);
-        };
-        this._browser.getAccessibilityResults = async () => {
-            return await getA11yResults(this._browser, isBrowserstackSession(this._browser), this._accessibility);
-        };
-        this._browser.performScan = async () => {
-            return await performA11yScan(this._browser, isBrowserstackSession(this._browser), this._accessibility);
-        };
-        if (!this._accessibility) {
-            return;
-        }
-        if (!('overwriteCommand' in this._browser && Array.isArray(accessibilityScripts.commandsToWrap))) {
-            return;
-        }
-        accessibilityScripts.commandsToWrap
-            .filter((command) => command.name && command.class)
-            .forEach((command) => {
-            const browser = this._browser;
-            browser.overwriteCommand(command.name, this.commandWrapper.bind(this, command), command.class === 'Element');
-        });
-    }
-    async beforeTest(suiteTitle, test) {
-        try {
-            if (this._framework !== 'mocha' ||
-                !this.shouldRunTestHooks(this._browser, this._accessibility)) {
-                return;
-            }
-            const shouldScanTest = shouldScanTestForAccessibility(suiteTitle, test.title, this._accessibilityOptions);
-            const testIdentifier = this.getIdentifier(test);
-            const isPageOpened = await this.checkIfPageOpened(this._browser, testIdentifier, shouldScanTest);
-            if (this._sessionId) {
-                /* For case with multiple tests under one browser, before hook of 2nd test should change this map value */
-                AccessibilityHandler._a11yScanSessionMap[this._sessionId] = shouldScanTest;
-            }
-            if (!isPageOpened) {
-                return;
-            }
-            this._testMetadata[testIdentifier].accessibilityScanStarted = shouldScanTest;
-            if (shouldScanTest) {
-                BStackLogger.info('Automate test case execution has started.');
-            }
-        }
-        catch (error) {
-            BStackLogger.error(`Exception in starting accessibility automation scan for this test case ${error}`);
-        }
-    }
-    async afterTest(suiteTitle, test) {
-        BStackLogger.debug('Accessibility after test hook. Before sending test stop event');
-        if (this._framework !== 'mocha' ||
-            !this.shouldRunTestHooks(this._browser, this._accessibility)) {
-            return;
-        }
-        try {
-            const testIdentifier = this.getIdentifier(test);
-            const accessibilityScanStarted = this._testMetadata[testIdentifier]?.accessibilityScanStarted;
-            const shouldScanTestForAccessibility = this._testMetadata[testIdentifier]?.scanTestForAccessibility;
-            if (!accessibilityScanStarted) {
-                return;
-            }
-            if (shouldScanTestForAccessibility) {
-                BStackLogger.info('Automate test case execution has ended. Processing for accessibility testing is underway. ');
-            }
-            const dataForExtension = {
-                saveResults: shouldScanTestForAccessibility,
-                testDetails: {
-                    'name': test.title,
-                    'testRunId': process.env.BS_A11Y_TEST_RUN_ID,
-                    'filePath': this._suiteFile,
-                    'scopeList': [suiteTitle, test.title]
-                },
-                platform: this._platformA11yMeta
-            };
-            await this.sendTestStopEvent(this._browser, dataForExtension);
-            if (shouldScanTestForAccessibility) {
-                BStackLogger.info('Accessibility testing for this test case has ended.');
-            }
-        }
-        catch (error) {
-            BStackLogger.error(`Accessibility results could not be processed for the test case ${test.title}. Error : ${error}`);
-        }
-    }
-    /**
-      * Cucumber Only
-    */
-    async beforeScenario(world) {
-        const pickleData = world.pickle;
-        const gherkinDocument = world.gherkinDocument;
-        const featureData = gherkinDocument.feature;
-        const uniqueId = getUniqueIdentifierForCucumber(world);
-        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
-            return;
-        }
-        try {
-            const shouldScanScenario = shouldScanTestForAccessibility(featureData?.name, pickleData.name, this._accessibilityOptions, world, true);
-            const isPageOpened = await this.checkIfPageOpened(this._browser, uniqueId, shouldScanScenario);
-            if (this._sessionId) {
-                /* For case with multiple tests under one browser, before hook of 2nd test should change this map value */
-                AccessibilityHandler._a11yScanSessionMap[this._sessionId] = shouldScanScenario;
-            }
-            if (!isPageOpened) {
-                return;
-            }
-            this._testMetadata[uniqueId].accessibilityScanStarted = shouldScanScenario;
-            if (shouldScanScenario) {
-                BStackLogger.info('Automate test case execution has started.');
-            }
-        }
-        catch (error) {
-            BStackLogger.error(`Exception in starting accessibility automation scan for this test case ${error}`);
-        }
-    }
-    async afterScenario(world) {
-        BStackLogger.debug('Accessibility after scenario hook. Before sending test stop event');
-        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
-            return;
-        }
-        const pickleData = world.pickle;
-        try {
-            const gherkinDocument = world.gherkinDocument;
-            const featureData = gherkinDocument.feature;
-            const uniqueId = getUniqueIdentifierForCucumber(world);
-            const accessibilityScanStarted = this._testMetadata[uniqueId]?.accessibilityScanStarted;
-            const shouldScanTestForAccessibility = this._testMetadata[uniqueId]?.scanTestForAccessibility;
-            if (!accessibilityScanStarted) {
-                return;
-            }
-            if (shouldScanTestForAccessibility) {
-                BStackLogger.info('Automate test case execution has ended. Processing for accessibility testing is underway. ');
-            }
-            const dataForExtension = {
-                saveResults: shouldScanTestForAccessibility,
-                testDetails: {
-                    'name': pickleData.name,
-                    'testRunId': process.env.BS_A11Y_TEST_RUN_ID,
-                    'filePath': gherkinDocument.uri,
-                    'scopeList': [featureData?.name, pickleData.name]
-                },
-                platform: this._platformA11yMeta
-            };
-            await this.sendTestStopEvent(this._browser, dataForExtension);
-            if (shouldScanTestForAccessibility) {
-                BStackLogger.info('Accessibility testing for this test case has ended.');
-            }
-        }
-        catch (error) {
-            BStackLogger.error(`Accessibility results could not be processed for the test case ${pickleData.name}. Error : ${error}`);
-        }
-    }
-    /*
-     * private methods
-     */
-    async commandWrapper(command, origFunction, ...args) {
-        if (this._sessionId && AccessibilityHandler._a11yScanSessionMap[this._sessionId] &&
-            (!command.name.includes('execute') ||
-                !AccessibilityHandler.shouldPatchExecuteScript(args.length ? args[0] : null))) {
-            BStackLogger.debug(`Performing scan for ${command.class} ${command.name}`);
-            await performA11yScan(this._browser, true, true, command.name);
-        }
-        return origFunction(...args);
-    }
-    async sendTestStopEvent(browser, dataForExtension) {
-        BStackLogger.debug('Performing scan before saving results');
-        await performA11yScan(browser, true, true);
-        const results = await browser.executeAsync(accessibilityScripts.saveTestResults, dataForExtension);
-        BStackLogger.debug(util.format(results));
-    }
-    getIdentifier(test) {
-        if ('pickle' in test) {
-            return getUniqueIdentifierForCucumber(test);
-        }
-        return getUniqueIdentifier(test, this._framework);
-    }
-    shouldRunTestHooks(browser, isAccessibility) {
-        if (!browser) {
-            return false;
-        }
-        return isBrowserstackSession(browser) && isAccessibilityAutomationSession(isAccessibility);
-    }
-    async checkIfPageOpened(browser, testIdentifier, shouldScanTest) {
-        let pageOpen = false;
-        this._testMetadata[testIdentifier] = {
-            scanTestForAccessibility: shouldScanTest,
-            accessibilityScanStarted: true
-        };
-        try {
-            const currentURL = await browser.getUrl();
-            const url = new URL(currentURL);
-            pageOpen = url?.protocol === 'http:' || url?.protocol === 'https:';
-        }
-        catch (e) {
-            pageOpen = false;
-        }
-        return pageOpen;
-    }
-    static shouldPatchExecuteScript(script) {
-        if (!script || typeof script !== 'string') {
-            return true;
-        }
-        return (script.toLowerCase().indexOf('browserstack_executor') !== -1 ||
-            script.toLowerCase().indexOf('browserstack_accessibility_automation_script') !== -1);
-    }
-}
-// https://github.com/microsoft/TypeScript/issues/6543
-const AccessibilityHandler = o11yClassErrorHandler(_AccessibilityHandler);
-export default AccessibilityHandler;

package/build/bstackLogger.js

@@ -1,70 +0,0 @@
-import path from 'node:path';
-import fs from 'node:fs';
-import chalk from 'chalk';
-import logger from '@wdio/logger';
-import { LOGS_FILE } from './constants.js';
-import { COLORS } from './util.js';
-const log = logger('@wdio/browserstack-service');
-export class BStackLogger {
-    static logFilePath = path.join(process.cwd(), LOGS_FILE);
-    static logFolderPath = path.join(process.cwd(), 'logs');
-    static logFileStream;
-    static logToFile(logMessage, logLevel) {
-        try {
-            if (!this.logFileStream) {
-                this.ensureLogsFolder();
-                this.logFileStream = fs.createWriteStream(this.logFilePath, { flags: 'a' });
-            }
-            if (this.logFileStream && this.logFileStream.writable) {
-                this.logFileStream.write(this.formatLog(logMessage, logLevel));
-            }
-        }
-        catch (error) {
-            log.debug(`Failed to log to file. Error ${error}`);
-        }
-    }
-    static formatLog(logMessage, level) {
-        return `${chalk.gray(new Date().toISOString())} ${chalk[COLORS[level]](level.toUpperCase())} ${chalk.whiteBright('@wdio/browserstack-service')} ${logMessage}\n`;
-    }
-    static info(message) {
-        this.logToFile(message, 'info');
-        log.info(message);
-    }
-    static error(message) {
-        this.logToFile(message, 'error');
-        log.error(message);
-    }
-    static debug(message, param) {
-        this.logToFile(message, 'debug');
-        if (param) {
-            log.debug(message, param);
-        }
-        else {
-            log.debug(message);
-        }
-    }
-    static warn(message) {
-        this.logToFile(message, 'warn');
-        log.warn(message);
-    }
-    static trace(message) {
-        this.logToFile(message, 'trace');
-        log.trace(message);
-    }
-    static clearLogger() {
-        if (this.logFileStream) {
-            this.logFileStream.end();
-        }
-        this.logFileStream = null;
-    }
-    static clearLogFile() {
-        if (fs.existsSync(this.logFilePath)) {
-            fs.truncateSync(this.logFilePath);
-        }
-    }
-    static ensureLogsFolder() {
-        if (!fs.existsSync(this.logFolderPath)) {
-            fs.mkdirSync(this.logFolderPath);
-        }
-    }
-}

package/build/cleanup.js

@@ -1,89 +0,0 @@
-import { getErrorString, stopBuildUpstream } from './util.js';
-import { BStackLogger } from './bstackLogger.js';
-import fs from 'node:fs';
-import { fireFunnelRequest } from './instrumentation/funnelInstrumentation.js';
-import { TESTOPS_BUILD_ID_ENV, TESTOPS_JWT_ENV } from './constants.js';
-export default class BStackCleanup {
-    static async startCleanup() {
-        try {
-            // Get funnel data object from saved file
-            const funnelDataCleanup = process.argv.includes('--funnelData');
-            let funnelData = null;
-            if (funnelDataCleanup) {
-                const index = process.argv.indexOf('--funnelData');
-                const filePath = process.argv[index + 1];
-                funnelData = this.getFunnelDataFromFile(filePath);
-            }
-            if (process.argv.includes('--observability')) {
-                await this.executeObservabilityCleanup(funnelData);
-            }
-            if (funnelDataCleanup && funnelData) {
-                await this.sendFunnelData(funnelData);
-            }
-        }
-        catch (err) {
-            const error = err;
-            BStackLogger.error(error);
-        }
-    }
-    static async executeObservabilityCleanup(funnelData) {
-        if (!process.env[TESTOPS_JWT_ENV]) {
-            return;
-        }
-        BStackLogger.debug('Executing observability cleanup');
-        try {
-            const result = await stopBuildUpstream();
-            if (process.env[TESTOPS_BUILD_ID_ENV]) {
-                BStackLogger.info(`\nVisit https://observability.browserstack.com/builds/${process.env[TESTOPS_BUILD_ID_ENV]} to view build report, insights, and many more debugging information all at one place!\n`);
-            }
-            const status = (result && result.status) || 'failed';
-            const message = (result && result.message);
-            this.updateO11yStopData(funnelData, status, status === 'failed' ? message : undefined);
-        }
-        catch (e) {
-            BStackLogger.error('Error in stopping Observability build: ' + e);
-            this.updateO11yStopData(funnelData, 'failed', e);
-        }
-    }
-    static updateO11yStopData(funnelData, status, error = undefined) {
-        const toData = funnelData?.event_properties?.productUsage?.testObservability;
-        // Return if no O11y data in funnel data
-        if (!toData) {
-            return;
-        }
-        let existingStopData = toData.events.buildEvents.finished;
-        existingStopData = existingStopData || {};
-        existingStopData = {
-            ...existingStopData,
-            status,
-            error: getErrorString(error),
-            stoppedFrom: 'exitHook'
-        };
-        toData.events.buildEvents.finished = existingStopData;
-    }
-    static async sendFunnelData(funnelData) {
-        try {
-            await fireFunnelRequest(funnelData);
-            BStackLogger.debug('Funnel data sent successfully from cleanup');
-        }
-        catch (e) {
-            BStackLogger.error('Error in sending funnel data: ' + e);
-        }
-    }
-    static getFunnelDataFromFile(filePath) {
-        if (!filePath) {
-            return null;
-        }
-        const content = fs.readFileSync(filePath, 'utf8');
-        const data = JSON.parse(content);
-        this.removeFunnelDataFile(filePath);
-        return data;
-    }
-    static removeFunnelDataFile(filePath) {
-        if (!filePath) {
-            return;
-        }
-        fs.rmSync(filePath, { force: true });
-    }
-}
-await BStackCleanup.startCleanup();

package/build/config.js

@@ -1,39 +0,0 @@
-import TestOpsConfig from './testOps/testOpsConfig.js';
-import { isUndefined } from './util.js';
-class BrowserStackConfig {
-    static getInstance(options, config) {
-        if (!this._instance && options && config) {
-            this._instance = new BrowserStackConfig(options, config);
-        }
-        return this._instance;
-    }
-    userName;
-    accessKey;
-    framework;
-    buildName;
-    buildIdentifier;
-    testObservability;
-    percy;
-    accessibility;
-    app;
-    static _instance;
-    appAutomate;
-    automate;
-    funnelDataSent = false;
-    constructor(options, config) {
-        this.framework = config.framework;
-        this.userName = config.user;
-        this.accessKey = config.key;
-        this.testObservability = new TestOpsConfig(options.testObservability !== false, !isUndefined(options.testObservability));
-        this.percy = options.percy || false;
-        this.accessibility = options.accessibility || false;
-        this.app = options.app;
-        this.appAutomate = !isUndefined(options.app);
-        this.automate = !this.appAutomate;
-        this.buildIdentifier = options.buildIdentifier;
-    }
-    sentFunnelData() {
-        this.funnelDataSent = true;
-    }
-}
-export default BrowserStackConfig;

package/build/constants.js

@@ -1,73 +0,0 @@
-import { createRequire } from 'node:module';
-const require = createRequire(import.meta.url);
-const { version: bstackServiceVersion } = require('../package.json');
-export const BROWSER_DESCRIPTION = [
-    'device',
-    'os',
-    'osVersion',
-    'os_version',
-    'browserName',
-    'browser',
-    'browserVersion',
-    'browser_version'
-];
-export const VALID_APP_EXTENSION = [
-    '.apk',
-    '.aab',
-    '.ipa'
-];
-export const DEFAULT_OPTIONS = {
-    setSessionName: true,
-    setSessionStatus: true,
-    testObservability: true,
-    accessibility: false
-};
-export const consoleHolder = Object.assign({}, console);
-export const DATA_ENDPOINT = 'https://collector-observability.browserstack.com';
-export const DATA_EVENT_ENDPOINT = 'api/v1/event';
-export const DATA_BATCH_ENDPOINT = 'api/v1/batch';
-export const DATA_SCREENSHOT_ENDPOINT = 'api/v1/screenshots';
-export const DATA_BATCH_SIZE = 1000;
-export const DATA_BATCH_INTERVAL = 2000;
-export const BATCH_EVENT_TYPES = ['LogCreated', 'TestRunStarted', 'TestRunFinished', 'HookRunFinished', 'HookRunStarted', 'ScreenshotCreated'];
-export const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000; // 5s
-export const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100; // 100ms
-export const BSTACK_SERVICE_VERSION = bstackServiceVersion;
-export const ACCESSIBILITY_API_URL = 'https://accessibility.browserstack.com/api';
-export const NOT_ALLOWED_KEYS_IN_CAPS = ['includeTagsInTestingScope', 'excludeTagsInTestingScope'];
-export const LOGS_FILE = 'logs/bstack-wdio-service.log';
-export const UPLOAD_LOGS_ADDRESS = 'https://upload-observability.browserstack.com';
-export const UPLOAD_LOGS_ENDPOINT = 'client-logs/upload';
-export const PERCY_LOGS_FILE = 'logs/percy.log';
-export const PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = [
-    '/session/:sessionId/url',
-    '/session/:sessionId/forward',
-    '/session/:sessionId/back',
-    '/session/:sessionId/refresh',
-    '/session/:sessionId/screenshot',
-    '/session/:sessionId/actions',
-    '/session/:sessionId/appium/device/shake'
-];
-export const CAPTURE_MODES = ['click', 'auto', 'screenshot', 'manual', 'testcase'];
-export const LOG_KIND_USAGE_MAP = {
-    'TEST_LOG': 'log',
-    'TEST_SCREENSHOT': 'screenshot',
-    'TEST_STEP': 'step',
-    'HTTP': 'http'
-};
-export const FUNNEL_INSTRUMENTATION_URL = 'https://api.browserstack.com/sdk/v1/event';
-// Env variables - Define all the env variable constants over here
-// To store the JWT token returned the session launch
-export const TESTOPS_JWT_ENV = 'BS_TESTOPS_JWT';
-// To store the setting of whether to send screenshots or not
-export const TESTOPS_SCREENSHOT_ENV = 'BS_TESTOPS_ALLOW_SCREENSHOTS';
-// To store build hashed id
-export const TESTOPS_BUILD_ID_ENV = 'BS_TESTOPS_BUILD_HASHED_ID';
-// Whether to collect performance instrumentation or not
-export const PERF_MEASUREMENT_ENV = 'BROWSERSTACK_O11Y_PERF_MEASUREMENT';
-// Whether the current run is rerun or not
-export const RERUN_TESTS_ENV = 'BROWSERSTACK_RERUN_TESTS';
-// The tests that needs to be rerun
-export const RERUN_ENV = 'BROWSERSTACK_RERUN';
-// To store whether the build launch has completed or not
-export const TESTOPS_BUILD_COMPLETED_ENV = 'BS_TESTOPS_BUILD_COMPLETED';