@tvlabs/wdio-service 0.1.5 → 0.1.7

package/esm/index.js

@@ -1,7 +1,10 @@
 import { SevereServiceError } from 'webdriverio';
-import * as crypto from 'crypto';
+import * as crypto$1 from 'crypto';
 import { WebSocket } from 'ws';
 import { Socket } from 'phoenix';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as crypto from 'node:crypto';
 
 const LOG_LEVELS = {
     error: 0,
@@ -107,7 +110,7 @@ class Logger {
 }
 
 var name = "@tvlabs/wdio-service";
-var version = "0.1.5";
+var version = "0.1.7";
 var packageJson = {
 	name: name,
 	version: version};
@@ -125,15 +128,81 @@ function getServiceName() {
     return packageJson.name;
 }
 
-class TVLabsChannel {
+class BaseChannel {
     endpoint;
     maxReconnectRetries;
     key;
     logLevel;
     socket;
+    log;
+    constructor(endpoint, maxReconnectRetries, key, logLevel = 'info', loggerName) {
+        this.endpoint = endpoint;
+        this.maxReconnectRetries = maxReconnectRetries;
+        this.key = key;
+        this.logLevel = logLevel;
+        this.log = new Logger(loggerName, this.logLevel);
+        this.socket = new Socket(this.endpoint, {
+            transport: WebSocket,
+            params: this.params(),
+            reconnectAfterMs: this.reconnectAfterMs.bind(this),
+        });
+        this.socket.onError((...args) => BaseChannel.logSocketError(this.log, ...args));
+    }
+    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;
+    }
+    static logSocketError(log, event, _transport, _establishedConnections) {
+        const error = event.error;
+        log.error('Socket error:', error || event);
+    }
+}
+
+class SessionChannel extends BaseChannel {
     lobbyTopic;
     requestTopic;
-    log;
     events = {
         SESSION_READY: 'session:ready',
         SESSION_FAILED: 'session:failed',
@@ -143,17 +212,7 @@ class TVLabsChannel {
         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));
+        super(endpoint, maxReconnectRetries, key, logLevel, '@tvlabs/session-channel');
         this.lobbyTopic = this.socket.channel('requests:lobby');
     }
     async disconnect() {
@@ -165,14 +224,14 @@ class TVLabsChannel {
     }
     async connect() {
         try {
-            this.log.debug('Connecting to TV Labs...');
+            this.log.debug('Connecting to session channel...');
             this.socket.connect();
             await this.join(this.lobbyTopic);
-            this.log.debug('Connected to TV Labs!');
+            this.log.debug('Connected to session channel!');
         }
         catch (error) {
-            this.log.error('Error connecting to TV Labs:', error);
-            throw new SevereServiceError('Could not connect to TV Labs, please check your connection.');
+            this.log.error('Error connecting to session channel:', error);
+            throw new SevereServiceError('Could not connect to session channel, please check your connection.');
         }
     }
     async newSession(capabilities, maxRetries, retry = 0) {
@@ -250,57 +309,116 @@ class TVLabsChannel {
             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');
-            });
-        });
+    tvlabsSessionLink(sessionId) {
+        return `https://tvlabs.ai/app/sessions/${sessionId}`;
     }
-    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');
-            });
+}
+
+class BuildChannel extends BaseChannel {
+    lobbyTopic;
+    constructor(endpoint, maxReconnectRetries, key, logLevel = 'info') {
+        super(endpoint, maxReconnectRetries, key, logLevel, '@tvlabs/build-channel');
+        this.lobbyTopic = this.socket.channel('upload:lobby');
+    }
+    async disconnect() {
+        return new Promise((res, _rej) => {
+            this.lobbyTopic.leave();
+            this.socket.disconnect(() => res());
         });
     }
-    params() {
-        const serviceInfo = getServiceInfo();
-        this.log.debug('Info:', serviceInfo);
-        return {
-            ...serviceInfo,
-            api_key: this.key,
-        };
+    async connect() {
+        try {
+            this.log.debug('Connecting to build channel...');
+            this.socket.connect();
+            await this.join(this.lobbyTopic);
+            this.log.debug('Connected to build channel!');
+        }
+        catch (error) {
+            this.log.error('Error connecting to build channel:', error);
+            throw new SevereServiceError('Could not connect to build channel, please check your connection.');
+        }
     }
-    reconnectAfterMs(tries) {
-        if (tries > this.maxReconnectRetries) {
-            throw new SevereServiceError('Could not connect to TV Labs, please check your connection.');
+    async uploadBuild(buildPath, appSlug) {
+        const metadata = await this.getFileMetadata(buildPath);
+        this.log.info(`Requesting upload for build ${metadata.filename} (${metadata.type}, ${metadata.size} bytes)`);
+        const { existing, build_id, url } = await this.requestUploadUrl(metadata, appSlug);
+        if (existing) {
+            this.log.info('Build is pre-existing, skipping upload');
         }
-        const wait = [0, 1000, 3000, 5000][tries] || 10000;
-        this.log.info(`[${tries}/${this.maxReconnectRetries}] Waiting ${wait}ms before re-attempting to connect...`);
-        return wait;
+        else {
+            this.log.info('Uploading build...');
+            await this.uploadToUrl(url, buildPath, metadata);
+            const { application_id } = await this.extractBuildInfo();
+            this.log.info(`Build "${application_id}" processed successfully`);
+        }
+        return build_id;
     }
-    tvlabsSessionLink(sessionId) {
-        return `https://tvlabs.ai/app/sessions/${sessionId}`;
+    async requestUploadUrl(metadata, appSlug) {
+        try {
+            return await this.push(this.lobbyTopic, 'request_upload_url', { metadata, application_slug: appSlug });
+        }
+        catch (error) {
+            this.log.error('Error requesting upload URL:', error);
+            throw error;
+        }
     }
-    static logSocketError(log, event, _transport, _establishedConnections) {
-        log.error('Socket error:', event.error);
+    async uploadToUrl(url, filePath, metadata) {
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers: {
+                    'Content-Type': metadata.type,
+                    'Content-Length': String(metadata.size),
+                },
+                body: fs.createReadStream(filePath),
+                duplex: 'half',
+            });
+            if (!response.ok) {
+                throw new SevereServiceError(`Failed to upload build to storage, got ${response.status}`);
+            }
+            this.log.info('Upload complete');
+        }
+        catch (error) {
+            this.log.error('Error uploading build:', error);
+            throw error;
+        }
+    }
+    async extractBuildInfo() {
+        this.log.info('Processing uploaded build...');
+        try {
+            return await this.push(this.lobbyTopic, 'extract_build_info', {});
+        }
+        catch (error) {
+            this.log.error('Error processing build:', error);
+            throw error;
+        }
+    }
+    async getFileMetadata(buildPath) {
+        const filename = path.basename(buildPath);
+        const size = fs.statSync(buildPath).size;
+        const type = this.detectMimeType(filename);
+        const sha256 = await this.computeSha256(buildPath);
+        return { filename, type, size, sha256 };
+    }
+    async computeSha256(buildPath) {
+        return new Promise((resolve, reject) => {
+            const hash = crypto.createHash('sha256');
+            const stream = fs.createReadStream(buildPath);
+            stream.on('data', (chunk) => hash.update(chunk));
+            stream.on('end', () => resolve(hash.digest('hex')));
+            stream.on('error', (err) => reject(err));
+        });
+    }
+    detectMimeType(filename) {
+        const fileExtension = path.extname(filename).toLowerCase();
+        switch (fileExtension) {
+            case '.apk':
+                return 'application/vnd.android.package-archive';
+            case '.zip':
+                return 'application/zip';
+            default:
+                return 'application/octet-stream';
+        }
     }
 }
 
@@ -324,15 +442,22 @@ class TVLabsService {
         }
     }
     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();
+        const buildPath = this.buildPath();
+        if (buildPath) {
+            const buildChannel = new BuildChannel(this.buildEndpoint(), this.reconnectRetries(), this.apiKey(), this.logLevel());
+            await buildChannel.connect();
+            capabilities['tvlabs:build'] = await buildChannel.uploadBuild(buildPath, this.appSlug());
+            await buildChannel.disconnect();
+        }
+        const sessionChannel = new SessionChannel(this.sessionEndpoint(), this.reconnectRetries(), this.apiKey(), this.logLevel());
+        await sessionChannel.connect();
+        capabilities['tvlabs:session_id'] = await sessionChannel.newSession(capabilities, this.retries());
+        await sessionChannel.disconnect();
     }
     setupRequestId() {
         const originalTransformRequest = this._config.transformRequest;
         this._config.transformRequest = (requestOptions) => {
-            const requestId = crypto.randomUUID();
+            const requestId = crypto$1.randomUUID();
             const originalRequestOptions = typeof originalTransformRequest === 'function'
                 ? originalTransformRequest(requestOptions)
                 : requestOptions;
@@ -357,8 +482,17 @@ class TVLabsService {
             }
         }
     }
-    endpoint() {
-        return this._options.endpoint ?? 'wss://tvlabs.ai/appium';
+    buildPath() {
+        return this._options.buildPath;
+    }
+    appSlug() {
+        return this._options.app;
+    }
+    sessionEndpoint() {
+        return this._options.sessionEndpoint ?? 'wss://tvlabs.ai/appium';
+    }
+    buildEndpoint() {
+        return this._options.buildEndpoint ?? 'wss://tvlabs.ai/cli';
     }
     retries() {
         return this._options.retries ?? 3;

package/esm/service.d.ts

@@ -10,7 +10,10 @@ export default class TVLabsService implements Services.ServiceInstance {
     beforeSession(_config: Omit<Options.Testrunner, 'capabilities'>, capabilities: TVLabsCapabilities, _specs: string[], _cid: string): Promise<void>;
     private setupRequestId;
     private setRequestHeader;
-    private endpoint;
+    private buildPath;
+    private appSlug;
+    private sessionEndpoint;
+    private buildEndpoint;
     private retries;
     private apiKey;
     private logLevel;

package/esm/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAMA,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"}
+{"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;IAuCd,OAAO,CAAC,cAAc;IA0BtB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,gBAAgB;CAGzB"}

package/esm/types.d.ts

@@ -2,8 +2,11 @@ import type { Capabilities } from '@wdio/types';
 export type LogLevel = 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
 export type TVLabsServiceOptions = {
     apiKey: string;
-    endpoint?: string;
+    sessionEndpoint?: string;
+    buildEndpoint?: string;
     retries?: number;
+    buildPath?: string;
+    app?: string;
     reconnectRetries?: number;
     attachRequestId?: boolean;
 };
@@ -38,4 +41,19 @@ export type TVLabsServiceInfo = {
     service_version: string;
     service_name: string;
 };
+export type TVLabsRequestUploadUrlResponse = {
+    url: string;
+    build_id: string;
+    existing: boolean;
+    application_id?: string;
+};
+export type TVLabsExtractBuildInfoResponse = {
+    application_id: string;
+};
+export type TVLabsBuildMetadata = {
+    filename: string;
+    type: string;
+    size: number;
+    sha256: 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,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"}
+{"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,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,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;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tvlabs/wdio-service",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "WebdriverIO service that provides a better integration into TV Labs",
   "author": "Regan Karlewicz <regan@tvlabs.ai>",
   "license": "Apache-2.0",
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tv-labs/wdio-tvlabs-service.git"
+    "url": "git+https://github.com/tv-labs/wdio-service.git"
   },
   "keywords": [
     "wdio-plugin",
@@ -19,7 +19,7 @@
     "appium"
   ],
   "bugs": {
-    "url": "https://github.com/tv-labs/wdio-tvlabs-service/issues"
+    "url": "https://github.com/tv-labs/wdio-service/issues"
   },
   "scripts": {
     "build": "npm run clean && rollup -c",
@@ -29,7 +29,8 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "lint": "eslint",
-    "test": "vitest --config vitest.config.ts --coverage",
+    "test": "vitest --config vitest.config.ts --coverage --run",
+    "test:watch": "vitest --config vitest.config.ts --coverage",
     "publish:dry": "npm publish --access public --provenance --dry-run"
   },
   "type": "module",

package/src/channels/base.ts

@@ -0,0 +1,110 @@
+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 { TVLabsSocketParams, LogLevel } from '../types.js';
+import type { PhoenixChannelJoinResponse } from '../phoenix.js';
+
+export abstract class BaseChannel {
+  protected socket: Socket;
+  protected log: Logger;
+
+  constructor(
+    protected endpoint: string,
+    protected maxReconnectRetries: number,
+    protected key: string,
+    protected logLevel: LogLevel = 'info',
+    loggerName: string,
+  ) {
+    this.log = new Logger(loggerName, this.logLevel);
+
+    this.socket = new Socket(this.endpoint, {
+      transport: WebSocket,
+      params: this.params(),
+      reconnectAfterMs: this.reconnectAfterMs.bind(this),
+    });
+
+    this.socket.onError((...args) =>
+      BaseChannel.logSocketError(this.log, ...args),
+    );
+  }
+
+  abstract connect(): Promise<void>;
+  abstract disconnect(): Promise<void>;
+
+  protected async join(topic: Channel): Promise<void> {
+    return new Promise((res, rej) => {
+      topic
+        .join()
+        .receive('ok', (_resp: PhoenixChannelJoinResponse) => {
+          res();
+        })
+        .receive('error', ({ response }: PhoenixChannelJoinResponse) => {
+          rej('Failed to join topic: ' + response);
+        })
+        .receive('timeout', () => {
+          rej('timeout');
+        });
+    });
+  }
+
+  protected async push<T>(
+    topic: Channel,
+    event: string,
+    payload: object,
+  ): Promise<T> {
+    return new Promise((res, rej) => {
+      topic
+        .push(event, payload)
+        .receive('ok', (msg: T) => {
+          res(msg);
+        })
+        .receive('error', (reason: string) => {
+          rej(reason);
+        })
+        .receive('timeout', () => {
+          rej('timeout');
+        });
+    });
+  }
+
+  private params(): TVLabsSocketParams {
+    const serviceInfo = getServiceInfo();
+
+    this.log.debug('Info:', serviceInfo);
+
+    return {
+      ...serviceInfo,
+      api_key: this.key,
+    };
+  }
+
+  private reconnectAfterMs(tries: number) {
+    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;
+  }
+
+  private static logSocketError(
+    log: Logger,
+    event: ErrorEvent,
+    _transport: new (endpoint: string) => object,
+    _establishedConnections: number,
+  ) {
+    const error = event.error;
+
+    log.error('Socket error:', error || event);
+  }
+}