@tvlabs/wdio-service 0.1.7 → 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 = ""
@@ -112,7 +117,7 @@ run();
 
 - **Type:** `string`
 - **Required:** No
-- **Description:** Slug of the App for build uploads. When provided in combination with `buildPath`, the build is uploaded under this specified App.
+- **Description:** The slug of the app on the TV Labs platform to use to upload the build. When not provided, the organization's default app is used. You may find or create an app on the [Apps page](https://tvlabs.ai/app/apps) in the TV Labs platform.
 
 ### `retries`
 
@@ -134,3 +139,41 @@ run();
 - **Required:** No
 - **Default:** `true`
 - **Description:** Controls whether or not to attach an `x-request-id` header to each request made to the TV Labs platform.
+
+### `continueOnError`
+
+- **Type:** `boolean`
+- **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.7";
+var version = "0.1.9";
 var packageJson = {
 	name: name,
 	version: version};
@@ -453,32 +453,52 @@ class TVLabsService {
     _capabilities;
     _config;
     log;
+    requestId;
     constructor(_options, _capabilities, _config) {
         this._options = _options;
         this._capabilities = _capabilities;
         this._config = _config;
-        this.log = new Logger('@tvlabs/wdio-server', this._config.logLevel);
+        this.log = new Logger('@tvlabs/wdio-service', this._config.logLevel);
         if (this.attachRequestId()) {
             this.setupRequestId();
         }
     }
+    lastRequestId() {
+        return this.requestId;
+    }
     onPrepare(_config, param) {
-        if (!Array.isArray(param)) {
-            throw new webdriverio.SevereServiceError('Multi-remote capabilities are not implemented. Contact TV Labs support if you are interested in this feature.');
+        try {
+            if (!Array.isArray(param)) {
+                throw new webdriverio.SevereServiceError('Multi-remote capabilities are not implemented. Contact TV Labs support if you are interested in this feature.');
+            }
+        }
+        catch (error) {
+            if (!this.continueOnError()) {
+                process.exit(1);
+            }
+            throw error;
         }
     }
     async beforeSession(_config, capabilities, _specs, _cid) {
-        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();
+        try {
+            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();
+        }
+        catch (error) {
+            if (!this.continueOnError()) {
+                process.exit(1);
+            }
+            throw error;
+        }
     }
     setupRequestId() {
         const originalTransformRequest = this._config.transformRequest;
@@ -491,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;
         };
     }
@@ -508,6 +529,12 @@ class TVLabsService {
             }
         }
     }
+    setRequestId(id) {
+        this.requestId = id;
+    }
+    continueOnError() {
+        return this._options.continueOnError ?? false;
+    }
     buildPath() {
         return this._options.buildPath;
     }

package/cjs/service.d.ts

@@ -5,11 +5,15 @@ 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;
     private sessionEndpoint;

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;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"}
+{"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/cjs/types.d.ts

@@ -9,6 +9,7 @@ export type TVLabsServiceOptions = {
     app?: string;
     reconnectRetries?: number;
     attachRequestId?: boolean;
+    continueOnError?: boolean;
 };
 export type TVLabsCapabilities = Capabilities.RequestedStandaloneCapabilities & {
     'tvlabs:session_id'?: string;

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;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,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/esm/index.js

@@ -110,7 +110,7 @@ class Logger {
 }
 
 var name = "@tvlabs/wdio-service";
-var version = "0.1.7";
+var version = "0.1.9";
 var packageJson = {
 	name: name,
 	version: version};
@@ -427,32 +427,52 @@ class TVLabsService {
     _capabilities;
     _config;
     log;
+    requestId;
     constructor(_options, _capabilities, _config) {
         this._options = _options;
         this._capabilities = _capabilities;
         this._config = _config;
-        this.log = new Logger('@tvlabs/wdio-server', this._config.logLevel);
+        this.log = new Logger('@tvlabs/wdio-service', this._config.logLevel);
         if (this.attachRequestId()) {
             this.setupRequestId();
         }
     }
+    lastRequestId() {
+        return this.requestId;
+    }
     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.');
+        try {
+            if (!Array.isArray(param)) {
+                throw new SevereServiceError('Multi-remote capabilities are not implemented. Contact TV Labs support if you are interested in this feature.');
+            }
+        }
+        catch (error) {
+            if (!this.continueOnError()) {
+                process.exit(1);
+            }
+            throw error;
         }
     }
     async beforeSession(_config, capabilities, _specs, _cid) {
-        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();
+        try {
+            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();
+        }
+        catch (error) {
+            if (!this.continueOnError()) {
+                process.exit(1);
+            }
+            throw error;
+        }
     }
     setupRequestId() {
         const originalTransformRequest = this._config.transformRequest;
@@ -465,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;
         };
     }
@@ -482,6 +503,12 @@ class TVLabsService {
             }
         }
     }
+    setRequestId(id) {
+        this.requestId = id;
+    }
+    continueOnError() {
+        return this._options.continueOnError ?? false;
+    }
     buildPath() {
         return this._options.buildPath;
     }

package/esm/service.d.ts

@@ -5,11 +5,15 @@ 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;
     private sessionEndpoint;

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;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"}
+{"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/types.d.ts

@@ -9,6 +9,7 @@ export type TVLabsServiceOptions = {
     app?: string;
     reconnectRetries?: number;
     attachRequestId?: boolean;
+    continueOnError?: boolean;
 };
 export type TVLabsCapabilities = Capabilities.RequestedStandaloneCapabilities & {
     'tvlabs:session_id'?: string;

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;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,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.7",
+  "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,26 +14,39 @@ import type {
 
 export default class TVLabsService implements Services.ServiceInstance {
   private log: Logger;
+  private requestId: string | undefined;
 
   constructor(
     private _options: TVLabsServiceOptions,
     private _capabilities: Capabilities.ResolvedTestrunnerCapabilities,
     private _config: Options.WebdriverIO,
   ) {
-    this.log = new Logger('@tvlabs/wdio-server', this._config.logLevel);
+    this.log = new Logger('@tvlabs/wdio-service', this._config.logLevel);
     if (this.attachRequestId()) {
       this.setupRequestId();
     }
   }
 
+  lastRequestId(): string | undefined {
+    return this.requestId;
+  }
+
   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.',
-      );
+    try {
+      if (!Array.isArray(param)) {
+        throw new SevereServiceError(
+          'Multi-remote capabilities are not implemented. Contact TV Labs support if you are interested in this feature.',
+        );
+      }
+    } catch (error) {
+      if (!this.continueOnError()) {
+        process.exit(1);
+      }
+
+      throw error;
     }
   }
 
@@ -43,41 +56,49 @@ export default class TVLabsService implements Services.ServiceInstance {
     _specs: string[],
     _cid: string,
   ) {
-    const buildPath = this.buildPath();
+    try {
+      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();
+      }
 
-    if (buildPath) {
-      const buildChannel = new BuildChannel(
-        this.buildEndpoint(),
+      const sessionChannel = new SessionChannel(
+        this.sessionEndpoint(),
         this.reconnectRetries(),
         this.apiKey(),
         this.logLevel(),
       );
 
-      await buildChannel.connect();
+      await sessionChannel.connect();
 
-      capabilities['tvlabs:build'] = await buildChannel.uploadBuild(
-        buildPath,
-        this.appSlug(),
+      capabilities['tvlabs:session_id'] = await sessionChannel.newSession(
+        capabilities,
+        this.retries(),
       );
 
-      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();
+    } catch (error) {
+      if (!this.continueOnError()) {
+        process.exit(1);
+      }
 
-    await sessionChannel.disconnect();
+      throw error;
+    }
   }
 
   private setupRequestId() {
@@ -100,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;
     };
@@ -122,6 +145,14 @@ export default class TVLabsService implements Services.ServiceInstance {
     }
   }
 
+  private setRequestId(id: string) {
+    this.requestId = id;
+  }
+
+  private continueOnError(): boolean {
+    return this._options.continueOnError ?? false;
+  }
+
   private buildPath(): string | undefined {
     return this._options.buildPath;
   }

package/src/types.ts

@@ -11,6 +11,7 @@ export type TVLabsServiceOptions = {
   app?: string;
   reconnectRetries?: number;
   attachRequestId?: boolean;
+  continueOnError?: boolean;
 };
 
 export type TVLabsCapabilities =