Prepare for 1.18.2

* bump appium-uiautomator2-server to 4.12.2

* bump to 1.18.1

.dependabot/config.yml

@@ -0,0 +1,11 @@
+version: 1
+update_configs:
+  - package_manager: "javascript"
+    directory: "/"
+    update_schedule: "live"
+  - package_manager: "javascript"
+    directory: "/sample-code/javascript-wd"
+    update_schedule: "live"
+  - package_manager: "javascript"
+    directory: "/sample-code/javascript-webdriverio"
+    update_schedule: "live"

.eslintignore

@@ -1,6 +1,2 @@
 coverage
 node_modules
-examples/javascript-wd
-packages/*/build/**/*
-**/*.min.js
-

.eslintrc

@@ -1,14 +1,3 @@
 {
-  "extends": "@appium/eslint-config-appium",
-  "overrides": [
-    {
-      "files": "packages/fake-driver/**/*",
-      "rules": { "require-await": "off" }
-    },
-    { "files": "packages/support/**/*", "globals": { "BigInt": "readonly" } },
-    {
-      "files": "packages/*/test/**/*",
-      "rules": { "func-names": "off" }
-    }
-  ]
+  "extends": "appium"
 }

.fossa.yml

@@ -1,64 +0,0 @@
-# Generated by FOSSA CLI (https://github.com/fossas/fossa-cli)
-# Visit https://fossa.com to learn more
-
-version: 2
-cli:
-  server: https://app.fossa.com
-  fetcher: git
-  project: github.com/appium/appium
-analyze:
-  modules:
-    - name: appium-monorepo
-      type: npm
-      target: .
-      path: .
-      options:
-        strategy: node_modules
-    - name: appium
-      type: npm
-      target: ./packages/appium
-      path: ./packages/appium
-      options:
-        strategy: node_modules
-    - name: '@appium/base-driver'
-      type: npm
-      target: ./packages/base-driver
-      path: ./packages/base-driver
-      options:
-        strategy: node_modules
-    - name: '@appium/doctor'
-      type: npm
-      target: ./packages/doctor
-      path: ./packages/doctor
-      options:
-        strategy: node_modules
-    - name: eslint-config-appium
-      type: npm
-      target: ./packages/eslint-config-appium
-      path: ./packages/eslint-config-appium
-      options:
-        strategy: node_modules
-    - name: '@appium/fake-driver'
-      type: npm
-      target: ./packages/fake-driver
-      path: ./packages/fake-driver
-      options:
-        strategy: node_modules
-    - name: '@appium/gulp-plugins'
-      type: npm
-      target: ./packages/gulp-plugins
-      path: ./packages/gulp-plugins
-      options:
-        strategy: node_modules
-    - name: '@appium/support'
-      type: npm
-      target: ./packages/support
-      path: ./packages/support
-      options:
-        strategy: node_modules
-    - name: '@appium/test-support'
-      type: npm
-      target: ./packages/test-support
-      path: ./packages/test-support
-      options:
-        strategy: node_modules

.github/ISSUE_TEMPLATE.md

@@ -28,6 +28,6 @@ If you are reporting a bug, _always_ include Appium logs!
 
 Please remember that with sample code it's easier to reproduce the bug and it's much faster to fix it.
 
-Please git clone https://github.com/appium/appium and from the `examples` directory, use one of your favourite languages and sample apps to reproduce the issue.
+Please git clone https://github.com/appium/appium and from the `sample-code` directory, use one of your favourite languages and sample apps to reproduce the issue.
 
-In case a similar scenario is missing in examples, please submit a PR with one of the sample apps provided.
+In case a similar scenario is missing in sample-code, please submit a PR with one of the sample apps provided.

.github/dependabot.yml

@@ -1,20 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: npm
-  directory: "/sample-code/javascript-webdriverio"
-  schedule:
-    interval: daily
-    time: "11:00"
-  open-pull-requests-limit: 10
-- package-ecosystem: npm
-  directory: "/sample-code/javascript-wd"
-  schedule:
-    interval: daily
-    time: "11:00"
-  open-pull-requests-limit: 10
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "11:00"
-  open-pull-requests-limit: 10

.github/workflows/node.js.yml

@@ -1,47 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: |
-          npm install
-          npm test
-          npm run install-fake-driver
-          npm run e2e-test
-
-  fossa-scan:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Analyze with FOSSA
-        run: |
-          npm install
-          curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install.sh | sudo bash
-          fossa analyze
-    env:
-      FOSSA_API_KEY: ${{secrets.FOSSA_API_KEY}}
-
-  generate_docs:
-    needs: [build]
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - run: |
-          npm install
-          npm run generate-docs

.gitignore

@@ -8,10 +8,10 @@ xcuserdata
 *.sublime-*
 test/functional/_joined
 *.iml
-!examples/java/*.iml
+!sample-code/java/*.iml
 *.autosave
 .idea/
-!examples/java/.idea/
+!sample-code/java/.idea/
 *.log
 *.t
 artifacts
@@ -40,19 +40,16 @@ old
 .tern-project
 coverage
 docs/mkdocs.yml
-examples/javascript-wd/node_modules
-examples/php/vendor
-examples/php/composer.lock
-examples/java/out/
-examples/ruby/Gemfile.lock
-examples/python/test/results/
-examples/python/test/input
-examples/python/.pytest_cache/
-examples/csharp/test/bin
-examples/csharp/test/obj
-examples/csharp/test/bin
-examples/csharp/packages
+sample-code/javascript-wd/node_modules
+sample-code/php/vendor
+sample-code/php/composer.lock
+sample-code/java/out/
+sample-code/ruby/Gemfile.lock
+sample-code/python/test/results/
+sample-code/python/test/input
+sample-code/python/.pytest_cache/
+sample-code/csharp/test/bin
+sample-code/csharp/test/obj
+sample-code/csharp/test/bin
+sample-code/csharp/packages
 appium.zip
-.vscode/settings.json
-.nyc_output
-*.lerna_backup

.mocharc.js

@@ -1,7 +0,0 @@
-// @ts-check
-
-'use strict';
-
-module.exports = {
-  require: require.resolve('./test/setup.js')
-};

.travis.yml

@@ -0,0 +1,30 @@
+language: node_js
+node_js: "10"
+os: linux
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
+      - build-essential
+env:
+  global:
+    - CXX=g++-4.8
+cache:
+  npm: false
+jobs:
+  include:
+    - stage: Tests
+      name: node 10
+      before_script: npm outdated || true
+      script: npm run test && npm run e2e-test
+      after_script: npm run coverage
+    - stage:
+      name: node 12
+      before_script: npm outdated || true
+      script: npm run test && npm run e2e-test
+      node_js: "12"
+    - stage:
+      name: test documentation generation
+      script: npm run generate-docs

.vscode/launch.json

@@ -1,50 +1,46 @@
 {
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "args": [
-        "--require",
-        "@babel/register",
-        "--timeout",
-        "999999",
-        "--colors",
-        "${file}"
-      ],
-      "internalConsoleOptions": "openOnSessionStart",
-      "name": "Test - Current File",
-      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
-      "request": "launch",
-      "skipFiles": ["<node_internals>/**"],
-      "type": "pwa-node"
-    },
-    {
-      "name": "Debug",
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}",
-      "console": "integratedTerminal",
-      "args": ["."]
-    },
-    {
-      "name": "Attach Debug",
-      "type": "node",
-      "request": "attach",
-      "cwd": "${workspaceFolder}",
-      "port": 9229
-    },
-    {
-      "name": "Test All",
-      "type": "node",
-      "request": "launch",
-      "program": "${workspaceFolder}/node_modules/.bin/_mocha",
-      "args": [
-        "--require",
-        "@babel/register",
-        "--timeout",
-        "999999",
-        "--colors",
-        "${workspaceFolder}/packages/appium/test"
-      ]
-    }
-  ]
-}
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "console": "integratedTerminal",
+            "args": [
+                "."
+            ]
+        },
+        {
+            "name": "Attach Debug",
+            "type": "node",
+            "request": "attach",
+            "cwd": "${workspaceFolder}",
+            "port": 9229
+        },
+        {
+            "name": "Test All",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/node_modules/.bin/_mocha",
+            "args": [
+                "--require", "babel-core/register",
+                "--timeout", "999999",
+                "--colors",
+                "${workspaceFolder}/test"
+            ]
+        },
+        {
+            "name": "Test Current File",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/node_modules/.bin/_mocha",
+            "args": [
+                "--require", "babel-core/register",
+                "--timeout", "999999",
+                "--colors",
+                "${file}"
+            ]
+        }
+    ]
+}

.wallaby.js

@@ -1,60 +0,0 @@
-'use strict';
-
-module.exports = (wallaby) => {
-  return {
-    compilers: {
-      '**/*.js': wallaby.compilers.babel(),
-    },
-    debug: true,
-    env: {
-      type: 'node',
-    },
-    files: [
-      './packages/**/*.js',
-      './packages/**/*.json',
-      '!./packages/**/build/**',
-      '!./packages/**/test/**/*-specs.js',
-      '!./packages/*/node_modules/**',
-      '!./packages/*/gulpfile.js',
-      // below this are fixtures
-      {
-        binary: true,
-        pattern: './packages/support/test/assets/sample_binary.plist',
-      },
-      {
-        instrument: false,
-        pattern: './packages/support/test/assets/sample_text.plist',
-      },
-      {
-        instrument: false,
-        pattern: './packages/*/test/**/fixtures/**/*',
-      },
-      {
-        instrument: false,
-        pattern: './packages/base-driver/static/**/*',
-      },
-      {
-        instrument: false,
-        pattern: './packages/gulp-plugins/build/**/*',
-      },
-      {
-        instrument: false,
-        pattern: './test/setup.js'
-      }
-    ],
-    testFramework: 'mocha',
-    tests: [
-      './packages/*/test/**/*-specs.js',
-      '!./packages/*/test/**/*-e2e-specs.js',
-      '!./packages/*/node_modules/**',
-      // this is more of an E2E test and it's tedious to run
-      '!./packages/gulp-plugins/test/transpile-specs.js',
-    ],
-    workers: {
-      restart: true,
-    },
-    setup() {
-      require('./test/setup');
-    }
-  };
-};

CHANGELOG.md

@@ -1,246 +1,3 @@
-CHANGES IN VERSION 1.20.0 (FROM 1.19.1)
-===================================
-
-Appium 1.20.0 is a minor release
-
-### General
-* Does not destory sockets explicitly against a client [appium-base-driver#437](https://github.com/appium/appium-base-driver/pull/437)
-* Connection timeout to each driver respects `--keep-alive-timeout` configuration [appium-base-driver#443](https://github.com/appium/appium-base-driver/pull/443). Default to 10 minutes
-
-### Android General
-* `InvalidContextError` error is thrown if running instrumentation process was dead
-* Fix Android emulator config paths on Windows [appium-adb#558](https://github.com/appium/appium-adb/pull/558)
-
-### Android(UIAutomator2)
-* Appium adds `io.appium.settings`, `io.appium.uiautomator2.server` and `io.appium.uiautomator2.server.test` as the device's Doze whitelist to keep working [appium-uiautomator2-driver#420](https://github.com/appium/appium-uiautomator2-driver/pull/420)
-* Add settings:
-    * `useResourcesForOrientationDetection` to use application resource propertires to determine the current device orientation [appium-uiautomator2-server#389](https://github.com/appium/appium-uiautomator2-server/pull/389)
-
-### Android(Espresso)
-* Appium adds `io.appium.settings` and `io.appium.espressoserver.test` as the device's Doze whitelist to keep working [appium-espresso-driver#627](https://github.com/appium/appium-espresso-driver/pull/627)
-* Add `mobile:` extensions:
-    * `uiautomatorPageSource` returns the page source dump by UIAutomator [appium-espresso-driver#628](https://github.com/appium/appium-espresso-driver/pull/628)
-* Improves XPath lookup performance [appium-espresso-driver#637](https://github.com/appium/appium-espresso-driver/pull/637)
-
-### iOS General
-* Fix updating simulator preference method [appium-ios-simulator#298](https://github.com/appium/appium-ios-simulator/pull/298)
-
-### iOS(XCUITest)
-* Support M1 chip based Mac, Xcode 12.3
-* Snapshots caching logic has been rewritten to improve lookup performance e.g. [WebDriverAgent#404](https://github.com/appium/WebDriverAgent/pull/404), [WebDriverAgent#407](https://github.com/appium/WebDriverAgent/pull/407)
-* Breaking changes
-    * Support over Xcode 10.2, iOS 12.2 (Drop supporting Xcode 10.0 and 10.1)
-    * `accessibility id`, `name` and `id` lookup strategies now find elements by `name`(`wdName`) attributes in page source: [WebDriverAgent#414](https://github.com/appium/WebDriverAgent/pull/414)
-        * Previously, they found elements by `name`(`wdName`) and `value`(`wdValue`)
-        * Please use `predicate` strategy to find `value`(`wdValue`) attribute like [this change](https://github.com/appium/ruby_lib_core/pull/282)
-* Add capabilities:
-    * `resultBundlePath` and `resultBundleVersion` to allow to specify the path to the result bundle of WebDriverAgent xcodebuild [WebDriverAgent#410](https://github.com/appium/WebDriverAgent/pull/410)
-    * `safariIgnoreWebHostnames` to provide a list of hostnames that the Safari automation tools should ignore [appium-xcuitest-driver#1258](https://github.com/appium/appium-xcuitest-driver/pull/
-    1258)
-    * `waitForIdleTimeout` (Please read the below settings section)
-* Add settings: (Please read [Settings API](http://appium.io/docs/en/advanced-concepts/settings/index.html) for more details)
-    * `customSnapshotTimeout` which was renamed from `snapshotTimeout` sets how much time is allowed to resolve a single accessibility snapshot with custom attributes
-    * `waitForIdleTimeout` to customize the time for waiting until the application under test is idling
-        * The value `zero` (not recommended) is equal to `waitForQuiescence` to `false`
-        * **Important**: this is still a workaround, so there is no guarantee it is going to always work. Please consider rather fixing your application source code, because XCTest uses idle intervals to send commands to the accessibility manager. You may get unexpected testing results or application crashes if such intervals don't exist or are too tiny.
-    * `animationCoolOffTimeout` customize the timeout to wait until the application under test has no animation
-* Add a possibility to select elements by indexes [WebDriverAgent#417](https://github.com/appium/WebDriverAgent/pull/417)
-* Fix parsing SSL output from OpenSSL output [appium-xcuitest-driver#1256](https://github.com/appium/appium-xcuitest-driver/pull/1256)
-
-### iOS(Safari)
-
-This driver provides you to communicate with Apple's `safaridriver` binary via Appium.
-It only supports Safari browser automation on macOS and iOS (Simulator/Real Device).
-
-Read https://github.com/appium/appium-safari-driver for more details.
-
-### Mac2
-
-This driver provides you to handle macOS native applications with Apple's `XCTest` framework.
-Read https://github.com/appium/appium-mac2-driver for more details.
-
-### Gecko
-
-This driver provides you to communicate with Firefox browsers on macOS, Windows, Linux and Android with geckodriver binary via Appium.
-Read https://github.com/appium/appium-geckodriver for more details to set the environment up.
-
-CHANGES IN VERSION 1.19.1(FROM 1.19.0)
-===================================
-
-Appium 1.19.1 is a patch release
-
-### iOS(XCUITest)
-
-Patches "missing target for targetId" bug in Safari tests (see [#14867](https://github.com/appium/appium/issues/14867))
-
-CHANGES IN VERSION 1.19.0 (FROM 1.18.3)
-===================================
-
-Appium 1.19.0 is a minor release
-
-### Android General
-
-* Add capabilities:
-  * `allowDelayAdb` to prevent `-delay-adb` command line option to detect emulator startup [#14773](https://github.com/appium/appium/issues/14773)
-* Add `mobile:` functions:
-  * `mobile:getContexts` to get WebView details [appium-android-driver#662](https://github.com/appium/appium-android-driver/pull/662)
-* Accept Web Authentication routes (they are part of W3C) [appium-base-driver#433](https://github.com/appium/appium-base-driver/pull/433)
-* Change to enable `ensureWebviewsHavePages` by default [appium-android-driver#652](https://github.com/appium/appium-android-driver/pull/652)
-* Change to close pending requests on the server side if the server is terminated [appium-base-driver#424](https://github.com/appium/appium-base-driver/pull/424)
-* Fix CPU performance data parsing [appium-android-driver#659](https://github.com/appium/appium-android-driver/pull/659)
-* Fix possible memory leak [appium-base-driver#430](https://github.com/appium/appium-base-driver/pull/430)
-* Fix responses to unexpected server errors [appium-base-driver#432](https://github.com/appium/appium-base-driver/pull/432)
-
-### Android(UIAutomator2)
-
-* Add `mobile:` functions:
-  * `mobile:dragGesture`, `mobile:flingGesture`, `mobile:longClickGesture`, `mobile:pinchCloseGesture`, `mobile:pinchOpenGesture`, `mobile:swipeGesture` and `mobile:scrollGesture`: [Automating Mobile Gestures With UiAutomator2 Backend](https://appium.io/docs/en/writing-running-appium/android/android-mobile-gestures/)
-* Add css selector support [appium-uiautomator2-driver#410](https://github.com/appium/appium-uiautomator2-driver/pull/410)
-  * `css selector` will be converted to `-android uiautomator` selector in UIAutomator2. Read [appium-uiautomator2-driver#410](https://github.com/appium/appium-uiautomator2-driver/pull/410) for more details.
-* Enhance XPath lookup performance [appium-uiautomator2-server#386](https://github.com/appium/appium-uiautomator2-server/pull/386)
-* Fix port guard logic to avoid port conflict [appium-uiautomator2-driver#409](https://github.com/appium/appium-uiautomator2-driver/pull/409)
-
-### Android(Espresso)
-
-* Raise `InvalidContextError` error when the app under test stops because of instrumentation process crashes (appium-espresso-driver#591)[https://github.com/appium/appium-espresso-driver/pull/591]
-* Add a possibility to allow JSON formatted string as `espressoBuildConfig` capability [appium-espresso-driver#609](https://github.com/appium/appium-espresso-driver/pull/609)
-* Add `mobile:` functions:
-  * `mobile:registerIdlingResources`, `mobile:unregisterIdlingResources` and `mobile:listIdlingResources` to customize idling resources [appium-espresso-driver#597](https://github.com/appium/appium-espresso-driver/pull/597)
-* Add a custom exception description, which helps to debug issues when the application under test is not idling long enough [appium-espresso-driver#589](https://github.com/appium/appium-espresso-driver/pull/589)
-* The `com.google.android.material` dependency became optional [appium-espresso-driver#616](https://github.com/appium/appium-espresso-driver/pull/616)
-  * `espressoBuildConfig` now allows to prevent custom dependencies for both categories: `additionalAppDependencies` and `additionalAndroidTestDependencies`. Please check [caps](https://appium.io/docs/en/writing-running-appium/caps/).
-  * `mobile:navigateTo` requires `com.google.android.material`, so please add `"espressoBuildConfig": "{\"additionalAndroidTestDependencies\":[\"com.google.android.material:material:1.2.1\"]}"` as your capabilities if needed
-* Fix to exclude transitive dependencies of espresso-contrib[appium-espresso-driver#596](https://github.com/appium/appium-espresso-driver/pull/596)
-* Fix to be able to build with SDK 29 [appium-espresso-driver#604](https://github.com/appium/appium-espresso-driver/pull/604)
-
-### iOS(general)
-
-* Improve the performane of simulator state state checks [appium-ios-simulator#284](https://github.com/appium/appium-ios-simulator/pull/284)
-* Fix granting access to Calendar on Xcode 11.4 and later [appium-ios-simulator#288](https://github.com/appium/appium-ios-simulator/pull/288)
-* Adjust the decimal separator in the Simulator location setting script according to system locale settings [appium-ios-simulator#295](https://github.com/appium/appium-ios-simulator/pull/295)
-
-### iOS(XCUITest)
-
-* Add capabilities:
-  * `simulatorDevicesSetPath` allows to set an alternative path to a Simulator devices set [appium-ios-simulator#290](https://github.com/appium/appium-ios-simulator/pull/290)
-  * `allowProvisioningDeviceRegistration` adds `-allowProvisioningUpdates` and `-allowProvisioningDeviceRegistration` flag to the list of xcodebuild arguments [appium-xcuitest-driver#1241](https://github.com/appium/appium-xcuitest-driver/pull/1241)
-* Add mobile functions:
-  * `mobile:resetPermission` to reset all previous allowed or denied permissions for the application under test. It requires Xcode 11.4 and later [https://github.com/appium/appium-xcuitest-driver#1239](https://github.com/appium/appium-xcuitest-driver/pull/1239), [WebDriverAgent#392](https://github.com/appium/WebDriverAgent/pull/392)
-* Add `velocity` argument for over Xcode 11.4 in `mobile:swipe` [appium#14793](https://github.com/appium/appium/pull/14793)
-* Enhance performance
-  * e.g. improve taking snapshot to get elements [WebDriverAgent#393](https://github.com/appium/WebDriverAgent/pull/393)
-* Fix alert handling in some cases [WebDriverAgent#400](https://github.com/appium/WebDriverAgent/pull/400)
-
-### Flutter
-
-The version is `0.25`
-
-### You.i Engine Driver
-
-The version is `1.2.7`
-
-
-CHANGES IN VERSION 1.18.2 and 1.18.3 (FROM 1.18.1)
-===================================
-
-Appium 1.18.2 and 1.18.3 are patch releases
-
-* Supports Xcode 12 + iOS 14
-
-### iOS(XCUITest)
-* Allow to input text by send keys API without focus check for newer Xcode versions [WebDriverAgent#379](https://github.com/appium/WebDriverAgent/pull/379)
-* Add supports `xcrun xctrace` instead of `instruments` command for Xcode 12+ [appium-xcuitest-driver#1223](https://github.com/appium/appium-xcuitest-driver/pull/1223)
-
-
-CHANGES IN VERSION 1.18.1 (FROM 1.18.0)
-===================================
-
-Appium 1.18.1 is a patch release
-
-#### Android General
-* Fix to properly clean up forwarded ports if parallel sessions are running [appium-chromedriver#183](https://github.com/appium/appium-chromedriver/pull/183)
-* Fix to avoid a redundant Chromedriver download operation if a matching driver is already present [appium-chromedriver#186](https://github.com/appium/appium-chromedriver/pull/186)
-
-#### Android (UiAutomator2)
-* Fix to return a proper response for missing route [appium/appium-uiautomator2-server#373](https://github.com/appium/appium-uiautomator2-server/pull/373)
-* Fix to allow double values as touch action coordinates [ appium/appium-uiautomator2-server#372](https://github.com/appium/appium-uiautomator2-server/pull/372)
-* Fix [#14586](https://github.com/appium/appium/issues/14586) which might affect XPath locators executed on elemetns, retrieved from nested lookup requests [appium/appium-uiautomator2-server#372](https://github.com/appium/appium-uiautomator2-server/pull/371)
-    * A known issue in 1.18.0
-
-CHANGES IN VERSION 1.18.0 (FROM 1.17.1)
-===================================
-
-Appium 1.18.0 is a minor release
-
-#### General
-* Add `score` attribute for ImageElement [appium-base-driver#396](https://github.com/appium/appium-base-driver/pull/396)
-* Add a route to be able to execute Chrome DevTools commands to downstream drivers [appium-base-driver#405](https://github.com/appium/appium-base-driver/pull/405)
-  * e.g. Clients can send `/session/:sessionId/goog/cdp/execute` command to Chromedriver
-* Fix socket leak by handling connections in a shared pool [appium-base-driver#416](https://github.com/appium/appium-base-driver/pull/416)
-* Fix to encode filenames with UTF-8 while extracting `.ipa` packages [appium-base-driver#419](https://github.com/appium/appium-base-driver/pull/419)
-  * The change fixes `.ipa` packages deployment that contain file names containing non-ASCII characters like [this issue](https://github.com/appium/appium/issues/14100)
-
-#### Android General
-* Add capabilities:
-  * `mockLocationApp` to make location mock configurable [appium-android-driver#632](https://github.com/appium/appium-android-driver/pull/632)
-  * `logcatFormat`, `logcatFilterSpecs` to allow logcat output format customization [appium-adb#528](https://github.com/appium/appium-adb/pull/528)
-  * `ignoreHiddenApiPolicyError` to ignore permission error when hidden api policy change happens [appium-adb#507](https://github.com/appium/appium-adb/pull/507)
-* Add `mobile:` functions:
-  * `mobile: getDeviceTime` to get the device time [appium-android-driver#623](https://github.com/appium/appium-android-driver/pull/623)
-  * `mobile: execEmuConsoleCommand` to send [emulator console commands](https://developer.android.com/studio/run/emulator-console) [appium-android-driver#517](https://github.com/appium/appium-adb/pull/517) [#630](https://github.com/appium/appium-android-driver/pull/630)
-  * `mobile: deleteFile` to delete a file [appium-android-driver#634](https://github.com/appium/appium-android-driver/pull/634)
-  * `mobile: startService` and `mobile: stopService` to start or stop services via [adb shell commands](https://stackoverflow.com/questions/7415997/how-to-start-and-stop-android-service-from-a-adb-shell) [appium-android-driver#647](https://github.com/appium/appium-android-driver/pull/647)
-* Add including native context log for getLog command [appium-android-driver#646](https://github.com/appium/appium-android-driver/pull/646)
-* Fix tapping by element coordinate [appium-android-driver#355](https://github.com/appium/appium-android-driver/pull/355)
-
-#### Android (UiAutomator2)
-* Add capabilities:
-  * `disableSuppressAccessibilityService` to control [FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES]((https://developer.android.com/reference/android/app/UiAutomation#FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES)) flag [appium-uiautomator2-driver#376](https://github.com/appium/appium-uiautomator2-driver/pull/376)
-waitForLaunch
-  * `mjpegServerPort` to customize MJPEG server port [appium-uiautomator2-driver#386](https://github.com/appium/appium-uiautomator2-driver/pull/386)
-* Add `mobile:` functions:
-  * `mobile: sensorSet` to set sensor [appium-uiautomator2-driver#378](https://github.com/appium/appium-uiautomator2-driver/pull/378)
-  * `mobile: scroll` to allow to scroll action in some ways. Please read [appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver/blob/master/lib/commands/general.js) for more details. [appium-uiautomator2-driver#385](https://github.com/appium/appium-uiautomator2-driver/pull/385)
-  * `mobile: deepLink` to send deeplink command with `waitForLaunch` option to handle the wait for logic [appium-uiautomator2-driver#389](https://github.com/appium/appium-uiautomator2-driver/pull/389)
-  * `mobile: viewportRect` to return view port rectangle [appium-uiautomator2-driver#404](https://github.com/appium/appium-uiautomator2-driver/pull/404)
-* Known issue
-  * [#14586](https://github.com/appium/appium/issues/14586): [Root element fix](https://github.com/appium/appium-uiautomator2-server/pull/363) might affect XPath locators executed on elements, retrieved from nested lookup requests (the document root for such elements is now the element itself rather than a fake `hierarchy` root)
-
-#### Android (Espresso)
-* Add capabilities:
-  * `disableSuppressAccessibilityService` to control [FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES]((https://developer.android.com/reference/android/app/UiAutomation#FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES)) flag [appium-espresso-driver#559](https://github.com/appium/appium-espresso-driver/pull/559)
-  * `appLocale` to set [Locale](https://developer.android.com/reference/java/util/Locale) for [the target context](https://developer.android.com/reference/androidx/test/core/app/ApplicationProvider#getApplicationContext()) [appium-espresso-driver#580](https://github.com/appium/appium-espresso-driver/pull/580)
-* Add `mobile:` functions:
-  * `mobile: sensorSet` to set sensor [appium-espresso-driver](https://github.com/appium/appium-espresso-driver/pull/560)
-
-### iOS (XCUITest)
-* Add Xcode 12 beta and iOS 14 support
-* Add settings:
-  * `boundElementsByIndex` for bounding strategy to lookup elements [WebDriverAgent#357](https://github.com/appium/WebDriverAgent/pull/357)
-* Add XCTest `mobile:` functions: [appium-xcuitest-driver#1205](https://github.com/appium/appium-xcuitest-driver/pull/1205). Please read [test code](https://github.com/appium/appium-xcuitest-driver/blob/master/test/functional/device/xctest-e2e-specs.js) as an example.
-  * `mobile: runXCTest` to run XCTest bundle
-  * `mobile: installXCTestBundle` to install the xctest bundle
-  * `mobile: listXCTestBundles` to get list of xctests within bundle
-  * `mobile: listXCTestsInTestBundle` to return the list of XCTest bundles
-* Add audio recording for simulators and real devices [appium-xcuitest-driver#1207](https://github.com/appium/appium-xcuitest-driver/pull/1207)
-  * Read [Audio Capture From iOS Simulators and Real Devices](https://appium.io/docs/en/writing-running-appium/ios/audio-capture/)
-* Add prebuilt WebDriverAgentRunner snapshots to speed up tests execution on iOS Simulator in `appium-webdriveragend` npm package [WebDriverAgent#331](https://github.com/appium/WebDriverAgent/pull/331)
-  * The path is `appium/node_modules/appium-webdriveragend/WebDriverAgentRunner-Runner.app.zip`
-  * The usage is:
-    ```bash
-    idb install /WebDriverAgentRunner-Runner.app --udid <device-udid>
-    idb launch com.facebook.WebDriverAgentRunner.xctrunner
-    ```
-* Fix a memory leak by removing unnecessary dependencies [WebDriverAgent#348](https://github.com/appium/WebDriverAgent/pull/348) [WebDriverAgent#350](https://github.com/appium/WebDriverAgent/pull/350) [WebDriverAgent#351](https://github.com/appium/WebDriverAgent/pull/351)
-* Fix respecting `webDriverAgentUrl` in favor of `wdaLocalPort` and `wdaBaseUrl` for real devices [WebDriverAgent#342](https://github.com/appium/WebDriverAgent/pull/342)
-* Fix ignoring the case where process locking the socket is not alive [WebDriverAgent#339](https://github.com/appium/WebDriverAgent/pull/339)
-* Fix to improve alert buttons detection [WebDriverAgent#322](https://github.com/appium/WebDriverAgent/pull/322)
-
-### Windows
-* Add video recording [appium-windows-driver#66](https://github.com/appium/appium-windows-driver/pull/66)
-* Add findByImage [appium-windows-driver#67](https://github.com/appium/appium-windows-driver/pull/67)
-
-
 CHANGES IN VERSION 1.17.1 (FROM 1.17.0)
 ===================================
 

README.md

@@ -8,8 +8,8 @@
 
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium?ref=badge_shield)
 
-Appium is an open-source, cross-platform test automation tool for native,
-hybrid, and mobile web and desktop apps. We support simulators (iOS), emulators
+Appium is an open source, cross-platform test automation tool for native,
+hybrid and mobile web and desktop apps. We support simulators (iOS), emulators
 (Android), and real devices (iOS, Android, Windows, Mac).
 
 Want to skip straight to the action? Check out our [getting
@@ -35,7 +35,7 @@ specific information about how that driver works and how to set it up:
 ### Why Appium?
 
 1. You don't have to recompile your app or modify it in any way, due
-   to the use of standard automation APIs on all platforms.
+   to use of standard automation APIs on all platforms.
 2. You can write tests with your favorite dev tools using any
    [WebDriver](https://w3c.github.io/webdriver/webdriver-spec.html)-compatible
    language such as Java, Objective-C, JavaScript (Node), PHP, Python, Ruby,
@@ -43,22 +43,22 @@ specific information about how that driver works and how to set it up:
    client libraries](/docs/en/about-appium/appium-clients.md).
 3. You can use any testing framework.
 4. Appium has built-in mobile web and hybrid app support. Within the same
-   script, you can switch seamlessly between native app automation and webview
+   script you can switch seamlessly between native app automation and webview
    automation, all using the WebDriver model that's already the standard for
    web automation.
 
 Investing in the
 [WebDriver](https://w3c.github.io/webdriver/webdriver-spec.html) protocol means
-you are betting on a single, free, and open protocol for testing that has become
+you are betting on a single, free and open protocol for testing that has become
 a web standard. Don't lock yourself into a proprietary stack.
 
 For example, if you use Apple's XCUITest library without Appium you can only
 write tests using Obj-C/Swift, and you can only run tests through Xcode.
-Similarly, with Google's UiAutomator or Espresso, you can only write tests in
+Similarly, with Google's UiAutomator or Espresso you can only write tests in
 Java/Kotlin. Appium opens up the possibility of true cross-platform native app
 automation, for mobile and beyond. Finally!
 
-If you're new to Appium or want a more comprehensive description of what this is all
+If you're new to Appium, or want a more comprehensive description of what this is all
 about, please read our [Introduction to Appium
 Concepts](/docs/en/about-appium/intro.md).
 
@@ -74,7 +74,7 @@ Node.js 10+.
 Check out our [Getting Started](/docs/en/about-appium/getting-started.md) guide
 to get going with Appium.
 
-There is also a sample code that contains [many examples of tests in a variety
+There is also sample code that contains [many examples of tests in a variety
 of different languages](https://github.com/appium/appium/tree/master/sample-code)!
 
 ### Documentation
@@ -92,7 +92,7 @@ Once the PR has been merged, the latest documentation will be in [appium.io](htt
 ### Contributing
 
 Please take a look at our [contribution documentation](CONTRIBUTING.md)
-for instructions on how to build, test, and run Appium from the source.
+for instructions on how to build, test and run Appium from source.
 
 ### Roadmap
 

babel.config.json

@@ -1,37 +0,0 @@
-{
-  "presets": [
-    [
-      "@babel/preset-env",
-      {
-        "targets": {
-          "node": "10"
-        }
-      }
-    ]
-  ],
-  "plugins": [
-    "source-map-support",
-    "@babel/plugin-transform-runtime",
-    "@babel/plugin-syntax-bigint",
-    "@babel/plugin-proposal-nullish-coalescing-operator",
-    "@babel/plugin-proposal-numeric-separator",
-    "@babel/plugin-proposal-optional-chaining",
-    ["@babel/plugin-proposal-private-methods", {"loose": true}],
-    ["@babel/plugin-proposal-class-properties", {"loose": true}],
-    ["@babel/plugin-proposal-private-property-in-object", {"loose": true}]
-  ],
-  "comments": false,
-  "sourceMaps": "both",
-  "env": {
-    "coverage": {
-      "plugins": [
-        [
-          "istanbul",
-          {
-            "exclude": ["test", "build"]
-          }
-        ]
-      ]
-    }
-  }
-}

bin/ios-webkit-debug-proxy-launcher.js

@@ -3,7 +3,7 @@
 /* eslint no-console:0 */
 
 /*
- * Small tool, launching and monitoring ios-web-kit-proxy, and relaunching
+ * Small tool, launching and monitoring ios-web-kit-proxy, and relauching
  * on predefined errors.
  *
  * Usage:

check-npm-pack-files.js

@@ -5,6 +5,7 @@ const res = JSON.parse(childProcess.execSync('npm pack --dry-run --json --ignore
 
 // List of files we are testing to make sure they are included in package
 const testFiles = [
+  'npm-shrinkwrap.json', // Check that npm-shrinkwrap.json is being packed
   'LICENSE', // Check that license is included
   'build/lib/appium.js', // Sanity check that build files are being included by testing just one file
 ];

check-pruned-shrinkwrap.js

@@ -0,0 +1,25 @@
+const _ = require('lodash');
+const { asyncify } = require('asyncbox');
+const { fs, logger } = require('appium-support');
+const path = require('path');
+
+const log = new logger.getLogger('ShrinkwrapValidator');
+
+async function main () {
+  const shrinkwrapPath = path.resolve('npm-shrinkwrap.json');
+  if (!(await fs.exists(shrinkwrapPath))) {
+    log.info('No shrinkwrap found. Skipping shrinkwrap check');
+    return;
+  }
+  const shrinkwrap = JSON.parse(await fs.readFile(shrinkwrapPath));
+  const backupShrinkwrap = JSON.parse(await fs.readFile(path.resolve('npm-shrinkwrap-backup.json')));
+  log.info('Checking that pruned shrinkwrap is a subset of primary shrinkwrap');
+  if (!_.isMatch(backupShrinkwrap, shrinkwrap)) {
+    log.errorAndThrow('Pruned shrinkwrap (shrinkwrap with dev dependencies removed) is not a subset of the original npm-shrinkwrap.json');
+  }
+  log.info('Shrinkwrap check passed');
+}
+
+if (require.main === module) {
+  asyncify(main);
+}

ci-jobs/create-release-branch.yml

@@ -0,0 +1,29 @@
+steps:
+- task: NodeTool@0
+  inputs:
+    versionSpec: '12.x'
+- script: npm install
+  displayName: NPM install
+- script: |
+    git remote add triager https://triager:$GITHUB_TOKEN@github.com/appium/appium
+    git checkout -b $MINOR_BRANCH_NAME
+    git status
+    node ./ci-jobs/scripts/set-package-json-version
+    rm -rf package-lock.json
+    npm shrinkwrap
+    git add .
+    git commit -n -m "Set version to $(MINOR_BRANCH_NAME).0-rc.0"
+    git push -u triager $MINOR_BRANCH_NAME
+  displayName: Create branch
+  env:
+    GITHUB_TOKEN: $(GITHUB_TOKEN)
+    MINOR_BRANCH_NAME: $(MINOR_BRANCH_NAME)
+- script: |
+    git tag $MINOR_BRANCH_NAME.0-rc.0
+    git push --tags -u triager
+    echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
+    npm publish --tag $(node ./ci-jobs/scripts/parse-tag)
+  env:
+    NPM_TOKEN: $(NPM_TOKEN)
+  displayName: Tag and Publish
+

ci-jobs/templates/bundle-template.yml

@@ -12,8 +12,15 @@ jobs:
     - task: NodeTool@0
       inputs:
         versionSpec: '12.x'
-    - script: npm install
+    - script: npm ci || npm install # "npm ci" if shrinkwrap is present
       displayName: Install NPM Dependencies
+    - script: |
+        pushd node_modules/appium-webdriveragent
+        carthage bootstrap --no-use-binaries
+        cp Cartfile.resolved Carthage
+        mkdir -p ./Resources/WebDriverAgent.bundle
+        popd
+      displayName: Fully build XCUITestDriver
     - script: npm run build
       displayName: npm run build
     - script: npm prune --production

commands-yml/commands/context/get-contexts.yml

@@ -8,10 +8,11 @@ description:
     For information on the format of the context names, see the [get context
     documentation](/docs/en/commands/context/get-context.md).
 
-    [mobile command](/docs/en/commands/mobile-command.md) 
-    `mobile: getContexts` is available on iOS (XCUITest) and Android 
-    (UIAutomator2 and Espresso) to get more detailed contexts. 
-    
+    On iOS, using the XCUITest driver, one can use the `mobile: getContexts`
+    [mobile command](/docs/en/commands/mobile-command.md) as an alternative to
+    the standard method in order to get the title and url associated with each
+    context as additional metadata.
+
     For information on contexts, see Appium's [hybrid automation docs](/docs/en/writing-running-appium/web/hybrid.md).
 
 example_usage:

commands-yml/commands/device/app/background-app.yml

@@ -9,7 +9,7 @@ description:
     There are 3 types of parameters which may be passed to this method:
 
 
-    1. An object that looks like `{"seconds": secs}`, where `secs` is an
+    1. An object that looks like `{"timeout": secs}`, where `secs` is an
        integer designating how long, in seconds, to background the app for. -1
        means to deactivate the app entirely.
 

commands-yml/commands/device/clipboard/get-clipboard.yml

@@ -5,16 +5,6 @@ description:
   >
     Get the content of the system clipboard
 
-
-    (For iOS real devices)
-    Apple security preferences require the WebDriverAgentRunner application to be in [foreground](https://github.com/appium/WebDriverAgent/issues/330) in order to be able to receive the system clipboard content. Otherwise an empty string is always returned. Consider using [Activate App](/docs/en/commands/device/app/activate-app.md) and [Background App](/docs/en/commands/device/app/background-app.md) to change the foreground application.
-    Activate App command cannot launch the WebDriverAgent properly on some environments. It depends on XCTest framework by Apple. Then, you should launch the WebDriverAgent using its Springboard's application icon. Follow the example below.
-
-    1. Open springboard, `@driver.activate_app 'com.apple.springboard'`.
-    2. Find the WDA icon with `@driver.find_element :accessibility_id, 'WebDriverAgentRunner-Runner'` (It should be visible on the screen) and click it.
-    3. Call the get clipboard API.
-    4. Open the application under test with the [Activate App](/docs/en/commands/device/app/activate-app.md).
-
 example_usage:
   java:
     |

commands-yml/commands/device/files/push-file.yml

@@ -5,7 +5,7 @@ short_description: Place a file onto the device in a particular place
 example_usage:
   java:
     |
-      driver.pushFile("/data/local/tmp/foo.bar", new File("/Users/johndoe/files/foo.bar"));
+      driver.pushFile("/path/to/device/foo.bar", new File("/Users/johndoe/files/foo.bar"));
   python:
     |
       dest_path = '/data/local/tmp/test_push_file.txt'
@@ -13,23 +13,23 @@ example_usage:
       self.driver.push_file(dest_path, base64.b64encode(data).decode('utf-8'))
   javascript_wd:
     |
-      await driver.pushFileToDevice('/data/local/tmp/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
+      await driver.pushFileToDevice('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
   javascript_wdio:
     |
       let data = new Buffer("Hello World").toString('base64');
       driver.pushFile('/data/local/tmp/file.txt', data);
   ruby:
     |
-      push_file('/data/local/tmp/foo.bar', File.read('path/to/file.png'))
+      push_file('/path/to/device/foo.bar', File.read('path/to/file.png'))
   ruby_core:
     |
-      @driver.push_file('/data/local/tmp/foo.bar', File.read('path/to/file.png'))
+      @driver.push_file('/path/to/device/foo.bar', File.read('path/to/file.png'))
   php:
     |
-      $driver->pushFile('/data/local/tmp/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
+      $driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
   csharp:
     |
-      driver.PushFile("/data/local/tmp/foo.bar", new FileInfo("/Users/johndoe/files/foo.bar"))
+      driver.PushFile("/path/to/device/foo.bar", new FileInfo("/Users/johndoe/files/foo.bar"))
 
 client_docs:
   java: "https://appium.github.io/java-client/io/appium/java_client/android/PushesFiles.html#pushFile-java.lang.String-java.io.File-"