@wdio/browserstack-service 8.32.4 → 8.33.1

package/build/insights-handler.js

@@ -1,10 +1,10 @@
 import path from 'node:path';
 import { v4 as uuidv4 } from 'uuid';
 import TestReporter from './reporter.js';
-import { frameworkSupportsHook, getCloudProvider, getFailureObject, getGitMetaData, getHookType, getPlatformVersion, getScenarioExamples, getUniqueIdentifier, getUniqueIdentifierForCucumber, isBrowserstackSession, isScreenshotCommand, o11yClassErrorHandler, pushDataToQueue, removeAnsiColors, sleep, uploadEventData } from './util.js';
-import RequestQueueHandler from './request-handler.js';
-import { DATA_SCREENSHOT_ENDPOINT, DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS, DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS } from './constants.js';
+import { frameworkSupportsHook, getCloudProvider, getFailureObject, getGitMetaData, getHookType, getPlatformVersion, getScenarioExamples, getUniqueIdentifier, getUniqueIdentifierForCucumber, isBrowserstackSession, isScreenshotCommand, o11yClassErrorHandler, removeAnsiColors, } from './util.js';
 import { BStackLogger } from './bstackLogger.js';
+import Listener from './testOps/listener.js';
+import { TESTOPS_SCREENSHOT_ENV } from './constants.js';
 class _InsightsHandler {
     _browser;
     _framework;
@@ -14,7 +14,6 @@ class _InsightsHandler {
     _commands = {};
     _gitConfigPath;
     _suiteFile;
-    _requestQueueHandler = RequestQueueHandler.getInstance();
     _currentTest = {};
     _currentHook = {};
     _cucumberData = {
@@ -23,10 +22,10 @@ class _InsightsHandler {
         steps: []
     };
     _userCaps = {};
+    listener = Listener.getInstance();
     constructor(_browser, isAppAutomate, _framework, _userCaps) {
         this._browser = _browser;
         this._framework = _framework;
-        this._requestQueueHandler.start();
         const caps = this._browser.capabilities;
         const sessionId = this._browser.sessionId;
         this._platformMeta = {
@@ -142,7 +141,7 @@ class _InsightsHandler {
                 };
             }),
         };
-        await this.sendTestRunEventForCucumber(null, 'TestRunSkipped', testMetaData);
+        this.listener.testFinished(this.getTestRunDataForCucumber(null, 'TestRunSkipped', testMetaData));
     }
     async processCucumberHook(test, params, result) {
         const hookType = this.getCucumberHookType(test);
@@ -163,12 +162,12 @@ class _InsightsHandler {
                 hookType: hookType
             };
             this._tests[hookId] = hookMetaData;
-            await this.sendHookRunEvent(hookMetaData, 'HookRunStarted');
+            this.listener.hookStarted(this.getHookRunDataForCucumber(hookMetaData, 'HookRunStarted'));
         }
         else {
             this._tests[hookId].finishedAt = (new Date()).toISOString();
             this.setCurrentHook({ uuid: this._tests[hookId].uuid, finished: true });
-            await this.sendHookRunEvent(this._tests[hookId], 'HookRunFinished', result);
+            this.listener.hookFinished(this.getHookRunDataForCucumber(this._tests[hookId], 'HookRunFinished', result));
             if (hookType === 'BEFORE_ALL' && result && !result.passed) {
                 const { feature, uri } = this._cucumberData;
                 if (!feature) {
@@ -207,7 +206,7 @@ class _InsightsHandler {
         };
         this.setCurrentHook({ uuid: hookUUID });
         this.attachHookData(context, hookUUID);
-        await this.sendTestRunEvent(test, 'HookRunStarted');
+        this.listener.hookStarted(this.getRunData(test, 'HookRunStarted'));
     }
     async afterHook(test, result) {
         if (!frameworkSupportsHook('after', this._framework)) {
@@ -228,7 +227,7 @@ class _InsightsHandler {
             };
         }
         this.setCurrentHook({ uuid: this._tests[fullTitle].uuid, finished: true });
-        await this.sendTestRunEvent(test, 'HookRunFinished', result);
+        this.listener.hookFinished(this.getRunData(test, 'HookRunFinished', result));
         const hookType = getHookType(test.title);
         /*
             If any of the `beforeAll`, `beforeEach`, `afterEach` then the tests after the hook won't run in mocha (https://github.com/mochajs/mocha/issues/4392)
@@ -245,7 +244,7 @@ class _InsightsHandler {
                         startedAt: (new Date()).toISOString(),
                         finishedAt: (new Date()).toISOString()
                     };
-                    await this.sendTestRunEvent(skippedTest, 'TestRunSkipped');
+                    this.listener.testFinished(this.getRunData(skippedTest, 'TestRunSkipped'));
                 }
             };
             /*
@@ -262,7 +261,7 @@ class _InsightsHandler {
             await sendSuiteSkipped(test.ctx.test.parent);
         }
     }
-    async sendHookRunEvent(hookData, eventType, result) {
+    getHookRunDataForCucumber(hookData, eventType, result) {
         const { uri, feature } = this._cucumberData;
         const testData = {
             uuid: hookData.uuid,
@@ -299,14 +298,7 @@ class _InsightsHandler {
                 testData.integrations[provider] = this.getIntegrationsObject();
             }
         }
-        const uploadData = {
-            event_type: eventType,
-            hook_run: testData
-        };
-        const req = this._requestQueueHandler.add(uploadData);
-        if (req.proceed && req.data) {
-            await uploadEventData(req.data, req.url);
-        }
+        return testData;
     }
     async beforeTest(test) {
         const uuid = uuidv4();
@@ -321,7 +313,7 @@ class _InsightsHandler {
             uuid,
             startedAt: (new Date()).toISOString()
         };
-        await this.sendTestRunEvent(test, 'TestRunStarted');
+        this.listener.testStarted(this.getRunData(test, 'TestRunStarted'));
     }
     async afterTest(test, result) {
         if (this._framework !== 'mocha') {
@@ -332,7 +324,8 @@ class _InsightsHandler {
             ...(this._tests[fullTitle] || {}),
             finishedAt: (new Date()).toISOString()
         };
-        await this.sendTestRunEvent(test, 'TestRunFinished', result);
+        BStackLogger.debug('calling testFinished');
+        this.listener.testFinished(this.getRunData(test, 'TestRunFinished', result));
     }
     /**
       * Cucumber Only
@@ -371,11 +364,11 @@ class _InsightsHandler {
             };
         }
         this._tests[uniqueId] = testMetaData;
-        await this.sendTestRunEventForCucumber(world, 'TestRunStarted');
+        this.listener.testStarted(this.getTestRunDataForCucumber(world, 'TestRunStarted'));
     }
     async afterScenario(world) {
         this._cucumberData.scenario = undefined;
-        await this.sendTestRunEventForCucumber(world, 'TestRunFinished');
+        this.listener.testFinished(this.getTestRunDataForCucumber(world, 'TestRunFinished'));
     }
     async beforeStep(step, scenario) {
         this._cucumberData.stepsStarted = true;
@@ -417,17 +410,6 @@ class _InsightsHandler {
         }
         this._tests[uniqueId] = testMetaData;
     }
-    async uploadPending(waitTimeout = DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS, waitInterval = DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS) {
-        if (this._requestQueueHandler.pendingUploads <= 0 || waitTimeout <= 0) {
-            return;
-        }
-        await sleep(waitInterval);
-        return this.uploadPending(waitTimeout - waitInterval);
-    }
-    async teardown() {
-        RequestQueueHandler.tearDownInvoked = true;
-        await this._requestQueueHandler.shutdown();
-    }
     /**
      * misc methods
      */
@@ -440,22 +422,13 @@ class _InsightsHandler {
                 stdLog.test_run_uuid = this._currentTest.uuid;
             }
             if (stdLog.hook_run_uuid || stdLog.test_run_uuid) {
-                await pushDataToQueue({
-                    event_type: 'LogCreated',
-                    logs: [stdLog]
-                });
+                this.listener.logCreated([stdLog]);
             }
         }
         catch (error) {
             BStackLogger.debug(`Exception in uploading log data to Observability with error : ${error}`);
         }
     };
-    async sendData(data) {
-        const req = this._requestQueueHandler.add(data);
-        if (req.proceed && req.data) {
-            await uploadEventData(req.data, req.url);
-        }
-    }
     async browserCommand(commandType, args, test) {
         const dataKey = `${args.sessionId}_${args.method}_${args.endpoint}`;
         if (commandType === 'client:beforeCommand') {
@@ -473,39 +446,30 @@ class _InsightsHandler {
         // log screenshot
         const body = 'body' in args ? args.body : undefined;
         const result = 'result' in args ? args.result : undefined;
-        if (Boolean(process.env.BS_TESTOPS_ALLOW_SCREENSHOTS) && isScreenshotCommand(args) && result?.value) {
-            await uploadEventData([{
-                    event_type: 'LogCreated',
-                    logs: [{
-                            test_run_uuid: testMeta.uuid,
-                            timestamp: new Date().toISOString(),
-                            message: result.value,
-                            kind: 'TEST_SCREENSHOT'
-                        }]
-                }], DATA_SCREENSHOT_ENDPOINT);
+        if (Boolean(process.env[TESTOPS_SCREENSHOT_ENV]) && isScreenshotCommand(args) && result?.value) {
+            await this.listener.onScreenshot([{
+                    test_run_uuid: testMeta.uuid,
+                    timestamp: new Date().toISOString(),
+                    message: result.value,
+                    kind: 'TEST_SCREENSHOT'
+                }]);
         }
         const requestData = this._commands[dataKey];
         if (!requestData) {
             return;
         }
         // log http request
-        const req = this._requestQueueHandler.add({
-            event_type: 'LogCreated',
-            logs: [{
-                    test_run_uuid: testMeta.uuid,
-                    timestamp: new Date().toISOString(),
-                    kind: 'HTTP',
-                    http_response: {
-                        path: requestData.endpoint,
-                        method: requestData.method,
-                        body,
-                        response: result
-                    }
-                }]
-        });
-        if (req.proceed && req.data) {
-            await uploadEventData(req.data, req.url);
-        }
+        this.listener.logCreated([{
+                test_run_uuid: testMeta.uuid,
+                timestamp: new Date().toISOString(),
+                kind: 'HTTP',
+                http_response: {
+                    path: requestData.endpoint,
+                    method: requestData.method,
+                    body,
+                    response: result
+                }
+            }]);
     }
     /*
      * private methods
@@ -563,7 +527,7 @@ class _InsightsHandler {
         }
         return value.reverse();
     }
-    async sendTestRunEvent(test, eventType, results) {
+    getRunData(test, eventType, results) {
         const fullTitle = getUniqueIdentifier(test, this._framework);
         const testMetaData = this._tests[fullTitle];
         const filename = test.file || this._suiteFile;
@@ -616,22 +580,12 @@ class _InsightsHandler {
             testData.result = 'skipped';
             eventType = 'TestRunFinished';
         }
-        const uploadData = {
-            event_type: eventType,
-        };
         /* istanbul ignore if */
         if (eventType.match(/HookRun/)) {
             testData.hook_type = testData.name?.toLowerCase() ? getHookType(testData.name.toLowerCase()) : 'undefined';
             testData.test_run_id = this.getTestRunId(test.ctx);
-            uploadData.hook_run = testData;
-        }
-        else {
-            uploadData.test_run = testData;
-        }
-        const req = this._requestQueueHandler.add(uploadData);
-        if (req.proceed && req.data) {
-            await uploadEventData(req.data, req.url);
         }
+        return testData;
     }
     getTestRunId(context) {
         if (!context) {
@@ -664,7 +618,7 @@ class _InsightsHandler {
         }
         return;
     }
-    async sendTestRunEventForCucumber(worldObj, eventType, testMetaData = null) {
+    getTestRunDataForCucumber(worldObj, eventType, testMetaData = null) {
         const world = worldObj;
         const dataHub = testMetaData ? testMetaData : (this._tests[getUniqueIdentifierForCucumber(world)] || {});
         const { feature, scenario, steps, uuid, startedAt, finishedAt } = dataHub;
@@ -740,14 +694,7 @@ class _InsightsHandler {
             testData.result = 'skipped';
             eventType = 'TestRunFinished';
         }
-        const uploadData = {
-            event_type: eventType,
-            test_run: testData
-        };
-        const req = this._requestQueueHandler.add(uploadData);
-        if (req.proceed && req.data) {
-            await uploadEventData(req.data, req.url);
-        }
+        return testData;
     }
     getIntegrationsObject() {
         const caps = this._browser?.capabilities;

package/build/instrumentation/funnelInstrumentation.d.ts

@@ -0,0 +1,6 @@
+import type BrowserStackConfig from '../config.js';
+export declare function sendStart(config: BrowserStackConfig): Promise<void>;
+export declare function sendFinish(config: BrowserStackConfig): Promise<void>;
+export declare function saveFunnelData(eventType: string, config: BrowserStackConfig): string;
+export declare function fireFunnelRequest(data: any): Promise<void>;
+//# sourceMappingURL=funnelInstrumentation.d.ts.map

package/build/instrumentation/funnelInstrumentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"funnelInstrumentation.d.ts","sourceRoot":"","sources":["../../src/instrumentation/funnelInstrumentation.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,kBAAkB,MAAM,cAAc,CAAA;AAsBlD,wBAAsB,SAAS,CAAC,MAAM,EAAE,kBAAkB,iBAIzD;AAED,wBAAsB,UAAU,CAAC,MAAM,EAAE,kBAAkB,iBAE1D;AAED,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAOpF;AAGD,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAOhE"}

package/build/instrumentation/funnelInstrumentation.js

@@ -0,0 +1,119 @@
+import os from 'node:os';
+import util from 'node:util';
+import path from 'node:path';
+import fs from 'node:fs';
+import got from 'got';
+import UsageStats from '../testOps/usageStats.js';
+import { BStackLogger } from '../bstackLogger.js';
+import { BSTACK_SERVICE_VERSION, FUNNEL_INSTRUMENTATION_URL } from '../constants.js';
+import { getDataFromWorkers, removeWorkersDataDir } from '../data-store.js';
+async function fireFunnelTestEvent(eventType, config) {
+    if (!config.userName || !config.accessKey) {
+        BStackLogger.debug('username/accesskey not passed');
+        return;
+    }
+    try {
+        const data = buildEventData(eventType, config);
+        await fireFunnelRequest(data);
+        BStackLogger.debug('Funnel event success');
+        if (eventType === 'SDKTestSuccessful') {
+            config.sentFunnelData();
+        }
+    }
+    catch (error) {
+        BStackLogger.debug('Exception in sending funnel data: ' + error);
+    }
+}
+export async function sendStart(config) {
+    // Remove Workers folder if exists
+    removeWorkersDataDir();
+    await fireFunnelTestEvent('SDKTestAttempted', config);
+}
+export async function sendFinish(config) {
+    await fireFunnelTestEvent('SDKTestSuccessful', config);
+}
+export function saveFunnelData(eventType, config) {
+    const data = buildEventData(eventType, config);
+    BStackLogger.ensureLogsFolder();
+    const filePath = path.join(BStackLogger.logFolderPath, 'funnelData.json');
+    fs.writeFileSync(filePath, JSON.stringify(data));
+    return filePath;
+}
+// Called from two different process
+export async function fireFunnelRequest(data) {
+    BStackLogger.debug('Sending SDK event with data ' + util.inspect(data, { depth: 6 }));
+    await got.post(FUNNEL_INSTRUMENTATION_URL, {
+        headers: {
+            'content-type': 'application/json'
+        }, username: data.userName, password: data.accessKey, json: data
+    });
+}
+function getProductList(config) {
+    const products = [];
+    if (config.testObservability.enabled) {
+        products.push('observability');
+    }
+    if (config.accessibility) {
+        products.push('accessibility');
+    }
+    if (config.percy) {
+        products.push('percy');
+    }
+    if (config.automate) {
+        products.push('automate');
+    }
+    if (config.appAutomate) {
+        products.push('app-automate');
+    }
+    return products;
+}
+function getProductMap(config) {
+    return {
+        'observability': config.testObservability.enabled,
+        'accessibility': config.accessibility,
+        'percy': config.percy,
+        'automate': config.automate,
+        'app_automate': config.appAutomate
+    };
+}
+function buildEventData(eventType, config) {
+    const eventProperties = {
+        // Framework Details
+        language_framework: getLanguageFramework(config.framework),
+        referrer: getReferrer(config.framework),
+        language: 'WebdriverIO',
+        languageVersion: process.version,
+        // Build Details
+        buildName: config.buildName || 'undefined',
+        buildIdentifier: String(config.buildIdentifier),
+        // Host details
+        os: os.type() || 'unknown',
+        hostname: os.hostname() || 'unknown',
+        // Product Details
+        productMap: getProductMap(config),
+        product: getProductList(config),
+    };
+    if (eventType === 'SDKTestSuccessful') {
+        const workerData = getDataFromWorkers();
+        eventProperties.productUsage = getProductUsage(workerData);
+    }
+    return {
+        userName: config.userName,
+        accessKey: config.accessKey,
+        event_type: eventType,
+        detectedFramework: 'WebdriverIO-' + config.framework,
+        event_properties: eventProperties
+    };
+}
+function getProductUsage(workersData) {
+    return {
+        testObservability: UsageStats.getInstance().getFormattedData(workersData)
+    };
+}
+function getLanguageFramework(framework) {
+    return 'WebdriverIO_' + framework;
+}
+function getReferrer(framework) {
+    const fullName = framework ? 'WebdriverIO-' + framework : 'WebdriverIO';
+    return `${fullName}/${BSTACK_SERVICE_VERSION}`;
+}

package/build/launcher.d.ts

@@ -16,7 +16,7 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _accessibilityAutomation?;
     private _percy?;
     private _percyBestPlatformCaps?;
-    static _testOpsBuildStopped?: boolean;
+    private readonly browserStackConfig;
     constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
     onWorkerStart(cid: any, caps: any): Promise<void>;
     onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): Promise<unknown>;

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAKlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAyBnG,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAA;CAC9C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAY5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IAbnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,wBAAwB,CAAC,CAAS;IAC1C,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,sBAAsB,CAAC,CAAkC;IACjE,OAAc,oBAAoB,CAAC,EAAE,OAAO,CAAA;gBAGhC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IA2GjC,aAAa,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAalC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAwJtF,UAAU;IA4EV,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU;IAwB7G,SAAS;IAYT,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAuBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB1D,kBAAkB;IAOxB,qBAAqB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAiFtH,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IA2F5F,sBAAsB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyCrE;;;OAGG;IACH,oBAAoB;IA6BpB,sBAAsB,CAAC,QAAQ,CAAC,EAAC,MAAM,EAAE,SAAS,CAAC,EAAC,MAAM,EAAE,eAAe,CAAC,EAAC,MAAM;IASnF,mBAAmB;CAQtB"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAKlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAgCnG,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAA;CAC9C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAY5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IAbnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,wBAAwB,CAAC,CAAS;IAC1C,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,sBAAsB,CAAC,CAAkC;IACjE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;gBAG3C,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAgHjC,aAAa,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAalC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA2JtF,UAAU;IA6EV,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU;IAwB7G,SAAS;IAYT,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAuBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB1D,kBAAkB;IAOxB,qBAAqB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAiFtH,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IA2F5F,sBAAsB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyCrE;;;OAGG;IACH,oBAAoB;IA6BpB,sBAAsB,CAAC,QAAQ,CAAC,EAAC,MAAM,EAAE,SAAS,CAAC,EAAC,MAAM,EAAE,eAAe,CAAC,EAAC,MAAM;IASnF,mBAAmB;CAQtB"}

package/build/launcher.js

@@ -10,12 +10,15 @@ 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, VALID_APP_EXTENSION } from './constants.js';
-import { launchTestSession, createAccessibilityTestRun, shouldAddServiceVersion, stopBuildUpstream, getCiInfo, isBStackSession, isUndefined, isAccessibilityAutomationSession, stopAccessibilityTestRun, isTrue, getBrowserStackUser, getBrowserStackKey, uploadLogs, ObjectsAreEqual, setupExitHandlers } from './util.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, } 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 { sendStart, sendFinish } from './instrumentation/funnelInstrumentation.js';
+import BrowserStackConfig from './config.js';
+import { setupExitHandlers } from './exitHandler.js';
 export default class BrowserstackLauncherService {
     _options;
     _config;
@@ -27,7 +30,7 @@ export default class BrowserstackLauncherService {
     _accessibilityAutomation;
     _percy;
     _percyBestPlatformCaps;
-    static _testOpsBuildStopped;
+    browserStackConfig;
     constructor(_options, capabilities, _config) {
         this._options = _options;
         this._config = _config;
@@ -36,6 +39,7 @@ export default class BrowserstackLauncherService {
         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) => {
@@ -117,18 +121,20 @@ export default class BrowserstackLauncherService {
                 }
             });
         }
-        if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+        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 ? false : true;
+        this._options.testObservability = this._options.testObservability !== false;
         if (this._options.testObservability
             &&
                 // update files to run if it's a rerun
-                process.env.BROWSERSTACK_RERUN && process.env.BROWSERSTACK_RERUN_TESTS) {
-            this._config.specs = process.env.BROWSERSTACK_RERUN_TESTS.split(',');
+                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);
@@ -151,6 +157,8 @@ export default class BrowserstackLauncherService {
         }
     }
     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
@@ -297,11 +305,11 @@ export default class BrowserstackLauncherService {
         if (this._options.testObservability) {
             BStackLogger.debug('Sending stop launch event');
             await stopBuildUpstream();
-            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`);
+            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`);
             }
-            BrowserstackLauncherService._testOpsBuildStopped = true;
-            if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+            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) {
@@ -317,6 +325,7 @@ export default class BrowserstackLauncherService {
         catch (error) {
             BStackLogger.debug(`Failed to upload BrowserStack WDIO Service logs ${error}`);
         }
+        await sendFinish(this.browserStackConfig);
         BStackLogger.clearLogger();
         if (this._options.percy) {
             await this.stopPercy();
@@ -718,8 +727,8 @@ export default class BrowserstackLauncherService {
         fs.writeFileSync(filePath, JSON.stringify(jsonContent));
     }
     _getClientBuildUuid() {
-        if (process.env.BS_TESTOPS_BUILD_HASHED_ID) {
-            return process.env.BS_TESTOPS_BUILD_HASHED_ID;
+        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');

package/build/reporter.d.ts

@@ -1,14 +1,13 @@
 import type { SuiteStats, TestStats, RunnerStats, HookStats } from '@wdio/reporter';
 import WDIOReporter from '@wdio/reporter';
 import type { CurrentRunInfo, StdLog } from './types.js';
-import type { TestMeta } from './types.js';
+import type { TestData, TestMeta } from './types.js';
 declare class _TestReporter extends WDIOReporter {
     private _capabilities;
     private _config?;
     private _observability;
     private _sessionId?;
     private _suiteName?;
-    private _requestQueueHandler;
     private _suites;
     private static _tests;
     private _gitConfigPath?;
@@ -16,6 +15,7 @@ declare class _TestReporter extends WDIOReporter {
     private _currentHook;
     private _currentTest;
     private _userCaps?;
+    private listener;
     onRunnerStart(runnerStats: RunnerStats): Promise<void>;
     private getUserCaps;
     registerListeners(): void;
@@ -32,7 +32,7 @@ declare class _TestReporter extends WDIOReporter {
     onHookEnd(hookStats: HookStats): Promise<void>;
     getHookIdentifier(hookStats: HookStats): string;
     onTestSkip(testStats: TestStats): Promise<void>;
-    sendTestRunEvent(testStats: TestStats | HookStats, eventType: string): Promise<void>;
+    getRunData(testStats: TestStats | HookStats, eventType: string): Promise<TestData>;
 }
 declare const TestReporter: typeof _TestReporter;
 type TestReporter = _TestReporter;

package/build/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACnF,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAKzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAExD,OAAO,KAAK,EAAgC,QAAQ,EAAc,MAAM,YAAY,CAAA;AAcpF,cAAM,aAAc,SAAQ,YAAY;IACpC,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,OAAO,CAAC,CAAyC;IACzD,OAAO,CAAC,cAAc,CAAO;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,oBAAoB,CAAoC;IAChE,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,MAAM,CAAC,MAAM,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,SAAS,CAAC,CAAoC;IAEhD,aAAa,CAAE,WAAW,EAAE,WAAW;IAY7C,OAAO,CAAC,WAAW;IAInB,iBAAiB;IAQJ,iBAAiB,CAAC,MAAM,EAAE,MAAM;IAc7C,cAAc,CAAC,WAAW,EAAE,cAAc;IAapC,YAAY;IAWlB,MAAM,CAAC,QAAQ;IAIf,YAAY,CAAE,UAAU,EAAE,UAAU;IAoBpC,UAAU;IAIV,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAe1C,SAAS,CAAC,SAAS,EAAE,SAAS;IAY9B,WAAW,CAAC,SAAS,EAAE,SAAS;IAgBhC,WAAW,CAAC,SAAS,EAAE,SAAS;IAehC,SAAS,CAAC,SAAS,EAAE,SAAS;IAoBpC,iBAAiB,CAAC,SAAS,EAAE,SAAS;IAIhC,UAAU,CAAE,SAAS,EAAE,SAAS;IAWhC,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM;CAgF7E;AAED,QAAA,MAAM,YAAY,EAAE,OAAO,aAAoD,CAAA;AAC/E,KAAK,YAAY,GAAG,aAAa,CAAA;AACjC,eAAe,YAAY,CAAA"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACnF,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAKzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAExD,OAAO,KAAK,EAAsB,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAaxE,cAAM,aAAc,SAAQ,YAAY;IACpC,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,OAAO,CAAC,CAAyC;IACzD,OAAO,CAAC,cAAc,CAAO;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,MAAM,CAAC,MAAM,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,SAAS,CAAC,CAAoC;IACtD,OAAO,CAAC,QAAQ,CAAyB;IAEnC,aAAa,CAAE,WAAW,EAAE,WAAW;IAY7C,OAAO,CAAC,WAAW;IAInB,iBAAiB;IAQJ,iBAAiB,CAAC,MAAM,EAAE,MAAM;IAW7C,cAAc,CAAC,WAAW,EAAE,cAAc;IAapC,YAAY;IAWlB,MAAM,CAAC,QAAQ;IAIf,YAAY,CAAE,UAAU,EAAE,UAAU;IAoBpC,UAAU;IAIV,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAe1C,SAAS,CAAC,SAAS,EAAE,SAAS;IAY9B,WAAW,CAAC,SAAS,EAAE,SAAS;IAgBhC,WAAW,CAAC,SAAS,EAAE,SAAS;IAehC,SAAS,CAAC,SAAS,EAAE,SAAS;IAoBpC,iBAAiB,CAAC,SAAS,EAAE,SAAS;IAIhC,UAAU,CAAE,SAAS,EAAE,SAAS;IAWhC,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;CAmE3F;AAED,QAAA,MAAM,YAAY,EAAE,OAAO,aAAoD,CAAA;AAC/E,KAAK,YAAY,GAAG,aAAa,CAAA;AACjC,eAAe,YAAY,CAAA"}