@wdio/browserstack-service 7.30.3 → 7.32.0

package/build/crash-reporter.d.ts

@@ -0,0 +1,14 @@
+import type { Capabilities, Options } from '@wdio/types';
+import type { BrowserstackConfig, UserConfigforReporting } from './types';
+export default class CrashReporter {
+    static userConfigForReporting: UserConfigforReporting;
+    private static credentialsForCrashReportUpload;
+    static setCredentialsForCrashReportUpload(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner): void;
+    static setConfigDetails(userConfig: Options.Testrunner, capabilities: Capabilities.RemoteCapability, options: BrowserstackConfig & Options.Testrunner): void;
+    static uploadCrashReport(exception: any, stackTrace: string): Promise<void>;
+    static deletePIIKeysFromObject(obj: {
+        [key: string]: any;
+    }): void;
+    static filterPII(userConfig: Options.Testrunner): any;
+}
+//# sourceMappingURL=crash-reporter.d.ts.map

package/build/crash-reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crash-reporter.d.ts","sourceRoot":"","sources":["../src/crash-reporter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAMxD,OAAO,KAAK,EAAE,kBAAkB,EAAmC,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAK1G,MAAM,CAAC,OAAO,OAAO,aAAa;IAE9B,OAAc,sBAAsB,EAAE,sBAAsB,CAAK;IAEjE,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAsC;IAEpF,MAAM,CAAC,kCAAkC,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU;IAQtH,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU;WAgBxI,iBAAiB,CAAC,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM;IA6CjE,MAAM,CAAC,uBAAuB,CAAC,GAAG,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAO1D,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU;CAyBlD"}

package/build/crash-reporter.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = __importDefault(require("@wdio/logger"));
+const got_1 = __importDefault(require("got"));
+// @ts-ignore
+const package_json_1 = require("../package.json");
+const constants_1 = require("./constants");
+const util_1 = require("./util");
+const log = (0, logger_1.default)('@wdio/browserstack-service');
+class CrashReporter {
+    static setCredentialsForCrashReportUpload(options, config) {
+        this.credentialsForCrashReportUpload = {
+            username: (0, util_1.getObservabilityUser)(options, config),
+            password: (0, util_1.getObservabilityKey)(options, config)
+        };
+        process.env.CREDENTIALS_FOR_CRASH_REPORTING = JSON.stringify(this.credentialsForCrashReportUpload);
+    }
+    static setConfigDetails(userConfig, capabilities, options) {
+        const configWithoutPII = this.filterPII(userConfig);
+        this.userConfigForReporting = {
+            framework: userConfig.framework,
+            services: configWithoutPII.services,
+            capabilities: capabilities,
+            env: {
+                'BROWSERSTACK_BUILD': process.env.BROWSERSTACK_BUILD,
+                'BROWSERSTACK_BUILD_NAME': process.env.BROWSERSTACK_BUILD_NAME,
+                'BUILD_TAG': process.env.BUILD_TAG
+            }
+        };
+        process.env.USER_CONFIG_FOR_REPORTING = JSON.stringify(this.userConfigForReporting);
+        this.setCredentialsForCrashReportUpload(options, userConfig);
+    }
+    static async uploadCrashReport(exception, stackTrace) {
+        try {
+            if (!this.credentialsForCrashReportUpload.username || !this.credentialsForCrashReportUpload.password) {
+                this.credentialsForCrashReportUpload = process.env.CREDENTIALS_FOR_CRASH_REPORTING !== undefined ? JSON.parse(process.env.CREDENTIALS_FOR_CRASH_REPORTING) : this.credentialsForCrashReportUpload;
+            }
+        }
+        catch (error) {
+            return log.error(`[Crash_Report_Upload] Failed to parse user credentials while reporting crash due to ${error}`);
+        }
+        if (!this.credentialsForCrashReportUpload.username || !this.credentialsForCrashReportUpload.password) {
+            return log.error('[Crash_Report_Upload] Failed to parse user credentials while reporting crash');
+        }
+        try {
+            if (Object.keys(this.userConfigForReporting).length === 0) {
+                this.userConfigForReporting = process.env.USER_CONFIG_FOR_REPORTING !== undefined ? JSON.parse(process.env.USER_CONFIG_FOR_REPORTING) : {};
+            }
+        }
+        catch (error) {
+            log.error(`[Crash_Report_Upload] Failed to parse user config while reporting crash due to ${error}`);
+            this.userConfigForReporting = {};
+        }
+        const data = {
+            hashed_id: process.env.BS_TESTOPS_BUILD_HASHED_ID,
+            observability_version: {
+                frameworkName: 'WebdriverIO-' + (this.userConfigForReporting.framework || 'null'),
+                sdkVersion: package_json_1.version
+            },
+            exception: {
+                error: exception.toString(),
+                stackTrace: stackTrace
+            },
+            config: this.userConfigForReporting
+        };
+        const url = `${constants_1.DATA_ENDPOINT}/api/v1/analytics`;
+        got_1.default.post(url, {
+            ...util_1.DEFAULT_REQUEST_CONFIG,
+            ...this.credentialsForCrashReportUpload,
+            json: data
+        }).text().then(response => {
+            log.debug(`[Crash_Report_Upload] Success response: ${JSON.stringify(response)}`);
+        }).catch((error) => {
+            log.error(`[Crash_Report_Upload] Failed due to ${error}`);
+        });
+    }
+    static deletePIIKeysFromObject(obj) {
+        if (!obj) {
+            return;
+        }
+        ['user', 'username', 'key', 'accessKey'].forEach(key => delete obj[key]);
+    }
+    static filterPII(userConfig) {
+        const configWithoutPII = JSON.parse(JSON.stringify(userConfig));
+        this.deletePIIKeysFromObject(configWithoutPII);
+        const finalServices = [];
+        const initialServices = configWithoutPII.services;
+        delete configWithoutPII.services;
+        try {
+            for (const serviceArray of initialServices) {
+                if (Array.isArray(serviceArray) && serviceArray.length >= 2 && serviceArray[0] === 'browserstack') {
+                    for (let idx = 1; idx < serviceArray.length; idx++) {
+                        this.deletePIIKeysFromObject(serviceArray[idx]);
+                        serviceArray[idx] && this.deletePIIKeysFromObject(serviceArray[idx].testObservabilityOptions);
+                    }
+                    finalServices.push(serviceArray);
+                    break;
+                }
+            }
+        }
+        catch (err) {
+            /* Wrong configuration like strings instead of json objects could break this method, needs no action */
+            log.error(`Error in parsing user config PII with error ${err ? (err.stack || err) : err}`);
+            return configWithoutPII;
+        }
+        configWithoutPII.services = finalServices;
+        return configWithoutPII;
+    }
+}
+/* User test config for build run minus PII */
+CrashReporter.userConfigForReporting = {};
+/* User credentials used for reporting crashes in browserstack service */
+CrashReporter.credentialsForCrashReportUpload = {};
+exports.default = CrashReporter;

package/build/insights-handler.d.ts

@@ -2,7 +2,7 @@ import type { Capabilities, Frameworks } from '@wdio/types';
 import type { Browser, MultiRemoteBrowser } from 'webdriverio';
 import type { BeforeCommandArgs, AfterCommandArgs } from '@wdio/reporter';
 import type { Pickle, ITestCaseHookParameter } from './cucumber-types';
-export default class InsightsHandler {
+declare class _InsightsHandler {
     private _browser;
     private _framework?;
     private _tests;
@@ -37,4 +37,7 @@ export default class InsightsHandler {
     private getIntegrationsObject;
     private getIdentifier;
 }
+declare const InsightsHandler: typeof _InsightsHandler;
+type InsightsHandler = _InsightsHandler;
+export default InsightsHandler;
 //# sourceMappingURL=insights-handler.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"insights-handler.d.ts","sourceRoot":"","sources":["../src/insights-handler.ts"],"names":[],"mappings":"AAEA,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,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGzE,OAAO,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAA;AAOtE,MAAM,CAAC,OAAO,OAAO,eAAe;IASnB,OAAO,CAAC,QAAQ;IAAwI,OAAO,CAAC,UAAU,CAAC;IAPxL,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,aAAa,CAAC,CAAc;IACpC,OAAO,CAAC,SAAS,CAA2D;IAC5E,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,oBAAoB,CAAoC;gBAE3C,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAU,UAAU,CAAC,oBAAQ;IAa1L,MAAM;IAWN,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG;IAa/C,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAc/D,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IASjC,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IASrE;;QAEI;IAEE,cAAc,CAAE,KAAK,EAAE,sBAAsB;IA+B7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAI5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAuBzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAgCzF,aAAa,CACf,WAAW,SAA2C,EACtD,YAAY,SAA4C;IAUtD,QAAQ;IAId;;OAEG;IAEG,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,GAAG,sBAAsB;IA2DtI,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,YAAY;YAYN,gBAAgB;YAuEhB,2BAA2B;IAsFzC,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,aAAa;CAMxB"}
+{"version":3,"file":"insights-handler.d.ts","sourceRoot":"","sources":["../src/insights-handler.ts"],"names":[],"mappings":"AAEA,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,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGzE,OAAO,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAA;AAsBtE,cAAM,gBAAgB;IASL,OAAO,CAAC,QAAQ;IAAwI,OAAO,CAAC,UAAU,CAAC;IAPxL,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,aAAa,CAAC,CAAc;IACpC,OAAO,CAAC,SAAS,CAA2D;IAC5E,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,oBAAoB,CAAoC;gBAE3C,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAU,UAAU,CAAC,oBAAQ;IAa1L,MAAM;IAWN,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG;IAgB/C,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAqD/D,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAUjC,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAUrE;;QAEI;IAEE,cAAc,CAAE,KAAK,EAAE,sBAAsB;IA+B7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAI5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAuBzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAgCzF,aAAa,CACf,WAAW,SAA2C,EACtD,YAAY,SAA4C;IAUtD,QAAQ;IAId;;OAEG;IAEG,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,GAAG,sBAAsB;IA4DtI,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,YAAY;YAaN,gBAAgB;YA4EhB,2BAA2B;IAsFzC,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,aAAa;CAMxB;AAGD,QAAA,MAAM,eAAe,EAAE,OAAO,gBAA0D,CAAA;AACxF,KAAK,eAAe,GAAG,gBAAgB,CAAA;AAEvC,eAAe,eAAe,CAAA"}

package/build/insights-handler.js

@@ -5,10 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const uuid_1 = require("uuid");
+const reporter_1 = __importDefault(require("./reporter"));
 const util_1 = require("./util");
 const request_handler_1 = __importDefault(require("./request-handler"));
 const constants_1 = require("./constants");
-class InsightsHandler {
+class _InsightsHandler {
     constructor(_browser, browserCaps, isAppAutomate, sessionId, _framework) {
         this._browser = _browser;
         this._framework = _framework;
@@ -36,33 +37,69 @@ class InsightsHandler {
         }
     }
     async beforeHook(test, context) {
-        if (this._framework == 'mocha') {
-            const fullTitle = `${test.parent} - ${test.title}`;
-            const hookId = (0, uuid_1.v4)();
-            this._tests[fullTitle] = {
-                uuid: hookId,
-                startedAt: (new Date()).toISOString()
-            };
-            this.attachHookData(context, hookId);
-            await this.sendTestRunEvent(test, 'HookRunStarted');
+        if (!(0, util_1.frameworkSupportsHook)('before', this._framework)) {
+            return;
         }
+        const fullTitle = (0, util_1.getUniqueIdentifier)(test, this._framework);
+        const hookId = (0, uuid_1.v4)();
+        this._tests[fullTitle] = {
+            uuid: hookId,
+            startedAt: (new Date()).toISOString()
+        };
+        this.attachHookData(context, hookId);
+        await this.sendTestRunEvent(test, 'HookRunStarted');
     }
     async afterHook(test, result) {
-        if (this._framework == 'mocha') {
-            const fullTitle = (0, util_1.getUniqueIdentifier)(test);
-            if (this._tests[fullTitle]) {
-                this._tests[fullTitle].finishedAt = (new Date()).toISOString();
-            }
-            else {
-                this._tests[fullTitle] = {
-                    finishedAt: (new Date()).toISOString()
-                };
-            }
-            await this.sendTestRunEvent(test, 'HookRunFinished', result);
+        if (!(0, util_1.frameworkSupportsHook)('after', this._framework)) {
+            return;
+        }
+        const fullTitle = (0, util_1.getUniqueIdentifier)(test, this._framework);
+        if (this._tests[fullTitle]) {
+            this._tests[fullTitle].finishedAt = (new Date()).toISOString();
+        }
+        else {
+            this._tests[fullTitle] = {
+                finishedAt: (new Date()).toISOString()
+            };
+        }
+        await this.sendTestRunEvent(test, 'HookRunFinished', result);
+        const hookType = (0, util_1.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)
+            So if any of this hook fails, then we are sending the next tests in the suite as skipped.
+            This won't be needed for `afterAll`, as even if `afterAll` fails all the tests that we need are already run by then, so we don't need to send the stats for them separately
+         */
+        if (!result.passed && (hookType === 'BEFORE_EACH' || hookType === 'BEFORE_ALL' || hookType === 'AFTER_EACH')) {
+            const sendTestSkip = async (skippedTest) => {
+                // We only need to send the tests that whose state is not determined yet. The state of tests which is determined will already be sent.
+                if (skippedTest.state === undefined) {
+                    const fullTitle = `${skippedTest.parent.title} - ${skippedTest.title}`;
+                    this._tests[fullTitle] = {
+                        uuid: (0, uuid_1.v4)(),
+                        startedAt: (new Date()).toISOString(),
+                        finishedAt: (new Date()).toISOString()
+                    };
+                    await this.sendTestRunEvent(skippedTest, 'TestRunSkipped');
+                }
+            };
+            /*
+                Recursively send the tests as skipped for all suites below the hook. This is to handle nested describe blocks
+             */
+            const sendSuiteSkipped = async (suite) => {
+                for (const skippedTest of suite.tests) {
+                    await sendTestSkip(skippedTest);
+                }
+                for (const skippedSuite of suite.suites) {
+                    await sendSuiteSkipped(skippedSuite);
+                }
+            };
+            await sendSuiteSkipped(test.ctx.test.parent);
         }
     }
     async beforeTest(test) {
-        const fullTitle = (0, util_1.getUniqueIdentifier)(test);
+        if (this._framework !== 'mocha')
+            return;
+        const fullTitle = (0, util_1.getUniqueIdentifier)(test, this._framework);
         this._tests[fullTitle] = {
             uuid: (0, uuid_1.v4)(),
             startedAt: (new Date()).toISOString()
@@ -70,7 +107,9 @@ class InsightsHandler {
         await this.sendTestRunEvent(test, 'TestRunStarted');
     }
     async afterTest(test, result) {
-        const fullTitle = (0, util_1.getUniqueIdentifier)(test);
+        if (this._framework !== 'mocha')
+            return;
+        const fullTitle = (0, util_1.getUniqueIdentifier)(test, this._framework);
         this._tests[fullTitle] = {
             ...(this._tests[fullTitle] || {}),
             finishedAt: (new Date()).toISOString()
@@ -179,7 +218,8 @@ class InsightsHandler {
             return;
         }
         const identifier = this.getIdentifier(test);
-        if (!this._tests[identifier]) {
+        const testMeta = this._tests[identifier] || reporter_1.default.getTests()[identifier];
+        if (!testMeta) {
             return;
         }
         // log screenshot
@@ -187,7 +227,7 @@ class InsightsHandler {
             await (0, util_1.uploadEventData)([{
                     event_type: 'LogCreated',
                     logs: [{
-                            test_run_uuid: this._tests[identifier].uuid,
+                            test_run_uuid: testMeta.uuid,
                             timestamp: new Date().toISOString(),
                             message: args.result.value,
                             kind: 'TEST_SCREENSHOT'
@@ -203,7 +243,7 @@ class InsightsHandler {
         const req = this._requestQueueHandler.add({
             event_type: 'LogCreated',
             logs: [{
-                    test_run_uuid: this._tests[identifier].uuid,
+                    test_run_uuid: testMeta.uuid,
                     timestamp: new Date().toISOString(),
                     kind: 'HTTP',
                     http_response: {
@@ -237,7 +277,8 @@ class InsightsHandler {
     getHierarchy(test) {
         const value = [];
         if (test.ctx && test.ctx.test) {
-            let parent = test.ctx.test.parent;
+            // If we already have the parent object, utilize it else get from context
+            let parent = typeof test.parent === 'object' ? test.parent : test.ctx.test.parent;
             while (parent && parent.title !== '') {
                 value.push(parent.title);
                 parent = parent.parent;
@@ -247,7 +288,7 @@ class InsightsHandler {
     }
     async sendTestRunEvent(test, eventType, results) {
         var _a;
-        const fullTitle = (0, util_1.getUniqueIdentifier)(test);
+        const fullTitle = (0, util_1.getUniqueIdentifier)(test, this._framework);
         const testMetaData = this._tests[fullTitle];
         const testData = {
             uuid: testMetaData.uuid,
@@ -260,8 +301,8 @@ class InsightsHandler {
             scope: fullTitle,
             scopes: this.getHierarchy(test),
             identifier: fullTitle,
-            file_name: test.file,
-            location: test.file,
+            file_name: test.file ? path_1.default.relative(process.cwd(), test.file) : undefined,
+            location: test.file ? path_1.default.relative(process.cwd(), test.file) : undefined,
             vc_filepath: (this._gitConfigPath && test.file) ? path_1.default.relative(this._gitConfigPath, test.file) : undefined,
             started_at: testMetaData.startedAt,
             finished_at: testMetaData.finishedAt,
@@ -287,13 +328,17 @@ class InsightsHandler {
                 testData.hooks = this._hooks[fullTitle];
             }
         }
-        if (eventType == 'TestRunStarted') {
+        if (eventType === 'TestRunStarted' || eventType === 'TestRunSkipped') {
             testData.integrations = {};
             if (this._browser && this._platformMeta) {
                 const provider = (0, util_1.getCloudProvider)(this._browser);
                 testData.integrations[provider] = this.getIntegrationsObject();
             }
         }
+        if (eventType === 'TestRunSkipped') {
+            testData.result = 'skipped';
+            eventType = 'TestRunFinished';
+        }
         const uploadData = {
             event_type: eventType,
         };
@@ -331,9 +376,9 @@ class InsightsHandler {
             scope: fullNameWithExamples,
             scopes: [(feature === null || feature === void 0 ? void 0 : feature.name) || ''],
             identifier: scenario === null || scenario === void 0 ? void 0 : scenario.name,
-            file_name: feature === null || feature === void 0 ? void 0 : feature.path,
+            file_name: feature && feature.path ? path_1.default.relative(process.cwd(), feature.path) : undefined,
+            location: feature && feature.path ? path_1.default.relative(process.cwd(), feature.path) : undefined,
             vc_filepath: (this._gitConfigPath && (feature === null || feature === void 0 ? void 0 : feature.path)) ? path_1.default.relative(this._gitConfigPath, feature === null || feature === void 0 ? void 0 : feature.path) : undefined,
-            location: feature === null || feature === void 0 ? void 0 : feature.path,
             framework: this._framework,
             result: 'pending',
             meta: {
@@ -400,7 +445,9 @@ class InsightsHandler {
         if ('pickle' in test) {
             return (0, util_1.getUniqueIdentifierForCucumber)(test);
         }
-        return (0, util_1.getUniqueIdentifier)(test);
+        return (0, util_1.getUniqueIdentifier)(test, this._framework);
     }
 }
+// https://github.com/microsoft/TypeScript/issues/6543
+const InsightsHandler = (0, util_1.o11yClassErrorHandler)(_InsightsHandler);
 exports.default = InsightsHandler;

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;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAIlE,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAMpF,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;IAQ5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IATnB,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;gBAGrB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAuDjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA2GtF,UAAU;IA2CV,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;IAoF3F,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;CAQtF"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAKlE,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAapF,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;IAQ5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IATnB,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;gBAGrB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAqEjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA2GtF,UAAU;IAsDV,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;IAoF3F,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;CAQtF"}

package/build/launcher.js

@@ -38,8 +38,10 @@ const BrowserstackLocalLauncher = __importStar(require("browserstack-local"));
 const logger_1 = __importDefault(require("@wdio/logger"));
 // @ts-ignore
 const package_json_1 = require("../package.json");
+const crash_reporter_1 = __importDefault(require("./crash-reporter"));
 const constants_1 = require("./constants");
 const util_2 = require("./util");
+const performance_tester_1 = __importDefault(require("./performance-tester"));
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class BrowserstackLauncherService {
     constructor(_options, capabilities, _config) {
@@ -51,12 +53,14 @@ class BrowserstackLauncherService {
             capabilities.forEach((capability) => {
                 var _a, _b;
                 if (!capability['bstack:options']) {
-                    const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
-                    if (extensionCaps.length) {
-                        capability['bstack:options'] = { wdioService: package_json_1.version };
-                    }
-                    else if ((0, util_2.shouldAddServiceVersion)(this._config, this._options.testObservability)) {
-                        capability['browserstack.wdioService'] = package_json_1.version;
+                    if ((0, util_2.isBStackSession)(this._config)) {
+                        const extensionCaps = Object.keys(capability).filter((cap) => cap.includes(':'));
+                        if (extensionCaps.length) {
+                            capability['bstack:options'] = { wdioService: package_json_1.version };
+                        }
+                        else if ((0, util_2.shouldAddServiceVersion)(this._config, this._options.testObservability)) {
+                            capability['browserstack.wdioService'] = package_json_1.version;
+                        }
                     }
                     this._buildIdentifier = (_a = capability['browserstack.buildIdentifier']) === null || _a === void 0 ? void 0 : _a.toString();
                     this._buildName = (_b = capability['build']) === null || _b === void 0 ? void 0 : _b.toString();
@@ -73,12 +77,14 @@ class BrowserstackLauncherService {
         else if (typeof capabilities === 'object') {
             Object.entries(capabilities).forEach(([, caps]) => {
                 if (!caps.capabilities['bstack:options']) {
-                    const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
-                    if (extensionCaps.length) {
-                        caps.capabilities['bstack:options'] = { wdioService: package_json_1.version };
-                    }
-                    else if ((0, util_2.shouldAddServiceVersion)(this._config, this._options.testObservability)) {
-                        caps.capabilities['browserstack.wdioService'] = package_json_1.version;
+                    if ((0, util_2.isBStackSession)(this._config)) {
+                        const extensionCaps = Object.keys(caps.capabilities).filter((cap) => cap.includes(':'));
+                        if (extensionCaps.length) {
+                            caps.capabilities['bstack:options'] = { wdioService: package_json_1.version };
+                        }
+                        else if ((0, util_2.shouldAddServiceVersion)(this._config, this._options.testObservability)) {
+                            caps.capabilities['browserstack.wdioService'] = package_json_1.version;
+                        }
                     }
                     this._buildIdentifier = caps.capabilities['browserstack.buildIdentifier'];
                 }
@@ -92,6 +98,9 @@ class BrowserstackLauncherService {
                 }
             });
         }
+        if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+            performance_tester_1.default.startMonitoring('performance-report-launcher.csv');
+        }
         // by default observability will be true unless specified as false
         this._options.testObservability = this._options.testObservability == false ? false : true;
         if (this._options.testObservability &&
@@ -99,6 +108,12 @@ class BrowserstackLauncherService {
             process.env.BROWSERSTACK_RERUN && process.env.BROWSERSTACK_RERUN_TESTS) {
             this._config.specs = process.env.BROWSERSTACK_RERUN_TESTS.split(',');
         }
+        try {
+            crash_reporter_1.default.setConfigDetails(this._config, capabilities, this._options);
+        }
+        catch (error) {
+            log.error(`[Crash_Report_Upload] Config processing failed due to ${error}`);
+        }
     }
     async onPrepare(config, capabilities) {
         /**
@@ -204,6 +219,15 @@ class BrowserstackLauncherService {
                 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.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+            await performance_tester_1.default.stopAndGenerate('performance-launcher.html');
+            performance_tester_1.default.calculateTimes(['launchTestSession', 'stopBuildUpstream']);
+            if (!process.env.START_TIME) {
+                return;
+            }
+            const duration = (new Date()).getTime() - (new Date(process.env.START_TIME)).getTime();
+            log.info(`Total duration is ${duration / 1000} s`);
+        }
         if (!this.browserstackLocal || !this.browserstackLocal.isRunning()) {
             return;
         }

package/build/performance-tester.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { PerformanceObserver } from 'perf_hooks';
+export default class PerformanceTester {
+    static _observer: PerformanceObserver;
+    static _csvWriter: any;
+    private static _events;
+    static started: boolean;
+    static startMonitoring(csvName?: string): void;
+    static getPerformance(): import("perf_hooks").Performance;
+    static calculateTimes(methods: string[]): number;
+    static stopAndGenerate(filename?: string): Promise<void>;
+    static generateReport(entries: any[]): string;
+    static generateCSV(entries: any[]): void;
+}
+//# sourceMappingURL=performance-tester.d.ts.map

package/build/performance-tester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance-tester.d.ts","sourceRoot":"","sources":["../src/performance-tester.ts"],"names":[],"mappings":";AAEA,OAAO,EAAe,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAM7D,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAClC,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAA;IACrC,MAAM,CAAC,UAAU,EAAE,GAAG,CAAA;IACtB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAyB;IAC/C,MAAM,CAAC,OAAO,UAAQ;IAEtB,MAAM,CAAC,eAAe,CAAC,OAAO,GAAE,MAAiC;IAiBjE,MAAM,CAAC,cAAc;IAIrB,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,GAAI,MAAM;WAepC,eAAe,CAAC,QAAQ,GAAE,MAA+B;IAoBtE,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE;IAWpC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE;CAuBpC"}

package/build/performance-tester.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const csv_writer_1 = require("csv-writer");
+const fs_1 = __importDefault(require("fs"));
+const perf_hooks_1 = require("perf_hooks");
+const logger_1 = __importDefault(require("@wdio/logger"));
+const util_1 = require("./util");
+const log = (0, logger_1.default)('@wdio/browserstack-service');
+class PerformanceTester {
+    static startMonitoring(csvName = 'performance-report.csv') {
+        this._observer = new perf_hooks_1.PerformanceObserver(list => {
+            list.getEntries().forEach(entry => {
+                this._events.push(entry);
+            });
+        });
+        this._observer.observe({ buffered: true, entryTypes: ['function'] });
+        this.started = true;
+        this._csvWriter = (0, csv_writer_1.createObjectCsvWriter)({
+            path: csvName,
+            header: [
+                { id: 'name', title: 'Function Name' },
+                { id: 'time', title: 'Execution Time (ms)' }
+            ]
+        });
+    }
+    static getPerformance() {
+        return perf_hooks_1.performance;
+    }
+    static calculateTimes(methods) {
+        const times = {};
+        this._events.map((entry) => {
+            if (!times[entry.name]) {
+                times[entry.name] = 0;
+            }
+            times[entry.name] += entry.duration;
+        });
+        const timeTaken = methods.reduce((a, c) => {
+            return times[c] + (a || 0);
+        }, 0);
+        log.info(`Time for ${methods} is `, timeTaken);
+        return timeTaken;
+    }
+    static async stopAndGenerate(filename = 'performance-own.html') {
+        if (!this.started)
+            return;
+        await (0, util_1.sleep)(2000); // Wait to 2s just to finish any running callbacks for timerify
+        this._observer.disconnect();
+        this.started = false;
+        this.generateCSV(this._events);
+        const content = this.generateReport(this._events);
+        const path = process.cwd() + '/' + filename;
+        fs_1.default.writeFile(path, content, err => {
+            if (err) {
+                log.error('Error in writing html', err);
+                return;
+            }
+            log.info('Performance report is at ', path);
+        });
+    }
+    static generateReport(entries) {
+        let html = '<!DOCTYPE html><html><head><title>Performance Report</title></head><body>';
+        html += '<h1>Performance Report</h1>';
+        html += '<table><thead><tr><th>Function Name</th><th>Duration (ms)</th></tr></thead><tbody>';
+        entries.forEach((entry) => {
+            html += `<tr><td>${entry.name}</td><td>${entry.duration}</td></tr>`;
+        });
+        html += '</tbody></table></body></html>';
+        return html;
+    }
+    static generateCSV(entries) {
+        const times = {};
+        entries.map((entry) => {
+            if (!times[entry.name]) {
+                times[entry.name] = 0;
+            }
+            times[entry.name] += entry.duration;
+            return {
+                name: entry.name,
+                time: entry.duration
+            };
+        });
+        const dat = Object.entries(times).map(([key, value]) => {
+            return {
+                name: key,
+                time: value
+            };
+        });
+        this._csvWriter.writeRecords(dat)
+            .then(() => log.info('Performance CSV report generated successfully'))
+            .catch((error) => console.error(error));
+    }
+}
+PerformanceTester._events = [];
+PerformanceTester.started = false;
+exports.default = PerformanceTester;

package/build/reporter.d.ts

@@ -1,13 +1,31 @@
-import WDIOReporter, { SuiteStats, TestStats, RunnerStats } from '@wdio/reporter';
-export default class TestReporter extends WDIOReporter {
+import WDIOReporter, { SuiteStats, TestStats, RunnerStats, HookStats } from '@wdio/reporter';
+import { TestMeta } from './types';
+declare class _TestReporter extends WDIOReporter {
     private _capabilities;
     private _config?;
     private _observability;
     private _sessionId?;
     private _suiteName?;
     private _requestQueueHandler;
-    onRunnerStart(runnerStats: RunnerStats): void;
+    private _suites;
+    private static _tests;
+    private _gitConfigPath?;
+    private _gitConfigured;
+    onRunnerStart(runnerStats: RunnerStats): Promise<void>;
+    configureGit(): Promise<void>;
+    static getTests(): Record<string, TestMeta>;
     onSuiteStart(suiteStats: SuiteStats): void;
+    onSuiteEnd(): void;
+    needToSendData(testType?: string, event?: string): boolean;
+    onTestEnd(testStats: TestStats): Promise<void>;
+    onTestStart(testStats: TestStats): Promise<void>;
+    onHookStart(hookStats: HookStats): Promise<void>;
+    onHookEnd(hookStats: HookStats): Promise<void>;
+    getHookIdentifier(hookStats: HookStats): string;
+    sendTestRunEvent(testStats: TestStats | HookStats, eventType: string): Promise<void>;
     onTestSkip(testStats: TestStats): Promise<void>;
 }
+declare const TestReporter: typeof _TestReporter;
+type TestReporter = _TestReporter;
+export default TestReporter;
 //# sourceMappingURL=reporter.d.ts.map

package/build/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAUjF,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;IAOvC,YAAY,CAAE,UAAU,EAAE,UAAU;IAI9B,UAAU,CAAE,SAAS,EAAE,SAAS;CAkDzC"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,YAAY,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAO5F,OAAO,EAAgC,QAAQ,EAAc,MAAM,SAAS,CAAA;AAa5E,cAAM,aAAc,SAAQ,YAAY;IACpC,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;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;IAEjC,aAAa,CAAE,WAAW,EAAE,WAAW;IAQvC,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;IAQ9B,WAAW,CAAC,SAAS,EAAE,SAAS;IAUhC,WAAW,CAAC,SAAS,EAAE,SAAS;IAchC,SAAS,CAAC,SAAS,EAAE,SAAS;IAYpC,iBAAiB,CAAC,SAAS,EAAE,SAAS;IAIhC,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAC,SAAS,EAAE,SAAS,EAAE,MAAM;IAkFlE,UAAU,CAAE,SAAS,EAAE,SAAS;CAQzC;AAED,QAAA,MAAM,YAAY,EAAE,OAAO,aAAoD,CAAA;AAC/E,KAAK,YAAY,GAAG,aAAa,CAAA;AACjC,eAAe,YAAY,CAAA"}