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

package/build/launcher.js

@@ -1,741 +0,0 @@
-import { FormData } from 'formdata-node';
-import { v4 as uuidv4 } from 'uuid';
-import fs from 'node:fs';
-import path from 'node:path';
-import { promisify, format } from 'node:util';
-import { performance, PerformanceObserver } from 'node:perf_hooks';
-import os from 'node:os';
-import { SevereServiceError } from 'webdriverio';
-import * as BrowserstackLocalLauncher from 'browserstack-local';
-import PerformanceTester from './performance-tester.js';
-import { startPercy, stopPercy, getBestPlatformForPercySnapshot } from './Percy/PercyHelper.js';
-import { BSTACK_SERVICE_VERSION, NOT_ALLOWED_KEYS_IN_CAPS, PERF_MEASUREMENT_ENV, RERUN_ENV, RERUN_TESTS_ENV, TESTOPS_BUILD_ID_ENV, VALID_APP_EXTENSION } from './constants.js';
-import { launchTestSession, createAccessibilityTestRun, shouldAddServiceVersion, stopBuildUpstream, getCiInfo, isBStackSession, isUndefined, isAccessibilityAutomationSession, stopAccessibilityTestRun, isTrue, getBrowserStackUser, getBrowserStackKey, uploadLogs, ObjectsAreEqual, getBasicAuthHeader, } from './util.js';
-import CrashReporter from './crash-reporter.js';
-import { BStackLogger } from './bstackLogger.js';
-import { PercyLogger } from './Percy/PercyLogger.js';
-import { FileStream } from './fileStream.js';
-import BrowserStackConfig from './config.js';
-import { setupExitHandlers } from './exitHandler.js';
-import { sendFinish, sendStart } from './instrumentation/funnelInstrumentation.js';
-export default class BrowserstackLauncherService {
-    _options;
-    _config;
-    browserstackLocal;
-    _buildName;
-    _projectName;
-    _buildTag;
-    _buildIdentifier;
-    _accessibilityAutomation;
-    _percy;
-    _percyBestPlatformCaps;
-    browserStackConfig;
-    constructor(_options, capabilities, _config) {
-        this._options = _options;
-        this._config = _config;
-        BStackLogger.clearLogFile();
-        PercyLogger.clearLogFile();
-        setupExitHandlers();
-        // added to maintain backward compatibility with webdriverIO v5
-        this._config || (this._config = _options);
-        this.browserStackConfig = BrowserStackConfig.getInstance(_options, _config);
-        if (Array.isArray(capabilities)) {
-            capabilities
-                .flatMap((c) => {
-                if (Object.values(c).length > 0 && Object.values(c).every(c => typeof c === 'object' && c.capabilities)) {
-                    return Object.values(c).map((o) => o.capabilities);
-                }
-                return c;
-            })
-                .forEach((capability) => {
-                if (!capability['bstack:options']) {
-                    // Skipping adding of service version if session is not of browserstack
-                    if (isBStackSession(this._config)) {
-                        const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
-                        if (extensionCaps.length) {
-                            capability['bstack:options'] = { wdioService: BSTACK_SERVICE_VERSION };
-                            if (!isUndefined(capability['browserstack.accessibility'])) {
-                                this._accessibilityAutomation ||= isTrue(capability['browserstack.accessibility']);
-                            }
-                            else if (isTrue(this._options.accessibility)) {
-                                capability['bstack:options'].accessibility = true;
-                            }
-                        }
-                        else if (shouldAddServiceVersion(this._config, this._options.testObservability)) {
-                            capability['browserstack.wdioService'] = BSTACK_SERVICE_VERSION;
-                        }
-                    }
-                    // Need this details for sending data to Observability
-                    this._buildIdentifier = capability['browserstack.buildIdentifier']?.toString();
-                    this._buildName = capability.build?.toString();
-                }
-                else {
-                    capability['bstack:options'].wdioService = BSTACK_SERVICE_VERSION;
-                    this._buildName = capability['bstack:options'].buildName;
-                    this._projectName = capability['bstack:options'].projectName;
-                    this._buildTag = capability['bstack:options'].buildTag;
-                    this._buildIdentifier = capability['bstack:options'].buildIdentifier;
-                    if (!isUndefined(capability['bstack:options'].accessibility)) {
-                        this._accessibilityAutomation ||= isTrue(capability['bstack:options'].accessibility);
-                    }
-                    else if (isTrue(this._options.accessibility)) {
-                        capability['bstack:options'].accessibility = (isTrue(this._options.accessibility));
-                    }
-                }
-            });
-        }
-        else if (typeof capabilities === 'object') {
-            Object.entries(capabilities).forEach(([, caps]) => {
-                if (!caps.capabilities['bstack:options']) {
-                    if (isBStackSession(this._config)) {
-                        const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
-                        if (extensionCaps.length) {
-                            caps.capabilities['bstack:options'] = { wdioService: BSTACK_SERVICE_VERSION };
-                            if (!isUndefined(caps.capabilities['browserstack.accessibility'])) {
-                                this._accessibilityAutomation ||= isTrue(caps.capabilities['browserstack.accessibility']);
-                            }
-                            else if (isTrue(this._options.accessibility)) {
-                                caps.capabilities['bstack:options'] = { wdioService: BSTACK_SERVICE_VERSION, accessibility: (isTrue(this._options.accessibility)) };
-                            }
-                        }
-                        else if (shouldAddServiceVersion(this._config, this._options.testObservability)) {
-                            caps.capabilities['browserstack.wdioService'] = BSTACK_SERVICE_VERSION;
-                        }
-                    }
-                    this._buildIdentifier = caps.capabilities['browserstack.buildIdentifier'];
-                }
-                else {
-                    const bstackOptions = caps.capabilities['bstack:options'];
-                    bstackOptions.wdioService = BSTACK_SERVICE_VERSION;
-                    this._buildName = bstackOptions.buildName;
-                    this._projectName = bstackOptions.projectName;
-                    this._buildTag = bstackOptions.buildTag;
-                    this._buildIdentifier = bstackOptions.buildIdentifier;
-                    if (!isUndefined(bstackOptions.accessibility)) {
-                        this._accessibilityAutomation ||= isTrue(bstackOptions.accessibility);
-                    }
-                    else if (isTrue(this._options.accessibility)) {
-                        bstackOptions.accessibility = isTrue(this._options.accessibility);
-                    }
-                }
-            });
-        }
-        this.browserStackConfig.buildIdentifier = this._buildIdentifier;
-        this.browserStackConfig.buildName = this._buildName;
-        if (process.env[PERF_MEASUREMENT_ENV]) {
-            PerformanceTester.startMonitoring('performance-report-launcher.csv');
-        }
-        this._accessibilityAutomation ||= isTrue(this._options.accessibility);
-        this._options.accessibility = this._accessibilityAutomation;
-        // by default observability will be true unless specified as false
-        this._options.testObservability = this._options.testObservability !== false;
-        if (this._options.testObservability
-            &&
-                // update files to run if it's a rerun
-                process.env[RERUN_ENV] && process.env[RERUN_TESTS_ENV]) {
-            this._config.specs = process.env[RERUN_TESTS_ENV].split(',');
-        }
-        try {
-            CrashReporter.setConfigDetails(this._config, capabilities, this._options);
-        }
-        catch (error) {
-            BStackLogger.error(`[Crash_Report_Upload] Config processing failed due to ${error}`);
-        }
-    }
-    async onWorkerStart(cid, caps) {
-        try {
-            if (this._options.percy && this._percyBestPlatformCaps) {
-                const isThisBestPercyPlatform = ObjectsAreEqual(caps, this._percyBestPlatformCaps);
-                if (isThisBestPercyPlatform) {
-                    process.env.BEST_PLATFORM_CID = cid;
-                }
-            }
-        }
-        catch (err) {
-            PercyLogger.error(`Error while setting best platform for Percy snapshot at worker start ${err}`);
-        }
-    }
-    async onPrepare(config, capabilities) {
-        // Send Funnel start request
-        await sendStart(this.browserStackConfig);
-        /**
-         * Upload app to BrowserStack if valid file path to app is given.
-         * Update app value of capability directly if app_url, custom_id, shareable_id is given
-         */
-        if (!this._options.app) {
-            BStackLogger.info('app is not defined in browserstack-service config, skipping ...');
-        }
-        else {
-            let app = {};
-            const appConfig = this._options.app;
-            try {
-                app = await this._validateApp(appConfig);
-            }
-            catch (error) {
-                throw new SevereServiceError(error);
-            }
-            if (VALID_APP_EXTENSION.includes(path.extname(app.app))) {
-                if (fs.existsSync(app.app)) {
-                    const data = await this._uploadApp(app);
-                    BStackLogger.info(`app upload completed: ${JSON.stringify(data)}`);
-                    app.app = data.app_url;
-                }
-                else if (app.customId) {
-                    app.app = app.customId;
-                }
-                else {
-                    throw new SevereServiceError(`[Invalid app path] app path ${app.app} is not correct, Provide correct path to app under test`);
-                }
-            }
-            BStackLogger.info(`Using app: ${app.app}`);
-            this._updateCaps(capabilities, 'app', app.app);
-        }
-        /**
-         * buildIdentifier in service options will take precedence over specified in capabilities
-        */
-        if (this._options.buildIdentifier) {
-            this._buildIdentifier = this._options.buildIdentifier;
-            this._updateCaps(capabilities, 'buildIdentifier', this._buildIdentifier);
-        }
-        /**
-         * evaluate buildIdentifier in case unique execution identifiers are present
-         * e.g., ${BUILD_NUMBER} and ${DATE_TIME}
-        */
-        this._handleBuildIdentifier(capabilities);
-        // remove accessibilityOptions from the capabilities if present
-        this._updateObjectTypeCaps(capabilities, 'accessibilityOptions');
-        if (this._accessibilityAutomation) {
-            const scannerVersion = await createAccessibilityTestRun(this._options, this._config, {
-                projectName: this._projectName,
-                buildName: this._buildName,
-                buildTag: this._buildTag,
-                bstackServiceVersion: BSTACK_SERVICE_VERSION,
-                buildIdentifier: this._buildIdentifier,
-                accessibilityOptions: this._options.accessibilityOptions
-            });
-            if (scannerVersion) {
-                process.env.BSTACK_A11Y_SCANNER_VERSION = scannerVersion;
-            }
-            BStackLogger.debug(`Accessibility scannerVersion ${scannerVersion}`);
-        }
-        if (this._options.accessibilityOptions) {
-            const filteredOpts = Object.keys(this._options.accessibilityOptions)
-                .filter(key => !NOT_ALLOWED_KEYS_IN_CAPS.includes(key))
-                .reduce((opts, key) => {
-                return {
-                    ...opts,
-                    [key]: this._options.accessibilityOptions?.[key]
-                };
-            }, {});
-            this._updateObjectTypeCaps(capabilities, 'accessibilityOptions', filteredOpts);
-        }
-        else if (isAccessibilityAutomationSession(this._accessibilityAutomation)) {
-            this._updateObjectTypeCaps(capabilities, 'accessibilityOptions', {});
-        }
-        if (this._options.testObservability) {
-            BStackLogger.debug('Sending launch start event');
-            await launchTestSession(this._options, this._config, {
-                projectName: this._projectName,
-                buildName: this._buildName,
-                buildTag: this._buildTag,
-                bstackServiceVersion: BSTACK_SERVICE_VERSION,
-                buildIdentifier: this._buildIdentifier
-            });
-        }
-        if (this._options.percy) {
-            try {
-                const bestPlatformPercyCaps = getBestPlatformForPercySnapshot(capabilities);
-                this._percyBestPlatformCaps = bestPlatformPercyCaps;
-                await this.setupPercy(this._options, this._config, {
-                    projectName: this._projectName
-                });
-            }
-            catch (err) {
-                PercyLogger.error(`Error while setting up Percy ${err}`);
-            }
-        }
-        if (!this._options.browserstackLocal) {
-            return BStackLogger.info('browserstackLocal is not enabled - skipping...');
-        }
-        const opts = {
-            key: this._config.key,
-            ...this._options.opts
-        };
-        this.browserstackLocal = new BrowserstackLocalLauncher.Local();
-        this._updateCaps(capabilities, 'local');
-        if (opts.localIdentifier) {
-            this._updateCaps(capabilities, 'localIdentifier', opts.localIdentifier);
-        }
-        /**
-         * measure BrowserStack tunnel boot time
-         */
-        const obs = new PerformanceObserver((list) => {
-            const entry = list.getEntries()[0];
-            BStackLogger.info(`Browserstack Local successfully started after ${entry.duration}ms`);
-        });
-        obs.observe({ entryTypes: ['measure'] });
-        let timer;
-        performance.mark('tbTunnelStart');
-        return Promise.race([
-            promisify(this.browserstackLocal.start.bind(this.browserstackLocal))(opts),
-            new Promise((resolve, reject) => {
-                /* istanbul ignore next */
-                timer = setTimeout(function () {
-                    reject('Browserstack Local failed to start within 60 seconds!');
-                }, 60000);
-            })
-        ]).then(function (result) {
-            clearTimeout(timer);
-            performance.mark('tbTunnelEnd');
-            performance.measure('bootTime', 'tbTunnelStart', 'tbTunnelEnd');
-            return Promise.resolve(result);
-        }, function (err) {
-            clearTimeout(timer);
-            return Promise.reject(err);
-        });
-    }
-    async onComplete() {
-        BStackLogger.debug('Inside OnComplete hook..');
-        if (isAccessibilityAutomationSession(this._accessibilityAutomation)) {
-            await stopAccessibilityTestRun().catch((error) => {
-                BStackLogger.error(`Exception in stop accessibility test run: ${error}`);
-            });
-        }
-        if (this._options.testObservability) {
-            BStackLogger.debug('Sending stop launch event');
-            await stopBuildUpstream();
-            if (process.env[TESTOPS_BUILD_ID_ENV]) {
-                console.log(`\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`);
-            }
-            this.browserStackConfig.testObservability.buildStopped = true;
-            if (process.env[PERF_MEASUREMENT_ENV]) {
-                await PerformanceTester.stopAndGenerate('performance-launcher.html');
-                PerformanceTester.calculateTimes(['launchTestSession', 'stopBuildUpstream']);
-                if (!process.env.START_TIME) {
-                    return;
-                }
-                const duration = (new Date()).getTime() - (new Date(process.env.START_TIME)).getTime();
-                BStackLogger.info(`Total duration is ${duration / 1000} s`);
-            }
-        }
-        try {
-            await this._uploadServiceLogs();
-        }
-        catch (error) {
-            BStackLogger.debug(`Failed to upload BrowserStack WDIO Service logs ${error}`);
-        }
-        BStackLogger.clearLogger();
-        if (this._options.percy) {
-            await this.stopPercy();
-        }
-        PercyLogger.clearLogger();
-        await sendFinish(this.browserStackConfig);
-        if (!this.browserstackLocal || !this.browserstackLocal.isRunning()) {
-            return;
-        }
-        if (this._options.forcedStop) {
-            return process.kill(this.browserstackLocal.pid);
-        }
-        let timer;
-        return Promise.race([
-            new Promise((resolve, reject) => {
-                this.browserstackLocal?.stop((err) => {
-                    if (err) {
-                        return reject(err);
-                    }
-                    resolve();
-                });
-            }),
-            new Promise((resolve, reject) => {
-                /* istanbul ignore next */
-                timer = setTimeout(() => reject(new Error('Browserstack Local failed to stop within 60 seconds!')), 60000);
-            })
-        ]).then(function (result) {
-            clearTimeout(timer);
-            return Promise.resolve(result);
-        }, function (err) {
-            clearTimeout(timer);
-            return Promise.reject(err);
-        });
-    }
-    async setupPercy(options, config, bsConfig) {
-        if (this._percy?.isRunning()) {
-            return;
-        }
-        try {
-            this._percy = await startPercy(options, config, bsConfig);
-            if (!this._percy) {
-                throw new Error('Could not start percy, check percy logs for info.');
-            }
-            PercyLogger.info('Percy started successfully');
-            let signal = 0;
-            const handler = async () => {
-                signal++;
-                signal === 1 && await this.stopPercy();
-            };
-            process.on('beforeExit', handler);
-            process.on('SIGINT', handler);
-            process.on('SIGTERM', handler);
-        }
-        catch (err) {
-            PercyLogger.debug(`Error in percy setup ${err}`);
-        }
-    }
-    async stopPercy() {
-        if (!this._percy || !this._percy.isRunning()) {
-            return;
-        }
-        try {
-            await stopPercy(this._percy);
-            PercyLogger.info('Percy stopped');
-        }
-        catch (err) {
-            PercyLogger.error('Error occured while stopping percy : ' + err);
-        }
-    }
-    async _uploadApp(app) {
-        BStackLogger.info(`uploading app ${app.app} ${app.customId ? `and custom_id: ${app.customId}` : ''} to browserstack`);
-        const form = new FormData();
-        if (app.app) {
-            const fileName = path.basename(app.app);
-            form.append('file', new FileStream(fs.createReadStream(app.app)), fileName);
-        }
-        if (app.customId) {
-            form.append('custom_id', app.customId);
-        }
-        const headers = {
-            'Content-Type': 'multipart/form-data',
-            Authorization: getBasicAuthHeader(this._config.user, this._config.key),
-        };
-        const res = await fetch('https://api-cloud.browserstack.com/app-automate/upload', {
-            method: 'POST',
-            body: form,
-            headers
-        });
-        if (!res.ok) {
-            throw new SevereServiceError(`app upload failed ${res.body}`);
-        }
-        return await res.json();
-    }
-    /**
-     * @param  {String | AppConfig}  appConfig    <string>: should be "app file path" or "app_url" or "custom_id" or "shareable_id".
-     *                                            <object>: only "path" and "custom_id" should coexist as multiple properties.
-     */
-    async _validateApp(appConfig) {
-        const app = {};
-        if (typeof appConfig === 'string') {
-            app.app = appConfig;
-        }
-        else if (typeof appConfig === 'object' && Object.keys(appConfig).length) {
-            if (Object.keys(appConfig).length > 2 || (Object.keys(appConfig).length === 2 && (!appConfig.path || !appConfig.custom_id))) {
-                throw new SevereServiceError(`keys ${Object.keys(appConfig)} can't co-exist as app values, use any one property from
-                            {id<string>, path<string>, custom_id<string>, shareable_id<string>}, only "path" and "custom_id" can co-exist.`);
-            }
-            app.app = appConfig.id || appConfig.path || appConfig.custom_id || appConfig.shareable_id;
-            app.customId = appConfig.custom_id;
-        }
-        else {
-            throw new SevereServiceError('[Invalid format] app should be string or an object');
-        }
-        if (!app.app) {
-            throw new SevereServiceError(`[Invalid app property] supported properties are {id<string>, path<string>, custom_id<string>, shareable_id<string>}.
-                        For more details please visit https://www.browserstack.com/docs/app-automate/appium/set-up-tests/specify-app ')`);
-        }
-        return app;
-    }
-    async _uploadServiceLogs() {
-        const clientBuildUuid = this._getClientBuildUuid();
-        const response = await uploadLogs(getBrowserStackUser(this._config), getBrowserStackKey(this._config), clientBuildUuid);
-        BStackLogger.logToFile(`Response - ${format(response)}`, 'debug');
-    }
-    _updateObjectTypeCaps(capabilities, capType, value) {
-        try {
-            if (Array.isArray(capabilities)) {
-                capabilities
-                    .flatMap((c) => {
-                    if (Object.values(c).length > 0 && Object.values(c).every(c => typeof c === 'object' && c.capabilities)) {
-                        return Object.values(c).map((o) => o.capabilities);
-                    }
-                    return c;
-                })
-                    .forEach((capability) => {
-                    if (!capability['bstack:options']) {
-                        const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
-                        if (extensionCaps.length) {
-                            if (capType === 'accessibilityOptions' && value) {
-                                capability['bstack:options'] = { accessibilityOptions: value };
-                            }
-                        }
-                        else if (capType === 'accessibilityOptions') {
-                            if (value) {
-                                const accessibilityOpts = { ...value };
-                                if (capability?.accessibility) {
-                                    accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
-                                    accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
-                                }
-                                capability['browserstack.accessibilityOptions'] = accessibilityOpts;
-                            }
-                            else {
-                                delete capability['browserstack.accessibilityOptions'];
-                            }
-                        }
-                    }
-                    else if (capType === 'accessibilityOptions') {
-                        if (value) {
-                            const accessibilityOpts = { ...value };
-                            if (capability['bstack:options'].accessibility) {
-                                accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
-                                accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
-                            }
-                            capability['bstack:options'].accessibilityOptions = accessibilityOpts;
-                        }
-                        else {
-                            delete capability['bstack:options'].accessibilityOptions;
-                        }
-                    }
-                });
-            }
-            else if (typeof capabilities === 'object') {
-                Object.entries(capabilities).forEach(([, caps]) => {
-                    if (!caps.capabilities['bstack:options']) {
-                        const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
-                        if (extensionCaps.length) {
-                            if (capType === 'accessibilityOptions' && value) {
-                                caps.capabilities['bstack:options'] = { accessibilityOptions: value };
-                            }
-                        }
-                        else if (capType === 'accessibilityOptions') {
-                            if (value) {
-                                const accessibilityOpts = { ...value };
-                                if (caps.capabilities['browserstack.accessibility']) {
-                                    accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
-                                    accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
-                                }
-                                caps.capabilities['browserstack.accessibilityOptions'] = accessibilityOpts;
-                            }
-                            else {
-                                delete caps.capabilities['browserstack.accessibilityOptions'];
-                            }
-                        }
-                    }
-                    else if (capType === 'accessibilityOptions') {
-                        if (value) {
-                            const accessibilityOpts = { ...value };
-                            if (caps.capabilities['bstack:options'].accessibility) {
-                                accessibilityOpts.authToken = process.env.BSTACK_A11Y_JWT;
-                                accessibilityOpts.scannerVersion = process.env.BSTACK_A11Y_SCANNER_VERSION;
-                            }
-                            caps.capabilities['bstack:options'].accessibilityOptions = accessibilityOpts;
-                        }
-                        else {
-                            delete caps.capabilities['bstack:options'].accessibilityOptions;
-                        }
-                    }
-                });
-            }
-        }
-        catch (error) {
-            BStackLogger.debug(`Exception while retrieving capability value. Error - ${error}`);
-        }
-    }
-    _updateCaps(capabilities, capType, value) {
-        if (Array.isArray(capabilities)) {
-            capabilities
-                .flatMap((c) => {
-                if (Object.values(c).length > 0 && Object.values(c).every(c => typeof c === 'object' && c.capabilities)) {
-                    return Object.values(c).map((o) => o.capabilities);
-                }
-                return c;
-            })
-                .forEach((capability) => {
-                if (!capability['bstack:options']) {
-                    const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
-                    if (extensionCaps.length) {
-                        if (capType === 'local') {
-                            capability['bstack:options'] = { local: true };
-                        }
-                        else if (capType === 'app') {
-                            capability['appium:app'] = value;
-                        }
-                        else if (capType === 'buildIdentifier' && value) {
-                            capability['bstack:options'] = { buildIdentifier: value };
-                        }
-                    }
-                    else if (capType === 'local') {
-                        capability['browserstack.local'] = true;
-                    }
-                    else if (capType === 'app') {
-                        capability.app = value;
-                    }
-                    else if (capType === 'buildIdentifier') {
-                        if (value) {
-                            capability['browserstack.buildIdentifier'] = value;
-                        }
-                        else {
-                            delete capability['browserstack.buildIdentifier'];
-                        }
-                    }
-                    else if (capType === 'localIdentifier') {
-                        capability['browserstack.localIdentifier'] = value;
-                    }
-                }
-                else if (capType === 'local') {
-                    capability['bstack:options'].local = true;
-                }
-                else if (capType === 'app') {
-                    capability['appium:app'] = value;
-                }
-                else if (capType === 'buildIdentifier') {
-                    if (value) {
-                        capability['bstack:options'].buildIdentifier = value;
-                    }
-                    else {
-                        delete capability['bstack:options'].buildIdentifier;
-                    }
-                }
-                else if (capType === 'localIdentifier') {
-                    capability['bstack:options'].localIdentifier = value;
-                }
-            });
-        }
-        else if (typeof capabilities === 'object') {
-            Object.entries(capabilities).forEach(([, caps]) => {
-                if (!caps.capabilities['bstack:options']) {
-                    const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
-                    if (extensionCaps.length) {
-                        if (capType === 'local') {
-                            caps.capabilities['bstack:options'] = { local: true };
-                        }
-                        else if (capType === 'app') {
-                            caps.capabilities['appium:app'] = value;
-                        }
-                        else if (capType === 'buildIdentifier' && value) {
-                            caps.capabilities['bstack:options'] = { buildIdentifier: value };
-                        }
-                    }
-                    else if (capType === 'local') {
-                        caps.capabilities['browserstack.local'] = true;
-                    }
-                    else if (capType === 'app') {
-                        caps.capabilities['appium:app'] = value;
-                    }
-                    else if (capType === 'buildIdentifier') {
-                        if (value) {
-                            caps.capabilities['browserstack.buildIdentifier'] = value;
-                        }
-                        else {
-                            delete caps.capabilities['browserstack.buildIdentifier'];
-                        }
-                    }
-                    else if (capType === 'localIdentifier') {
-                        caps.capabilities['browserstack.localIdentifier'] = value;
-                    }
-                }
-                else if (capType === 'local') {
-                    caps.capabilities['bstack:options'].local = true;
-                }
-                else if (capType === 'app') {
-                    caps.capabilities['appium:app'] = value;
-                }
-                else if (capType === 'buildIdentifier') {
-                    if (value) {
-                        caps.capabilities['bstack:options'].buildIdentifier = value;
-                    }
-                    else {
-                        delete caps.capabilities['bstack:options'].buildIdentifier;
-                    }
-                }
-                else if (capType === 'localIdentifier') {
-                    caps.capabilities['bstack:options'].localIdentifier = value;
-                }
-            });
-        }
-        else {
-            throw new SevereServiceError('Capabilities should be an object or Array!');
-        }
-    }
-    _handleBuildIdentifier(capabilities) {
-        if (!this._buildIdentifier) {
-            return;
-        }
-        if ((!this._buildName || process.env.BROWSERSTACK_BUILD_NAME) && this._buildIdentifier) {
-            this._updateCaps(capabilities, 'buildIdentifier');
-            BStackLogger.warn('Skipping buildIdentifier as buildName is not passed.');
-            return;
-        }
-        if (this._buildIdentifier && this._buildIdentifier.includes('${DATE_TIME}')) {
-            const formattedDate = new Intl.DateTimeFormat('en-GB', {
-                month: 'short',
-                day: '2-digit',
-                hour: '2-digit',
-                minute: '2-digit',
-                hour12: false
-            })
-                .format(new Date())
-                .replace(/ |, /g, '-');
-            this._buildIdentifier = this._buildIdentifier.replace('${DATE_TIME}', formattedDate);
-            this._updateCaps(capabilities, 'buildIdentifier', this._buildIdentifier);
-        }
-        if (!this._buildIdentifier.includes('${BUILD_NUMBER}')) {
-            return;
-        }
-        const ciInfo = getCiInfo();
-        if (ciInfo !== null && ciInfo.build_number) {
-            this._buildIdentifier = this._buildIdentifier.replace('${BUILD_NUMBER}', 'CI ' + ciInfo.build_number);
-            this._updateCaps(capabilities, 'buildIdentifier', this._buildIdentifier);
-        }
-        else {
-            const localBuildNumber = this._getLocalBuildNumber();
-            if (localBuildNumber) {
-                this._buildIdentifier = this._buildIdentifier.replace('${BUILD_NUMBER}', localBuildNumber);
-                this._updateCaps(capabilities, 'buildIdentifier', this._buildIdentifier);
-            }
-        }
-    }
-    /**
-     * @return {string} if buildName doesn't exist in json file, it will return 1
-     *                  else returns corresponding value in json file (e.g. { "wdio-build": { "identifier" : 2 } } => 2 in this case)
-     */
-    _getLocalBuildNumber() {
-        const browserstackFolderPath = path.join(os.homedir(), '.browserstack');
-        try {
-            if (!fs.existsSync(browserstackFolderPath)) {
-                fs.mkdirSync(browserstackFolderPath);
-            }
-            const filePath = path.join(browserstackFolderPath, '.build-name-cache.json');
-            if (!fs.existsSync(filePath)) {
-                fs.appendFileSync(filePath, JSON.stringify({}));
-            }
-            const buildCacheFileData = fs.readFileSync(filePath);
-            const parsedBuildCacheFileData = JSON.parse(buildCacheFileData.toString());
-            if (this._buildName && this._buildName in parsedBuildCacheFileData) {
-                const prevIdentifier = parseInt((parsedBuildCacheFileData[this._buildName].identifier));
-                const newIdentifier = prevIdentifier + 1;
-                this._updateLocalBuildCache(filePath, this._buildName, newIdentifier);
-                return newIdentifier.toString();
-            }
-            const newIdentifier = 1;
-            this._updateLocalBuildCache(filePath, this._buildName, 1);
-            return newIdentifier.toString();
-        }
-        catch (error) {
-            return null;
-        }
-    }
-    _updateLocalBuildCache(filePath, buildName, buildIdentifier) {
-        if (!buildName || !filePath) {
-            return;
-        }
-        const jsonContent = JSON.parse(fs.readFileSync(filePath).toString());
-        jsonContent[buildName] = { 'identifier': buildIdentifier };
-        fs.writeFileSync(filePath, JSON.stringify(jsonContent));
-    }
-    _getClientBuildUuid() {
-        if (process.env[TESTOPS_BUILD_ID_ENV]) {
-            return process.env[TESTOPS_BUILD_ID_ENV];
-        }
-        const uuid = uuidv4();
-        BStackLogger.logToFile(`If facing any issues, please contact BrowserStack support with the Build Run Id - ${uuid}`, 'info');
-        return uuid;
-    }
-}