@wdio/browserstack-service 9.36.2 → 9.39.0

package/build/insights-handler.d.ts

@@ -93,7 +93,7 @@ declare class _InsightsHandler {
     private getIntegrationsObject;
     private getIdentifier;
     setGitConfigPath(): Promise<void>;
-    setTestData(test: Frameworks.Test, uuid: string): void;
+    setTestData(test: Frameworks.Test | ITestCaseHookParameter, uuid: string): void;
 }
 declare const InsightsHandler: typeof _InsightsHandler;
 type InsightsHandler = _InsightsHandler;

package/build/service.d.ts

@@ -64,6 +64,18 @@ export default class BrowserstackService implements Services.ServiceInstance {
     beforeSuite(suite: Frameworks.Suite): Promise<void>;
     beforeHook(test: Frameworks.Test | CucumberHook, context: unknown): Promise<void>;
     afterHook(test: Frameworks.Test | CucumberHook, context: unknown, result: Frameworks.TestResult): Promise<void>;
+    /**
+     * Cucumber abandons the whole feature when a `BeforeAll` throws, so every scenario in it
+     * (Rule-nested included) is reported SKIPPED rather than vanishing. Ports
+     * `insights-handler.processCucumberHook`, whose cascade publishes over the legacy HTTP
+     * listener and is inert once the binary is up.
+     *
+     * Sent straight to TestHub rather than via `framework.trackEvent()`: legacy called
+     * `listener.testFinished()` directly, so routing these through the observers would rename the
+     * session, stop accessibility and run a Percy teardown per skipped row — none of which legacy
+     * does.
+     */
+    private _reportCucumberScenariosSkipped;
     beforeTest(test: Frameworks.Test): Promise<void>;
     afterTest(originalTest: Frameworks.Test, context: never, results: Frameworks.TestResult): Promise<void>;
     /**
@@ -93,6 +105,32 @@ export default class BrowserstackService implements Services.ServiceInstance {
      * For CucumberJS
      */
     beforeFeature(uri: string, feature: Feature): Promise<void>;
+    /**
+     * The CLI test framework, only when it is the cucumber one and the CLI is actually running.
+     * Returns null on the legacy flow and on any startup race, so every call site degrades to the
+     * classic handlers instead of throwing inside an awaited WDIO hook.
+     */
+    private _cliCucumberFramework;
+    /**
+     * A `Frameworks.Test`-shaped view of a scenario, for the cli/modules that read `args.test`.
+     *
+     * `fullName` is set deliberately. automateModule's session naming is SHAPE-keyed
+     * (`else if (test && !test.fullName)`), so leaving it unset drops the scenario into the mocha
+     * arm and names the session `<feature> - <scenario>`; legacy names the session after the
+     * feature alone, which is what the populated `fullName` preserves.
+     */
+    private _cucumberTestView;
+    /**
+     * A `Frameworks.TestResult`-shaped view of a scenario result, for automateModule's
+     * session-status marking.
+     *
+     * Which statuses count as a session failure is `_failureStatuses`, NOT the passed/failed
+     * collapse the o11y result applies: cucumber's UNDEFINED / AMBIGUOUS / UNKNOWN fail the
+     * session on legacy while still being reported to Observability as `skipped`, and PENDING
+     * joins them only under `cucumberOpts.strict`. Reading the o11y collapse here instead marked
+     * a feature with an undefined step `passed` where legacy marks it `failed`.
+     */
+    private _cucumberTestResult;
     /**
      * Runs before a Cucumber Scenario.
      * @param world world object containing information on pickle and test step

package/build/util.d.ts

@@ -272,6 +272,13 @@ export declare function createDir(dir: string): void;
 export declare function isWritable(dirPath: string): boolean;
 export declare function setReadWriteAccess(dirPath: string): void;
 export declare function getMochaTestHierarchy(test: Frameworks.Test): string[];
+/**
+ * Mocha and Jasmine have no tag construct, so `@tag` tokens written into the suite and
+ * test titles are the tag source. The leading `@` is kept so these match the pickle tags
+ * the Cucumber path in this service already forwards; note the node SDK strips it for
+ * Jest/Playwright, so the two SDKs emit different shapes for the same logical tag.
+ */
+export declare function getTestTags(test: Frameworks.Test, scopes?: string[]): string[];
 /**
  * True only for the hub-interpreted `browserstack_executor: {…}` magic string.
  * Anchored to the start (leading whitespace tolerated) and case-sensitive, matching

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "9.36.2",
+  "version": "9.39.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "BrowserStack <support@browserstack.com>",
   "homepage": "https://github.com/browserstack/wdio-browserstack-service",
@@ -58,7 +58,11 @@
     "@grpc/grpc-js": "~1.13.5",
     "@percy/appium-app": "^2.0.9",
     "@percy/selenium-webdriver": "^2.2.2",
+    "@percy/webdriverio": ">=3.3.0 <3.3.3",
     "@types/gitconfiglocal": "^2.0.1",
+    "@wdio/logger": "^9.0.0",
+    "@wdio/reporter": "^9.0.0",
+    "@wdio/types": "^9.0.0",
     "browserstack-local": "^1.5.1",
     "chalk": "^5.3.0",
     "csv-writer": "^1.6.0",
@@ -68,12 +72,9 @@
     "tar": "^7.5.11",
     "undici": "^6.24.0",
     "uuid": "^11.1.0",
+    "webdriverio": "^9.0.0",
     "winston-transport": "^4.5.0",
-    "yauzl": "^3.4.0",
-    "@wdio/logger": "^9.0.0",
-    "@wdio/reporter": "^9.0.0",
-    "@wdio/types": "^9.0.0",
-    "webdriverio": "^9.0.0"
+    "yauzl": "^3.4.0"
   },
   "peerDependencies": {
     "@wdio/cli": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0"

package/src/proto/browserstack/sdk/v1/sdk-messages.proto

@@ -157,6 +157,24 @@ message StopBinSessionResponse {
     optional string error = 2;
     optional string automate_buildlink = 3;
     optional string hashed_id = 4;
+    // End-of-build customer-visible summary entries. Populated on EVERY response
+    // shape — success, error, and clean-build alike (empty when nothing to
+    // surface). Iterate by `severity` + `body`; do not branch on `entry_type`,
+    // so new entry types need no SDK change.
+    repeated CustomerVisibleSummaryEntry entries = 5;
+}
+
+// A single customer-visible summary entry surfaced at end of build via
+// StopBinSessionResponse.entries. The binary owns the prose so all SDKs render
+// consistent text; SDKs choose the output stream from `severity`.
+message CustomerVisibleSummaryEntry {
+    // Stable machine-readable identifier (e.g. "network_restrictions").
+    string entry_type = 1;
+    // One of: "info" | "warn" | "error".
+    string severity = 2;
+    // Pre-formatted block to display verbatim. May contain embedded newlines.
+    string body = 3;
+    optional string doc_link = 4;
 }
 
 message ConnectBinSessionRequest {