@tvlabs/wdio-service 0.1.3 → 0.1.4

package/esm/index.js

@@ -1,4 +1,332 @@
-import TVLabsService from './service.js';
-export { TVLabsService };
-export default TVLabsService;
-export * from './types.js';
+import { SevereServiceError } from 'webdriverio';
+import * as crypto from 'crypto';
+import { WebSocket } from 'ws';
+import { Socket } from 'phoenix';
+
+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));
+        }
+    }
+}
+
+var name = "@tvlabs/wdio-service";
+var version = "0.1.4";
+var packageJson = {
+	name: name,
+	version: version};
+
+function getServiceInfo() {
+    return {
+        service_name: getServiceName(),
+        service_version: getServiceVersion(),
+    };
+}
+function getServiceVersion() {
+    return packageJson.version;
+}
+function getServiceName() {
+    return packageJson.name;
+}
+
+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 = 'info') {
+        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() {
+        const serviceInfo = getServiceInfo();
+        this.log.debug('Info:', serviceInfo);
+        return {
+            ...serviceInfo,
+            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);
+    }
+}
+
+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;
+    }
+}
+
+export { TVLabsService, TVLabsService as default };

package/esm/package.json

@@ -1 +1,3 @@
-{"type": "module"}
+{
+  "type": "module"
+}

package/esm/types.d.ts

@@ -31,7 +31,11 @@ export type TVLabsSessionRequestUpdate = {
 export type TVLabsSessionRequestResponse = {
     request_id: string;
 };
-export type TVLabsSessionChannelParams = {
+export type TVLabsSocketParams = TVLabsServiceInfo & {
     api_key: string;
 };
+export type TVLabsServiceInfo = {
+    service_version: string;
+    service_name: string;
+};
 //# sourceMappingURL=types.d.ts.map

package/esm/types.d.ts.map

@@ -1 +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"}
+{"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,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/esm/utils.d.ts

@@ -0,0 +1,5 @@
+import { TVLabsServiceInfo } from './types.js';
+export declare function getServiceInfo(): TVLabsServiceInfo;
+export declare function getServiceVersion(): string;
+export declare function getServiceName(): string;
+//# sourceMappingURL=utils.d.ts.map

package/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAG/C,wBAAgB,cAAc,IAAI,iBAAiB,CAKlD;AAED,wBAAgB,iBAAiB,IAAI,MAAM,CAE1C;AAED,wBAAgB,cAAc,IAAI,MAAM,CAEvC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tvlabs/wdio-service",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "WebdriverIO service that provides a better integration into TV Labs",
   "author": "Regan Karlewicz <regan@tvlabs.ai>",
   "license": "Apache-2.0",
@@ -22,9 +22,7 @@
     "url": "https://github.com/tv-labs/wdio-tvlabs-service/issues"
   },
   "scripts": {
-    "build": "npm run build:cjs && npm run build:esm",
-    "build:cjs": "tsc -p src --module commonjs --moduleResolution node --outDir cjs && echo '{\"type\": \"commonjs\"}' > cjs/package.json",
-    "build:esm": "tsc -p src --outDir esm && echo '{\"type\": \"module\"}' > esm/package.json",
+    "build": "npm run clean && rollup -c",
     "start": "ts-node src/index.ts",
     "dev": "ts-node --transpile-only src/index.ts",
     "clean": "rm -rf cjs && rm -rf esm",
@@ -44,6 +42,10 @@
   "typeScriptVersion": "5.8.2",
   "devDependencies": {
     "@eslint/js": "^9.22.0",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@types/node": "^22.13.10",
     "@types/phoenix": "^1.6.6",
     "@types/ws": "^8.18.0",
@@ -56,6 +58,7 @@
     "globals": "^16.0.0",
     "jiti": "^2.4.2",
     "prettier": "^3.5.3",
+    "rollup": "^4.45.1",
     "typescript": "^5.8.2",
     "typescript-eslint": "^8.36.0",
     "vitest": "^3.0.9",

package/rollup.config.js

@@ -0,0 +1,53 @@
+import typescript from '@rollup/plugin-typescript';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+import { writeFileSync, mkdirSync } from 'fs';
+import path from 'path';
+
+const createPackageJson = (dir, type) => ({
+  name: `create-package-json-${type}`,
+  generateBundle() {
+    const content = JSON.stringify({ type }, null, 2);
+    mkdirSync(dir, { recursive: true });
+    writeFileSync(path.join(dir, 'package.json'), content);
+  },
+});
+
+const external = (id) => !id.startsWith('.') && !path.isAbsolute(id);
+
+const plugins = (outDir) => [
+  nodeResolve({
+    preferBuiltins: true,
+    exportConditions: ['node'],
+  }),
+  json(),
+  commonjs(),
+  typescript({
+    tsconfig: 'src/tsconfig.json',
+    outDir,
+  }),
+  createPackageJson(outDir, outDir === 'esm' ? 'module' : 'commonjs'),
+];
+
+export default [
+  {
+    input: './src/index.ts',
+    output: {
+      dir: 'esm',
+      format: 'esm',
+    },
+    external,
+    plugins: plugins('esm'),
+  },
+  {
+    input: './src/index.ts',
+    output: {
+      dir: 'cjs',
+      format: 'cjs',
+      exports: 'named',
+    },
+    external,
+    plugins: plugins('cjs'),
+  },
+];

package/src/channel.ts

@@ -2,10 +2,11 @@ import { WebSocket } from 'ws';
 import { Socket, type Channel } from 'phoenix';
 import { SevereServiceError } from 'webdriverio';
 import { Logger } from './logger.js';
+import { getServiceInfo } from './utils.js';
 
 import type {
   TVLabsCapabilities,
-  TVLabsSessionChannelParams,
+  TVLabsSocketParams,
   TVLabsSessionRequestEventHandler,
   TVLabsSessionRequestResponse,
   LogLevel,
@@ -31,7 +32,7 @@ export class TVLabsChannel {
     private endpoint: string,
     private maxReconnectRetries: number,
     private key: string,
-    private logLevel: LogLevel,
+    private logLevel: LogLevel = 'info',
   ) {
     this.log = new Logger('@tvlabs/wdio-channel', this.logLevel);
     this.socket = new Socket(this.endpoint, {
@@ -228,8 +229,13 @@ export class TVLabsChannel {
     });
   }
 
-  private params(): TVLabsSessionChannelParams {
+  private params(): TVLabsSocketParams {
+    const serviceInfo = getServiceInfo();
+
+    this.log.debug('Info:', serviceInfo);
+
     return {
+      ...serviceInfo,
       api_key: this.key,
     };
   }

package/src/types.ts

@@ -41,6 +41,11 @@ export type TVLabsSessionRequestResponse = {
   request_id: string;
 };
 
-export type TVLabsSessionChannelParams = {
+export type TVLabsSocketParams = TVLabsServiceInfo & {
   api_key: string;
 };
+
+export type TVLabsServiceInfo = {
+  service_version: string;
+  service_name: string;
+};

package/src/utils.ts

@@ -0,0 +1,17 @@
+import { TVLabsServiceInfo } from './types.js';
+import packageJson from '../package.json';
+
+export function getServiceInfo(): TVLabsServiceInfo {
+  return {
+    service_name: getServiceName(),
+    service_version: getServiceVersion(),
+  };
+}
+
+export function getServiceVersion(): string {
+  return packageJson.version;
+}
+
+export function getServiceName(): string {
+  return packageJson.name;
+}