chore: publish

- appium@2.1.0
 - @appium/base-driver@9.3.17
 - @appium/base-plugin@2.2.17
 - @appium/doctor@2.0.23
 - @appium/docutils@0.4.6
 - @appium/driver-test-support@0.4.12
 - @appium/execute-driver-plugin@3.0.16
 - @appium/fake-driver@5.2.7
 - @appium/fake-plugin@3.1.21
 - @appium/images-plugin@2.1.3
 - @appium/opencv@2.1.2
 - @appium/plugin-test-support@0.3.20
 - @appium/support@4.1.4
 - @appium/test-support@3.0.22
 - @appium/typedoc-plugin-appium@0.6.6
 - @appium/types@0.13.3
 - @appium/universal-xml-plugin@1.0.10

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -80,7 +80,7 @@ body:
       placeholder: 'https://gist.github.com/...'
   - type: textarea
     attributes:
-      label: Futher Information
+      label: Further Information
       description: |
         Links? References? Anything that will give us more context about the issue you are encountering!
 

.github/workflows/build.yml

@@ -42,21 +42,33 @@ permissions:
   contents: read
 
 jobs:
+  prepare_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      versions: ${{ steps.generate-matrix.outputs.versions }}
+    steps:
+    - name: Select 3 most recent LTS versions of Node.js
+      id: generate-matrix
+      run: echo "versions=$(curl -s https://endoflife.date/api/nodejs.json | jq -c '[[.[] | select(.lts != false)][:3] | .[].cycle | tonumber]')" >> "$GITHUB_OUTPUT"
+
   test:
+    needs:
+    - prepare_matrix
     name: Tests
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: ${{ fromJSON(needs.prepare_matrix.outputs.versions) }}
         os:
         - ubuntu-latest
-        - windows-latest
+        # TODO: Windows is not stable and slow to run
+        # - windows-latest
         # TODO: Enable below envs after all tests have been verified green
         # - macos-latest
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+        uses: actions/setup-node@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
@@ -82,7 +94,7 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
       - name: Install dependencies
         uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
         with:

.github/workflows/clean-cache.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
 
       - name: Cleanup
         run: |

.github/workflows/deploy.yml

@@ -18,15 +18,15 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+        uses: actions/setup-node@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install Appium
         run: |
           if [[ "$GITHUB_REF_TYPE" == tag ]]; then
-            npm i -g $GITHUB_REF_NAME
+            npm i --location=global $GITHUB_REF_NAME
           else
-            npm i -g appium@next
+            npm i --location=global appium
           fi
         shell: bash
       - name: Install drivers and plugins

.github/workflows/docs.yml

@@ -35,7 +35,7 @@ jobs:
     name: Docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
       - name: Install dependencies (Node.js)
         uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
         with:

.github/workflows/fossa.yml

@@ -11,7 +11,7 @@ jobs:
     name: Run FOSSA Analysis
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
         with:
           ref: master
       - name: Install dependencies

.github/workflows/publish-doc.yml

@@ -0,0 +1,38 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Publish docs
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - run: |
+        git config user.name github-actions
+        git config user.email github-actions@github.com
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies (Node.js)
+      uses: bahmutov/npm-install@1a235c31658a322a3b024444759650ee6345c26d # tag=v1
+      with:
+        useRollingCache: true
+        install-command: npm ci
+    - name: Install dependencies (Python)
+      run: pip install -r packages/docutils/requirements.txt
+    - name: Publish docs
+      run: |
+        cd packages/appium
+        npm run publish:docs

.github/workflows/renovate.yml

@@ -19,7 +19,7 @@ jobs:
     name: Check Renovate Configs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
       - name: Validate Renovate Config
         uses: rinchsan/renovate-config-validator@1ea1e8514f6a33fdd71c40b0a5fa3512b9e7b936 # tag=v0
         with:

.lintstagedrc.js

@@ -1,6 +1,5 @@
 module.exports = {
-  '*.js': ['eslint --fix', 'prettier --write'],
-  '*.ts': ['prettier --write'],
+  '*.(js|ts)': ['eslint --fix', 'prettier --write'],
   'appium-config-schema.js': () => [
     'npm run --workspace=./packages/schema build',
     'git add -A packages/schema/lib/appium-config.schema.json',

README.md

@@ -16,18 +16,16 @@ See the full list of
 [officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
 [third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
 
-:bangbang: Major documentation revision in progress
+:bangbang: The current Appium 2.0 documentation can be found [here](https://appium.io/docs/en/latest/).
 
-:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
+:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
 
-Appium is in the final stages of a major revision (to version 2.0). As such, the documentation
-found around the web may not be correct. The current Appium 2.0 documentation is very much in
-progress. Currently, it can be found [here](https://appium.io/docs/en/latest/).
+:bangbang: If you still use the deprecated Appium Desktop containing the built-in server then you won't be able to upgrade to Appium 2. Consider switching to [Appium Inspector](https://github.com/appium/appium-inspector) instead.
 
 ### Requirements
 
 - macOS, Linux or Windows operating system
-- Node.js 14+
+- Node.js 16+. Any relevant [LTS release](https://nodejs.dev/en/about/releases/) should work just fine.
 - NPM (Node Package Manager) 8+
 
 These are only server requirements. Each driver might have its own requirements. Consider checking the corresponding driver tutorial for more details.
@@ -37,10 +35,16 @@ These are only server requirements. Each driver might have its own requirements.
 To install Appium 2 server using Node Package Manager (npm) run the following command:
 
 ```bash
-npm install -g appium@next
+npm i --location=global appium
 ```
 
-:bangbang: Running `npm install -g appium` would still install Appium 1 because version 2 is in its late beta stage.
+To update Appium 2 server using Node Package Manager (npm) run the following command:
+
+ ```bash
+npm install --location=global appium@latest
+```
+
+:bangbang: Make sure Appium 1 is fully uninstalled before upgrading it to Appium 2 (`npm uninstall --location=global appium`). Unexpected errors might appear if this has not been done.
 
 ### Drivers
 
@@ -190,10 +194,6 @@ Repo](https://github.com/appium/appium/tree/master/packages/appium/docs) as well
 Please take a look at our [contribution documentation](CONTRIBUTING.md)
 for instructions on how to build, test, and run Appium from the source.
 
-### Roadmap
-
-Interested in where Appium is heading in the future? Check out the [Roadmap](ROADMAP.md)
-
 ### Project History, Credits & Inspiration
 
 * [History](https://appium.io/docs/en/latest/intro/history/)

ROADMAP.md

@@ -1,59 +0,0 @@
-Appium Roadmap
----------------
-
-This document is designed to be a living record of the current and projected
-priorities for the Appium project. It is, of course, always subject to change
-and exists solely to give the community an idea of where we're going. The
-roadmap is set by the Appium core team. If you have feature suggestions for
-Appium, please submit a [GitHub issue](https://github.com/appium/appium/issues)
-and, if of sufficient size and approved by the team, it will be added here. If
-you have concerns about the roadmap, you can e-mail the Appium devs at
-`appium-developers@googlegroups.com` or raise a GitHub issue. Note that
-bugfixes and miscellaneous features are not considered "roadmap projects", and
-will be addressed in the due course of normal Appium development. This page
-exists to outline large-scale future plans for Appium.
-
-## Current Roadmap Projects
-
-| Project | Description | ETD | Projected Appium Release |
-|---------|-------------|-----|--------------------------|
-|[Appium CI + Metrics Improvements](https://github.com/appium/appium/issues/7168)|We have CI servers running via Cloudbees that we don't understand and which break. Let's document and own them so they work reliably. Also, let's implement gathering various metrics about driver performance so we can track this over time and ensure we're not releasing a driver which has decreased in performance or reliability.|Q2 2017|N/A|
-
-## Upcoming Projects (in rough order of priority)
-
-| Project | Description |
-|---------|-------------|
-|[Appium Client Library Updates](https://github.com/appium/appium/issues/7170)|It's been too long since we ensured that Appium's client libraries were up to date with the server|
-|[Test App Overhaul](https://github.com/appium/appium/issues/7172)|Our current test applications (the ones used to test Appium's iOS and Android support) are not ideal. We use too many of them and the ones we use have a random hodgepodge of app SDK features, sometimes not enough to sufficiently test automation support. It'd be great to find a way to ensure our test app(s) have all the features we need to test, and keep in sync with our requirements.|
-|[iOS Test Startup Time Improvement](https://github.com/appium/appium/issues/7173)|iOS startup times have gotten progressively longer with each iOS release. In part this is Apple's fault and there's not anything we can do about it. But we should investigate and see if we can be more efficient in how we start, especially given that we can now focus on XCUITest and leave Instruments behind|
-|[Appium Dearchitecture](https://github.com/appium/appium/issues/7174)|OK, we went a bit overboard in Appium 1.5 by exploding Appium into 40+ repos and NPM packages. Let's think a little more critically about it and consolidate into the minimal number of repos/packages that make sense for our code and community patterns.|
-|[Appium 2.0](https://github.com/appium/appium/issues/7175)|Appium, rather than bundling all the separate drivers by default, becomes a driver management interface (in addition to continuing to play the role of automation frontend server). Appium gets a set of CLI tools for users to pick and choose which drivers and versions of drivers they want to use via Appium|
-
-## Projects Under Consideration (unplanned and unprioritized)
-
-| Project | Description |
-|---------|-------------|
-|Windows Phone Support|There has been some work done on automating Windows Phone apps. We could take this all the way to integration with Appium in the form of a WindowsDriver.|
-|Apple Watch support|Appium should support Apple Watch apps via the Watch simulator|
-|Unity3d backend POC|This is a research project to determine whether we can add some kind of support for 3d game automation, probably based on the Unity3d game development platform.|
-
-## Completed Roadmap Projects
-
-| Project | Description | Completed | Appium Release | Notes |
-|---------|-------------|-----------|----------------|-------|
-|[Sample Code Overhaul](https://github.com/appium/appium/issues/7171)|Our sample code repo has grown tangled and broken. Let's make a new one with minimal examples which are the same across every language, and actually maintain the repo so as not to let it become overgrown.|
-|[Onboarding Overhaul](https://github.com/appium/appium/issues/7169)|Have a new site built with MkDocs that documents all of the Selenium and Appium commands with code samples|1/2018|n/a|appium.io|
-|[New Appium GUIs](https://github.com/appium/appium/issues/7167)|The current Appium GUIs (Appium.app and Appium.exe) have a number of issues. They aren't maintained by the core Appium team. They're written in Objective-C and C# respectively: two languages, and specifically, two languages other than Appium's core language. Because of this they lag behind the Appium server and are often broken. However, users love them primarily because of the Inspector feature (the thing that lets them graphically navigate their app), so we have to field a ton of complaints about these projects. There's an opportunity to start over. With [Electron](http://electron.atom.io/), we'd be able to take the new version of Appium we're working on and embed it directly inside a Node-based GUI app written using the languages and technologies the core team is experienced with. We'd have one codebase and could distribute the app on Mac, Windows, and Linux. The GUIs would become an official part of Appium's release cycle so they wouldn't be broken.|3/2017|N/A|[Appium Desktop website](https://github.com/appium/appium-desktop)|
-|[Android 7.1.1 Support](https://github.com/appium/appium/issues/7165)|Google has released Android 7.1.1 (API Level 25). Ensure it works with UiAutomator 1/2|2/2017|1.6.4||
-|[Android 7.0 Support](https://github.com/appium/appium/issues/7156)|Support Android 7 (Nougat)|11/2016|1.6.3||
-|[iOS 10.2 Support](https://github.com/appium/appium/issues/7166)|Support iOS 10.2|11/2016|1.6.1||
-|[iOS 10.1 Support](https://github.com/appium/appium/issues/7105)|Support iOS 10.1|11/2016|1.6.1||
-|UiAutomator2 integration|Google has released [UiAutomator 2](http://developer.android.com/reference/android/support/test/uiautomator/package-summary.html), and it promises to fix some issues and limitations with the previous UiAutomator support. We will build this inside of Selendroid since it requires an instrumentation context.|10/2016?|1.6.0|
-|XCUITest integration / iOS 10 support|Instruments + UIAutomation has been working well for many Appium users, but requires crazy workarounds to deal with bugs which remain unfixed on the Apple side. Also, UIAutomation has been removed in favor of XCUITest for iOS 10+. This new backend would exist alongside the UIAutomation backend.|10/2016|1.6.0||
-|iOS 9.3 support|Appium should support iOS 9.3 / Xcode 7.3|3/2016|1.5.1||
-|[Architecture Overhaul](https://github.com/appium/appium/issues/5169)|Appium's architecture has grown unwieldy enough that adding new features and preventing regressions has become difficult. A rearchitecture is in order to solve these issues as well as migrate the codebase to a form of JS much easier to work in and understand.|2/2015|1.5.0||
-|iOS 9.2 support|Appium should support iOS 9.2 / Xcode 7.2|11/2015|1.4.14||
-|iOS 9.1 support|Appium should support iOS 9.1 / Xcode 7.1|10/2015|1.4.12||
-|iOS 9.0 support|Appium should support iOS 9.0 / Xcode 7.0|10/2015|1.4.11||
-|iOS 8.4 support|Appium should support iOS 8.4 / Xcode 6.2|5/2015|1.4.0||
-|Appium CI|Appium has unique needs for Continuous Integration because of the highly specialized environments required (iOS simulators, Xcode, Android emulators, the Android SDK, etc...). We therefore need to create a custom CI solution (perhaps sitting underneath Cloudbees or some other OSS-friendly CI server) that can be used for all Appium projects which need integration tests.|5/2015|_N/A_|Usage instructions at [appium/appium-ci](https://github.com/appium/appium-ci)|

package.json

@@ -84,45 +84,45 @@
     "singleQuote": true
   },
   "devDependencies": {
-    "@colors/colors": "1.5.0",
-    "@commitlint/cli": "17.6.5",
-    "@commitlint/config-conventional": "17.6.5",
+    "@colors/colors": "1.6.0",
+    "@commitlint/cli": "17.6.7",
+    "@commitlint/config-conventional": "17.6.7",
     "@tsconfig/node14": "1.0.3",
     "@types/chai": "4.3.5",
     "@types/chai-as-promised": "7.1.5",
     "@types/diff": "5.0.3",
     "@types/mocha": "10.0.1",
-    "@types/node": "18.16.16",
+    "@types/node": "18.16.20",
     "@types/semver": "7.5.0",
-    "@types/sinon": "10.0.15",
+    "@types/sinon": "10.0.16",
     "@types/sinon-chai": "3.2.9",
     "@types/source-map-support": "0.5.6",
     "@types/teen_process": "2.0.0",
-    "@types/ws": "8.5.4",
+    "@types/ws": "8.5.5",
     "@types/yargs": "17.0.24",
-    "@typescript-eslint/eslint-plugin": "5.59.8",
-    "@typescript-eslint/parser": "5.59.8",
+    "@typescript-eslint/eslint-plugin": "5.62.0",
+    "@typescript-eslint/parser": "5.62.0",
     "asyncbox": "2.9.4",
     "chai": "4.3.7",
     "chai-as-promised": "7.1.1",
     "chai-webdriverio-async": "2.7.0",
     "conventional-changelog-conventionalcommits": "5.0.0",
     "cpy-cli": "4.2.0",
-    "eslint": "8.42.0",
-    "eslint-config-prettier": "8.8.0",
+    "eslint": "8.46.0",
+    "eslint-config-prettier": "8.10.0",
     "eslint-find-rules": "4.1.0",
     "eslint-import-resolver-typescript": "3.5.5",
-    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-import": "2.28.0",
     "eslint-plugin-mocha": "10.1.0",
     "eslint-plugin-promise": "6.1.1",
     "fancy-log": "2.0.0",
     "finalhandler": "1.2.0",
     "get-port": "5.1.1",
-    "handlebars": "4.7.7",
+    "handlebars": "4.7.8",
     "husky": "8.0.3",
-    "json-schema-to-typescript": "13.0.1",
+    "json-schema-to-typescript": "13.0.2",
     "lerna": "6.6.2",
-    "lint-staged": "13.2.2",
+    "lint-staged": "13.2.3",
     "log-symbols": "4.1.0",
     "midnight-smoker": "2.0.4",
     "mjpeg-consumer": "2.0.0",
@@ -134,7 +134,7 @@
     "rewiremock": "3.14.5",
     "rimraf": "5.0.1",
     "serve-static": "1.15.0",
-    "sinon": "15.1.0",
+    "sinon": "15.2.0",
     "sinon-chai": "3.7.0",
     "sync-monorepo-packages": "1.0.2",
     "through2": "4.0.2",
@@ -143,9 +143,9 @@
     "typedoc": "0.23.28",
     "typedoc-plugin-markdown": "3.14.0",
     "typedoc-plugin-resolve-crossmodule-references": "0.3.3",
-    "typescript": "4.9.5",
+    "typescript": "5.0.4",
     "validate.js": "0.13.1",
-    "webdriverio": "7.31.1",
+    "webdriverio": "7.32.3",
     "ws": "8.13.0",
     "yaml-js": "0.3.1"
   },

packages/appium/CHANGELOG.md

@@ -3,6 +3,54 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.1.0](https://github.com/appium/appium/compare/appium@2.0.1...appium@2.1.0) (2023-08-17)
+
+
+### Features
+
+* **base-driver:** Make it possible to provide settings as a map in session capabilities ([#18970](https://github.com/appium/appium/issues/18970)) ([aaf58c3](https://github.com/appium/appium/commit/aaf58c3de66fee2eb10225d05e156e7416a4ac79))
+
+
+### Bug Fixes
+
+* **appium:** Fix the plural form ([97d8f0d](https://github.com/appium/appium/commit/97d8f0df44d915b346a6ecd0d052369dd80a9569))
+* **appium:** update dependency winston to v3.10.0 ([b85a92a](https://github.com/appium/appium/commit/b85a92a912b3d2854e8102b41119fc780e1a6cc2))
+* **appium:** Update the GET /status response to be in sync with the standard ([#18972](https://github.com/appium/appium/issues/18972)) ([5a26111](https://github.com/appium/appium/commit/5a2611137b2a7428bb2e593fc945e21874c4cdae))
+* **support:** update dependency glob to v10 ([#18490](https://github.com/appium/appium/issues/18490)) ([aaf31a5](https://github.com/appium/appium/commit/aaf31a577cb0b9cbe22646dcd888dc393a03aa11))
+* **support:** update dependency semver to v7.5.4 ([03ddcdf](https://github.com/appium/appium/commit/03ddcdfcafbccf6698868a272e499cbdac41d791))
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
+## [2.0.1](https://github.com/appium/appium/compare/appium@2.0.0...appium@2.0.1) (2023-07-24)
+
+
+### Bug Fixes
+
+* **appium:** ensure plugin commands reset newCommandTimeout ([41836a4](https://github.com/appium/appium/commit/41836a4a7bfb0d7602839c081a4e3c4792e869df))
+* **support:** update dependency teen_process to v2.0.4 ([151c19c](https://github.com/appium/appium/commit/151c19c1c3b4c9b94aba10033c2d863f567d849b))
+
+
+
+## [2.0.0-rc.5](https://github.com/appium/appium/compare/appium@2.0.0-rc.4...appium@2.0.0-rc.5) (2023-07-03)
+
+
+### Bug Fixes
+
+* **appium:** restrict address to ipv6/hostname ([#18824](https://github.com/appium/appium/issues/18824)) ([f09fbb6](https://github.com/appium/appium/commit/f09fbb64dce0e179a007f3a0ae9800e61fbe90eb)), closes [#18716](https://github.com/appium/appium/issues/18716)
+* **appium:** type fixes for ts v5 ([c13333b](https://github.com/appium/appium/commit/c13333bb979ee3409e6a62a5800c629781553b42))
+* **support:** update dependency semver to v7.5.3 ([ed1856d](https://github.com/appium/appium/commit/ed1856d720c442842d5c3fe5f6caeccb8229b5f1))
+
+
+
+## [2.0.0-rc.4](https://github.com/appium/appium/compare/appium@2.0.0-rc.3...appium@2.0.0-rc.4) (2023-06-29)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
 ## [2.0.0-rc.3](https://github.com/appium/appium/compare/appium@2.0.0-rc.2...appium@2.0.0-rc.3) (2023-06-15)
 
 **Note:** Version bump only for package appium

packages/appium/README.md

@@ -16,18 +16,16 @@ See the full list of
 [officially-supported](https://appium.io/docs/en/latest/ecosystem/#drivers) and
 [third-party](https://appium.io/docs/en/latest/ecosystem/#other-drivers) drivers for more details.
 
-:bangbang: Major documentation revision in progress
+:bangbang: The current Appium 2.0 documentation can be found [here](https://appium.io/docs/en/latest/).
 
-:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x anymore, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
+:bangbang: Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. All recent versions of officially supported platform drivers are not compatible to Appium 1.x, and require Appium 2 to run. [Please read the migration guide from 1.x to 2.0](https://appium.io/docs/en/latest/guides/migrating-1-to-2/) to manage the Appium server.
 
-Appium is in the final stages of a major revision (to version 2.0). As such, the documentation
-found around the web may not be correct. The current Appium 2.0 documentation is very much in
-progress. Currently, it can be found [here](https://appium.io/docs/en/latest/).
+:bangbang: If you still use the deprecated Appium Desktop containing the built-in server then you won't be able to upgrade to Appium 2. Consider switching to [Appium Inspector](https://github.com/appium/appium-inspector) instead.
 
 ### Requirements
 
 - macOS, Linux or Windows operating system
-- Node.js 14+
+- Node.js 16+. Any relevant [LTS release](https://nodejs.dev/en/about/releases/) should work just fine.
 - NPM (Node Package Manager) 8+
 
 These are only server requirements. Each driver might have its own requirements. Consider checking the corresponding driver tutorial for more details.
@@ -37,10 +35,16 @@ These are only server requirements. Each driver might have its own requirements.
 To install Appium 2 server using Node Package Manager (npm) run the following command:
 
 ```bash
-npm install -g appium@next
+npm i --location=global appium
 ```
 
-:bangbang: Running `npm install -g appium` would still install Appium 1 because version 2 is in its late beta stage.
+To update Appium 2 server using Node Package Manager (npm) run the following command:
+
+ ```bash
+npm install --location=global appium@latest
+```
+
+:bangbang: Make sure Appium 1 is fully uninstalled before upgrading it to Appium 2 (`npm uninstall --location=global appium`). Unexpected errors might appear if this has not been done.
 
 ### Drivers
 
@@ -190,10 +194,6 @@ Repo](https://github.com/appium/appium/tree/master/packages/appium/docs) as well
 Please take a look at our [contribution documentation](CONTRIBUTING.md)
 for instructions on how to build, test, and run Appium from the source.
 
-### Roadmap
-
-Interested in where Appium is heading in the future? Check out the [Roadmap](ROADMAP.md)
-
 ### Project History, Credits & Inspiration
 
 * [History](https://appium.io/docs/en/latest/intro/history/)

packages/appium/docs/en/cli/env-vars.md

@@ -0,0 +1,18 @@
+---
+title: Server Environment Variables
+---
+
+The primary way of configuring the Appium server is via [CLI Args](./args.md). However, some more
+advanced features are toggled or configured via environment variables. To set environment
+variables, refer to the documentation for your operating system and terminal. These are the
+environment variables that the Appium server understands:
+
+|Variable                                          |Description|
+|--------|-----------|
+|`APPIUM_HOME`|By default, Appium creates a directory called `.appium` in the home directory for your system user. You can adjust the directory with this variable, as detailed in the [Managing Extensions](../guides/managing-exts.md) guide.|
+|`APPIUM_TMP_DIR`|By default, Appium uses a random temporary directory for many of its operations. If you wish to use a specific directory, you may do so by including an absolute path as the value of this variable. The behaviour is equivalent to using the `--tmp` CLI arg.|
+|`APPIUM_PREFER_SYSTEM_UNZIP`|Set to `0` or `false` to request that Appium not use the `unzip` binary included on your system for unzipping downloaded apps or other artifacts. Instead it will use a JS-based unzip library. This could help on some systems with non-existent or non-standard `unzip` commands. Note that if unzipping fails using the system library, the fallback library will be attempted in any case, so setting this env var merely saves time in the event you know the system unzip will fail.|
+|`APPIUM_HOST`|Same as the `--address` CLI arg|
+|`APPIUM_PORT`|Same as the `--port` CLI arg|
+|`APPIUM_RELOAD_EXTENSIONS`|Set to `1` to cause Appium to re-require extensions when new sessions are created. This is mostly useful for [building extensions](../ecosystem/build-drivers.md)|
+|`APPIUM_OMIT_PEER_DEPS`|Adds `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature.|

packages/appium/docs/en/ecosystem/build-drivers.md

@@ -152,6 +152,16 @@ your driver locally:
 appium driver install --source=local /path/to/your/driver/dev/dir
 ```
 
+### Refreshing your driver during development
+
+When the Appium server starts, it loads your driver into memory. Changes to your driver code will
+not take effect until the next time the Appium server starts. Simply starting a new session is not
+sufficient to cause your driver's code to be reloaded.
+
+However, you can set the `APPIUM_RELOAD_EXTENSIONS` environment variable to `1` to request that
+Appium clear its module cache and reload extensions whenever a new session is requested. This may
+obviate the need to restart the server when you make code changes to your driver.
+
 ## Standard driver implementation ideas
 
 These are things you will probably find yourself wanting to do when creating a driver.

packages/appium/docs/en/ecosystem/build-plugins.md

@@ -141,7 +141,9 @@ Appium's start server methods to handle starting and stopping the Appium server
 Of course, you can always install it locally as described above as well.
 
 Anytime you make changes to your plugin code, you'll need to restart the Appium server to make sure
-it picks up the latest code.
+it picks up the latest code. As with drivers, you can set the `APPIUM_RELOAD_EXTENSIONS`
+environment variable if you wish Appium to try to re-require your plugin module when a new session
+starts.
 
 ## Standard plugin implementation ideas
 

packages/appium/docs/en/guides/migrating-1-to-2.md

@@ -31,7 +31,7 @@ You can also set server arguments as [Config file](./config.md) properties.
 
 ### :bangbang: Installing drivers during setup
 
-When you installed Appium 1.x, all available drivers would be installed at the same time as the main Appium server. This is no longer the case. Simply installing Appium 2.0 (e.g., by `npm install -g appium@next`), will install the Appium server only, but no drivers. To install drivers, you must instead use the new [Appium extension CLI](../cli/extensions.md). For example, to install the latest versions of the XCUITest and UiAutomator2 drivers, after installing Appium you would run the following commands:
+When you installed Appium 1.x, all available drivers would be installed at the same time as the main Appium server. This is no longer the case. Simply installing Appium 2.0 (e.g., by `npm install --location=global appium`), will install the Appium server only, but no drivers. To install drivers, you must instead use the new [Appium extension CLI](../cli/extensions.md). For example, to install the latest versions of the XCUITest and UiAutomator2 drivers, after installing Appium you would run the following commands:
 
 ```bash
 appium driver install uiautomator2     # installs the latest driver version
@@ -42,10 +42,10 @@ At this point, your drivers are installed and ready. There's a lot more you can
 If you're running in a CI environment or want to install Appium along with some drivers all in one step, you can do so using some special flags during install, for example:
 
 ```bash
-npm install --global appium --drivers=xcuitest,uiautomator2
+npm install --location=global appium --drivers=xcuitest,uiautomator2
 ```
 
-This will install Appium and the two drivers for you in one go. Please uninstall any existing Appium 1.x npm packages (with `npm uninstall -g appium`) if you get an installation or startup error.
+This will install Appium and the two drivers for you in one go. Please uninstall any existing Appium 1.x npm packages (with `npm uninstall --location=global appium`) if you get an installation or startup error.
 
 ### :bangbang: Drivers installation path
 
@@ -122,7 +122,7 @@ appium driver update xcuitest
 (For a complete description of the update command, check out the [Extension
 CLI](../cli/extensions.md) doc)
 
-To update the Appium server itself, you do the same thing as in the past: `npm install -g appium`. Now, installing new versions of the Appium server will leave your drivers intact, so the whole process will be much more quick.
+To update the Appium server itself, you do the same thing as in the past: `npm install --location=global appium`. Now, installing new versions of the Appium server will leave your drivers intact, so the whole process will be much more quick.
 
 If you would like to update to a specific version, not the latest, please uninstall the driver and install the desired version using the `install` subcommand instead of `update`.
 
@@ -225,11 +225,11 @@ Some Appium-internal NPM packages have been renamed (for example, `appium-base-d
 
 For many years, some of Appium's authors maintained the [WD](https://github.com/admc/wd) client library. This library has been deprecated and has not been updated for use with the W3C WebDriver protocol. As such, if you're using this library you'll need to move to a more modern one. We recommend [WebdriverIO](https://webdriver.io).
 
-### :warning: Appium Inspector split out from Appium Desktop
+### :warning: Appium Desktop replaced with Appium Inspector
 
-The inspecting portion of Appium Desktop has been moved to its own app, Appium Inspector: [github.com/appium/appium-inspector](https://github.com/appium/appium-inspector). It's fully compatible with Appium 2.0 servers. Simply download it and run it on its own. You no longer need the GUI Appium Desktop server to inspect apps. The Appium Desktop server will continue to be supported at its original site: [github.com/appium/appium-desktop](https://github.com/appium/appium-desktop). It will simply no longer bundle the Inspector with it. Note that Appium Desktop 1.21 and lower versions depend on the deprecated [WD](https://github.com/admc/wd) client, and are not compatible with Appium 2.0. There is currently no Appium 2.0 support for Appium Desktop planned, now that the Inspector is a standalone app.
+The inspector functionality of Appium Desktop has been moved to its own app: [Appium Inspector](https://github.com/appium/appium-inspector). It's fully compatible with standalone Appium 2.0 servers, but also works with later versions of Appium 1.x servers. Appium Desktop itself has been deprecated and is not compatible with Appium 2.0.
 
-You can also now use the Appium Inspector without downloading anything, by visiting the [web version of Appium Inspector](https://inspector.appiumpro.com). Note that to test against local servers, you'll need to start the server with `--allow-cors` so that the browser-based version of Appium Inspector can access your Appium server to start sessions.
+In addition to the app, Appium Inspector also has a browser version, accessible at https://inspector.appiumpro.com. Note that in order to use the browser version with a local Appium server, you'll need to first start the server with the `--allow-cors` flag.
 
 ## Major New Features
 

packages/appium/docs/en/guides/settings.md

@@ -41,6 +41,18 @@ would construct a set of capabilities that includes the following in its JSON re
 }
 ```
 
+Also, since base-driver version 9.4.0, there is a possibility to provide multiple settings
+in a single `appium:settings` capability value:
+
+```json
+{
+    "appium:settings": {
+        "ignoreUnimportantViews": true,
+        "allowInvisibleElements": true
+    }
+}
+```
+
 Of course, initializing a setting via capabilities doesn't prevent you from changing it later on
 via the Settings API. To learn more about how to use the Settings API in the context of your
 specific client library, visit the documentation for that library.

packages/appium/docs/en/quickstart/install.md

@@ -5,14 +5,9 @@ title: Install Appium
 Installing Appium is as easy as running a single NPM command:
 
 ```bash
-npm i -g appium@next
+npm i --location=global appium
 ```
 
-!!! note
-
-    Currently, you must use `appium@next` instead of just `appium`. Once Appium 2.0 has been
-    officially published, you can simply use `appium`.
-
 This command installs Appium globally on your system so that you can access it from the command
 line simply by running the `appium` command. Go ahead and run it now:
 

packages/appium/docs/ja/guides/migrating-1-to-2.md

@@ -78,10 +78,10 @@ You can also set server arguments as [Config file](./config.md) properties.
 ### :bangbang: ドライバーのインストール
 
 <!---
-When you installed Appium 1.x, all available drivers would be installed at the same time as the main Appium server. This is no longer the case. Simply installing Appium 2.0 (e.g., by `npm install -g appium@next`), will install the Appium server only, but no drivers. To install drivers, you must instead use the new [Appium extension CLI](../cli/extensions.md). For example, to install the latest versions of the XCUITest and UiAutomator2 drivers, after installing Appium you would run the following commands:
+When you installed Appium 1.x, all available drivers would be installed at the same time as the main Appium server. This is no longer the case. Simply installing Appium 2.0 (e.g., by `npm install --location=global appium`), will install the Appium server only, but no drivers. To install drivers, you must instead use the new [Appium extension CLI](../cli/extensions.md). For example, to install the latest versions of the XCUITest and UiAutomator2 drivers, after installing Appium you would run the following commands:
 --->
 
-Appium 1.xをインストールしたとき、全ての入手可能なドライバーは主となるAppiumサーバーと合わせてインストールされていました。Appium 2.0ではそうではありません。Appium 2.0のインストール（例えば `npm install -g appium@next`）は単にAppiumサーバーのみをインストールし、ドライバーはインストールしません。ドライバーをインストールするためには新しい[Appium拡張コマンドラインインタフェース（Appium extension CLI）](../cli/extensions.md)を使わなければいけません。例えば、最新のXCUITestとUiAutomator2ドライバーをインストールする場合、Appiumをインストールしたのちに次のコマンドを実行する必要があります。
+Appium 1.xをインストールしたとき、全ての入手可能なドライバーは主となるAppiumサーバーと合わせてインストールされていました。Appium 2.0ではそうではありません。Appium 2.0のインストール（例えば `npm install --location=global appium`）は単にAppiumサーバーのみをインストールし、ドライバーはインストールしません。ドライバーをインストールするためには新しい[Appium拡張コマンドラインインタフェース（Appium extension CLI）](../cli/extensions.md)を使わなければいけません。例えば、最新のXCUITestとUiAutomator2ドライバーをインストールする場合、Appiumをインストールしたのちに次のコマンドを実行する必要があります。
 
 ```bash
 appium driver install uiautomator2     # installs the latest driver version
@@ -95,14 +95,14 @@ At this point, your drivers are installed and ready. There's a lot more you can
 これにより、ドライバーはインストールされ、利用可能になります。このCLIはいろいろな機能を提供しているので、CLIのドキュメントを確認してみてください。もしCI上であったり、いくつかのドライバーをAppiumと一緒にインストールしたい場合、以下のようなフラグを利用することで実現可能です。
 
 ```bash
-npm install --global appium --drivers=xcuitest,uiautomator2
+npm install --location=global appium --drivers=xcuitest,uiautomator2
 ```
 
 <!---
-This will install Appium and the two drivers for you in one go. Please uninstall any existing Appium 1.x npm packages (with `npm uninstall -g appium`) if you get an installation or startup error. 
+This will install Appium and the two drivers for you in one go. Please uninstall any existing Appium 1.x npm packages (with `npm uninstall --location=global appium`) if you get an installation or startup error. 
 --->
 
-これはAppiumと2つのドライバーを一つのコマンドでインストールします。もしセットアップで何らかの問題が発生した場合、既存のAppium 1.xを`npm uninstall -g appium`で削除してみてください。
+これはAppiumと2つのドライバーを一つのコマンドでインストールします。もしセットアップで何らかの問題が発生した場合、既存のAppium 1.xを`npm uninstall --location=global appium`で削除してみてください。
 
 ### :bangbang: Drivers installation path
 
@@ -166,7 +166,7 @@ appium driver update xcuitest
 (For a complete description of the update command, check out the [Extension
 CLI](../cli/extensions.md) doc)
 
-To update the Appium server itself, you do the same thing as in the past: `npm install -g appium`. Now, installing new versions of the Appium server will leave your drivers intact, so the whole process will be much more quick.
+To update the Appium server itself, you do the same thing as in the past: `npm install --location=global appium`. Now, installing new versions of the Appium server will leave your drivers intact, so the whole process will be much more quick.
 
 If you would like to update to a specific version, not the latest, please uninstall the driver and install the desired version using the `install` subcommand instead of `update`.
 

packages/appium/docs/mkdocs-en.yml

@@ -28,6 +28,7 @@ nav:
   - CLI Reference:
       - cli/index.md
       - cli/args.md
+      - cli/env-vars.md
       - cli/extensions.md
   - Guides:
       - guides/migrating-1-to-2.md

packages/appium/lib/appium.js

@@ -13,7 +13,7 @@ import {
   promoteAppiumOptionsForObject,
 } from '@appium/base-driver';
 import AsyncLock from 'async-lock';
-import {parseCapsForInnerDriver, pullSettings} from './utils';
+import {parseCapsForInnerDriver, pullSettings, makeNonW3cCapsError} from './utils';
 import {util, node, logger} from '@appium/support';
 import {getDefaultsForExtension} from './schema';
 import {DRIVER_TYPE} from './constants';
@@ -114,6 +114,7 @@ class AppiumDriver extends DriverCore {
     this.sessionPlugins = {};
     this.sessionlessPlugins = [];
     this.desiredCapConstraints = desiredCapabilityConstraints;
+    this._isShuttingDown = false;
 
     // allow this to happen in the background, so no `await`
     (async () => {
@@ -155,15 +156,36 @@ class AppiumDriver extends DriverCore {
 
   // eslint-disable-next-line require-await
   async getStatus() {
+    // https://www.w3.org/TR/webdriver/#dfn-status
+    const statusObj = this._isShuttingDown
+      ? {
+        ready: false,
+        message: 'The server is shutting down',
+      } : {
+        ready: true,
+        message: 'The server is ready to accept new connections',
+      };
     return {
+      ...statusObj,
       build: _.clone(getBuildInfo()),
     };
   }
 
+  /**
+   * @param {string|null} reason An optional shutdown reason
+   */
+  async shutdown(reason = null) {
+    this._isShuttingDown = true;
+    await this.deleteAllSessions({
+      force: true,
+      reason,
+    });
+  }
+
   async getSessions() {
     return _.toPairs(this.sessions).map(([id, driver]) => ({
       id,
-      capabilities: /** @type {import('@appium/types').DriverCaps} */ (driver.caps),
+      capabilities: /** @type {import('@appium/types').DriverCaps<any>} */ (driver.caps),
     }));
   }
 
@@ -231,6 +253,12 @@ class AppiumDriver extends DriverCore {
     jsonwpCaps = _.cloneDeep(jsonwpCaps);
     const jwpSettings = {...defaultSettings, ...pullSettings(jsonwpCaps)};
     w3cCapabilities = _.cloneDeep(w3cCapabilities);
+    if (
+      !_.isPlainObject(w3cCapabilities) ||
+      !(_.isArray(w3cCapabilities?.firstMatch) || _.isPlainObject(w3cCapabilities?.alwaysMatch))
+    ) {
+      throw makeNonW3cCapsError();
+    }
     // It is possible that the client only provides caps using JSONWP standard,
     // although firstMatch/alwaysMatch properties are still present.
     // In such case we assume the client understands W3C protocol and merge the given
@@ -634,6 +662,16 @@ class AppiumDriver extends DriverCore {
     // get any plugins which are registered as handling this command
     const plugins = this.pluginsToHandleCmd(cmd, sessionId);
 
+    // if any plugins are going to handle this command, we can't guarantee that the default
+    // driver's executeCommand method will be called, which means we can't guarantee that the
+    // newCommandTimeout will be cleared. So we do it here as well.
+    if (plugins.length && dstSession) {
+      this.log.debug(
+        'Clearing new command timeout pre-emptively since plugin(s) will handle this command'
+      );
+      await dstSession.clearNewCommandTimeout();
+    }
+
     // now we define a 'cmdHandledBy' object which will keep track of which plugins have handled this
     // command. we care about this because (a) multiple plugins can handle the same command, and
     // (b) there's no guarantee that a plugin will actually call the next() method which runs the
@@ -699,6 +737,22 @@ class AppiumDriver extends DriverCore {
     // handling the command and which didn't
     this.logPluginHandlerReport(plugins, {cmd, cmdHandledBy});
 
+    // if we had plugins, and if they did not ultimately call the default handler, this means our
+    // new command timeout was not restarted by the default handler's executeCommand call, so
+    // restart it here using the same logic as in BaseDriver's executeCommand
+    if (
+      dstSession &&
+      !cmdHandledBy.default &&
+      dstSession.isCommandsQueueEnabled &&
+      cmd !== DELETE_SESSION_COMMAND
+    ) {
+      this.log.debug(
+        'Restarting new command timeout via umbrella driver since plugin did not ' +
+          'allow default handler to execute'
+      );
+      await dstSession.startNewCommandTimeout();
+    }
+
     // And finally, if the command was createSession, we want to migrate any plugins which were
     // previously sessionless to use the new sessionId, so that plugins can share state between
     // their createSession method and other instance methods

packages/appium/lib/config-file.js

@@ -9,7 +9,11 @@ import {getSchema, validate} from './schema/schema';
  * @type {import('lilconfig').LoaderSync}
  */
 function yamlLoader(filepath, content) {
-  return yaml.parse(content);
+  try {
+    return yaml.parse(content);
+  } catch (e) {
+    throw new Error(`The YAML config at '${filepath}' cannot be loaded. Original error: ${e.message}`);
+  }
 }
 
 /**
@@ -27,7 +31,11 @@ const rawConfig = new Map();
  */
 function jsonLoader(filepath, content) {
   rawConfig.set(filepath, content);
-  return JSON.parse(content);
+  try {
+    return JSON.parse(content);
+  } catch (e) {
+    throw new Error(`The JSON config at '${filepath}' cannot be loaded. Original error: ${e.message}`);
+  }
 }
 
 /**

packages/appium/lib/extension/manifest.js

@@ -3,7 +3,6 @@
  */
 
 import B from 'bluebird';
-import glob from 'glob';
 import {env, fs} from '@appium/support';
 import _ from 'lodash';
 import path from 'path';
@@ -212,23 +211,13 @@ export class Manifest {
     ];
 
     // add dependencies to the queue
-    await new B((resolve, reject) => {
-      glob(
-        'node_modules/{*,@*/*}/package.json',
-        {cwd: this.#appiumHome, silent: true, absolute: true},
-        // eslint-disable-next-line promise/prefer-await-to-callbacks
-        (err) => {
-          if (err) {
-            reject(err);
-          }
-          resolve();
-        }
-      )
-        .on('error', reject)
-        .on('match', (filepath) => {
-          queue.push(onMatch(filepath));
-        });
+    const filepaths = await fs.glob('node_modules/{*,@*/*}/package.json', {
+      cwd: this.#appiumHome,
+      absolute: true,
     });
+    for (const filepath of filepaths) {
+      queue.push(onMatch(filepath));
+    }
 
     // wait for everything to finish
     await B.all(queue);
@@ -284,7 +273,11 @@ export class Manifest {
         ...internal,
       };
       if (!_.isEqual(value, this.#data.drivers[pkgJson.appium.driverName])) {
-        this.setExtension(DRIVER_TYPE, pkgJson.appium.driverName, value);
+        this.setExtension(
+          /** @type {ExtType} */ (DRIVER_TYPE),
+          pkgJson.appium.driverName,
+          /** @type {ExtManifest<ExtType>} */ (value)
+        );
         return true;
       }
       return false;
@@ -294,7 +287,11 @@ export class Manifest {
         ...internal,
       };
       if (!_.isEqual(value, this.#data.plugins[pkgJson.appium.pluginName])) {
-        this.setExtension(PLUGIN_TYPE, pkgJson.appium.pluginName, value);
+        this.setExtension(
+          /** @type {ExtType} */ (PLUGIN_TYPE),
+          pkgJson.appium.pluginName,
+          /** @type {ExtManifest<ExtType>} */ (value)
+        );
         return true;
       }
       return false;

packages/appium/lib/main.js

@@ -2,7 +2,11 @@
 
 import {init as logsinkInit} from './logsink'; // this import needs to come first since it sets up global npmlog
 import logger from './logger'; // logger needs to remain second
-import {routeConfiguringFunction as makeRouter, server as baseServer} from '@appium/base-driver';
+import {
+  routeConfiguringFunction as makeRouter,
+  server as baseServer,
+  normalizeBasePath,
+} from '@appium/base-driver';
 import {logger as logFactory, util, env, fs} from '@appium/support';
 import {asyncify} from 'asyncbox';
 import _ from 'lodash';
@@ -32,11 +36,12 @@ import {
   isExtensionCommandArgs,
   isPluginCommandArgs,
   isServerCommandArgs,
-  fetchIpAddresses,
+  fetchInterfaces,
   V4_BROADCAST_IP,
   V6_BROADCAST_IP,
 } from './utils';
 import os from 'node:os';
+import net from 'node:net';
 
 const {resolveAppiumHome} = env;
 
@@ -328,17 +333,23 @@ async function init(args) {
  * @param {string} url The URL the server is listening on
  */
 function logServerAddress(url) {
-  logger.info(`Appium REST http interface listener started on ${url}`);
   const urlObj = new URL(url);
-  if (![V4_BROADCAST_IP, V6_BROADCAST_IP].includes(urlObj.hostname)) {
+  logger.info(`Appium REST http interface listener started on ${url}`);
+  if (![V4_BROADCAST_IP, V6_BROADCAST_IP, `[${V6_BROADCAST_IP}]`].includes(urlObj.hostname)) {
     return;
   }
 
-  const ips = fetchIpAddresses(urlObj.hostname === V4_BROADCAST_IP ? 4 : 6);
+  const interfaces = fetchInterfaces(urlObj.hostname === V4_BROADCAST_IP ? 4 : 6);
+  const toLabel = (/** @type {os.NetworkInterfaceInfo} */ iface) => {
+    const href = urlObj.href.replace(urlObj.hostname, iface.address);
+    return iface.internal
+      ? `${href} (only accessible from the same host)`
+      : href;
+  };
   logger.info(
-    `You can provide the following ${util.pluralize('URL', ips.length, false)} ` +
-      `in your client code to connect to this server:\n` +
-      ips.map((x) => `\t${urlObj.href.replace(urlObj.hostname, x)}`).join('\n')
+    `You can provide the following ${interfaces.length === 1 ? 'URL' : 'URLs'} ` +
+    `in your client code to connect to this server:\n` +
+    interfaces.map((iface) => `\t${toLabel(iface)}`).join('\n')
   );
 }
 
@@ -429,10 +440,7 @@ async function main(args) {
     process.once(signal, async function onSignal() {
       logger.info(`Received ${signal} - shutting down`);
       try {
-        await appiumDriver.deleteAllSessions({
-          force: true,
-          reason: `The process has received ${signal} signal`,
-        });
+        await appiumDriver.shutdown(`The process has received ${signal} signal`);
         await server.close();
         process.exit(0);
       } catch (e) {
@@ -442,7 +450,8 @@ async function main(args) {
     });
   }
 
-  logServerAddress(`http://${parsedArgs.address}:${parsedArgs.port}${parsedArgs.basePath}`);
+  const address = net.isIPv6(parsedArgs.address) ? `[${parsedArgs.address}]` : parsedArgs.address;
+  logServerAddress(`http://${address}:${parsedArgs.port}${normalizeBasePath(parsedArgs.basePath)}`);
 
   driverConfig.print();
   pluginConfig.print([...pluginClasses.values()]);

packages/appium/lib/utils.js

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import logger from './logger';
-import {processCapabilities, PROTOCOLS, STANDARD_CAPS} from '@appium/base-driver';
+import {processCapabilities, PROTOCOLS, STANDARD_CAPS, errors} from '@appium/base-driver';
 import {inspect as dump} from 'util';
 import {node} from '@appium/support';
 import path from 'path';
@@ -22,6 +22,18 @@ export const V6_BROADCAST_IP = '::';
  */
 const isStdoutTTY = process.stdout.isTTY;
 
+/**
+ * Creates an error object in case a session gets incompatible capabilities as the input.
+ *
+ * @returns {Error}
+ */
+export function makeNonW3cCapsError() {
+  return new errors.SessionNotCreatedError(
+    'Session capabilities format must comply to the W3C standard. Make sure your client is up to date. ' +
+    'See https://www.w3.org/TR/webdriver/#new-session for more details.'
+  );
+}
+
 /**
  * Dumps to value to the console using `info` logger.
  *
@@ -69,7 +81,7 @@ function parseCapsForInnerDriver(
   if (!hasW3CCaps) {
     return /** @type {InvalidCaps<C>} */ ({
       protocol: PROTOCOLS.W3C,
-      error: new Error('W3C capabilities should be provided'),
+      error: makeNonW3cCapsError(),
     });
   }
 
@@ -264,11 +276,18 @@ function adjustNodePath() {
 /**
  * Pulls the initial values of Appium settings from the given capabilities argument.
  * Each setting item must satisfy the following format:
- * `setting[setting_name]: setting_value`
+ * `settings[setting_name]: setting_value`
+ * or
+ * ```
+ * settings = {
+ *   setting_name1: 'setting_value1',
+ *   setting_name2: 'setting_value2',
+ * }
+ * ```
  * The capabilities argument itself gets mutated, so it does not contain parsed
  * settings anymore to avoid further parsing issues.
  * Check
- * https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md
+ * https://appium.io/docs/en/latest/guides/settings/
  * for more details on the available settings.
  *
  * @param {?Object} caps - Capabilities dictionary. It is mutated if
@@ -283,14 +302,19 @@ function pullSettings(caps) {
   }
 
   const result = {};
+  const singleSettings = {};
   for (const [key, value] of _.toPairs(caps)) {
-    const match = /\bsettings\[(\S+)\]$/.exec(key);
-    if (!match) {
-      continue;
+    let match;
+    if (/^(s|appium:s)ettings$/.test(key) && _.isPlainObject(value)) {
+      Object.assign(result, value);
+      delete caps[key];
+    } else if ((match = /^(s|appium:s)ettings\[(\S+)\]$/.exec(key))) {
+      singleSettings[match[2]] = value;
+      delete caps[key];
     }
-
-    result[match[1]] = value;
-    delete caps[key];
+  }
+  if (!_.isEmpty(singleSettings)) {
+    Object.assign(result, singleSettings);
   }
   return result;
 }
@@ -336,13 +360,13 @@ export function isPluginCommandArgs(args) {
 }
 
 /**
- * Fetches the list of IP addresses of the current host.
+ * Fetches the list of matched network interfaces of the current host.
  *
  * @param {4|6|null} family Either 4 to include ipv4 addresses only,
  * 6 to include ipv6 addresses only, or null to include all of them
- * @returns {string[]} The list of matched IP addresses
+ * @returns {os.NetworkInterfaceInfo[]} The list of matched interfcaes
  */
-export function fetchIpAddresses (family = null) {
+export function fetchInterfaces (family = null) {
   let familyValue = null;
   // 'IPv4' is in Node <= 17, from 18 it's a number 4 or 6
   if (family === 4) {
@@ -350,11 +374,10 @@ export function fetchIpAddresses (family = null) {
   } else if (family === 6) {
     familyValue = [6, 'IPv6'];
   }
+  // @ts-ignore The linter does not understand the below filter
   return _.flatMap(_.values(os.networkInterfaces()).filter(Boolean))
     // @ts-ignore The linter does not understand the above filter
-    .filter(({family}) => !familyValue || familyValue && familyValue.includes(family))
-    // @ts-ignore The linter does not understand the above filter
-    .map(({address}) => address);
+    .filter(({family}) => !familyValue || familyValue && familyValue.includes(family));
 }
 
 export {

packages/appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-rc.3",
+  "version": "2.1.0",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -60,12 +60,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.3.13",
-    "@appium/base-plugin": "^2.2.13",
-    "@appium/docutils": "^0.4.2",
-    "@appium/schema": "^0.3.0",
-    "@appium/support": "^4.1.0",
-    "@appium/types": "^0.13.0",
+    "@appium/base-driver": "^9.3.17",
+    "@appium/base-plugin": "^2.2.17",
+    "@appium/docutils": "^0.4.6",
+    "@appium/schema": "^0.3.1",
+    "@appium/support": "^4.1.4",
+    "@appium/types": "^0.13.3",
     "@sidvind/better-ajv-errors": "2.1.0",
     "@types/argparse": "2.0.10",
     "@types/bluebird": "3.5.38",
@@ -82,18 +82,17 @@
     "bluebird": "3.7.2",
     "cross-env": "7.0.3",
     "find-up": "5.0.0",
-    "glob": "8.1.0",
     "lilconfig": "2.1.0",
     "lodash": "4.17.21",
     "npmlog": "7.0.1",
     "ora": "5.4.1",
     "package-changed": "3.0.0",
     "resolve-from": "5.0.0",
-    "semver": "7.5.1",
+    "semver": "7.5.4",
     "source-map-support": "0.5.21",
-    "teen_process": "2.0.2",
-    "type-fest": "3.11.1",
-    "winston": "3.9.0",
+    "teen_process": "2.0.4",
+    "type-fest": "3.13.1",
+    "winston": "3.10.0",
     "wrap-ansi": "7.0.0",
     "yaml": "2.3.1"
   },
@@ -102,10 +101,9 @@
     "npm": ">=8"
   },
   "publishConfig": {
-    "access": "public",
-    "tag": "next"
+    "access": "public"
   },
-  "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02",
+  "gitHead": "3fa73a1d1a95e3868fbceb005f8b1deb4ac53eaf",
   "typedoc": {
     "entryPoint": "./lib/main.js"
   }

packages/appium/sample-code/quickstarts/js/package.json

@@ -1,5 +1,5 @@
 {
   "devDependencies": {
-    "webdriverio": "7.31.1"
+    "webdriverio": "^8.11.2"
   }
 }

packages/appium/sample-code/quickstarts/js/test.js

@@ -9,7 +9,7 @@ const capabilities = {
 };
 
 const wdOpts = {
-  host: process.env.APPIUM_HOST || 'localhost',
+  hostname: process.env.APPIUM_HOST || 'localhost',
   port: parseInt(process.env.APPIUM_PORT, 10) || 4723,
   logLevel: 'info',
   capabilities,

packages/appium/test/e2e/config-file.e2e.spec.js

@@ -320,7 +320,7 @@ describe('config file behavior', function () {
           return this.skip();
         }
         await readConfigFile(INVALID_JSON_FILEPATH).should.be.rejectedWith(
-          new RegExp(`${INVALID_JSON_FILEPATH} is invalid`)
+          new RegExp(`${_.escapeRegExp(INVALID_JSON_FILEPATH)}`)
         );
       });
     });

packages/appium/test/e2e/driver.e2e.spec.js

@@ -240,6 +240,28 @@ describe('FakeDriver via HTTP', function () {
 
       await B.delay(250);
       await driver.getPageSource().should.eventually.be.rejectedWith(/terminated/);
+
+      await driver.getSessions().should.eventually.be.empty;
+    });
+
+    it('should not allow umbrella commands to prevent newCommandTimeout on inner driver', async function () {
+      let localCaps = Object.assign(
+        {
+          'appium:newCommandTimeout': 0.25,
+        },
+        caps
+      );
+      let driver = await wdio({...wdOpts, capabilities: localCaps});
+      should.exist(driver.sessionId);
+
+      // get the session list 6 times over 300ms. each request will be below the new command
+      // timeout but since they are not received by the driver the session should still time out
+      for (let i = 0; i < 6; i++) {
+        await driver.getSessions();
+        await B.delay(50);
+      }
+      await driver.getPageSource().should.eventually.be.rejectedWith(/terminated/);
+      await driver.getSessions().should.eventually.be.empty;
     });
 
     it('should accept valid W3C capabilities and start a W3C session', async function () {

packages/appium/test/e2e/plugin.e2e.spec.js

@@ -275,6 +275,31 @@ describe('FakePlugin w/ FakeDriver via HTTP', function () {
         }
         shutdownErr.message.should.match(/either terminated or not started/);
       });
+
+      it('should allow plugin handled commands to reset newCommandTimeout', async function () {
+        /** @type {import('webdriverio').RemoteOptions} */
+        const newOpts = {...wdOpts};
+        newOpts.capabilities = {
+          ...(newOpts.capabilities ?? {}),
+          'appium:newCommandTimeout': 2,
+        };
+        const driver = await wdio(newOpts);
+        const {sessionId} = driver;
+        try {
+          const start = Date.now();
+          for (let i = 0; i < 5; i++) {
+            await B.delay(500);
+            await driver.getPageSource();
+          }
+          // prove that we went beyond the new command timeout as a result of sending commands
+          (Date.now() - start).should.be.above(2500);
+          await driver
+            .getPageSource()
+            .should.eventually.eql(`<Fake>${JSON.stringify([sessionId])}</Fake>`);
+        } finally {
+          await driver.deleteSession();
+        }
+      });
     });
   }
   describe('cli args handling for plugin args', function () {

packages/appium/test/fixtures/flattened-schema.js

@@ -16,6 +16,10 @@ export default [
       description: 'IPv4/IPv6 address or a hostname to listen on',
       title: 'address config',
       type: 'string',
+      anyOf: [
+        {format: 'hostname', type: 'string'},
+        {format: 'ipv6', type: 'string'}
+      ]
     },
   },
   {

packages/appium/test/unit/extension/mocks.js

@@ -26,6 +26,7 @@ export function initMocks(sandbox = createSandbox()) {
             .returns({next: sandbox.stub().resolves({done: true})}),
         })
       ),
+      glob: /** @type {MockAppiumSupportFs['glob']} */ (sandbox.stub().resolves([])),
       mkdirp: /** @type {MockAppiumSupportFs['mkdirp']} */ (sandbox.stub().resolves()),
       readPackageJsonFrom: /** @type {MockAppiumSupportFs['readPackageJsonFrom']} */ (
         sandbox.stub().returns({version: APPIUM_VER, engines: {node: '>=12'}})
@@ -166,6 +167,7 @@ export function initMocks(sandbox = createSandbox()) {
  * @property {SinonStubbedMember<SupportFs['readFile']>} readFile
  * @property {SinonStubbedMember<SupportFs['writeFile']>} writeFile
  * @property {SinonStubbedMember<SupportFs['walk']>} walk
+ * @property {SinonStubbedMember<SupportFs['glob']>} glob
  * @property {SinonStubbedMember<SupportFs['mkdirp']>} mkdirp
  * @property {SinonStubbedMember<SupportFs['readPackageJsonFrom']>} readPackageJsonFrom
  * @property {SinonStubbedMember<SupportFs['findRoot']>} findRoot

packages/appium/test/unit/utils.spec.js

@@ -5,7 +5,7 @@ import {
   removeAppiumPrefixes,
   inspect,
   adjustNodePath,
-  fetchIpAddresses,
+  fetchInterfaces,
 } from '../../lib/utils';
 import {BASE_CAPS, W3C_CAPS} from '../helpers';
 import _ from 'lodash';
@@ -232,6 +232,26 @@ describe('utils', function () {
       settings.should.eql({});
       caps.should.eql({});
     });
+    it('should pull combined settings', function () {
+      const caps = {
+        platformName: 'foo',
+        browserName: 'bar',
+        'appium:settings[foo]': 'baz2',
+        'appium:settings': {
+          foo: 'baz',
+          yolo: 'bar',
+        },
+      };
+      const settings = pullSettings(caps);
+      settings.should.eql({
+        foo: 'baz2',
+        yolo: 'bar',
+      });
+      caps.should.eql({
+        platformName: 'foo',
+        browserName: 'bar',
+      });
+    });
   });
 
   describe('inspect()', function () {
@@ -277,17 +297,17 @@ describe('utils', function () {
     });
   });
 
-  describe('fetchIpAddresses()', function () {
-    it('should fetch addresses for ipv4 only', async function () {
-      fetchIpAddresses(4).length.should.be.greaterThan(0);
+  describe('fetchInterfaces()', function () {
+    it('should fetch interfaces for ipv4 only', async function () {
+      fetchInterfaces(4).length.should.be.greaterThan(0);
     });
 
-    it('should fetch addresses for ipv6 only', async function () {
-      fetchIpAddresses(6).length.should.be.greaterThan(0);
+    it('should fetch interfaces for ipv6 only', async function () {
+      fetchInterfaces(6).length.should.be.greaterThan(0);
     });
 
-    it('should fetch addresses for ipv4 and ipv6', async function () {
-      fetchIpAddresses().length.should.be.greaterThan(0);
+    it('should fetch interfaces for ipv4 and ipv6', async function () {
+      fetchInterfaces().length.should.be.greaterThan(0);
     });
   });
 

packages/base-driver/CHANGELOG.md

@@ -3,6 +3,48 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.3.17](https://github.com/appium/appium/compare/@appium/base-driver@9.3.16...@appium/base-driver@9.3.17) (2023-08-17)
+
+
+### Bug Fixes
+
+* **base-driver:** Tune responses caching logic ([#18922](https://github.com/appium/appium/issues/18922)) ([de5b55a](https://github.com/appium/appium/commit/de5b55ae90fefcce86962a48d5aceb73962e56b6))
+* **driver-test-support:** update definitelytyped ([c320e8a](https://github.com/appium/appium/commit/c320e8a1a61cb6d980d6d944ae47b60da97aa398))
+* **support:** update dependency glob to v10 ([#18490](https://github.com/appium/appium/issues/18490)) ([aaf31a5](https://github.com/appium/appium/commit/aaf31a577cb0b9cbe22646dcd888dc393a03aa11))
+* **test-support:** update dependency @colors/colors to v1.6.0 ([1358937](https://github.com/appium/appium/commit/1358937db2edf08ce1ebe3dff2f70ac6b07cd373))
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
+## [9.3.16](https://github.com/appium/appium/compare/@appium/base-driver@9.3.15...@appium/base-driver@9.3.16) (2023-07-24)
+
+
+### Bug Fixes
+
+* **base-driver:** Use proper cached headers for app download ([#18874](https://github.com/appium/appium/issues/18874)) ([75650a6](https://github.com/appium/appium/commit/75650a6b744dfcbd50d45972f04040472fdbcd45))
+
+
+
+## [9.3.15](https://github.com/appium/appium/compare/@appium/base-driver@9.3.14...@appium/base-driver@9.3.15) (2023-07-03)
+
+
+### Bug Fixes
+
+* **base-driver:** allow subclass to define shape of settings object ([3d614d6](https://github.com/appium/appium/commit/3d614d6d414d0d34026f516dbfad7d296000efcf))
+* **base-driver:** pass thru all type args to ExternalDriver ([2b35170](https://github.com/appium/appium/commit/2b351705d401e2db8da76022989c1475cbdda0f8))
+* **types,base-driver:** remove deviceName from base constraints ([01061b2](https://github.com/appium/appium/commit/01061b291981333bdec59adfbea60f0cef3d69c1))
+* **types:** separate the type of opts from initialOpts ([d6cca51](https://github.com/appium/appium/commit/d6cca5175c3e55d4670936c9d216cd3a6610d16b))
+
+
+
+## [9.3.14](https://github.com/appium/appium/compare/@appium/base-driver@9.3.13...@appium/base-driver@9.3.14) (2023-06-29)
+
+**Note:** Version bump only for package @appium/base-driver
+
+
+
+
+
 ## [9.3.13](https://github.com/appium/appium/compare/@appium/base-driver@9.3.12...@appium/base-driver@9.3.13) (2023-06-15)
 
 

packages/base-driver/lib/basedriver/commands/index.ts

@@ -1,6 +1,5 @@
 import './event';
 import './find';
 import './log';
-import './settings';
 import './timeout';
 import './execute';

packages/base-driver/lib/basedriver/commands/log.ts

@@ -1,6 +1,6 @@
-import {Constraints, Driver, ILogCommands, LogDefRecord} from '@appium/types';
+import type {Constraints, Driver, ILogCommands} from '@appium/types';
 import _ from 'lodash';
-import {BaseDriver} from '../driver';
+import type {BaseDriver} from '../driver';
 import {mixin} from './mixin';
 
 declare module '../driver' {
@@ -9,7 +9,7 @@ declare module '../driver' {
 }
 
 const LogCommands: ILogCommands = {
-  supportedLogTypes: <LogDefRecord>{},
+  supportedLogTypes: {},
 
   async getLogTypes<C extends Constraints>(this: BaseDriver<C>) {
     this.log.debug('Retrieving supported log types');

packages/base-driver/lib/basedriver/commands/settings.ts

@@ -1,26 +0,0 @@
-import {BaseDriver} from '../driver';
-import {Constraints, ISettingsCommands, StringRecord} from '@appium/types';
-import {mixin} from './mixin';
-
-declare module '../driver' {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  interface BaseDriver<C extends Constraints> extends ISettingsCommands {}
-}
-
-const SettingsCommands: ISettingsCommands = {
-  async updateSettings<C extends Constraints>(this: BaseDriver<C>, newSettings: StringRecord) {
-    if (!this.settings) {
-      this.log.errorAndThrow('Cannot update settings; settings object not found');
-    }
-    return await this.settings.update(newSettings);
-  },
-
-  async getSettings<C extends Constraints>(this: BaseDriver<C>) {
-    if (!this.settings) {
-      this.log.errorAndThrow('Cannot get settings; settings object not found');
-    }
-    return this.settings.getSettings();
-  },
-};
-
-mixin(SettingsCommands);

packages/base-driver/lib/basedriver/core.ts

@@ -2,10 +2,23 @@
 /* eslint-disable require-await */
 
 import {logger} from '@appium/support';
+import type {
+  AppiumLogger,
+  Constraints,
+  Core,
+  Driver,
+  DriverOpts,
+  EventHistory,
+  HTTPMethod,
+  InitialOpts,
+  Protocol,
+  RouteMatcher,
+  StringRecord,
+} from '@appium/types';
 import AsyncLock from 'async-lock';
-import {EventEmitter} from 'events';
 import _ from 'lodash';
-import os from 'os';
+import {EventEmitter} from 'node:events';
+import os from 'node:os';
 import {DEFAULT_BASE_PATH, PROTOCOLS} from '../constants';
 import {errors} from '../protocol';
 import DeviceSettings from './device-settings';
@@ -15,35 +28,22 @@ const NEW_COMMAND_TIMEOUT_MS = 60 * 1000;
 
 const ON_UNEXPECTED_SHUTDOWN_EVENT = 'onUnexpectedShutdown';
 
-/**
- * @template {Constraints} C
- * @template {StringRecord} [Settings=StringRecord]
- * @implements {Core<C, Settings>}
- */
-class DriverCore {
+export class DriverCore<const C extends Constraints, Settings extends StringRecord = StringRecord>
+  implements Core<C, Settings>
+{
   /**
    * Make the basedriver version available so for any driver which inherits from this package, we
    * know which version of basedriver it inherited from
    */
   static baseVersion = BASEDRIVER_VER;
 
-  /**
-   * @type {string?}
-   */
-  sessionId;
+  sessionId: string | null;
 
-  /**
-   * @type {import('@appium/types').DriverOpts<C>}
-   */
-  opts;
+  opts: DriverOpts<C>;
 
-  /**
-   * @type {import('@appium/types').DriverOpts<C>}
-   */
-  initialOpts;
+  initialOpts: InitialOpts;
 
-  /** @type {typeof helpers} */
-  helpers;
+  helpers: typeof helpers;
 
   /**
    * basePath is used for several purposes, for example in setting up
@@ -52,83 +52,58 @@ class DriverCore {
    * initially but it is automatically updated during any actual program
    * execution by the routeConfiguringFunction, which is necessarily run as
    * the entrypoint for any Appium server
-   * @type {string}
    */
-  basePath;
+  basePath: string;
 
-  /** @type {boolean} */
-  relaxedSecurityEnabled;
+  relaxedSecurityEnabled: boolean;
 
-  /** @type {string[]} */
-  allowInsecure;
+  allowInsecure: string[];
 
-  /** @type {string[]} */
-  denyInsecure;
+  denyInsecure: string[];
 
-  /** @type {number} */
-  newCommandTimeoutMs;
+  newCommandTimeoutMs: number;
 
-  /** @type {number} */
-  implicitWaitMs;
+  implicitWaitMs: number;
 
-  /** @type {string[]} */
-  locatorStrategies;
+  locatorStrategies: string[];
 
-  /** @type {string[]} */
-  webLocatorStrategies;
+  webLocatorStrategies: string[];
 
-  /** @type {Driver[]} */
-  managedDrivers;
+  managedDrivers: Driver[];
 
-  /** @type {NodeJS.Timeout?} */
-  noCommandTimer;
+  noCommandTimer: NodeJS.Timeout | null;
 
-  /** @type {EventHistory} */
-  _eventHistory;
+  protected _eventHistory: EventHistory;
 
   // used to handle driver events
-  /** @type {NodeJS.EventEmitter} */
-  eventEmitter;
+  eventEmitter: NodeJS.EventEmitter;
 
   /**
-   * @type {AppiumLogger}
+   * @privateRemarks XXX: unsure why this is wrapped in a getter when nothing else is
    */
-  _log;
+  protected _log: AppiumLogger;
 
-  /**
-   * @type {boolean}
-   */
-  shutdownUnexpectedly;
+  shutdownUnexpectedly: boolean;
 
-  /**
-   * @type {boolean}
-   */
-  shouldValidateCaps;
+  shouldValidateCaps: boolean;
 
-  /**
-   * @protected
-   * @type {AsyncLock}
-   */
-  commandsQueueGuard;
+  protected commandsQueueGuard: AsyncLock;
 
   /**
    * settings should be instantiated by drivers which extend BaseDriver, but
    * we set it to an empty DeviceSettings instance here to make sure that the
    * default settings are applied even if an extending driver doesn't utilize
    * the settings functionality itself
-   * @type {DeviceSettings<Settings>}
    */
-  settings;
+  settings: DeviceSettings<Settings>;
 
-  /**
-   * @param {DriverOpts<C>} opts
-   * @param {boolean} [shouldValidateCaps]
-   */
-  constructor(opts = /** @type {DriverOpts<C>} */ ({}), shouldValidateCaps = true) {
-    this._log = logger.getLogger(helpers.generateDriverLogPrefix(this));
+  protocol?: Protocol;
+
+  constructor(opts: InitialOpts = <InitialOpts>{}, shouldValidateCaps = true) {
+    this._log = logger.getLogger(helpers.generateDriverLogPrefix(this as Core<C>));
 
     // setup state
-    this.opts = opts;
+    this.opts = opts as DriverOpts<C>;
 
     // use a custom tmp dir to avoid losing data and app when computer is
     // restarted
@@ -168,11 +143,11 @@ class DriverCore {
    * when the driver is shut down unexpectedly. Multiple calls to this method
    * will cause the handler to be executed mutiple times
    *
-   * @param {(...args: any[]) => void} handler The code to be executed on unexpected shutdown.
+   * @param handler The code to be executed on unexpected shutdown.
    * The function may accept one argument, which is the actual error instance, which
    * caused the driver to shut down.
    */
-  onUnexpectedShutdown(handler) {
+  onUnexpectedShutdown(handler: (...args: any[]) => void) {
     this.eventEmitter.on(ON_UNEXPECTED_SHUTDOWN_EVENT, handler);
   }
 
@@ -183,7 +158,7 @@ class DriverCore {
    * Override it in inherited driver classes if necessary.
    */
   get driverData() {
-    return /** @type {import('@appium/types').DriverData} */ ({});
+    return {};
   }
 
   /**
@@ -191,13 +166,13 @@ class DriverCore {
    * handles new driver commands received from the client.
    * Override it for inherited classes only in special cases.
    *
-   * @return {boolean} If the returned value is true (default) then all the commands
+   * @return If the returned value is true (default) then all the commands
    *   received by the particular driver instance are going to be put into the queue,
    *   so each following command will not be executed until the previous command
    *   execution is completed. False value disables that queue, so each driver command
    *   is executed independently and does not wait for anything.
    */
-  get isCommandsQueueEnabled() {
+  get isCommandsQueueEnabled(): boolean {
     return true;
   }
 
@@ -211,9 +186,8 @@ class DriverCore {
 
   /**
    * API method for driver developers to log timings for important events
-   * @param {string} eventName
    */
-  logEvent(eventName) {
+  logEvent(eventName: string) {
     if (eventName === 'commands') {
       throw new Error('Cannot log commands directly');
     }
@@ -240,10 +214,8 @@ class DriverCore {
   /**
    * method required by MJSONWP in order to determine whether it should
    * respond with an invalid session response
-   * @param {string} [sessionId]
-   * @returns {boolean}
    */
-  sessionExists(sessionId) {
+  sessionExists(sessionId: string): boolean {
     if (!sessionId) return false; // eslint-disable-line curly
     return sessionId === this.sessionId;
   }
@@ -251,11 +223,9 @@ class DriverCore {
   /**
    * method required by MJSONWP in order to determine if the command should
    * be proxied directly to the driver
-   * @param {string} sessionId
-   * @returns {Core<C> | null}
    */
-  driverForSession(sessionId) {
-    return /** @type {Core<C> | null} */ (this);
+  driverForSession(sessionId: string): Core<Constraints> | null {
+    return this as Core<Constraints>;
   }
 
   isMjsonwpProtocol() {
@@ -277,11 +247,9 @@ class DriverCore {
   /**
    * Check whether a given feature is enabled via its name
    *
-   * @param {string} name - name of feature/command
-   *
-   * @returns {Boolean}
+   * @param name - name of feature/command
    */
-  isFeatureEnabled(name) {
+  isFeatureEnabled(name: string): boolean {
     // if we have explicitly denied this feature, return false immediately
     if (this.denyInsecure && _.includes(this.denyInsecure, name)) {
       return false;
@@ -306,10 +274,10 @@ class DriverCore {
    * Assert that a given feature is enabled and throw a helpful error if it's
    * not
    *
-   * @param {string} name - name of feature/command
+   * @param name - name of feature/command
    * @deprecated
    */
-  ensureFeatureEnabled(name) {
+  ensureFeatureEnabled(name: string) {
     this.assertFeatureEnabled(name);
   }
 
@@ -317,26 +285,20 @@ class DriverCore {
    * Assert that a given feature is enabled and throw a helpful error if it's
    * not
    *
-   * @param {string} name - name of feature/command
+   * @param name - name of feature/command
    */
-  assertFeatureEnabled(name) {
+  assertFeatureEnabled(name: string) {
     if (!this.isFeatureEnabled(name)) {
       throw new Error(
         `Potentially insecure feature '${name}' has not been ` +
           `enabled. If you want to enable this feature and accept ` +
           `the security ramifications, please do so by following ` +
-          `the documented instructions at https://github.com/appium` +
-          `/appium/blob/master/docs/en/writing-running-appium/security.md`
+          `the documented instructions at http://appium.io/docs/en/2.0/guides/security/`
       );
     }
   }
 
-  /**
-   *
-   * @param {string} strategy
-   * @param {boolean} [webContext]
-   */
-  validateLocatorStrategy(strategy, webContext = false) {
+  validateLocatorStrategy(strategy: string, webContext = false) {
     let validStrategies = this.locatorStrategies;
     this.log.debug(`Valid locator strategies for this request: ${validStrategies.join(', ')}`);
 
@@ -351,30 +313,15 @@ class DriverCore {
     }
   }
 
-  /**
-   *
-   * @param {string} [sessionId]
-   * @returns {boolean}
-   */
-  proxyActive(sessionId) {
+  proxyActive(sessionId: string): boolean {
     return false;
   }
 
-  /**
-   *
-   * @param {string} sessionId
-   * @returns {import('@appium/types').RouteMatcher[]}
-   */
-  getProxyAvoidList(sessionId) {
+  getProxyAvoidList(sessionId: string): RouteMatcher[] {
     return [];
   }
 
-  /**
-   *
-   * @param {string} [sessionId]
-   * @returns {boolean}
-   */
-  canProxy(sessionId) {
+  canProxy(sessionId: string): boolean {
     return false;
   }
 
@@ -382,28 +329,28 @@ class DriverCore {
    * Whether a given command route (expressed as method and url) should not be
    * proxied according to this driver
    *
-   * @param {string} sessionId - the current sessionId (in case the driver runs
+   * @param sessionId - the current sessionId (in case the driver runs
    * multiple session ids and requires it). This is not used in this method but
    * should be made available to overridden methods.
-   * @param {import('@appium/types').HTTPMethod} method - HTTP method of the route
-   * @param {string} url - url of the route
-   * @param {any} [body] - webdriver request body
+   * @param method - HTTP method of the route
+   * @param url - url of the route
+   * @param [body] - webdriver request body
    *
-   * @returns {boolean} - whether the route should be avoided
+   * @returns whether the route should be avoided
    */
-  proxyRouteIsAvoided(sessionId, method, url, body) {
-    for (let avoidSchema of this.getProxyAvoidList(sessionId)) {
+  proxyRouteIsAvoided(sessionId: string, method: HTTPMethod, url: string, body?: any): boolean {
+    for (const avoidSchema of this.getProxyAvoidList(sessionId)) {
       if (!_.isArray(avoidSchema) || avoidSchema.length !== 2) {
         throw new Error('Proxy avoidance must be a list of pairs');
       }
-      let [avoidMethod, avoidPathRegex] = avoidSchema;
+      const [avoidMethod, avoidPathRegex] = avoidSchema;
       if (!_.includes(['GET', 'POST', 'DELETE'], avoidMethod)) {
         throw new Error(`Unrecognized proxy avoidance method '${avoidMethod}'`);
       }
       if (!_.isRegExp(avoidPathRegex)) {
         throw new Error('Proxy avoidance path must be a regular expression');
       }
-      let normalizedUrl = url.replace(new RegExp(`^${_.escapeRegExp(this.basePath)}`), '');
+      const normalizedUrl = url.replace(new RegExp(`^${_.escapeRegExp(this.basePath)}`), '');
       if (avoidMethod === method && avoidPathRegex.test(normalizedUrl)) {
         return true;
       }
@@ -415,7 +362,7 @@ class DriverCore {
    *
    * @param {Driver} driver
    */
-  addManagedDriver(driver) {
+  addManagedDriver(driver: Driver) {
     this.managedDrivers.push(driver);
   }
 
@@ -430,26 +377,3 @@ class DriverCore {
     }
   }
 }
-
-export {DriverCore};
-
-/**
- * @typedef {import('@appium/types').Driver} Driver
- * @typedef {import('@appium/types').Constraints} Constraints
- * @typedef {import('@appium/types').ServerArgs} ServerArgs
- * @typedef {import('@appium/types').EventHistory} EventHistory
- * @typedef {import('@appium/types').AppiumLogger} AppiumLogger
- * @typedef {import('@appium/types').StringRecord} StringRecord
- * @typedef {import('@appium/types').BaseDriverCapConstraints} BaseDriverCapConstraints
- */
-
-/**
- * @template {Constraints} C
- * @template {StringRecord} [S=StringRecord]
- * @typedef {import('@appium/types').Core<C, S>} Core
- */
-
-/**
- * @template {Constraints} C
- * @typedef {import('@appium/types').DriverOpts<C>} DriverOpts
- */

packages/base-driver/lib/basedriver/device-settings.js

@@ -9,7 +9,7 @@ import {errors} from '../protocol/errors';
 export const MAX_SETTINGS_SIZE = 20 * 1024 * 1024; // 20 MB
 
 /**
- * @template {import('@appium/types').StringRecord} T
+ * @template {StringRecord} T
  * @implements {IDeviceSettings<T>}
  */
 export class DeviceSettings {
@@ -74,6 +74,10 @@ export class DeviceSettings {
 export default DeviceSettings;
 
 /**
- * @template {import('@appium/types').StringRecord} [T=import('@appium/types').StringRecord]
+ * @typedef {import('@appium/types').StringRecord} StringRecord
+ */
+
+/**
+ * @template {StringRecord} [T=StringRecord]
  * @typedef {import('@appium/types').IDeviceSettings<T>} IDeviceSettings
  */

packages/base-driver/lib/basedriver/driver.ts

@@ -1,28 +1,29 @@
-import {validateCaps, processCapabilities} from './capabilities';
-import {DriverCore} from './core';
 import {util} from '@appium/support';
+import {
+  BASE_DESIRED_CAP_CONSTRAINTS,
+  type AppiumServer,
+  type BaseDriverCapConstraints,
+  type Capabilities,
+  type Constraints,
+  type DefaultCreateSessionResult,
+  type Driver,
+  type DriverCaps,
+  type DriverData,
+  type MultiSessionData,
+  type ServerArgs,
+  type StringRecord,
+  type W3CDriverCaps,
+  type InitialOpts,
+  type DefaultDeleteSessionResult,
+  type SingularSessionData,
+} from '@appium/types';
 import B from 'bluebird';
 import _ from 'lodash';
 import {fixCaps, isW3cCaps} from '../helpers/capabilities';
 import {DELETE_SESSION_COMMAND, determineProtocol, errors} from '../protocol';
+import {processCapabilities, validateCaps} from './capabilities';
+import {DriverCore} from './core';
 import helpers from './helpers';
-import {
-  AppiumServer,
-  BaseDriverCapConstraints,
-  BASE_DESIRED_CAP_CONSTRAINTS,
-  Capabilities,
-  Constraints,
-  DefaultCreateSessionResult,
-  Driver,
-  DriverCaps,
-  DriverData,
-  DriverOpts,
-  MultiSessionData,
-  ServerArgs,
-  SingularSessionData,
-  StringRecord,
-  W3CDriverCaps,
-} from '@appium/types';
 
 const EVENT_SESSION_INIT = 'newSessionRequested';
 const EVENT_SESSION_START = 'newSessionStarted';
@@ -31,26 +32,26 @@ const EVENT_SESSION_QUIT_DONE = 'quitSessionFinished';
 const ON_UNEXPECTED_SHUTDOWN_EVENT = 'onUnexpectedShutdown';
 
 export class BaseDriver<
-    C extends Constraints,
+    const C extends Constraints,
     CArgs extends StringRecord = StringRecord,
     Settings extends StringRecord = StringRecord,
+    CreateResult = DefaultCreateSessionResult<C>,
+    DeleteResult = DefaultDeleteSessionResult,
     SessionData extends StringRecord = StringRecord
   >
   extends DriverCore<C, Settings>
-  implements Driver<C, CArgs>
+  implements Driver<C, CArgs, Settings, CreateResult, DeleteResult, SessionData>
 {
   cliArgs: CArgs & ServerArgs;
-
   caps: DriverCaps<C>;
   originalCaps: W3CDriverCaps<C>;
   desiredCapConstraints: C;
-  opts: DriverOpts<C>;
   server?: AppiumServer;
   serverHost?: string;
   serverPort?: number;
   serverPath?: string;
 
-  constructor(opts: DriverOpts<C>, shouldValidateCaps = true) {
+  constructor(opts: InitialOpts, shouldValidateCaps = true) {
     super(opts, shouldValidateCaps);
 
     this.caps = {} as DriverCaps<C>;
@@ -63,7 +64,7 @@ export class BaseDriver<
    *
    * Subclasses _shouldn't_ need to use this. If you need to use this, please create
    * an issue:
-   * @see https://github.com/appium/appium/issues/new
+   * @see {@link https://github.com/appium/appium/issues/new}
    */
   protected get _desiredCapConstraints(): Readonly<BaseDriverCapConstraints & C> {
     return Object.freeze(_.merge({}, BASE_DESIRED_CAP_CONSTRAINTS, this.desiredCapConstraints));
@@ -234,7 +235,7 @@ export class BaseDriver<
     w3cCapabilities?: W3CDriverCaps<C>,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     driverData?: DriverData[]
-  ): Promise<DefaultCreateSessionResult<C>> {
+  ): Promise<CreateResult> {
     if (this.sessionId !== null) {
       throw new errors.SessionNotCreatedError(
         'Cannot create a new session while one is in progress'
@@ -311,7 +312,7 @@ export class BaseDriver<
 
     this.log.info(`Session created with session id: ${this.sessionId}`);
 
-    return [this.sessionId, caps];
+    return [this.sessionId, caps] as CreateResult;
   }
   async getSessions() {
     const ret: MultiSessionData<C>[] = [];
@@ -330,7 +331,9 @@ export class BaseDriver<
    * Returns capabilities for the session and event history (if applicable)
    */
   async getSession() {
-    return this.caps.eventTimings ? {...this.caps, events: this.eventHistory} : this.caps;
+    return (
+      this.caps.eventTimings ? {...this.caps, events: this.eventHistory} : this.caps
+    ) as SingularSessionData<C, SessionData>;
   }
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -380,6 +383,20 @@ export class BaseDriver<
 
     return true;
   }
+
+  async updateSettings(newSettings: Settings) {
+    if (!this.settings) {
+      this.log.errorAndThrow('Cannot update settings; settings object not found');
+    }
+    return await this.settings.update(newSettings);
+  }
+
+  async getSettings() {
+    if (!this.settings) {
+      this.log.errorAndThrow('Cannot get settings; settings object not found');
+    }
+    return this.settings.getSettings();
+  }
 }
 
 export * from './commands';

packages/base-driver/lib/basedriver/helpers.js

@@ -72,7 +72,7 @@ function verifyAppExtension(app, supportedAppExtensions) {
 }
 
 async function calculateFolderIntegrity(folderPath) {
-  return (await fs.glob('**/*', {cwd: folderPath, strict: false, nosort: true})).length;
+  return (await fs.glob('**/*', {cwd: folderPath})).length;
 }
 
 async function calculateFileIntegrity(filePath) {
@@ -141,6 +141,9 @@ async function configureApp(
   const isUrl = protocol === null ? false : ['http:', 'https:'].includes(protocol);
 
   const cachedAppInfo = APPLICATIONS_CACHE.get(app);
+  if (cachedAppInfo) {
+    logger.debug(`Cached app data: ${JSON.stringify(cachedAppInfo, null, 2)}`);
+  }
 
   return await APPLICATIONS_CACHE_GUARD.acquire(app, async () => {
     if (isUrl) {
@@ -150,27 +153,23 @@ async function configureApp(
         ...DEFAULT_REQ_HEADERS,
       };
       if (cachedAppInfo?.etag) {
-        reqHeaders['if-none-match'] = remoteAppProps.etag;
+        reqHeaders['if-none-match'] = cachedAppInfo.etag;
       } else if (cachedAppInfo?.lastModified) {
-        reqHeaders['if-modified-since'] = remoteAppProps.lastModified?.toString();
+        reqHeaders['if-modified-since'] = cachedAppInfo.lastModified.toUTCString();
       }
 
       let {headers, stream, status} = await queryAppLink(newApp, reqHeaders);
       try {
         if (!_.isEmpty(headers)) {
-          logger.debug(`Etag: ${remoteAppProps?.etag} -> ${headers.etag}`);
+          logger.debug(`Etag: ${headers.etag}`);
           if (headers.etag) {
             remoteAppProps.etag = headers.etag;
           }
-          logger.debug(
-            `Last-Modified: ${remoteAppProps?.['last-modified']} -> ${headers['last-modified']}`
-          );
+          logger.debug(`Last-Modified: ${headers['last-modified']}`);
           if (headers['last-modified']) {
             remoteAppProps.lastModified = new Date(headers['last-modified']);
           }
-          logger.debug(
-            `Cache-Control: ${remoteAppProps?.['cache-control']} -> ${headers['cache-control']}`
-          );
+          logger.debug(`Cache-Control: ${headers['cache-control']}`);
           if (headers['cache-control']) {
             remoteAppProps.immutable = /\bimmutable\b/i.test(headers['cache-control']);
             const maxAgeMatch = /\bmax-age=(\d+)\b/i.exec(headers['cache-control']);
@@ -476,7 +475,6 @@ async function unzipApp(zipPath, dstRoot, supportedAppExtensions) {
     const sortedBundleItems = (
       await fs.glob(globPattern, {
         cwd: tmpRoot,
-        strict: false,
         // Get the top level match
       })
     ).sort((a, b) => a.split(path.sep).length - b.split(path.sep).length);

packages/base-driver/lib/constants.ts

@@ -1,4 +1,5 @@
 import {util} from '@appium/support';
+import {Protocol} from '@appium/types';
 
 // The default maximum length of a single log record
 // containing http request/response body
@@ -12,7 +13,7 @@ const W3C_ELEMENT_KEY = util.W3C_WEB_ELEMENT_IDENTIFIER;
 const PROTOCOLS = {
   W3C: 'W3C',
   MJSONWP: 'MJSONWP',
-};
+} as const satisfies Record<Protocol, Protocol>;
 
 // Before Appium 2.0, this default value was '/wd/hub' by historical reasons.
 const DEFAULT_BASE_PATH = '';

packages/base-driver/lib/express/idempotency.js

@@ -1,34 +1,31 @@
 import log from './logger';
 import LRU from 'lru-cache';
-import {fs, util} from '@appium/support';
-import os from 'os';
-import path from 'path';
+import _ from 'lodash';
 import {EventEmitter} from 'events';
 
-const CACHE_SIZE = 1024;
 const IDEMPOTENT_RESPONSES = new LRU({
-  max: CACHE_SIZE,
+  max: 64,
+  ttl: 30 * 60 * 1000,
   updateAgeOnGet: true,
-  dispose(key, {response}) {
-    if (response) {
-      fs.rimrafSync(response);
-    }
-  },
+  updateAgeOnHas: true,
+  dispose: (key, {responseStateListener}) => {
+    responseStateListener.removeAllListeners();
+  }
 });
 const MONITORED_METHODS = ['POST', 'PATCH'];
 const IDEMPOTENCY_KEY_HEADER = 'x-idempotency-key';
 
-process.on('exit', () => {
-  const resPaths = [...IDEMPOTENT_RESPONSES.values()].map(({response}) => response).filter(Boolean);
-  for (const resPath of resPaths) {
-    try {
-      // Asynchronous calls are not supported in onExit handler
-      fs.rimrafSync(resPath);
-    } catch (ign) {}
-  }
-});
-
+/**
+ *
+ * @param {string} key
+ * @param {import('express').Request} req
+ * @param {import('express').Response} res
+ */
 function cacheResponse(key, req, res) {
+  if (!res.socket) {
+    return;
+  }
+
   const responseStateListener = new EventEmitter();
   IDEMPOTENT_RESPONSES.set(key, {
     method: req.method,
@@ -36,33 +33,23 @@ function cacheResponse(key, req, res) {
     response: null,
     responseStateListener,
   });
-  const tmpFile = path.resolve(os.tmpdir(), `${util.uuidV4()}.response`);
-  const responseListener = fs.createWriteStream(tmpFile, {
-    emitClose: true,
-  });
   const originalSocketWriter = res.socket.write.bind(res.socket);
+  let response = '';
   const patchedWriter = (chunk, encoding, next) => {
-    if (responseListener.writable) {
-      responseListener.write(chunk);
+    if (_.isString(chunk)) {
+      response += chunk;
+    } else if (_.isFunction(chunk.toString)) {
+      response += chunk.toString(_.isString(encoding) ? encoding : undefined);
     }
     return originalSocketWriter(chunk, encoding, next);
   };
   res.socket.write = patchedWriter;
-  let writeError = null;
+  let httpErrorMessage = null;
   let isResponseFullySent = false;
-  responseListener.once('error', (e) => {
-    writeError = e;
-  });
-  res.once('finish', () => {
-    isResponseFullySent = true;
-    responseListener.end();
-  });
+  res.once('error', (e) => { httpErrorMessage = e.message; });
+  req.once('error', (e) => { httpErrorMessage = e.message; });
+  res.once('finish', () => { isResponseFullySent = true; });
   res.once('close', () => {
-    if (!isResponseFullySent) {
-      responseListener.end();
-    }
-  });
-  responseListener.once('close', () => {
     if (res.socket?.write === patchedWriter) {
       res.socket.write = originalSocketWriter;
     }
@@ -70,35 +57,41 @@ function cacheResponse(key, req, res) {
     if (!IDEMPOTENT_RESPONSES.has(key)) {
       log.info(
         `Could not cache the response identified by '${key}'. ` +
-          `Cache consistency has been damaged`
+        `Cache consistency has been damaged`
       );
-      return responseStateListener.emit('ready', null);
-    }
-    if (writeError) {
-      log.info(`Could not cache the response identified by '${key}': ${writeError.message}`);
+    } else if (httpErrorMessage) {
+      log.info(`Could not cache the response identified by '${key}': ${httpErrorMessage}`);
       IDEMPOTENT_RESPONSES.delete(key);
-      return responseStateListener.emit('ready', null);
-    }
-    if (!isResponseFullySent) {
+    } else if (!isResponseFullySent) {
       log.info(
         `Could not cache the response identified by '${key}', ` +
-          `because it has not been completed`
+        `because it has not been completed`
       );
       log.info('Does the client terminate connections too early?');
       IDEMPOTENT_RESPONSES.delete(key);
-      return responseStateListener.emit('ready', null);
     }
 
-    IDEMPOTENT_RESPONSES.get(key).response = tmpFile;
-    responseStateListener.emit('ready', tmpFile);
+    const value = IDEMPOTENT_RESPONSES.get(key);
+    if (value) {
+      value.response = Buffer.from(response, 'utf8');
+      responseStateListener.emit('ready', value.response);
+    } else {
+      responseStateListener.emit('ready', null);
+    }
   });
 }
 
+/**
+ * @param {import('express').Request} req
+ * @param {import('express').Response} res
+ */
 async function handleIdempotency(req, res, next) {
-  const key = req.headers[IDEMPOTENCY_KEY_HEADER];
-  if (!key) {
+  const keyOrArr = req.headers[IDEMPOTENCY_KEY_HEADER];
+  if (!keyOrArr) {
     return next();
   }
+
+  const key = _.isArray(keyOrArr) ? keyOrArr[0] : keyOrArr;
   if (!MONITORED_METHODS.includes(req.method)) {
     // GET, DELETE, etc. requests are idempotent by default
     // there is no need to cache them
@@ -112,39 +105,32 @@ async function handleIdempotency(req, res, next) {
   }
 
   const {
-    method: storedMethod,
-    path: storedPath,
+    method,
+    path,
     response,
     responseStateListener,
   } = IDEMPOTENT_RESPONSES.get(key);
-  if (req.method !== storedMethod || req.path !== storedPath) {
+  if (req.method !== method || req.path !== path) {
     log.warn(`Got two different requests with the same idempotency key '${key}'`);
     log.warn('Is the client generating idempotency keys properly?');
     return next();
   }
 
-  const rerouteCachedResponse = async (cachedResPath) => {
-    if (!(await fs.exists(cachedResPath))) {
-      IDEMPOTENT_RESPONSES.delete(key);
-      log.warn(`Could not read the cached response identified by key '${key}'`);
-      log.warn('The temporary storage is not accessible anymore');
-      return next();
-    }
-    fs.createReadStream(cachedResPath).pipe(res.socket);
-  };
-
   if (response) {
     log.info(`The same request with the idempotency key '${key}' has been already processed`);
     log.info(`Rerouting its response to the current request`);
-    await rerouteCachedResponse(response);
+    if (!res.socket?.writable) {
+      return next();
+    }
+    res.socket.write(response.toString('utf8'));
   } else {
     log.info(`The same request with the idempotency key '${key}' is being processed`);
     log.info(`Waiting for the response to be rerouted to the current request`);
-    responseStateListener.once('ready', async (cachedResponsePath) => {
-      if (!cachedResponsePath) {
+    responseStateListener.once('ready', async (/** @type {Buffer?} */ cachedResponse) => {
+      if (!cachedResponse || !res.socket?.writable) {
         return next();
       }
-      await rerouteCachedResponse(cachedResponsePath);
+      res.socket.write(cachedResponse.toString('utf8'));
     });
   }
 }

packages/base-driver/lib/express/server.js

@@ -118,6 +118,7 @@ function configureServer({
   } else {
     app.use(allowCrossDomainAsyncExecute(basePath));
   }
+  // @ts-ignore
   app.use(handleIdempotency);
   app.use(fixPythonContentType(basePath));
   app.use(defaultToJSONContentType);

packages/base-driver/lib/index.js

@@ -15,7 +15,7 @@ export default BaseDriver;
 // MJSONWP exports
 export * from './protocol';
 export {errorFromMJSONWPStatusCode as errorFromCode} from './protocol';
-export {DEFAULT_BASE_PATH, PROTOCOLS} from './constants';
+export {DEFAULT_BASE_PATH, PROTOCOLS, W3C_ELEMENT_KEY} from './constants';
 
 // Express exports
 export {STATIC_DIR} from './express/static';

packages/base-driver/lib/jsonwp-proxy/proxy.js

@@ -341,6 +341,7 @@ class JWProxy {
    * @param {string} url
    * @param {import('@appium/types').HTTPMethod} method
    * @param {any?} body
+   * @returns {Promise<unknown>}
    */
   async command(url, method, body = null) {
     let response;

packages/base-driver/lib/protocol/errors.js

@@ -1078,6 +1078,7 @@ function getResponseForW3CError(err) {
     w3cLog.debug(`Bad parameters: ${err}`);
     w3cErrorString = BadParametersError.error();
   } else {
+    // @ts-expect-error unclear what the problem is here
     w3cErrorString = err.error;
   }
 

packages/base-driver/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "9.3.13",
+  "version": "9.3.17",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -37,20 +37,20 @@
     "!build/tsconfig.tsbuildinfo"
   ],
   "scripts": {
-    "test": "npm run test:unit",
-    "test:e2e": "mocha -p --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
+    "test": "run-p test:unit test:types",
+    "test:e2e": "mocha --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
     "test:smoke": "node ./index.js",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\"",
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/support": "^4.1.0",
-    "@appium/types": "^0.13.0",
-    "@colors/colors": "1.5.0",
+    "@appium/support": "^4.1.4",
+    "@appium/types": "^0.13.3",
+    "@colors/colors": "1.6.0",
     "@types/async-lock": "1.4.0",
     "@types/bluebird": "3.5.38",
     "@types/express": "4.17.17",
-    "@types/lodash": "4.14.195",
+    "@types/lodash": "4.14.196",
     "@types/method-override": "0.0.32",
     "@types/serve-favicon": "2.5.4",
     "async-lock": "1.4.0",
@@ -67,7 +67,7 @@
     "morgan": "1.10.0",
     "serve-favicon": "2.5.0",
     "source-map-support": "0.5.21",
-    "type-fest": "3.11.1",
+    "type-fest": "3.13.1",
     "validate.js": "0.13.1"
   },
   "engines": {

packages/base-driver/test/types/basedriver/driver.test-d.ts

@@ -4,8 +4,8 @@ import {BaseDriver} from '.../../..';
 import {BaseDriverCapConstraints, ExternalDriver, Driver, DriverOpts} from '@appium/types';
 
 expectAssignable<Driver<BaseDriverCapConstraints>>(
-  new BaseDriver({} as DriverOpts<BaseDriverCapConstraints>)
+  new BaseDriver<BaseDriverCapConstraints>({} as DriverOpts<BaseDriverCapConstraints>)
 );
 expectAssignable<ExternalDriver<BaseDriverCapConstraints>>(
-  new BaseDriver({} as DriverOpts<BaseDriverCapConstraints>)
+  new BaseDriver<BaseDriverCapConstraints>({} as DriverOpts<BaseDriverCapConstraints>)
 );

packages/base-driver/test/unit/basedriver/capability.spec.js

@@ -36,18 +36,15 @@ describe('Desired Capabilities', function () {
   it('should require platformName', async function () {
     await d
       .createSession({
-        alwaysMatch: {
-          'appium:deviceName': 'Delorean',
-        },
+        alwaysMatch: {},
         firstMatch: [{}],
       })
       .should.be.rejectedWith(errors.SessionNotCreatedError, /platformName/);
   });
 
   it('should not care about cap order', async function () {
-    await d.createSession(null, null, {
+    await d.createSession({
       alwaysMatch: {
-        'appium:deviceName': 'Delorean',
         platformName: 'iOS',
       },
       firstMatch: [{}],
@@ -67,10 +64,9 @@ describe('Desired Capabilities', function () {
     };
 
     await d
-      .createSession(null, null, {
+      .createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
         },
         firstMatch: [{}],
       })
@@ -90,7 +86,7 @@ describe('Desired Capabilities', function () {
     });
 
     await d
-      .createSession(null, null, {
+      .createSession({
         alwaysMatch: {
           'appium:necessary': 'yup',
         },
@@ -100,28 +96,22 @@ describe('Desired Capabilities', function () {
   });
 
   it('should accept extra capabilities', async function () {
-    await d.createSession(
-      null,
-      null,
-      /** @type {import('@appium/types').W3CCapabilities<{'hold the':string}>} */ ({
-        alwaysMatch: {
-          platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:extra': 'cheese',
-          'appium:hold the': 'sauce',
-        },
-        firstMatch: [{}],
-      })
-    ).should.be.fulfilled;
+    await d.createSession({
+      alwaysMatch: {
+        platformName: 'iOS',
+        'appium:extra': 'cheese',
+        'appium:hold the': 'sauce',
+      },
+      firstMatch: [{}],
+    }).should.be.fulfilled;
   });
 
   it('should log the use of extra caps', async function () {
     this.timeout(500);
 
-    await d.createSession(null, null, {
+    await d.createSession({
       alwaysMatch: {
         platformName: 'iOS',
-        'appium:deviceName': 'Delorean',
         'appium:extra': 'cheese',
         'appium:hold the': 'sauce',
       },
@@ -133,11 +123,10 @@ describe('Desired Capabilities', function () {
 
   it('should be sensitive to the case of caps', async function () {
     await d
-      .createSession(null, null, {
+      .createSession({
         alwaysMatch: {
           // @ts-expect-error
           platformname: 'iOS',
-          'appium:deviceName': 'Delorean',
         },
         firstMatch: [{}],
       })
@@ -146,10 +135,9 @@ describe('Desired Capabilities', function () {
 
   describe('boolean capabilities', function () {
     it('should allow a string "false"', async function () {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
           // @ts-expect-error
           'appium:noReset': 'false',
         },
@@ -162,10 +150,9 @@ describe('Desired Capabilities', function () {
     });
 
     it('should allow a string "true"', async function () {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
           // @ts-expect-error
           'appium:noReset': 'true',
         },
@@ -178,10 +165,9 @@ describe('Desired Capabilities', function () {
     });
 
     it('should allow a string "true" in string capabilities', async function () {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
           'appium:language': 'true',
         },
         firstMatch: [{}],
@@ -195,10 +181,9 @@ describe('Desired Capabilities', function () {
 
   describe('number capabilities', function () {
     it('should allow a string "1"', async function () {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
           // @ts-expect-error
           'appium:newCommandTimeout': '1',
         },
@@ -211,10 +196,9 @@ describe('Desired Capabilities', function () {
     });
 
     it('should allow a string "1.1"', async function () {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
           // @ts-expect-error
           'appium:newCommandTimeout': '1.1',
         },
@@ -227,10 +211,9 @@ describe('Desired Capabilities', function () {
     });
 
     it('should allow a string "1" in string capabilities', async function () {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
           'appium:language': '1',
         },
         firstMatch: [{}],
@@ -244,11 +227,10 @@ describe('Desired Capabilities', function () {
 
   it('should error if objects in caps', async function () {
     await d
-      .createSession(null, null, {
+      .createSession({
         alwaysMatch: {
           // @ts-expect-error
           platformName: {a: 'iOS'},
-          'appium:deviceName': 'Delorean',
         },
         firstMatch: [{}],
       })
@@ -264,10 +246,9 @@ describe('Desired Capabilities', function () {
       },
     };
 
-    await d.createSession(null, null, {
+    await d.createSession({
       alwaysMatch: {
         platformName: 'iOS',
-        'appium:deviceName': 'Delorean',
         'appium:lynx-version': 5,
       },
       firstMatch: [{}],
@@ -285,10 +266,9 @@ describe('Desired Capabilities', function () {
       },
     };
 
-    await d.createSession(null, null, {
+    await d.createSession({
       alwaysMatch: {
         platformName: 'iOS',
-        'appium:deviceName': 'Delorean',
         'appium:lynx-version': 5,
       },
       firstMatch: [{}],
@@ -305,10 +285,9 @@ describe('Desired Capabilities', function () {
     };
 
     try {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': null,
         },
         firstMatch: [{}],
@@ -318,10 +297,9 @@ describe('Desired Capabilities', function () {
     }
 
     await d
-      .createSession(null, null, {
+      .createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': 1,
         },
         firstMatch: [{}],
@@ -329,10 +307,9 @@ describe('Desired Capabilities', function () {
       .should.be.rejectedWith(/'foo' must be of type string/);
 
     try {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': undefined,
         },
         firstMatch: [{}],
@@ -342,10 +319,9 @@ describe('Desired Capabilities', function () {
     }
 
     try {
-      await d.createSession(null, null, {
+      await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': '',
         },
         firstMatch: [{}],
@@ -363,10 +339,9 @@ describe('Desired Capabilities', function () {
     };
 
     await d
-      .createSession(null, null, {
+      .createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': null,
         },
         firstMatch: [{}],
@@ -374,10 +349,10 @@ describe('Desired Capabilities', function () {
       .should.be.rejectedWith(/blank/);
 
     await d
+      // @ts-expect-error `null` is not actually allowed here
       .createSession(null, {
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': '',
         },
         firstMatch: [{}],
@@ -389,7 +364,6 @@ describe('Desired Capabilities', function () {
         firstMatch: [
           {
             platformName: 'iOS',
-            'appium:deviceName': 'Dumb',
             'appium:foo': {},
           },
         ],
@@ -401,7 +375,6 @@ describe('Desired Capabilities', function () {
       .createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': [],
         },
         firstMatch: [{}],
@@ -412,7 +385,6 @@ describe('Desired Capabilities', function () {
       .createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
           'appium:foo': '  ',
         },
         firstMatch: [{}],
@@ -422,17 +394,15 @@ describe('Desired Capabilities', function () {
 
   describe('w3c', function () {
     it('should accept w3c capabilities', async function () {
-      const [sessionId, caps] = await d.createSession(null, null, {
+      const [sessionId, caps] = await d.createSession({
         alwaysMatch: {
           platformName: 'iOS',
-          'appium:deviceName': 'Delorean',
         },
         firstMatch: [{}],
       });
       sessionId.should.exist;
       caps.should.eql({
         platformName: 'iOS',
-        deviceName: 'Delorean',
       });
     });
 
@@ -442,7 +412,7 @@ describe('Desired Capabilities', function () {
       await B.map(testValues, (val) =>
         d
           // @ts-expect-error
-          .createSession(null, null, val)
+          .createSession(val)
           .should.be.rejectedWith(errors.SessionNotCreatedError)
       );
     });

packages/base-plugin/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.17](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.16...@appium/base-plugin@2.2.17) (2023-08-17)
+
+**Note:** Version bump only for package @appium/base-plugin
+
+
+
+
+
+## [2.2.16](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.15...@appium/base-plugin@2.2.16) (2023-07-24)
+
+**Note:** Version bump only for package @appium/base-plugin
+
+
+
+
+
+## [2.2.15](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.14...@appium/base-plugin@2.2.15) (2023-07-03)
+
+**Note:** Version bump only for package @appium/base-plugin
+
+
+
+
+
+## [2.2.14](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.13...@appium/base-plugin@2.2.14) (2023-06-29)
+
+**Note:** Version bump only for package @appium/base-plugin
+
+
+
+
+
 ## [2.2.13](https://github.com/appium/appium/compare/@appium/base-plugin@2.2.12...@appium/base-plugin@2.2.13) (2023-06-15)
 
 **Note:** Version bump only for package @appium/base-plugin

packages/base-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-plugin",
-  "version": "2.2.13",
+  "version": "2.2.17",
   "description": "The base plugin used to create Appium 2.0 plugins",
   "keywords": [
     "automation",
@@ -40,8 +40,8 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.3.13",
-    "@appium/support": "^4.1.0"
+    "@appium/base-driver": "^9.3.17",
+    "@appium/support": "^4.1.4"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",

packages/doctor/CHANGELOG.md

@@ -3,6 +3,43 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.23](https://github.com/appium/appium/compare/@appium/doctor@2.0.22...@appium/doctor@2.0.23) (2023-08-17)
+
+
+### Bug Fixes
+
+* **doctor:** update dependency appium-adb to v9.14.4 ([#18844](https://github.com/appium/appium/issues/18844)) ([a9e86aa](https://github.com/appium/appium/commit/a9e86aabc657bf22df8b1c5f67ab93acc0ced934))
+* **doctor:** update dependency inquirer to v8.2.6 ([#18940](https://github.com/appium/appium/issues/18940)) ([a8cc551](https://github.com/appium/appium/commit/a8cc551210c31b014025f7c56b091163f4d15df1))
+* **test-support:** update dependency @colors/colors to v1.6.0 ([1358937](https://github.com/appium/appium/commit/1358937db2edf08ce1ebe3dff2f70ac6b07cd373))
+
+
+
+## [2.0.22](https://github.com/appium/appium/compare/@appium/doctor@2.0.21...@appium/doctor@2.0.22) (2023-07-24)
+
+
+### Bug Fixes
+
+* **support:** update dependency teen_process to v2.0.4 ([151c19c](https://github.com/appium/appium/commit/151c19c1c3b4c9b94aba10033c2d863f567d849b))
+
+
+
+## [2.0.21](https://github.com/appium/appium/compare/@appium/doctor@2.0.20...@appium/doctor@2.0.21) (2023-07-03)
+
+
+### Bug Fixes
+
+* **doctor:** update dependency appium-adb to v9.11.7 ([fdd2ac0](https://github.com/appium/appium/commit/fdd2ac098d1b6e0d17b1429defa0123660d85ca9))
+
+
+
+## [2.0.20](https://github.com/appium/appium/compare/@appium/doctor@2.0.19...@appium/doctor@2.0.20) (2023-06-29)
+
+**Note:** Version bump only for package @appium/doctor
+
+
+
+
+
 ## [2.0.19](https://github.com/appium/appium/compare/@appium/doctor@2.0.18...@appium/doctor@2.0.19) (2023-06-15)
 
 **Note:** Version bump only for package @appium/doctor

packages/doctor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/doctor",
-  "version": "2.0.19",
+  "version": "2.0.23",
   "description": "Test environment for fitness to run Appium",
   "keywords": [
     "automation",
@@ -44,16 +44,16 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^4.1.0",
-    "@colors/colors": "1.5.0",
+    "@appium/support": "^4.1.4",
+    "@colors/colors": "1.6.0",
     "@types/bluebird": "3.5.38",
     "@types/teen_process": "2.0.0",
-    "appium-adb": "9.11.5",
+    "appium-adb": "9.14.4",
     "bluebird": "3.7.2",
-    "inquirer": "8.2.5",
+    "inquirer": "8.2.6",
     "lodash": "4.17.21",
     "source-map-support": "0.5.21",
-    "teen_process": "2.0.2",
+    "teen_process": "2.0.4",
     "yargs": "17.7.2"
   },
   "engines": {

packages/doctor/test/unit/android.spec.js

@@ -12,6 +12,7 @@ import * as tp from 'teen_process';
 import {withMocks, stubEnv} from '@appium/test-support';
 import B from 'bluebird';
 import {removeColors} from './helper';
+import {createSandbox} from 'sinon';
 
 describe('android', function () {
   const apkAnalyzerFilename = system.isWindows() ? 'apkanalyzer.bat' : 'apkanalyzer';
@@ -59,8 +60,17 @@ describe('android', function () {
     })
   );
   describe(
-    'AndroidToolCheck',
-    withMocks({adb}, (mocks) => {
+    'AndroidToolCheck', function () {
+      // withMocks won't work with ESM modules: https://github.com/sinonjs/sinon/issues/2530
+      /** @type {sinon.SinonSandbox} */
+      let sandbox;
+      beforeEach(function () {
+        sandbox = createSandbox();
+      });
+      afterEach(function () {
+        sandbox.restore();
+      });
+
       stubEnv();
       const check = new AndroidToolCheck();
       it('autofix', function () {
@@ -68,16 +78,13 @@ describe('android', function () {
       });
       it('diagnose - success', async function () {
         process.env.ANDROID_HOME = '/a/b/c/d';
-        mocks.adb
-          .expects('getAndroidBinaryPath')
-          .exactly(check.tools.length)
-          .returns(B.resolve('/path/to/binary'));
+        sandbox.stub(adb, 'getAndroidBinaryPath')
+          .get(() => sandbox.fake.resolves('/path/to/binary'));
         (await check.diagnose()).should.deep.equal({
           ok: true,
           optional: false,
           message: `adb, emulator, ${apkAnalyzerFilename} exist: /a/b/c/d`,
         });
-        mocks.verify();
       });
       it('diagnose - failure - no ANDROID_HOME', async function () {
         delete process.env.ANDROID_HOME;
@@ -87,17 +94,16 @@ describe('android', function () {
           optional: false,
           message: `adb, emulator, ${apkAnalyzerFilename} could not be found because ANDROID_HOME or ANDROID_SDK_ROOT is NOT set!`,
         });
-        mocks.verify();
       });
       it('diagnose - failure - path not valid', async function () {
         process.env.ANDROID_HOME = '/a/b/c/d';
-        mocks.adb.expects('getAndroidBinaryPath').exactly(check.tools.length).throws();
+        sandbox.stub(adb, 'getAndroidBinaryPath')
+          .get(() => sandbox.fake.throws());
         (await check.diagnose()).should.deep.equal({
           ok: false,
           optional: false,
           message: `adb, emulator, ${apkAnalyzerFilename} could NOT be found in /a/b/c/d!`,
         });
-        mocks.verify();
       });
       it('fix - ANDROID_HOME', async function () {
         delete process.env.ANDROID_HOME;
@@ -111,7 +117,7 @@ describe('android', function () {
           `Manually install adb, emulator, ${apkAnalyzerFilename} and add it to PATH. https://developer.android.com/studio#cmdline-tools and https://developer.android.com/studio/intro/update#sdk-manager may help to setup.`
         );
       });
-    })
+    }
   );
 
   describe(

packages/docutils/CHANGELOG.md

@@ -3,6 +3,43 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.6](https://github.com/appium/appium/compare/@appium/docutils@0.4.5...@appium/docutils@0.4.6) (2023-08-17)
+
+
+### Bug Fixes
+
+* **support:** update dependency semver to v7.5.4 ([03ddcdf](https://github.com/appium/appium/commit/03ddcdfcafbccf6698868a272e499cbdac41d791))
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
+## [0.4.5](https://github.com/appium/appium/compare/@appium/docutils@0.4.4...@appium/docutils@0.4.5) (2023-07-24)
+
+
+### Bug Fixes
+
+* **support:** update dependency teen_process to v2.0.4 ([151c19c](https://github.com/appium/appium/commit/151c19c1c3b4c9b94aba10033c2d863f567d849b))
+
+
+
+## [0.4.4](https://github.com/appium/appium/compare/@appium/docutils@0.4.3...@appium/docutils@0.4.4) (2023-07-03)
+
+
+### Bug Fixes
+
+* **support:** update dependency semver to v7.5.3 ([ed1856d](https://github.com/appium/appium/commit/ed1856d720c442842d5c3fe5f6caeccb8229b5f1))
+
+
+
+## [0.4.3](https://github.com/appium/appium/compare/@appium/docutils@0.4.2...@appium/docutils@0.4.3) (2023-06-29)
+
+
+### Bug Fixes
+
+* **docutils:** docs versioning and update latest ([#18804](https://github.com/appium/appium/issues/18804)) ([52a755a](https://github.com/appium/appium/commit/52a755a9135e06ad676cc422e37b5cab019c5b85))
+
+
+
 ## [0.4.2](https://github.com/appium/appium/compare/@appium/docutils@0.4.1...@appium/docutils@0.4.2) (2023-06-15)
 
 

packages/docutils/lib/builder/deploy.ts

@@ -137,11 +137,12 @@ export async function deploy({
   }
   if (serve) {
     const mikeArgs = [
-      ...argify(_.pickBy(mikeOpts, (value) => _.isNumber(value) || Boolean(value))),
-      version,
+      ...argify(_.pickBy(mikeOpts, (value) => _.isNumber(value) || Boolean(value)))
     ];
     if (alias) {
-      mikeArgs.push(alias);
+      mikeArgs.push('--update-aliases', version, alias);
+    } else {
+      mikeArgs.push(version);
     }
     stop(); // discard
     // unsure about how SIGHUP is handled here
@@ -155,10 +156,11 @@ export async function deploy({
           (value, key) => _.includes(['port', 'host'], key) || (!_.isNumber(value) && !value)
         )
       ),
-      version,
     ];
     if (alias) {
-      mikeArgs.push(alias);
+      mikeArgs.push('--update-aliases', version, alias);
+    } else {
+      mikeArgs.push(version);
     }
     await doDeploy(mikePath, mikeArgs, execOpts);
 

packages/docutils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/docutils",
-  "version": "0.4.2",
+  "version": "0.4.6",
   "description": "Documentation generation utilities for Appium and related projects",
   "keywords": [
     "automation",
@@ -49,9 +49,9 @@
     "start": "node ./build/lib/cli/index.js"
   },
   "dependencies": {
-    "@appium/support": "^4.1.0",
+    "@appium/support": "^4.1.4",
     "@appium/tsconfig": "^0.3.0",
-    "@appium/typedoc-plugin-appium": "^0.6.5",
+    "@appium/typedoc-plugin-appium": "^0.6.6",
     "@sliphua/lilconfig-ts-loader": "3.2.2",
     "@types/which": "3.0.0",
     "chalk": "4.1.2",
@@ -65,10 +65,10 @@
     "log-symbols": "4.1.0",
     "pkg-dir": "5.0.0",
     "read-pkg": "5.2.0",
-    "semver": "7.5.1",
+    "semver": "7.5.4",
     "source-map-support": "0.5.21",
-    "teen_process": "2.0.2",
-    "type-fest": "3.11.1",
+    "teen_process": "2.0.4",
+    "type-fest": "3.13.1",
     "typedoc": "0.23.28",
     "typedoc-plugin-markdown": "3.14.0",
     "typedoc-plugin-resolve-crossmodule-references": "0.3.3",

packages/docutils/requirements.txt

@@ -1,4 +1,4 @@
-mkdocs==1.4.3
-mkdocs-material==9.1.15
+mkdocs==1.5.2
+mkdocs-material==9.1.21
 mkdocs-material-extensions==1.1.1
 mike==1.1.2

packages/driver-test-support/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.12](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.11...@appium/driver-test-support@0.4.12) (2023-08-17)
+
+
+### Bug Fixes
+
+* **driver-test-support:** update definitelytyped ([c320e8a](https://github.com/appium/appium/commit/c320e8a1a61cb6d980d6d944ae47b60da97aa398))
+* **test-support:** update dependency sinon to v15.2.0 ([a21ae6a](https://github.com/appium/appium/commit/a21ae6ab2bcaba44ecdacae67076cf011b4e5ae8))
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
+## [0.4.11](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.10...@appium/driver-test-support@0.4.11) (2023-07-24)
+
+
+### Bug Fixes
+
+* **test-support:** update dependency sinon to v15.1.2 ([e5b569c](https://github.com/appium/appium/commit/e5b569c3a0a0545210f126822031420d236ad1f4))
+
+
+
+## [0.4.10](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.9...@appium/driver-test-support@0.4.10) (2023-07-03)
+
+**Note:** Version bump only for package @appium/driver-test-support
+
+
+
+
+
+## [0.4.9](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.8...@appium/driver-test-support@0.4.9) (2023-06-29)
+
+**Note:** Version bump only for package @appium/driver-test-support
+
+
+
+
+
 ## [0.4.8](https://github.com/appium/appium/compare/@appium/driver-test-support@0.4.7...@appium/driver-test-support@0.4.8) (2023-06-15)
 
 **Note:** Version bump only for package @appium/driver-test-support

packages/driver-test-support/lib/e2e-suite.js

@@ -5,9 +5,10 @@ import B from 'bluebird';
 import {TEST_HOST, getTestPort, createAppiumURL} from './helpers';
 import chai from 'chai';
 import sinon from 'sinon';
-import { Agent } from 'node:http';
+import {Agent} from 'node:http';
 
 const should = chai.should();
+const {expect} = chai;
 
 /**
  * Creates some helper functions for E2E tests to manage sessions.
@@ -150,7 +151,7 @@ export function driverE2ETestSuite(DriverClass, defaultCaps = {}) {
     describe('session handling', function () {
       it('should handle idempotency while creating sessions', async function () {
         // workaround for https://github.com/node-fetch/node-fetch/issues/1735
-        const httpAgent = new Agent({ keepAlive: true });
+        const httpAgent = new Agent({keepAlive: true});
 
         const sessionIds = [];
         let times = 0;
@@ -179,7 +180,7 @@ export function driverE2ETestSuite(DriverClass, defaultCaps = {}) {
 
       it('should handle idempotency while creating parallel sessions', async function () {
         // workaround for https://github.com/node-fetch/node-fetch/issues/1735
-        const httpAgent = new Agent({ keepAlive: true });
+        const httpAgent = new Agent({keepAlive: true});
 
         const reqs = [];
         let times = 0;
@@ -400,22 +401,49 @@ export function driverE2ETestSuite(DriverClass, defaultCaps = {}) {
     });
 
     describe('event timings', function () {
-      it('should not add timings if not using opt-in cap', async function () {
-        const session = await startSession({capabilities: {alwaysMatch: defaultCaps}});
-        const res = await getSession(session.sessionId);
-        should.not.exist(res.events);
-        await endSession(session.sessionId);
+      /** @type {NewSessionResponse} */
+      let session;
+      /** @type {SingularSessionData} */
+      let res;
+
+      describe('when not provided the eventTimings cap', function () {
+        before(async function () {
+          session = await startSession({capabilities: {alwaysMatch: defaultCaps}});
+          res = await getSession(session.sessionId);
+        });
+
+        after(async function () {
+          if (session) {
+            await endSession(session.sessionId);
+          }
+        });
+
+        it('should not respond with events', function () {
+          expect(res.events).to.be.undefined;
+        });
       });
-      it('should add start session timings', async function () {
-        const caps = {...defaultCaps, 'appium:eventTimings': true};
-        const session = await startSession({capabilities: {alwaysMatch: caps}});
-        const res = await getSession(session.sessionId);
-        should.exist(res.events);
-        should.exist(res.events?.newSessionRequested);
-        should.exist(res.events?.newSessionStarted);
-        res.events?.newSessionRequested[0].should.be.a('number');
-        res.events?.newSessionStarted[0].should.be.a('number');
-        await endSession(session.sessionId);
+
+      describe('when provided the eventTimings cap', function () {
+        before(async function () {
+          session = await startSession({
+            capabilities: {alwaysMatch: {...defaultCaps, 'appium:eventTimings': true}},
+          });
+          res = await getSession(session.sessionId);
+        });
+
+        after(async function () {
+          if (session) {
+            await endSession(session.sessionId);
+          }
+        });
+
+        it('should add a newSessionRequested event', function () {
+          expect(res.events?.newSessionRequested?.[0]).to.be.a('number');
+        });
+
+        it('should add a newSessionStarted event', function () {
+          expect(res.events?.newSessionRequested?.[0]).to.be.a('number');
+        });
       });
     });
   });

packages/driver-test-support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/driver-test-support",
-  "version": "0.4.8",
+  "version": "0.4.12",
   "description": "Test utilities for Appium drivers",
   "keywords": [
     "automation",
@@ -41,18 +41,18 @@
   },
   "types": "./build/lib/index.d.ts",
   "dependencies": {
-    "@appium/types": "^0.13.0",
-    "@types/lodash": "4.14.195",
+    "@appium/types": "^0.13.3",
+    "@types/lodash": "4.14.196",
     "@types/stoppable": "1.1.1",
     "axios": "1.4.0",
     "bluebird": "3.7.2",
     "chai": "4.3.7",
     "get-port": "5.1.1",
     "lodash": "4.17.21",
-    "sinon": "15.1.0",
+    "sinon": "15.2.0",
     "source-map-support": "0.5.21",
     "stoppable": "1.1.0",
-    "type-fest": "3.11.1"
+    "type-fest": "3.13.1"
   },
   "peerDependencies": {
     "appium": "^2.0.0-beta.43",

packages/eslint-config-appium/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.4](https://github.com/appium/appium/compare/@appium/eslint-config-appium@8.0.3...@appium/eslint-config-appium@8.0.4) (2023-07-03)
+
+
+### Bug Fixes
+
+* **eslint-config-appium:** remove prototype assignment warning ([679865e](https://github.com/appium/appium/commit/679865ed2f1df59baef8c4d884b0a63a9222940e))
+
+
+
 ## [8.0.3](https://github.com/appium/appium/compare/@appium/eslint-config-appium@8.0.2...@appium/eslint-config-appium@8.0.3) (2023-04-03)
 
 **Note:** Version bump only for package @appium/eslint-config-appium

packages/eslint-config-appium/index.js

@@ -91,18 +91,6 @@ module.exports = {
     'require-atomic-updates': 0,
     'no-prototype-builtins': 1,
     'no-redeclare': 1,
-    'no-restricted-syntax': [
-      'warn',
-      {
-        selector: 'AssignmentExpression[left.object.property.name="prototype"]',
-        message: 'Avoid assignment to prototype; use class fields, methods or mixins instead.',
-      },
-      {
-        selector:
-          'CallExpression[callee.object.name="Object"][callee.property.name="assign"][arguments.0.property.name="prototype"]',
-        message: 'Avoid assignment to prototype; use class fields, methods or mixins instead.',
-      },
-    ],
   },
   overrides: [
     /**

packages/eslint-config-appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/eslint-config-appium",
-  "version": "8.0.3",
+  "version": "8.0.4",
   "description": "Shared ESLint config for Appium projects",
   "keywords": [
     "eslint",

packages/execute-driver-plugin/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.16](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.15...@appium/execute-driver-plugin@3.0.16) (2023-08-17)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency webdriverio to v7.32.3 ([9a5c9ae](https://github.com/appium/appium/commit/9a5c9ae55c97ea3e5c604ecbc3f972480d091ba9))
+
+
+
+## [3.0.15](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.14...@appium/execute-driver-plugin@3.0.15) (2023-07-24)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency webdriverio to v7.32.0 ([b9151a5](https://github.com/appium/appium/commit/b9151a573b6a8b0a5194658882ad59cca1a5f8b5))
+
+
+
 ## [3.0.14](https://github.com/appium/appium/compare/@appium/execute-driver-plugin@3.0.13...@appium/execute-driver-plugin@3.0.14) (2023-06-14)
 
 

packages/execute-driver-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/execute-driver-plugin",
-  "version": "3.0.14",
+  "version": "3.0.16",
   "description": "Plugin for batching and executing driver commands with Appiums",
   "keywords": [
     "automation",
@@ -43,7 +43,7 @@
     "lodash": "4.17.21",
     "source-map-support": "0.5.21",
     "vm2": "3.9.19",
-    "webdriverio": "7.31.1"
+    "webdriverio": "7.32.3"
   },
   "peerDependencies": {
     "appium": "^2.0.0-beta.35"

packages/fake-driver/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.2.7](https://github.com/appium/appium/compare/@appium/fake-driver@5.2.6...@appium/fake-driver@5.2.7) (2023-08-17)
+
+
+### Bug Fixes
+
+* **universal-xml-plugin:** update dependency @xmldom/xmldom to v0.8.10 ([#18949](https://github.com/appium/appium/issues/18949)) ([12147d5](https://github.com/appium/appium/commit/12147d518fc3ac86b01c3401b9e462b5dca99ca4))
+
+
+
+## [5.2.6](https://github.com/appium/appium/compare/@appium/fake-driver@5.2.5...@appium/fake-driver@5.2.6) (2023-07-03)
+
+
+### Bug Fixes
+
+* **types:** separate the type of opts from initialOpts ([d6cca51](https://github.com/appium/appium/commit/d6cca5175c3e55d4670936c9d216cd3a6610d16b))
+
+
+
 ## [5.2.5](https://github.com/appium/appium/compare/@appium/fake-driver@5.2.4...@appium/fake-driver@5.2.5) (2023-06-15)
 
 

packages/fake-driver/lib/driver.js

@@ -55,7 +55,7 @@ export class FakeDriver extends BaseDriver {
   elMap;
 
   constructor(
-    opts = /** @type {import('@appium/types').DriverOpts<FakeDriverConstraints>} */ ({}),
+    opts = /** @type {import('@appium/types').InitialOpts} */ ({}),
     shouldValidateCaps = true
   ) {
     super(opts, shouldValidateCaps);

packages/fake-driver/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/fake-driver",
-  "version": "5.2.5",
+  "version": "5.2.7",
   "description": "Mock driver used internally by Appium for testing. Ignore",
   "keywords": [
     "automation",
@@ -47,7 +47,7 @@
   },
   "dependencies": {
     "@types/bluebird": "3.5.38",
-    "@xmldom/xmldom": "0.8.8",
+    "@xmldom/xmldom": "0.8.10",
     "asyncbox": "2.9.4",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",

packages/fake-plugin/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.21](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.20...@appium/fake-plugin@3.1.21) (2023-08-17)
+
+**Note:** Version bump only for package @appium/fake-plugin
+
+
+
+
+
+## [3.1.20](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.19...@appium/fake-plugin@3.1.20) (2023-07-24)
+
+**Note:** Version bump only for package @appium/fake-plugin
+
+
+
+
+
+## [3.1.19](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.18...@appium/fake-plugin@3.1.19) (2023-07-03)
+
+**Note:** Version bump only for package @appium/fake-plugin
+
+
+
+
+
+## [3.1.18](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.17...@appium/fake-plugin@3.1.18) (2023-06-29)
+
+**Note:** Version bump only for package @appium/fake-plugin
+
+
+
+
+
 ## [3.1.17](https://github.com/appium/appium/compare/@appium/fake-plugin@3.1.16...@appium/fake-plugin@3.1.17) (2023-06-15)
 
 **Note:** Version bump only for package @appium/fake-plugin

packages/fake-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/fake-plugin",
-  "version": "3.1.17",
+  "version": "3.1.21",
   "description": "A fake Appium 2.0 plugin",
   "keywords": [
     "automation",
@@ -39,8 +39,8 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-plugin": "^2.2.13",
-    "@appium/support": "^4.1.0",
+    "@appium/base-plugin": "^2.2.17",
+    "@appium/support": "^4.1.4",
     "@types/bluebird": "3.5.38",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",

packages/images-plugin/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.1.3](https://github.com/appium/appium/compare/@appium/images-plugin@2.1.2...@appium/images-plugin@2.1.3) (2023-08-17)
+
+**Note:** Version bump only for package @appium/images-plugin
+
+
+
+
+
 ## [2.1.2](https://github.com/appium/appium/compare/@appium/images-plugin@2.1.1...@appium/images-plugin@2.1.2) (2023-06-14)
 
 

packages/images-plugin/docs/image-comparison.md

@@ -98,7 +98,7 @@ assert File.size? 'find_result_visual.png'
    The image must have the same scale and look the same. However, you can add a scaling transformation beforehand.
 
    official doc:
-   https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md
+   https://github.com/appium/appium/blob/master/packages/images-plugin/docs/image-comparison.md
    OpenCV algorithm doc:
    https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html
    official sample code:

packages/images-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/images-plugin",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "Plugin for working with images and image elements in Appium",
   "keywords": [
     "automation",
@@ -39,10 +39,10 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/opencv": "^2.1.1",
+    "@appium/opencv": "^2.1.2",
     "lodash": "4.17.21",
     "lru-cache": "7.18.3",
-    "sharp": "0.32.1",
+    "sharp": "0.32.4",
     "source-map-support": "0.5.21"
   },
   "peerDependencies": {

packages/opencv/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.1.2](https://github.com/appium/appium/compare/@appium/opencv@2.1.1...@appium/opencv@2.1.2) (2023-08-17)
+
+**Note:** Version bump only for package @appium/opencv
+
+
+
+
+
 ## [2.1.1](https://github.com/appium/appium/compare/@appium/opencv@2.1.0...@appium/opencv@2.1.1) (2023-06-14)
 
 

packages/opencv/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/opencv",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "OpenCV-related helper library",
   "keywords": [
     "automation",
@@ -45,7 +45,7 @@
     "bluebird": "3.7.2",
     "lodash": "4.17.21",
     "opencv-bindings": "4.5.5",
-    "sharp": "0.32.1",
+    "sharp": "0.32.4",
     "source-map-support": "0.5.21"
   },
   "engines": {

packages/plugin-test-support/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.3.20](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.19...@appium/plugin-test-support@0.3.20) (2023-08-17)
+
+**Note:** Version bump only for package @appium/plugin-test-support
+
+
+
+
+
+## [0.3.19](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.18...@appium/plugin-test-support@0.3.19) (2023-07-24)
+
+
+### Bug Fixes
+
+* **support:** update dependency teen_process to v2.0.4 ([151c19c](https://github.com/appium/appium/commit/151c19c1c3b4c9b94aba10033c2d863f567d849b))
+
+
+
+## [0.3.18](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.17...@appium/plugin-test-support@0.3.18) (2023-07-03)
+
+**Note:** Version bump only for package @appium/plugin-test-support
+
+
+
+
+
+## [0.3.17](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.16...@appium/plugin-test-support@0.3.17) (2023-06-29)
+
+**Note:** Version bump only for package @appium/plugin-test-support
+
+
+
+
+
 ## [0.3.16](https://github.com/appium/appium/compare/@appium/plugin-test-support@0.3.15...@appium/plugin-test-support@0.3.16) (2023-06-15)
 
 **Note:** Version bump only for package @appium/plugin-test-support

packages/plugin-test-support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/plugin-test-support",
-  "version": "0.3.16",
+  "version": "0.3.20",
   "description": "Testing utilities for Appium plugins",
   "keywords": [
     "automation",
@@ -41,11 +41,11 @@
     "test:unit": "exit 0"
   },
   "dependencies": {
-    "@appium/types": "^0.13.0",
+    "@appium/types": "^0.13.3",
     "get-port": "5.1.1",
     "log-symbols": "4.1.0",
     "source-map-support": "0.5.21",
-    "teen_process": "2.0.2"
+    "teen_process": "2.0.4"
   },
   "peerDependencies": {
     "appium": "^2.0.0-beta.43",

packages/schema/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.3.1](https://github.com/appium/appium/compare/@appium/schema@0.3.0...@appium/schema@0.3.1) (2023-07-03)
+
+
+### Bug Fixes
+
+* **appium:** restrict address to ipv6/hostname ([#18824](https://github.com/appium/appium/issues/18824)) ([f09fbb6](https://github.com/appium/appium/commit/f09fbb64dce0e179a007f3a0ae9800e61fbe90eb)), closes [#18716](https://github.com/appium/appium/issues/18716)
+
+
+
 ## [0.3.0](https://github.com/appium/appium/compare/@appium/schema@0.2.6...@appium/schema@0.3.0) (2023-06-14)
 
 

packages/schema/lib/appium-config-schema.js

@@ -26,7 +26,16 @@ export const AppiumConfigJsonSchema = /** @type {const} */ ({
           description: 'IPv4/IPv6 address or a hostname to listen on',
           title: 'address config',
           type: 'string',
-          // this should be anyOf [format: "hostname" or format: "ipv6"], but there seems to be a bug in json-schema-to-typescript preventing "ipv6" from converting to type "string"'
+          anyOf: [
+            {
+              type: 'string',
+              format: 'hostname',
+            },
+            {
+              type: 'string',
+              format: 'ipv6',
+            },
+          ],
         },
         'allow-cors': {
           description:

packages/schema/lib/appium-config.schema.json

@@ -20,7 +20,17 @@
           "default": "0.0.0.0",
           "description": "IPv4/IPv6 address or a hostname to listen on",
           "title": "address config",
-          "type": "string"
+          "type": "string",
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "hostname"
+            },
+            {
+              "type": "string",
+              "format": "ipv6"
+            }
+          ]
         },
         "allow-cors": {
           "description": "Whether the Appium server should allow web browser connections from any host",

packages/schema/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/schema",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Appium Configuration Schema",
   "keywords": [
     "automation",

packages/support/CHANGELOG.md

@@ -3,6 +3,46 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.1.4](https://github.com/appium/appium/compare/@appium/support@4.1.3...@appium/support@4.1.4) (2023-08-17)
+
+
+### Bug Fixes
+
+* **driver-test-support:** update definitelytyped ([c320e8a](https://github.com/appium/appium/commit/c320e8a1a61cb6d980d6d944ae47b60da97aa398))
+* **support:** update dependency glob to v10 ([#18490](https://github.com/appium/appium/issues/18490)) ([aaf31a5](https://github.com/appium/appium/commit/aaf31a577cb0b9cbe22646dcd888dc393a03aa11))
+* **support:** update dependency plist to v3.1.0 ([f9ba313](https://github.com/appium/appium/commit/f9ba31383ad2c97f8dc5999c8a28e6bc6345b192))
+* **support:** update dependency semver to v7.5.4 ([03ddcdf](https://github.com/appium/appium/commit/03ddcdfcafbccf6698868a272e499cbdac41d791))
+* **test-support:** update dependency @colors/colors to v1.6.0 ([1358937](https://github.com/appium/appium/commit/1358937db2edf08ce1ebe3dff2f70ac6b07cd373))
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
+## [4.1.3](https://github.com/appium/appium/compare/@appium/support@4.1.2...@appium/support@4.1.3) (2023-07-24)
+
+
+### Bug Fixes
+
+* **support:** update dependency teen_process to v2.0.4 ([151c19c](https://github.com/appium/appium/commit/151c19c1c3b4c9b94aba10033c2d863f567d849b))
+
+
+
+## [4.1.2](https://github.com/appium/appium/compare/@appium/support@4.1.1...@appium/support@4.1.2) (2023-07-03)
+
+
+### Bug Fixes
+
+* **support:** update dependency semver to v7.5.3 ([ed1856d](https://github.com/appium/appium/commit/ed1856d720c442842d5c3fe5f6caeccb8229b5f1))
+
+
+
+## [4.1.1](https://github.com/appium/appium/compare/@appium/support@4.1.0...@appium/support@4.1.1) (2023-06-29)
+
+**Note:** Version bump only for package @appium/support
+
+
+
+
+
 ## [4.1.0](https://github.com/appium/appium/compare/@appium/support@4.0.3...@appium/support@4.1.0) (2023-06-15)
 
 

packages/support/lib/fs.js

@@ -13,7 +13,7 @@ import {
   rmSync,
   open,
 } from 'fs';
-import glob from 'glob';
+import { glob } from 'glob';
 import klaw from 'klaw';
 import _ from 'lodash';
 import mv from 'mv';
@@ -158,7 +158,9 @@ const fs = {
    * Given a glob pattern, resolve with list of files matching that pattern
    * @see https://github.com/isaacs/node-glob
    */
-  glob: /** @type {(pattern: string, opts?: glob.IOptions) => B<string[]>} */ (B.promisify(glob)),
+  glob: /** @type {(pattern: string, opts?: import('glob').GlobOptions) => B<string[]>} */ (
+    (pattern, options) => B.resolve(options ? glob(pattern, options) : glob(pattern))
+  ),
 
   /**
    * Sanitize a filename

packages/support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/support",
-  "version": "4.1.0",
+  "version": "4.1.4",
   "description": "Support libs used across appium packages",
   "keywords": [
     "automation",
@@ -42,24 +42,23 @@
   },
   "dependencies": {
     "@appium/tsconfig": "^0.3.0",
-    "@appium/types": "^0.13.0",
-    "@colors/colors": "1.5.0",
+    "@appium/types": "^0.13.3",
+    "@colors/colors": "1.6.0",
     "@types/archiver": "5.3.2",
     "@types/base64-stream": "1.0.2",
     "@types/find-root": "1.1.2",
-    "@types/glob": "8.1.0",
     "@types/jsftp": "2.1.2",
     "@types/klaw": "3.0.3",
     "@types/lockfile": "1.0.2",
     "@types/mv": "2.1.2",
     "@types/ncp": "2.0.5",
     "@types/npmlog": "4.1.4",
-    "@types/pluralize": "0.0.29",
+    "@types/pluralize": "0.0.30",
     "@types/semver": "7.5.0",
     "@types/shell-quote": "1.7.1",
     "@types/supports-color": "8.1.1",
     "@types/teen_process": "2.0.0",
-    "@types/uuid": "9.0.1",
+    "@types/uuid": "9.0.2",
     "@types/which": "3.0.0",
     "archiver": "5.3.1",
     "axios": "1.4.0",
@@ -69,7 +68,7 @@
     "bplist-parser": "0.3.2",
     "form-data": "4.0.0",
     "get-stream": "6.0.1",
-    "glob": "8.1.0",
+    "glob": "10.3.3",
     "jsftp": "2.1.3",
     "klaw": "4.1.0",
     "lockfile": "1.0.4",
@@ -81,23 +80,23 @@
     "npmlog": "7.0.1",
     "opencv-bindings": "4.5.5",
     "pkg-dir": "5.0.0",
-    "plist": "3.0.6",
+    "plist": "3.1.0",
     "pluralize": "8.0.0",
     "read-pkg": "5.2.0",
     "resolve-from": "5.0.0",
     "sanitize-filename": "1.6.3",
-    "semver": "7.5.1",
+    "semver": "7.5.4",
     "shell-quote": "1.8.1",
     "source-map-support": "0.5.21",
     "supports-color": "8.1.1",
-    "teen_process": "2.0.2",
-    "type-fest": "3.11.1",
+    "teen_process": "2.0.4",
+    "type-fest": "3.13.1",
     "uuid": "9.0.0",
     "which": "3.0.1",
     "yauzl": "2.10.0"
   },
   "optionalDependencies": {
-    "sharp": "0.32.1"
+    "sharp": "0.32.4"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",

packages/test-support/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.22](https://github.com/appium/appium/compare/@appium/test-support@3.0.21...@appium/test-support@3.0.22) (2023-08-17)
+
+
+### Bug Fixes
+
+* **test-support:** update dependency @colors/colors to v1.6.0 ([1358937](https://github.com/appium/appium/commit/1358937db2edf08ce1ebe3dff2f70ac6b07cd373))
+* **test-support:** update dependency sinon to v15.2.0 ([a21ae6a](https://github.com/appium/appium/commit/a21ae6ab2bcaba44ecdacae67076cf011b4e5ae8))
+
+
+
+## [3.0.21](https://github.com/appium/appium/compare/@appium/test-support@3.0.20...@appium/test-support@3.0.21) (2023-07-24)
+
+
+### Bug Fixes
+
+* **test-support:** update dependency sinon to v15.1.2 ([e5b569c](https://github.com/appium/appium/commit/e5b569c3a0a0545210f126822031420d236ad1f4))
+
+
+
+## [3.0.20](https://github.com/appium/appium/compare/@appium/test-support@3.0.19...@appium/test-support@3.0.20) (2023-07-03)
+
+**Note:** Version bump only for package @appium/test-support
+
+
+
+
+
+## [3.0.19](https://github.com/appium/appium/compare/@appium/test-support@3.0.18...@appium/test-support@3.0.19) (2023-06-29)
+
+**Note:** Version bump only for package @appium/test-support
+
+
+
+
+
 ## [3.0.18](https://github.com/appium/appium/compare/@appium/test-support@3.0.17...@appium/test-support@3.0.18) (2023-06-15)
 
 **Note:** Version bump only for package @appium/test-support

packages/test-support/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/test-support",
-  "version": "3.0.18",
+  "version": "3.0.22",
   "description": "A collection of test utilities used across Appium packages",
   "keywords": [
     "automation",
@@ -45,12 +45,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^4.1.0",
-    "@colors/colors": "1.5.0",
+    "@appium/support": "^4.1.4",
+    "@colors/colors": "1.6.0",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",
     "loud-rejection": "2.2.0",
-    "sinon": "15.1.0",
+    "sinon": "15.2.0",
     "source-map-support": "0.5.21"
   },
   "engines": {

packages/typedoc-plugin-appium/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.6](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.5...@appium/typedoc-plugin-appium@0.6.6) (2023-08-17)
+
+
+### Bug Fixes
+
+* **typedoc-plugin-appium:** update dependency handlebars to v4.7.8 ([#18947](https://github.com/appium/appium/issues/18947)) ([a888e26](https://github.com/appium/appium/commit/a888e263317839cecbc2cb42e183d190e136624d))
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
 ## [0.6.5](https://github.com/appium/appium/compare/@appium/typedoc-plugin-appium@0.6.4...@appium/typedoc-plugin-appium@0.6.5) (2023-06-14)
 
 

packages/typedoc-plugin-appium/README.md

@@ -71,7 +71,7 @@ This packages uses snapshot tests to assert the generated markdown is correct.
 To update the snapshots, execute:
 
 ```bash
-UPDATE_SNAPSHOT=1 npm test
+UPDATE_SNAPSHOT=1 npm run test:e2e
 ```
 
 This will (likely) modify the snapshots in your working copy, so you will then need to commit them.

packages/typedoc-plugin-appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/typedoc-plugin-appium",
-  "version": "0.6.5",
+  "version": "0.6.6",
   "description": "TypeDoc plugin for Appium & its extensions",
   "homepage": "https://appium.io",
   "license": "Apache-2.0",
@@ -60,10 +60,10 @@
     "typescript": "^4.7.0 || ^5.0.0"
   },
   "dependencies": {
-    "handlebars": "4.7.7",
+    "handlebars": "4.7.8",
     "lodash": "4.17.21",
     "pluralize": "8.0.0",
-    "type-fest": "3.11.1"
+    "type-fest": "3.13.1"
   },
   "gitHead": "8480a85ce2fa466360e0fb1a7f66628331907f02"
 }

packages/typedoc-plugin-appium/test/e2e/theme/__snapshots__/output.e2e.spec.ts.snap

@@ -5,38 +5,6 @@ exports[`@appium/typedoc-plugin-appium theme command output should generate expe
 
 ## Commands
 
-### \`getSettings\`
-
-\`GET\` **\`/session/:sessionId/appium/settings\`**
-
-Get the current settings for the session
-
-<!-- comment source: method-signature -->
-
-#### Response
-
-\`StringRecord\`<\`any\`\\\\>
-
-The settings object
-
-### \`updateSettings\`
-
-\`POST\` **\`/session/:sessionId/appium/settings\`**
-
-Get the current settings for the session
-
-<!-- comment source: method-signature -->
-
-##### Required Parameters
-
-- \`settings\`
-
-#### Response
-
-\`StringRecord\`<\`any\`\\\\>
-
-The settings object
-
 ### \`createSession\`
 
 \`POST\` **\`/session\`**
@@ -62,7 +30,7 @@ the latter.
 
 #### Response
 
-\`DefaultCreateSessionResult\`<\`C\`\\\\>
+\`CreateResult\`
 
 The capabilities object representing the created session
 
@@ -76,7 +44,7 @@ Returns capabilities for the session and event history (if applicable)
 
 #### Response
 
-\`DriverCaps\`<\`C\`\\\\>
+\`SingularSessionData\`<\`C\`, \`SessionData\`\\\\>
 
 A session data object
 
@@ -90,7 +58,7 @@ Returns capabilities for the session and event history (if applicable)
 
 #### Response
 
-\`DriverCaps\`<\`C\`\\\\>
+\`SingularSessionData\`<\`C\`, \`SessionData\`\\\\>
 
 A session data object
 
@@ -360,6 +328,36 @@ Get data for all sessions running on an Appium server
 
 A list of session data objects
 
+### \`getSettings\`
+
+\`GET\` **\`/session/:sessionId/appium/settings\`**
+
+Update the session's settings dictionary with a new settings object
+
+<!-- comment source: builtin-interface -->
+
+#### Response
+
+\`\`null\`\`
+
+### \`updateSettings\`
+
+\`POST\` **\`/session/:sessionId/appium/settings\`**
+
+Update the session's settings dictionary with a new settings object
+
+<!-- comment source: builtin-interface -->
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| \`settings\` | \`Settings\` | A key-value map of setting names to values. Settings not named in the map will not have their value adjusted. |
+
+#### Response
+
+\`\`null\`\`
+
 ### \`getStatus\`
 
 \`GET\` **\`/status\`**
@@ -594,39 +592,7 @@ Get the driver args that were sent in via the CLI
 
 #### Response
 
-\`StringRecord\`<\`any\`\\\\> & \`ServerArgs\`
-
-### \`getSettings\`
-
-\`GET\` **\`/session/:sessionId/appium/settings\`**
-
-Get the current settings for the session
-
-<!-- comment source: method-signature -->
-
-#### Response
-
-\`StringRecord\`<\`any\`\\\\>
-
-The settings object
-
-### \`updateSettings\`
-
-\`POST\` **\`/session/:sessionId/appium/settings\`**
-
-Get the current settings for the session
-
-<!-- comment source: method-signature -->
-
-##### Required Parameters
-
-- \`settings\`
-
-#### Response
-
-\`StringRecord\`<\`any\`\\\\>
-
-The settings object
+\`StringRecord\` & \`ServerArgs\`
 
 ### \`createSession\`
 
@@ -664,7 +630,7 @@ Returns capabilities for the session and event history (if applicable)
 
 #### Response
 
-\`DriverCaps\`<{ \`app\`: { \`isString\`: \`\`true\`\` = true; \`presence\`: \`\`true\`\` = true } ; \`uniqueApp\`: { \`isBoolean\`: \`\`true\`\` = true }  }\\\\>
+\`SingularSessionData\`<{ \`app\`: { \`isString\`: \`\`true\`\` = true; \`presence\`: \`\`true\`\` = true } ; \`uniqueApp\`: { \`isBoolean\`: \`\`true\`\` = true }  }, \`StringRecord\`\\\\>
 
 A session data object
 
@@ -678,7 +644,7 @@ Returns capabilities for the session and event history (if applicable)
 
 #### Response
 
-\`DriverCaps\`<{ \`app\`: { \`isString\`: \`\`true\`\` = true; \`presence\`: \`\`true\`\` = true } ; \`uniqueApp\`: { \`isBoolean\`: \`\`true\`\` = true }  }\\\\>
+\`SingularSessionData\`<{ \`app\`: { \`isString\`: \`\`true\`\` = true; \`presence\`: \`\`true\`\` = true } ; \`uniqueApp\`: { \`isBoolean\`: \`\`true\`\` = true }  }, \`StringRecord\`\\\\>
 
 A session data object
 
@@ -948,6 +914,36 @@ Get data for all sessions running on an Appium server
 
 A list of session data objects
 
+### \`getSettings\`
+
+\`GET\` **\`/session/:sessionId/appium/settings\`**
+
+Update the session's settings dictionary with a new settings object
+
+<!-- comment source: builtin-interface -->
+
+#### Response
+
+\`\`null\`\`
+
+### \`updateSettings\`
+
+\`POST\` **\`/session/:sessionId/appium/settings\`**
+
+Update the session's settings dictionary with a new settings object
+
+<!-- comment source: builtin-interface -->
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| \`settings\` | \`StringRecord\` | A key-value map of setting names to values. Settings not named in the map will not have their value adjusted. |
+
+#### Response
+
+\`\`null\`\`
+
 ### \`getStatus\`
 
 \`GET\` **\`/status\`**

packages/types/CHANGELOG.md

@@ -3,6 +3,37 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.13.3](https://github.com/appium/appium/compare/@appium/types@0.13.2...@appium/types@0.13.3) (2023-08-17)
+
+
+### Bug Fixes
+
+* **types:** update dependency type-fest to v3.13.1 ([fb34ab9](https://github.com/appium/appium/commit/fb34ab917216121d2b554677a12f07a03393d218))
+
+
+
+## [0.13.2](https://github.com/appium/appium/compare/@appium/types@0.13.1...@appium/types@0.13.2) (2023-07-03)
+
+
+### Bug Fixes
+
+* **appium:** restrict address to ipv6/hostname ([#18824](https://github.com/appium/appium/issues/18824)) ([f09fbb6](https://github.com/appium/appium/commit/f09fbb64dce0e179a007f3a0ae9800e61fbe90eb)), closes [#18716](https://github.com/appium/appium/issues/18716)
+* **types,base-driver:** remove deviceName from base constraints ([01061b2](https://github.com/appium/appium/commit/01061b291981333bdec59adfbea60f0cef3d69c1))
+* **types:** ensure return type of deleteSession can always be void ([ee9b2a3](https://github.com/appium/appium/commit/ee9b2a30dee4a24b351375862883986e6d4e618c))
+* **types:** fix signature of updateSettings ([24e7aec](https://github.com/appium/appium/commit/24e7aeca7dcab69e84e797e9e3168492d0e70e83))
+* **types:** separate the type of opts from initialOpts ([d6cca51](https://github.com/appium/appium/commit/d6cca5175c3e55d4670936c9d216cd3a6610d16b))
+* **types:** update some more types to reflect reality ([62f4244](https://github.com/appium/appium/commit/62f4244753b450eb0c9b96483a8b04a40ef289d2))
+
+
+
+## [0.13.1](https://github.com/appium/appium/compare/@appium/types@0.13.0...@appium/types@0.13.1) (2023-06-29)
+
+**Note:** Version bump only for package @appium/types
+
+
+
+
+
 ## [0.13.0](https://github.com/appium/appium/compare/@appium/types@0.12.0...@appium/types@0.13.0) (2023-06-15)
 
 

packages/types/lib/appium-config.ts

@@ -8,7 +8,9 @@
 /**
  * IPv4/IPv6 address or a hostname to listen on
  */
-export type AddressConfig = string;
+export type AddressConfig = AddressConfig1 & AddressConfig2;
+export type AddressConfig1 = string;
+export type AddressConfig2 = string;
 /**
  * Whether the Appium server should allow web browser connections from any host
  */

packages/types/lib/command.ts

@@ -30,16 +30,16 @@ export interface PayloadParams {
  * }
  * ```
  */
-export type MethodMap<T extends Plugin | Driver<any>> = T extends Plugin
+export type MethodMap<T extends Plugin | Driver> = T extends Plugin
   ? Readonly<PluginMethodMap<T>>
-  : T extends Driver<any>
+  : T extends Driver
   ? Readonly<DriverMethodMap<T>>
   : never;
 
 /**
  * A {@linkcode MethodMap} for a {@linkcode Driver}.
  */
-export interface DriverMethodMap<T extends Driver<any>> {
+export interface DriverMethodMap<T extends Driver> {
   [key: string]: {
     GET?: DriverMethodDef<T>;
     POST?: DriverMethodDef<T>;
@@ -118,7 +118,7 @@ export interface BaseExecuteMethodDef {
 /**
  * A definition of an execute method in a {@linkcode Driver}.
  */
-export interface DriverExecuteMethodDef<T extends Driver<any>> extends BaseExecuteMethodDef {
+export interface DriverExecuteMethodDef<T extends Driver> extends BaseExecuteMethodDef {
   command: keyof ConditionalPick<T, DriverCommand>;
 }
 
@@ -132,8 +132,8 @@ export interface PluginExecuteMethodDef<T extends Plugin> extends BaseExecuteMet
 /**
  * Definition of an execute method (which overloads the behavior of the `execute` command) in a {@linkcode Driver} or {@linkcode Plugin}.
  */
-export type ExecuteMethodMap<T extends Plugin | Driver<any>> = T extends Plugin
+export type ExecuteMethodMap<T extends Plugin | Driver> = T extends Plugin
   ? Readonly<StringRecord<PluginExecuteMethodDef<T>>>
-  : T extends Driver<any>
+  : T extends Driver
   ? Readonly<StringRecord<DriverExecuteMethodDef<T>>>
   : never;

packages/types/lib/constraints.ts

@@ -1,4 +1,4 @@
-import {Constraints} from './driver';
+import type {Constraints} from './driver';
 
 export const BASE_DESIRED_CAP_CONSTRAINTS = {
   platformName: {
@@ -8,9 +8,6 @@ export const BASE_DESIRED_CAP_CONSTRAINTS = {
   app: {
     isString: true,
   },
-  deviceName: {
-    isString: true,
-  },
   platformVersion: {
     isString: true,
   },