@wdio/sauce-service 10.0.0-alpha.18 → 10.0.0

package/AGENTS.md

@@ -0,0 +1,17 @@
+# @wdio/sauce-service
+
+Package-specific notes. Shared package rules live in [../AGENTS.md](../AGENTS.md).
+
+## Tests
+
+Owners:
+
+- Sauce Connect launch, tunnel name, and retries: `tests/launcher.test.ts` against `src/launcher.ts`.
+- Worker hooks, job updates, and annotations: `tests/service.test.ts` against `src/service.ts`.
+- Real device versus emulator or simulator: `isRDC` in `src/utils.ts`, covered by `tests/utils.test.ts`.
+
+Classify sessions with `isRDC` only. Tunnel setup stopped consulting a separate emulator helper when Sauce Connect moved to W3C options.
+
+`onPrepare` leaves `hostname`, `port`, and `protocol` alone. Sauce Connect 5 removed the Selenium relay (`scRelay`).
+
+Keep a single `getBody` test for job body shape. Name each test after the hook it calls.

package/README.md

@@ -117,41 +117,45 @@ To authorize the Sauce Labs service your config needs to contain a [`user`](http
 
 ### maxErrorStackLength
 
+<Option type="number" default="5">
+
 This service will automatically push the error stack to Sauce Labs when a test fails. By default, it will only push the first 5 lines, but if needed this can be changed. Be aware that more lines will result in more WebDriver calls which might slow down the execution.
 
-Type: `number`<br />
-Default: `5`
+</Option>
 
 ### sauceConnect
 
+<Option type="Boolean" default="false">
+
 If `true` it runs Sauce Connect and opens a secure connection between a Sauce Labs virtual machine running your browser tests.
 
-Type: `Boolean`<br />
-Default: `false`
+</Option>
 
 ### sauceConnectOpts
 
+<Option type="Object" default={`{ }`}>
+
 Apply Sauce Connect options (e.g. to change port number or logFile settings). See [this list](https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/) for more information.
 
 NOTE: When specifying the options the `--` should be omitted. It can also be turned into camelCase (e.g. `shared-tunnel` or `sharedTunnel`).
 
-Type: `Object`<br />
-Default: `{ }`
+</Option>
 
 ### uploadLogs
 
+<Option type="Boolean" default="true">
+
 If `true` this option uploads all WebdriverIO log files to the Sauce Labs platform for further inspection. Make sure you have [`outputDir`](https://webdriver.io/docs/options#outputdir) set in your wdio config to write logs into files, otherwise data will be streamed to stdout and can't get uploaded.
 
-Type: `Boolean`<br />
-Default: `true`
+</Option>
 
 ### setJobName
 
-Allows users to dynamically set the job name based on worker parameters such as WebdriverIO configuration, used capabilities and the original suite title.
+<Option type="Function" default="(config, capabilities, suiteTitle) => suiteTitle">
 
-Type: `Function`<br />
-Default: `(config, capabilities, suiteTitle) => suiteTitle`
+Allows users to dynamically set the job name based on worker parameters such as WebdriverIO configuration, used capabilities and the original suite title.
 
+</Option>
 ----
 
 ## Overriding generated name metadata
@@ -163,3 +167,5 @@ You can override this by providing a value for the `name` desired capability, bu
 ----
 
 For more information on WebdriverIO see the [homepage](https://webdriver.io).
+
+

package/build/index.js

@@ -365,7 +365,7 @@ var SauceService = class {
       failures = 1;
     }
     const status = "status: " + (failures > 0 ? "failing" : "passing");
-    if (!this._browser.isMultiremote) {
+    if (!this._browser.isMultiRemote) {
       await this._uploadLogs(this._browser.sessionId);
       this._updateJobIdInTestRuns(this._browser.sessionId);
       try {
@@ -414,7 +414,7 @@ var SauceService = class {
       return;
     }
     const status = "status: " + (this._failures > 0 ? "failing" : "passing");
-    if (!this._browser.isMultiremote) {
+    if (!this._browser.isMultiRemote) {
       log2.info(`Update (reloaded) job with sessionId ${oldSessionId}, ${status}`);
       return this.updateJob(oldSessionId, this._failures, true);
     }
@@ -422,7 +422,7 @@ var SauceService = class {
     const browserName = mulitremoteBrowser.instances.filter(
       (browserName2) => mulitremoteBrowser.getInstance(browserName2).sessionId === newSessionId
     )[0];
-    log2.info(`Update (reloaded) multiremote job for browser "${browserName}" and sessionId ${oldSessionId}, ${status}`);
+    log2.info(`Update (reloaded) multi-remote job for browser "${browserName}" and sessionId ${oldSessionId}, ${status}`);
     return this.updateJob(oldSessionId, this._failures, true, browserName);
   }
   async updateJob(sessionId, failures, calledOnReload = false, browserName) {
@@ -442,7 +442,7 @@ var SauceService = class {
       }
       let testCnt = ++this._testCnt;
       const mulitremoteBrowser = this._browser;
-      if (this._browser && this._browser.isMultiremote) {
+      if (this._browser && this._browser.isMultiRemote) {
         testCnt = Math.ceil(testCnt / mulitremoteBrowser.instances.length);
       }
       body.name += ` (${testCnt})`;
@@ -471,7 +471,7 @@ var SauceService = class {
     if (!this._browser) {
       return;
     }
-    if (this._browser.isMultiremote) {
+    if (this._browser.isMultiRemote) {
       return Promise.all(Object.keys(this._capabilities).map(async (browserName) => {
         const multiRemoteBrowser = this._browser.getInstance(browserName);
         return multiRemoteBrowser.executeScript(annotation, []);

package/build/utils.d.ts

@@ -41,12 +41,6 @@
  * }
  */
 export declare function isRDC(caps: WebdriverIO.Capabilities): boolean;
-/**
- * Determine if this is an EMUSIM session
- * @param {object} caps
- * @returns {boolean}
- */
-export declare function isEmuSim(caps: WebdriverIO.Capabilities): boolean;
 /** Ensure capabilities are in the correct format for Sauce Labs
  * @param {string} tunnelName - The default Sauce Connect tunnel identifier
  * @param {object} options - Additional options to set on the capability

package/build/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,WAMnD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,WAMtD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,IAC5C,YAAY,WAAW,CAAC,YAAY,UAQ/C;AAED,wBAAgB,SAAS,WAOxB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,WAMnD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,IAC5C,YAAY,WAAW,CAAC,YAAY,UAQ/C;AAED,wBAAgB,SAAS,WAOxB"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@wdio/sauce-service",
-  "version": "10.0.0-alpha.18+dbf0f4971",
+  "version": "10.0.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",
   "license": "MIT",
   "engines": {
-    "node": ">=18.20.0"
+    "node": ">=22.19.0"
   },
   "repository": {
     "type": "git",
@@ -30,20 +30,20 @@
       "import": "./build/index.js"
     }
   },
-  "typeScriptVersion": "3.8.3",
+  "typeScriptVersion": "6.0.3",
   "dependencies": {
-    "@wdio/logger": "9.29.1",
-    "@wdio/types": "9.32.0",
-    "@wdio/utils": "9.32.0",
+    "@wdio/logger": "10.0.0",
+    "@wdio/types": "10.0.0",
+    "@wdio/utils": "10.0.0",
     "saucelabs": "^9.0.1",
-    "webdriverio": "9.32.0"
+    "webdriverio": "10.0.0"
   },
   "devDependencies": {
     "@types/ip": "^1.1.0",
-    "@wdio/globals": "10.0.0-alpha.18+dbf0f4971"
+    "@wdio/globals": "10.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dbf0f497130676040ce4212d9cf6459adfe16c42"
+  "gitHead": "38bd5ff4dccfaadccce4bd678286f00594623da2"
 }