@wdio/sauce-service 8.0.13 → 8.1.0

package/README.md

@@ -51,10 +51,18 @@ export const config = {
 };
 ```
 
-If you want to use an existing Sauce Connect tunnel you only need to provide or the `tunnelIdentifier`, or if you are using a parent tunnel the `parentTunnel` into you capabilities like this:
+If you want to use an existing Sauce Connect tunnel you only need to provide a `tunnelIdentifier`, or if you are using a parent tunnel, include the `parentTunnel` in the capabilities like this:
+
+
+<Tabs
+  defaultValue="tunnelidentifier"
+  values={[
+    {label: 'Tunnel Identifier', value: 'tunnelidentifier'},
+    {label: 'Parent Tunnel', value: 'parenttunnel'}
+  ]
+}>
+<TabItem value="tunnelidentifier">
 
-<!--DOCUSAURUS_CODE_TABS-->
-<!--Tunnel Identifier-->
 ```js
 export const config = {
     // ...
@@ -75,7 +83,10 @@ export const config = {
     // ...
 };
 ```
-<!--Parent Tunnel-->
+
+</TabItem>
+<TabItem value="parenttunnel">
+
 ```js
 export const config = {
     // ...
@@ -97,7 +108,9 @@ export const config = {
     // ...
 };
 ```
-<!--END_DOCUSAURUS_CODE_TABS-->
+
+</TabItem>
+</Tabs>
 
 If you want to use the Real Device cloud pass the `testobject_api_key` in the capabilities like this:
 

package/build/constants.d.ts

@@ -1,3 +1,3 @@
-import type { SauceServiceConfig } from './types';
+import type { SauceServiceConfig } from './types.js';
 export declare const DEFAULT_OPTIONS: Partial<SauceServiceConfig>;
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAEvD,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAEvD,CAAA"}

package/build/index.d.ts

@@ -1,6 +1,6 @@
 import SauceLauncher from './launcher.js';
 import SauceService from './service.js';
-import type { SauceServiceConfig } from './types';
+import type { SauceServiceConfig } from './types.js';
 export default SauceService;
 export declare const launcher: typeof SauceLauncher;
 export * from './types.js';

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,eAAe,CAAA;AACzC,OAAO,YAAY,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,eAAe,YAAY,CAAA;AAC3B,eAAO,MAAM,QAAQ,sBAAgB,CAAA;AACrC,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,aAAc,SAAQ,kBAAkB;SAAG;KACxD;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,eAAe,CAAA;AACzC,OAAO,YAAY,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD,eAAe,YAAY,CAAA;AAC3B,eAAO,MAAM,QAAQ,sBAAgB,CAAA;AACrC,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,aAAc,SAAQ,kBAAkB;SAAG;KACxD;CACJ"}

package/build/launcher.d.ts

@@ -1,6 +1,6 @@
-import { SauceConnectOptions, SauceConnectInstance } from 'saucelabs';
+import type { SauceConnectOptions, SauceConnectInstance } from 'saucelabs';
 import type { Services, Capabilities, Options } from '@wdio/types';
-import type { SauceServiceConfig } from './types';
+import type { SauceServiceConfig } from './types.js';
 export default class SauceLauncher implements Services.ServiceInstance {
     private _options;
     private _capabilities;

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAkB,EAAoB,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAElG,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAMjD,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ,CAAC,eAAe;IAK9D,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IANnB,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,oBAAoB,CAAC,CAAsB;gBAGvC,QAAQ,EAAE,kBAAkB,EAC5B,aAAa,EAAE,OAAO,EACtB,OAAO,EAAE,OAAO,CAAC,UAAU;IAMvC;;OAEG;IACG,SAAS,CACX,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,kBAAkB;IAyD3C,WAAW,CAAE,gBAAgB,EAAE,mBAAmB,EAAE,UAAU,SAAI,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA4BxG;;OAEG;IACH,UAAU;CAOb"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAoB,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAG5F,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAMpD,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ,CAAC,eAAe;IAK9D,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IANnB,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAsB;gBAGvC,QAAQ,EAAE,kBAAkB,EAC5B,aAAa,EAAE,OAAO,EACtB,OAAO,EAAE,OAAO,CAAC,UAAU;IAKvC;;OAEG;IACG,SAAS,CACX,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,kBAAkB;IAyD3C,WAAW,CAAE,gBAAgB,EAAE,mBAAmB,EAAE,UAAU,SAAI,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA4BxG;;OAEG;IACH,UAAU;CAOb"}

package/build/launcher.js

@@ -16,7 +16,6 @@ export default class SauceLauncher {
         this._options = _options;
         this._capabilities = _capabilities;
         this._config = _config;
-        // @ts-expect-error https://github.com/saucelabs/node-saucelabs/issues/153
         this._api = new SauceLabs.default(this._config);
     }
     /**

package/build/service.d.ts

@@ -1,7 +1,7 @@
-import { Job } from 'saucelabs';
+import type { Job } from 'saucelabs';
 import type { Services, Capabilities, Options, Frameworks } from '@wdio/types';
 import type { Browser, MultiRemoteBrowser } from 'webdriverio';
-import type { SauceServiceConfig } from './types';
+import type { SauceServiceConfig } from './types.js';
 export default class SauceService implements Services.ServiceInstance {
     private _capabilities;
     private _config;
@@ -23,7 +23,7 @@ export default class SauceService implements Services.ServiceInstance {
     beforeSession(config: Options.Testrunner, __: never, ___: never, cid: string): void;
     before(caps: unknown, specs: string[], browser: Browser<'async'> | MultiRemoteBrowser<'async'>): void;
     beforeSuite(suite: Frameworks.Suite): Promise<void>;
-    beforeTest(test: Frameworks.Test): Promise<unknown>;
+    beforeTest(test: Frameworks.Test): Promise<any>;
     afterSuite(suite: Frameworks.Suite): void;
     private _reportErrorLog;
     afterTest(test: Frameworks.Test, context: unknown, results: Frameworks.TestResult): void;
@@ -33,13 +33,13 @@ export default class SauceService implements Services.ServiceInstance {
      */
     beforeFeature(uri: unknown, feature: {
         name: string;
-    }): Promise<unknown>;
+    }): Promise<any>;
     /**
      * Runs before a Cucumber Scenario.
      * @param world world object containing information on pickle and test step
      */
-    beforeScenario(world: Frameworks.World): Promise<unknown> | undefined;
-    beforeStep(step: Frameworks.PickleStep): Promise<unknown>;
+    beforeScenario(world: Frameworks.World): Promise<any> | undefined;
+    beforeStep(step: Frameworks.PickleStep): Promise<any>;
     /**
      * Runs after a Cucumber Scenario.
      * @param world world object containing information on pickle and test step
@@ -52,7 +52,7 @@ export default class SauceService implements Services.ServiceInstance {
     /**
      * update Sauce Labs job
      */
-    after(result: number): Promise<unknown>;
+    after(result: number): Promise<any>;
     /**
      * upload files to Sauce Labs platform
      * @param jobId id of the job
@@ -68,7 +68,7 @@ export default class SauceService implements Services.ServiceInstance {
     /**
      * Update the running Sauce Labs Job with an annotation
      */
-    setAnnotation(annotation: string): Promise<unknown>;
+    setAnnotation(annotation: string): Promise<any>;
     private _setJobName;
 }
 //# sourceMappingURL=service.d.ts.map

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAIA,OAAkB,EAAoB,GAAG,EAAE,MAAM,WAAW,CAAA;AAE5D,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAI9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAMjD,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ,CAAC,eAAe;IAgB7D,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IAhBnB,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,oBAAoB,CAAI;IAChC,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,iBAAiB,CAAO;IAChC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,IAAI,CAAK;gBAGb,OAAO,EAAE,kBAAkB,EACnB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,OAAO,EAAE,OAAO,CAAC,UAAU;IAQvC;;OAEG;IACH,aAAa,CAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM;IAyB7E,MAAM,CAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAazF,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAepC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAwCvC,UAAU,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAMnC,OAAO,CAAC,eAAe;IAKvB,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAyClF,SAAS,CAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAetE;;OAEG;IACG,aAAa,CAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAsB5D;;;OAGG;IACH,cAAc,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAajC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU;IAY7C;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAOtE;;OAEG;IACG,KAAK,CAAE,MAAM,EAAE,MAAM;IAsC3B;;;;OAIG;YACW,WAAW;IAezB,QAAQ,CAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAmB9C,SAAS,CAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAMlG;;OAEG;IACH,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAgDvE;;OAEG;IACG,aAAa,CAAE,UAAU,EAAE,MAAM;YAmBzB,WAAW;CAa5B"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAoB,GAAG,EAAE,MAAM,WAAW,CAAA;AAGtD,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAI9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAMpD,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ,CAAC,eAAe;IAgB7D,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IAhBnB,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,oBAAoB,CAAI;IAChC,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,iBAAiB,CAAO;IAChC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,IAAI,CAAK;gBAGb,OAAO,EAAE,kBAAkB,EACnB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,OAAO,EAAE,OAAO,CAAC,UAAU;IAOvC;;OAEG;IACH,aAAa,CAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM;IAyB7E,MAAM,CAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IAazF,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAepC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAwCvC,UAAU,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAMnC,OAAO,CAAC,eAAe;IAKvB,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAyClF,SAAS,CAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAetE;;OAEG;IACG,aAAa,CAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAsB5D;;;OAGG;IACH,cAAc,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAajC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU;IAY7C;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAOtE;;OAEG;IACG,KAAK,CAAE,MAAM,EAAE,MAAM;IAsC3B;;;;OAIG;YACW,WAAW;IAezB,QAAQ,CAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAmB9C,SAAS,CAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAMlG;;OAEG;IACH,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAgDvE;;OAEG;IACG,aAAa,CAAE,UAAU,EAAE,MAAM;YAmBzB,WAAW;CAe5B"}

package/build/service.js

@@ -25,7 +25,6 @@ export default class SauceService {
         this._capabilities = _capabilities;
         this._config = _config;
         this._options = { ...DEFAULT_OPTIONS, ...options };
-        // @ts-expect-error https://github.com/saucelabs/node-saucelabs/issues/153
         this._api = new SauceLabs.default(this._config);
         this._maxErrorStackLength = this._options.maxErrorStackLength || this._maxErrorStackLength;
     }
@@ -299,7 +298,7 @@ export default class SauceService {
      * VM message data
      */
     getBody(failures, calledOnReload = false, browserName) {
-        let body = {};
+        const body = {};
         /**
          * add reload count to title if reload is used
          */
@@ -318,8 +317,8 @@ export default class SauceService {
             }
             body.name += ` (${testCnt})`;
         }
-        let caps = this._capabilities['sauce:options'] || this._capabilities;
-        for (let prop of jobDataProperties) {
+        const caps = this._capabilities['sauce:options'] || this._capabilities;
+        for (const prop of jobDataProperties) {
             if (!caps[prop]) {
                 continue;
             }
@@ -350,8 +349,9 @@ export default class SauceService {
         return this._browser.execute(annotation);
     }
     async _setJobName(suiteTitle) {
-        if (!suiteTitle)
+        if (!suiteTitle) {
             return;
+        }
         let jobName = suiteTitle;
         if (this._options.setJobName) {
             jobName = this._options.setJobName(this._config, this._capabilities, suiteTitle);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/sauce-service",
-  "version": "8.0.13",
+  "version": "8.1.0",
   "description": "WebdriverIO service that provides a better integration into Sauce Labs",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service",
@@ -27,16 +27,18 @@
   "types": "./build/index.d.ts",
   "typeScriptVersion": "3.8.3",
   "dependencies": {
-    "@types/ip": "^1.1.0",
-    "@wdio/logger": "8.0.0",
-    "@wdio/types": "8.0.11",
-    "@wdio/utils": "8.0.13",
+    "@wdio/logger": "8.1.0",
+    "@wdio/types": "8.1.0",
+    "@wdio/utils": "8.1.0",
     "ip": "^1.1.8",
     "saucelabs": "^7.1.3",
     "webdriverio": "8.0.2"
   },
+  "devDependencies": {
+    "@types/ip": "^1.1.0"
+  },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "912db21d2cd4552a02b776ba74cae05440b076de"
+  "gitHead": "f505134606f99129c816acb00f22e39032e60820"
 }