@wdio/browserstack-service 7.35.0 → 7.37.0

package/build/accessibility-handler.d.ts

@@ -13,12 +13,14 @@ declare class _AccessibilityHandler {
     private _accessibility?;
     private _accessibilityOptions?;
     private _testMetadata;
+    private static _a11yScanSessionMap;
+    private _sessionId;
     constructor(_browser: Browser<'async'> | MultiRemoteBrowser<'async'>, _capabilities: Capabilities.RemoteCapability, isAppAutomate?: boolean, _framework?: string | undefined, _accessibilityAutomation?: string | boolean | undefined, _accessibilityOpts?: {
         [key: string]: any;
     } | undefined);
     setSuiteFile(filename: string): void;
     _getCapabilityValue(caps: Capabilities.RemoteCapability, capType: string, legacyCapType: string): any;
-    before(): Promise<void>;
+    before(sessionId: string): Promise<void>;
     beforeTest(suiteTitle: string | undefined, test: Frameworks.Test): Promise<void>;
     afterTest(suiteTitle: string | undefined, test: Frameworks.Test): Promise<void>;
     /**
@@ -26,12 +28,12 @@ declare class _AccessibilityHandler {
     */
     beforeScenario(world: ITestCaseHookParameter): Promise<void>;
     afterScenario(world: ITestCaseHookParameter): Promise<void>;
-    private sendTestStartEvent;
-    private sendTestForceStopEvent;
+    private commandWrapper;
     private sendTestStopEvent;
     private getIdentifier;
     private shouldRunTestHooks;
     private checkIfPageOpened;
+    private static shouldPatchExecuteScript;
 }
 declare const AccessibilityHandler: typeof _AccessibilityHandler;
 type AccessibilityHandler = _AccessibilityHandler;

package/build/accessibility-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"accessibility-handler.d.ts","sourceRoot":"","sources":["../src/accessibility-handler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAA;AAmB9D,cAAM,qBAAqB;IASnB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IAErB,OAAO,CAAC,UAAU,CAAC;IACnB,OAAO,CAAC,wBAAwB,CAAC;IACjC,OAAO,CAAC,kBAAkB,CAAC;IAb/B,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,qBAAqB,CAAC,CAAyB;IACvD,OAAO,CAAC,aAAa,CAA8B;gBAGvC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EACxD,aAAa,EAAE,YAAY,CAAC,gBAAgB,EACpD,aAAa,CAAC,EAAE,OAAO,EACf,UAAU,CAAC,oBAAQ,EACnB,wBAAwB,CAAC,8BAAkB,EAC3C,kBAAkB,CAAC;;iBAAyB;IAgBxD,YAAY,CAAC,QAAQ,EAAE,MAAM;IAI7B,mBAAmB,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAI,GAAG;IA6BhG,MAAM;IAmBN,UAAU,CAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAiCjE,SAAS,CAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IA0CtE;;MAEE;IACI,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAiC7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IA8ClD,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,kBAAkB;YAOZ,iBAAiB;CAiBlC;AAGD,QAAA,MAAM,oBAAoB,EAAE,OAAO,qBAAoE,CAAA;AACvG,KAAK,oBAAoB,GAAG,qBAAqB,CAAA;AAEjD,eAAe,oBAAoB,CAAA"}
+{"version":3,"file":"accessibility-handler.d.ts","sourceRoot":"","sources":["../src/accessibility-handler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAA;AAqB9D,cAAM,qBAAqB;IAWnB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IAErB,OAAO,CAAC,UAAU,CAAC;IACnB,OAAO,CAAC,wBAAwB,CAAC;IACjC,OAAO,CAAC,kBAAkB,CAAC;IAf/B,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,qBAAqB,CAAC,CAAyB;IACvD,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAA8B;IAChE,OAAO,CAAC,UAAU,CAAsB;gBAG5B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EACxD,aAAa,EAAE,YAAY,CAAC,gBAAgB,EACpD,aAAa,CAAC,EAAE,OAAO,EACf,UAAU,CAAC,oBAAQ,EACnB,wBAAwB,CAAC,8BAAkB,EAC3C,kBAAkB,CAAC;;iBAAyB;IAgBxD,YAAY,CAAC,QAAQ,EAAE,MAAM;IAI7B,mBAAmB,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAI,GAAG;IA6BhG,MAAM,CAAE,SAAS,EAAE,MAAM;IAyCzB,UAAU,CAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAiCjE,SAAS,CAAE,UAAU,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IA0CtE;;MAEE;IACI,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAgC7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;YA8CpC,cAAc;YAcd,iBAAiB;IAO/B,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,kBAAkB;YAOZ,iBAAiB;IAkB/B,OAAO,CAAC,MAAM,CAAC,wBAAwB;CAU1C;AAGD,QAAA,MAAM,oBAAoB,EAAE,OAAO,qBAAoE,CAAA;AACvG,KAAK,oBAAoB,GAAG,qBAAqB,CAAA;AAEjD,eAAe,oBAAoB,CAAA"}

package/build/accessibility-handler.js

@@ -3,9 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const node_util_1 = __importDefault(require("node:util"));
 const logger_1 = __importDefault(require("@wdio/logger"));
 const util_1 = require("./util");
-const test_event_scripts_1 = require("./scripts/test-event-scripts");
+const accessibility_scripts_1 = __importDefault(require("./scripts/accessibility-scripts"));
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class _AccessibilityHandler {
     constructor(_browser, _capabilities, isAppAutomate, _framework, _accessibilityAutomation, _accessibilityOpts) {
@@ -15,6 +16,7 @@ class _AccessibilityHandler {
         this._accessibilityAutomation = _accessibilityAutomation;
         this._accessibilityOpts = _accessibilityOpts;
         this._testMetadata = {};
+        this._sessionId = null;
         const caps = this._browser.capabilities;
         this._platformA11yMeta = {
             browser_name: caps.browserName,
@@ -65,7 +67,8 @@ class _AccessibilityHandler {
             }
         }
     }
-    async before() {
+    async before(sessionId) {
+        this._sessionId = sessionId;
         this._accessibility = (0, util_1.isTrue)(this._getCapabilityValue(this._caps, 'accessibility', 'browserstack.accessibility'));
         if ((0, util_1.isBrowserstackSession)(this._browser) && (0, util_1.isAccessibilityAutomationSession)(this._accessibility)) {
             const deviceName = this._getCapabilityValue(this._caps, 'deviceName', 'device');
@@ -78,6 +81,26 @@ class _AccessibilityHandler {
         this._browser.getAccessibilityResults = async () => {
             return await (0, util_1.getA11yResults)(this._browser, (0, util_1.isBrowserstackSession)(this._browser), this._accessibility);
         };
+        this._browser.performScan = async () => {
+            return await (0, util_1.performA11yScan)(this._browser, (0, util_1.isBrowserstackSession)(this._browser), this._accessibility);
+        };
+        if (!this._accessibility) {
+            return;
+        }
+        if (!('overwriteCommand' in this._browser && Array.isArray(accessibility_scripts_1.default.commandsToWrap))) {
+            return;
+        }
+        accessibility_scripts_1.default.commandsToWrap
+            .filter((command) => (command.name && command.class))
+            .forEach((command) => {
+            var _a;
+            try {
+                (_a = this._browser) === null || _a === void 0 ? void 0 : _a.overwriteCommand(command.name, this.commandWrapper.bind(this, command), command.class === 'Element');
+            }
+            catch (er) {
+                log.debug(`Unable to overwrite command ${node_util_1.default.format(command)} ${node_util_1.default.format(er)}`);
+            }
+        });
     }
     async beforeTest(suiteTitle, test) {
         if (this._framework !== 'mocha' ||
@@ -86,17 +109,14 @@ class _AccessibilityHandler {
         }
         const shouldScanTest = (0, util_1.shouldScanTestForAccessibility)(suiteTitle, test.title, this._accessibilityOptions);
         const testIdentifier = this.getIdentifier(test);
-        const isPageOpened = await this.checkIfPageOpened(this._browser, testIdentifier, shouldScanTest);
-        if (!isPageOpened) {
-            return;
+        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;
         }
         try {
-            if (shouldScanTest) {
-                log.info('Setup for Accessibility testing has started. Automate test case execution will begin momentarily.');
-                await this.sendTestStartEvent(this._browser);
-            }
-            else {
-                await this.sendTestForceStopEvent(this._browser);
+            const isPageOpened = await this.checkIfPageOpened(this._browser, testIdentifier, shouldScanTest);
+            if (!isPageOpened) {
+                return;
             }
             this._testMetadata[testIdentifier].accessibilityScanStarted = shouldScanTest;
             if (shouldScanTest) {
@@ -146,27 +166,24 @@ class _AccessibilityHandler {
       * Cucumber Only
     */
     async beforeScenario(world) {
-        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
-            return;
-        }
         const pickleData = world.pickle;
         const gherkinDocument = world.gherkinDocument;
         const featureData = gherkinDocument.feature;
         const uniqueId = (0, util_1.getUniqueIdentifierForCucumber)(world);
-        const shouldScanScenario = (0, util_1.shouldScanTestForAccessibility)(featureData === null || featureData === void 0 ? void 0 : featureData.name, pickleData.name, this._accessibilityOptions);
-        const isPageOpened = await this.checkIfPageOpened(this._browser, uniqueId, shouldScanScenario);
-        if (!isPageOpened) {
+        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
             return;
         }
         try {
-            if (shouldScanScenario) {
-                log.info('Setup for Accessibility testing has started. Automate test case execution will begin momentarily.');
-                await this.sendTestStartEvent(this._browser);
+            const shouldScanScenario = (0, util_1.shouldScanTestForAccessibility)(featureData === null || featureData === void 0 ? void 0 : featureData.name, pickleData.name, this._accessibilityOptions);
+            const isPageOpened = await this.checkIfPageOpened(this._browser, uniqueId, shouldScanScenario);
+            this._testMetadata[uniqueId].accessibilityScanStarted = 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;
             }
-            else {
-                await this.sendTestForceStopEvent(this._browser);
+            if (!isPageOpened) {
+                return;
             }
-            this._testMetadata[uniqueId].accessibilityScanStarted = shouldScanScenario;
             if (shouldScanScenario) {
                 log.info('Automate test case execution has started.');
             }
@@ -215,14 +232,20 @@ class _AccessibilityHandler {
     /*
      * private methods
      */
-    sendTestStartEvent(browser) {
-        return browser.executeAsync(test_event_scripts_1.testStartEvent);
-    }
-    sendTestForceStopEvent(browser) {
-        return browser.execute(test_event_scripts_1.testForceStop);
+    async commandWrapper(command, origFunction, ...args) {
+        if (this._sessionId && AccessibilityHandler._a11yScanSessionMap[this._sessionId] &&
+            (!command.name.includes('execute') ||
+                !AccessibilityHandler.shouldPatchExecuteScript(args.length ? args[0] : null))) {
+            log.debug(`Performing scan for ${command.class} ${command.name}`);
+            await (0, util_1.performA11yScan)(this._browser, true, true, command.name);
+        }
+        return origFunction(...args);
     }
-    sendTestStopEvent(browser, dataForExtension) {
-        return browser.executeAsync(test_event_scripts_1.testStop, dataForExtension);
+    async sendTestStopEvent(browser, dataForExtension) {
+        log.debug('Performing scan before saving results');
+        await (0, util_1.performA11yScan)(browser, true, true);
+        const results = await browser.executeAsync(accessibility_scripts_1.default.saveTestResults, dataForExtension);
+        log.debug(node_util_1.default.format(results));
     }
     getIdentifier(test) {
         if ('pickle' in test) {
@@ -252,7 +275,15 @@ class _AccessibilityHandler {
         }
         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);
+    }
 }
+_AccessibilityHandler._a11yScanSessionMap = {};
 // https://github.com/microsoft/TypeScript/issues/6543
 const AccessibilityHandler = (0, util_1.o11yClassErrorHandler)(_AccessibilityHandler);
 exports.default = AccessibilityHandler;

package/build/bstackLogger.d.ts

@@ -0,0 +1,14 @@
+export declare class BStackLogger {
+    static logFilePath: string;
+    static logFolderPath: string;
+    private static logFileStream;
+    static info(message: string): void;
+    static error(message: string): void;
+    static debug(message: string, param?: any): void;
+    static warn(message: string): void;
+    static trace(message: string): void;
+    static clearLogger(): void;
+    static clearLogFile(): void;
+    static ensureLogsFolder(): void;
+}
+//# sourceMappingURL=bstackLogger.d.ts.map

package/build/bstackLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bstackLogger.d.ts","sourceRoot":"","sources":["../src/bstackLogger.ts"],"names":[],"mappings":"AASA,qBAAa,YAAY;IACrB,OAAc,WAAW,SAAsC;IAC/D,OAAc,aAAa,SAAmC;IAC9D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAuB;WAErC,IAAI,CAAC,OAAO,EAAE,MAAM;WAIpB,KAAK,CAAC,OAAO,EAAE,MAAM;WAIrB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;WAQlC,IAAI,CAAC,OAAO,EAAE,MAAM;WAIpB,KAAK,CAAC,OAAO,EAAE,MAAM;WAIrB,WAAW;WAOX,YAAY;WAMZ,gBAAgB;CAKjC"}

package/build/bstackLogger.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BStackLogger = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const logger_1 = __importDefault(require("@wdio/logger"));
+const constants_1 = require("./constants");
+const log = (0, logger_1.default)('@wdio/browserstack-service');
+class BStackLogger {
+    static info(message) {
+        log.info(message);
+    }
+    static error(message) {
+        log.error(message);
+    }
+    static debug(message, param) {
+        if (param) {
+            log.debug(message, param);
+        }
+        else {
+            log.debug(message);
+        }
+    }
+    static warn(message) {
+        log.warn(message);
+    }
+    static trace(message) {
+        log.trace(message);
+    }
+    static clearLogger() {
+        if (this.logFileStream) {
+            this.logFileStream.end();
+        }
+        this.logFileStream = null;
+    }
+    static clearLogFile() {
+        if (node_fs_1.default.existsSync(this.logFilePath)) {
+            node_fs_1.default.truncateSync(this.logFilePath);
+        }
+    }
+    static ensureLogsFolder() {
+        if (!node_fs_1.default.existsSync(this.logFolderPath)) {
+            node_fs_1.default.mkdirSync(this.logFolderPath);
+        }
+    }
+}
+exports.BStackLogger = BStackLogger;
+BStackLogger.logFilePath = node_path_1.default.join(process.cwd(), constants_1.LOGS_FILE);
+BStackLogger.logFolderPath = node_path_1.default.join(process.cwd(), 'logs');

package/build/cleanup.d.ts

@@ -1,5 +1,9 @@
 export default class BStackCleanup {
-    static startCleanup(): void;
-    static executeObservabilityCleanup(): void;
+    static startCleanup(): Promise<void>;
+    static executeObservabilityCleanup(funnelData: any): Promise<void>;
+    static updateO11yStopData(funnelData: any, status: string, error?: unknown): void;
+    static sendFunnelData(funnelData: any): Promise<void>;
+    static removeFunnelDataFile(filePath?: string): void;
+    static getFunnelDataFromFile(filePath: string): any;
 }
 //# sourceMappingURL=cleanup.d.ts.map

package/build/cleanup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cleanup.d.ts","sourceRoot":"","sources":["../src/cleanup.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,OAAO,aAAa;IAC9B,MAAM,CAAC,YAAY;IAGnB,MAAM,CAAC,2BAA2B;CAarC"}
+{"version":3,"file":"cleanup.d.ts","sourceRoot":"","sources":["../src/cleanup.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,OAAO,OAAO,aAAa;WACjB,YAAY;WAmBZ,2BAA2B,CAAC,UAAU,EAAE,GAAG;IAsBxD,MAAM,CAAC,kBAAkB,CAAC,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,OAAmB;WAkBxE,cAAc,CAAC,UAAU,EAAE,GAAG;IAS3C,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,MAAM;IAO7C,MAAM,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAM;CAWhD"}

package/build/cleanup.js

@@ -1,23 +1,115 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("./util");
+const fs_1 = __importDefault(require("fs"));
+const bstackLogger_1 = require("./bstackLogger");
+const funnelInstrumentation_1 = require("./instrumentation/funnelInstrumentation");
+const constants_1 = require("./constants");
+const process = __importStar(require("process"));
 class BStackCleanup {
-    static startCleanup() {
-        this.executeObservabilityCleanup();
+    static async startCleanup() {
+        // 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);
+        }
     }
-    static executeObservabilityCleanup() {
-        if (!process.env.BS_TESTOPS_JWT) {
+    static async executeObservabilityCleanup(funnelData) {
+        if (!process.env[constants_1.TESTOPS_JWT_ENV]) {
             return;
         }
-        console.log('Executing observability cleanup');
-        (0, util_1.stopBuildUpstream)().then(() => {
-            if (process.env.BS_TESTOPS_BUILD_HASHED_ID) {
-                console.log(`\nVisit https://observability.browserstack.com/builds/${process.env.BS_TESTOPS_BUILD_HASHED_ID} to view build report, insights, and many more debugging information all at one place!\n`);
+        bstackLogger_1.BStackLogger.debug('Executing observability cleanup');
+        try {
+            const result = await (0, util_1.stopBuildUpstream)();
+            if (process.env[constants_1.TESTOPS_BUILD_ID_ENV]) {
+                bstackLogger_1.BStackLogger.info(`\nVisit https://observability.browserstack.com/builds/${process.env[constants_1.TESTOPS_BUILD_ID_ENV]} to view build report, insights, and many more debugging information all at one place!\n`);
             }
-        }).catch((err) => {
-            console.error(err);
-        });
+            const status = (result && result.status) || 'failed';
+            const message = (result && result.message);
+            this.updateO11yStopData(funnelData, status, status === 'failed' ? message : undefined);
+        }
+        catch (e) {
+            bstackLogger_1.BStackLogger.error('Error in stopping Observability build: ' + e);
+            this.updateO11yStopData(funnelData, 'failed', e);
+        }
+    }
+    static updateO11yStopData(funnelData, status, error = undefined) {
+        var _a, _b;
+        const toData = (_b = (_a = funnelData === null || funnelData === void 0 ? void 0 : funnelData.event_properties) === null || _a === void 0 ? void 0 : _a.productUsage) === null || _b === void 0 ? void 0 : _b.testObservability;
+        // Return if no O11y data in funnel data
+        if (!toData) {
+            return;
+        }
+        let existingStopData = toData.events.buildEvents.finished;
+        existingStopData = existingStopData || {};
+        existingStopData = {
+            ...existingStopData,
+            status,
+            error: (0, util_1.getErrorString)(error),
+            stoppedFrom: 'exitHook'
+        };
+        toData.events.buildEvents.finished = existingStopData;
+    }
+    static async sendFunnelData(funnelData) {
+        try {
+            await (0, funnelInstrumentation_1.fireFunnelRequest)(funnelData);
+            bstackLogger_1.BStackLogger.debug('Funnel data sent successfully from cleanup');
+        }
+        catch (e) {
+            bstackLogger_1.BStackLogger.error('Error in sending funnel data: ' + e);
+        }
+    }
+    static removeFunnelDataFile(filePath) {
+        if (!filePath) {
+            return;
+        }
+        fs_1.default.rmSync(filePath, { force: true });
+    }
+    static getFunnelDataFromFile(filePath) {
+        if (!filePath) {
+            return null;
+        }
+        bstackLogger_1.BStackLogger.debug('Getting saved funnel data from file ' + filePath);
+        const content = fs_1.default.readFileSync(filePath, 'utf8');
+        const data = JSON.parse(content);
+        this.removeFunnelDataFile(filePath);
+        return data;
     }
 }
 exports.default = BStackCleanup;
-BStackCleanup.startCleanup();
+(async () => await BStackCleanup.startCleanup())();

package/build/config.d.ts

@@ -0,0 +1,23 @@
+import type { AppConfig, BrowserstackConfig } from './types';
+import type { Options } from '@wdio/types';
+import TestOpsConfig from './testOps/testOpsConfig';
+declare class BrowserStackConfig {
+    static getInstance(options?: BrowserstackConfig & Options.Testrunner, config?: Options.Testrunner): BrowserStackConfig;
+    userName?: string;
+    accessKey?: string;
+    framework?: string;
+    buildName?: string;
+    buildIdentifier?: string;
+    testObservability: TestOpsConfig;
+    percy: boolean;
+    accessibility: boolean;
+    app?: string | AppConfig;
+    private static _instance;
+    appAutomate: boolean;
+    automate: boolean;
+    funnelDataSent: boolean;
+    constructor(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner);
+    sentFunnelData(): void;
+}
+export default BrowserStackConfig;
+//# sourceMappingURL=config.d.ts.map

package/build/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,aAAa,MAAM,yBAAyB,CAAA;AAGnD,cAAM,kBAAkB;IACpB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,kBAAkB;IAO/G,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,iBAAiB,EAAE,aAAa,CAAA;IAChC,KAAK,EAAE,OAAO,CAAA;IACd,aAAa,EAAE,OAAO,CAAA;IACtB,GAAG,CAAC,EAAE,MAAM,GAAC,SAAS,CAAA;IAC7B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAoB;IACrC,WAAW,EAAE,OAAO,CAAA;IACpB,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAQ;gBAE1B,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU;IAaxF,cAAc;CAIjB;AAED,eAAe,kBAAkB,CAAA"}

package/build/config.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const testOpsConfig_1 = __importDefault(require("./testOps/testOpsConfig"));
+const util_1 = require("./util");
+class BrowserStackConfig {
+    static getInstance(options, config) {
+        if (!this._instance && options && config) {
+            this._instance = new BrowserStackConfig(options, config);
+        }
+        return this._instance;
+    }
+    constructor(options, config) {
+        this.funnelDataSent = false;
+        this.framework = config.framework;
+        this.userName = config.user;
+        this.accessKey = config.key;
+        this.testObservability = new testOpsConfig_1.default(options.testObservability !== false, !(0, util_1.isUndefined)(options.testObservability));
+        this.percy = options.percy || false;
+        this.accessibility = options.accessibility || false;
+        this.app = options.app;
+        this.appAutomate = !(0, util_1.isUndefined)(options.app);
+        this.automate = !this.appAutomate;
+        this.buildIdentifier = options.buildIdentifier;
+    }
+    sentFunnelData() {
+        this.funnelDataSent = true;
+    }
+}
+exports.default = BrowserStackConfig;

package/build/constants.d.ts

@@ -12,9 +12,26 @@ export declare const DATA_BATCH_INTERVAL = 2000;
 export declare const BATCH_EVENT_TYPES: string[];
 export declare const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000;
 export declare const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100;
+export declare const BSTACK_SERVICE_VERSION: string;
 export declare const ACCESSIBILITY_API_URL = "https://accessibility.browserstack.com/api";
 export declare const NOT_ALLOWED_KEYS_IN_CAPS: string[];
+export declare const LOGS_FILE = "logs/bstack-wdio-service.log";
+export declare const COLORS: Record<string, string>;
 export declare const PERCY_LOGS_FILE = "logs/percy.log";
 export declare const PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS: string[];
 export declare const CAPTURE_MODES: string[];
+export declare const LOG_KIND_USAGE_MAP: {
+    TEST_LOG: string;
+    TEST_SCREENSHOT: string;
+    TEST_STEP: string;
+    HTTP: string;
+};
+export declare const FUNNEL_INSTRUMENTATION_URL = "https://api.browserstack.com/sdk/v1/event";
+export declare const TESTOPS_JWT_ENV = "BS_TESTOPS_JWT";
+export declare const TESTOPS_SCREENSHOT_ENV = "BS_TESTOPS_ALLOW_SCREENSHOTS";
+export declare const TESTOPS_BUILD_ID_ENV = "BS_TESTOPS_BUILD_HASHED_ID";
+export declare const PERF_MEASUREMENT_ENV = "BROWSERSTACK_O11Y_PERF_MEASUREMENT";
+export declare const RERUN_TESTS_ENV = "BROWSERSTACK_RERUN_TESTS";
+export declare const RERUN_ENV = "BROWSERSTACK_RERUN";
+export declare const TESTOPS_BUILD_COMPLETED_ENV = "BS_TESTOPS_BUILD_COMPLETED";
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAKvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AACvE,eAAO,MAAM,aAAa,qDAAqD,CAAA;AAC/E,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,eAAe,OAAO,CAAA;AACnC,eAAO,MAAM,mBAAmB,OAAO,CAAA;AACvC,eAAO,MAAM,iBAAiB,UAAgH,CAAA;AAC9I,eAAO,MAAM,wCAAwC,OAAO,CAAA;AAC5D,eAAO,MAAM,yCAAyC,MAAM,CAAA;AAE5D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA;AAElG,eAAO,MAAM,eAAe,mBAAmB,CAAA;AAE/C,eAAO,MAAM,qCAAqC,UAQjD,CAAA;AAED,eAAO,MAAM,aAAa,UAAwD,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAGjD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAKvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AACvE,eAAO,MAAM,aAAa,qDAAqD,CAAA;AAC/E,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,eAAe,OAAO,CAAA;AACnC,eAAO,MAAM,mBAAmB,OAAO,CAAA;AACvC,eAAO,MAAM,iBAAiB,UAAgH,CAAA;AAC9I,eAAO,MAAM,wCAAwC,OAAO,CAAA;AAC5D,eAAO,MAAM,yCAAyC,MAAM,CAAA;AAE5D,eAAO,MAAM,sBAAsB,QAAuB,CAAA;AAE1D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA;AAElG,eAAO,MAAM,SAAS,iCAAiC,CAAA;AACvD,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAOzC,CAAA;AAED,eAAO,MAAM,eAAe,mBAAmB,CAAA;AAE/C,eAAO,MAAM,qCAAqC,UAQjD,CAAA;AAED,eAAO,MAAM,aAAa,UAAwD,CAAA;AAElF,eAAO,MAAM,kBAAkB;;;;;CAK9B,CAAA;AAED,eAAO,MAAM,0BAA0B,8CAA8C,CAAA;AAKrF,eAAO,MAAM,eAAe,mBAAmB,CAAA;AAG/C,eAAO,MAAM,sBAAsB,iCAAiC,CAAA;AAGpE,eAAO,MAAM,oBAAoB,+BAA+B,CAAA;AAGhE,eAAO,MAAM,oBAAoB,uCAAuC,CAAA;AAGxE,eAAO,MAAM,eAAe,6BAA6B,CAAA;AAGzD,eAAO,MAAM,SAAS,uBAAuB,CAAA;AAG7C,eAAO,MAAM,2BAA2B,+BAA+B,CAAA"}

package/build/constants.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CAPTURE_MODES = exports.PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = exports.PERCY_LOGS_FILE = exports.NOT_ALLOWED_KEYS_IN_CAPS = exports.ACCESSIBILITY_API_URL = exports.DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = exports.DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = exports.BATCH_EVENT_TYPES = exports.DATA_BATCH_INTERVAL = exports.DATA_BATCH_SIZE = exports.DATA_SCREENSHOT_ENDPOINT = exports.DATA_BATCH_ENDPOINT = exports.DATA_EVENT_ENDPOINT = exports.DATA_ENDPOINT = exports.consoleHolder = exports.DEFAULT_OPTIONS = exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
+exports.TESTOPS_BUILD_COMPLETED_ENV = exports.RERUN_ENV = exports.RERUN_TESTS_ENV = exports.PERF_MEASUREMENT_ENV = exports.TESTOPS_BUILD_ID_ENV = exports.TESTOPS_SCREENSHOT_ENV = exports.TESTOPS_JWT_ENV = exports.FUNNEL_INSTRUMENTATION_URL = exports.LOG_KIND_USAGE_MAP = exports.CAPTURE_MODES = exports.PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = exports.PERCY_LOGS_FILE = exports.COLORS = exports.LOGS_FILE = exports.NOT_ALLOWED_KEYS_IN_CAPS = exports.ACCESSIBILITY_API_URL = exports.BSTACK_SERVICE_VERSION = exports.DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = exports.DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = exports.BATCH_EVENT_TYPES = exports.DATA_BATCH_INTERVAL = exports.DATA_BATCH_SIZE = exports.DATA_SCREENSHOT_ENDPOINT = exports.DATA_BATCH_ENDPOINT = exports.DATA_EVENT_ENDPOINT = exports.DATA_ENDPOINT = exports.consoleHolder = exports.DEFAULT_OPTIONS = exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
+const package_json_1 = require("../package.json");
 exports.BROWSER_DESCRIPTION = [
     'device',
     'os',
@@ -32,8 +33,18 @@ exports.DATA_BATCH_INTERVAL = 2000;
 exports.BATCH_EVENT_TYPES = ['LogCreated', 'TestRunStarted', 'TestRunFinished', 'HookRunFinished', 'HookRunStarted', 'ScreenshotCreated'];
 exports.DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000; // 5s
 exports.DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100; // 100ms
+exports.BSTACK_SERVICE_VERSION = package_json_1.version;
 exports.ACCESSIBILITY_API_URL = 'https://accessibility.browserstack.com/api';
 exports.NOT_ALLOWED_KEYS_IN_CAPS = ['includeTagsInTestingScope', 'excludeTagsInTestingScope'];
+exports.LOGS_FILE = 'logs/bstack-wdio-service.log';
+exports.COLORS = {
+    error: 'red',
+    warn: 'yellow',
+    info: 'cyanBright',
+    debug: 'green',
+    trace: 'cyan',
+    progress: 'magenta'
+};
 exports.PERCY_LOGS_FILE = 'logs/percy.log';
 exports.PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = [
     '/session/:sessionId/url',
@@ -45,3 +56,25 @@ exports.PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = [
     '/session/:sessionId/appium/device/shake'
 ];
 exports.CAPTURE_MODES = ['click', 'auto', 'screenshot', 'manual', 'testcase'];
+exports.LOG_KIND_USAGE_MAP = {
+    'TEST_LOG': 'log',
+    'TEST_SCREENSHOT': 'screenshot',
+    'TEST_STEP': 'step',
+    'HTTP': 'http'
+};
+exports.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
+exports.TESTOPS_JWT_ENV = 'BS_TESTOPS_JWT';
+// To store the setting of whether to send screenshots or not
+exports.TESTOPS_SCREENSHOT_ENV = 'BS_TESTOPS_ALLOW_SCREENSHOTS';
+// To store build hashed id
+exports.TESTOPS_BUILD_ID_ENV = 'BS_TESTOPS_BUILD_HASHED_ID';
+// Whether to collect performance instrumentation or not
+exports.PERF_MEASUREMENT_ENV = 'BROWSERSTACK_O11Y_PERF_MEASUREMENT';
+// Whether the current run is rerun or not
+exports.RERUN_TESTS_ENV = 'BROWSERSTACK_RERUN_TESTS';
+// The tests that needs to be rerun
+exports.RERUN_ENV = 'BROWSERSTACK_RERUN';
+// To store whether the build launch has completed or not
+exports.TESTOPS_BUILD_COMPLETED_ENV = 'BS_TESTOPS_BUILD_COMPLETED';

package/build/crash-reporter.js

@@ -55,7 +55,7 @@ class CrashReporter {
             this.userConfigForReporting = {};
         }
         const data = {
-            hashed_id: process.env.BS_TESTOPS_BUILD_HASHED_ID,
+            hashed_id: process.env[constants_1.TESTOPS_BUILD_ID_ENV],
             observability_version: {
                 frameworkName: 'WebdriverIO-' + (this.userConfigForReporting.framework || 'null'),
                 sdkVersion: package_json_1.version

package/build/data-store.d.ts

@@ -0,0 +1,3 @@
+export declare function getDataFromWorkers(): Record<string, object>[];
+export declare function saveWorkerData(data: Record<string, any>): void;
+//# sourceMappingURL=data-store.d.ts.map

package/build/data-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-store.d.ts","sourceRoot":"","sources":["../src/data-store.ts"],"names":[],"mappings":"AAOA,wBAAgB,kBAAkB,6BAoBjC;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QASvD"}

package/build/data-store.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveWorkerData = exports.getDataFromWorkers = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const bstackLogger_1 = require("./bstackLogger");
+const workersDataDirPath = node_path_1.default.join(process.cwd(), 'logs', 'worker_data');
+function getDataFromWorkers() {
+    const workersData = [];
+    if (!node_fs_1.default.existsSync(workersDataDirPath)) {
+        return workersData;
+    }
+    const files = node_fs_1.default.readdirSync(workersDataDirPath);
+    files.forEach((file) => {
+        bstackLogger_1.BStackLogger.debug('Reading worker file ' + file);
+        const filePath = node_path_1.default.join(workersDataDirPath, file);
+        const fileContent = node_fs_1.default.readFileSync(filePath, 'utf8');
+        const workerData = JSON.parse(fileContent);
+        workersData.push(workerData);
+    });
+    // Remove worker data after all reading
+    removeWorkersDataDir();
+    return workersData;
+}
+exports.getDataFromWorkers = getDataFromWorkers;
+function saveWorkerData(data) {
+    const filePath = node_path_1.default.join(workersDataDirPath, 'worker-data-' + process.pid + '.json');
+    try {
+        createWorkersDataDir();
+        node_fs_1.default.writeFileSync(filePath, JSON.stringify(data));
+    }
+    catch (e) {
+        bstackLogger_1.BStackLogger.debug('Exception in saving worker data: ' + e);
+    }
+}
+exports.saveWorkerData = saveWorkerData;
+function removeWorkersDataDir() {
+    node_fs_1.default.rmSync(workersDataDirPath, { recursive: true, force: true });
+    return true;
+}
+function createWorkersDataDir() {
+    if (!node_fs_1.default.existsSync(workersDataDirPath)) {
+        node_fs_1.default.mkdirSync(workersDataDirPath, { recursive: true });
+    }
+    return true;
+}