@tvlabs/wdio-service 0.1.0 → 0.1.2

package/src/service.ts

@@ -0,0 +1,128 @@
+import { SevereServiceError } from 'webdriverio';
+import * as crypto from 'crypto';
+import chalk from 'chalk';
+
+import { TVLabsChannel } from './channel.js';
+import { Logger } from './logger.js';
+
+import type { Services, Capabilities, Options } from '@wdio/types';
+import type {
+  TVLabsCapabilities,
+  TVLabsServiceOptions,
+  LogLevel,
+} from './types.js';
+
+export default class TVLabsService implements Services.ServiceInstance {
+  private log: Logger;
+
+  constructor(
+    private _options: TVLabsServiceOptions,
+    private _capabilities: Capabilities.ResolvedTestrunnerCapabilities,
+    private _config: Options.WebdriverIO,
+  ) {
+    this.log = new Logger('@tvlabs/wdio-server', this._config.logLevel);
+    if (this.attachRequestId()) {
+      this.setupRequestId();
+    }
+  }
+
+  onPrepare(
+    _config: Options.Testrunner,
+    param: Capabilities.TestrunnerCapabilities,
+  ) {
+    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: Omit<Options.Testrunner, 'capabilities'>,
+    capabilities: TVLabsCapabilities,
+    _specs: string[],
+    _cid: string,
+  ) {
+    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();
+  }
+
+  private setupRequestId() {
+    const originalTransformRequest = this._config.transformRequest;
+
+    this._config.transformRequest = (requestOptions: RequestInit) => {
+      const requestId = crypto.randomUUID();
+      const originalRequestOptions =
+        typeof originalTransformRequest === 'function'
+          ? originalTransformRequest(requestOptions)
+          : requestOptions;
+
+      if (typeof originalRequestOptions.headers === 'undefined') {
+        originalRequestOptions.headers = <HeadersInit>{};
+      }
+
+      this.setRequestHeader(
+        originalRequestOptions.headers,
+        'x-request-id',
+        requestId,
+      );
+
+      this.log.info(chalk.blue('ATTACHED REQUEST ID'), requestId);
+
+      return originalRequestOptions;
+    };
+  }
+
+  private setRequestHeader(
+    headers: RequestInit['headers'],
+    header: string,
+    value: string,
+  ) {
+    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;
+      }
+    }
+  }
+
+  private endpoint(): string {
+    return this._options.endpoint ?? 'wss://tvlabs.ai/appium';
+  }
+
+  private retries(): number {
+    return this._options.retries ?? 3;
+  }
+
+  private apiKey(): string {
+    return this._options.apiKey;
+  }
+
+  private logLevel(): LogLevel {
+    return this._config.logLevel ?? 'info';
+  }
+
+  private attachRequestId(): boolean {
+    return this._options.attachRequestId ?? true;
+  }
+
+  private reconnectRetries(): number {
+    return this._options.reconnectRetries ?? 5;
+  }
+}

package/src/types.ts

@@ -0,0 +1,46 @@
+import type { Capabilities } from '@wdio/types';
+
+export type LogLevel = 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
+
+export type TVLabsServiceOptions = {
+  apiKey: string;
+  endpoint?: string;
+  retries?: number;
+  reconnectRetries?: number;
+  attachRequestId?: boolean;
+};
+
+export type TVLabsCapabilities =
+  Capabilities.RequestedStandaloneCapabilities & {
+    'tvlabs:session_id'?: string;
+    'tvlabs:build'?: string;
+    'tvlabs:constraints'?: {
+      platform_key?: string;
+      device_type?: string;
+      make?: string;
+      model?: string;
+      year?: string;
+      minimum_chromedriver_major_version?: number;
+      supports_chromedriver?: boolean;
+    };
+    'tvlabs:match_timeout'?: number;
+    'tvlabs:device_timeout'?: number;
+  };
+
+export type TVLabsSessionRequestEventHandler = (
+  response: TVLabsSessionRequestUpdate,
+) => void;
+
+export type TVLabsSessionRequestUpdate = {
+  request_id: string;
+  session_id: string;
+  reason: string;
+};
+
+export type TVLabsSessionRequestResponse = {
+  request_id: string;
+};
+
+export type TVLabsSessionChannelParams = {
+  api_key: string;
+};

package/dist/channel.d.ts.map

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

package/dist/service.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE3E,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ,CAAC,eAAe;IAElE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;gBAFP,QAAQ,EAAE,oBAAoB,EAC9B,aAAa,EAAE,YAAY,CAAC,8BAA8B,EAC1D,OAAO,EAAE,OAAO,CAAC,WAAW;IAGtC,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;IAkBd,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,gBAAgB;CAGzB"}

package/dist/service.js

@@ -1,35 +0,0 @@
-import { SevereServiceError } from 'webdriverio';
-import { TVLabsChannel } from './channel.js';
-export default class TVLabsService {
-    _options;
-    _capabilities;
-    _config;
-    constructor(_options, _capabilities, _config) {
-        this._options = _options;
-        this._capabilities = _capabilities;
-        this._config = _config;
-    }
-    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());
-        await channel.connect();
-        capabilities['tvlabs:session_id'] = await channel.newSession(capabilities, this.retries());
-        await channel.disconnect();
-    }
-    endpoint() {
-        return this._options.endpoint || 'wss://tvlabs.ai/appium';
-    }
-    retries() {
-        return this._options.retries || 3;
-    }
-    apiKey() {
-        return this._options.apiKey;
-    }
-    reconnectRetries() {
-        return this._options.reconnectRetries || 5;
-    }
-}

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"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,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;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"}