Skip to content

feat!: remove deprecated APIs and legacy element handling for core 14 - #736

Open
KazuCocoa wants to merge 21 commits into
masterfrom
feat/remove-implicit-configuration
Open

KazuCocoa wants to merge 21 commits into
masterfrom
feat/remove-implicit-configuration

Conversation

@KazuCocoa

@KazuCocoa KazuCocoa commented Nov 15, 2026 •

Copy link
Copy Markdown
Member

Remove deprecated client APIs and legacy JSONWP/MJSONWP element handling for core 14 and Appium 4. Supersedes #674 while preserving @aguspe's original commits, with current master merged in.

  • Remove Appium.symbolize_keys, appium_lib[:wait], default_wait, and set_implicit_wait_by_default. Session creation no longer sets implicit timeouts; explicit Selenium timeout configuration remains supported.
  • Remove deprecated Element#location_rel; document element.rect and explicit relative-center calculation.
  • Remove the take_element_screenshot compatibility alias; use save_element_screenshot.
  • Simplify Bridge#action to keyword arguments (async:, devices:).
  • Accept only W3C element references. Reject legacy-only responses when constructing elements, and keep ordinary script hashes containing ELEMENT as data. Preserve noncompact W3C cached attributes and shadow-root handling.
  • Change wait helpers to retry only NoSuchElementError by default. Other exceptions propagate unless explicitly configured with ignored:; connection refusal still propagates immediately. Document the migration and cover exception identity, retry behavior, aliases, timeout messages, and success conditions.
  • Exclude both element ID keys from cached attributes while accepting only W3C references. Migrate Android element lookups to implicit waits and state assertions to driver.wait_true conditions; restore the keyboard IME and close the notification shade in cleanup.
  • Keep Capabilities#convert_key, with regression coverage for nested Chrome preference keys containing underscores.
  • Keep driver-supported IME and other endpoints that Appium 4 still exposes, along with W3C get_timeouts.
  • Update migration notes, RBS definitions, fixtures, and screenshot tests. Show Selenium implicit-timeout configuration in README and migration examples. Configure a 20-second implicit wait in Android W3C action tests and remove their core.wait wrappers, retaining a 3-second timeout for the negative lookup assertion.

CI coverage

  • Add Ruby 3.4 on Linux and Windows, plus Ruby 4.0 on Windows.
  • Add an allowed-to-fail Linux ruby-head job for early compatibility feedback.
  • Keep Ruby 3.1 on Ubuntu 24.04 because Ubuntu 26.04 does not provide it.
  • Set Windows driver-selection environment variables in the current PowerShell process so each test mode is actually selected.

Major release and downstream coordination

Use this PR's feat!: title when squash-merging so Release Please prepares 14.0.0. Version, date, manifest, and generated release entries belong in the release PR. The detailed migration guide is recorded in CHANGELOG.md with an unreleased notice, separate from versioned release headings.

ruby_lib currently requires core < 14.0. Before relaxing that constraint, a separate compatibility change must adapt Appium.symbolize_keys, core.default_wait, wait helpers, and the removed screenshot alias. This also affects console/Capybara users through ruby_lib.

Validation

  • Ruby 3.4.9 / Selenium 4.52.0: 223 unit tests, 1,214 assertions passed after the wait exception change.
  • Selenium 4.21.0: 215 unit tests, 1,139 assertions passed before the wait exception change. The minimum Selenium dependency remains unchanged.
  • RuboCop: 129 files, no offenses. Steep: no type errors.
  • Gem build and shared release validation passed after correcting the migration heading so the validator reads the latest versioned release entry.
  • Simulator/device tests were updated but not run locally.

BREAKING CHANGE: Remove deprecated key normalization, automatic implicit-wait configuration, location_rel, the take_element_screenshot alias, the bridge action positional argument, and legacy ELEMENT reference handling. Wait helpers now retry only NoSuchElementError by default. See the CHANGELOG migration guide for replacements; the README links to it with a short summary.

@KazuCocoa KazuCocoa changed the title feat!: remove symbolize_keys and implicit wait configuration feat!: remove deprecated APIs and legacy element handling for core 14 Nov 15, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants