@amazon/vinyl-build-utils 1.0.0

package/dist/browserstack/BrowserStackWorkerController.js

@@ -0,0 +1,199 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BrowserStackWorker } from './BrowserStackWorker';
+import { logger } from '../util/Logger';
+export class BrowserStackWorkerController {
+    deps;
+    options;
+    /**
+     * Set to observe state updates.
+     */
+    onUpdate = () => { };
+    _state;
+    workers;
+    /**
+     * Maps the worker's local id to the worker.
+     */
+    localIdToWorkerMap;
+    sessionPollIntervalId = null;
+    /**
+     * Tracks an in-flight startSessions invocation. While set, additional calls
+     * are deferred until the current one settles to avoid redundant API calls
+     * and racing state updates.
+     */
+    startSessionsInFlight = null;
+    /**
+     * If set during an in-flight startSessions, indicates another invocation
+     * was requested and should run after the current one settles.
+     */
+    startSessionsRequested = false;
+    constructor(deps, browsers, options) {
+        this.deps = deps;
+        this.options = options;
+        this.workers = browsers.map((browser) => new BrowserStackWorker(deps, browser, options?.worker));
+        this._state = {
+            workers: this.workers.map((worker) => worker.state),
+            pending: this.workers.length,
+            remaining: this.workers.length,
+            running: 0,
+            failed: 0,
+            passed: 0,
+            percentComplete: 0,
+            total: this.workers.length,
+        };
+        this.localIdToWorkerMap = new Map(this.workers.map((worker) => {
+            return [worker.state.localId, worker];
+        }));
+        // Observe state on all workers
+        for (const worker of this.workers) {
+            worker.onUpdate = this.updateHandler;
+        }
+    }
+    get state() {
+        return this._state;
+    }
+    shouldHandleRequest(id) {
+        return this.localIdToWorkerMap.has(id);
+    }
+    onStarted(request) {
+        const worker = this.localIdToWorkerMap.get(request.id);
+        worker.totalSpecs = request.totalSpecs;
+    }
+    onProgress(request) {
+        const worker = this.localIdToWorkerMap.get(request.id);
+        worker.totalCompleted = request.totalCompleted;
+        worker.appendLogs(request.logs);
+    }
+    onDone(request) {
+        const worker = this.localIdToWorkerMap.get(request.id);
+        void worker.done(request.overallStatus === 'passed', request.reason ?? '');
+    }
+    refreshState() {
+        const state = this._state;
+        let running = 0;
+        let pending = 0;
+        let failed = 0;
+        let passed = 0;
+        let percentSum = 0;
+        for (const worker of this.workers) {
+            const completed = worker.completed;
+            if (completed) {
+                if (worker.passed)
+                    passed++;
+                else
+                    failed++;
+                percentSum++;
+            }
+            else {
+                if (worker.state.started)
+                    running++;
+                else
+                    pending++;
+                percentSum +=
+                    worker.state.totalCompleted / (worker.state.totalSpecs || 1);
+            }
+        }
+        state.running = running;
+        state.pending = pending;
+        state.failed = failed;
+        state.passed = passed;
+        state.remaining = running + pending;
+        state.percentComplete = percentSum / (state.total || 1);
+    }
+    /**
+     * Refreshes the current state and invokes the onUpdate callback.
+     */
+    updateHandler = () => {
+        const state = this._state;
+        const previousRunning = state.running;
+        this.refreshState();
+        if (previousRunning !== state.running)
+            this.startSessions();
+        this.onUpdate();
+    };
+    /**
+     * Begins new workers until the maximum parallel sessions is reached.
+     * Reentrancy-safe: if invoked while a previous invocation is still
+     * running, schedules a single follow-up to run after it settles.
+     */
+    startSessions() {
+        if (this.startSessionsInFlight) {
+            this.startSessionsRequested = true;
+            return;
+        }
+        const run = (async () => {
+            const state = this._state;
+            if (state.pending === 0)
+                return;
+            const client = this.deps.client;
+            const planDetails = await client.getPlan();
+            const remainingOpenSessions = Math.min(this.options?.maxSessions ?? Number.MAX_SAFE_INTEGER, planDetails.parallel_sessions_max_allowed) -
+                Math.max(state.running, planDetails.parallel_sessions_running);
+            logger.debug('Plan parallel sessions:', `${planDetails.parallel_sessions_running} running, ${planDetails.parallel_sessions_max_allowed} allowed`);
+            // Takes up to [remainingOpenSessions] pending workers, starts them in parallel, and awaits their startup.
+            const workersToStart = this.workers
+                .filter((worker) => !worker.state.started)
+                .slice(0, remainingOpenSessions);
+            if (workersToStart.length) {
+                logger.debug(`Starting ${workersToStart.length} sessions...`);
+                // Start all workers in parallel
+                await Promise.all(workersToStart.map((worker) => worker.start().catch(() => { })));
+            }
+            this.refreshState();
+            if (this._state.pending > 0) {
+                // There are pending sessions that were not started, either due
+                // no open sessions or a worker start failure.
+                // Check if a session opens up after a timeout.
+                logger.debug('No open sessions, checking again in 15s.');
+                this.clearOpenSessionPollTimeout();
+                this.sessionPollIntervalId = setTimeout(() => this.startSessions(), 15000);
+            }
+        })()
+            .catch((error) => {
+            logger.warn('startSessions failed', error);
+            // Schedule a retry rather than abandoning all pending workers;
+            // a transient API failure should not permanently strand them.
+            this.clearOpenSessionPollTimeout();
+            this.sessionPollIntervalId = setTimeout(() => this.startSessions(), 15000);
+        })
+            .finally(() => {
+            this.startSessionsInFlight = null;
+            if (this.startSessionsRequested) {
+                this.startSessionsRequested = false;
+                // A coalesced request supersedes any retry scheduled by
+                // .catch(); otherwise both the immediate run here and the
+                // delayed timeout below would fire startSessions().
+                this.clearOpenSessionPollTimeout();
+                this.startSessions();
+            }
+        });
+        this.startSessionsInFlight = run;
+    }
+    clearOpenSessionPollTimeout() {
+        if (this.sessionPollIntervalId != null) {
+            clearTimeout(this.sessionPollIntervalId);
+            this.sessionPollIntervalId = null;
+        }
+    }
+    get allPassed() {
+        return this.workers.every((worker) => worker.passed);
+    }
+    start() {
+        logger.debug(`BrowserStackWorkerController start`);
+        this.startSessions();
+    }
+    /**
+     * Terminates all running workers.
+     */
+    async terminate() {
+        logger.debug(`Terminating workers`);
+        this.clearOpenSessionPollTimeout();
+        await Promise.all(this.workers.map((worker) => worker.terminate().catch(() => {
+            logger.warn(`Could not terminate worker: '${worker.state.workerOptions.name}'`);
+        }))).finally(() => {
+            logger.debug('terminate done');
+        });
+    }
+}

package/dist/browserstack/browserStackLocal.d.ts

@@ -0,0 +1,3 @@
+import { type Options } from 'browserstack-local';
+export declare function startBrowserStackLocal(options: Partial<Options>): Promise<() => Promise<void>>;
+//# sourceMappingURL=browserStackLocal.d.ts.map

package/dist/browserstack/browserStackLocal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserStackLocal.d.ts","sourceRoot":"","sources":["../../src/browserstack/browserStackLocal.ts"],"names":[],"mappings":"AAKA,OAAO,EAAoB,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAKnE,wBAAgB,sBAAsB,CAClC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAC1B,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAe9B"}

package/dist/browserstack/browserStackLocal.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Local as BsLocal } from 'browserstack-local';
+import { logger } from '../util/Logger';
+import fs from 'node:fs';
+import path from 'path';
+export function startBrowserStackLocal(options) {
+    if (options.logFile)
+        fs.mkdirSync(path.dirname(options.logFile), { recursive: true });
+    return new Promise((resolve, reject) => {
+        const bsLocal = new BsLocal();
+        logger.info('Starting BrowserStackLocal...');
+        bsLocal.start(options, (error) => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            logger.info('Started BrowserStackLocal');
+            resolve(() => closeBsLocal(bsLocal));
+        });
+    });
+}
+/**
+ * Promisifies closing the local connection.
+ */
+function closeBsLocal(bsLocal) {
+    return new Promise((resolve) => {
+        logger.debug('Stopping BrowserStackLocal...');
+        bsLocal.stop(() => {
+            logger.debug('Stopped BrowserStackLocal');
+            resolve();
+        });
+    });
+}

package/dist/browserstack/browserStackRestApi.d.ts

@@ -0,0 +1,304 @@
+/**
+ * Browserstack Automate credentials.
+ */
+export interface BrowserStackCredentials {
+    readonly username: string;
+    readonly key: string;
+}
+export interface BrowserDetails {
+    /**
+     * Specifies the Browser in the combination.
+     */
+    readonly browser?: string;
+    /**
+     * Specifies the version of the browser in the combination.
+     */
+    readonly browser_version?: string;
+    /**
+     * Specifies the OS in the combination.
+     */
+    readonly os: string;
+    /**
+     * Specifies the version of the OS in the combination.
+     */
+    readonly os_version: string;
+    /**
+     * Specifies the device name (in case of mobile device), null otherwise.
+     */
+    readonly device?: string | null;
+}
+/**
+ * Worker configuration. Valid browsers and devices can be obtained using the SDK config
+ * generator at:
+ * {@link https://www.browserstack.com/docs/automate/selenium/sdk-config-generator}
+ */
+export interface WorkerOptions extends BrowserDetails {
+    /**
+     * Set the resolution of VM before the beginning of your test. Available for Desktop only.
+     * Default is 1024x768.
+     */
+    readonly resolution?: string;
+    /**
+     * Provide a name to the session/worker.
+     * Accepted characters are A-Z, a-z, 0-9, ., :, -, [], /, @, &, ', _.
+     */
+    readonly name?: string;
+    /**
+     * Time in seconds before the worker is terminated.
+     * Defaults to 300 seconds.
+     * Irrespective of this value, a browser worker is alive for a maximum time of 1800 seconds.
+     */
+    readonly timeout?: number;
+    /**
+     * A valid url to navigate the browser to.
+     */
+    readonly url: string;
+    /**
+     * Optional name of the build the session is running under.
+     */
+    readonly build?: string;
+    /**
+     * Optional name of the project the build is under.
+     */
+    readonly project?: string;
+    /**
+     * Optional flag to enable video recording in your test.
+     * Default: true
+     */
+    readonly video?: boolean;
+    /**
+     * Required if you want to capture network logs for your test. Network Logs are supported
+     * for all desktop browsers, Android and iOS devices with a few exceptions - IE 10 on any
+     * OS; IE 11 on Windows 7 / 8.1 and any browser on MacOS High Sierra and Mojave.
+     */
+    readonly networkLogs?: boolean;
+}
+export interface NewWorker {
+    /**
+     * The identifier of the new Worker. Can be used to get worker details which includes the session id.
+     */
+    readonly id: number;
+    /**
+     * The url of the worker.
+     */
+    readonly url: string;
+}
+/**
+ * https://www.browserstack.com/docs/automate/api-reference/selenium/session#set-test-status
+ */
+export type SessionUpdateStatus = 'passed' | 'failed';
+export interface UpdateSessionOptions {
+    /**
+     * Set session status to either passed or failed.
+     */
+    readonly status?: SessionUpdateStatus;
+    /**
+     * Name of your session.
+     */
+    readonly name?: string;
+    /**
+     * Reason for session failure.
+     */
+    readonly reason?: string;
+}
+export interface GetSessionsOptions {
+    /**
+     * Specify the number of results to be displayed. The default value is 10, and the maximum value is 100.
+     */
+    readonly limit?: number;
+    /**
+     * Retrieve builds from a specific point using the offset parameter.
+     */
+    readonly offset?: number;
+    /**
+     * Filters the returned sessions to this status.
+     */
+    readonly status?: ExecutionStatus;
+}
+/**
+ * https://www.browserstack.com/docs/automate/api-reference/selenium/build#update-build-details
+ */
+export interface UpdateBuildOptions {
+    /**
+     * The new name of the build.
+     */
+    readonly name?: string;
+}
+export type BuildStatus = 'running' | 'done' | 'timeout' | 'failed';
+/**
+ * An empty record.
+ */
+export type AnyRecord = Record<never, any>;
+export interface PlanDetails {
+    /**
+     * Specifies your Automate plan name.
+     */
+    readonly automate_plan: string;
+    /**
+     * Number of parallel sessions currently running.
+     */
+    readonly parallel_sessions_running: number;
+    /**
+     * Maximum number of parallel sessions allowed in a team.
+     */
+    readonly team_parallel_sessions_max_allowed: number;
+    /**
+     * Maximum number of parallel sessions you can run.
+     */
+    readonly parallel_sessions_max_allowed: number;
+    /**
+     * Number of sessions currently queued.
+     */
+    readonly queued_sessions: number;
+    /**
+     * Maximum number of sessions that can be queued.
+     */
+    readonly queued_sessions_max_allowed: number;
+}
+/**
+ * Information about the worker.
+ */
+export interface WorkerDetails extends BrowserDetails {
+    readonly id: number;
+    readonly status: SessionStatus;
+    readonly real_mobile: null | boolean;
+    readonly browser_url: string;
+    readonly sessionId: string;
+}
+export interface DeleteWorkerResponse {
+    readonly time: number;
+}
+export type SessionStatus = 'passed' | 'failed' | 'timeout' | 'running' | 'queued';
+export type ExecutionStatus = 'running' | 'done' | 'timeout' | 'queued';
+export interface SessionDetails extends BrowserDetails {
+    readonly status: SessionStatus;
+    /**
+     * Name of your session.
+     */
+    readonly name: null | string;
+    /**
+     * Time taken to run the session.
+     */
+    readonly duration: null | number;
+    /**
+     * ID of the session.
+     */
+    readonly hashed_id: string;
+    /**
+     * Reason for test status.
+     */
+    readonly reason: string | null;
+    /**
+     * Name of the build.
+     */
+    readonly build_name: string;
+    /**
+     * Name of the project.
+     */
+    readonly project_name: string | null;
+    /**
+     * The build id.
+     */
+    readonly build_hashed_id: string;
+}
+export interface FullSessionDetails extends SessionDetails {
+    /**
+     * URL to view the session logs.
+     */
+    readonly logs: string;
+    /**
+     * Execution status of the session.
+     */
+    readonly browserstack_status: ExecutionStatus;
+    /**
+     * URL to view the session on Automate dashboard.
+     */
+    readonly browser_url: string;
+    /**
+     * URL to view the session publicly.
+     */
+    readonly public_url: string;
+    /**
+     * URL to view appium logs.
+     */
+    readonly appium_logs_url: string;
+    /**
+     * URL to view session video.
+     */
+    readonly video_url: string;
+    /**
+     * URL to view browser’s console logs.
+     */
+    readonly browser_console_logs_url: string;
+    /**
+     * URL to view browser logs.
+     */
+    readonly har_logs_url: string;
+    /**
+     * URL to view selenium logs.
+     */
+    readonly selenium_logs_url: string;
+    /**
+     * URL to view telemetry logs if it is enabled in your Selenium 4 session.
+     */
+    readonly selenium_telemetry_logs_url: string;
+}
+export interface DeleteResponse {
+    readonly status: 'ok' | string;
+    readonly message: string;
+}
+export interface GetBuildsOptions {
+    /**
+     * Specify the number of results to be displayed. The default value is 10, and the maximum value is 100.
+     */
+    readonly limit?: number;
+    /**
+     * Retrieve builds from a specific point using the offset parameter.
+     */
+    readonly offset?: number;
+    /**
+     * The status parameter filters your results by the status of the build.
+     * The values accepted by this parameter are running, done, timeout, and failed.
+     */
+    readonly status?: BuildStatus;
+    /**
+     * Retrieve all builds related to the specified project ID.
+     */
+    readonly projectId?: number;
+}
+export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+declare class BrowserStackClient {
+    readonly credentials: BrowserStackCredentials;
+    constructor(credentials: BrowserStackCredentials);
+    createWorker(options: WorkerOptions): Promise<NewWorker>;
+    deleteWorker(workerId: number): Promise<DeleteWorkerResponse>;
+    getWorker(workerId: number): Promise<WorkerDetails>;
+    /**
+     * Deletes a build and all sessions contained within it. Builds once deleted cannot be recovered.
+     * @param buildId
+     */
+    deleteBuild(buildId: number): Promise<DeleteWorkerResponse>;
+    protected doRequest(url: string, method: RequestMethod, body?: any, type?: 'json' | 'text', retries?: number): Promise<any>;
+}
+export declare class ServiceResponseError extends Error {
+    readonly url: string;
+    readonly method: RequestMethod;
+    readonly response: Response;
+    constructor(url: string, method: RequestMethod, response: Response);
+}
+export declare class BrowserStackAutomateClient extends BrowserStackClient {
+    getPlan(): Promise<PlanDetails>;
+    getSessions(buildId: string, options: GetSessionsOptions): Promise<readonly FullSessionDetails[]>;
+    getSession(sessionId: string): Promise<FullSessionDetails>;
+    updateSession(sessionId: string, options: UpdateSessionOptions): Promise<SessionDetails>;
+    /**
+     * Deletes a session.
+     * Sessions once deleted cannot be recovered.
+     * @param sessionId
+     */
+    deleteSession(sessionId: string): Promise<DeleteResponse>;
+    getBuilds(options: GetBuildsOptions): Promise<WorkerDetails | AnyRecord>;
+    updateBuild(buildId: string, buildOptions: UpdateBuildOptions): Promise<WorkerDetails | AnyRecord>;
+}
+export {};
+//# sourceMappingURL=browserStackRestApi.d.ts.map

package/dist/browserstack/browserStackRestApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserStackRestApi.d.ts","sourceRoot":"","sources":["../../src/browserstack/browserStackRestApi.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAErD,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAA;AAEnE;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;AAE1C,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,yBAAyB,EAAE,MAAM,CAAA;IAE1C;;OAEG;IACH,QAAQ,CAAC,kCAAkC,EAAE,MAAM,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAA;IAE9C;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,2BAA2B,EAAE,MAAM,CAAA;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B,QAAQ,CAAC,WAAW,EAAE,IAAI,GAAG,OAAO,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,MAAM,aAAa,GACnB,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,CAAA;AAEd,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAA;AAEvE,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACtD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,eAAe,CAAA;IAE7C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,2BAA2B,EAAE,MAAM,CAAA;CAC/C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC9B;AAYD,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;AAE7D,cAAM,kBAAkB;IACR,QAAQ,CAAC,WAAW,EAAE,uBAAuB;gBAApC,WAAW,EAAE,uBAAuB;IAEnD,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC;IAIxD,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7D,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAWzD;;;OAGG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;cAIjD,SAAS,CACrB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,EACrB,IAAI,CAAC,EAAE,GAAG,EACV,IAAI,GAAE,MAAM,GAAG,MAAe,EAC9B,OAAO,SAAI,GACZ,OAAO,CAAC,GAAG,CAAC;CAkClB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;IAEvC,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,QAAQ,CAAC,MAAM,EAAE,aAAa;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ;gBAFlB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,QAAQ;CAMlC;AAID,qBAAa,0BAA2B,SAAQ,kBAAkB;IACxD,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC;IAI/B,WAAW,CACb,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,kBAAkB,GAC5B,OAAO,CAAC,SAAS,kBAAkB,EAAE,CAAC;IAYnC,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAS1D,aAAa,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,oBAAoB,GAC9B,OAAO,CAAC,cAAc,CAAC;IAU1B;;;;OAIG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAOzD,SAAS,CACX,OAAO,EAAE,gBAAgB,GAC1B,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAI/B,WAAW,CACb,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,kBAAkB,GACjC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;CAOxC"}

package/dist/browserstack/browserStackRestApi.js

@@ -0,0 +1,121 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * A partial, typed implementation of the BrowserStack Automate REST API.
+ * https://www.browserstack.com/docs/automate/api-reference/selenium/introduction
+ * https://www.browserstack.com/docs/automate/capabilities#reference-main-section
+ * @module
+ */
+import { sleep } from '../util/sleep';
+import { logger } from '../util/Logger';
+const API = 'https://api.browserstack.com/5';
+const retryableStatuses = new Set([
+    400, // Bad request
+    429, // Too many requests
+    502, // Bad gateway
+    503, // Service unavailable
+    504, // Gateway timeout
+]);
+class BrowserStackClient {
+    credentials;
+    constructor(credentials) {
+        this.credentials = credentials;
+    }
+    async createWorker(options) {
+        return this.doRequest(`${API}/worker`, 'POST', options);
+    }
+    async deleteWorker(workerId) {
+        return this.doRequest(`${API}/worker/${workerId}`, 'DELETE');
+    }
+    async getWorker(workerId) {
+        const workerDetails = await this.doRequest(`${API}/worker/${workerId}`, 'GET');
+        if (!('sessionId' in workerDetails)) {
+            throw new Error(`worker ${workerId} not found`);
+        }
+        return workerDetails;
+    }
+    /**
+     * Deletes a build and all sessions contained within it. Builds once deleted cannot be recovered.
+     * @param buildId
+     */
+    async deleteBuild(buildId) {
+        return this.doRequest(`${API}/builds/${buildId}`, 'DELETE');
+    }
+    async doRequest(url, method, body, type = 'json', retries = 3) {
+        let response = null;
+        let error = null;
+        let retryable = retries > 0;
+        try {
+            response = await fetch(url, {
+                method,
+                headers: {
+                    Authorization: `Basic ${Buffer.from(`${this.credentials.username}:${this.credentials.key}`).toString('base64')}`,
+                    'Content-Type': type === 'json' ? 'application/json' : 'text/plain',
+                },
+                body: body ? JSON.stringify(body) : null,
+            });
+            if (!response.ok) {
+                error = new ServiceResponseError(url, method, response);
+                retryable &&= retryableStatuses.has(response.status);
+            }
+        }
+        catch (e) {
+            error = e;
+        }
+        if (error) {
+            if (retryable) {
+                logger.warn(`${error.message}, retrying in 5s`);
+                await sleep(5);
+                return this.doRequest(url, method, body, type, retries - 1);
+            }
+            else {
+                throw error;
+            }
+        }
+        return type === 'json' ? await response.json() : await response.text();
+    }
+}
+export class ServiceResponseError extends Error {
+    url;
+    method;
+    response;
+    constructor(url, method, response) {
+        super(`BrowserStack API error: ${url} ${method} ${response.status} ${response.statusText}`);
+        this.url = url;
+        this.method = method;
+        this.response = response;
+    }
+}
+const AUTOMATE_API = 'https://api.browserstack.com/automate';
+export class BrowserStackAutomateClient extends BrowserStackClient {
+    async getPlan() {
+        return await this.doRequest(`${AUTOMATE_API}/plan.json`, 'GET');
+    }
+    async getSessions(buildId, options) {
+        return (await this.doRequest(`${AUTOMATE_API}/builds/${buildId}/sessions.json`, 'GET', options)).map((element) => {
+            return element['automation_session'];
+        });
+    }
+    async getSession(sessionId) {
+        return (await this.doRequest(`${AUTOMATE_API}/sessions/${sessionId}.json`, 'GET'))['automation_session'];
+    }
+    async updateSession(sessionId, options) {
+        return (await this.doRequest(`${AUTOMATE_API}/sessions/${sessionId}.json`, 'PUT', options))['automation_session'];
+    }
+    /**
+     * Deletes a session.
+     * Sessions once deleted cannot be recovered.
+     * @param sessionId
+     */
+    async deleteSession(sessionId) {
+        return this.doRequest(`${AUTOMATE_API}/sessions/${sessionId}.json`, 'DELETE');
+    }
+    async getBuilds(options) {
+        return this.doRequest(`${AUTOMATE_API}/builds.json`, 'GET', options);
+    }
+    async updateBuild(buildId, buildOptions) {
+        return this.doRequest(`${AUTOMATE_API}/builds/${buildId}.json`, 'PUT', buildOptions);
+    }
+}