@tvlabs/wdio-service 0.1.8 → 0.1.10

package/README.md

@@ -10,13 +10,17 @@
 
 ## Introduction
 
+[![npm](https://img.shields.io/npm/v/@tvlabs/wdio-service)](https://www.npmjs.com/package/@tvlabs/wdio-service)
+
 The `@tvlabs/wdio-service` package uses a websocket to connect to the TV Labs platform before an Appium session begins, logging events relating to build upload and session creation as they occur. This offloads the responsibility of creating the TV Labs session from the `POST /session` Webdriver endpoint, leading to more reliable session requests and creation.
 
 If a build path is provided, the service first makes a build upload request to the TV Labs platform, and then sets the `tvlabs:build` capability to the newly created build ID.
 
 The service then 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.
+Additionally, the service automatically injects an `Authorization` header with your API key (formatted as `Bearer ${apiKey}`) into all requests to the TV Labs platform. If you have already set an `Authorization` header in your configuration, the service will respect your existing header and not override it.
+
+The service also 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
 
@@ -64,17 +68,17 @@ async function run() {
   const wdOpts = {
     capabilities,
     hostname: 'appium.tvlabs.ai',
-    port: 4723,
-    headers: {
-      Authorization: `Bearer ${process.env.TVLABS_API_TOKEN}`,
-    },
+    port: 4723
   };
 
   const serviceOpts = {
     apiKey: process.env.TVLABS_API_TOKEN,
   }
 
-  const service = new TVLabsService(serviceOpts, capabilities, {})
+  // NOTE: it is important to make sure that
+  // the wdOpts passed here are the same reference
+  // as the one passed to remote()
+  const service = new TVLabsService(serviceOpts, capabilities, wdOpts)
 
   // The TV Labs service does not use specs or a cid, pass default values.
   const cid = ""
@@ -141,3 +145,90 @@ run();
 - **Required:** No
 - **Default:** `false`
 - **Description:** Whether to continue the session request if any step fails. When `true`, the session request will still be made with the original provided capabilities. When `false`, the service will exit with a non-zero code.
+
+## Methods
+
+### `lastRequestId()`
+
+- **Returns:** `string | undefined`
+- **Description:** Returns the last request ID that was attached to a request made to the TV Labs platform. This is useful for correlating client-side logs with server-side logs. Returns `undefined` if no request has been made yet or if `attachRequestId` is set to `false`.
+
+#### Example
+
+```javascript
+import { remote } from 'webdriverio';
+import { TVLabsService } from '@tvlabs/wdio-service';
+
+const capabilities = { ... };
+const wdOpts = { ... };
+
+const service = new TVLabsService(
+  { apiKey: process.env.TVLABS_API_KEY },
+  capabilities,
+  wdOpts
+);
+
+await service.beforeSession(wdOpts, capabilities, [], '');
+
+const driver = await remote(wdOpts);
+
+// Get the last request ID
+const requestId = service.lastRequestId();
+console.log(`Last request ID: ${requestId}`);
+```
+
+### `requestMetadata()`
+
+- **Parameters:** `appiumSessionId: string, requestIds: string | string[]`
+- **Returns:** `Promise<TVLabsRequestMetadata | TVLabsRequestMetadataResponse>`
+- **Description:** Fetches metadata for one or more Appium request IDs from the TV Labs platform. If a single request ID is provided, returns the metadata for that request. If an array of request IDs is provided, returns a map where keys are request IDs and values are their corresponding metadata.
+
+> **Note:** Request metadata is processed asynchronously on the TV Labs platform. To ensure metadata is available, it is recommended to fetch request metadata a few seconds after the request, or after the session has ended.
+
+#### Example
+
+```javascript
+import { remote } from 'webdriverio';
+import { TVLabsService } from '@tvlabs/wdio-service';
+
+const capabilities = { ... };
+const wdOpts = { ... };
+
+const service = new TVLabsService(
+  { apiKey: process.env.TVLABS_API_KEY },
+  capabilities,
+  wdOpts
+);
+
+await service.beforeSession(wdOpts, capabilities, [], '');
+
+const driver = await remote(wdOpts);
+let requestId;
+
+try {
+  // Perform some actions that generate requests
+  const element = await driver.$('#my-button');
+  await element.click();
+
+  // Get the request ID from the click
+  requestId = service.lastRequestId();
+  console.log(`Request ID: ${requestId}`);
+} finally {
+  await driver.deleteSession();
+}
+
+// Fetch metadata after session ends (recommended)
+if (requestId) {
+  const metadata = await service.requestMetadata(driver.sessionId, requestId);
+  console.log('Request metadata:', metadata);
+}
+
+// Fetch metadata for multiple requests
+const multiMetadata = await service.requestMetadata("appium-session-id-1234"[
+  'request-id-123',
+  'request-id-456',
+  'request-id-789'
+]);
+
+console.log('Multiple requests metadata:', multiMetadata);
+```

package/cjs/channels/metadata.d.ts

@@ -0,0 +1,10 @@
+import { BaseChannel } from './base.js';
+import type { LogLevel, TVLabsRequestMetadataResponse } from '../types.js';
+export declare class MetadataChannel extends BaseChannel {
+    private lobbyTopic;
+    constructor(endpoint: string, maxReconnectRetries: number, key: string, logLevel?: LogLevel);
+    disconnect(): Promise<void>;
+    connect(): Promise<void>;
+    getRequestMetadata(appiumSessionId: string, requestIds: string[]): Promise<TVLabsRequestMetadataResponse>;
+}
+//# sourceMappingURL=metadata.d.ts.map

package/cjs/channels/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/channels/metadata.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC;AAE3E,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,OAAO,CAAC,UAAU,CAAU;gBAG1B,QAAQ,EAAE,MAAM,EAChB,mBAAmB,EAAE,MAAM,EAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,GAAE,QAAiB;IAYvB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBxB,kBAAkB,CACtB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,6BAA6B,CAAC;CAyB1C"}

package/cjs/index.js

@@ -11,20 +11,20 @@ var path = require('node:path');
 var crypto = require('node:crypto');
 
 function _interopNamespaceDefault(e) {
-    var n = Object.create(null);
-    if (e) {
-        Object.keys(e).forEach(function (k) {
-            if (k !== 'default') {
-                var d = Object.getOwnPropertyDescriptor(e, k);
-                Object.defineProperty(n, k, d.get ? d : {
-                    enumerable: true,
-                    get: function () { return e[k]; }
-                });
-            }
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
         });
-    }
-    n.default = e;
-    return Object.freeze(n);
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
 }
 
 var crypto__namespace$1 = /*#__PURE__*/_interopNamespaceDefault(crypto$1);
@@ -32,6 +32,25 @@ var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
 var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 var crypto__namespace = /*#__PURE__*/_interopNamespaceDefault(crypto);
 
+var name = "@tvlabs/wdio-service";
+var version = "0.1.10";
+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;
+}
+
 const LOG_LEVELS = {
     error: 0,
     warn: 1,
@@ -135,25 +154,6 @@ class Logger {
     }
 }
 
-var name = "@tvlabs/wdio-service";
-var version = "0.1.8";
-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 BaseChannel {
     endpoint;
     maxReconnectRetries;
@@ -448,19 +448,82 @@ class BuildChannel extends BaseChannel {
     }
 }
 
+class MetadataChannel extends BaseChannel {
+    lobbyTopic;
+    constructor(endpoint, maxReconnectRetries, key, logLevel = 'info') {
+        super(endpoint, maxReconnectRetries, key, logLevel, '@tvlabs/metadata-channel');
+        this.lobbyTopic = this.socket.channel('metadata:lobby');
+    }
+    async disconnect() {
+        return new Promise((res, _rej) => {
+            this.lobbyTopic.leave();
+            this.socket.disconnect(() => res());
+        });
+    }
+    async connect() {
+        try {
+            this.log.debug('Connecting to metadata channel...');
+            this.socket.connect();
+            await this.join(this.lobbyTopic);
+            this.log.debug('Connected to metadata channel!');
+        }
+        catch (error) {
+            this.log.error('Error connecting to metadata channel:', error);
+            throw new webdriverio.SevereServiceError('Could not connect to metadata channel, please check your connection.');
+        }
+    }
+    async getRequestMetadata(appiumSessionId, requestIds) {
+        this.log.debug(`Fetching metadata for session ${appiumSessionId}, requests: ${requestIds.join(', ')}`);
+        try {
+            const response = await this.push(this.lobbyTopic, 'appium_request_metadata', {
+                appium_session_id: appiumSessionId,
+                request_ids: requestIds,
+            });
+            this.log.debug(`Received metadata for ${Object.keys(response).length} request(s)`);
+            return response;
+        }
+        catch (error) {
+            this.log.error('Error fetching request metadata:', error);
+            throw error;
+        }
+    }
+}
+
 class TVLabsService {
     _options;
     _capabilities;
     _config;
     log;
+    requestId;
+    sessionId;
+    metadataChannel;
     constructor(_options, _capabilities, _config) {
         this._options = _options;
         this._capabilities = _capabilities;
         this._config = _config;
         this.log = new Logger('@tvlabs/wdio-service', this._config.logLevel);
+        this.injectAuthorizationHeader();
         if (this.attachRequestId()) {
             this.setupRequestId();
         }
+        this.log.info(`Instantiated TVLabsService v${getServiceVersion()}`);
+    }
+    lastRequestId() {
+        return this.requestId;
+    }
+    async requestMetadata(sessionId, requestIds) {
+        const requestIdArray = Array.isArray(requestIds)
+            ? requestIds
+            : [requestIds];
+        if (!this.metadataChannel) {
+            this.metadataChannel = new MetadataChannel(this.sessionEndpoint(), this.reconnectRetries(), this.apiKey(), this.logLevel());
+            await this.metadataChannel.connect();
+        }
+        const response = await this.metadataChannel.getRequestMetadata(sessionId, requestIdArray);
+        if (!Array.isArray(requestIds)) {
+            return response[requestIds];
+        }
+        return response;
     }
     onPrepare(_config, param) {
         try {
@@ -496,6 +559,12 @@ class TVLabsService {
             throw error;
         }
     }
+    injectAuthorizationHeader() {
+        this._config.headers = this._config.headers || {};
+        if (!this._config.headers.Authorization) {
+            this._config.headers.Authorization = `Bearer ${this.apiKey()}`;
+        }
+    }
     setupRequestId() {
         const originalTransformRequest = this._config.transformRequest;
         this._config.transformRequest = (requestOptions) => {
@@ -507,7 +576,8 @@ class TVLabsService {
                 originalRequestOptions.headers = {};
             }
             this.setRequestHeader(originalRequestOptions.headers, 'x-request-id', requestId);
-            this.log.info('ATTACHED REQUEST ID', requestId);
+            this.log.debug('ATTACHED REQUEST ID', requestId);
+            this.setRequestId(requestId);
             return originalRequestOptions;
         };
     }
@@ -524,6 +594,9 @@ class TVLabsService {
             }
         }
     }
+    setRequestId(id) {
+        this.requestId = id;
+    }
     continueOnError() {
         return this._options.continueOnError ?? false;
     }

package/cjs/service.d.ts

@@ -1,15 +1,22 @@
 import type { Services, Capabilities, Options } from '@wdio/types';
-import type { TVLabsCapabilities, TVLabsServiceOptions } from './types.js';
+import type { TVLabsCapabilities, TVLabsServiceOptions, TVLabsRequestMetadata, TVLabsRequestMetadataResponse } from './types.js';
 export default class TVLabsService implements Services.ServiceInstance {
     private _options;
     private _capabilities;
     private _config;
     private log;
+    private requestId;
+    private sessionId;
+    private metadataChannel;
     constructor(_options: TVLabsServiceOptions, _capabilities: Capabilities.ResolvedTestrunnerCapabilities, _config: Options.WebdriverIO);
+    lastRequestId(): string | undefined;
+    requestMetadata(sessionId: string, requestIds: string | string[]): Promise<TVLabsRequestMetadata | TVLabsRequestMetadataResponse>;
     onPrepare(_config: Options.Testrunner, param: Capabilities.TestrunnerCapabilities): void;
     beforeSession(_config: Omit<Options.Testrunner, 'capabilities'>, capabilities: TVLabsCapabilities, _specs: string[], _cid: string): Promise<void>;
+    private injectAuthorizationHeader;
     private setupRequestId;
     private setRequestHeader;
+    private setRequestId;
     private continueOnError;
     private buildPath;
     private appSlug;

package/cjs/service.d.ts.map

@@ -1 +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;IAiBtC,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;IA+Cd,OAAO,CAAC,cAAc;IA0BtB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,eAAe;IAIvB,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"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,6BAA6B,EAE9B,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ,CAAC,eAAe;IAOlE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IARjB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,eAAe,CAA8B;gBAG3C,QAAQ,EAAE,oBAAoB,EAC9B,aAAa,EAAE,YAAY,CAAC,8BAA8B,EAC1D,OAAO,EAAE,OAAO,CAAC,WAAW;IAatC,aAAa,IAAI,MAAM,GAAG,SAAS;IAI7B,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAC5B,OAAO,CAAC,qBAAqB,GAAG,6BAA6B,CAAC;IA+BjE,SAAS,CACP,OAAO,EAAE,OAAO,CAAC,UAAU,EAC3B,KAAK,EAAE,YAAY,CAAC,sBAAsB;IAiBtC,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;IA+Cd,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,cAAc;IA4BtB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,eAAe;IAIvB,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/cjs/types.d.ts

@@ -32,8 +32,20 @@ export type TVLabsSessionRequestUpdate = {
     session_id: string;
     reason: string;
 };
+export type ResponseAnyValue = string | number | boolean | null | ResponseAnyValue[] | {
+    [key: string]: ResponseAnyValue;
+};
 export type TVLabsSessionRequestResponse = {
+    status: number;
+    path: string;
     request_id: string;
+    method: string;
+    req_body: ResponseAnyValue;
+    resp_body: ResponseAnyValue;
+    requested_at: string | null;
+    responded_at: string | null;
+    video_start_time: number | null;
+    video_end_time: number | null;
 };
 export type TVLabsSocketParams = TVLabsServiceInfo & {
     api_key: string;
@@ -57,4 +69,10 @@ export type TVLabsBuildMetadata = {
     size: number;
     sha256: string;
 };
+export type TVLabsRequestMetadata = {
+    [key: string]: unknown;
+};
+export type TVLabsRequestMetadataResponse = {
+    [request_id: string]: TVLabsRequestMetadata;
+};
 //# sourceMappingURL=types.d.ts.map

package/cjs/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,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;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"}
+{"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;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,gBAAgB,GACxB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,gBAAgB,EAAE,GAClB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,CAAC;AAExC,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,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;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,CAAC;CAC7C,CAAC"}

package/esm/channels/metadata.d.ts

@@ -0,0 +1,10 @@
+import { BaseChannel } from './base.js';
+import type { LogLevel, TVLabsRequestMetadataResponse } from '../types.js';
+export declare class MetadataChannel extends BaseChannel {
+    private lobbyTopic;
+    constructor(endpoint: string, maxReconnectRetries: number, key: string, logLevel?: LogLevel);
+    disconnect(): Promise<void>;
+    connect(): Promise<void>;
+    getRequestMetadata(appiumSessionId: string, requestIds: string[]): Promise<TVLabsRequestMetadataResponse>;
+}
+//# sourceMappingURL=metadata.d.ts.map

package/esm/channels/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/channels/metadata.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC;AAE3E,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,OAAO,CAAC,UAAU,CAAU;gBAG1B,QAAQ,EAAE,MAAM,EAChB,mBAAmB,EAAE,MAAM,EAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,GAAE,QAAiB;IAYvB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBxB,kBAAkB,CACtB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,6BAA6B,CAAC;CAyB1C"}

package/esm/index.js

@@ -6,6 +6,25 @@ import * as fs from 'node:fs';
 import * as path from 'node:path';
 import * as crypto from 'node:crypto';
 
+var name = "@tvlabs/wdio-service";
+var version = "0.1.10";
+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;
+}
+
 const LOG_LEVELS = {
     error: 0,
     warn: 1,
@@ -109,25 +128,6 @@ class Logger {
     }
 }
 
-var name = "@tvlabs/wdio-service";
-var version = "0.1.8";
-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 BaseChannel {
     endpoint;
     maxReconnectRetries;
@@ -422,19 +422,82 @@ class BuildChannel extends BaseChannel {
     }
 }
 
+class MetadataChannel extends BaseChannel {
+    lobbyTopic;
+    constructor(endpoint, maxReconnectRetries, key, logLevel = 'info') {
+        super(endpoint, maxReconnectRetries, key, logLevel, '@tvlabs/metadata-channel');
+        this.lobbyTopic = this.socket.channel('metadata:lobby');
+    }
+    async disconnect() {
+        return new Promise((res, _rej) => {
+            this.lobbyTopic.leave();
+            this.socket.disconnect(() => res());
+        });
+    }
+    async connect() {
+        try {
+            this.log.debug('Connecting to metadata channel...');
+            this.socket.connect();
+            await this.join(this.lobbyTopic);
+            this.log.debug('Connected to metadata channel!');
+        }
+        catch (error) {
+            this.log.error('Error connecting to metadata channel:', error);
+            throw new SevereServiceError('Could not connect to metadata channel, please check your connection.');
+        }
+    }
+    async getRequestMetadata(appiumSessionId, requestIds) {
+        this.log.debug(`Fetching metadata for session ${appiumSessionId}, requests: ${requestIds.join(', ')}`);
+        try {
+            const response = await this.push(this.lobbyTopic, 'appium_request_metadata', {
+                appium_session_id: appiumSessionId,
+                request_ids: requestIds,
+            });
+            this.log.debug(`Received metadata for ${Object.keys(response).length} request(s)`);
+            return response;
+        }
+        catch (error) {
+            this.log.error('Error fetching request metadata:', error);
+            throw error;
+        }
+    }
+}
+
 class TVLabsService {
     _options;
     _capabilities;
     _config;
     log;
+    requestId;
+    sessionId;
+    metadataChannel;
     constructor(_options, _capabilities, _config) {
         this._options = _options;
         this._capabilities = _capabilities;
         this._config = _config;
         this.log = new Logger('@tvlabs/wdio-service', this._config.logLevel);
+        this.injectAuthorizationHeader();
         if (this.attachRequestId()) {
             this.setupRequestId();
         }
+        this.log.info(`Instantiated TVLabsService v${getServiceVersion()}`);
+    }
+    lastRequestId() {
+        return this.requestId;
+    }
+    async requestMetadata(sessionId, requestIds) {
+        const requestIdArray = Array.isArray(requestIds)
+            ? requestIds
+            : [requestIds];
+        if (!this.metadataChannel) {
+            this.metadataChannel = new MetadataChannel(this.sessionEndpoint(), this.reconnectRetries(), this.apiKey(), this.logLevel());
+            await this.metadataChannel.connect();
+        }
+        const response = await this.metadataChannel.getRequestMetadata(sessionId, requestIdArray);
+        if (!Array.isArray(requestIds)) {
+            return response[requestIds];
+        }
+        return response;
     }
     onPrepare(_config, param) {
         try {
@@ -470,6 +533,12 @@ class TVLabsService {
             throw error;
         }
     }
+    injectAuthorizationHeader() {
+        this._config.headers = this._config.headers || {};
+        if (!this._config.headers.Authorization) {
+            this._config.headers.Authorization = `Bearer ${this.apiKey()}`;
+        }
+    }
     setupRequestId() {
         const originalTransformRequest = this._config.transformRequest;
         this._config.transformRequest = (requestOptions) => {
@@ -481,7 +550,8 @@ class TVLabsService {
                 originalRequestOptions.headers = {};
             }
             this.setRequestHeader(originalRequestOptions.headers, 'x-request-id', requestId);
-            this.log.info('ATTACHED REQUEST ID', requestId);
+            this.log.debug('ATTACHED REQUEST ID', requestId);
+            this.setRequestId(requestId);
             return originalRequestOptions;
         };
     }
@@ -498,6 +568,9 @@ class TVLabsService {
             }
         }
     }
+    setRequestId(id) {
+        this.requestId = id;
+    }
     continueOnError() {
         return this._options.continueOnError ?? false;
     }

package/esm/service.d.ts

@@ -1,15 +1,22 @@
 import type { Services, Capabilities, Options } from '@wdio/types';
-import type { TVLabsCapabilities, TVLabsServiceOptions } from './types.js';
+import type { TVLabsCapabilities, TVLabsServiceOptions, TVLabsRequestMetadata, TVLabsRequestMetadataResponse } from './types.js';
 export default class TVLabsService implements Services.ServiceInstance {
     private _options;
     private _capabilities;
     private _config;
     private log;
+    private requestId;
+    private sessionId;
+    private metadataChannel;
     constructor(_options: TVLabsServiceOptions, _capabilities: Capabilities.ResolvedTestrunnerCapabilities, _config: Options.WebdriverIO);
+    lastRequestId(): string | undefined;
+    requestMetadata(sessionId: string, requestIds: string | string[]): Promise<TVLabsRequestMetadata | TVLabsRequestMetadataResponse>;
     onPrepare(_config: Options.Testrunner, param: Capabilities.TestrunnerCapabilities): void;
     beforeSession(_config: Omit<Options.Testrunner, 'capabilities'>, capabilities: TVLabsCapabilities, _specs: string[], _cid: string): Promise<void>;
+    private injectAuthorizationHeader;
     private setupRequestId;
     private setRequestHeader;
+    private setRequestId;
     private continueOnError;
     private buildPath;
     private appSlug;

package/esm/service.d.ts.map

@@ -1 +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;IAiBtC,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;IA+Cd,OAAO,CAAC,cAAc;IA0BtB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,eAAe;IAIvB,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"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,6BAA6B,EAE9B,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ,CAAC,eAAe;IAOlE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IARjB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,eAAe,CAA8B;gBAG3C,QAAQ,EAAE,oBAAoB,EAC9B,aAAa,EAAE,YAAY,CAAC,8BAA8B,EAC1D,OAAO,EAAE,OAAO,CAAC,WAAW;IAatC,aAAa,IAAI,MAAM,GAAG,SAAS;IAI7B,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAC5B,OAAO,CAAC,qBAAqB,GAAG,6BAA6B,CAAC;IA+BjE,SAAS,CACP,OAAO,EAAE,OAAO,CAAC,UAAU,EAC3B,KAAK,EAAE,YAAY,CAAC,sBAAsB;IAiBtC,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;IA+Cd,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,cAAc;IA4BtB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,eAAe;IAIvB,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

@@ -32,8 +32,20 @@ export type TVLabsSessionRequestUpdate = {
     session_id: string;
     reason: string;
 };
+export type ResponseAnyValue = string | number | boolean | null | ResponseAnyValue[] | {
+    [key: string]: ResponseAnyValue;
+};
 export type TVLabsSessionRequestResponse = {
+    status: number;
+    path: string;
     request_id: string;
+    method: string;
+    req_body: ResponseAnyValue;
+    resp_body: ResponseAnyValue;
+    requested_at: string | null;
+    responded_at: string | null;
+    video_start_time: number | null;
+    video_end_time: number | null;
 };
 export type TVLabsSocketParams = TVLabsServiceInfo & {
     api_key: string;
@@ -57,4 +69,10 @@ export type TVLabsBuildMetadata = {
     size: number;
     sha256: string;
 };
+export type TVLabsRequestMetadata = {
+    [key: string]: unknown;
+};
+export type TVLabsRequestMetadataResponse = {
+    [request_id: string]: TVLabsRequestMetadata;
+};
 //# 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,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;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"}
+{"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;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,gBAAgB,GACxB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,gBAAgB,EAAE,GAClB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,CAAC;AAExC,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,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;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,CAAC;CAC7C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tvlabs/wdio-service",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "WebdriverIO service that provides a better integration into TV Labs",
   "author": "Regan Karlewicz <regan@tvlabs.ai>",
   "license": "Apache-2.0",
@@ -23,7 +23,7 @@
   },
   "scripts": {
     "build": "npm run clean && rollup -c",
-    "start": "ts-node src/index.ts",
+    "start": "tsx --env-file=.env scripts/test.ts",
     "dev": "ts-node --transpile-only src/index.ts",
     "clean": "rm -rf cjs && rm -rf esm",
     "format": "prettier --write .",
@@ -31,6 +31,9 @@
     "lint": "eslint",
     "test": "vitest --config vitest.config.ts --coverage --run",
     "test:watch": "vitest --config vitest.config.ts --coverage",
+    "test:integration": "npm run build && npm run test:integration:esm && npm run test:integration:cjs",
+    "test:integration:esm": "vitest --config vitest.config.esm.ts --run",
+    "test:integration:cjs": "vitest --config vitest.config.cjs.ts --run",
     "publish:dry": "npm publish --access public --provenance --dry-run"
   },
   "type": "module",
@@ -43,7 +46,7 @@
   "typeScriptVersion": "5.8.2",
   "devDependencies": {
     "@eslint/js": "^9.22.0",
-    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-typescript": "^12.1.4",
@@ -52,7 +55,7 @@
     "@types/ws": "^8.18.0",
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.38.0",
-    "@vitest/coverage-v8": "^3.0.9",
+    "@vitest/coverage-v8": "^4.0.7",
     "@wdio/globals": "^9.12.1",
     "@wdio/types": "^9.10.1",
     "eslint": "^9.30.1",
@@ -60,9 +63,10 @@
     "jiti": "^2.4.2",
     "prettier": "^3.5.3",
     "rollup": "^4.45.1",
-    "typescript": "^5.8.2",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3",
     "typescript-eslint": "^8.38.0",
-    "vitest": "^3.0.9",
+    "vitest": "^4.0.7",
     "webdriverio": "^9.12.1"
   },
   "dependencies": {

package/scripts/test.ts

@@ -0,0 +1,65 @@
+import { remote } from 'webdriverio';
+import { TVLabsService } from '../src/index.ts';
+
+const apiKey = process.env.TVLABS_API_TOKEN;
+
+const capabilities = {
+  'tvlabs:build': '00000000-0000-0000-0000-000000000000',
+  'tvlabs:teleport_region': 'fake',
+  'tvlabs:constraints': 'platform_key:dev AND model:"Virtual Device"',
+};
+
+const wdOpts = {
+  hostname: 'localhost',
+  port: 4723, // Appium proxy
+  logLevel: 'info',
+  capabilities,
+};
+
+const serviceOpts = {
+  apiKey,
+  sessionEndpoint: 'ws://localhost:4000/appium',
+};
+
+const service = new TVLabsService(serviceOpts, capabilities, wdOpts);
+
+async function runTest() {
+  await service.beforeSession(wdOpts, capabilities, [], '');
+  const driver = await remote(wdOpts);
+
+  console.log('The session id is: ', driver.sessionId);
+
+  const requests = [];
+
+  try {
+    for (let i = 0; i < 3; ++i) {
+      await driver.execute('fake: getThing', {
+        thing: 'thing',
+      });
+
+      requests.push(service.lastRequestId());
+    }
+  } finally {
+    await driver.pause(1000);
+    await driver.deleteSession();
+  }
+
+  const allRequests = await service.requestMetadata(driver.sessionId, requests);
+  const singleRequest = await service.requestMetadata(
+    driver.sessionId,
+    requests[0],
+  );
+
+  console.log('Single request', singleRequest);
+  console.log('All requests', allRequests);
+}
+
+runTest()
+  .then(() => {
+    console.log('Test completed successfully');
+    process.exit(0);
+  })
+  .catch((error) => {
+    console.error('Test failed:', error);
+    process.exit(1);
+  });

package/src/channels/metadata.ts

@@ -0,0 +1,78 @@
+import { type Channel } from 'phoenix';
+import { SevereServiceError } from 'webdriverio';
+import { BaseChannel } from './base.js';
+
+import type { LogLevel, TVLabsRequestMetadataResponse } from '../types.js';
+
+export class MetadataChannel extends BaseChannel {
+  private lobbyTopic: Channel;
+
+  constructor(
+    endpoint: string,
+    maxReconnectRetries: number,
+    key: string,
+    logLevel: LogLevel = 'info',
+  ) {
+    super(
+      endpoint,
+      maxReconnectRetries,
+      key,
+      logLevel,
+      '@tvlabs/metadata-channel',
+    );
+    this.lobbyTopic = this.socket.channel('metadata:lobby');
+  }
+
+  async disconnect(): Promise<void> {
+    return new Promise((res, _rej) => {
+      this.lobbyTopic.leave();
+      this.socket.disconnect(() => res());
+    });
+  }
+
+  async connect(): Promise<void> {
+    try {
+      this.log.debug('Connecting to metadata channel...');
+
+      this.socket.connect();
+
+      await this.join(this.lobbyTopic);
+
+      this.log.debug('Connected to metadata channel!');
+    } catch (error) {
+      this.log.error('Error connecting to metadata channel:', error);
+      throw new SevereServiceError(
+        'Could not connect to metadata channel, please check your connection.',
+      );
+    }
+  }
+
+  async getRequestMetadata(
+    appiumSessionId: string,
+    requestIds: string[],
+  ): Promise<TVLabsRequestMetadataResponse> {
+    this.log.debug(
+      `Fetching metadata for session ${appiumSessionId}, requests: ${requestIds.join(', ')}`,
+    );
+
+    try {
+      const response = await this.push<TVLabsRequestMetadataResponse>(
+        this.lobbyTopic,
+        'appium_request_metadata',
+        {
+          appium_session_id: appiumSessionId,
+          request_ids: requestIds,
+        },
+      );
+
+      this.log.debug(
+        `Received metadata for ${Object.keys(response).length} request(s)`,
+      );
+
+      return response;
+    } catch (error) {
+      this.log.error('Error fetching request metadata:', error);
+      throw error;
+    }
+  }
+}

package/src/service.ts

@@ -1,19 +1,26 @@
 import { SevereServiceError } from 'webdriverio';
 import * as crypto from 'crypto';
+import { getServiceVersion } from './utils.js';
 
 import { SessionChannel } from './channels/session.js';
 import { BuildChannel } from './channels/build.js';
+import { MetadataChannel } from './channels/metadata.js';
 import { Logger } from './logger.js';
 
 import type { Services, Capabilities, Options } from '@wdio/types';
 import type {
   TVLabsCapabilities,
   TVLabsServiceOptions,
+  TVLabsRequestMetadata,
+  TVLabsRequestMetadataResponse,
   LogLevel,
 } from './types.js';
 
 export default class TVLabsService implements Services.ServiceInstance {
   private log: Logger;
+  private requestId: string | undefined;
+  private sessionId: string | undefined;
+  private metadataChannel: MetadataChannel | undefined;
 
   constructor(
     private _options: TVLabsServiceOptions,
@@ -21,9 +28,52 @@ export default class TVLabsService implements Services.ServiceInstance {
     private _config: Options.WebdriverIO,
   ) {
     this.log = new Logger('@tvlabs/wdio-service', this._config.logLevel);
+
+    this.injectAuthorizationHeader();
+
     if (this.attachRequestId()) {
       this.setupRequestId();
     }
+
+    this.log.info(`Instantiated TVLabsService v${getServiceVersion()}`);
+  }
+
+  lastRequestId(): string | undefined {
+    return this.requestId;
+  }
+
+  async requestMetadata(
+    sessionId: string,
+    requestIds: string | string[],
+  ): Promise<TVLabsRequestMetadata | TVLabsRequestMetadataResponse> {
+    const requestIdArray = Array.isArray(requestIds)
+      ? requestIds
+      : [requestIds];
+
+    // Create and connect to metadata channel if not already connected
+    if (!this.metadataChannel) {
+      this.metadataChannel = new MetadataChannel(
+        this.sessionEndpoint(),
+        this.reconnectRetries(),
+        this.apiKey(),
+        this.logLevel(),
+      );
+
+      await this.metadataChannel.connect();
+    }
+
+    const response = await this.metadataChannel.getRequestMetadata(
+      sessionId,
+      requestIdArray,
+    );
+
+    // If a single request ID was passed, return just that request's metadata
+    if (!Array.isArray(requestIds)) {
+      return response[requestIds];
+    }
+
+    // Otherwise return the full map
+    return response;
   }
 
   onPrepare(
@@ -96,6 +146,14 @@ export default class TVLabsService implements Services.ServiceInstance {
     }
   }
 
+  private injectAuthorizationHeader() {
+    this._config.headers = this._config.headers || {};
+
+    if (!this._config.headers.Authorization) {
+      this._config.headers.Authorization = `Bearer ${this.apiKey()}`;
+    }
+  }
+
   private setupRequestId() {
     const originalTransformRequest = this._config.transformRequest;
 
@@ -116,7 +174,9 @@ export default class TVLabsService implements Services.ServiceInstance {
         requestId,
       );
 
-      this.log.info('ATTACHED REQUEST ID', requestId);
+      this.log.debug('ATTACHED REQUEST ID', requestId);
+
+      this.setRequestId(requestId);
 
       return originalRequestOptions;
     };
@@ -138,6 +198,10 @@ export default class TVLabsService implements Services.ServiceInstance {
     }
   }
 
+  private setRequestId(id: string) {
+    this.requestId = id;
+  }
+
   private continueOnError(): boolean {
     return this._options.continueOnError ?? false;
   }

package/src/types.ts

@@ -41,8 +41,25 @@ export type TVLabsSessionRequestUpdate = {
   reason: string;
 };
 
+export type ResponseAnyValue =
+  | string
+  | number
+  | boolean
+  | null
+  | ResponseAnyValue[]
+  | { [key: string]: ResponseAnyValue };
+
 export type TVLabsSessionRequestResponse = {
+  status: number;
+  path: string;
   request_id: string;
+  method: string;
+  req_body: ResponseAnyValue;
+  resp_body: ResponseAnyValue;
+  requested_at: string | null;
+  responded_at: string | null;
+  video_start_time: number | null;
+  video_end_time: number | null;
 };
 
 export type TVLabsSocketParams = TVLabsServiceInfo & {
@@ -71,3 +88,11 @@ export type TVLabsBuildMetadata = {
   size: number;
   sha256: string;
 };
+
+export type TVLabsRequestMetadata = {
+  [key: string]: unknown;
+};
+
+export type TVLabsRequestMetadataResponse = {
+  [request_id: string]: TVLabsRequestMetadata;
+};

package/test-integration/README.md

@@ -0,0 +1,62 @@
+# Integration Tests
+
+These integration tests verify that the compiled ESM and CJS outputs work correctly when imported/required by consumers.
+
+## Directory Structure
+
+```
+test-integration/
+├── esm/
+│   └── import.test.mjs    # ESM module import tests
+└── cjs/
+    └── require.test.mjs   # CJS require tests (uses createRequire)
+```
+
+## Running Tests
+
+```bash
+# Run all integration tests (builds first)
+npm run test:integration
+
+# Run only ESM integration tests
+npm run test:integration:esm
+
+# Run only CJS integration tests
+npm run test:integration:cjs
+```
+
+## What These Tests Do
+
+Unlike unit tests that test source code (`src/`), these integration tests:
+
+1. **Import/require the compiled outputs** (`esm/` and `cjs/`)
+2. **Verify the module structure** is correct (exports are available)
+3. **Test basic instantiation** to ensure the code runs in both module systems
+4. **Validate that the build process** produces functional output
+
+## How It Works
+
+### ESM Tests (`esm/import.test.mjs`)
+
+- Uses standard ESM `import` to load the ESM build
+- Imports directly from `../../esm/index.js`
+
+### CJS Tests (`cjs/require.test.mjs`)
+
+- Written as an ESM file (`.mjs`) but uses `createRequire` to test CJS output
+- Uses Node's `createRequire` API to dynamically require the CJS build
+- This approach is necessary because Vitest itself is ESM-only
+
+## Prerequisites
+
+Integration tests require the project to be built first:
+
+```bash
+npm run build
+```
+
+The `test:integration` script automatically runs the build step.
+
+## CI Integration
+
+Integration tests run in CI as part of the Test job after unit tests complete.

package/test-integration/cjs/require.test.mjs

@@ -0,0 +1,90 @@
+import { describe, it, expect } from 'vitest';
+import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);
+const { TVLabsService } = require('../../cjs/index.js');
+
+const createService = (options = {}) => {
+  const serviceOptions = { apiKey: 'test-key', ...options };
+  const capabilities = {};
+  const config = { logLevel: 'silent' };
+  return new TVLabsService(serviceOptions, capabilities, config);
+};
+
+describe('CJS Integration Tests', () => {
+  it('should export TVLabsService', () => {
+    expect(typeof TVLabsService).toBe('function');
+  });
+
+  it('should be instantiable with valid options', () => {
+    const service = createService();
+    expect(service).toBeInstanceOf(TVLabsService);
+  });
+
+  it('should have onPrepare method', () => {
+    const service = createService();
+    expect(typeof service.onPrepare).toBe('function');
+  });
+
+  it('should have beforeSession method', () => {
+    const service = createService();
+    expect(typeof service.beforeSession).toBe('function');
+  });
+
+  it('should reject multi-remote capabilities in onPrepare', () => {
+    const service = createService({ continueOnError: true });
+    const multiRemoteConfig = {
+      capabilities: {
+        browserA: { browserName: 'chrome' },
+        browserB: { browserName: 'firefox' },
+      },
+    };
+
+    expect(() => service.onPrepare(multiRemoteConfig, {})).toThrow(
+      /multi-remote capabilities are not implemented/i,
+    );
+  });
+
+  it('should have lastRequestId method', () => {
+    const service = createService();
+    expect(typeof service.lastRequestId).toBe('function');
+  });
+
+  it('should have requestMetadata method', () => {
+    const service = createService();
+    expect(typeof service.requestMetadata).toBe('function');
+  });
+
+  describe('Authorization header injection', () => {
+    it('should inject Authorization header when not present', () => {
+      const config = {};
+      new TVLabsService({ apiKey: 'test-api-key' }, {}, config);
+
+      expect(config.headers).toBeDefined();
+      expect(config.headers.Authorization).toBe('Bearer test-api-key');
+    });
+
+    it('should not override existing Authorization header', () => {
+      const config = {
+        headers: {
+          Authorization: 'Bearer existing-token',
+        },
+      };
+      new TVLabsService({ apiKey: 'test-api-key' }, {}, config);
+
+      expect(config.headers.Authorization).toBe('Bearer existing-token');
+    });
+
+    it('should preserve other headers when injecting Authorization', () => {
+      const config = {
+        headers: {
+          'X-Custom-Header': 'custom-value',
+        },
+      };
+      new TVLabsService({ apiKey: 'test-api-key' }, {}, config);
+
+      expect(config.headers['X-Custom-Header']).toBe('custom-value');
+      expect(config.headers.Authorization).toBe('Bearer test-api-key');
+    });
+  });
+});

package/test-integration/esm/import.test.mjs

@@ -0,0 +1,87 @@
+import { describe, it, expect } from 'vitest';
+import { TVLabsService } from '../../esm/index.js';
+
+const createService = (options = {}) => {
+  const serviceOptions = { apiKey: 'test-key', ...options };
+  const capabilities = {};
+  const config = { logLevel: 'silent' };
+  return new TVLabsService(serviceOptions, capabilities, config);
+};
+
+describe('ESM Integration Tests', () => {
+  it('should export TVLabsService', () => {
+    expect(typeof TVLabsService).toBe('function');
+  });
+
+  it('should be instantiable with valid options', () => {
+    const service = createService();
+    expect(service).toBeInstanceOf(TVLabsService);
+  });
+
+  it('should have onPrepare method', () => {
+    const service = createService();
+    expect(typeof service.onPrepare).toBe('function');
+  });
+
+  it('should have beforeSession method', () => {
+    const service = createService();
+    expect(typeof service.beforeSession).toBe('function');
+  });
+
+  it('should reject multi-remote capabilities in onPrepare', () => {
+    const service = createService({ continueOnError: true });
+    const multiRemoteConfig = {
+      capabilities: {
+        browserA: { browserName: 'chrome' },
+        browserB: { browserName: 'firefox' },
+      },
+    };
+
+    expect(() => service.onPrepare(multiRemoteConfig, {})).toThrow(
+      /multi-remote capabilities are not implemented/i,
+    );
+  });
+
+  it('should have lastRequestId method', () => {
+    const service = createService();
+    expect(typeof service.lastRequestId).toBe('function');
+  });
+
+  it('should have requestMetadata method', () => {
+    const service = createService();
+    expect(typeof service.requestMetadata).toBe('function');
+  });
+
+  describe('Authorization header injection', () => {
+    it('should inject Authorization header when not present', () => {
+      const config = {};
+      new TVLabsService({ apiKey: 'test-api-key' }, {}, config);
+
+      expect(config.headers).toBeDefined();
+      expect(config.headers.Authorization).toBe('Bearer test-api-key');
+    });
+
+    it('should not override existing Authorization header', () => {
+      const config = {
+        headers: {
+          Authorization: 'Bearer existing-token',
+        },
+      };
+      new TVLabsService({ apiKey: 'test-api-key' }, {}, config);
+
+      expect(config.headers.Authorization).toBe('Bearer existing-token');
+    });
+
+    it('should preserve other headers when injecting Authorization', () => {
+      const config = {
+        headers: {
+          'X-Custom-Header': 'custom-value',
+        },
+      };
+      new TVLabsService({ apiKey: 'test-api-key' }, {}, config);
+
+      expect(config.headers['X-Custom-Header']).toBe('custom-value');
+      expect(config.headers.Authorization).toBe('Bearer test-api-key');
+    });
+  });
+});

package/vitest.config.cjs.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['test-integration/cjs/**/*.test.mjs'],
+    coverage: {
+      enabled: false,
+    },
+  },
+});

package/vitest.config.esm.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['test-integration/esm/**/*.test.mjs'],
+    coverage: {
+      enabled: false,
+    },
+  },
+});