@wdio/browserstack-service 9.39.1 → 9.39.3

package/build/cli/apiUtils.d.ts

@@ -9,5 +9,11 @@ export default class APIUtils {
     static DATA_ENDPOINT: string;
     static UPLOAD_LOGS_ADDRESS: string;
     static EDS_URL: string;
-    static updateURLSForGRR(apis: GRRUrls): void;
+    /**
+     * Overlay the binary-supplied GRR endpoints onto the public defaults. Every field is
+     * optional: a degenerate StartBinSession/ConnectBinSession config (auth failure, empty
+     * payload) used to throw here and abort the whole CLI bootstrap, taking every product
+     * module with it. Missing entries now just leave the corresponding default in place.
+     */
+    static updateURLSForGRR(apis?: GRRUrls): void;
 }

package/build/cli/frameworks/constants/testFrameworkConstants.d.ts

@@ -39,5 +39,6 @@ export declare const TestFrameworkConstants: {
     DEFAULT_HOOK_RESULT: string;
     KIND_SCREENSHOT: string;
     KIND_LOG: string;
+    KIND_ATTACHMENT: string;
     HOOK_REGEX: string;
 };

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

@@ -0,0 +1,58 @@
+import BaseModule from './baseModule.js';
+import { BStackLogger } from '../cliLogger.js';
+/**
+ * UploadAttachmentModule — CLI/gRPC path registration for `browser.uploadAttachment`
+ * (aliased as `browser.uploadMedia`).
+ *
+ * Mirrors CustomTagsModule: registers the browser method in onBeforeExecute()
+ * (observer-bound to AutomationFrameworkState.CREATE / HookState.POST), instantiated
+ * from BrowserstackCLI.loadModules() whenever the binary is up.
+ *
+ * The binary streams the file from `filePath` only when it drains its upload queue, so the
+ * file is snapshotted first: a caller that overwrites or deletes its file right after the call
+ * would otherwise attach the wrong content or nothing. Snapshots go to
+ * `UploadedAttachments-wdio-<bin session id>/<worker pid>/<level>/` under the writable dir:
+ * per worker, so parallel workers never pick the same name, and per wdio run, so the Python
+ * and Java SDKs (`UploadedAttachments-<n>/`) and other runs on the host never read or delete
+ * them. The launcher removes this run's folder in onComplete. `level` is what the binary
+ * switches on to pick test_run_uuid / hook_run_uuid / build_run_uuid.
+ */
+export default class UploadAttachmentModule extends BaseModule {
+    logger: typeof BStackLogger;
+    name: string;
+    static MODULE_NAME: string;
+    private pendingSends;
+    constructor();
+    getModuleName(): string;
+    onBeforeExecute(): Promise<void>;
+    private recordAttachment;
+    private static platformIndex;
+    private static runAttachmentsDir;
+    private static snapshot;
+    /**
+     * Keeps uploadAttachment/uploadMedia callable when Test Reporting is inactive (no testhub,
+     * classic path, CLI down), as the other SDKs do. onBeforeExecute replaces it when the
+     * binary is up, and an already-registered implementation is left alone.
+     */
+    static installNoopFallback(browser?: WebdriverIO.Browser): void;
+    static cleanupUploadedAttachments(): void;
+    /**
+     * Pick the attachment level and the uuid it hangs off. A build-level attachment still
+     * needs a uuid on the wire — the binary drops log entries without one before it ever
+     * reads `level` — so it reuses whichever test/hook uuid is current and the binary
+     * substitutes the build id downstream.
+     */
+    private resolveTarget;
+    /**
+     * Dispatch and return — deliberately NOT awaited by the caller.
+     *
+     * uploadAttachment is called from the customer's test body, and the very next statement
+     * is usually a browser command that the accessibility module wraps with a pre-command
+     * scan. Awaiting a binary round-trip on that stack was observed to stall the following
+     * `executeAsync` scan under load (chrome sessions reaped at the framework timeout), so
+     * the event is written and its ack observed off the caller's stack. The ack carries no
+     * information the caller can act on: the binary streams the file from `filePath` while
+     * draining its own upload queue.
+     */
+    private sendAttachmentEvent;
+}

package/build/constants.d.ts

@@ -107,6 +107,7 @@ 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 UPLOAD_ATTACHMENT_ACK_TIMEOUT_MS = 10000;
 export declare const UPDATED_CLI_ENDPOINT = "sdk/v1/update_cli";
 /**
  * Module Hook Events - Performance event names for module lifecycle tracking

package/build/index.d.ts

@@ -28,6 +28,12 @@ declare global {
             startA11yScanning: () => Promise<void>;
             stopA11yScanning: () => Promise<void>;
             setCustomTags: (key: string, value: string) => Promise<void>;
+            uploadAttachment: (filePath: string, options?: {
+                buildAttachment?: boolean;
+            }) => Promise<void>;
+            uploadMedia: (filePath: string, options?: {
+                buildAttachment?: boolean;
+            }) => Promise<void>;
         }
     }
     interface State {