percy-appium-app 0.0.9 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82432d403ea8909fd0dd473251c8b406378497ff06e6e1806144e83350598013
-  data.tar.gz: 1f351d8ede37fef600554f98f1ac8bdc7b60124ea62374be65175a26b0cd74c0
+  metadata.gz: 85a82be9fb7970cea7e6bfbf92341377a6cf4647f07ce09b3a3c4bb52ff25c11
+  data.tar.gz: 03be307ae51ff85c7853cf0284ded40713a91f8bbf4ce36f8f6b7ae69165d26e
 SHA512:
-  metadata.gz: 0bc03604787ae7757d95e29d33dfcdc176c9b0733c0b639ed04d75a7aac4061ff915046b34c0d65f21cf3360514f3c9f970dfef46e6bb38f363a5c2b3cd611d7
-  data.tar.gz: c339d7e5282e110b6351284f72124cab0876ddb4b40c95606096219923ca64cf9b4cd4c8084022274625a6bbdd6c087a90bec4a6a105a3ed9c61a49b756bb1f3
+  metadata.gz: 986183165da611f44bfd356562c084bdb942d7f87a2e38418746562c1d056894e8a373c4fe3e61a5aa2c3a44a48c9c42d7701e845b30eec7727fdafbe2a78faa
+  data.tar.gz: a21a495cb3cda29740602eb262e23ef67ed7c3fce651d191d1ec91c73bc56b0540f6c8cf55772816da6acdcadf1d07c6040e35a49f4fdfae95e1ca0016ccf2fe

data/percy/metadata/android_metadata.rb

@@ -9,20 +9,24 @@ module Percy
     def initialize(driver)
       super(driver)
       @_bars = nil
+      # Intentionally left as the original lookup: this path already degrades to
+      # driver.get_system_bars consistently across all appium_lib_core versions
+      # (the rect read yields a non-Hash, so the rect arithmetic in
+      # get_system_bars rescues to nil and falls back), so it is out of scope for
+      # the snake_case capability fix.
       @_viewport_rect = capabilities.to_json['viewportRect']
     end
 
     def device_screen_size
-      caps = capabilities
-      caps = caps.as_json unless caps.is_a?(Hash)
       # Use string keys to match the IosMetadata implementation and every
       # consumer (generic_provider, app_automate, _get_tag), all of which read
       # device_screen_size['width'] / ['height'].
-      if caps['deviceScreenSize'].nil?
+      device_screen_size_cap = get_capability_value('deviceScreenSize')
+      if device_screen_size_cap.nil?
         size = driver.window_size
         { 'width' => size.width.to_i, 'height' => size.height.to_i }
       else
-        width, height = caps['deviceScreenSize'].split('x')
+        width, height = device_screen_size_cap.split('x')
         { 'width' => width.to_i, 'height' => height.to_i }
       end
     end
@@ -76,11 +80,13 @@ module Percy
 
     def _device_name
       if @device_name.nil?
-        desired_caps = capabilities.to_json['desired'] || {}
-        device_name = desired_caps['deviceName']
+        # Normalize the nested desired-caps hash too, so its keys are matched
+        # regardless of casing (camelCase or appium_lib_core 13+ snake_case).
+        desired_caps = Percy::Metadata.normalize_hash(get_capability_value('desired'))
+        device_name = desired_caps['devicename']
         device = desired_caps['device']
         device_name ||= device
-        device_model = capabilities.to_json['deviceModel']
+        device_model = get_capability_value('deviceModel')
         @device_name = device_name || device_model
       end
       @device_name

data/percy/metadata/ios_metadata.rb

@@ -67,11 +67,7 @@ module Percy
     end
 
     def device_name
-      if @device_name.nil?
-        caps = capabilities
-        caps = caps.as_json unless caps.is_a?(Hash)
-        @device_name = caps['deviceName']
-      end
+      @device_name = get_capability_value('deviceName') if @device_name.nil?
       @device_name
     end
 

data/percy/metadata/metadata.rb

@@ -25,19 +25,54 @@ module Percy
       caps
     end
 
+    # Normalizes a capability key so lookups are resilient to the differences
+    # across appium_lib_core versions and protocols: camelCase ("platformName"),
+    # snake_case ("platform_name", as returned by appium_lib_core 13+),
+    # SCREAMING ("PLATFORM_NAME") and the W3C vendor prefix ("appium:platformName").
+    # Note: all colons are stripped, not just the vendor-prefix one. This is safe
+    # for every known Appium capability (e.g. "bstack:options" -> "bstackoptions").
+    def self.normalize_capability_key(key)
+      key.to_s.downcase.gsub(/[_:]/, '').sub(/\Aappium/, '')
+    end
+
+    # Builds a {normalized_key => value} view of a capabilities hash. First key
+    # wins, so a camelCase key (e.g. "platformName") takes precedence over a
+    # snake_case duplicate ("platform_name") when both are present, matching the
+    # previous MetadataResolver semantics.
+    def self.normalize_hash(hash)
+      normalized = {}
+      (hash || {}).each do |k, v|
+        nk = normalize_capability_key(k)
+        normalized[nk] = v unless normalized.key?(nk)
+      end
+      normalized
+    end
+
+    # Builds a {normalized_key => value} view of the driver's capabilities,
+    # coercing the appium_lib_core Capabilities object into a plain Hash first.
+    def self.normalized_capabilities(driver)
+      caps = driver.capabilities
+      caps = caps.as_json if caps.respond_to?(:as_json) && !caps.is_a?(Hash)
+      caps = caps.to_h if caps.respond_to?(:to_h) && !caps.is_a?(Hash)
+      normalize_hash(caps)
+    end
+
+    # Reads capabilities fresh on every call (no memoization) so callers always
+    # observe the driver's current capabilities, matching the prior behaviour.
+    def get_capability_value(name)
+      self.class.normalized_capabilities(driver)[self.class.normalize_capability_key(name)]
+    end
+
     def session_id
       driver.session_id
     end
 
     def os_name
-      capabilities['platformName']
+      get_capability_value('platformName')
     end
 
     def os_version
-      caps = capabilities
-      caps = caps.as_json unless caps.is_a?(Hash)
-
-      os_version = caps['os_version'] || caps['platformVersion'] || ''
+      os_version = get_capability_value('os_version') || get_capability_value('platformVersion') || ''
       os_version = @os_version || os_version
       begin
         os_version.to_f.to_i.to_s
@@ -51,7 +86,7 @@ module Percy
     end
 
     def get_orientation(**kwargs)
-      orientation = kwargs[:orientation] || capabilities['orientation'] || 'PORTRAIT'
+      orientation = kwargs[:orientation] || get_capability_value('orientation') || 'PORTRAIT'
       orientation = orientation.downcase
       orientation = orientation == 'auto' ? _orientation : orientation
       orientation.upcase

data/percy/metadata/metadata_resolver.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 require_relative '../exceptions/exceptions'
+require_relative 'metadata'
 require_relative 'android_metadata'
 require_relative 'ios_metadata'
 
 module Percy
   class MetadataResolver
     def self.resolve(driver)
-      capabilities = driver.capabilities
-      capabilities = capabilities.as_json unless capabilities.is_a?(Hash)
-      key = capabilities.keys.find { |k| k.downcase.gsub('_', '') == 'platformname' }
-      platform_name = capabilities[key]&.downcase
+      # Resolve via normalized capability keys so platformName is found
+      # regardless of casing/prefix (camelCase, snake_case as in appium_lib_core
+      # 13+, or the appium: vendor prefix).
+      platform_name = Percy::Metadata.normalized_capabilities(driver)['platformname']&.to_s&.downcase
       case platform_name
       when 'android'
         Percy::AndroidMetadata.new(driver)

data/percy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Percy
-  VERSION = '0.0.9'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/specs/android_metadata.rb

@@ -102,4 +102,28 @@ class TestAndroidMetadata < Minitest::Test
   def test_scale_factor
     assert_equal(1, @android_metadata.scale_factor)
   end
+
+  # Regression: appium_lib_core 13.x returns capabilities with snake_case keys
+  # (e.g. "device_screen_size" instead of "deviceScreenSize").
+  def test_device_screen_size_with_snake_case_caps
+    android_capabilities = get_android_capabilities
+    android_capabilities.delete('deviceScreenSize')
+    android_capabilities['device_screen_size'] = '1080x2280'
+    @mock_webdriver.expect(:capabilities, android_capabilities)
+
+    result = @android_metadata.device_screen_size
+    assert_equal({ 'width' => 1080, 'height' => 2280 }, result)
+    @mock_webdriver.verify
+  end
+
+  # Regression: the nested desired-caps hash is also normalized, so a
+  # snake_case "device_name" inside "desired" still resolves the device.
+  def test_device_name_with_snake_case_desired_caps
+    android_capabilities = get_android_capabilities
+    android_capabilities['desired'] = { 'device_name' => 'google pixel 4' }
+    @mock_webdriver.expect(:capabilities, android_capabilities)
+    @mock_webdriver.expect(:capabilities, android_capabilities)
+
+    assert_equal('google pixel 4', @android_metadata._device_name)
+  end
 end

data/specs/ios_metadata.rb

@@ -105,4 +105,15 @@ class TestIOSMetadata < Minitest::Test
 
     assert_equal(2, @ios_metadata.scale_factor)
   end
+
+  def test_device_name_with_camel_case_caps
+    @mock_webdriver.expect(:capabilities, { 'deviceName' => 'iPhone 14' })
+    assert_equal('iPhone 14', @ios_metadata.device_name)
+  end
+
+  # Regression: appium_lib_core 13.x returns capabilities with snake_case keys.
+  def test_device_name_with_snake_case_caps
+    @mock_webdriver.expect(:capabilities, { 'device_name' => 'iPhone 14' })
+    assert_equal('iPhone 14', @ios_metadata.device_name)
+  end
 end

data/specs/metadata.rb

@@ -137,4 +137,26 @@ class TestMetadata < Minitest::Test
       @metadata.value_from_devices_info('scale_factor', ios_device)
     )
   end
+
+  def test_normalize_capability_key
+    # camelCase, snake_case, SCREAMING and the appium: vendor prefix all
+    # collapse to the same normalized key.
+    %w[platformName platform_name PLATFORM_NAME appium:platformName].each do |key|
+      assert_equal('platformname', Percy::Metadata.normalize_capability_key(key))
+    end
+    assert_equal('platformname', Percy::Metadata.normalize_capability_key(:platformName))
+  end
+
+  # Regression: appium_lib_core 13.x returns capabilities with snake_case keys.
+  def test_metadata_os_name_with_snake_case_caps
+    @mock_webdriver.expect(:capabilities, { 'platform_name' => 'Android' })
+    assert_equal('Android', @metadata.os_name)
+  end
+
+  def test_metadata_os_version_with_snake_case_platform_version
+    capabilities = { 'platform_version' => '14' }
+    @mock_webdriver.expect(:capabilities, capabilities)
+    @mock_webdriver.expect(:capabilities, capabilities)
+    assert_equal('14', @metadata.os_version)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percy-appium-app
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.1
 platform: ruby
 authors:
 - BroswerStack