@wdio/browserstack-service 9.33.1 → 9.34.0

package/build/insights-handler.d.ts

@@ -46,9 +46,10 @@ declare class _InsightsHandler {
      * test/hook so the backend closes the entity instead of leaving it in_progress and
      * letting the build watchdog inflate the duration.
      *
-     * Scoped to mocha. Cucumber hooks are keyed differently (getCucumberHookUniqueId) and
-     * their lifecycle differs, so they are intentionally left out here — closing them safely
-     * would need cucumber-specific keying and is a known gap for a follow-up.
+     * Covers mocha and cucumber. Cucumber entries are keyed by hook-definition id / scenario
+     * unique id rather than title, but both stash kind + identity at start time, so the same
+     * kind-tag scan closes them (SDK-7167: an AFTER_EACH hook whose finish was never emitted
+     * held the hook open until the backend's 2h hook timeout, inflating the build duration).
      *
      * Each entry was tagged with kind at start time so we emit HookRunFinished for hooks and
      * TestRunFinished for tests without re-deriving the kind from the title. Entries without a

package/build/types.d.ts

@@ -91,6 +91,22 @@ export interface BrowserstackConfig {
      * Currently supports testPlanId.
      */
     testManagementOptions?: TestManagementOptions;
+    /**
+     * By default the service uploads its own debug logs, your `package.json` and a copy of
+     * your wdio config file at the end of a run, so BrowserStack support can debug issues
+     * without asking you to reproduce them.
+     *
+     * Values under known credential keys are removed before upload on a best-effort basis:
+     * BrowserStack credentials, common third-party secret names (`clientSecret`,
+     * `AWS_SECRET_ACCESS_KEY`, …), inline PEM blocks and basic-auth URLs. It is key-name
+     * driven, so a secret stored under an unrecognised name can still be included — if your
+     * config holds secrets you would rather not send, set this to true.
+     *
+     * Set this to true to disable that upload entirely.
+     * Can also be set with the `BROWSERSTACK_DISABLE_AUTO_CAPTURE_LOGS=true` env var.
+     * @default false
+     */
+    disableAutoCaptureLogs?: boolean;
     /**
      * Set this to true to enable BrowserStack Percy which will take screenshots
      * and snapshots for your tests run on Browserstack

package/build/util.d.ts

@@ -99,6 +99,15 @@ export declare const getA11yResults: (...args: (object | boolean | undefined | n
 export declare const getAppA11yResults: (...args: (object | boolean | undefined | null | string)[]) => any;
 export declare const getAppA11yResultsSummary: (...args: (object | boolean | undefined | null | string)[]) => any;
 export declare const getA11yResultsSummary: (...args: (object | boolean | undefined | null | string)[]) => any;
+/**
+ * Render an error together with its `cause` chain.
+ *
+ * Node's native fetch reports every transport failure as the same opaque
+ * `TypeError: fetch failed`; the actionable detail (ENOTFOUND, ECONNRESET, a proxy
+ * refusal) only lives on `error.cause`, which plain interpolation drops. Without this
+ * a failed build-stop is indistinguishable from any other network fault in the logs.
+ */
+export declare const describeErrorWithCause: (error: unknown, depth?: number) => string;
 export declare const stopBuildUpstream: (...args: (object | boolean | undefined | null | string)[]) => any;
 export declare function getCiInfo(): {
     name: string;
@@ -191,7 +200,11 @@ export declare function getFailureObject(error: string | Error): {
     failure_type: string | null;
 };
 export declare const sleep: (ms?: number) => Promise<unknown>;
-export declare function uploadLogs(user: string | undefined, key: string | undefined, clientBuildUuid: string): Promise<any>;
+export interface UploadLogsOptions {
+    disableAutoCaptureLogs?: boolean;
+    config?: Options.Testrunner;
+}
+export declare function uploadLogs(user: string | undefined, key: string | undefined, clientBuildUuid: string, options?: UploadLogsOptions): Promise<any>;
 export declare const isObject: (object: unknown) => boolean;
 export declare const ObjectsAreEqual: (object1: object, object2: object) => boolean;
 export declare const getPlatformVersion: (...args: unknown[]) => any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "9.33.1",
+  "version": "9.34.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "BrowserStack <support@browserstack.com>",
   "homepage": "https://github.com/browserstack/wdio-browserstack-service",