java-client

9.2.2

• [BUG FIX]
  • fix: Fix building of Android key event parameters #2145
  • fix: Fix building of Android geo location parameters #2146

9.2.1

• [REFACTOR]
  • Replace private usages of Guava Collections API with Java Collections API #2136
  • Remove usages of Guava's @VisibleForTesting annotation #2138. Previously opened internal API marked with @VisibleForTesting annotation is private now:
    • io.appium.java_client.internal.filters.AppiumUserAgentFilter#containsAppiumName
    • io.appium.java_client.service.local.AppiumDriverLocalService#parseSlf4jContextFromLogMessage
• [DEPENDENCY CHANGE]
  • Bump minimum supported Selenium version from 4.17.0 to 4.19.0 #2142

9.2.0

• [ENHANCEMENTS]
  • Incorporate poll delay mechanism into AppiumFluentWait #2116 (Closes #2111)
  • Make server startup error messages more useful #2130
• [BUG FIX]
  • Set correct geolocation coordinates of the current device #2109 (Fixes #2108)
  • Always release annotated element reference from the builder instance #2128
  • Cache dynamic proxy classes created by ByteBuddy #2129 (Fixes #2119)
• [DEPENDENCY CHANGE]
  • Bump SLF4J from 2.0.11 to 2.0.12 #2115
• [DOCUMENTATION]
  • Improve release steps #2107

9.1.0

• [ENHANCEMENTS]
  • Introduce better constructor argument validation for the AppiumFieldDecorator class. #2070
  • Add toString to AppiumClientConfig. #2076
  • Perform listeners cleanup periodically. #2077
  • Add non-W3C context, orientation and rotation management endpoints removed from Selenium client. #2093
  • Add non-W3C Location-management endpoints deprecated in Selenium client. #2098
• [BUG FIX]
  • Properly unwrap driver instance if the ContextAware object is deeply nested. #2052
  • Update hashing and iteration logic of page object items. #2067
  • Assign method call listeners directly to the proxy instance. #2102
  • Use JDK 11 to build Jitpack snapshots. #2083
• [DEPRECATION]
  • Deprecate custom functional interfaces. #2055
• [REFACTOR]
  • Use Java 9+ APIs instead of outdated/3rd-party APIs. #2048
  • Migrate to new Selenium API for process management. #2054
• [DEPENDENCY CHANGE]
  • Bump minimum supported Selenium version from 4.14.1 to 4.17.0.
  • Bump SLF4J from 2.0.9 to 2.0.11. #2091, #2099
• [DOCUMENTATION]
  • Describe the release procedure. #2104

9.0.0

• [DOCUMENTATION]
  • Add 8 to 9 migration guide. #2039
• [BREAKING CHANGE] #2036
  • Set minimum Java version to 11.
  • The previously deprecated MobileBy class has been removed. Use AppiumBy instead.
  • The previously deprecated launchApp, resetApp and closeApp methods have been removed. Use extension methods instead.
  • The previously deprecated WindowsBy class and related location strategies have been removed.
  • The previously deprecated ByAll class has been removed in favour of the Selenium one.
  • The previously deprecated AndroidMobileCapabilityType interface has been removed. Use driver options instead
  • The previously deprecated IOSMobileCapabilityType interface has been removed. Use driver options instead
  • The previously deprecated MobileCapabilityType interface has been removed. Use driver options instead
  • The previously deprecated MobileOptions class has been removed. Use driver options instead
  • The previously deprecated YouiEngineCapabilityType interface has been removed. Use driver options instead
  • Removed several misspelled methods. Use properly spelled alternatives instead
  • Removed startActivity method from AndroidDriver. Use 'mobile: startActivity' extension method instead
  • Removed the previously deprecated APPIUM constant from the AutomationName interface
  • Removed the previously deprecated PRE_LAUNCH value from the GeneralServerFlag enum
  • Moved AppiumUserAgentFilter class to io.appium.java_client.internal.filters package
• [REFACTOR]
  • Align Selenium version in test dependencies. #2042
• [DEPENDENCY CHANGE]
  • Removed dependencies to Apache Commons libraries.

8.6.0

• [BUG FIX]
  • Exclude abstract methods from proxy matching. #1937
  • AppiumClientConfig#readTimeout to call super.readTimeout. #1959
  • Use weak references to elements inside of interceptor objects. #1981
  • Correct spelling and semantic mistakes in method naming. #1970
  • Change scope of selenium-support dependency to compile. #2019
  • Fix Code style issues to match Java standards. #2017
  • class of proxy method in AppiumClientConfig. #2026
• [ENHANCEMENTS]
  • Mark Windows page object annotations as deprecated. #1938
  • Deprecate obsolete capabilities constants. #1961
  • patch AutomationName with Chromium. #1993
  • Implementation of Chromium driver plus capabilities. #2003
• [REFACTOR]
  • Increase server start timeout for iOS tests. #1983
  • Fix Android test: --base-path arg must start with /. #1952
  • Added fixes for No service provider found for io.appium.java_client.events.api.Listener. #1975
  • Run tests against latest Selenium release. #1978
  • Use server releases from the main branch for testing. #1994
  • Remove obsolete API calls from tests. #2006
  • Automate more static code checks. #2028
  • Limit the maximum selenium version to 4.14. #2031
  • Remove the obsolete commons-validator dependency. #2032
• [DOCUMENTATION]
  • Add the latest versions of clients to the compatibility matrix. #1935
  • Added correct url path for the latest appium documentation. #1974
  • Add Selenium 4.11.0, 4.12.0, 4.12.1 & 4.13.0 to compatibility matrix. #1986 & #1999 & #2002 & #1986
  • Add known compatibility issue for Selenium 4.12.1. #2008
• [DEPENDENCY UPDATES]
  • org.owasp.dependencycheck was updated to 8.4.0.
  • org.junit.jupiter:junit-jupiter was updated to 5.10.0.
  • commons-io:commons-io was updated to 2.14.0.
  • checkstyle was updated to 10.12.1.
  • org.apache.commons:commons-lang3 was updated to 3.13.0.
  • gradle was updated to 8.4.0.
  • io.github.bonigarcia:webdrivermanager was updated to 5.5.3.
  • org.seleniumhq.selenium:selenium-bom was updated to 4.13.0.
  • org.projectlombok:lombok was updated to 1.18.30.

8.5.1

• [BUG FIX]
  • Use correct exception type for fallback at file/folder pulling. #1912
  • Update autoWebview capability name. #1917
• [REFACTOR]
  • Move execution of E2E tests to GitHub Actions. #1913
  • Replace cglib with bytebuddy. #1923
  • Improve the error message on service startup. #1928
• [DOCUMENTATION]
  • Initiate Selenium client compatibility matrix. #1918
• [DEPENDENCY UPDATES]
  • io.github.bonigarcia:webdrivermanager was updated to 5.3.3.
  • org.projectlombok:lombok was updated to 1.18.28.
  • commons-io:commons-io was updated to 2.12.0.

8.5.0

• [BUG FIX]
  • Restore Jitpack builds. #1911
  • Add fallback commands for file management APIs. #1910
• [REFACTOR]
  • Replace performance data APIs with mobile extensions. #1905
• [DEPENDENCY UPDATES]
  • org.seleniumhq.selenium:selenium-java was updated to 4.9.1.
  • org.junit.jupiter:junit-jupiter was updated to 5.9.3.

8.4.0

• [ENHANCEMENTS]
  • Added possibility to connect to a running session. #1813
  • deprecate tapWithShortPressDuration capability.#1825
  • Add SupportsEnforceAppInstallOption to XCUITestOptions.#1895
• [BUG FIX]
  • Use ipv4 address instead of localhost. #1815
  • Fix test broken by updates in appium-xcuitest-driver. #1839
  • Merge misc tests suite into unit tests suite. #1850
  • Avoid NPE in destroyProcess call. #1878
  • Send arguments for mobile methods depending on the target platform. #1897
• [REFACTOR]
  • Run Gradle wrapper validation only on Gradle files changes. #1828
  • Skip GH Actions build on changes in docs. #1829
  • Remove Checkstyle exclusion of removed Selenium package. #1831
  • Enable Checkstyle checks for test code. #1843
  • Configure CODEOWNERS to automate review requests. #1846
  • Enable execution of unit tests in CI. #1845
  • Add Simple SLF4J binding to unit tests runtime. #1848
  • Improve performance of proxy Interceptor logging. #1849
  • Make unit tests execution a part of Gradle build lifecycle. #1853
  • Replace non-W3C API calls with corresponding extension calls in app management. #1883
  • Switch the time getter to use mobile extensions. #1884
  • Switch file management APIs to use mobile: extensions. #1886
  • Use mobile extensions for app strings getters and keyboard commands. #1890
  • Finish replacing iOS extensions with their mobile alternatives. #1892
  • Change some Android APIs to use mobile extensions. #1893
  • Change backgroundApp command to use the corresponding mobile extension. #1896
  • Switch more Android helpers to use extensions. #1898
  • Perform xcuitest driver prebuild. #1900
  • Finish migrating Android helpers to mobile extensions. #1901
  • Avoid sending unnecessary requests if corresponding extensions are absent. #1903
• [DOCUMENTATION]
  • Describe transitive Selenium dependencies management. #1827
  • Fix build badge to point GH Actions CI. #1844
• [DEPENDENCY UPDATES]
  • org.seleniumhq.selenium:selenium-java was updated to 4.8.2.
  • org.slf4j:slf4j-api was updated to 2.0.7.
  • org.owasp.dependencycheck was updated to 8.2.1.
  • gradle was updated to 8.1.0.
  • com.google.code.gson:gson was updated to 2.10.1.
  • io.github.bonigarcia:webdrivermanager was updated to 5.3.2.
  • org.junit.jupiter:junit-jupiter was updated to 5.9.2.
  • checkstyle was updated to 10.0.
  • jacoco was updated to 0.8.8.
  • org.projectlombok:lombok was updated to 1.18.26.
  • com.github.johnrengelman.shadow was updated to 8.1.1.

8.3.0

• [DOCUMENTATION]
  • Added troubleshooting section. #1808
  • Added CHANGELOG.md. #1810
• [DEPENDENCY UPDATES]
  • org.seleniumhq.selenium:selenium-java was updated to 4.7.0.
  • org.slf4j:slf4j-api was updated to 2.0.5.

• [ENHANCEMENTS]
  • BYACCESSABILITY is deprecated in favor of BYACCESSIBILITY. #1752
  • Connect directly to Appium Hosts in Distributed Environments. #1747
  • use own User Agent. #1779
  • Add alternative proxy implementation. #1790
  • Automated artefact publish to maven central. #1803 & #1807
• [BUG FIX]
  • Enforce usage of Base64 compliant with RFC 4648 for all operations. #1785
  • Override getScreenshotAs to support the legacy base64 encoding. #1787
• [REFRACTOR]
  • BYACCESSABILITY is deprecated in favor of BYACCESSIBILITY. #1752
  • JUnit5 test classes and methods are updated to have default package visibility. #1755
  • Verify if the PR title complies with conventional commits spec. #1757
  • Use Lombok in direct connect class. #1789
  • Update readme and remove obsolete documents. #1792
  • Remove unnecessary annotation. #1791
  • Force unified imports order. #1793
• [DEPENDENCY UPDATES]
  • org.seleniumhq.selenium:selenium-java was updated to 4.5.0.
  • org.owasp.dependencycheck was updated to 7.3.2.
  • io.github.bonigarcia:webdrivermanager was updated to 5.3.1.
  • org.junit.jupiter:junit-jupiter was updated to 5.9.1.
  • org.slf4j:slf4j-api was updated to 2.0.4.
  • com.google.code.gson:gson was updated to 2.10.0.

• [ENHANCEMENTS]
  • AppiumDriverLocalService can handle outputStreams. #1709
  • Add creating a driver with ClientConfig. #1735
• [BUG FIX]
  • Update the environment argument type for mac SupportsEnvironmentOption. #1712
• [REFRACTOR]
  • Deprecate Appium ByAll in favour of Selenium ByAll. #1740
  • Bump Node.js version in pipeline. #1713
  • Switch unit tests to run on Junit 5 Jupiter Platform. #1721
  • Clean up unit tests asserting thrown exceptions. #1741
  • Fix open notification test. #1749
  • update Azure pipeline to use macos-11 VM image. #1728
• [DEPENDENCY UPDATES]
  • org.seleniumhq.selenium:selenium-java was updated to 4.4.0.
  • org.owasp.dependencycheck was updated to 7.1.2.
  • io.github.bonigarcia:webdrivermanager was updated to 5.3.0.
  • gradle was updated to 7.5.1.
  • com.google.code.gson:gson was updated to 2.9.1.

8.1.1

• [BUG FIX]
  • Perform safe typecast while getting the platform name. #1702
  • Add prefix to platformVersion capability name. #1704
• [REFRACTOR]
  • Update e2e tests to make it green. #1706
  • Ignore the test which has a connected server issue. #1699

8.1.0

• [ENHANCEMENTS]
  • Add new EspressoBuildConfig options. #1687
• [DOCUMENTATION]
  • delete all references to removed MobileElement class. #1677
• [BUG FIX]
  • Pass orientation name capability in uppercase. #1686
  • correction for ping method to get proper status URL. #1661
  • Remove deprecated option classes. #1679
  • Remove obsolete event firing decorators. #1676
• [DEPENDENCY UPDATES]
  • org.seleniumhq.selenium:selenium-java was updated to 4.2.0.
  • org.owasp.dependencycheck was updated to 7.1.0.1.
  • org.springframework:spring-context was updated to 5.3.18.
  • org.aspectj:aspectjweaver was updated to 1.9.9.
  • io.github.bonigarcia:webdrivermanager was updated to 5.2.0.
  • org.projectlombok:lombok was updated to 1.18.24.

8.0.0

• [DOCUMENTATION]
  • Set minimum Java version to 1.8.0. #1631
• [BUG FIX]
  • Make interfaces public to fix decorator creation. #1644
  • Do not convert argument names to lowercase. #1627
  • Avoid fallback to css for id and name locator annotations. #1622
  • Fix handling of chinese characters in AppiumDriverLocalService. #1618
• [DEPENDENCY UPDATES]
  • org.owasp.dependencycheck was updated to 7.0.0.
  • org.springframework:spring-context was updated to 5.3.16.
  • actions/setup-java was updated to 3.
  • actions/checkout was updated to 3.
  • io.github.bonigarcia:webdrivermanager was updated to 5.1.0.
  • org.aspectj:aspectjweaver was updated to 1.9.8.
  • org.slf4j:slf4j-api was updated to 1.7.36.
  • com.github.johnrengelman.shadow was updated to 7.1.2.

8.0.0-beta2

• [DOCUMENTATION]
  • Add a link to options builder examples to the migration guide. #1595
• [BUG FIX]
  • Filter out proxyClassLookup method from Proxy class (for Java 16+) in AppiumByBuilder. #1575
• [REFRACTOR]
  • Add more nice functional stuff into page factory helpers. #1584
  • Switch e2e tests to use Appium2. #1603
  • relax constraints of Selenium dependencies versions. #1606
• [DEPENDENCY UPDATES]
  • Upgrade to Selenium 4.1.1. #1613
  • org.owasp.dependencycheck was updated to 6.5.1.
  • org.springframework:spring-context was updated to 5.3.14.
  • actions/setup-java was updated to 2.4.0.
  • gradle was updated to 7.3.

• [ENHANCEMENTS]
  • Start adding UiAutomator2 options. #1543
  • Add more UiAutomator2 options. #1545
  • Finish creating options for UiAutomator2 driver. #1548
  • Add WDA-related XCUITestOptions. #1552
  • Add web view options for XCUITest driver. #1557
  • Add the rest of XCUITest driver options. #1561
  • Add Espresso options. #1563
  • Add Windows driver options. #1564
  • Add Mac2 driver options. #1565
  • Add Gecko driver options. #1573
  • Add Safari driver options. #1576
  • Start adding XCUITest driver options. #1551
  • Implement driver-specific W3C option classes. #1540
  • Update Service to properly work with options. #1550
• [BREAKING CHANGE]
  • Migrate to Selenium 4. #1531
  • Make sure we only write W3C payload into create session command. #1537
  • Use the new session payload creator inherited from Selenium. #1535
  • unify locator factories naming and toString implementations. #1538
  • drop support of deprecated Selendroid driver. #1553
  • switch to javac compiler. #1556
  • revise used Selenium dependencies. #1560
  • change prefix to AppiumBy in locator toString implementation. #1559
  • enable dependencies caching. #1567
  • Include more tests into the pipeline. #1566
  • Tune setting of default platform names. #1570
  • Deprecate custom event listener implementation and default to the one provided by Selenium4. #1541
  • Deprecate touch actions. #1569
  • Deprecate legacy app management helpers. #1571
  • deprecate Windows UIAutomation selector. #1562
  • Remove unused entities. #1572
  • Remove setElementValue helper. #1577
  • Remove selenium package override. #1555
  • remove redundant exclusion of Gradle task signMavenJavaPublication. #1568
• [DEPENDENCY UPDATES]
  • org.owasp.dependencycheck was updated to 6.4.1.
  • com.google.code.gson:gson was updated to 2.8.9.

7.6.0

• [ENHANCEMENTS]
  • Add custom commands dynamically [Appium 2.0]. #1506
  • New General Server flags are added [Appium 2.0]. #1511
  • Add support of extended Android geolocation. #1492
• [BUG FIX]
  • AndroidGeoLocation: update the constructor signature to mimic order of parameters in org.openqa.selenium.html5.Location. #1526
  • Prevent duplicate builds for PRs from base repo branches. #1496
  • Enable Dependabot for GitHub actions. #1500
  • bind mac2element in element map for mac platform. #1474
• [DEPENDENCY UPDATES]
  • org.owasp.dependencycheck was updated to 6.3.2.
  • org.projectlombok:lombok was updated to 1.18.22.
  • com.github.johnrengelman.shadow was updated to 7.1.0.
  • actions/setup-java was updated to 2.3.1.
  • io.github.bonigarcia:webdrivermanager was updated to 5.0.3.
  • org.springframework:spring-context was updated to 5.3.10.
  • org.slf4j:slf4j-api was updated to 1.7.32.
  • com.google.code.gson:gson was updated to 2.8.8.
  • gradle was updated to 7.1.1.
  • commons-io:commons-io was updated to 2.11.0.
  • org.aspectj:aspectjweaver was updated to 1.9.7.
  • org.eclipse.jdt:ecj was updated to 3.26.0.
  • 'junit:junit was updated to 4.13.2.

• [ENHANCEMENTS]
  • Add iOS related annotations to tvOS. #1456
• [BUG FIX]
  • Bring back automatic quote escaping for desired capabilities command-line arguments on windows. #1454
• [DEPENDENCY UPDATES]
  • org.owasp.dependencycheck was updated to 6.1.2.
  • org.eclipse.jdt:ecj was updated to 3.25.0.

• [ENHANCEMENTS]
  • Add support for Appium Mac2Driver. #1439
  • Add support for multiple image occurrences. #1445
  • BOUND_ELEMENTS_BY_INDEX Setting was added. #1418
• [BUG FIX]
  • Use lower case for Windows platform key in ElementMap. #1421
• [DEPENDENCY UPDATES]
  • org.apache.commons:commons-lang3 was updated to 3.12.0.
  • org.springframework:spring-context was updated to 5.3.4.
  • org.owasp.dependencycheck was updated to 6.1.0.
  • io.github.bonigarcia:webdrivermanager was updated to 4.3.1.
  • org.eclipse.jdt:ecj was updated to 3.24.0.
  • org.projectlombok:lombok was updated to 1.18.16.
  • jcenter repository was removed.