@testingbot/cli 1.0.1 → 1.0.3

package/dist/models/xcuitest_options.d.ts

@@ -1,6 +1,12 @@
 export type Orientation = 'PORTRAIT' | 'LANDSCAPE';
 export type ReportFormat = 'html' | 'junit';
 export type ThrottleNetwork = '4G' | '3G' | 'Edge' | 'airplane';
+export interface RunMetadata {
+    commitSha?: string;
+    pullRequestId?: string;
+    repoName?: string;
+    repoOwner?: string;
+}
 export interface CustomNetworkProfile {
     uploadSpeed: number;
     downloadSpeed: number;
@@ -45,6 +51,7 @@ export default class XCUITestOptions {
     private _async;
     private _report?;
     private _reportOutputDir?;
+    private _metadata?;
     constructor(app: string, testApp: string, device?: string, options?: {
         version?: string;
         realDevice?: boolean;
@@ -62,6 +69,7 @@ export default class XCUITestOptions {
         async?: boolean;
         report?: ReportFormat;
         reportOutputDir?: string;
+        metadata?: RunMetadata;
     });
     get app(): string;
     get testApp(): string;
@@ -82,6 +90,7 @@ export default class XCUITestOptions {
     get async(): boolean;
     get report(): ReportFormat | undefined;
     get reportOutputDir(): string | undefined;
+    get metadata(): RunMetadata | undefined;
     getCapabilities(): XCUITestCapabilities;
     getXCUITestOptions(): XCUITestRunOptions | undefined;
 }

package/dist/models/xcuitest_options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xcuitest_options.d.ts","sourceRoot":"","sources":["../../src/models/xcuitest_options.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;AACnD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAC5C,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,KAAK,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IAEjC,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gBAAgB,CAAC,EAAE,eAAe,GAAG,oBAAoB,CAAC;CAC3D;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,MAAM,CAAC,CAAS;IAExB,OAAO,CAAC,YAAY,CAAC,CAAc;IAEnC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,gBAAgB,CAAC,CAAyC;IAElE,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,gBAAgB,CAAC,CAAS;gBAGhC,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,eAAe,GAAG,oBAAoB,CAAC;QACzD,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAuBH,IAAW,GAAG,IAAI,MAAM,CAEvB;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;IAED,IAAW,OAAO,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,IAAI,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAEhD;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED,IAAW,eAAe,IACtB,eAAe,GACf,oBAAoB,GACpB,SAAS,CAEZ;IAED,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED,IAAW,MAAM,IAAI,YAAY,GAAG,SAAS,CAE5C;IAED,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;IAEM,eAAe,IAAI,oBAAoB;IAgBvC,kBAAkB,IAAI,kBAAkB,GAAG,SAAS;CAgB5D"}
+{"version":3,"file":"xcuitest_options.d.ts","sourceRoot":"","sources":["../../src/models/xcuitest_options.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;AACnD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAC5C,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,CAAC;AAEhE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,KAAK,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IAEjC,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gBAAgB,CAAC,EAAE,eAAe,GAAG,oBAAoB,CAAC;CAC3D;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,MAAM,CAAC,CAAS;IAExB,OAAO,CAAC,YAAY,CAAC,CAAc;IAEnC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,gBAAgB,CAAC,CAAyC;IAElE,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAElC,OAAO,CAAC,SAAS,CAAC,CAAc;gBAG9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,eAAe,GAAG,oBAAoB,CAAC;QACzD,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,EAAE,WAAW,CAAC;KACxB;IAgCH,IAAW,GAAG,IAAI,MAAM,CAEvB;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;IAED,IAAW,OAAO,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,IAAI,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAEhD;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED,IAAW,eAAe,IACtB,eAAe,GACf,oBAAoB,GACpB,SAAS,CAEZ;IAED,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED,IAAW,MAAM,IAAI,YAAY,GAAG,SAAS,CAE5C;IAED,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;IAED,IAAW,QAAQ,IAAI,WAAW,GAAG,SAAS,CAE7C;IAEM,eAAe,IAAI,oBAAoB;IAgBvC,kBAAkB,IAAI,kBAAkB,GAAG,SAAS;CAgB5D"}

package/dist/models/xcuitest_options.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const testingbot_error_1 = __importDefault(require("./testingbot_error"));
 class XCUITestOptions {
     _app;
     _testApp;
@@ -25,6 +29,8 @@ class XCUITestOptions {
     _async;
     _report;
     _reportOutputDir;
+    // Metadata
+    _metadata;
     constructor(app, testApp, device, options) {
         this._app = app;
         this._testApp = testApp;
@@ -33,6 +39,10 @@ class XCUITestOptions {
         this._realDevice = options?.realDevice ?? false;
         this._tabletOnly = options?.tabletOnly ?? false;
         this._phoneOnly = options?.phoneOnly ?? false;
+        // Validate contradictory options
+        if (this._tabletOnly && this._phoneOnly) {
+            throw new testingbot_error_1.default('Cannot specify both --phone-only and --tablet-only options');
+        }
         this._name = options?.name;
         this._build = options?.build;
         this._orientation = options?.orientation;
@@ -45,6 +55,7 @@ class XCUITestOptions {
         this._async = options?.async ?? false;
         this._report = options?.report;
         this._reportOutputDir = options?.reportOutputDir;
+        this._metadata = options?.metadata;
     }
     get app() {
         return this._app;
@@ -103,6 +114,9 @@ class XCUITestOptions {
     get reportOutputDir() {
         return this._reportOutputDir;
     }
+    get metadata() {
+        return this._metadata;
+    }
     getCapabilities() {
         const caps = {
             platformName: 'iOS',

package/dist/providers/base_provider.d.ts

@@ -0,0 +1,119 @@
+import Credentials from '../models/credentials';
+import TestingBotError from '../models/testingbot_error';
+import Upload from '../upload';
+/**
+ * Common interface for run information shared by all providers
+ */
+export interface BaseRunInfo {
+    id: number;
+    status: 'WAITING' | 'READY' | 'DONE' | 'FAILED';
+    capabilities: {
+        deviceName: string;
+        platformName: string;
+        version?: string;
+    };
+    success: number;
+    report?: string;
+}
+/**
+ * Common interface for provider options
+ */
+export interface BaseProviderOptions {
+    quiet?: boolean;
+    reportOutputDir?: string;
+}
+/**
+ * Abstract base class for test providers (Espresso, XCUITest, Maestro)
+ * Contains common functionality shared across all providers.
+ */
+export default abstract class BaseProvider<TOptions extends BaseProviderOptions> {
+    protected readonly POLL_INTERVAL_MS = 5000;
+    protected readonly MAX_POLL_ATTEMPTS = 720;
+    protected credentials: Credentials;
+    protected options: TOptions;
+    protected upload: Upload;
+    protected appId: number | undefined;
+    protected activeRunIds: number[];
+    protected isShuttingDown: boolean;
+    protected signalHandler: (() => void) | null;
+    /**
+     * The base URL for the provider's API endpoint
+     */
+    protected abstract readonly URL: string;
+    constructor(credentials: Credentials, options: TOptions);
+    /**
+     * Ensures an output directory exists, creating it if necessary.
+     */
+    protected ensureOutputDirectory(dirPath: string): Promise<void>;
+    /**
+     * Sets up signal handlers for graceful shutdown (SIGINT, SIGTERM)
+     */
+    protected setupSignalHandlers(): void;
+    /**
+     * Removes signal handlers
+     */
+    protected removeSignalHandlers(): void;
+    /**
+     * Handles graceful shutdown when interrupt signal is received
+     */
+    protected handleShutdown(): void;
+    /**
+     * Stops all active test runs
+     */
+    protected stopActiveRuns(): Promise<void>;
+    /**
+     * Stops a specific test run
+     */
+    protected stopRun(runId: number): Promise<void>;
+    /**
+     * Clears the current line in the terminal
+     */
+    protected clearLine(): void;
+    /**
+     * Sleeps for the specified number of milliseconds
+     */
+    protected sleep(ms: number): Promise<void>;
+    /**
+     * Maximum number of retries for transient errors
+     */
+    protected readonly MAX_RETRIES = 3;
+    /**
+     * Base delay for exponential backoff (in milliseconds)
+     */
+    protected readonly BASE_RETRY_DELAY_MS = 2000;
+    /**
+     * Executes an async operation with automatic retry for transient errors.
+     * Uses exponential backoff between retries.
+     *
+     * @param operation - Description of the operation (for logging)
+     * @param fn - Async function to execute
+     * @returns The result of the function
+     * @throws The last error if all retries fail
+     */
+    protected withRetry<T>(operation: string, fn: () => Promise<T>): Promise<T>;
+    /**
+     * Extracts an error message from various error types.
+     * For Axios errors, uses enhanced error handling with diagnostics.
+     */
+    protected extractErrorMessage(cause: unknown): string | null;
+    /**
+     * Checks internet connectivity and logs diagnostic information.
+     * Useful when network errors occur to help users troubleshoot.
+     */
+    protected checkAndReportConnectivity(): Promise<boolean>;
+    /**
+     * Performs a quick connectivity check before starting operations.
+     * Throws an error with diagnostics if no connection is available.
+     */
+    protected ensureConnectivity(): Promise<void>;
+    /**
+     * Handles errors with enhanced diagnostics.
+     * For network errors, performs connectivity check.
+     */
+    protected handleErrorWithDiagnostics(error: unknown, operation: string): Promise<TestingBotError>;
+    /**
+     * Formats elapsed time in human-readable format
+     */
+    protected formatElapsedTime(seconds: number): string;
+}
+//# sourceMappingURL=base_provider.d.ts.map

package/dist/providers/base_provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base_provider.d.ts","sourceRoot":"","sources":["../../src/providers/base_provider.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAGhD,OAAO,eAAe,MAAM,4BAA4B,CAAC;AAEzD,OAAO,MAAM,MAAM,WAAW,CAAC;AAa/B;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;IAChD,YAAY,EAAE;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,YAAY,CACxC,QAAQ,SAAS,mBAAmB;IAEpC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,QAAQ;IAC3C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,OAAO;IAE3C,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IACnC,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC5B,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAEzB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAa;IAChD,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,CAAM;IACtC,SAAS,CAAC,cAAc,UAAS;IACjC,SAAS,CAAC,aAAa,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAQ;IAEpD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;gBAErB,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ;IAM9D;;OAEG;cACa,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCrE;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAQrC;;OAEG;IACH,SAAS,CAAC,oBAAoB,IAAI,IAAI;IAOtC;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAuBhC;;OAEG;cACa,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB/C;;OAEG;cACa,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BrD;;OAEG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAI3B;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,KAAK;IAEnC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,QAAQ;IAE9C;;;;;;;;OAQG;cACa,SAAS,CAAC,CAAC,EACzB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC;IAsCb;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI;IAgE5D;;;OAGG;cACa,0BAA0B,IAAI,OAAO,CAAC,OAAO,CAAC;IAO9D;;;OAGG;cACa,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAWnD;;;OAGG;cACa,0BAA0B,CACxC,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,eAAe,CAAC;IAmB3B;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CASrD"}

package/dist/providers/base_provider.js

@@ -0,0 +1,296 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const testingbot_error_1 = __importDefault(require("../models/testingbot_error"));
+const utils_1 = __importDefault(require("../utils"));
+const upload_1 = __importDefault(require("../upload"));
+const platform_1 = __importDefault(require("../utils/platform"));
+const logger_1 = __importDefault(require("../logger"));
+const error_helpers_1 = require("../utils/error-helpers");
+const connectivity_1 = require("../utils/connectivity");
+/**
+ * Abstract base class for test providers (Espresso, XCUITest, Maestro)
+ * Contains common functionality shared across all providers.
+ */
+class BaseProvider {
+    POLL_INTERVAL_MS = 5000;
+    MAX_POLL_ATTEMPTS = 720; // 1 hour max with 5s interval
+    credentials;
+    options;
+    upload;
+    appId = undefined;
+    activeRunIds = [];
+    isShuttingDown = false;
+    signalHandler = null;
+    constructor(credentials, options) {
+        this.credentials = credentials;
+        this.options = options;
+        this.upload = new upload_1.default();
+    }
+    /**
+     * Ensures an output directory exists, creating it if necessary.
+     */
+    async ensureOutputDirectory(dirPath) {
+        try {
+            const stat = await node_fs_1.default.promises.stat(dirPath);
+            if (!stat.isDirectory()) {
+                throw new testingbot_error_1.default(`Report output path exists but is not a directory: ${dirPath}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error &&
+                'code' in error &&
+                error.code === 'ENOENT') {
+                try {
+                    await node_fs_1.default.promises.mkdir(dirPath, { recursive: true });
+                }
+                catch (mkdirError) {
+                    throw new testingbot_error_1.default(`Failed to create report output directory: ${dirPath}`, { cause: mkdirError });
+                }
+            }
+            else if (error instanceof testingbot_error_1.default) {
+                throw error;
+            }
+            else {
+                throw new testingbot_error_1.default(`Failed to access report output directory: ${dirPath}`, { cause: error });
+            }
+        }
+    }
+    /**
+     * Sets up signal handlers for graceful shutdown (SIGINT, SIGTERM)
+     */
+    setupSignalHandlers() {
+        this.signalHandler = () => {
+            this.handleShutdown();
+        };
+        platform_1.default.setupSignalHandlers(this.signalHandler);
+    }
+    /**
+     * Removes signal handlers
+     */
+    removeSignalHandlers() {
+        if (this.signalHandler) {
+            platform_1.default.removeSignalHandlers(this.signalHandler);
+            this.signalHandler = null;
+        }
+    }
+    /**
+     * Handles graceful shutdown when interrupt signal is received
+     */
+    handleShutdown() {
+        if (this.isShuttingDown) {
+            logger_1.default.warn('Force exiting...');
+            process.exit(1);
+        }
+        this.isShuttingDown = true;
+        this.clearLine();
+        logger_1.default.info('Received interrupt signal, stopping test runs...');
+        this.stopActiveRuns()
+            .then(() => {
+            logger_1.default.info('All test runs have been stopped.');
+            process.exit(1);
+        })
+            .catch((error) => {
+            logger_1.default.error(`Failed to stop some test runs: ${error instanceof Error ? error.message : error}`);
+            process.exit(1);
+        });
+    }
+    /**
+     * Stops all active test runs
+     */
+    async stopActiveRuns() {
+        if (!this.appId || this.activeRunIds.length === 0) {
+            return;
+        }
+        const stopPromises = this.activeRunIds.map((runId) => this.stopRun(runId).catch((error) => {
+            logger_1.default.error(`Failed to stop run ${runId}: ${error instanceof Error ? error.message : error}`);
+        }));
+        await Promise.all(stopPromises);
+    }
+    /**
+     * Stops a specific test run
+     */
+    async stopRun(runId) {
+        if (!this.appId) {
+            return;
+        }
+        try {
+            await axios_1.default.post(`${this.URL}/${this.appId}/${runId}/stop`, {}, {
+                headers: {
+                    'User-Agent': utils_1.default.getUserAgent(),
+                },
+                auth: {
+                    username: this.credentials.userName,
+                    password: this.credentials.accessKey,
+                },
+            });
+            if (!this.options.quiet) {
+                logger_1.default.info(`Stopped run ${runId}`);
+            }
+        }
+        catch {
+            // Ignore errors when stopping runs (may already be stopped)
+        }
+    }
+    /**
+     * Clears the current line in the terminal
+     */
+    clearLine() {
+        platform_1.default.clearLine();
+    }
+    /**
+     * Sleeps for the specified number of milliseconds
+     */
+    sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    /**
+     * Maximum number of retries for transient errors
+     */
+    MAX_RETRIES = 3;
+    /**
+     * Base delay for exponential backoff (in milliseconds)
+     */
+    BASE_RETRY_DELAY_MS = 2000;
+    /**
+     * Executes an async operation with automatic retry for transient errors.
+     * Uses exponential backoff between retries.
+     *
+     * @param operation - Description of the operation (for logging)
+     * @param fn - Async function to execute
+     * @returns The result of the function
+     * @throws The last error if all retries fail
+     */
+    async withRetry(operation, fn) {
+        let lastError;
+        for (let attempt = 0; attempt <= this.MAX_RETRIES; attempt++) {
+            try {
+                return await fn();
+            }
+            catch (error) {
+                lastError = error;
+                // Check if this is a retryable error
+                const isRetryable = axios_1.default.isAxiosError(error) && (0, error_helpers_1.isRetryableError)(error);
+                // Don't retry non-retryable errors or on the last attempt
+                if (!isRetryable || attempt === this.MAX_RETRIES) {
+                    break;
+                }
+                // Calculate delay with exponential backoff: 2s, 4s, 8s
+                const delay = this.BASE_RETRY_DELAY_MS * Math.pow(2, attempt);
+                if (!this.options.quiet) {
+                    const statusCode = axios_1.default.isAxiosError(error)
+                        ? error.response?.status
+                        : undefined;
+                    logger_1.default.warn(`${operation} failed${statusCode ? ` (HTTP ${statusCode})` : ''}, retrying in ${delay / 1000}s... (attempt ${attempt + 1}/${this.MAX_RETRIES})`);
+                }
+                await this.sleep(delay);
+            }
+        }
+        // All retries failed, throw the error
+        throw lastError;
+    }
+    /**
+     * Extracts an error message from various error types.
+     * For Axios errors, uses enhanced error handling with diagnostics.
+     */
+    extractErrorMessage(cause) {
+        if (typeof cause === 'string') {
+            return cause;
+        }
+        if (Array.isArray(cause)) {
+            return cause.join('\n');
+        }
+        if (cause && typeof cause === 'object') {
+            // Use enhanced error handling for real Axios errors
+            if (axios_1.default.isAxiosError(cause)) {
+                const enhanced = (0, error_helpers_1.handleAxiosError)(cause, 'Request failed');
+                return enhanced.message;
+            }
+            // Handle error-like objects with response property (for backwards compatibility)
+            const axiosLikeError = cause;
+            // Check for 429 status code (credits depleted)
+            if (axiosLikeError.response?.status === 429) {
+                return 'Your TestingBot credits are depleted. Please upgrade your plan at https://testingbot.com/pricing';
+            }
+            // Extract error message from response data
+            if (axiosLikeError.response?.data?.errors) {
+                return axiosLikeError.response.data.errors.join('\n');
+            }
+            if (axiosLikeError.response?.data?.error) {
+                return axiosLikeError.response.data.error;
+            }
+            if (axiosLikeError.response?.data?.message) {
+                return axiosLikeError.response.data.message;
+            }
+            if (cause instanceof Error) {
+                return cause.message;
+            }
+            const obj = cause;
+            if (obj.errors) {
+                return obj.errors.join('\n');
+            }
+            if (obj.error) {
+                return obj.error;
+            }
+            if (obj.message) {
+                return obj.message;
+            }
+        }
+        return null;
+    }
+    /**
+     * Checks internet connectivity and logs diagnostic information.
+     * Useful when network errors occur to help users troubleshoot.
+     */
+    async checkAndReportConnectivity() {
+        logger_1.default.info('Checking internet connectivity...');
+        const result = await (0, connectivity_1.checkInternetConnectivity)();
+        logger_1.default.info((0, connectivity_1.formatConnectivityResults)(result));
+        return result.connected;
+    }
+    /**
+     * Performs a quick connectivity check before starting operations.
+     * Throws an error with diagnostics if no connection is available.
+     */
+    async ensureConnectivity() {
+        const result = await (0, connectivity_1.checkInternetConnectivity)();
+        if (!result.connected) {
+            logger_1.default.error('No internet connection detected.');
+            logger_1.default.error((0, connectivity_1.formatConnectivityResults)(result));
+            throw new testingbot_error_1.default('No internet connection. Please check your network and try again.');
+        }
+    }
+    /**
+     * Handles errors with enhanced diagnostics.
+     * For network errors, performs connectivity check.
+     */
+    async handleErrorWithDiagnostics(error, operation) {
+        if (axios_1.default.isAxiosError(error)) {
+            // For network errors, check connectivity
+            if ((0, error_helpers_1.isNetworkError)(error)) {
+                await this.checkAndReportConnectivity();
+            }
+            return (0, error_helpers_1.handleAxiosError)(error, operation);
+        }
+        if (error instanceof testingbot_error_1.default) {
+            return error;
+        }
+        return new testingbot_error_1.default(`${operation}: ${error instanceof Error ? error.message : 'Unknown error'}`, { cause: error instanceof Error ? error : undefined });
+    }
+    /**
+     * Formats elapsed time in human-readable format
+     */
+    formatElapsedTime(seconds) {
+        if (seconds < 60) {
+            return `${seconds}s`;
+        }
+        const minutes = Math.floor(seconds / 60);
+        const remainingSeconds = seconds % 60;
+        return `${minutes}m ${remainingSeconds}s`;
+    }
+}
+exports.default = BaseProvider;

package/dist/providers/espresso.d.ts

@@ -1,5 +1,11 @@
 import EspressoOptions from '../models/espresso_options';
 import Credentials from '../models/credentials';
+import BaseProvider from './base_provider';
+export interface EspressoRunEnvironment {
+    device?: string;
+    name?: string;
+    version?: string;
+}
 export interface EspressoRunInfo {
     id: number;
     status: 'WAITING' | 'READY' | 'DONE' | 'FAILED';
@@ -8,6 +14,7 @@ export interface EspressoRunInfo {
         platformName: string;
         version?: string;
     };
+    environment?: EspressoRunEnvironment;
     success: number;
     report?: string;
 }
@@ -24,23 +31,13 @@ export interface EspressoSocketMessage {
     id: number;
     payload: string;
 }
-export default class Espresso {
-    private readonly URL;
-    private readonly POLL_INTERVAL_MS;
-    private readonly MAX_POLL_ATTEMPTS;
-    private credentials;
-    private options;
-    private upload;
-    private appId;
-    private activeRunIds;
-    private isShuttingDown;
-    private signalHandler;
+export default class Espresso extends BaseProvider<EspressoOptions> {
+    protected readonly URL = "https://api.testingbot.com/v1/app-automate/espresso";
     private socket;
     private updateServer;
     private updateKey;
     constructor(credentials: Credentials, options: EspressoOptions);
     private validate;
-    private ensureOutputDirectory;
     run(): Promise<EspressoResult>;
     private uploadApp;
     private uploadTestApp;
@@ -48,17 +45,13 @@ export default class Espresso {
     private getStatus;
     private waitForCompletion;
     private displayRunStatus;
-    private clearLine;
-    private formatElapsedTime;
+    /**
+     * Get the display name for a run, preferring environment.name over capabilities.deviceName
+     * This shows the actual device used when a wildcard (*) was specified
+     */
+    private getRunDisplayName;
     private getStatusInfo;
     private fetchReports;
-    private sleep;
-    private extractErrorMessage;
-    private setupSignalHandlers;
-    private removeSignalHandlers;
-    private handleShutdown;
-    private stopActiveRuns;
-    private stopRun;
     private connectToUpdateServer;
     private disconnectFromUpdateServer;
     private handleEspressoData;

package/dist/providers/espresso.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"espresso.d.ts","sourceRoot":"","sources":["../../src/providers/espresso.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,4BAA4B,CAAC;AAEzD,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAUhD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;IAChD,YAAY,EAAE;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,eAAe,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAyD;IAC7E,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAO;IAEzC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,KAAK,CAAiC;IAC9C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,aAAa,CAA6B;IAClD,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,SAAS,CAAuB;gBAErB,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe;YAMvD,QAAQ;YAuCR,qBAAqB;IA6BtB,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC;YA4D7B,SAAS;YAaT,aAAa;YAYb,QAAQ;YAsDR,SAAS;YAoBT,iBAAiB;IAwE/B,OAAO,CAAC,gBAAgB;IAmCxB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,aAAa;YAkBP,YAAY;IAmD1B,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,mBAAmB;IAiD3B,OAAO,CAAC,mBAAmB;IAQ3B,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,cAAc;YAuBR,cAAc;YAgBd,OAAO;IA8BrB,OAAO,CAAC,qBAAqB;IAqC7B,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,mBAAmB;CAa5B"}
+{"version":3,"file":"espresso.d.ts","sourceRoot":"","sources":["../../src/providers/espresso.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,4BAA4B,CAAC;AAEzD,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAOhD,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;IAChD,YAAY,EAAE;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,eAAe,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,YAAY,CAAC,eAAe,CAAC;IACjE,SAAS,CAAC,QAAQ,CAAC,GAAG,yDACkC;IAExD,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,SAAS,CAAuB;gBAErB,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe;YAIvD,QAAQ;IAuCT,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC;YA+D7B,SAAS;YAaT,aAAa;YAYb,QAAQ;YA0DR,SAAS;YA4BT,iBAAiB;IAwE/B,OAAO,CAAC,gBAAgB;IAmCxB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;YAkBP,YAAY;IAwD1B,OAAO,CAAC,qBAAqB;IAqC7B,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,mBAAmB;CAa5B"}