appium_lib_core 8.0.2 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e57b152d3c94c2b86f65520b00899c2f9c5bd0231a8496c9f0726849601e93
-  data.tar.gz: ec392fd1c14218a5306489c05c3364dcd15a6a5f1191e2a42589698429fb9e8c
+  metadata.gz: 8679d6bb72c4130e216ac363eaed0c49f13b6d8818db2cba0b44c8f5b9dcef7b
+  data.tar.gz: d226eeb911201d9afd12117bb73871afa95e4b0d7f3844f2df2e4efdb45563ed
 SHA512:
-  metadata.gz: d4525eac2deb92a9356842d1fa9d518029d8166df50dbc628661e3637ed3f1c0527bfdb7c302a6f2d3fc32c39eee2ca2ca405fd72b572e7413bb91ee0ec66b2b
-  data.tar.gz: 645d56159c0a8f444511ef25e6ef7d1ead6a428360928adc3219fc2c3e105d6d1fd6dbf204841a107657eecc64c6cfee0dd4326851771fc9eb73b1bc9f79c80b
+  metadata.gz: 5ad279ca22ef8f33ad8634fbfcaffaac1f6b16a8904a90f45a39427ed060c444fec5e1130589cac30fd35cdff74df0626e9768e9f1a819f49db678ab6044d2d3
+  data.tar.gz: 2f6c31b0718f6155db25a647832d68d370c4dee839fe962f5b99bc6f4d082bdc0d96fdde807f5e89192f814815e998752ab9f2fb772f0a01d823425c7b90ad09

data/CHANGELOG.md

@@ -10,6 +10,21 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [9.1.0] - 2024-05-18
+
+### Enhancements
+- Require Selenium 4.21.0+
+- Simplify internal code with Selenium 4.21.0. Now it requires selenium webdriver v4.21.0.
+
+## [9.0.0] - 2024-05-14
+
+### Deprecations
+- Stop converting snake cases to camel case for symbols in capabilities
+    - Please define camel/snake cases in capabilities as-is for the WebDriver capabilities
+- Stop implicit symbolizing capabilities
+    - Historically ruby_lib/ruby_lib_core symbolized capabilities keys from string internally.
+    - `Appium.symbolize_keys` to build symbolized capabilities if issues occurred by this change.
+
 ## [8.0.2] - 2024-04-26
 
 ### Enhancements

data/appium_lib_core.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.2'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.21'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
 
   spec.add_development_dependency 'rake', '~> 13.0'
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.23.0'
-  spec.add_development_dependency 'rubocop', '1.63.3'
+  spec.add_development_dependency 'rubocop', '1.63.5'
   spec.add_development_dependency 'appium_thor', '~> 2.0'
   spec.add_development_dependency 'parallel_tests'
   spec.add_development_dependency 'simplecov'

data/lib/appium_lib_core/common/base/bridge.rb

@@ -15,6 +15,12 @@
 module Appium
   module Core
     class Base
+      class LocatorConverter
+        def convert(how, what)
+          [how, what]
+        end
+      end # LocatorConverter
+
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
         include Device::DeviceLock
         include Device::Keyboard
@@ -31,6 +37,8 @@ module Appium
         include Device::ExecuteDriver
         include Device::Orientation
 
+        Bridge.locator_converter = LocatorConverter.new
+
         # Prefix for extra capability defined by W3C
         APPIUM_PREFIX = 'appium:'
 
@@ -153,6 +161,18 @@ module Appium
         public
 
         # command for Appium 2.0.
+
+        # Example:
+        #   driver.add_command(name: :available_contexts, method: :get, url: 'session/:session_id/contexts') do
+        #     execute(:available_contexts, {}) || []
+        #   end
+        # Then,
+        #   driver.available_contexts #=> ["NATIVE_APP"]
+
+        # def add_command(method:, url:, name:, &block)
+        #   Bridge.add_command name, method, url, &block
+        # end
+
         def add_command(method:, url:, name:, &block)
           ::Appium::Logger.info "Overriding the method '#{name}' for '#{url}'" if @available_commands.key? name
 
@@ -162,7 +182,7 @@ module Appium
         end
 
         def commands(command)
-          @available_commands[command]
+          @available_commands[command] || Bridge.extra_commands[command]
         end
 
         def status
@@ -216,52 +236,8 @@ module Appium
         end
 
         # For Appium
-        # override
-        def active_element
-          ::Appium::Core::Element.new self, element_id_from(execute(:get_active_element))
-        end
         alias switch_to_active_element active_element
 
-        # For Appium
-        # override
-        def find_element_by(how, what, parent_ref = [])
-          how, what = convert_locator(how, what)
-
-          return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
-
-          parent_type, parent_id = parent_ref
-          id = case parent_type
-               when :element
-                 execute :find_child_element, { id: parent_id }, { using: how, value: what.to_s }
-               when :shadow_root
-                 execute :find_shadow_child_element, { id: parent_id }, { using: how, value: what.to_s }
-               else
-                 execute :find_element, {}, { using: how, value: what.to_s }
-               end
-
-          ::Appium::Core::Element.new self, element_id_from(id)
-        end
-
-        # For Appium
-        # override
-        def find_elements_by(how, what, parent_ref = [])
-          how, what = convert_locator(how, what)
-
-          return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
-
-          parent_type, parent_id = parent_ref
-          ids = case parent_type
-                when :element
-                  execute :find_child_elements, { id: parent_id }, { using: how, value: what.to_s }
-                when :shadow_root
-                  execute :find_shadow_child_elements, { id: parent_id }, { using: how, value: what.to_s }
-                else
-                  execute :find_elements, {}, { using: how, value: what.to_s }
-                end
-
-          ids.map { |id| ::Appium::Core::Element.new self, element_id_from(id) }
-        end
-
         # For Appium
         # @param [Hash] id The id which can get as a response from server
         # @return [::Appium::Core::Element]
@@ -370,36 +346,6 @@ module Appium
             arg
           end
         end
-
-        def element_id_from(id)
-          id['ELEMENT'] || id['element-6066-11e4-a52e-4f735466cecf']
-        end
-
-        # Don't convert locators for Appium in native context
-        def convert_locator(how, what)
-          # case how
-          # when 'class name'
-          #   how = 'css selector'
-          #   what = ".#{escape_css(what)}"
-          # when 'id'
-          #   how = 'css selector'
-          #   what = "##{escape_css(what)}"
-          # when 'name'
-          #   how = 'css selector'
-          #   what = "*[name='#{escape_css(what)}']"
-          # when 'tag name'
-          #   how = 'css selector'
-          # end
-          #
-          # if what.is_a?(Hash)
-          #   what = what.each_with_object({}) do |(h, w), hash|
-          #     h, w = convert_locator(h.to_s, w)
-          #     hash[h] = w
-          #   end
-          # end
-
-          [how, what]
-        end
       end # class Bridge
     end # class Base
   end # module Core

data/lib/appium_lib_core/common/base/capabilities.rb

@@ -23,6 +23,20 @@ module Appium
         # Appium's capabilities could change by depending on Appium versions. So it does not have
         # standard options like chrome and firefox etc. So, the implementation should differ from
         # other browsers. But here should inherit `Options` to follow Selenium.
+
+        # Method override
+        # FIXME: when we drop "symbolize_keys", this can be removed.
+        def convert_key(key)
+          case key
+          when String
+            key.to_s
+          when Symbol
+            # here do not convert to camel case
+            key.to_s
+          else
+            raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
+          end
+        end
       end
     end
   end

data/lib/appium_lib_core/common/base/driver.rb

@@ -32,7 +32,6 @@ module Appium
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
         include ::Appium::Core::Base::Rotatable
-        include ::Appium::Core::Base::SearchContext
         include ::Appium::Core::Base::TakesScreenshot
         include ::Appium::Core::Base::HasRemoteStatus
         include ::Appium::Core::Base::HasLocation
@@ -40,6 +39,8 @@ module Appium
 
         include ::Appium::Core::Waitable
 
+        ::Selenium::WebDriver::SearchContext.extra_finders = APPIUM_EXTRA_FINDERS
+
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
         attr_reader :bridge
@@ -57,6 +58,7 @@ module Appium
           @bidi = nil
 
           # in the selenium webdriver as well
+          ::Selenium::WebDriver::Remote::Bridge.element_class = ::Appium::Core::Element
           bridge ||= create_bridge(**opts)
           add_extensions(bridge.browser)
           @bridge = listener ? ::Appium::Support::EventFiringBridge.new(bridge, listener, **original_opts) : bridge
@@ -1023,8 +1025,8 @@ module Appium
         #     ele = @driver.convert_to_element(response) #=> ::Appium::Core::Element
         #     ele.rect #=> Can get the rect of the element
         #
-        def convert_to_element(id)
-          @bridge.convert_to_element id
+        def convert_to_element(response_id)
+          @bridge.convert_to_element response_id
         end
       end # class Driver
     end # class Base

data/lib/appium_lib_core/common/base/http_default.rb

@@ -31,6 +31,9 @@ module Appium
         class Default < ::Selenium::WebDriver::Remote::Http::Default
           attr_reader :additional_headers
 
+          ::Selenium::WebDriver::Remote::Http::Common.user_agent = \
+            "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common.user_agent})"
+
           # override
           def initialize(open_timeout: nil, read_timeout: nil)
             @open_timeout = open_timeout
@@ -39,6 +42,17 @@ module Appium
             super
           end
 
+          def set_additional_header(key, value)
+            @additional_headers[key] = value
+            ::Selenium::WebDriver::Remote::Http::Common.extra_headers = @additional_headers
+          end
+
+          def delete_additional_header(key)
+            @additional_headers.delete key
+            ::Selenium::WebDriver::Remote::Http::Common.extra_headers = @additional_headers
+            @common_headers.delete key if defined? @common_headers
+          end
+
           # Update <code>server_url</code> provided when ruby_lib _core created a default http client.
           # Set <code>@http</code> as nil to re-create http client for the <code>server_url</code>
           #
@@ -59,13 +73,6 @@ module Appium
             @server_url = URI.parse "#{scheme}://#{host}:#{port}#{path}"
           end
 
-          def request(verb, url, headers, payload, redirects = 0)
-            headers['User-Agent'] = "appium/ruby_lib_core/#{VERSION} (#{headers['User-Agent']})"
-            headers = headers.merge @additional_headers unless @additional_headers.empty?
-
-            super(verb, url, headers, payload, redirects)
-          end
-
           private
 
           def validate_url_param(scheme, host, port, path)

data/lib/appium_lib_core/common/base/search_context.rb

@@ -12,172 +12,102 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module Appium
-  module Core
-    class Base
-      module SearchContext
-        # referenced: ::Selenium::WebDriver::SearchContext
-
-        FINDERS = ::Selenium::WebDriver::SearchContext::FINDERS.merge(
-          accessibility_id:     'accessibility id',
-          image:                '-image',
-          custom:               '-custom',
-          # Android
-          uiautomator:          '-android uiautomator', # Unavailable in Espresso
-          viewtag:              '-android viewtag',     # Available in Espresso
-          data_matcher:         '-android datamatcher', # Available in Espresso
-          view_matcher:         '-android viewmatcher', # Available in Espresso
-          # iOS
-          predicate:            '-ios predicate string',
-          class_chain:          '-ios class chain'
-        )
-
-        # rubocop:disable Layout/LineLength
-        #
-        # Find the first element matching the given arguments
-        #
-        # - Android can find with uiautomator like a {http://developer.android.com/tools/help/uiautomator/UiSelector.html UISelector}.
-        # - iOS can find with a {https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930 UIAutomation command}.
-        # - iOS, only for XCUITest(WebDriverAgent), can find with a {https://github.com/facebook/WebDriverAgent/wiki/Queries class chain}
-        #
-        # == Find with image
-        # Return an element if current view has a partial image. The logic depends on template matching by OpenCV.
-        # {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
-        #
-        # You can handle settings for the comparision following {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 here}
-        #
-        # == Espresso viewmatcher and datamatcher
-        # Espresso has {https://developer.android.com/training/testing/espresso/basics _onView_ matcher}
-        # and {https://medium.com/androiddevelopers/adapterviews-and-espresso-f4172aa853cf _onData_ matcher} for more reference
-        # that allows you to target adapters instead of Views. This method find methods based on reflections
-        #
-        # This is a selector strategy that allows users to pass a selector of the form:
-        #
-        # <code>{ name: '<name>', args: ['arg1', 'arg2', '...'], class: '<optional class>' }</code>
-        #
-        # - _name_: The name of a method to invoke. The method must return
-        # a Hamcrest {http://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/Matcher.html Matcher}
-        # - _args_: The args provided to the method
-        # - _class_: The class name that the method is part of (defaults to <code>org.hamcrest.Matchers</code>).
-        # Can be fully qualified, or simple, and simple defaults to <code>androidx.test.espresso.matcher</code> package
-        # (e.g.: <code>class=CursorMatchers</code> fully qualified is <code>class=androidx.test.espresso.matcher.CursorMatchers</code>
-        #
-        # See example how to send viewmatcher and datamatcher in Ruby client
-        #
-        #
-        # @overload find_element(how, what)
-        #   @param [Symbol, String] how The method to find the element by
-        #   @param [String] what The locator to use
-        #
-        # @overload find_element(opts)
-        #   @param [Hash] opts Find options
-        #   @option opts [Symbol] :how Key named after the method to find the element by, containing the locator
-        # @return [Element]
-        # @raise [Error::NoSuchElementError] if the element doesn't exist
-        #
-        # @example Find element with each keys
-        #
-        #     # with accessibility id. All platforms.
-        #     @driver.find_elements :accessibility_id, 'Animation'
-        #     @driver.find_elements :accessibility_id, 'Animation'
-        #
-        #     # with base64 encoded template image. All platforms.
-        #     @driver.find_elements :image, Base64.strict_encode64(File.read(file_path))
-        #
-        #     # For Android
-        #     ## With uiautomator
-        #     @driver.find_elements :uiautomator, 'new UiSelector().clickable(true)'
-        #     ## With viewtag, but only for Espresso
-        #     ## 'setTag'/'getTag' in https://developer.android.com/reference/android/view/View
-        #     @driver.find_elements :viewtag, 'new UiSelector().clickable(true)'
-        #     # With data_matcher. The argument should be JSON format.
-        #     @driver.find_elements :data_matcher, { name: 'hasEntry', args: %w(title Animation) }.to_json
-        #
-        #     # For iOS
-        #     ## With :predicate
-        #     @driver.find_elements :predicate, "isWDVisible == 1"
-        #     @driver.find_elements :predicate, 'wdName == "Buttons"'
-        #     @driver.find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
-        #
-        #     ## With Class Chain
-        #     ### select the third child button of the first child window element
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
-        #     ### select all the children windows
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow'
-        #     ### select the second last child of the second child window
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
-        #     ### matching predicate. <code>'</code> is the mark.
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow['visible = 1]['name = "bla"']'
-        #     ### containing predicate. '$' is the mark.
-        #     ### Require appium-xcuitest-driver 2.54.0+. PR: https://github.com/facebook/WebDriverAgent/pull/707/files
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[$name = \"bla$$$bla\"$]'
-        #     e = find_element :class_chain, "**/XCUIElementTypeWindow[$name == 'Buttons'$]"
-        #     e.tag_name #=> "XCUIElementTypeWindow"
-        #     e = find_element :class_chain, "**/XCUIElementTypeStaticText[$name == 'Buttons'$]"
-        #     e.tag_name #=> "XCUIElementTypeStaticText"
-        #
-        # rubocop:enable Layout/LineLength
-        def find_element(*args)
-          how, what = extract_args(args)
-          by = _set_by_from_finders(how)
-          begin
-            bridge.find_element_by by, what.to_s, ref
-          rescue Selenium::WebDriver::Error::TimeoutError
-            raise Selenium::WebDriver::Error::NoSuchElementError
-          end
-        end
-
-        #
-        # Find all elements matching the given arguments
-        #
-        # @return [Array<Selenium::WebDriver::Element>]
-        #
-        # @see SearchContext#find_elements
-        #
-        def find_elements(*args)
-          how, what = extract_args(args)
-          by = _set_by_from_finders(how)
-          begin
-            bridge.find_elements_by by, what.to_s, ref
-          rescue Selenium::WebDriver::Error::TimeoutError
-            []
-          end
-        end
-
-        private
-
-        def _set_by_from_finders(how)
-          by = FINDERS[how.to_sym]
-          unless by
-            raise ::Appium::Core::Error::ArgumentError,
-                  "cannot find element by #{how.inspect}. Available finders are #{FINDERS.keys}."
-          end
-
-          by
-        end
-
-        def extract_args(args)
-          case args.size
-          when 2
-            args
-          when 1
-            arg = args.first
-
-            unless arg.respond_to?(:shift)
-              raise ::Appium::Core::Error::ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift"
-            end
-
-            # this will be a single-entry hash, so use #shift over #first or #[]
-            arr = arg.dup.shift
-
-            raise ::Appium::Core::Error::ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
+# rubocop:disable Layout/LineLength
+#
+# Find the first element matching the given arguments
+#
+# - Android can find with uiautomator like a {http://developer.android.com/tools/help/uiautomator/UiSelector.html UISelector}.
+# - iOS can find with a {https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930 UIAutomation command}.
+# - iOS, only for XCUITest(WebDriverAgent), can find with a {https://github.com/facebook/WebDriverAgent/wiki/Queries class chain}
+#
+# == Find with image
+# Return an element if current view has a partial image. The logic depends on template matching by OpenCV.
+# {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
+#
+# You can handle settings for the comparision following {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 here}
+#
+# == Espresso viewmatcher and datamatcher
+# Espresso has {https://developer.android.com/training/testing/espresso/basics _onView_ matcher}
+# and {https://medium.com/androiddevelopers/adapterviews-and-espresso-f4172aa853cf _onData_ matcher} for more reference
+# that allows you to target adapters instead of Views. This method find methods based on reflections
+#
+# This is a selector strategy that allows users to pass a selector of the form:
+#
+# <code>{ name: '<name>', args: ['arg1', 'arg2', '...'], class: '<optional class>' }</code>
+#
+# - _name_: The name of a method to invoke. The method must return
+# a Hamcrest {http://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/Matcher.html Matcher}
+# - _args_: The args provided to the method
+# - _class_: The class name that the method is part of (defaults to <code>org.hamcrest.Matchers</code>).
+# Can be fully qualified, or simple, and simple defaults to <code>androidx.test.espresso.matcher</code> package
+# (e.g.: <code>class=CursorMatchers</code> fully qualified is <code>class=androidx.test.espresso.matcher.CursorMatchers</code>
+#
+# See example how to send viewmatcher and datamatcher in Ruby client
+#
+#
+# @overload find_element(how, what)
+#   @param [Symbol, String] how The method to find the element by
+#   @param [String] what The locator to use
+#
+# @overload find_element(opts)
+#   @param [Hash] opts Find options
+#   @option opts [Symbol] :how Key named after the method to find the element by, containing the locator
+# @return [Element]
+# @raise [Error::NoSuchElementError] if the element doesn't exist
+#
+# @example Find element with each keys
+#
+#     # with accessibility id. All platforms.
+#     @driver.find_elements :accessibility_id, 'Animation'
+#     @driver.find_elements :accessibility_id, 'Animation'
+#
+#     # with base64 encoded template image. All platforms.
+#     @driver.find_elements :image, Base64.strict_encode64(File.read(file_path))
+#
+#     # For Android
+#     ## With uiautomator
+#     @driver.find_elements :uiautomator, 'new UiSelector().clickable(true)'
+#     ## With viewtag, but only for Espresso
+#     ## 'setTag'/'getTag' in https://developer.android.com/reference/android/view/View
+#     @driver.find_elements :viewtag, 'new UiSelector().clickable(true)'
+#     # With data_matcher. The argument should be JSON format.
+#     @driver.find_elements :data_matcher, { name: 'hasEntry', args: %w(title Animation) }.to_json
+#
+#     # For iOS
+#     ## With :predicate
+#     @driver.find_elements :predicate, "isWDVisible == 1"
+#     @driver.find_elements :predicate, 'wdName == "Buttons"'
+#     @driver.find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
+#
+#     ## With Class Chain
+#     ### select the third child button of the first child window element
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
+#     ### select all the children windows
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow'
+#     ### select the second last child of the second child window
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
+#     ### matching predicate. <code>'</code> is the mark.
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow['visible = 1]['name = "bla"']'
+#     ### containing predicate. '$' is the mark.
+#     ### Require appium-xcuitest-driver 2.54.0+. PR: https://github.com/facebook/WebDriverAgent/pull/707/files
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[$name = \"bla$$$bla\"$]'
+#     e = find_element :class_chain, "**/XCUIElementTypeWindow[$name == 'Buttons'$]"
+#     e.tag_name #=> "XCUIElementTypeWindow"
+#     e = find_element :class_chain, "**/XCUIElementTypeStaticText[$name == 'Buttons'$]"
+#     e.tag_name #=> "XCUIElementTypeStaticText"
+#
+# rubocop:enable Layout/LineLength
 
-            arr
-          else
-            raise ::Appium::Core::Error::ArgumentError, "wrong number of arguments (#{args.size} for 2)"
-          end
-        end
-      end # module SearchContext
-    end # class Base
-  end # module Core
-end # module Appium
+APPIUM_EXTRA_FINDERS = {
+  accessibility_id:     'accessibility id',
+  image:                '-image',
+  custom:               '-custom',
+  # Android
+  uiautomator:          '-android uiautomator', # Unavailable in Espresso
+  viewtag:              '-android viewtag',     # Available in Espresso
+  data_matcher:         '-android datamatcher', # Available in Espresso
+  view_matcher:         '-android viewmatcher', # Available in Espresso
+  # iOS
+  predicate:            '-ios predicate string',
+  class_chain:          '-ios class chain'
+}.freeze

data/lib/appium_lib_core/driver.rb

@@ -338,12 +338,6 @@ module Appium
       def setup_for_new_session(opts = {})
         @custom_url = opts.delete :url # to set the custom url as :url
 
-        # TODO: Remove when we implement Options
-        # The symbolize_keys is to keep compatiility for the legacy code, which allows capabilities to give 'string' as the key.
-        # The toplevel `caps`, `capabilities` and `appium_lib` are expected to be symbol.
-        # FIXME: First, please try to remove `nested: true` to `nested: false`.
-        opts = Appium.symbolize_keys(opts, nested: true)
-
         @caps = get_caps(opts)
 
         set_appium_lib_specific_values(get_appium_lib_opts(opts))
@@ -408,7 +402,7 @@ module Appium
 
         if @enable_idempotency_header
           if @http_client.instance_variable_defined? :@additional_headers
-            @http_client.additional_headers[Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]] = SecureRandom.uuid
+            @http_client.set_additional_header Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency], SecureRandom.uuid
           else
             ::Appium::Logger.warn 'No additional_headers attribute in this http client instance'
           end
@@ -432,7 +426,7 @@ module Appium
 
         if @http_client.instance_variable_defined? :@additional_headers
           # We only need the key for a new session request. Should remove it for other following commands.
-          @http_client.additional_headers.delete Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]
+          @http_client.delete_additional_header Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]
         end
 
         # TODO: this method can be removed after releasing Appium 2.0, and after a while
@@ -635,22 +629,27 @@ module Appium
         opts[:appium_lib] || {}
       end
 
+      # @private
+      def get_app
+        @caps[:app] || @caps['app']
+      end
+
       # @private
       # Path to the .apk, .app or .app.zip.
       # The path can be local, HTTP/S, Windows Share and other path like 'sauce-storage:'.
       # Use @caps[:app] without modifications if the path isn't HTTP/S or local path.
       def set_app_path
         # FIXME: maybe `:app` should check `app` as well.
-        return unless @caps && @caps[:app] && !@caps[:app].empty?
-        return if @caps[:app] =~ URI::DEFAULT_PARSER.make_regexp
-
-        app_path = File.expand_path(@caps[:app])
-        @caps[:app] = if File.exist? app_path
-                        app_path
-                      else
-                        ::Appium::Logger.warn("Use #{@caps[:app]} directly since #{app_path} does not exist.")
-                        @caps[:app]
-                      end
+        return unless @caps && get_app && !get_app.empty?
+        return if get_app =~ URI::DEFAULT_PARSER.make_regexp
+
+        app_path = File.expand_path(get_app)
+        @caps['app'] = if File.exist? app_path
+                         app_path
+                       else
+                         ::Appium::Logger.warn("Use #{get_app} directly since #{app_path} does not exist.")
+                         get_app
+                       end
       end
 
       # @private
@@ -676,7 +675,6 @@ module Appium
       # @private
       def set_appium_device
         # https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile
-        # TODO: check if the Appium.symbolize_keys(opts, nested: false) enoug with this
         @device = @caps[:platformName] || @caps['platformName']
         return @device unless @device
 
@@ -685,7 +683,6 @@ module Appium
 
       # @private
       def set_automation_name
-        # TODO: check if the Appium.symbolize_keys(opts, nested: false) enoug with this
         candidate = @caps[:automationName] || @caps['automationName']
         @automation_name = candidate if candidate
         @automation_name = convert_downcase @automation_name if @automation_name

data/lib/appium_lib_core/element.rb

@@ -17,9 +17,10 @@ module Appium
     # Implement useful features for element.
     # Patch for Selenium Webdriver.
     class Element < ::Selenium::WebDriver::Element
-      include ::Appium::Core::Base::SearchContext
       include ::Appium::Core::Base::TakesScreenshot
 
+      ::Selenium::WebDriver::SearchContext.extra_finders = APPIUM_EXTRA_FINDERS
+
       # Retuns the element id.
       #
       # @return [String]

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '8.0.2' unless defined? ::Appium::Core::VERSION
-    DATE    = '2024-04-26' unless defined? ::Appium::Core::DATE
+    VERSION = '9.1.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2024-05-18' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -22,15 +22,17 @@ require_relative 'appium_lib_core/element'
 require_relative 'appium_lib_core/support/event_firing_bridge'
 
 module Appium
-  # @private
-  #
   # convert the top level keys to symbols.
   #
   # @param [Hash] hash Hash value to make symbolise
+  #
+  # @example
+  # opts = Appium.symbolize_keys(opts)
+  #
   def self.symbolize_keys(hash, nested: false, enable_deprecation_msg: true)
     # FIXME: As https://github.com/appium/ruby_lib/issues/945, we must remove this implicit string to symbol.
     # But appium_lib_core's some capability handling expect to be symbol, so we should test to remove
-    # the mehotds which expect the symbol first.
+    # the methods which expect the symbol first.
     raise ::Appium::Core::Error::ArgumentError, 'symbolize_keys requires a hash' unless hash.is_a? Hash
 
     hash.each_with_object({}) do |pair, acc|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 9.1.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.21'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.63.3
+        version: 1.63.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.63.3
+        version: 1.63.5
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement