@wdio/sauce-service 8.0.2 → 8.0.7

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAEA,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;AAUjD,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;IAKvC;;OAEG;IACG,SAAS,CACX,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,kBAAkB;IA4D3C,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,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"}

package/build/launcher.js

@@ -1,12 +1,9 @@
 import { performance, PerformanceObserver } from 'node:perf_hooks';
+import ip from 'ip';
 import SauceLabs from 'saucelabs';
 import logger from '@wdio/logger';
 import { makeCapabilityFactory } from './utils.js';
-const SC_RELAY_DEPCRECATION_WARNING = [
-    'The "scRelay" option is depcrecated and will be removed',
-    'with the upcoming versions of @wdio/sauce-service. Please',
-    'remove the option as tests should work identically without it.'
-].join(' ');
+import path from 'node:path';
 const MAX_SC_START_TRIALS = 3;
 const log = logger('@wdio/sauce-service');
 export default class SauceLauncher {
@@ -19,7 +16,8 @@ export default class SauceLauncher {
         this._options = _options;
         this._capabilities = _capabilities;
         this._config = _config;
-        this._api = new SauceLabs(this._config);
+        // @ts-expect-error https://github.com/saucelabs/node-saucelabs/issues/153
+        this._api = new SauceLabs.default(this._config);
     }
     /**
      * modify config and launch sauce connect
@@ -36,20 +34,16 @@ export default class SauceLauncher {
         const sauceConnectOpts = {
             noAutodetect: true,
             tunnelIdentifier: sauceConnectTunnelIdentifier,
-            ...this._options.sauceConnectOpts
+            ...this._options.sauceConnectOpts,
+            noSslBumpDomains: `127.0.0.1,localhost,${ip.address()}` + (this._options.sauceConnectOpts?.noSslBumpDomains
+                ? `,${this._options.sauceConnectOpts.noSslBumpDomains}`
+                : ''),
+            logger: this._options.sauceConnectOpts?.logger || ((output) => log.debug(`Sauce Connect Log: ${output}`)),
+            ...(!this._options.sauceConnectOpts?.logfile && this._config.outputDir
+                ? { logfile: path.join(this._config.outputDir, 'wdio-sauce-connect-tunnel.log') }
+                : {})
         };
-        let endpointConfigurations = {};
-        if (this._options.scRelay) {
-            log.warn(SC_RELAY_DEPCRECATION_WARNING);
-            const scRelayPort = sauceConnectOpts.sePort || 4445;
-            sauceConnectOpts.sePort = scRelayPort;
-            endpointConfigurations = {
-                protocol: 'http',
-                hostname: 'localhost',
-                port: scRelayPort
-            };
-        }
-        const prepareCapability = makeCapabilityFactory(sauceConnectTunnelIdentifier, endpointConfigurations);
+        const prepareCapability = makeCapabilityFactory(sauceConnectTunnelIdentifier);
         if (Array.isArray(capabilities)) {
             for (const capability of capabilities) {
                 prepareCapability(capability);
@@ -69,10 +63,12 @@ export default class SauceLauncher {
             log.info(`Sauce Connect successfully started after ${entry.duration}ms`);
         });
         obs.observe({ entryTypes: ['measure'] });
+        log.info('Starting Sauce Connect Tunnel');
         performance.mark('sauceConnectStart');
         this._sauceConnectProcess = await this.startTunnel(sauceConnectOpts);
         performance.mark('sauceConnectEnd');
-        performance.measure('bootTime', 'sauceConnectStart', 'sauceConnectEnd');
+        const bootimeMeasure = performance.measure('bootTime', 'sauceConnectStart', 'sauceConnectEnd');
+        log.info(`Started Sauce Connect Tunnel within ${bootimeMeasure.duration}ms`);
     }
     async startTunnel(sauceConnectOpts, retryCount = 0) {
         try {

package/build/service.d.ts

@@ -20,7 +20,7 @@ export default class SauceService implements Services.ServiceInstance {
     /**
      * gather information about runner
      */
-    beforeSession(_: never, __: never, ___: never, cid: string): void;
+    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>;

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAGA,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;IAOvC;;OAEG;IACH,aAAa,CAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM;IAkB3D,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,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;IA0B7E,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"}

package/build/service.js

@@ -1,5 +1,6 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import ip from 'ip';
 import SauceLabs from 'saucelabs';
 import logger from '@wdio/logger';
 import { isRDC, ansiRegex } from './utils.js';
@@ -24,13 +25,15 @@ export default class SauceService {
         this._capabilities = _capabilities;
         this._config = _config;
         this._options = { ...DEFAULT_OPTIONS, ...options };
-        this._api = new SauceLabs(this._config);
+        // @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;
     }
     /**
      * gather information about runner
      */
-    beforeSession(_, __, ___, cid) {
+    beforeSession(config, __, ___, cid) {
+        console.log('beforeSession');
         this._cid = cid;
         /**
          * if no user and key is specified even though a sauce service was
@@ -45,6 +48,12 @@ export default class SauceService {
             this._isServiceEnabled = false;
             this._config.key = 'unknown_key';
         }
+        /**
+         * update baseUrl if localhost so it can be reached by Sauce Connect
+         */
+        if (config.baseUrl && config.baseUrl.includes('localhost')) {
+            config.baseUrl = config.baseUrl.replace(/(localhost|127\.0\.0\.1)/, ip.address());
+        }
     }
     before(caps, specs, browser) {
         this._browser = browser;

package/build/utils.d.ts

@@ -53,6 +53,6 @@ export declare function isEmuSim(caps: Capabilities.DesiredCapabilities): boolea
  * @param {object} options - Additional options to set on the capability
  * @returns {function(object): void} - A function that mutates a single capability
  */
-export declare function makeCapabilityFactory(tunnelIdentifier: string, options: any): (capability: Capabilities.DesiredCapabilities) => void;
+export declare function makeCapabilityFactory(tunnelIdentifier: string): (capability: Capabilities.DesiredCapabilities) => void;
 export declare function ansiRegex(): RegExp;
 //# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,KAAK,CAAE,IAAI,EAAE,YAAY,CAAC,mBAAmB,WAM5D;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,YAAY,CAAC,mBAAmB,WAM/D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,gBACpD,aAAa,mBAAmB,UA2BvD;AAED,wBAAgB,SAAS,WAOxB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,KAAK,CAAE,IAAI,EAAE,YAAY,CAAC,mBAAmB,WAM5D;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,YAAY,CAAC,mBAAmB,WAM/D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,gBACtC,aAAa,mBAAmB,UAYvD;AAED,wBAAgB,SAAS,WAOxB"}

package/build/utils.js

@@ -62,25 +62,15 @@ export function isEmuSim(caps) {
  * @param {object} options - Additional options to set on the capability
  * @returns {function(object): void} - A function that mutates a single capability
  */
-export function makeCapabilityFactory(tunnelIdentifier, options) {
+export function makeCapabilityFactory(tunnelIdentifier) {
     return (capability) => {
-        // Check if this is a 'valid' W3C request, this is done with a simple check
-        // where we assume that if only one cap has `:` it's W3C, even if the request
-        // is a mix of JWP and W3C. This is hard to check
-        const isW3CRequest = Boolean(Object.keys(capability).find((cap) => cap.includes(':')));
-        // If the `sauce:options` are not provided and it is a W3C session
-        // then add it
-        if (!capability['sauce:options'] && isW3CRequest) {
+        // If the `sauce:options` are not provided and it is a W3C session then add it
+        if (!capability['sauce:options']) {
             capability['sauce:options'] = {};
         }
-        Object.assign(capability, options);
-        const sauceOptions = (isW3CRequest ? capability['sauce:options'] : capability);
-        sauceOptions.tunnelIdentifier = (capability.tunnelIdentifier ||
-            sauceOptions.tunnelIdentifier ||
+        capability['sauce:options'].tunnelIdentifier = (capability.tunnelIdentifier ||
+            capability['sauce:options'].tunnelIdentifier ||
             tunnelIdentifier);
-        if (isW3CRequest) {
-            delete capability.tunnelIdentifier;
-        }
     };
 }
 export function ansiRegex() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/sauce-service",
-  "version": "8.0.2",
+  "version": "8.0.7",
   "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,17 +27,16 @@
   "types": "./build/index.d.ts",
   "typeScriptVersion": "3.8.3",
   "dependencies": {
+    "@types/ip": "^1.1.0",
     "@wdio/logger": "8.0.0",
-    "@wdio/types": "8.0.0",
-    "@wdio/utils": "8.0.2",
+    "@wdio/types": "8.0.7",
+    "@wdio/utils": "8.0.7",
+    "ip": "^1.1.8",
     "saucelabs": "^7.1.3",
     "webdriverio": "8.0.2"
   },
-  "devDependencies": {
-    "@types/node": "^18.0.0"
-  },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "501a4b9056487cbcc994f610068e338e444cfe81"
+  "gitHead": "a874a82a727634d1323fff05c17455ba0907a020"
 }