Merge branch 'master' into update-gradle9

Author: valfirst

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
     strategy:
       matrix:
         include:
-        - java: 11
+        - java: 17
           # Need to use specific (not `-latest`) version of macOS to be sure the required version of Xcode/simulator is available
           platform: macos-14
           e2e-tests: ios
@@ -59,7 +59,7 @@ jobs:
 
     name: JDK ${{ matrix.java }} - ${{ matrix.platform }} ${{ matrix.e2e-tests }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Enable KVM group perms
       if: matrix.e2e-tests == 'android' || matrix.e2e-tests == 'flutter-android'
@@ -69,7 +69,7 @@ jobs:
         sudo udevadm trigger --name-match=kvm
 
     - name: Set up JDK ${{ matrix.java }}
-      uses: actions/setup-java@v4
+      uses: actions/setup-java@v5
       with:
         distribution: 'zulu'
         java-version: ${{ matrix.java }}
@@ -107,7 +107,7 @@ jobs:
 
     - name: Install Node.js
       if: ${{ matrix.e2e-tests }}
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v5
       with:
         node-version: 'lts/*'
 

.github/workflows/publish.yml

@@ -6,9 +6,9 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Java
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           java-version: '11'
           distribution: 'zulu'

CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+_10.0.0_
+- **[DOCUMENTATION]**
+  - Document the migration guide from v9 to v10 [#2331](https://github.com/appium/java-client/pull/2331) 
+  - updated maven central release badge [#2316](https://github.com/appium/java-client/pull/2316)
+  - updated CI badge to use ci.yml workflow [#2317](https://github.com/appium/java-client/pull/2317)
+- **[BREAKING CHANGE]** [#2327](https://github.com/appium/java-client/pull/2327)
+  - Removed all deprecated methods with Selenium's Location and LocationContext (these classes have been removed in Selenium 4.35.0)
+- **[ENHANCEMENTS]**
+  - Proxy commands issues via RemoteWebElement [#2311](https://github.com/appium/java-client/pull/2311)
+  - Automated Release to Maven Central Repository using JReleaser [#2313](https://github.com/appium/java-client/pull/2313)
+- **[BUG FIX]**
+  - Possible NPE in initBiDi() [#2325](https://github.com/appium/java-client/pull/2325)
+- **[DEPENDENCY CHANGE]**
+  - Bump minimum Selenium version to 4.35.0 [#2327](https://github.com/appium/java-client/pull/2327)
+  - Bump org.junit.jupiter:junit-jupiter from 5.13.2 to 5.13.3 [#2314](https://github.com/appium/java-client/pull/2314)
+  - Bump io.github.bonigarcia:webdrivermanager [#2322](https://github.com/appium/java-client/pull/2322)
+  - Bump com.gradleup.shadow from 8.3.7 to 8.3.8 [#2315](https://github.com/appium/java-client/pull/2315)
+  - Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 [#2320](https://github.com/appium/java-client/pull/2320)
+
 _9.5.0_
 - **[ENHANCEMENTS]**
   - Allow extension capability keys to contain dot characters  [#2271](https://github.com/appium/java-client/pull/2271)
@@ -667,14 +686,14 @@ _8.6.0_
 
 *6.0.0-BETA1*
 - **[ENHANCEMENT]** **[REFACTOR]** **[BREAKING CHANGE]** **[MAJOR CHANGE]** Improvements of the TouchActions API [#756](https://github.com/appium/java-client/pull/756), [#760](https://github.com/appium/java-client/pull/760):
-    - `io.appium.java_client.touch.ActionOptions` and sublasses were added
+    - `io.appium.java_client.touch.ActionOptions` and subclasses were added
     - old methods of the `TouchActions` were marked `@Deprecated`
     - new methods which take new options.
-- **[ENHANCEMENT]**. Appium drivr local service uses default process environment by default. [#753](https://github.com/appium/java-client/pull/753)
+- **[ENHANCEMENT]**. Appium driver local service uses default process environment by default. [#753](https://github.com/appium/java-client/pull/753)
 - **[BUG FIX]**. Removed 'set' prefix from waitForIdleTimeout setting. [#754](https://github.com/appium/java-client/pull/754)
 - **[BUG FIX]**. The asking for session details was optimized. Issue report [764](https://github.com/appium/java-client/issues/764).
   FIX [#769](https://github.com/appium/java-client/pull/769)
-- **[BUG FIX]** **[REFACTOR]**. Inconcistent MissingParameterException was removed. Improvements of MultiTouchAction. Report: [#102](https://github.com/appium/java-client/issues/102). FIX [#772](https://github.com/appium/java-client/pull/772)
+- **[BUG FIX]** **[REFACTOR]**. Inconsistent MissingParameterException was removed. Improvements of MultiTouchAction. Report: [#102](https://github.com/appium/java-client/issues/102). FIX [#772](https://github.com/appium/java-client/pull/772)
 - **[DEPENDENCY UPDATES]**
     - `org.apache.commons:commons-lang3` was updated to 3.7
     - `commons-io:commons-io` was updated to 2.6

README.md

@@ -6,6 +6,11 @@
 
 This is the Java language bindings for writing Appium Tests that conform to [WebDriver Protocol](https://w3c.github.io/webdriver/)
 
+
+## v9 to v10 Migration
+
+Follow the [v9 to v10 Migration Guide](./docs/v9-to-v10-migration-guide.md) to streamline the migration process.
+
 ## v8 to v9 Migration
 
 Since v9 the client only supports Java 11 and above.
@@ -95,6 +100,7 @@ dependencies {
 ### Compatibility Matrix
  Appium Java Client                                                                                 | Selenium client
 ----------------------------------------------------------------------------------------------------|-----------------------------
+`10.0.0`                                                                                            | `4.35.0`
 `9.5.0`                                                                                             | `4.34.0`
 `9.4.0`                                                                                             | `4.26.0`, `4.27.0`, `4.28.0`, `4.28.1`, `4.29.0`, `4.30.0`, `4.31.0`, `4.32.0`, `4.33.0`
  `9.2.1`(known issues: appium/java-client#2145, appium/java-client#2146), `9.2.2`, `9.2.3`, `9.3.0` | `4.19.0`, `4.19.1`, `4.20.0`, `4.21.0`, `4.22.0`, `4.23.0`, `4.23.1`, `4.24.0`, `4.25.0`, `4.26.0`, `4.27.0`

build.gradle

@@ -7,9 +7,9 @@ plugins {
     id 'maven-publish'
     id 'jacoco'
     id 'signing'
-    id 'org.owasp.dependencycheck' version '12.1.3'
-    id 'com.gradleup.shadow' version '8.3.8'
-    id 'org.jreleaser' version '1.19.0'
+    id 'org.owasp.dependencycheck' version '12.1.6'
+    id 'com.gradleup.shadow' version '9.2.2'
+    id 'org.jreleaser' version '1.20.0'
 }
 
 ext {
@@ -42,8 +42,8 @@ java {
 }
 
 dependencies {
-    compileOnly 'org.projectlombok:lombok:1.18.38'
-    annotationProcessor 'org.projectlombok:lombok:1.18.38'
+    compileOnly 'org.projectlombok:lombok:1.18.42'
+    annotationProcessor 'org.projectlombok:lombok:1.18.42'
 
     if (project.hasProperty("isCI")) {
         api "org.seleniumhq.selenium:selenium-api:${seleniumVersion}"
@@ -69,7 +69,7 @@ dependencies {
             }
         }
     }
-    implementation 'com.google.code.gson:gson:2.13.1'
+    implementation 'com.google.code.gson:gson:2.13.2'
     implementation "org.slf4j:slf4j-api:${slf4jVersion}"
     implementation 'org.jspecify:jspecify:1.0.0'
 }
@@ -222,7 +222,7 @@ testing {
         test {
             dependencies {
                 implementation "org.seleniumhq.selenium:selenium-chrome-driver:${seleniumVersion}"
-                implementation('io.github.bonigarcia:webdrivermanager:6.2.0') {
+                implementation('io.github.bonigarcia:webdrivermanager:6.3.2') {
                     exclude group: 'org.seleniumhq.selenium'
                 }
             }
@@ -266,7 +266,7 @@ testing {
             dependencies {
                 implementation project()
                 implementation(sourceSets.test.output)
-                implementation('io.github.bonigarcia:webdrivermanager:6.2.0') {
+                implementation('io.github.bonigarcia:webdrivermanager:6.3.2') {
                     exclude group: 'org.seleniumhq.selenium'
                 }
             }

docs/Advanced-By.md

@@ -48,7 +48,7 @@ XCUIElementTypeCell[$label == 'here'$]
 #### Handling Quote Marks
 
 Most of the time, you can treat pairs of single quotes or double quotes
-interchangably. If you're searching with a string that contains quote marks,
+interchangeably. If you're searching with a string that contains quote marks,
 though, you [need to be careful](https://stackoverflow.com/q/14116217).
 
 ```c

docs/How-to-report-an-issue.md

@@ -1,6 +1,6 @@
 # Be sure that it is not a server-side problem if you are facing something that looks like a bug
 
-The Appium Java client is the thin client which just sends requests and receives responces generally. 
+The Appium Java client is the thin client which just sends requests and receives responses generally.
 Be sure that this bug is not reported [here](https://github.com/appium/appium/issues) and/or there is
 no progress on this issue.
 
@@ -13,8 +13,8 @@ If it is the feature request then there should be the description of this featur
 
 ### Environment (bug report)
 
-* java client build version or git revision if you use some shapshot:
-* Appium server version or git revision if you use some shapshot:
+* java client build version or git revision if you use some snapshot:
+* Appium server version or git revision if you use some snapshot:
 * Desktop OS/version used to run Appium if necessary:
 * Node.js version (unless using Appium.app|exe) or Appium CLI or Appium.app|exe:
 * Mobile platform/version under test:
@@ -32,7 +32,7 @@ You can git clone https://github.com/appium/appium/tree/master/sample-code or ht
 Also you can create a [gist](https://gist.github.com) with pasted java code sample or paste it at ussue description using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and 
 [Writing on GitHub](https://help.github.com/categories/writing-on-github/)
 
-### Ecxeption stacktraces (bug report)
+### Exception stacktraces (bug report)
 
 There should be created a [gist](https://gist.github.com) with pasted stacktrace of exception thrown by java.
 

docs/Page-objects.md

@@ -16,7 +16,7 @@ WebElement someElement;
 List<WebElement> someElements;
 ```
 
-# If there is need to use convinient locators for mobile native applications then the following is available:
+# If there is need to use convenient locators for mobile native applications then the following is available:
 
 ```java
 import io.appium.java_client.android.AndroidElement;
@@ -324,13 +324,13 @@ A typical page object could look like:
 
 ```java
 public class RottenTomatoesScreen {
-    //convinient locator  
+    //convenient locator  
     private List<AndroidElement> titles;
 
-    //convinient locator  
+    //convenient locator  
     private List<AndroidElement> scores;
 
-    //convinient locator  
+    //convenient locator  
     private List<AndroidElement> castings;
     //element declaration goes on 
 
@@ -371,13 +371,13 @@ public class Movie extends Widget{
         super(element);
    }
 
-   //convinient locator  
+   //convenient locator  
    private AndroidElement title;
 
-   //convinient locator  
+   //convenient locator  
    private AndroidElement score;
 
-   //convinient locator  
+   //convenient locator  
    private AndroidElement casting;
 
    public String getTitle(params){
@@ -404,7 +404,7 @@ So, now page object looks
 ```java
 public class RottenTomatoesScreen {
 
-     @AndroidFindBy(a locator which convinient to find a single movie-root - element)
+     @AndroidFindBy(a locator which convenient to find a single movie-root - element)
      private List<Movie> movies;
 
       //element declaration goes on 
@@ -427,7 +427,7 @@ public class RottenTomatoesScreen {
 Then
 ```java
 //the class is annotated !!!
-@AndroidFindBy(a locator which convinient to find a single movie-root - element)
+@AndroidFindBy(a locator which convenient to find a single movie-root - element)
 public class Movie extends Widget{
 ...
 }
@@ -658,7 +658,7 @@ This use case has some restrictions;
 
 - All classes which are declared by the OverrideWidget annotation should be subclasses of the class declared by field
 
-- All classes which are declared by the OverrideWidget should not be abstract. If a declared class is overriden partially like 
+- All classes which are declared by the OverrideWidget should not be abstract. If a declared class is overridden partially like 
 
 ```java
   //above is the other field declaration

docs/environment.md

@@ -32,4 +32,4 @@ Remember to reload the config after it has been changed by restarting the comman
 Also, it is possible to set variables on [per-process](https://stackoverflow.com/questions/10856129/setting-an-environment-variable-before-a-command-in-bash-not-working-for-second) basis. 
 This might be handy if Appium is set up to start automatically with the operating system, because on early stages of system initialization it is possible that the "usual" environment has not been loaded yet.
 
-In case the Appium process is started programatically, for example with java client's `AppiumDriverLocalService` helper class, then it might be necessary to setup the environment [in the client code](https://github.com/appium/java-client/pull/753), because prior to version 6.0 the client does not inherit it from the parent process by default.
+In case the Appium process is started programmatically, for example with java client's `AppiumDriverLocalService` helper class, then it might be necessary to setup the environment [in the client code](https://github.com/appium/java-client/pull/753), because prior to version 6.0 the client does not inherit it from the parent process by default.

docs/v9-to-v10-migration-guide.md

@@ -0,0 +1,17 @@
+This is the list of main changes between major versions 9 and 10 of Appium 
+java client. This list should help you to successfully migrate your 
+existing automated tests codebase.
+
+
+## The minimum supported Selenium version is set to 4.35.0
+
+- Selenium versions below 4.35.0 won't work with Appium java client 10+.
+Check the [Compatibility Matrix](../README.md#compatibility-matrix) for more
+details about versions compatibility.
+
+## Removed previously deprecated items
+
+- `org.openqa.selenium.remote.html5.RemoteLocationContext`, `org.openqa.selenium.html5.Location` and 
+  `org.openqa.selenium.html5.LocationContext` imports have been removed since they don't exist
+  in Selenium lib anymore. Use appropriate replacements from this library instead for APIs and 
+  interfaces that were using deprecated classes, like `io.appium.java_client.Location`.