@wdio/browserstack-service 9.33.2 → 9.34.1

package/build/cli/cliUtils.d.ts

@@ -23,7 +23,20 @@ export declare class CLIUtils {
     static isBinaryBusy(binaryPath: string): boolean;
     static requestToUpdateCLI: (queryParams: Record<string, string>, config: Options.Testrunner) => Promise<any>;
     static runShellCommand(cmdCommand: string, workingDir?: string): Promise<string>;
-    static downloadLatestBinary: (binDownloadUrl: string, cliDir: string) => Promise<string | null>;
+    /**
+     * Version encoded in a binary download URL, e.g.
+     * `.../binary-macos-arm64-1.48.0.zip` -> `1.48.0`. Null when the URL does
+     * not carry one (custom BROWSERSTACK_BINARY_URL).
+     */
+    static getVersionFromBinaryUrl(binDownloadUrl: string): string | null;
+    /**
+     * Whether the binary on disk is already the version we were asked to fetch.
+     * A peer worker winning the download race leaves the *target* version here;
+     * a merely-pre-existing binary is stale. Only the former may short-circuit
+     * the download — see `downloadLatestBinary`.
+     */
+    static isBinaryAtVersion(binaryPath: string, expectedVersion: string | null): Promise<boolean>;
+    static downloadLatestBinary: (binDownloadUrl: string, cliDir: string, expectedVersion?: string | null) => Promise<string | null>;
     static downloadFileStream(downloadedFileStream: fs.WriteStream, zipFilePath: string, cliDir: string, resolve: (path: string) => void, reject: (reason?: Error) => void): void;
     static getTestFrameworkDetail(): any;
     static getAutomationFrameworkDetail(): any;

package/build/cli/modules/automateModule.d.ts

@@ -12,6 +12,11 @@ export default class AutomateModule extends BaseModule {
     constructor(browserStackConfig: Options.Testrunner);
     getModuleName(): string;
     onBeforeTest(args: Record<string, unknown>): Promise<void>;
+    /**
+     * PUT the session's current name if it has not already been applied.
+     * De-duped via `appliedName` so the onAfterExecute sweep does not re-send it.
+     */
+    private flushSessionName;
     onAfterTest(args: Record<string, unknown>): Promise<void>;
     onAfterExecute(): Promise<void>;
     private isAppAutomate;

package/build/cli/modules/testHubModule.d.ts

@@ -43,7 +43,7 @@ export default class TestHubModule extends BaseModule {
     sendTestFrameworkEvent(args: Record<string, unknown>, stateOverride?: {
         testFrameworkState: string;
         testHookState: string;
-    }): Promise<void>;
+    }): Promise<boolean>;
     /**
      * Send test session event to the service
      * @param args containing test session data

package/build/configCapture.d.ts

@@ -0,0 +1,117 @@
+import type { Options } from '@wdio/types';
+export interface CapturedFile {
+    name: string;
+    sourcePath: string;
+    content: string;
+}
+export interface ConfigPathResolution {
+    configPath?: string;
+    strategy?: string;
+    reason?: string;
+}
+/**
+ * cwd-relative form of a FILE path, for anything that gets uploaded.
+ *
+ * The basename fallback is safe here only because `path.relative` is never empty for a file —
+ * a file is never equal to cwd. Do NOT pass a directory: see `relativeDirToCwd`.
+ */
+export declare const relativeToCwd: (filePath: string) => string;
+/**
+ * cwd-relative form of a DIRECTORY path.
+ *
+ * `path.relative(cwd, cwd)` is `''`, which is the COMMON case here (a manifest at the project
+ * root), so a basename fallback would report the folder name — and for a project checked out
+ * directly in `$HOME` that folder name is the OS username, which is the exact exposure the
+ * relative-path handling exists to prevent. Empty means "cwd", so render it as `.`.
+ */
+export declare const relativeDirToCwd: (dir: string) => string;
+/**
+ * Resolve the absolute path of the user's wdio config file.
+ *
+ * WDIO keeps the real path in `ConfigParser`'s private `#configFilePath`, which no service can
+ * reach, so this reconstructs it from the values the CLI does leave on the merged config —
+ * mirroring how `@wdio/cli` itself resolves it. The CLI never searches: it takes one candidate
+ * and probes one stem across the supported extensions, so neither does this.
+ *
+ *   1. BROWSERSTACK_WDIO_CONFIG_FILE_PATH  — explicit override / support escape hatch
+ *   2. config['config-path']               — yargs' kebab alias of the `run <configPath>`
+ *                                            positional (v8 and v9 alike)
+ *   3. config._[0]                         — the bare `wdio <config>` form, which `run.ts`
+ *                                            itself resolves from `params._[0]`
+ *   4. rootDir + wdio.conf.<ext>           — no-arg `wdio`, and programmatic `new Launcher()`
+ *   5. cwd + wdio.conf.<ext>               — when the user overrides `rootDir` in their config
+ *
+ * `config._` is read rather than raw `process.argv`: it is the same positional AFTER yargs has
+ * applied wdio's own option declarations. Scanning argv means re-implementing that with a
+ * heuristic that cannot know which flags are boolean — and `wdio --watch ./a.conf.ts` puts the
+ * real config in `_[0]` while any "skip a flag's value" rule throws it away.
+ */
+export declare function resolveWdioConfigPath(config?: Options.Testrunner): ConfigPathResolution;
+/**
+ * Resolve once, as early as possible, and publish the answer on the environment so the
+ * upload path (and any worker) reads the SAME value instead of re-deriving it from cwd.
+ *
+ * Re-resolving at archive time is precisely the bug SDK-5993 fixed in the Node SDK: the
+ * archive step read `cwd/browserstack.yml` while startup had resolved a different path,
+ * silently dropping the config for every monorepo / subdir CI run.
+ */
+export declare function initWdioConfigPath(config?: Options.Testrunner): ConfigPathResolution;
+/**
+ * Opt-out for auto-captured logs. Service option first, env var as the CI escape hatch
+ * (customers cannot always edit a committed config). Name matches the Node SDK's
+ * `disableAutoCaptureLogs` so the flag means the same thing across BrowserStack SDKs.
+ */
+export declare function isAutoCaptureLogsDisabled(options?: {
+    disableAutoCaptureLogs?: boolean;
+}): boolean;
+/**
+ * Mirror the service option onto the environment so the opt-out survives into the
+ * DETACHED cleanup process, which gets no options object.
+ *
+ * Without this the opt-out is worse than useless: skipping the upload leaves
+ * `logsUploaded` false, which is exactly the condition that arms the exit-time
+ * `--uploadLogs` rescue — so every opted-out run had its config read and POSTed by the
+ * cleanup child. Returns whether auto-capture is disabled.
+ */
+export declare function publishAutoCaptureDisabled(options?: {
+    disableAutoCaptureLogs?: boolean;
+}): boolean;
+/**
+ * Line-level credential scrub, ported from the Node SDK's `redactSensitiveContent`.
+ *
+ * Any line mentioning a sensitive key collapses to `<key>: [REDACTED]`. Word boundaries
+ * keep `hotkey` / `keyword` from tripping the bare `key` entry that WDIO's top-level
+ * credential options force us to carry. `.` is intentionally NOT part of the boundary
+ * class so `bstackOptions.accessKey = '...'` still matches.
+ */
+export declare function redactSensitiveContent(text: string): string;
+/**
+ * Give every archive entry a unique name. Two configs can share a basename
+ * (`configs/wdio.conf.ts` + `shared/wdio.conf.ts`); without this the second silently
+ * overwrites the first, since archive entries are keyed by basename.
+ *
+ * Shared with `uploadLogs`, which de-dupes the copied log files against these entries —
+ * one implementation so the two can never disagree.
+ */
+export declare function dedupeEntryName(filePath: string, taken: Set<string>): string;
+/**
+ * Build the redacted config entries added to the auto-captured log archive.
+ *
+ * Best effort by contract: any failure returns what was gathered so far and a reason
+ * string for the SDK_UPLOAD_LOGS event. It must never throw — a debug artifact is never
+ * worth failing a customer's test run over.
+ */
+export declare function collectConfigFilesForUpload(config?: Options.Testrunner): {
+    files: CapturedFile[];
+    failures: string[];
+    strategy?: string;
+};
+/**
+ * `package.json` for the project the config belongs to — framework and service versions
+ * are the first thing triage needs, and the archive carried neither before.
+ *
+ * Walks UP from the config's directory, because `configs/wdio.conf.ts` (a very common
+ * layout) puts the manifest one or more levels above the config, not beside it.
+ * Archived verbatim: it is a manifest, not a secret store.
+ */
+export declare function findPackageJsonForUpload(): string | undefined;

package/build/constants.d.ts

@@ -23,6 +23,40 @@ export declare const CLI_DEBUG_LOGS_FILE = "log/sdk-cli-debug.log";
 export declare const UPLOAD_LOGS_ADDRESS = "https://upload-observability.browserstack.com";
 export declare const UPLOAD_LOGS_ENDPOINT = "client-logs/upload";
 export declare const PERCY_LOGS_FILE = "logs/percy.log";
+/**
+ * Auto-capture of the user's wdio config file (SDK-7250).
+ */
+export declare const AUTOLOGCAPTURE_NOTIFICATION = "Your wdio config file, the local config files it imports and package.json are captured with the debug logs at the end of the run, with values under known credential keys removed. To disable, set disableAutoCaptureLogs: true in the browserstack service options.";
+export declare const BROWSERSTACK_WDIO_CONFIG_FILE_PATH = "BROWSERSTACK_WDIO_CONFIG_FILE_PATH";
+export declare const BROWSERSTACK_DISABLE_AUTO_CAPTURE_LOGS = "BROWSERSTACK_DISABLE_AUTO_CAPTURE_LOGS";
+export declare const BROWSERSTACK_WDIO_CONFIG_STRATEGY = "BROWSERSTACK_WDIO_CONFIG_STRATEGY";
+export declare const SUPPORTED_WDIO_CONFIG_EXTENSIONS: string[];
+export declare const DEFAULT_WDIO_CONFIG_BASENAME = "wdio.conf";
+export declare const WDIO_CLI_SUBCOMMANDS: string[];
+export declare const MAX_CAPTURED_CONFIG_FILE_BYTES: number;
+export declare const MAX_CAPTURED_CONFIG_FILES = 6;
+export declare const CAPTURE_CONFIG_IMPORT_DEPTH = 1;
+export declare const MAX_PACKAGE_JSON_WALK_UP = 5;
+/**
+ * Keys whose line is scrubbed before a config file enters the archive.
+ * `user` / `key` are WDIO's own top-level credential options, hence the bare entries.
+ */
+/**
+ * Word families that make an identifier sensitive when they appear as its SUFFIX —
+ * `clientSecret`, `refreshToken`, `privateKey`, `client_secret`. Split by case so the
+ * camelCase form requires a capital (distinguishing `privateKey` from `hotkey`) and the
+ * snake_case form requires an explicit `_` (distinguishing `client_secret` from `keyword`).
+ */
+export declare const COMPOUND_SECRET_SUFFIXES_CAMEL = "Key|Token|Secret|Password|Passwd|Credential";
+export declare const COMPOUND_SECRET_SUFFIXES_SNAKE = "key|token|secret|password|passwd|credential";
+/**
+ * Secrets that span lines or hide inside a value, which a line/key-anchored scrub cannot
+ * reach. Applied as whole-block passes before the line passes.
+ */
+export declare const PEM_BLOCK_REGEX: RegExp;
+export declare const PEM_UNTERMINATED_REGEX: RegExp;
+export declare const URL_USERINFO_REGEX: RegExp;
+export declare const REDACTED_KEYS: string[];
 export declare const PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS: string[];
 export declare const CAPTURE_MODES: string[];
 export declare const LOG_KIND_USAGE_MAP: {
@@ -69,6 +103,10 @@ export declare const MAX_SPAWN_RETRIES = 3;
 export declare const SPAWN_RETRY_DELAY_MS = 1000;
 export declare const WDIO_NAMING_PREFIX = "WebdriverIO-";
 export declare const PERF_METRICS_WAIT_TIME = 2000;
+export declare const STOP_BUILD_MAX_ATTEMPTS = 4;
+export declare const STOP_BUILD_ATTEMPT_TIMEOUT_MS = 10000;
+export declare const STOP_BUILD_TOTAL_BUDGET_MS = 30000;
+export declare const STOP_BUILD_BACKOFF_BASE_MS = 1000;
 export declare const UPDATED_CLI_ENDPOINT = "sdk/v1/update_cli";
 /**
  * Module Hook Events - Performance event names for module lifecycle tracking