@tvlabs/wdio-service 0.1.8 → 0.1.9

package/README.md

@@ -10,6 +10,8 @@
 
 ## 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.
@@ -74,7 +76,10 @@ async function run() {
     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 +146,34 @@ 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}`);
+```

package/cjs/index.js

@@ -136,7 +136,7 @@ class Logger {
 }
 
 var name = "@tvlabs/wdio-service";
-var version = "0.1.8";
+var version = "0.1.9";
 var packageJson = {
 	name: name,
 	version: version};
@@ -453,6 +453,7 @@ class TVLabsService {
     _capabilities;
     _config;
     log;
+    requestId;
     constructor(_options, _capabilities, _config) {
         this._options = _options;
         this._capabilities = _capabilities;
@@ -462,6 +463,9 @@ class TVLabsService {
             this.setupRequestId();
         }
     }
+    lastRequestId() {
+        return this.requestId;
+    }
     onPrepare(_config, param) {
         try {
             if (!Array.isArray(param)) {
@@ -507,7 +511,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 +529,9 @@ class TVLabsService {
             }
         }
     }
+    setRequestId(id) {
+        this.requestId = id;
+    }
     continueOnError() {
         return this._options.continueOnError ?? false;
     }

package/cjs/service.d.ts

@@ -5,11 +5,14 @@ export default class TVLabsService implements Services.ServiceInstance {
     private _capabilities;
     private _config;
     private log;
+    private requestId;
     constructor(_options: TVLabsServiceOptions, _capabilities: Capabilities.ResolvedTestrunnerCapabilities, _config: Options.WebdriverIO);
+    lastRequestId(): string | undefined;
     onPrepare(_config: Options.Testrunner, param: Capabilities.TestrunnerCapabilities): void;
     beforeSession(_config: Omit<Options.Testrunner, 'capabilities'>, capabilities: TVLabsCapabilities, _specs: string[], _cid: string): Promise<void>;
     private setupRequestId;
     private setRequestHeader;
+    private 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":"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;IAKlE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IANjB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAqB;gBAG5B,QAAQ,EAAE,oBAAoB,EAC9B,aAAa,EAAE,YAAY,CAAC,8BAA8B,EAC1D,OAAO,EAAE,OAAO,CAAC,WAAW;IAQtC,aAAa,IAAI,MAAM,GAAG,SAAS;IAInC,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;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/index.js

@@ -110,7 +110,7 @@ class Logger {
 }
 
 var name = "@tvlabs/wdio-service";
-var version = "0.1.8";
+var version = "0.1.9";
 var packageJson = {
 	name: name,
 	version: version};
@@ -427,6 +427,7 @@ class TVLabsService {
     _capabilities;
     _config;
     log;
+    requestId;
     constructor(_options, _capabilities, _config) {
         this._options = _options;
         this._capabilities = _capabilities;
@@ -436,6 +437,9 @@ class TVLabsService {
             this.setupRequestId();
         }
     }
+    lastRequestId() {
+        return this.requestId;
+    }
     onPrepare(_config, param) {
         try {
             if (!Array.isArray(param)) {
@@ -481,7 +485,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 +503,9 @@ class TVLabsService {
             }
         }
     }
+    setRequestId(id) {
+        this.requestId = id;
+    }
     continueOnError() {
         return this._options.continueOnError ?? false;
     }

package/esm/service.d.ts

@@ -5,11 +5,14 @@ export default class TVLabsService implements Services.ServiceInstance {
     private _capabilities;
     private _config;
     private log;
+    private requestId;
     constructor(_options: TVLabsServiceOptions, _capabilities: Capabilities.ResolvedTestrunnerCapabilities, _config: Options.WebdriverIO);
+    lastRequestId(): string | undefined;
     onPrepare(_config: Options.Testrunner, param: Capabilities.TestrunnerCapabilities): void;
     beforeSession(_config: Omit<Options.Testrunner, 'capabilities'>, capabilities: TVLabsCapabilities, _specs: string[], _cid: string): Promise<void>;
     private setupRequestId;
     private setRequestHeader;
+    private 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":"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;IAKlE,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IANjB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAqB;gBAG5B,QAAQ,EAAE,oBAAoB,EAC9B,aAAa,EAAE,YAAY,CAAC,8BAA8B,EAC1D,OAAO,EAAE,OAAO,CAAC,WAAW;IAQtC,aAAa,IAAI,MAAM,GAAG,SAAS;IAInC,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;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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tvlabs/wdio-service",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "WebdriverIO service that provides a better integration into TV Labs",
   "author": "Regan Karlewicz <regan@tvlabs.ai>",
   "license": "Apache-2.0",

package/src/service.ts

@@ -14,6 +14,7 @@ import type {
 
 export default class TVLabsService implements Services.ServiceInstance {
   private log: Logger;
+  private requestId: string | undefined;
 
   constructor(
     private _options: TVLabsServiceOptions,
@@ -26,6 +27,10 @@ export default class TVLabsService implements Services.ServiceInstance {
     }
   }
 
+  lastRequestId(): string | undefined {
+    return this.requestId;
+  }
+
   onPrepare(
     _config: Options.Testrunner,
     param: Capabilities.TestrunnerCapabilities,
@@ -116,7 +121,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 +145,10 @@ export default class TVLabsService implements Services.ServiceInstance {
     }
   }
 
+  private setRequestId(id: string) {
+    this.requestId = id;
+  }
+
   private continueOnError(): boolean {
     return this._options.continueOnError ?? false;
   }