@wdio/browserstack-service 7.26.0 → 7.28.0

package/README.md

@@ -1,7 +1,7 @@
-WebdriverIO Browserstack Service
+WebdriverIO BrowserStack Service
 ==========
 
-> A WebdriverIO service that manages local tunnel and job metadata for Browserstack users.
+> A WebdriverIO service that manages local tunnel and job metadata for BrowserStack users.
 
 ## Installation
 
@@ -16,7 +16,7 @@ Instructions on how to install `WebdriverIO` can be found [here.](https://webdri
 
 ## Configuration
 
-WebdriverIO has Browserstack support out of the box. You should simply set `user` and `key` in your `wdio.conf.js` file. This service plugin provides supports for [Browserstack Tunnel](https://www.browserstack.com/automate/node#setting-local-tunnel). Set `browserstackLocal: true` also to activate this feature.
+WebdriverIO has BrowserStack support out of the box. You should set `user` and `key` in your `wdio.conf.js` file. This service plugin provides support for [BrowserStack](https://www.browserstack.com/automate/node#setting-local-tunnel) Tunnel](https://www.browserstack.com/automate/node#setting-local-tunnel). Set `browserstackLocal: true` also to activate this feature.
 Reporting of session status on BrowserStack will respect `strict` setting of Cucumber options.
 
 ```js
@@ -39,19 +39,13 @@ exports.config
 In order to authorize to the BrowserStack service your config needs to contain a [`user`](https://webdriver.io/docs/options#user) and [`key`](https://webdriver.io/docs/options#key) option.
 
 ### browserstackLocal
-Set this to true to enable routing connections from Browserstack cloud through your computer.
-
-Type: `Boolean`<br />
-Default: `false`
-
-### preferScenarioName
-Cucumber only. Set this to true to enable updating the session name to the Scenario name if only a single Scenario was ran. Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
+Set this to true to enable routing connections from BrowserStack cloud through your computer.
 
 Type: `Boolean`<br />
 Default: `false`
 
 ### forcedStop
-Set this to true to kill the browserstack process on complete, without waiting for the browserstack stop callback to be called. This is experimental and should not be used by all. Mostly necessary as a workaraound for [this issue](https://github.com/browserstack/browserstack-local-nodejs/issues/41).
+Set this to true to kill the BrowserStack Local process on complete, without waiting for the BrowserStack Local stop callback to be called. This is experimental and should not be used by all. Mostly necessary as a workaraound for [this issue](https://github.com/browserstack/browserstack-local-nodejs/issues/41).
 
 Type: `Boolean`<br />
 Default: `false`
@@ -141,8 +135,53 @@ services: [
 ]
 ```
 
+### preferScenarioName
+
+Cucumber only. Set the BrowserStack Automate session name to the Scenario name if only a single Scenario ran.
+Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
+
+Type: `Boolean`<br />
+Default: `false`
+
+### sessionNameFormat
+
+Customize the BrowserStack Automate session name format.
+
+Type: `Function`<br />
+Default (Cucumber/Jasmine): `(config, capabilities, suiteTitle) => suiteTitle`<br />
+Default (Mocha): `(config, capabilities, suiteTitle, testTitle) => suiteTitle + ' - ' + testTitle`
+
+### sessionNameOmitTestTitle
+
+Mocha only. Do not append the test title to the BrowserStack Automate session name.
+
+Type: `Boolean`<br />
+Default: `false`
+
+### sessionNamePrependTopLevelSuiteTitle
+
+Mocha only. Prepend the top level suite title to the BrowserStack Automate session name.
+
+Type: `Boolean`<br />
+Default: `false`
+
+### setSessionName
+
+Automatically set the BrowserStack Automate session name.
+
+Type: `Boolean`<br />
+Default: `true`
+
+### setSessionStatus
+
+Automatically set the BrowserStack Automate session status (passed/failed).
+
+Type: `Boolean`<br />
+Default: `true`
+
 ### opts
-Specified optional will be passed down to BrowserstackLocal.
+
+BrowserStack Local options.
 
 Type: `Object`<br />
 Default: `{}`
@@ -185,7 +224,7 @@ opts = { f: "/my/awesome/folder" };
 
 #### Force Start
 
-To kill other running Browserstack Local instances -
+To kill other running BrowserStack Local instances -
 
 ```js
 opts = { force: "true" };

package/build/constants.d.ts

@@ -1,3 +1,5 @@
+import type { BrowserstackConfig } from './types';
 export declare const BROWSER_DESCRIPTION: readonly ["device", "os", "osVersion", "os_version", "browserName", "browser", "browserVersion", "browser_version"];
 export declare const VALID_APP_EXTENSION: string[];
+export declare const DEFAULT_OPTIONS: Partial<BrowserstackConfig>;
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAGvD,CAAA"}

package/build/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
+exports.DEFAULT_OPTIONS = exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
 exports.BROWSER_DESCRIPTION = [
     'device',
     'os',
@@ -16,3 +16,7 @@ exports.VALID_APP_EXTENSION = [
     '.aab',
     '.ipa'
 ];
+exports.DEFAULT_OPTIONS = {
+    setSessionName: true,
+    setSessionStatus: true
+};

package/build/launcher.d.ts

@@ -2,7 +2,7 @@ import * as BrowserstackLocalLauncher from 'browserstack-local';
 import type { Capabilities, Services, Options } from '@wdio/types';
 import { App, AppConfig, AppUploadResponse } from './types';
 import { BrowserstackConfig } from './types';
-declare type BrowserstackLocal = BrowserstackLocalLauncher.Local & {
+type BrowserstackLocal = BrowserstackLocalLauncher.Local & {
     pid?: number;
     stop(callback: (err?: any) => void): void;
 };

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAClE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAI3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAK5C,aAAK,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":"AAQA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAClE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAI3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAK5C,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"}

package/build/service.d.ts

@@ -2,7 +2,6 @@ import type { Services, Capabilities, Options, Frameworks } from '@wdio/types';
 import type { Browser, MultiRemoteBrowser } from 'webdriverio';
 import { BrowserstackConfig, MultiRemoteAction } from './types';
 export default class BrowserstackService implements Services.ServiceInstance {
-    private _options;
     private _caps;
     private _config;
     private _sessionBaseUrl;
@@ -10,22 +9,39 @@ export default class BrowserstackService implements Services.ServiceInstance {
     private _scenariosThatRan;
     private _failureStatuses;
     private _browser?;
+    private _suiteTitle?;
     private _fullTitle?;
-    constructor(_options: BrowserstackConfig & Options.Testrunner, _caps: Capabilities.RemoteCapability, _config: Options.Testrunner);
+    private _options;
+    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;
+    before(caps: Capabilities.RemoteCapability, specs: string[], browser: Browser<'async'> | MultiRemoteBrowser<'async'>): Promise<void>;
     /**
-     * if no user and key is specified even though a browserstack service was
-     * provided set user and key with values so that the session request
-     * will fail
+     * Set the default job name at the suite level to make sure we account
+     * for the cases where there is a long running `before` function for a
+     * suite or one that can fail.
+     * Don't do this for Jasmine because `suite.title` is `Jasmine__TopLevel__Suite`
+     * and `suite.fullTitle` is `undefined`, so no alternative to use for the job name.
+     */
+    beforeSuite(suite: Frameworks.Suite): Promise<void>;
+    beforeTest(test: Frameworks.Test): Promise<void>;
+    /**
+     * For CucumberJS
      */
-    beforeSession(config: Options.Testrunner): void;
-    before(caps: Capabilities.RemoteCapability, specs: string[], browser: Browser<'async'> | MultiRemoteBrowser<'async'>): Promise<void>;
-    beforeSuite(suite: Frameworks.Suite): void;
     beforeFeature(uri: unknown, feature: {
         name: string;
-    }): Promise<any>;
+    }): 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<any>;
+    after(result: number): Promise<void>;
     /**
      * For CucumberJS
      */
@@ -36,5 +52,8 @@ export default class BrowserstackService implements Services.ServiceInstance {
     _multiRemoteAction(action: MultiRemoteAction): Promise<any>;
     _update(sessionId: string, requestBody: any): import("got").CancelableRequest<import("got").Response<string>>;
     _printSessionURL(): Promise<void>;
+    private _setSessionName;
+    private _setAnnotation;
+    private _executeCommand;
 }
 //# sourceMappingURL=service.d.ts.map

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,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,SAAS,CAAA;AAIhF,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IASpE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAVnB,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,UAAU,CAAC,CAAQ;gBAGf,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACjD,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAYvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F;;;;OAIG;IACH,aAAa,CAAE,MAAM,EAAE,OAAO,CAAC,UAAU;IAYzC,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,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAIpC,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAKrD,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAqB/E,KAAK,CAAE,MAAM,EAAE,MAAM;IAgBrB;;OAEG;IACH,aAAa,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAmBhC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IA2BzD,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;CAsBzB"}
+{"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,EAAE,kBAAkB,EAAE,iBAAiB,EAAmB,MAAM,SAAS,CAAA;AAKhF,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"}

package/build/service.js

@@ -6,18 +6,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = __importDefault(require("@wdio/logger"));
 const got_1 = __importDefault(require("got"));
 const util_1 = require("./util");
+const constants_1 = require("./constants");
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class BrowserstackService {
-    constructor(_options, _caps, _config) {
-        this._options = _options;
+    constructor(options, _caps, _config) {
         this._caps = _caps;
         this._config = _config;
         this._sessionBaseUrl = 'https://api.browserstack.com/automate/sessions';
         this._failReasons = [];
         this._scenariosThatRan = [];
         this._failureStatuses = ['failed', 'ambiguous', 'undefined', 'unknown'];
+        this._options = { ...constants_1.DEFAULT_OPTIONS, ...options };
         // added to maintain backward compatibility with webdriverIO v5
-        this._config || (this._config = _options);
+        this._config || (this._config = this._options);
         // 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
@@ -32,12 +33,10 @@ class BrowserstackService {
         }
         return fn(this._caps);
     }
-    /**
-     * if no user and key is specified even though a browserstack service was
-     * provided set user and key with values so that the session request
-     * will fail
-     */
     beforeSession(config) {
+        // if no user and key is specified even though a browserstack service was
+        // provided set user and key with values so that the session request
+        // will fail
         if (!config.user) {
             config.user = 'NotSetUser';
         }
@@ -57,45 +56,80 @@ class BrowserstackService {
         this._scenariosThatRan = [];
         return this._printSessionURL();
     }
-    beforeSuite(suite) {
-        this._fullTitle = suite.title;
-    }
-    beforeFeature(uri, feature) {
-        this._fullTitle = feature.name;
-        return this._updateJob({ name: this._fullTitle });
+    /**
+     * Set the default job name at the suite level to make sure we account
+     * for the cases where there is a long running `before` function for a
+     * suite or one that can fail.
+     * Don't do this for Jasmine because `suite.title` is `Jasmine__TopLevel__Suite`
+     * and `suite.fullTitle` is `undefined`, so no alternative to use for the job name.
+     */
+    async beforeSuite(suite) {
+        this._suiteTitle = suite.title;
+        if (suite.title && suite.title !== 'Jasmine__TopLevel__Suite') {
+            await this._setSessionName(suite.title);
+        }
     }
-    afterTest(test, context, results) {
-        const { error, passed } = results;
-        // Jasmine
+    async beforeTest(test) {
+        var _a;
+        let suiteTitle = this._suiteTitle;
         if (test.fullName) {
+            // For Jasmine, `suite.title` is `Jasmine__TopLevel__Suite`.
+            // This tweak allows us to set the real suite name.
             const testSuiteName = test.fullName.slice(0, test.fullName.indexOf(test.description || '') - 1);
-            if (this._fullTitle === 'Jasmine__TopLevel__Suite') {
-                this._fullTitle = testSuiteName;
+            if (this._suiteTitle === 'Jasmine__TopLevel__Suite') {
+                suiteTitle = testSuiteName;
             }
-            else if (this._fullTitle) {
-                this._fullTitle = (0, util_1.getParentSuiteName)(this._fullTitle, testSuiteName);
+            else if (this._suiteTitle) {
+                suiteTitle = (0, util_1.getParentSuiteName)(this._suiteTitle, testSuiteName);
             }
         }
-        else {
-            // Mocha
-            this._fullTitle = `${test.parent} - ${test.title}`;
-        }
+        await this._setSessionName(suiteTitle, test);
+        await this._setAnnotation(`Test: ${(_a = test.fullName) !== null && _a !== void 0 ? _a : test.title}`);
+    }
+    /**
+     * 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) {
+        const { error, passed } = results;
         if (!passed) {
             this._failReasons.push((error && error.message) || 'Unknown Error');
         }
     }
-    after(result) {
+    async after(result) {
+        const { preferScenarioName, setSessionName, setSessionStatus } = this._options;
         // For Cucumber: Checks scenarios that ran (i.e. not skipped) on the session
         // Only 1 Scenario ran and option enabled => Redefine session name to Scenario's name
-        if (this._options.preferScenarioName && this._scenariosThatRan.length === 1) {
+        if (preferScenarioName && this._scenariosThatRan.length === 1) {
             this._fullTitle = this._scenariosThatRan.pop();
         }
-        const hasReasons = Boolean(this._failReasons.filter(Boolean).length);
-        return this._updateJob({
-            status: result === 0 ? 'passed' : 'failed',
-            name: this._fullTitle,
-            reason: hasReasons ? this._failReasons.join('\n') : undefined
-        });
+        if (setSessionStatus) {
+            const hasReasons = this._failReasons.length > 0;
+            await this._updateJob({
+                status: result === 0 ? 'passed' : 'failed',
+                ...(setSessionName ? { name: this._fullTitle } : {}),
+                ...(hasReasons ? { reason: this._failReasons.join('\n') } : {})
+            });
+        }
     }
     /**
      * For CucumberJS
@@ -118,8 +152,9 @@ class BrowserstackService {
         if (!this._browser) {
             return Promise.resolve();
         }
-        const hasReasons = Boolean(this._failReasons.filter(Boolean).length);
-        let status = hasReasons ? 'failed' : 'passed';
+        const { setSessionName, setSessionStatus } = this._options;
+        const hasReasons = this._failReasons.length > 0;
+        const status = hasReasons ? 'failed' : 'passed';
         if (!this._browser.isMultiremote) {
             log.info(`Update (reloaded) job with sessionId ${oldSessionId}, ${status}`);
         }
@@ -127,12 +162,15 @@ class BrowserstackService {
             const browserName = this._browser.instances.filter((browserName) => this._browser && this._browser[browserName].sessionId === newSessionId)[0];
             log.info(`Update (reloaded) multiremote job for browser "${browserName}" and sessionId ${oldSessionId}, ${status}`);
         }
-        await this._update(oldSessionId, {
-            name: this._fullTitle,
-            status,
-            reason: hasReasons ? this._failReasons.join('\n') : undefined
-        });
+        if (setSessionStatus) {
+            await this._update(oldSessionId, {
+                status,
+                ...(setSessionName ? { name: this._fullTitle } : {}),
+                ...(hasReasons ? { reason: this._failReasons.join('\n') } : {})
+            });
+        }
         this._scenariosThatRan = [];
+        delete this._suiteTitle;
         delete this._fullTitle;
         this._failReasons = [];
         await this._printSessionURL();
@@ -160,7 +198,7 @@ class BrowserstackService {
             return action(_browser.sessionId);
         }
         return Promise.all(_browser.instances
-            .filter(browserName => {
+            .filter((browserName) => {
             const cap = (0, util_1.getBrowserCapabilities)(_browser, this._caps, browserName);
             return (0, util_1.isBrowserstackCapability)(cap);
         })
@@ -195,5 +233,42 @@ class BrowserstackService {
             log.info(`${browserString} session: ${response.body.automation_session.browser_url}`);
         });
     }
+    async _setSessionName(suiteTitle, test) {
+        if (!this._options.setSessionName || !suiteTitle) {
+            return;
+        }
+        let name = suiteTitle;
+        if (this._options.sessionNameFormat) {
+            name = this._options.sessionNameFormat(this._config, this._caps, suiteTitle, test === null || test === void 0 ? void 0 : test.title);
+        }
+        else if (test && !test.fullName) {
+            // Mocha
+            const pre = this._options.sessionNamePrependTopLevelSuiteTitle ? `${suiteTitle} - ` : '';
+            const post = !this._options.sessionNameOmitTestTitle ? ` - ${test.title}` : '';
+            name = `${pre}${test.parent}${post}`;
+        }
+        if (name !== this._fullTitle) {
+            this._fullTitle = name;
+            await this._updateJob({ name });
+        }
+    }
+    _setAnnotation(data) {
+        return this._executeCommand('annotate', { data, level: 'info' });
+    }
+    async _executeCommand(action, args) {
+        if (!this._browser) {
+            return Promise.resolve();
+        }
+        const cmd = { action, ...(args ? { arguments: args } : {}) };
+        const script = `browserstack_executor: ${JSON.stringify(cmd)}`;
+        if (this._browser.isMultiremote) {
+            const multiRemoteBrowser = this._browser;
+            return Promise.all(Object.keys(this._caps).map(async (browserName) => {
+                const browser = multiRemoteBrowser[browserName];
+                return (await browser.execute(script));
+            }));
+        }
+        return (await this._browser.execute(script));
+    }
 }
 exports.default = BrowserstackService;

package/build/types.d.ts

@@ -1,10 +1,11 @@
+import type { Capabilities, Options } from '@wdio/types';
 export interface SessionResponse {
     automation_session: {
         browser_url: string;
     };
 }
-export declare type MultiRemoteAction = (sessionId: string, browserName?: string) => Promise<any>;
-export declare type AppConfig = {
+export type MultiRemoteAction = (sessionId: string, browserName?: string) => Promise<any>;
+export type AppConfig = {
     id?: string;
     path?: string;
     custom_id?: string;
@@ -20,30 +21,29 @@ export interface App {
     customId?: string;
 }
 export interface BrowserstackConfig {
-    /**
-     * Set this to true to enable routing connections from Browserstack cloud through your computer.
-     * You will also need to set `browserstack.local` to true in browser capabilities.
-     */
-    browserstackLocal?: boolean;
     /**
      * Set this with app file path present locally on your device or
-     * app hashed id returned after uploading app to Browserstack or
+     * app hashed id returned after uploading app to BrowserStack or
      * custom_id, sharable_id of the uploaded app
+     * @default undefined
      */
     app?: string | AppConfig;
     /**
-     * Cucumber only. Set this to true to enable updating the session name to the Scenario name if only
-     * a single Scenario was ran. Useful when running in parallel
-     * with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
+     * Enable routing connections from BrowserStack cloud through your computer.
+     * You will also need to set `browserstack.local` to true in browser capabilities.
+     * @default false
      */
-    preferScenarioName?: boolean;
+    browserstackLocal?: boolean;
     /**
-     * Set this to true to kill the browserstack process on complete, without waiting for the
-     * browserstack stop callback to be called. This is experimental and should not be used by all.
+     * Kill the BrowserStack Local process on complete, without waiting for the
+     * BrowserStack Local stop callback to be called.
+     *
+     * __This is experimental and should not be used by all.__
+     * @default false
      */
     forcedStop?: boolean;
     /**
-     * Specified optional will be passed down to BrowserstackLocal. For more details check out the
+     * BrowserStack Local options. For more details check out the
      * [`browserstack-local`](https://www.npmjs.com/package/browserstack-local#arguments) docs.
      *
      * @example
@@ -52,7 +52,39 @@ export interface BrowserstackConfig {
      *   localIdentifier: 'some-identifier'
      * }
      * ```
+     * @default {}
      */
     opts?: Partial<import('browserstack-local').Options>;
+    /**
+     * Cucumber only. Set the BrowserStack Automate session name to the Scenario name if only a single Scenario ran.
+     * Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
+     * @default false
+     */
+    preferScenarioName?: boolean;
+    /**
+     * Customize the BrowserStack Automate session name format.
+     * @default undefined
+     */
+    sessionNameFormat?: (config: Options.Testrunner, capabilities: Capabilities.RemoteCapability, suiteTitle: string, testTitle?: string) => string;
+    /**
+     * Mocha only. Do not append the test title to the BrowserStack Automate session name.
+     * @default false
+     */
+    sessionNameOmitTestTitle?: boolean;
+    /**
+     * Mocha only. Prepend the top level suite title to the BrowserStack Automate session name.
+     * @default false
+     */
+    sessionNamePrependTopLevelSuiteTitle?: boolean;
+    /**
+     * Automatically set the BrowserStack Automate session name.
+     * @default true
+     */
+    setSessionName?: boolean;
+    /**
+     * Automatically set the BrowserStack Automate session status (passed/failed).
+     * @default true
+     */
+    setSessionStatus?: boolean;
 }
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,oBAAY,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,oBAAY,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAAA;CACvD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,MAAM,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAAA;IACpD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAChB,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,KACjB,MAAM,CAAA;IACX;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "7.26.0",
+  "version": "7.28.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "Adam Bjerstedt <abjerstedt@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service",
@@ -29,7 +29,7 @@
     "browserstack-local": "^1.4.5",
     "form-data": "^4.0.0",
     "got": "^11.0.2",
-    "webdriverio": "7.26.0"
+    "webdriverio": "7.28.0"
   },
   "peerDependencies": {
     "@wdio/cli": "^5.0.0 || ^6.0.0 || ^7.0.0"
@@ -38,5 +38,5 @@
     "access": "public"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "573927a79dc0a2b9d9a9e19e7d1b8c1ff9fac308"
+  "gitHead": "09be73a21a3241d65c92269ff2ca7cec2d49b5fc"
 }