@tvlabs/wdio-service 0.1.3 → 0.1.4

package/cjs/channel.js

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TVLabsChannel = void 0;
-const ws_1 = require("ws");
-const phoenix_1 = require("phoenix");
-const webdriverio_1 = require("webdriverio");
-const logger_js_1 = require("./logger.js");
-class TVLabsChannel {
-    endpoint;
-    maxReconnectRetries;
-    key;
-    logLevel;
-    socket;
-    lobbyTopic;
-    requestTopic;
-    log;
-    events = {
-        SESSION_READY: 'session:ready',
-        SESSION_FAILED: 'session:failed',
-        REQUEST_CANCELED: 'request:canceled',
-        REQUEST_FAILED: 'request:failed',
-        REQUEST_FILLED: 'request:filled',
-        REQUEST_MATCHING: 'request:matching',
-    };
-    constructor(endpoint, maxReconnectRetries, key, logLevel) {
-        this.endpoint = endpoint;
-        this.maxReconnectRetries = maxReconnectRetries;
-        this.key = key;
-        this.logLevel = logLevel;
-        this.log = new logger_js_1.Logger('@tvlabs/wdio-channel', this.logLevel);
-        this.socket = new phoenix_1.Socket(this.endpoint, {
-            transport: ws_1.WebSocket,
-            params: this.params(),
-            reconnectAfterMs: this.reconnectAfterMs.bind(this),
-        });
-        this.socket.onError((...args) => TVLabsChannel.logSocketError(this.log, ...args));
-        this.lobbyTopic = this.socket.channel('requests:lobby');
-    }
-    async disconnect() {
-        return new Promise((res, _rej) => {
-            this.lobbyTopic.leave();
-            this.requestTopic?.leave();
-            this.socket.disconnect(() => res());
-        });
-    }
-    async connect() {
-        try {
-            this.log.debug('Connecting to TV Labs...');
-            this.socket.connect();
-            await this.join(this.lobbyTopic);
-            this.log.debug('Connected to TV Labs!');
-        }
-        catch (error) {
-            this.log.error('Error connecting to TV Labs:', error);
-            throw new webdriverio_1.SevereServiceError('Could not connect to TV Labs, please check your connection.');
-        }
-    }
-    async newSession(capabilities, maxRetries, retry = 0) {
-        try {
-            const requestId = await this.requestSession(capabilities);
-            const sessionId = await this.observeRequest(requestId);
-            return sessionId;
-        }
-        catch {
-            return this.handleRetry(capabilities, maxRetries, retry);
-        }
-    }
-    async handleRetry(capabilities, maxRetries, retry) {
-        if (retry < maxRetries) {
-            this.log.warn(`Could not create a session, retrying (${retry + 1}/${maxRetries})`);
-            return this.newSession(capabilities, maxRetries, retry + 1);
-        }
-        else {
-            throw new webdriverio_1.SevereServiceError(`Could not create a session after ${maxRetries} attempts.`);
-        }
-    }
-    async observeRequest(requestId) {
-        const cleanup = () => this.unobserveRequest();
-        return new Promise((res, rej) => {
-            this.requestTopic = this.socket.channel(`requests:${requestId}`);
-            const eventHandlers = {
-                [this.events.REQUEST_MATCHING]: ({ request_id }) => {
-                    this.log.info(`Session request ${request_id} matching...`);
-                },
-                [this.events.REQUEST_FILLED]: ({ session_id, request_id }) => {
-                    this.log.info(`Session request ${request_id} filled: ${this.tvlabsSessionLink(session_id)}`);
-                    this.log.info('Waiting for device to be ready...');
-                },
-                [this.events.SESSION_FAILED]: ({ session_id, reason }) => {
-                    this.log.error(`Session ${session_id} failed, reason: ${reason}`);
-                    rej(reason);
-                },
-                [this.events.REQUEST_CANCELED]: ({ request_id, reason }) => {
-                    this.log.info(`Session request ${request_id} canceled, reason: ${reason}`);
-                    rej(reason);
-                },
-                [this.events.REQUEST_FAILED]: ({ request_id, reason }) => {
-                    this.log.info(`Session request ${request_id} failed, reason: ${reason}`);
-                    rej(reason);
-                },
-                [this.events.SESSION_READY]: ({ session_id }) => {
-                    this.log.info(`Session ${session_id} ready!`);
-                    res(session_id);
-                },
-            };
-            Object.entries(eventHandlers).forEach(([event, handler]) => {
-                this.requestTopic?.on(event, handler);
-            });
-            this.join(this.requestTopic).catch((err) => {
-                rej(err);
-            });
-        }).finally(cleanup);
-    }
-    unobserveRequest() {
-        Object.values(this.events).forEach((event) => {
-            this.requestTopic?.off(event);
-        });
-        this.requestTopic?.leave();
-        this.requestTopic = undefined;
-    }
-    async requestSession(capabilities) {
-        this.log.info('Requesting TV Labs session');
-        try {
-            const response = await this.push(this.lobbyTopic, 'requests:create', { capabilities });
-            this.log.info(`Received session request ID: ${response.request_id}. Waiting for a match...`);
-            return response.request_id;
-        }
-        catch (error) {
-            this.log.error('Error requesting session:', error);
-            throw error;
-        }
-    }
-    async join(topic) {
-        return new Promise((res, rej) => {
-            topic
-                .join()
-                .receive('ok', (_resp) => {
-                res();
-            })
-                .receive('error', ({ response }) => {
-                rej('Failed to join topic: ' + response);
-            })
-                .receive('timeout', () => {
-                rej('timeout');
-            });
-        });
-    }
-    async push(topic, event, payload) {
-        return new Promise((res, rej) => {
-            topic
-                .push(event, payload)
-                .receive('ok', (msg) => {
-                res(msg);
-            })
-                .receive('error', (reason) => {
-                rej(reason);
-            })
-                .receive('timeout', () => {
-                rej('timeout');
-            });
-        });
-    }
-    params() {
-        return {
-            api_key: this.key,
-        };
-    }
-    reconnectAfterMs(tries) {
-        if (tries > this.maxReconnectRetries) {
-            throw new webdriverio_1.SevereServiceError('Could not connect to TV Labs, please check your connection.');
-        }
-        const wait = [0, 1000, 3000, 5000][tries] || 10000;
-        this.log.info(`[${tries}/${this.maxReconnectRetries}] Waiting ${wait}ms before re-attempting to connect...`);
-        return wait;
-    }
-    tvlabsSessionLink(sessionId) {
-        return `https://tvlabs.ai/app/sessions/${sessionId}`;
-    }
-    static logSocketError(log, event, _transport, _establishedConnections) {
-        const error = event.error;
-        log.error('Socket error:', error || event);
-    }
-}
-exports.TVLabsChannel = TVLabsChannel;

package/cjs/logger.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = void 0;
-const LOG_LEVELS = {
-    error: 0,
-    warn: 1,
-    info: 2,
-    debug: 3,
-    trace: 4,
-    silent: 5,
-};
-class Logger {
-    name;
-    logLevel;
-    constructor(name, logLevel = 'info') {
-        this.name = name;
-        this.logLevel = logLevel;
-    }
-    shouldLog(level) {
-        if (this.logLevel === 'silent') {
-            return false;
-        }
-        return LOG_LEVELS[level] <= LOG_LEVELS[this.logLevel];
-    }
-    formatMessage(level, ...args) {
-        const timestamp = new Date().toISOString();
-        return `${timestamp} ${level.toUpperCase()} ${this.name}: ${args
-            .map((arg) => typeof arg === 'object' ? JSON.stringify(arg) : String(arg))
-            .join(' ')}`;
-    }
-    debug(...args) {
-        if (this.shouldLog('debug')) {
-            console.log(this.formatMessage('debug', ...args));
-        }
-    }
-    info(...args) {
-        if (this.shouldLog('info')) {
-            console.log(this.formatMessage('info', ...args));
-        }
-    }
-    warn(...args) {
-        if (this.shouldLog('warn')) {
-            console.warn(this.formatMessage('warn', ...args));
-        }
-    }
-    error(...args) {
-        if (this.shouldLog('error')) {
-            console.error(this.formatMessage('error', ...args));
-        }
-    }
-    trace(...args) {
-        if (this.shouldLog('trace')) {
-            console.trace(this.formatMessage('trace', ...args));
-        }
-    }
-}
-exports.Logger = Logger;

package/cjs/service.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const webdriverio_1 = require("webdriverio");
-const crypto = require("crypto");
-const channel_js_1 = require("./channel.js");
-const logger_js_1 = require("./logger.js");
-class TVLabsService {
-    _options;
-    _capabilities;
-    _config;
-    log;
-    constructor(_options, _capabilities, _config) {
-        this._options = _options;
-        this._capabilities = _capabilities;
-        this._config = _config;
-        this.log = new logger_js_1.Logger('@tvlabs/wdio-server', this._config.logLevel);
-        if (this.attachRequestId()) {
-            this.setupRequestId();
-        }
-    }
-    onPrepare(_config, param) {
-        if (!Array.isArray(param)) {
-            throw new webdriverio_1.SevereServiceError('Multi-remote capabilities are not implemented. Contact TV Labs support if you are interested in this feature.');
-        }
-    }
-    async beforeSession(_config, capabilities, _specs, _cid) {
-        const channel = new channel_js_1.TVLabsChannel(this.endpoint(), this.reconnectRetries(), this.apiKey(), this.logLevel());
-        await channel.connect();
-        capabilities['tvlabs:session_id'] = await channel.newSession(capabilities, this.retries());
-        await channel.disconnect();
-    }
-    setupRequestId() {
-        const originalTransformRequest = this._config.transformRequest;
-        this._config.transformRequest = (requestOptions) => {
-            const requestId = crypto.randomUUID();
-            const originalRequestOptions = typeof originalTransformRequest === 'function'
-                ? originalTransformRequest(requestOptions)
-                : requestOptions;
-            if (typeof originalRequestOptions.headers === 'undefined') {
-                originalRequestOptions.headers = {};
-            }
-            this.setRequestHeader(originalRequestOptions.headers, 'x-request-id', requestId);
-            this.log.info('ATTACHED REQUEST ID', requestId);
-            return originalRequestOptions;
-        };
-    }
-    setRequestHeader(headers, header, value) {
-        if (headers instanceof Headers) {
-            headers.set(header, value);
-        }
-        else if (typeof headers === 'object') {
-            if (Array.isArray(headers)) {
-                headers.push([header, value]);
-            }
-            else {
-                headers[header] = value;
-            }
-        }
-    }
-    endpoint() {
-        return this._options.endpoint ?? 'wss://tvlabs.ai/appium';
-    }
-    retries() {
-        return this._options.retries ?? 3;
-    }
-    apiKey() {
-        return this._options.apiKey;
-    }
-    logLevel() {
-        return this._config.logLevel ?? 'info';
-    }
-    attachRequestId() {
-        return this._options.attachRequestId ?? true;
-    }
-    reconnectRetries() {
-        return this._options.reconnectRetries ?? 5;
-    }
-}
-exports.default = TVLabsService;

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/channel.js

@@ -1,180 +0,0 @@
-import { WebSocket } from 'ws';
-import { Socket } from 'phoenix';
-import { SevereServiceError } from 'webdriverio';
-import { Logger } from './logger.js';
-export class TVLabsChannel {
-    endpoint;
-    maxReconnectRetries;
-    key;
-    logLevel;
-    socket;
-    lobbyTopic;
-    requestTopic;
-    log;
-    events = {
-        SESSION_READY: 'session:ready',
-        SESSION_FAILED: 'session:failed',
-        REQUEST_CANCELED: 'request:canceled',
-        REQUEST_FAILED: 'request:failed',
-        REQUEST_FILLED: 'request:filled',
-        REQUEST_MATCHING: 'request:matching',
-    };
-    constructor(endpoint, maxReconnectRetries, key, logLevel) {
-        this.endpoint = endpoint;
-        this.maxReconnectRetries = maxReconnectRetries;
-        this.key = key;
-        this.logLevel = logLevel;
-        this.log = new Logger('@tvlabs/wdio-channel', this.logLevel);
-        this.socket = new Socket(this.endpoint, {
-            transport: WebSocket,
-            params: this.params(),
-            reconnectAfterMs: this.reconnectAfterMs.bind(this),
-        });
-        this.socket.onError((...args) => TVLabsChannel.logSocketError(this.log, ...args));
-        this.lobbyTopic = this.socket.channel('requests:lobby');
-    }
-    async disconnect() {
-        return new Promise((res, _rej) => {
-            this.lobbyTopic.leave();
-            this.requestTopic?.leave();
-            this.socket.disconnect(() => res());
-        });
-    }
-    async connect() {
-        try {
-            this.log.debug('Connecting to TV Labs...');
-            this.socket.connect();
-            await this.join(this.lobbyTopic);
-            this.log.debug('Connected to TV Labs!');
-        }
-        catch (error) {
-            this.log.error('Error connecting to TV Labs:', error);
-            throw new SevereServiceError('Could not connect to TV Labs, please check your connection.');
-        }
-    }
-    async newSession(capabilities, maxRetries, retry = 0) {
-        try {
-            const requestId = await this.requestSession(capabilities);
-            const sessionId = await this.observeRequest(requestId);
-            return sessionId;
-        }
-        catch {
-            return this.handleRetry(capabilities, maxRetries, retry);
-        }
-    }
-    async handleRetry(capabilities, maxRetries, retry) {
-        if (retry < maxRetries) {
-            this.log.warn(`Could not create a session, retrying (${retry + 1}/${maxRetries})`);
-            return this.newSession(capabilities, maxRetries, retry + 1);
-        }
-        else {
-            throw new SevereServiceError(`Could not create a session after ${maxRetries} attempts.`);
-        }
-    }
-    async observeRequest(requestId) {
-        const cleanup = () => this.unobserveRequest();
-        return new Promise((res, rej) => {
-            this.requestTopic = this.socket.channel(`requests:${requestId}`);
-            const eventHandlers = {
-                [this.events.REQUEST_MATCHING]: ({ request_id }) => {
-                    this.log.info(`Session request ${request_id} matching...`);
-                },
-                [this.events.REQUEST_FILLED]: ({ session_id, request_id }) => {
-                    this.log.info(`Session request ${request_id} filled: ${this.tvlabsSessionLink(session_id)}`);
-                    this.log.info('Waiting for device to be ready...');
-                },
-                [this.events.SESSION_FAILED]: ({ session_id, reason }) => {
-                    this.log.error(`Session ${session_id} failed, reason: ${reason}`);
-                    rej(reason);
-                },
-                [this.events.REQUEST_CANCELED]: ({ request_id, reason }) => {
-                    this.log.info(`Session request ${request_id} canceled, reason: ${reason}`);
-                    rej(reason);
-                },
-                [this.events.REQUEST_FAILED]: ({ request_id, reason }) => {
-                    this.log.info(`Session request ${request_id} failed, reason: ${reason}`);
-                    rej(reason);
-                },
-                [this.events.SESSION_READY]: ({ session_id }) => {
-                    this.log.info(`Session ${session_id} ready!`);
-                    res(session_id);
-                },
-            };
-            Object.entries(eventHandlers).forEach(([event, handler]) => {
-                this.requestTopic?.on(event, handler);
-            });
-            this.join(this.requestTopic).catch((err) => {
-                rej(err);
-            });
-        }).finally(cleanup);
-    }
-    unobserveRequest() {
-        Object.values(this.events).forEach((event) => {
-            this.requestTopic?.off(event);
-        });
-        this.requestTopic?.leave();
-        this.requestTopic = undefined;
-    }
-    async requestSession(capabilities) {
-        this.log.info('Requesting TV Labs session');
-        try {
-            const response = await this.push(this.lobbyTopic, 'requests:create', { capabilities });
-            this.log.info(`Received session request ID: ${response.request_id}. Waiting for a match...`);
-            return response.request_id;
-        }
-        catch (error) {
-            this.log.error('Error requesting session:', error);
-            throw error;
-        }
-    }
-    async join(topic) {
-        return new Promise((res, rej) => {
-            topic
-                .join()
-                .receive('ok', (_resp) => {
-                res();
-            })
-                .receive('error', ({ response }) => {
-                rej('Failed to join topic: ' + response);
-            })
-                .receive('timeout', () => {
-                rej('timeout');
-            });
-        });
-    }
-    async push(topic, event, payload) {
-        return new Promise((res, rej) => {
-            topic
-                .push(event, payload)
-                .receive('ok', (msg) => {
-                res(msg);
-            })
-                .receive('error', (reason) => {
-                rej(reason);
-            })
-                .receive('timeout', () => {
-                rej('timeout');
-            });
-        });
-    }
-    params() {
-        return {
-            api_key: this.key,
-        };
-    }
-    reconnectAfterMs(tries) {
-        if (tries > this.maxReconnectRetries) {
-            throw new SevereServiceError('Could not connect to TV Labs, please check your connection.');
-        }
-        const wait = [0, 1000, 3000, 5000][tries] || 10000;
-        this.log.info(`[${tries}/${this.maxReconnectRetries}] Waiting ${wait}ms before re-attempting to connect...`);
-        return wait;
-    }
-    tvlabsSessionLink(sessionId) {
-        return `https://tvlabs.ai/app/sessions/${sessionId}`;
-    }
-    static logSocketError(log, event, _transport, _establishedConnections) {
-        const error = event.error;
-        log.error('Socket error:', error || event);
-    }
-}

package/esm/logger.js

@@ -1,53 +0,0 @@
-const LOG_LEVELS = {
-    error: 0,
-    warn: 1,
-    info: 2,
-    debug: 3,
-    trace: 4,
-    silent: 5,
-};
-export class Logger {
-    name;
-    logLevel;
-    constructor(name, logLevel = 'info') {
-        this.name = name;
-        this.logLevel = logLevel;
-    }
-    shouldLog(level) {
-        if (this.logLevel === 'silent') {
-            return false;
-        }
-        return LOG_LEVELS[level] <= LOG_LEVELS[this.logLevel];
-    }
-    formatMessage(level, ...args) {
-        const timestamp = new Date().toISOString();
-        return `${timestamp} ${level.toUpperCase()} ${this.name}: ${args
-            .map((arg) => typeof arg === 'object' ? JSON.stringify(arg) : String(arg))
-            .join(' ')}`;
-    }
-    debug(...args) {
-        if (this.shouldLog('debug')) {
-            console.log(this.formatMessage('debug', ...args));
-        }
-    }
-    info(...args) {
-        if (this.shouldLog('info')) {
-            console.log(this.formatMessage('info', ...args));
-        }
-    }
-    warn(...args) {
-        if (this.shouldLog('warn')) {
-            console.warn(this.formatMessage('warn', ...args));
-        }
-    }
-    error(...args) {
-        if (this.shouldLog('error')) {
-            console.error(this.formatMessage('error', ...args));
-        }
-    }
-    trace(...args) {
-        if (this.shouldLog('trace')) {
-            console.trace(this.formatMessage('trace', ...args));
-        }
-    }
-}

package/esm/service.js

@@ -1,76 +0,0 @@
-import { SevereServiceError } from 'webdriverio';
-import * as crypto from 'crypto';
-import { TVLabsChannel } from './channel.js';
-import { Logger } from './logger.js';
-export default class TVLabsService {
-    _options;
-    _capabilities;
-    _config;
-    log;
-    constructor(_options, _capabilities, _config) {
-        this._options = _options;
-        this._capabilities = _capabilities;
-        this._config = _config;
-        this.log = new Logger('@tvlabs/wdio-server', this._config.logLevel);
-        if (this.attachRequestId()) {
-            this.setupRequestId();
-        }
-    }
-    onPrepare(_config, param) {
-        if (!Array.isArray(param)) {
-            throw new SevereServiceError('Multi-remote capabilities are not implemented. Contact TV Labs support if you are interested in this feature.');
-        }
-    }
-    async beforeSession(_config, capabilities, _specs, _cid) {
-        const channel = new TVLabsChannel(this.endpoint(), this.reconnectRetries(), this.apiKey(), this.logLevel());
-        await channel.connect();
-        capabilities['tvlabs:session_id'] = await channel.newSession(capabilities, this.retries());
-        await channel.disconnect();
-    }
-    setupRequestId() {
-        const originalTransformRequest = this._config.transformRequest;
-        this._config.transformRequest = (requestOptions) => {
-            const requestId = crypto.randomUUID();
-            const originalRequestOptions = typeof originalTransformRequest === 'function'
-                ? originalTransformRequest(requestOptions)
-                : requestOptions;
-            if (typeof originalRequestOptions.headers === 'undefined') {
-                originalRequestOptions.headers = {};
-            }
-            this.setRequestHeader(originalRequestOptions.headers, 'x-request-id', requestId);
-            this.log.info('ATTACHED REQUEST ID', requestId);
-            return originalRequestOptions;
-        };
-    }
-    setRequestHeader(headers, header, value) {
-        if (headers instanceof Headers) {
-            headers.set(header, value);
-        }
-        else if (typeof headers === 'object') {
-            if (Array.isArray(headers)) {
-                headers.push([header, value]);
-            }
-            else {
-                headers[header] = value;
-            }
-        }
-    }
-    endpoint() {
-        return this._options.endpoint ?? 'wss://tvlabs.ai/appium';
-    }
-    retries() {
-        return this._options.retries ?? 3;
-    }
-    apiKey() {
-        return this._options.apiKey;
-    }
-    logLevel() {
-        return this._config.logLevel ?? 'info';
-    }
-    attachRequestId() {
-        return this._options.attachRequestId ?? true;
-    }
-    reconnectRetries() {
-        return this._options.reconnectRetries ?? 5;
-    }
-}

package/esm/types.js

@@ -1 +0,0 @@
-export {};