@tvlabs/wdio-service 0.1.0 → 0.1.2

package/README.md

@@ -14,6 +14,8 @@ The `@tvlabs/wdio-service` package uses a websocket to connect to the TV Labs pl
 
 The service first makes a session request, and then subscribes to events for that request. Once the session has been filled and is ready for the Webdriver script to begin, the service receives a ready event with the TV Labs session ID. This session ID is injected into the capabilities as `tvlabs:session_id` on the Webdriver session create request.
 
+Additionally, the service adds a unique request ID for each request made. The service will generate and attach an `x-request-id` header before each request to the TV Labs platform. This can be used to correlate requests in the client side logs to the Appium server logs.
+
 ## Installation
 
 In your WebdriverIO project, run one of the following commands to install:
@@ -40,12 +42,10 @@ To use this as a WebdriverIO test runner service, include the service in your We
 import TVLabsService from '@tvlabs/wdio-service';
 
 export const config = {
-    // ...
-    services: [
-        [TVLabsService, apiKey: process.env.TVLABS_API_KEY]
-    ],
-    // ...
-}
+  // ...
+  services: [[TVLabsService, { apiKey: process.env.TVLABS_API_KEY }]],
+  // ...
+};
 ```
 
 ### WebdriverIO Remote
@@ -113,3 +113,10 @@ run();
 - **Required:** No
 - **Default:** `5`
 - **Description:** Maximum number of attempts to re-connect if the connection to TV Labs is lost.
+
+### `attachRequestId`
+
+- **Type:** `boolean`
+- **Required:** No
+- **Default:** `true`
+- **Description:** Controls whether or not to attach an `x-request-id` header to each request made to the TV Labs platform.

package/{dist → cjs}/channel.d.ts

@@ -1,13 +1,15 @@
-import type { TVLabsCapabilities } from './types.js';
+import type { TVLabsCapabilities, LogLevel } from './types.js';
 export declare class TVLabsChannel {
     private endpoint;
     private maxReconnectRetries;
     private key;
+    private logLevel;
     private socket;
     private lobbyTopic;
     private requestTopic?;
+    private log;
     private readonly events;
-    constructor(endpoint: string, maxReconnectRetries: number, key: string);
+    constructor(endpoint: string, maxReconnectRetries: number, key: string, logLevel: LogLevel);
     disconnect(): Promise<void>;
     connect(): Promise<void>;
     newSession(capabilities: TVLabsCapabilities, maxRetries: number, retry?: number): Promise<string>;

package/cjs/channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,kBAAkB,EAIlB,QAAQ,EACT,MAAM,YAAY,CAAC;AAGpB,qBAAa,aAAa;IAgBtB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,mBAAmB;IAC3B,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,QAAQ;IAlBlB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,YAAY,CAAC,CAAU;IAC/B,OAAO,CAAC,GAAG,CAAS;IAEpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAOZ;gBAGD,QAAQ,EAAE,MAAM,EAChB,mBAAmB,EAAE,MAAM,EAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,QAAQ;IActB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBxB,UAAU,CACd,YAAY,EAAE,kBAAkB,EAChC,UAAU,EAAE,MAAM,EAClB,KAAK,SAAI,GACR,OAAO,CAAC,MAAM,CAAC;YAWJ,WAAW;YAkBX,cAAc;IAsD5B,OAAO,CAAC,gBAAgB;YAUV,cAAc;YAuBd,IAAI;YAgBJ,IAAI;IAoBlB,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,iBAAiB;CAG1B"}

package/cjs/channel.js

@@ -0,0 +1,185 @@
+"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(this.logSocketError);
+        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;
+    }
+    logSocketError(event, _transport, _establishedConnections) {
+        const error = event.error;
+        const code = error && error.code;
+        this.log.error('Socket error:', code || error || event);
+    }
+    tvlabsSessionLink(sessionId) {
+        return `https://tvlabs.ai/app/sessions/${sessionId}`;
+    }
+}
+exports.TVLabsChannel = TVLabsChannel;

package/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const service_js_1 = require("./service.js");
+exports.default = service_js_1.default;
+__exportStar(require("./types.js"), exports);

package/cjs/logger.d.ts

@@ -0,0 +1,14 @@
+import type { LogLevel } from './types.js';
+export declare class Logger {
+    private name;
+    private logLevel;
+    constructor(name: string, logLevel?: LogLevel);
+    private shouldLog;
+    private formatMessage;
+    debug(...args: unknown[]): void;
+    info(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    error(...args: unknown[]): void;
+    trace(...args: unknown[]): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/cjs/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAwB3C,qBAAa,MAAM;IAEf,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,QAAQ;gBADR,IAAI,EAAE,MAAM,EACZ,QAAQ,GAAE,QAAiB;IAGrC,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,aAAa;IAUrB,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAM/B,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAM9B,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAM9B,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAM/B,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;CAKhC"}

package/cjs/logger.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const chalk_1 = require("chalk");
+const LOG_LEVEL_COLORS = {
+    error: chalk_1.default.red,
+    warn: chalk_1.default.yellow,
+    info: chalk_1.default.cyanBright,
+    debug: chalk_1.default.green,
+    trace: chalk_1.default.cyan,
+    silent: chalk_1.default.gray,
+};
+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();
+        const levelColor = LOG_LEVEL_COLORS[level];
+        return `${chalk_1.default.gray(timestamp)} ${levelColor(level.toUpperCase())} ${chalk_1.default.white(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/package.json

@@ -0,0 +1 @@
+{"type": "commonjs"}

package/{dist → cjs}/service.d.ts

@@ -4,12 +4,17 @@ export default class TVLabsService implements Services.ServiceInstance {
     private _options;
     private _capabilities;
     private _config;
+    private log;
     constructor(_options: TVLabsServiceOptions, _capabilities: Capabilities.ResolvedTestrunnerCapabilities, _config: Options.WebdriverIO);
     onPrepare(_config: Options.Testrunner, param: Capabilities.TestrunnerCapabilities): void;
     beforeSession(_config: Omit<Options.Testrunner, 'capabilities'>, capabilities: TVLabsCapabilities, _specs: string[], _cid: string): Promise<void>;
+    private setupRequestId;
+    private setRequestHeader;
     private endpoint;
     private retries;
     private apiKey;
+    private logLevel;
+    private attachRequestId;
     private reconnectRetries;
 }
 //# sourceMappingURL=service.d.ts.map

package/cjs/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EAErB,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ,CAAC,eAAe;IAIlE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IALjB,OAAO,CAAC,GAAG,CAAS;gBAGV,QAAQ,EAAE,oBAAoB,EAC9B,aAAa,EAAE,YAAY,CAAC,8BAA8B,EAC1D,OAAO,EAAE,OAAO,CAAC,WAAW;IAQtC,SAAS,CACP,OAAO,EAAE,OAAO,CAAC,UAAU,EAC3B,KAAK,EAAE,YAAY,CAAC,sBAAsB;IAStC,aAAa,CACjB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,EACjD,YAAY,EAAE,kBAAkB,EAChC,MAAM,EAAE,MAAM,EAAE,EAChB,IAAI,EAAE,MAAM;IAmBd,OAAO,CAAC,cAAc;IA0BtB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,gBAAgB;CAGzB"}

package/cjs/service.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const webdriverio_1 = require("webdriverio");
+const crypto = require("crypto");
+const chalk_1 = require("chalk");
+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(chalk_1.default.blue('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/{dist → cjs}/types.d.ts

@@ -1,9 +1,11 @@
 import type { Capabilities } from '@wdio/types';
+export type LogLevel = 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
 export type TVLabsServiceOptions = {
     apiKey: string;
     endpoint?: string;
     retries?: number;
     reconnectRetries?: number;
+    attachRequestId?: boolean;
 };
 export type TVLabsCapabilities = Capabilities.RequestedStandaloneCapabilities & {
     'tvlabs:session_id'?: string;

package/cjs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEhF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC5B,YAAY,CAAC,+BAA+B,GAAG;IAC7C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,kCAAkC,CAAC,EAAE,MAAM,CAAC;QAC5C,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC,CAAC;IACF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,CAAC;AAEJ,MAAM,MAAM,gCAAgC,GAAG,CAC7C,QAAQ,EAAE,0BAA0B,KACjC,IAAI,CAAC;AAEV,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/cjs/types.js

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

package/esm/channel.d.ts

@@ -0,0 +1,27 @@
+import type { TVLabsCapabilities, LogLevel } from './types.js';
+export declare class TVLabsChannel {
+    private endpoint;
+    private maxReconnectRetries;
+    private key;
+    private logLevel;
+    private socket;
+    private lobbyTopic;
+    private requestTopic?;
+    private log;
+    private readonly events;
+    constructor(endpoint: string, maxReconnectRetries: number, key: string, logLevel: LogLevel);
+    disconnect(): Promise<void>;
+    connect(): Promise<void>;
+    newSession(capabilities: TVLabsCapabilities, maxRetries: number, retry?: number): Promise<string>;
+    private handleRetry;
+    private observeRequest;
+    private unobserveRequest;
+    private requestSession;
+    private join;
+    private push;
+    private params;
+    private reconnectAfterMs;
+    private logSocketError;
+    private tvlabsSessionLink;
+}
+//# sourceMappingURL=channel.d.ts.map

package/esm/channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,kBAAkB,EAIlB,QAAQ,EACT,MAAM,YAAY,CAAC;AAGpB,qBAAa,aAAa;IAgBtB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,mBAAmB;IAC3B,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,QAAQ;IAlBlB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,YAAY,CAAC,CAAU;IAC/B,OAAO,CAAC,GAAG,CAAS;IAEpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAOZ;gBAGD,QAAQ,EAAE,MAAM,EAChB,mBAAmB,EAAE,MAAM,EAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,QAAQ;IActB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBxB,UAAU,CACd,YAAY,EAAE,kBAAkB,EAChC,UAAU,EAAE,MAAM,EAClB,KAAK,SAAI,GACR,OAAO,CAAC,MAAM,CAAC;YAWJ,WAAW;YAkBX,cAAc;IAsD5B,OAAO,CAAC,gBAAgB;YAUV,cAAc;YAuBd,IAAI;YAgBJ,IAAI;IAoBlB,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,iBAAiB;CAG1B"}

package/{dist → esm}/channel.js

@@ -1,15 +1,16 @@
+import { WebSocket } from 'ws';
 import { Socket } from 'phoenix';
-import WebSocket from 'ws';
-import logger from '@wdio/logger';
 import { SevereServiceError } from 'webdriverio';
-const log = logger('wdio-tvlabs-service');
+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',
@@ -18,10 +19,12 @@ export class TVLabsChannel {
         REQUEST_FILLED: 'request:filled',
         REQUEST_MATCHING: 'request:matching',
     };
-    constructor(endpoint, maxReconnectRetries, key) {
+    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(),
@@ -39,13 +42,13 @@ export class TVLabsChannel {
     }
     async connect() {
         try {
-            log.debug('Connecting to TV Labs...');
+            this.log.debug('Connecting to TV Labs...');
             this.socket.connect();
             await this.join(this.lobbyTopic);
-            log.debug('Connected to TV Labs!');
+            this.log.debug('Connected to TV Labs!');
         }
         catch (error) {
-            log.error('Error connecting to TV Labs:', error);
+            this.log.error('Error connecting to TV Labs:', error);
             throw new SevereServiceError('Could not connect to TV Labs, please check your connection.');
         }
     }
@@ -61,7 +64,7 @@ export class TVLabsChannel {
     }
     async handleRetry(capabilities, maxRetries, retry) {
         if (retry < maxRetries) {
-            log.warn(`Could not create a session, retrying (${retry + 1}/${maxRetries})`);
+            this.log.warn(`Could not create a session, retrying (${retry + 1}/${maxRetries})`);
             return this.newSession(capabilities, maxRetries, retry + 1);
         }
         else {
@@ -74,26 +77,26 @@ export class TVLabsChannel {
             this.requestTopic = this.socket.channel(`requests:${requestId}`);
             const eventHandlers = {
                 [this.events.REQUEST_MATCHING]: ({ request_id }) => {
-                    log.info(`Session request ${request_id} matching...`);
+                    this.log.info(`Session request ${request_id} matching...`);
                 },
                 [this.events.REQUEST_FILLED]: ({ session_id, request_id }) => {
-                    log.info(`Session request ${request_id} filled: ${this.tvlabsSessionLink(session_id)}`);
-                    log.info('Waiting for device to be ready...');
+                    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 }) => {
-                    log.error(`Session ${session_id} failed, reason: ${reason}`);
+                    this.log.error(`Session ${session_id} failed, reason: ${reason}`);
                     rej(reason);
                 },
                 [this.events.REQUEST_CANCELED]: ({ request_id, reason }) => {
-                    log.info(`Session request ${request_id} canceled, reason: ${reason}`);
+                    this.log.info(`Session request ${request_id} canceled, reason: ${reason}`);
                     rej(reason);
                 },
                 [this.events.REQUEST_FAILED]: ({ request_id, reason }) => {
-                    log.info(`Session request ${request_id} failed, reason: ${reason}`);
+                    this.log.info(`Session request ${request_id} failed, reason: ${reason}`);
                     rej(reason);
                 },
                 [this.events.SESSION_READY]: ({ session_id }) => {
-                    log.info(`Session ${session_id} ready!`);
+                    this.log.info(`Session ${session_id} ready!`);
                     res(session_id);
                 },
             };
@@ -113,14 +116,14 @@ export class TVLabsChannel {
         this.requestTopic = undefined;
     }
     async requestSession(capabilities) {
-        log.info('Requesting TV Labs session');
+        this.log.info('Requesting TV Labs session');
         try {
             const response = await this.push(this.lobbyTopic, 'requests:create', { capabilities });
-            log.info(`Received session request ID: ${response.request_id}. Waiting for a match...`);
+            this.log.info(`Received session request ID: ${response.request_id}. Waiting for a match...`);
             return response.request_id;
         }
         catch (error) {
-            log.error('Error requesting session:', error);
+            this.log.error('Error requesting session:', error);
             throw error;
         }
     }
@@ -164,13 +167,13 @@ export class TVLabsChannel {
             throw new SevereServiceError('Could not connect to TV Labs, please check your connection.');
         }
         const wait = [0, 1000, 3000, 5000][tries] || 10000;
-        log.info(`[${tries}/${this.maxReconnectRetries}] Waiting ${wait}ms before re-attempting to connect...`);
+        this.log.info(`[${tries}/${this.maxReconnectRetries}] Waiting ${wait}ms before re-attempting to connect...`);
         return wait;
     }
     logSocketError(event, _transport, _establishedConnections) {
         const error = event.error;
         const code = error && error.code;
-        log.error('Socket error:', code || error || event);
+        this.log.error('Socket error:', code || error || event);
     }
     tvlabsSessionLink(sessionId) {
         return `https://tvlabs.ai/app/sessions/${sessionId}`;

package/esm/index.d.ts

@@ -0,0 +1,4 @@
+import TVLabsService from './service.js';
+export default TVLabsService;
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,cAAc,CAAC;AAEzC,eAAe,aAAa,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/esm/logger.d.ts

@@ -0,0 +1,14 @@
+import type { LogLevel } from './types.js';
+export declare class Logger {
+    private name;
+    private logLevel;
+    constructor(name: string, logLevel?: LogLevel);
+    private shouldLog;
+    private formatMessage;
+    debug(...args: unknown[]): void;
+    info(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    error(...args: unknown[]): void;
+    trace(...args: unknown[]): void;
+}
+//# sourceMappingURL=logger.d.ts.map