Note to make less diff between selenium Ruby binding and this lib

[KazuCocoa]

• Appium binding specific
  • directConnect

    • ruby_lib_core/lib/appium_lib_core/driver.rb

      Line 70 in 4621549

      # DirectConnections has capabilities of directConnect

    • https://appiumpro.com/editions/86-connecting-directly-to-appium-hosts-in-distributed-environments
  • Add x-idempotency-key header in a new session request to prevent calling duplicated new session commands in Appium
    • Because generally, Appium new session requests could take a long time. Clients could do retry
    • feat: Add requests idempotency verification on the server side appium-base-driver#400
  • Appium specific commands
    • https://github.com/appium/ruby_lib_core/blob/master/lib/appium_lib_core/common/command.rb#L178
  • add_command

    • ruby_lib_core/lib/appium_lib_core/common/base/bridge.rb

      Line 161 in 4621549

      def add_command(method:, url:, name:, &block)

    • Appium plugins/drivers could have their own route, so we should allow users to add appending them
  • converting locators to CSS stuff. Appium needs non-w3c standard locators yet
    • https://github.com/appium/ruby_lib_core/blob/master/lib/appium_lib_core/common/base/bridge.rb#L388-L410
  • convert_to_element

    • ruby_lib_core/test/functional/ios/driver_test.rb

      Line 174 in 7721eec

      ele = @@driver.convert_to_element(r.result.first)

    • Appium provides a feature to run multiple webdriverio commands on Appium to reduce the number of communication between the client and Appium. It has a use case to get the element (id). Then, Ruby client needed to handle element class from the element id.
• Ruby binding specific
  • @core stuff, they may be able to remove since most of them are now just calling @driver.xxxx

[KazuCocoa]

Only Python client defines shortcut actions such as https://github.com/appium/python-client/blob/677c1a2121053a0435f3e0d8f7798077a41aa067/appium/webdriver/extensions/action_helpers.py#L132, but not in Ruby and other ones.
Action builders can provide such high-level action shortcuts for users.

[p0deje]

From the Selenium side, the following changes are needed:

1. HTTPClient:
   a. There should be a way to pass extra HTTP headers to the new session.
   b. There should be a way to change the default User-Agent.
2. Bridge:
   a. There should be a way to update the bridge so that it can point to a new URL.
   b. There should be a way to add a new command that is a bridge request and extra methods to implement more on top of that.
   c. There should be a way to alter locator conversion.
   d. There should be a way to unwrap elements from the executeScript response. It seems like it should already work, but needs to be double-checked.
3. Driver:
   a. There should be a way to define methods on Driver which simply delegate to Bridge.
   b. There should be a way to define different defaults for action builder (touch instead of mouse, smaller duration). Or there should be a way to completely redefine action builder implementations.
4. Capabilities:
   a. There should be a way to process capabilities before creating a new session.
5. SearchContext:
   a. There should be a way to register extra finders (e.g. accessibility_id).