@wdio/selenium-devtools 0.0.1 → 1.0.0

package/dist/screencast.js

@@ -1,179 +0,0 @@
-import logger from '@wdio/logger';
-import { BLANK_FRAME_THRESHOLD_BYTES, SCREENCAST_DEFAULTS } from './constants.js';
-import { getDriverOriginals } from './driverPatcher.js';
-const log = logger('@wdio/selenium-devtools:ScreencastRecorder');
-// Two strategies:
-//   1. CDP push (Chromium): listens to `Page.screencastFrame` events.
-//   2. Polling fallback: calls unwrapped `takeScreenshot()` at pollIntervalMs.
-// Frames buffer in memory and encode to WebM at stop().
-export class ScreencastRecorder {
-    #frames = [];
-    #cdp = undefined;
-    #cdpFrameListener;
-    #pollTimer;
-    #isRecording = false;
-    #options;
-    #startIndex = 0;
-    #startMarkerSet = false;
-    constructor(options = {}) {
-        this.#options = { ...SCREENCAST_DEFAULTS, ...options };
-    }
-    async start(driver) {
-        if (this.#isRecording) {
-            return;
-        }
-        const cdpOk = await this.#startCdp(driver);
-        if (!cdpOk) {
-            await this.#startPolling(driver);
-        }
-    }
-    async stop() {
-        if (!this.#isRecording) {
-            return;
-        }
-        if (this.#cdp) {
-            await this.#stopCdp();
-        }
-        else if (this.#pollTimer !== undefined) {
-            this.#stopPolling();
-        }
-        this.#isRecording = false;
-    }
-    setStartMarker() {
-        if (!this.#startMarkerSet) {
-            this.#startMarkerSet = true;
-            this.#startIndex = this.#frames.length;
-        }
-    }
-    get frames() {
-        return this.#frames.slice(this.#startIndex);
-    }
-    get duration() {
-        const f = this.frames;
-        if (f.length < 2) {
-            return 0;
-        }
-        return f[f.length - 1].timestamp - f[0].timestamp;
-    }
-    get isRecording() {
-        return this.#isRecording;
-    }
-    // ─── CDP path (Chromium) ─────────────────────────────────────────────────
-    async #startCdp(driver) {
-        if (typeof driver.createCDPConnection !== 'function') {
-            return false;
-        }
-        try {
-            const cdp = await driver.createCDPConnection('page');
-            this.#cdp = cdp;
-            // Listen for frames on the underlying WebSocket. Each CDP event arrives
-            // as a JSON message with method='Page.screencastFrame' and embedded
-            // params. We push to the frame buffer and ack so Chrome keeps streaming.
-            const ws = cdp._wsConnection;
-            if (!ws || typeof ws.on !== 'function') {
-                log.warn('CDP connection has no underlying WebSocket — falling back');
-                return false;
-            }
-            const onMessage = (raw) => {
-                try {
-                    const payload = JSON.parse(raw.toString());
-                    if (payload.method !== 'Page.screencastFrame') {
-                        return;
-                    }
-                    const params = payload.params || {};
-                    const ts = params.metadata?.timestamp !== undefined &&
-                        params.metadata?.timestamp !== null
-                        ? Math.round(params.metadata.timestamp * 1000)
-                        : Date.now();
-                    this.#frames.push({ data: params.data, timestamp: ts });
-                    // Anchor frame 0 at the first content-bearing frame to trim the
-                    // leading about:blank dead-air.
-                    if (!this.#startMarkerSet) {
-                        const decodedSize = Math.floor((params.data?.length ?? 0) * 0.75);
-                        if (decodedSize >= BLANK_FRAME_THRESHOLD_BYTES) {
-                            this.#startIndex = Math.max(0, this.#frames.length - 1);
-                            this.#startMarkerSet = true;
-                        }
-                    }
-                    if (params.sessionId !== undefined) {
-                        cdp.execute('Page.screencastFrameAck', {
-                            sessionId: params.sessionId
-                        });
-                    }
-                }
-                catch {
-                    // ignore non-JSON / non-screencast messages
-                }
-            };
-            this.#cdpFrameListener = onMessage;
-            ws.on('message', onMessage);
-            cdp.execute('Page.startScreencast', {
-                format: this.#options.captureFormat,
-                quality: this.#options.quality,
-                maxWidth: this.#options.maxWidth,
-                maxHeight: this.#options.maxHeight
-            });
-            this.#isRecording = true;
-            log.info('✓ Screencast recording started (CDP mode)');
-            return true;
-        }
-        catch (err) {
-            log.info(`CDP screencast unavailable (${err.message}); will try polling`);
-            return false;
-        }
-    }
-    async #stopCdp() {
-        try {
-            this.#cdp.execute('Page.stopScreencast');
-        }
-        catch (err) {
-            log.warn(`Screencast: error stopping CDP — ${err.message}`);
-        }
-        try {
-            if (this.#cdpFrameListener && this.#cdp?._wsConnection?.off) {
-                this.#cdp._wsConnection.off('message', this.#cdpFrameListener);
-            }
-        }
-        catch {
-            // detach best-effort
-        }
-        log.info(`✓ Screencast stopped — ${this.#frames.length} frame(s) collected`);
-        this.#cdp = undefined;
-        this.#cdpFrameListener = undefined;
-    }
-    // ─── Polling fallback (any browser) ──────────────────────────────────────
-    async #startPolling(driver) {
-        const takeShot = getDriverOriginals().takeScreenshot;
-        if (!takeShot) {
-            log.warn('Screencast unavailable — driver lacks takeScreenshot');
-            return;
-        }
-        try {
-            const first = await takeShot(driver);
-            this.#frames.push({ data: first, timestamp: Date.now() });
-            const intervalMs = this.#options.pollIntervalMs;
-            this.#pollTimer = setInterval(async () => {
-                try {
-                    const data = await takeShot(driver);
-                    this.#frames.push({ data, timestamp: Date.now() });
-                }
-                catch {
-                    this.#stopPolling();
-                }
-            }, intervalMs);
-            this.#isRecording = true;
-            log.info(`✓ Screencast recording started (polling mode, ${intervalMs} ms interval)`);
-        }
-        catch (err) {
-            log.warn(`Screencast unavailable (${err.message}). Recording skipped.`);
-        }
-    }
-    #stopPolling() {
-        if (this.#pollTimer !== undefined) {
-            clearInterval(this.#pollTimer);
-            this.#pollTimer = undefined;
-            log.info(`✓ Screencast stopped — ${this.#frames.length} frame(s) collected`);
-        }
-    }
-}
-//# sourceMappingURL=screencast.js.map

package/dist/screencast.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"screencast.js","sourceRoot":"","sources":["../src/screencast.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,cAAc,CAAA;AACjC,OAAO,EACL,2BAA2B,EAC3B,mBAAmB,EACpB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAOvD,MAAM,GAAG,GAAG,MAAM,CAAC,4CAA4C,CAAC,CAAA;AAEhE,kBAAkB;AAClB,sEAAsE;AACtE,+EAA+E;AAC/E,wDAAwD;AACxD,MAAM,OAAO,kBAAkB;IAC7B,OAAO,GAAsB,EAAE,CAAA;IAC/B,IAAI,GAAQ,SAAS,CAAA;IACrB,iBAAiB,CAAmC;IACpD,UAAU,CAA4C;IACtD,YAAY,GAAG,KAAK,CAAA;IACpB,QAAQ,CAA6B;IACrC,WAAW,GAAG,CAAC,CAAA;IACf,eAAe,GAAG,KAAK,CAAA;IAEvB,YAAY,UAA6B,EAAE;QACzC,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,mBAAmB,EAAE,GAAG,OAAO,EAAE,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAA0B;QACpC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAM;QACR,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QAC1C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAClC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,OAAM;QACR,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;QACvB,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,YAAY,EAAE,CAAA;QACrB,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;IAC3B,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAA;YAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QACxC,CAAC;IACH,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAC7C,CAAC;IAED,IAAI,QAAQ;QACV,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA;QACrB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO,CAAC,CAAA;QACV,CAAC;QACD,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACnD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;IAED,4EAA4E;IAE5E,KAAK,CAAC,SAAS,CAAC,MAA0B;QACxC,IAAI,OAAO,MAAM,CAAC,mBAAmB,KAAK,UAAU,EAAE,CAAC;YACrD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;YACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;YAEf,wEAAwE;YACxE,oEAAoE;YACpE,yEAAyE;YACzE,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,CAAA;YAC5B,IAAI,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;gBACvC,GAAG,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAA;gBACrE,OAAO,KAAK,CAAA;YACd,CAAC;YACD,MAAM,SAAS,GAAG,CAAC,GAAQ,EAAE,EAAE;gBAC7B,IAAI,CAAC;oBACH,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;oBAC1C,IAAI,OAAO,CAAC,MAAM,KAAK,sBAAsB,EAAE,CAAC;wBAC9C,OAAM;oBACR,CAAC;oBACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAA;oBACnC,MAAM,EAAE,GACN,MAAM,CAAC,QAAQ,EAAE,SAAS,KAAK,SAAS;wBACxC,MAAM,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI;wBACjC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;wBAC9C,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;oBAChB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAA;oBACvD,gEAAgE;oBAChE,gCAAgC;oBAChC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;wBAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;wBACjE,IAAI,WAAW,IAAI,2BAA2B,EAAE,CAAC;4BAC/C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;4BACvD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAA;wBAC7B,CAAC;oBACH,CAAC;oBACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;wBACnC,GAAG,CAAC,OAAO,CAAC,yBAAyB,EAAE;4BACrC,SAAS,EAAE,MAAM,CAAC,SAAS;yBAC5B,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;gBAAC,MAAM,CAAC;oBACP,4CAA4C;gBAC9C,CAAC;YACH,CAAC,CAAA;YACD,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAA;YAClC,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YAE3B,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE;gBAClC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa;gBACnC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBAC9B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;gBAChC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;aACnC,CAAC,CAAA;YAEF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;YACxB,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAA;YACrD,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,IAAI,CACN,+BAAgC,GAAa,CAAC,OAAO,qBAAqB,CAC3E,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,IAAI,CAAC,oCAAqC,GAAa,CAAC,OAAO,EAAE,CAAC,CAAA;QACxE,CAAC;QACD,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC;gBAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAChE,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,qBAAqB;QACvB,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,OAAO,CAAC,MAAM,qBAAqB,CAAC,CAAA;QAC5E,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;QACrB,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAA;IACpC,CAAC;IAED,4EAA4E;IAE5E,KAAK,CAAC,aAAa,CAAC,MAA0B;QAC5C,MAAM,QAAQ,GAAG,kBAAkB,EAAE,CAAC,cAAc,CAAA;QACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAA;YAChE,OAAM;QACR,CAAC;QACD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAA;YACpC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEzD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAA;YAC/C,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;gBACvC,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAA;oBACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;gBACpD,CAAC;gBAAC,MAAM,CAAC;oBACP,IAAI,CAAC,YAAY,EAAE,CAAA;gBACrB,CAAC;YACH,CAAC,EAAE,UAAU,CAAC,CAAA;YAEd,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;YACxB,GAAG,CAAC,IAAI,CACN,iDAAiD,UAAU,eAAe,CAC3E,CAAA;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,IAAI,CACN,2BAA4B,GAAa,CAAC,OAAO,uBAAuB,CACzE,CAAA;QACH,CAAC;IACH,CAAC;IAED,YAAY;QACV,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAClC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAC9B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;YAC3B,GAAG,CAAC,IAAI,CACN,0BAA0B,IAAI,CAAC,OAAO,CAAC,MAAM,qBAAqB,CACnE,CAAA;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/session.d.ts

@@ -1,48 +0,0 @@
-import type { CommandLog, ConsoleLog, SeleniumDriverLike } from './types.js';
-export declare class SessionCapturer {
-    #private;
-    bidiActive: boolean;
-    commandsLog: CommandLog[];
-    sources: Map<string, string>;
-    consoleLogs: ConsoleLog[];
-    mutations: any[];
-    traceLogs: string[];
-    networkRequests: any[];
-    metadata?: any;
-    constructor(devtoolsOptions?: {
-        hostname?: string;
-        port?: number;
-    }, driver?: SeleniumDriverLike);
-    setDriver(driver: SeleniumDriverLike): void;
-    awaitClientConnected(): Promise<void>;
-    setClientDisconnectedHandler(fn: () => void): void;
-    cleanup(): void;
-    get isReportingUpstream(): boolean;
-    isConnected(): boolean;
-    waitForConnection(timeoutMs?: number): Promise<boolean>;
-    closeWebSocket(): Promise<void>;
-    sendUpstream(event: string, data: any): void;
-    captureCommand(command: string, args: any[], result: any, error: Error | undefined, testUid?: string, callSource?: string, timestamp?: number): Promise<CommandLog & {
-        _id?: number;
-    }>;
-    sendCommand(command: CommandLog & {
-        _id?: number;
-    }): void;
-    sendReplaceCommand(oldTimestamp: number, command: CommandLog & {
-        _id?: number;
-    }): void;
-    /** Update an existing entry in place (matched by `_id`) for retry coalesce. */
-    replaceCommand(oldId: number, command: string, args: any[], result: any, error: Error | undefined, testUid?: string, callSource?: string, timestamp?: number): {
-        entry: CommandLog & {
-            _id?: number;
-        };
-        oldTimestamp: number;
-    };
-    takeScreenshot(): Promise<string | null>;
-    captureSource(filePath: string): Promise<void>;
-    injectScript(): Promise<void>;
-    captureTrace(): Promise<void>;
-    /** Pulls Chrome browser logs (requires `goog:loggingPrefs: { browser: 'ALL' }`). */
-    captureBrowserLogs(): Promise<void>;
-    isNavigationCommand(command: string): boolean;
-}