appium_lib_core 5.4.0 → 5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d218a7a8a40159dbd710c8aec292346297a92b98f7026456fd7a29c5794f2914
-  data.tar.gz: 9606b1256c653c693ed17b344cec7fe2adaf58e8f5f95c9be3f0b9b3811cd79c
+  metadata.gz: 36c3e5d802524fd73d0bd2f3f4c383dc8ca315b5fab8d91126aa38360023513e
+  data.tar.gz: 3133b9cacbc2ccb65d44be5abc2ead266e70b84603a37d33f4697d71e5a28320
 SHA512:
-  metadata.gz: 9cf6fda7cec0c09f3b83e0bd786d3a914a8d24c1f1f6f355570c83f9ae1b33c486608370d6a4c5b5cd2aeab73df802509dce93d6de46efcf12cd8a86e3d9c6f9
-  data.tar.gz: 4f57441793ffeb9b40d9f6cc5d1456e836b05cd166775d2ec3c2319767daf36e44f66b498b69fa3b4f5f3e304718fd5a32fa717b732983294ed8713d0950c33a
+  metadata.gz: 606343375d1a70d5b0d3f6c8b3a01d5bb4cb3b7668bfe622bae0ba3d35ca57997c1dd1b081934cade812a74bce250fa8fd0d3328d98dd94da451a34677021ef3
+  data.tar.gz: 7315f007b57556ba24d615aea8fc48d05808a89f6cb408b400a560e5ea032827b732b20c15f3682e36abe48f3d30fcfd6896368e21a479e1adecf73b30459cc3

data/CHANGELOG.md

@@ -10,6 +10,21 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [5.5.1] - 2022-10-10
+
+### Bug fixes
+- Keep converting String to Symbol for `capabilities`, `caps` and `appium_lib` for the backward compatibility
+- Wrong `automationName` and `platformName` detection in this library before starting a session
+
+### Deprecations
+- Converting `capabilities`, `caps` and `appium_lib` from String to Symbol
+    - They are expected to be Symbol. Nothing affects existing users who already give the above keys as Symbol for `Appium::Core.for`.
+
+## [5.5.0] - 2022-10-09
+
+### Bug fixes
+- Removed forcefully converting keys of capabilities into symbol, which caused unexpected capabilities format issue [ruby_lib/945](https://github.com/appium/ruby_lib/issues/945)
+
 ## [5.4.0] - 2022-10-01
 
 ### Enhancements

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

@@ -53,8 +53,8 @@ module Appium
         # Override
         # Creates session handling.
         #
-        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
-        # @return [::Selenium::WebDriver::Remote::Capabilities]
+        # @param [::Appium::Core::Base::Capabilities, Hash] capabilities A capability
+        # @return [::Appium::Core::Base::Capabilities]
         #
         # @example
         #
@@ -89,10 +89,10 @@ module Appium
         # Append +appium:+ prefix for Appium following W3C spec
         # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
         #
-        # @param [::Selenium::WebDriver::Remote::Capabilities, Hash] capabilities A capability
-        # @return [::Selenium::WebDriver::Remote::Capabilities]
+        # @param [::Appium::Core::Base::Capabilities, Hash] capabilities A capability
+        # @return [::Appium::Core::Base::Capabilities]
         def add_appium_prefix(capabilities)
-          w3c_capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
+          w3c_capabilities = ::Appium::Core::Base::Capabilities.new
 
           capabilities = capabilities.send(:capabilities) unless capabilities.is_a?(Hash)
 
@@ -111,12 +111,12 @@ module Appium
 
         private
 
-        def camel_case(str)
-          str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+        def camel_case(str_or_sym)
+          str_or_sym.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
         end
 
         def extension_prefix?(capability_name)
-          snake_cased_capability_names = ::Selenium::WebDriver::Remote::Capabilities::KNOWN.map(&:to_s)
+          snake_cased_capability_names = ::Appium::Core::Base::Capabilities::KNOWN.map(&:to_s)
           camel_cased_capability_names = snake_cased_capability_names.map { |v| camel_case(v) }
 
           # Check 'EXTENSION_CAPABILITY_PATTERN'
@@ -126,7 +126,7 @@ module Appium
         end
 
         def json_create(value)
-          ::Selenium::WebDriver::Remote::Capabilities.json_create(value)
+          ::Appium::Core::Base::Capabilities.json_create(value)
         end
 
         public
@@ -182,7 +182,7 @@ module Appium
 
         # Port from MJSONWP
         def session_capabilities
-          ::Selenium::WebDriver::Remote::Capabilities.json_create execute(:get_capabilities)
+          ::Appium::Core::Base::Capabilities.json_create execute(:get_capabilities)
         end
 
         # Override for safe. Newer ruby selenium webdriver already has the same code
@@ -345,6 +345,9 @@ module Appium
             element_id = element_id_from(arg)
             return ::Appium::Core::Element.new(self, element_id) if element_id
 
+            shadow_root_id = shadow_root_id_from(arg)
+            return ::Selenium::WebDriver::Remote::ShadowRoot.new self, shadow_root_id if shadow_root_id
+
             arg.each { |k, v| arg[k] = unwrap_script_result(v) }
           else
             arg

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

@@ -15,22 +15,14 @@
 module Appium
   module Core
     class Base
-      module Capabilities
-        # @private
-        # @param [Hash] opts_caps Capabilities for Appium server. All capability keys are converted to lowerCamelCase when
-        #                         this client sends capabilities to Appium server as JSON format.
-        # @return [::Selenium::WebDriver::Remote::Capabilities] Return instance of Appium::Core::Base::Capabilities
-        #                         inherited ::Selenium::WebDriver::Remote::Capabilities
-        def self.create_capabilities(opts_caps = {})
-          # TODO: Move to 'Options' way instead of 'Capabilities'.
-          # Selenium 5 will have Options instead of 'Capabilities'.
-          # https://github.com/SeleniumHQ/selenium/blob/trunk/rb/lib/selenium/webdriver/common/options.rb
-          # Then, Ruby client also shoud move to the Options way.
-          # 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.
-          ::Selenium::WebDriver::Remote::Capabilities.new(opts_caps)
-        end
+      class Capabilities < ::Selenium::WebDriver::Remote::Capabilities
+        # TODO: Move to 'Options' way instead of 'Capabilities'.
+        # Selenium 5 will have Options instead of 'Capabilities'.
+        # https://github.com/SeleniumHQ/selenium/blob/trunk/rb/lib/selenium/webdriver/common/options.rb
+        # Then, Ruby client also shoud move to the Options way.
+        # 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.
       end
     end
   end

data/lib/appium_lib_core/common/error.rb

@@ -17,10 +17,6 @@ module Appium
     module Error
       class CoreError < StandardError; end
 
-      # Capability related errors
-      class NoCapabilityError < CoreError; end
-      class CapabilityStructureError < CoreError; end
-
       # Appium related errors
       class NotSupportedAppiumServer < CoreError; end
       class NoSuchElementError < CoreError; end

data/lib/appium_lib_core/driver.rb

@@ -293,8 +293,11 @@ module Appium
         @delegate_target = self # for testing purpose
         @automation_name = nil # initialise before 'set_automation_name'
 
-        opts = Appium.symbolize_keys opts
-        validate_keys(opts)
+        # 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)
 
         @custom_url = opts.delete :url
         @caps = get_caps(opts)
@@ -371,7 +374,7 @@ module Appium
         begin
           @driver = ::Appium::Core::Base::Driver.new(listener: @listener,
                                                      http_client: @http_client,
-                                                     capabilities: @caps, # ::Selenium::WebDriver::Remote::Capabilities
+                                                     capabilities: @caps, # ::Appium::Core::Base::Capabilities
                                                      url: @custom_url,
                                                      wait_timeout: @wait_timeout,
                                                      wait_interval: @wait_interval,
@@ -489,14 +492,24 @@ module Appium
 
       private
 
+      def convert_to_symbol(value)
+        if value.nil?
+          value
+        else
+          value.to_sym
+        end
+      end
+
       # @private
       def extend_for(device:, automation_name:) # rubocop:disable Metrics/CyclomaticComplexity
         extend Appium::Core
         extend Appium::Core::Device
 
-        case device
+        sym_automation_name = convert_to_symbol(automation_name)
+
+        case convert_to_symbol(device)
         when :android
-          case automation_name
+          case sym_automation_name
           when :espresso
             ::Appium::Core::Android::Espresso::Bridge.for self
           when :uiautomator2
@@ -507,7 +520,7 @@ module Appium
             ::Appium::Core::Android::Uiautomator1::Bridge.for self
           end
         when :ios, :tvos
-          case automation_name
+          case sym_automation_name
           when :safari
             ::Appium::Logger.debug('SafariDriver for iOS')
           when :xcuitest
@@ -516,7 +529,7 @@ module Appium
             ::Appium::Core::Ios::Uiautomation::Bridge.for self
           end
         when :mac
-          case automation_name
+          case sym_automation_name
           when :safari
             ::Appium::Logger.debug('SafariDriver for macOS')
           when :gecko
@@ -528,7 +541,7 @@ module Appium
             ::Appium::Logger.debug('macOS Native')
           end
         when :windows
-          case automation_name
+          case sym_automation_name
           when :gecko
             ::Appium::Logger.debug('Gecko Driver for Windows')
           else
@@ -538,7 +551,7 @@ module Appium
           # https://github.com/Samsung/appium-tizen-driver
           ::Appium::Logger.debug('tizen')
         else
-          case automation_name
+          case sym_automation_name
           when :youiengine
             # https://github.com/YOU-i-Labs/appium-youiengine-driver
             ::Appium::Logger.debug('YouiEngine')
@@ -555,32 +568,9 @@ module Appium
         self
       end
 
-      # @private
-      def validate_keys(opts)
-        flatten_ops = flatten_hash_keys(opts)
-
-        raise Error::NoCapabilityError unless opts.member?(:caps) || opts.member?(:capabilities)
-
-        if !opts.member?(:appium_lib) && flatten_ops.member?(:appium_lib)
-          raise Error::CapabilityStructureError, 'Please check the value of appium_lib in the capability'
-        end
-
-        true
-      end
-
-      # @private
-      def flatten_hash_keys(hash, flatten_keys_result = [])
-        hash.each do |key, value|
-          flatten_keys_result << key
-          flatten_hash_keys(value, flatten_keys_result) if value.is_a?(Hash)
-        end
-
-        flatten_keys_result
-      end
-
       # @private
       def get_caps(opts)
-        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:capabilities] || {})
+        Core::Base::Capabilities.new(opts[:caps] || opts[:capabilities] || {})
       end
 
       # @private
@@ -593,6 +583,7 @@ module Appium
       # 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
 
@@ -631,7 +622,8 @@ module Appium
       # @private
       def set_appium_device
         # https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile
-        @device = @caps[:platformName]
+        # TODO: check if the Appium.symbolize_keys(opts, nested: false) enoug with this
+        @device = @caps[:platformName] || @caps['platformName']
         return @device unless @device
 
         @device = @device.is_a?(Symbol) ? @device.downcase : @device.downcase.strip.intern
@@ -639,7 +631,9 @@ module Appium
 
       # @private
       def set_automation_name
-        @automation_name = @caps[:automationName] if @caps[:automationName]
+        # 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 = if @automation_name
                              @automation_name.is_a?(Symbol) ? @automation_name.downcase : @automation_name.downcase.strip.intern
                            end

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '5.4.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2022-10-01' unless defined? ::Appium::Core::DATE
+    VERSION = '5.5.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2022-10-10' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -21,16 +21,25 @@ require_relative 'appium_lib_core/device'
 require_relative 'appium_lib_core/element'
 
 module Appium
-  # convert all keys (including nested) to symbols
+  # @private
+  #
+  # convert the top level keys to symbols.
   #
-  # based on deep_symbolize_keys & deep_transform_keys from rails
-  # https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84
   # @param [Hash] hash Hash value to make symbolise
-  def self.symbolize_keys(hash)
+  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.
     raise ::Appium::Core::Error::ArgumentError, 'symbolize_keys requires a hash' unless hash.is_a? Hash
 
     hash.each_with_object({}) do |pair, acc|
       key = begin
+        if enable_deprecation_msg && !(pair[0].is_a? Symbol)
+          ::Appium::Logger.warn("[Deprecation] The key '#{pair[0]}' must be a symbol while currently it " \
+                                "is #{pair[0].class.name}. Please define the key as a Symbol. " \
+                                'Converting it to Symbol for now.')
+        end
+
         pair[0].to_sym
       rescue StandardError => e
         ::Appium::Logger.warn(e.message)
@@ -38,7 +47,11 @@ module Appium
       end
 
       value = pair[1]
-      acc[key] = value.is_a?(Hash) ? symbolize_keys(value) : value
+      acc[key] = if nested
+                   value.is_a?(Hash) ? symbolize_keys(value, nested: false, enable_deprecation_msg: true) : value
+                 else
+                   value
+                 end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver