@wdio/browserstack-service 8.0.11 → 8.1.0

package/build/launcher.d.ts

@@ -1,6 +1,6 @@
 import * as BrowserstackLocalLauncher from 'browserstack-local';
 import type { Capabilities, Services, Options } from '@wdio/types';
-import type { BrowserstackConfig, App, AppConfig, AppUploadResponse } from './types';
+import type { BrowserstackConfig, App, AppConfig, AppUploadResponse } from './types.js';
 type BrowserstackLocal = BrowserstackLocalLauncher.Local & {
     pid?: number;
     stop(callback: (err?: any) => void): void;
@@ -9,9 +9,12 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _options;
     private _config;
     browserstackLocal?: BrowserstackLocal;
+    private _buildName?;
+    private _projectName?;
+    private _buildTag?;
     constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
     onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): Promise<unknown>;
-    onComplete(): true | Promise<unknown> | undefined;
+    onComplete(): Promise<unknown>;
     _uploadApp(app: App): Promise<AppUploadResponse>;
     /**
      * @param  {String | AppConfig}  appConfig    <string>: should be "app file path" or "app_url" or "custom_id" or "shareable_id".

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAG/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAElE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAQpF,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAI5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IALnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAiCjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA6E5F,UAAU;IAmCJ,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAC,MAAM;CA+C9F"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAG/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAElE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AASvF,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAO5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IARnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;gBAGd,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAmDjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAuFtF,UAAU;IA2CV,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAC,MAAM;CA+C9F"}

package/build/launcher.js

@@ -9,6 +9,7 @@ import { SevereServiceError } from 'webdriverio';
 import * as BrowserstackLocalLauncher from 'browserstack-local';
 import logger from '@wdio/logger';
 import { VALID_APP_EXTENSION } from './constants.js';
+import { launchTestSession, shouldAddServiceVersion, stopBuildUpstream } from './util.js';
 const require = createRequire(import.meta.url);
 const { version: bstackServiceVersion } = require('../package.json');
 const log = logger('@wdio/browserstack-service');
@@ -16,6 +17,9 @@ export default class BrowserstackLauncherService {
     _options;
     _config;
     browserstackLocal;
+    _buildName;
+    _projectName;
+    _buildTag;
     constructor(_options, capabilities, _config) {
         this._options = _options;
         this._config = _config;
@@ -28,12 +32,15 @@ export default class BrowserstackLauncherService {
                     if (extensionCaps.length) {
                         capability['bstack:options'] = { wdioService: bstackServiceVersion };
                     }
-                    else {
+                    else if (shouldAddServiceVersion(this._config, this._options.testObservability)) {
                         capability['browserstack.wdioService'] = bstackServiceVersion;
                     }
                 }
                 else {
                     capability['bstack:options'].wdioService = bstackServiceVersion;
+                    this._buildName = capability['bstack:options'].buildName;
+                    this._projectName = capability['bstack:options'].projectName;
+                    this._buildTag = capability['bstack:options'].buildTag;
                 }
             });
         }
@@ -44,15 +51,27 @@ export default class BrowserstackLauncherService {
                     if (extensionCaps.length) {
                         caps.capabilities['bstack:options'] = { wdioService: bstackServiceVersion };
                     }
-                    else {
+                    else if (shouldAddServiceVersion(this._config, this._options.testObservability)) {
                         caps.capabilities['browserstack.wdioService'] = bstackServiceVersion;
                     }
                 }
                 else {
-                    caps.capabilities['bstack:options'].wdioService = bstackServiceVersion;
+                    const bstackOptions = caps.capabilities['bstack:options'];
+                    bstackOptions.wdioService = bstackServiceVersion;
+                    this._buildName = bstackOptions.buildName;
+                    this._projectName = bstackOptions.projectName;
+                    this._buildTag = bstackOptions.buildTag;
                 }
             });
         }
+        // by default observability will be true unless specified as false
+        this._options.testObservability = this._options.testObservability === false ? false : true;
+        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(',');
+        }
     }
     async onPrepare(config, capabilities) {
         /**
@@ -64,7 +83,7 @@ export default class BrowserstackLauncherService {
         }
         else {
             let app = {};
-            let appConfig = this._options.app;
+            const appConfig = this._options.app;
             try {
                 app = await this._validateApp(appConfig);
             }
@@ -73,8 +92,7 @@ export default class BrowserstackLauncherService {
             }
             if (VALID_APP_EXTENSION.includes(path.extname(app.app))) {
                 if (fs.existsSync(app.app)) {
-                    let data;
-                    data = await this._uploadApp(app);
+                    const data = await this._uploadApp(app);
                     log.info(`app upload completed: ${JSON.stringify(data)}`);
                     app.app = data.app_url;
                 }
@@ -88,6 +106,15 @@ export default class BrowserstackLauncherService {
             log.info(`Using app: ${app.app}`);
             this._updateCaps(capabilities, 'app', app.app);
         }
+        if (this._options.testObservability) {
+            log.debug('Sending launch start event');
+            await launchTestSession(this._options, this._config, {
+                projectName: this._projectName,
+                buildName: this._buildName,
+                buildTag: this._buildTag,
+                bstackServiceVersion: bstackServiceVersion
+            });
+        }
         if (!this._options.browserstackLocal) {
             return log.info('browserstackLocal is not enabled - skipping...');
         }
@@ -125,7 +152,14 @@ export default class BrowserstackLauncherService {
             return Promise.reject(err);
         });
     }
-    onComplete() {
+    async onComplete() {
+        if (this._options.testObservability) {
+            log.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 (!this.browserstackLocal || !this.browserstackLocal.isRunning()) {
             return;
         }
@@ -157,10 +191,12 @@ export default class BrowserstackLauncherService {
     async _uploadApp(app) {
         log.info(`uploading app ${app.app} ${app.customId ? `and custom_id: ${app.customId}` : ''} to browserstack`);
         const form = new FormData();
-        if (app.app)
+        if (app.app) {
             form.append('file', fs.createReadStream(app.app));
-        if (app.customId)
+        }
+        if (app.customId) {
             form.append('custom_id', app.customId);
+        }
         const res = await got.post('https://api-cloud.browserstack.com/app-automate/upload', {
             body: form,
             username: this._config.user,
@@ -175,7 +211,7 @@ export default class BrowserstackLauncherService {
      *                                            <object>: only "path" and "custom_id" should coexist as multiple properties.
      */
     async _validateApp(appConfig) {
-        let app = {};
+        const app = {};
         if (typeof appConfig === 'string') {
             app.app = appConfig;
         }
@@ -213,7 +249,7 @@ export default class BrowserstackLauncherService {
                         capability['browserstack.local'] = true;
                     }
                     else if (capType === 'app') {
-                        capability['app'] = value;
+                        capability.app = value;
                     }
                 }
                 else if (capType === 'local') {
@@ -240,7 +276,7 @@ export default class BrowserstackLauncherService {
                         caps.capabilities['browserstack.local'] = true;
                     }
                     else if (capType === 'app') {
-                        caps.capabilities['app'] = value;
+                        caps.capabilities.app = value;
                     }
                 }
                 else if (capType === 'local') {

package/build/reporter.d.ts

@@ -0,0 +1,14 @@
+import type { SuiteStats, TestStats, RunnerStats } from '@wdio/reporter';
+import WDIOReporter from '@wdio/reporter';
+export default class TestReporter extends WDIOReporter {
+    private _capabilities;
+    private _config?;
+    private _observability;
+    private _sessionId?;
+    private _suiteName?;
+    private _requestQueueHandler;
+    onRunnerStart(runnerStats: RunnerStats): void;
+    onSuiteStart(suiteStats: SuiteStats): void;
+    onTestSkip(testStats: TestStats): Promise<void>;
+}
+//# sourceMappingURL=reporter.d.ts.map

package/build/reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACxE,OAAO,YAAY,MAAM,gBAAgB,CAAA;AASzC,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY;IAClD,OAAO,CAAC,aAAa,CAAgC;IACrD,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;IAEhE,aAAa,CAAE,WAAW,EAAE,WAAW;IASvC,YAAY,CAAE,UAAU,EAAE,UAAU;IAI9B,UAAU,CAAE,SAAS,EAAE,SAAS;CAgDzC"}

package/build/reporter.js

@@ -0,0 +1,66 @@
+import WDIOReporter from '@wdio/reporter';
+import { v4 as uuidv4 } from 'uuid';
+import { getCloudProvider, uploadEventData, getHierarchy } from './util.js';
+import RequestQueueHandler from './request-handler.js';
+export default class TestReporter extends WDIOReporter {
+    _capabilities = {};
+    _config;
+    _observability = true;
+    _sessionId;
+    _suiteName;
+    _requestQueueHandler = RequestQueueHandler.getInstance();
+    onRunnerStart(runnerStats) {
+        this._capabilities = runnerStats.capabilities;
+        this._config = runnerStats.config;
+        this._sessionId = runnerStats.sessionId;
+        if (typeof this._config.testObservability !== 'undefined') {
+            this._observability = this._config.testObservability;
+        }
+    }
+    onSuiteStart(suiteStats) {
+        this._suiteName = suiteStats.file;
+    }
+    async onTestSkip(testStats) {
+        // cucumber steps call this method. We don't want step skipped state so skip for cucumber
+        const framework = this._config?.framework;
+        if (this._observability && framework !== 'cucumber') {
+            const testData = {
+                uuid: uuidv4(),
+                type: testStats.type,
+                name: testStats.title,
+                body: {
+                    lang: 'webdriverio',
+                    code: null
+                },
+                scope: testStats.fullTitle,
+                scopes: getHierarchy(testStats.fullTitle),
+                identifier: testStats.fullTitle,
+                file_name: this._suiteName,
+                location: this._suiteName,
+                started_at: (new Date()).toISOString(),
+                framework: framework,
+                finished_at: (new Date()).toISOString(),
+                duration_in_ms: testStats._duration,
+                retries: { limit: 0, attempts: 0 },
+                result: testStats.state,
+            };
+            const cloudProvider = getCloudProvider({ options: { hostname: this._config?.hostname } });
+            testData.integrations = {};
+            testData.integrations[cloudProvider] = {
+                capabilities: this._capabilities,
+                session_id: this._sessionId,
+                browser: this._capabilities?.browserName,
+                browser_version: this._capabilities?.browserVersion,
+                platform: this._capabilities?.platformName,
+            };
+            const uploadData = {
+                event_type: 'TestRunFinished',
+                test_run: testData
+            };
+            const req = this._requestQueueHandler.add(uploadData);
+            if (req.proceed && req.data) {
+                await uploadEventData(req.data, req.url);
+            }
+        }
+    }
+}

package/build/request-handler.d.ts

@@ -0,0 +1,26 @@
+import type { UploadType } from './types.js';
+export default class RequestQueueHandler {
+    private queue;
+    private started;
+    private pollEventBatchInterval?;
+    pendingUploads: number;
+    static instance: RequestQueueHandler;
+    private constructor();
+    static getInstance(): RequestQueueHandler;
+    start(): void;
+    add(event: UploadType): {
+        proceed: boolean;
+        data?: undefined;
+        url?: undefined;
+    } | {
+        proceed: boolean;
+        data: UploadType[] | undefined;
+        url: string;
+    };
+    shutdown(): Promise<void>;
+    startEventBatchPolling(): void;
+    resetEventBatchPolling(): void;
+    removeEventBatchPolling(tag: string): void;
+    shouldProceed(): boolean;
+}
+//# sourceMappingURL=request-handler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request-handler.d.ts","sourceRoot":"","sources":["../src/request-handler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAK5C,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACpC,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,sBAAsB,CAAC,CAAgC;IACxD,cAAc,SAAI;IAEzB,MAAM,CAAC,QAAQ,EAAE,mBAAmB,CAAA;IAGpC,OAAO;WAEO,WAAW,IAAI,mBAAmB;IAOhD,KAAK;IAOL,GAAG,CAAE,KAAK,EAAE,UAAU;;;;;;;;;IAuChB,QAAQ;IAQd,sBAAsB;IAUtB,sBAAsB;IAKtB,uBAAuB,CAAE,GAAG,EAAE,MAAM;IAQpC,aAAa;CAGhB"}

package/build/request-handler.js

@@ -0,0 +1,88 @@
+import logger from '@wdio/logger';
+import { DATA_BATCH_SIZE, DATA_BATCH_INTERVAL, DATA_BATCH_ENDPOINT, BATCH_EVENT_TYPES, DATA_SCREENSHOT_ENDPOINT } from './constants.js';
+import { batchAndPostEvents } from './util.js';
+const log = logger('@wdio/browserstack-service');
+export default class RequestQueueHandler {
+    queue = [];
+    started = false;
+    pollEventBatchInterval;
+    pendingUploads = 0;
+    static instance;
+    // making it private to use singleton pattern
+    constructor() { }
+    static getInstance() {
+        if (!RequestQueueHandler.instance) {
+            RequestQueueHandler.instance = new RequestQueueHandler();
+        }
+        return RequestQueueHandler.instance;
+    }
+    start() {
+        if (!this.started) {
+            this.started = true;
+            this.startEventBatchPolling();
+        }
+    }
+    add(event) {
+        if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
+            return {
+                proceed: false
+            };
+        }
+        if (!BATCH_EVENT_TYPES.includes(event.event_type)) {
+            return {
+                proceed: true
+            };
+        }
+        if (event.logs && event.logs[0] && event.logs[0].kind === 'TEST_SCREENSHOT') {
+            return {
+                proceed: true,
+                data: [event],
+                url: DATA_SCREENSHOT_ENDPOINT
+            };
+        }
+        this.queue.push(event);
+        log.debug(`Added data to request queue. Queue length = ${this.queue.length}`);
+        let data;
+        const shouldProceed = this.shouldProceed();
+        if (shouldProceed) {
+            data = this.queue.splice(0, DATA_BATCH_SIZE);
+            this.resetEventBatchPolling();
+            log.debug(`Sending data from request queue. Data length = ${data.length}, Queue length after removal = ${this.queue.length}`);
+        }
+        return {
+            proceed: shouldProceed,
+            data: data,
+            url: DATA_BATCH_ENDPOINT
+        };
+    }
+    async shutdown() {
+        this.removeEventBatchPolling('Shutting down');
+        while (this.queue.length > 0) {
+            const data = this.queue.splice(0, DATA_BATCH_SIZE);
+            await batchAndPostEvents(DATA_BATCH_ENDPOINT, 'SHUTDOWN_QUEUE', data);
+        }
+    }
+    startEventBatchPolling() {
+        this.pollEventBatchInterval = setInterval(async () => {
+            if (this.queue.length > 0) {
+                const data = this.queue.splice(0, DATA_BATCH_SIZE);
+                log.debug(`Sending data from request queue. Data length = ${data.length}, Queue length after removal = ${this.queue.length}`);
+                await batchAndPostEvents(DATA_BATCH_ENDPOINT, 'INTERVAL_QUEUE', data);
+            }
+        }, DATA_BATCH_INTERVAL);
+    }
+    resetEventBatchPolling() {
+        this.removeEventBatchPolling('Resetting');
+        this.startEventBatchPolling();
+    }
+    removeEventBatchPolling(tag) {
+        if (this.pollEventBatchInterval) {
+            log.debug(`${tag} request queue`);
+            clearInterval(this.pollEventBatchInterval);
+            this.started = false;
+        }
+    }
+    shouldProceed() {
+        return this.queue.length >= DATA_BATCH_SIZE;
+    }
+}

package/build/service.d.ts

@@ -1,6 +1,7 @@
 import type { Services, Capabilities, Options, Frameworks } from '@wdio/types';
 import type { Browser, MultiRemoteBrowser } from 'webdriverio';
-import type { BrowserstackConfig, MultiRemoteAction } from './types';
+import type { BrowserstackConfig, MultiRemoteAction } from './types.js';
+import type { Pickle, Feature, ITestCaseHookParameter } from './cucumber-types.js';
 export default class BrowserstackService implements Services.ServiceInstance {
     private _caps;
     private _config;
@@ -12,6 +13,10 @@ export default class BrowserstackService implements Services.ServiceInstance {
     private _suiteTitle?;
     private _fullTitle?;
     private _options;
+    private _specsRan;
+    private _observability;
+    private _currentTest?;
+    private _insightsHandler?;
     constructor(options: BrowserstackConfig & Options.Testrunner, _caps: Capabilities.RemoteCapability, _config: Options.Testrunner);
     _updateCaps(fn: (caps: Capabilities.Capabilities | Capabilities.DesiredCapabilities) => void): void;
     beforeSession(config: Omit<Options.Testrunner, 'capabilities'>): void;
@@ -24,33 +29,28 @@ export default class BrowserstackService implements Services.ServiceInstance {
      * and `suite.fullTitle` is `undefined`, so no alternative to use for the job name.
      */
     beforeSuite(suite: Frameworks.Suite): Promise<void>;
+    beforeHook(test: Frameworks.Test, context: any): Promise<void>;
+    afterHook(test: Frameworks.Test, context: unknown, result: Frameworks.TestResult): Promise<void>;
     beforeTest(test: Frameworks.Test): Promise<void>;
+    afterTest(test: Frameworks.Test, context: never, results: Frameworks.TestResult): Promise<void>;
+    after(result: number): Promise<void>;
     /**
      * For CucumberJS
      */
-    beforeFeature(uri: unknown, feature: {
-        name: string;
-    }): Promise<void>;
+    beforeFeature(uri: string, feature: Feature): Promise<void>;
     /**
      * Runs before a Cucumber Scenario.
      * @param world world object containing information on pickle and test step
      */
-    beforeScenario(world: Frameworks.World): Promise<void>;
-    /**
-     * For CucumberJS
-     */
-    beforeStep(step: Frameworks.PickleStep): Promise<void>;
-    afterTest(test: Frameworks.Test, context: never, results: Frameworks.TestResult): void;
-    after(result: number): Promise<void>;
-    /**
-     * For CucumberJS
-     */
-    afterScenario(world: Frameworks.World): void;
+    beforeScenario(world: ITestCaseHookParameter): Promise<void>;
+    afterScenario(world: ITestCaseHookParameter): Promise<void>;
+    beforeStep(step: Frameworks.PickleStep, scenario: Pickle): Promise<void>;
+    afterStep(step: Frameworks.PickleStep, scenario: Pickle, result: Frameworks.PickleResult): Promise<void>;
     onReload(oldSessionId: string, newSessionId: string): Promise<void>;
     _isAppAutomate(): boolean;
     _updateJob(requestBody: any): Promise<any>;
     _multiRemoteAction(action: MultiRemoteAction): Promise<any>;
-    _update(sessionId: string, requestBody: any): import("got").CancelableRequest<import("got").Response<string>>;
+    _update(sessionId: string, requestBody: any): Promise<void> | import("got").CancelableRequest<import("got").Response<string>>;
     _printSessionURL(): Promise<void>;
     private _setSessionName;
     private _setAnnotation;

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAG9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,SAAS,CAAA;AAKrF,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAYpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAZnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAyC;gBAGrD,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACxC,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAavC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IAe/D,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAepH;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAQpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAkBvC;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAM3D;;;OAGG;IACG,cAAc,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAK7C;;OAEG;IACG,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU;IAK7C,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAOzE,KAAK,CAAE,MAAM,EAAE,MAAM;IAkB3B;;OAEG;IACH,aAAa,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAmBhC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAgCzD,cAAc,IAAI,OAAO;IAOzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAUrC,gBAAgB;YAuBR,eAAe;IA0B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAG9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,YAAY,CAAA;AACxF,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AASlF,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAgBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAhBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,YAAY,CAAC,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAAiB;gBAGtC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACxC,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAkBvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IAezD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAqC1H;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAQpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG;IAO/C,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAIjF,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAoBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAS/E,KAAK,CAAE,MAAM,EAAE,MAAM;IAqB3B;;OAEG;IAEG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAMjD;;;OAGG;IACG,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAO7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAsB5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAKzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAIzF,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAgCzD,cAAc,IAAI,OAAO;IAOzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAarC,gBAAgB;YAuBR,eAAe;IA0B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}

package/build/service.js

@@ -1,7 +1,12 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import logger from '@wdio/logger';
 import got from 'got';
-import { getBrowserDescription, getBrowserCapabilities, isBrowserstackCapability, getParentSuiteName } from './util.js';
+import { getBrowserDescription, getBrowserCapabilities, isBrowserstackCapability, getParentSuiteName, isBrowserstackSession } from './util.js';
+import InsightsHandler from './insights-handler.js';
 import { DEFAULT_OPTIONS } from './constants.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 const log = logger('@wdio/browserstack-service');
 export default class BrowserstackService {
     _caps;
@@ -14,12 +19,20 @@ export default class BrowserstackService {
     _suiteTitle;
     _fullTitle;
     _options;
+    _specsRan = false;
+    _observability;
+    _currentTest;
+    _insightsHandler;
     constructor(options, _caps, _config) {
         this._caps = _caps;
         this._config = _config;
         this._options = { ...DEFAULT_OPTIONS, ...options };
         // added to maintain backward compatibility with webdriverIO v5
         this._config || (this._config = this._options);
+        this._observability = this._options.testObservability;
+        if (this._observability) {
+            this._config.reporters?.push(path.join(__dirname, 'reporter.js'));
+        }
         // Cucumber specific
         const strict = Boolean(this._config.cucumberOpts && this._config.cucumberOpts.strict);
         // See https://github.com/cucumber/cucumber-js/blob/master/src/runtime/index.ts#L136
@@ -47,7 +60,7 @@ export default class BrowserstackService {
         this._config.user = config.user;
         this._config.key = config.key;
     }
-    before(caps, specs, browser) {
+    async before(caps, specs, browser) {
         // added to maintain backward compatibility with webdriverIO v5
         this._browser = browser ? browser : global.browser;
         // Ensure capabilities are not null in case of multiremote
@@ -55,7 +68,19 @@ export default class BrowserstackService {
             this._sessionBaseUrl = 'https://api-cloud.browserstack.com/app-automate/sessions';
         }
         this._scenariosThatRan = [];
-        return this._printSessionURL();
+        if (this._observability && this._browser) {
+            this._insightsHandler = new InsightsHandler(this._browser, this._browser.capabilities, this._isAppAutomate(), this._browser.sessionId, this._config.framework);
+            await this._insightsHandler.before();
+            /**
+             * register command event
+             */
+            this._browser.on('command', async (command) => await this._insightsHandler?.browserCommand('client:beforeCommand', Object.assign(command, { sessionId: this._browser?.sessionId }), this._currentTest));
+            /**
+             * register result event
+             */
+            this._browser.on('result', async (result) => await this._insightsHandler?.browserCommand('client:afterCommand', Object.assign(result, { sessionId: this._browser?.sessionId }), this._currentTest));
+        }
+        return await this._printSessionURL();
     }
     /**
      * Set the default job name at the suite level to make sure we account
@@ -70,7 +95,17 @@ export default class BrowserstackService {
             await this._setSessionName(suite.title);
         }
     }
+    async beforeHook(test, context) {
+        if (this._config.framework !== 'cucumber') {
+            this._currentTest = test; // not update currentTest when this is called for cucumber step
+        }
+        await this._insightsHandler?.beforeHook(test, context);
+    }
+    async afterHook(test, context, result) {
+        await this._insightsHandler?.afterHook(test, result);
+    }
     async beforeTest(test) {
+        this._currentTest = test;
         let suiteTitle = this._suiteTitle;
         if (test.fullName) {
             // For Jasmine, `suite.title` is `Jasmine__TopLevel__Suite`.
@@ -85,35 +120,15 @@ export default class BrowserstackService {
         }
         await this._setSessionName(suiteTitle, test);
         await this._setAnnotation(`Test: ${test.fullName ?? test.title}`);
+        await this._insightsHandler?.beforeTest(test);
     }
-    /**
-     * For CucumberJS
-     */
-    async beforeFeature(uri, feature) {
-        this._suiteTitle = feature.name;
-        await this._setSessionName(feature.name);
-        await this._setAnnotation(`Feature: ${feature.name}`);
-    }
-    /**
-     * Runs before a Cucumber Scenario.
-     * @param world world object containing information on pickle and test step
-     */
-    async beforeScenario(world) {
-        const scenarioName = world.pickle.name || 'unknown scenario';
-        await this._setAnnotation(`Scenario: ${scenarioName}`);
-    }
-    /**
-     * For CucumberJS
-     */
-    async beforeStep(step) {
-        const { keyword, text } = step;
-        await this._setAnnotation(`Step: ${keyword}${text}`);
-    }
-    afterTest(test, context, results) {
+    async afterTest(test, context, results) {
+        this._specsRan = true;
         const { error, passed } = results;
         if (!passed) {
             this._failReasons.push((error && error.message) || 'Unknown Error');
         }
+        await this._insightsHandler?.afterTest(test, results);
     }
     async after(result) {
         const { preferScenarioName, setSessionName, setSessionStatus } = this._options;
@@ -125,16 +140,34 @@ export default class BrowserstackService {
         if (setSessionStatus) {
             const hasReasons = this._failReasons.length > 0;
             await this._updateJob({
-                status: result === 0 ? 'passed' : 'failed',
+                status: result === 0 && this._specsRan ? 'passed' : 'failed',
                 ...(setSessionName ? { name: this._fullTitle } : {}),
                 ...(hasReasons ? { reason: this._failReasons.join('\n') } : {})
             });
         }
+        await this._insightsHandler?.uploadPending();
+        await this._insightsHandler?.teardown();
     }
     /**
      * For CucumberJS
      */
-    afterScenario(world) {
+    async beforeFeature(uri, feature) {
+        this._suiteTitle = feature.name;
+        await this._setSessionName(feature.name);
+        await this._setAnnotation(`Feature: ${feature.name}`);
+    }
+    /**
+     * Runs before a Cucumber Scenario.
+     * @param world world object containing information on pickle and test step
+     */
+    async beforeScenario(world) {
+        this._currentTest = world;
+        await this._insightsHandler?.beforeScenario(world);
+        const scenarioName = world.pickle.name || 'unknown scenario';
+        await this._setAnnotation(`Scenario: ${scenarioName}`);
+    }
+    async afterScenario(world) {
+        this._specsRan = true;
         const status = world.result?.status.toLowerCase();
         if (status !== 'skipped') {
             this._scenariosThatRan.push(world.pickle.name || 'unknown pickle name');
@@ -146,6 +179,14 @@ export default class BrowserstackService {
                     : 'Unknown Error'));
             this._failReasons.push(exception);
         }
+        await this._insightsHandler?.afterScenario(world);
+    }
+    async beforeStep(step, scenario) {
+        await this._insightsHandler?.beforeStep(step, scenario);
+        await this._setAnnotation(`Step: ${step.keyword}${step.text}`);
+    }
+    async afterStep(step, scenario, result) {
+        await this._insightsHandler?.afterStep(step, scenario, result);
     }
     async onReload(oldSessionId, newSessionId) {
         if (!this._browser) {
@@ -203,6 +244,9 @@ export default class BrowserstackService {
             .map((browserName) => (action(_browser[browserName].sessionId, browserName))));
     }
     _update(sessionId, requestBody) {
+        if (!isBrowserstackSession(this._browser)) {
+            return Promise.resolve();
+        }
         const sessionUrl = `${this._sessionBaseUrl}/${sessionId}.json`;
         log.debug(`Updating Browserstack session at ${sessionUrl} with request body: `, requestBody);
         return got.put(sessionUrl, {
@@ -212,7 +256,7 @@ export default class BrowserstackService {
         });
     }
     async _printSessionURL() {
-        if (!this._browser) {
+        if (!this._browser || !isBrowserstackSession(this._browser)) {
             return Promise.resolve();
         }
         await this._multiRemoteAction(async (sessionId, browserName) => {
@@ -254,7 +298,7 @@ export default class BrowserstackService {
         return this._executeCommand('annotate', { data, level: 'info' });
     }
     async _executeCommand(action, args) {
-        if (!this._browser) {
+        if (!this._browser || !isBrowserstackSession(this._browser)) {
             return Promise.resolve();
         }
         const cmd = { action, ...(args ? { arguments: args } : {}) };