appium_lib_core 12.1.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6226306206eafec9dbd6f2c2f1ac09c86fee48ee841be8616df8acf6ce56a5
-  data.tar.gz: ab63b82ecafb824a8b0edfdcbcba8d9ec0e1530e8a42f86c4c95aa95246a6871
+  metadata.gz: 5da273adb6ddfbb70989718cc778ea9bac3714396f36f70e3de3cc65293dcd7b
+  data.tar.gz: ac1df239bf0a69a32dc14e0c81b49f295f29dfe465630c36dd93bf51dd135a75
 SHA512:
-  metadata.gz: 2573d787ffb963708aae21889b3f3ab6f68b7747b623a7ba906fff4065f7514557608dfaa6b9b05b8ceddaf4a6f0ae96edb20a436af01e3148c5c13ed64bf598
-  data.tar.gz: 21c2e01a1bdfb8bfd81ad309eb8e6fbdfa6d5abba485c77b52c257652be9c8b58a4f62a110a78128f2f26438e0d018cebfe6f1cffd8f60e1aa91293c2d14e269
+  metadata.gz: 78d693f951a61e7261a7f3b792780a06b488532c07fd67f7b89d0b8afbf378013cbfdf59a2f1f7eca2259fccd9991fa973d34944807c85fae652ca9367af96ef
+  data.tar.gz: 030a377ea6bb2bd102e5f69faf5f22297593050db31346f951b3a8e39d5735b9c10ceb98dddf6871a28e0cb6d47b4fc82b7fbe941668e3f07edf1d802b5084a2

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 Read `release_notes.md` for commit level details.
 
+## [13.0.0] - 2026-05-10
+- Remove extenced methods in `Appium::Core::Base::Driver` only for the appium_lib - which is covered  by the library.
+
+## [12.2.0] - 2026-04-19
+- Add validation for direct connect URL when `direct_connect` capability is `true`.
+
 ## [12.1.0] - 2026-03-21
 - Replace internal `add_command` method with Selnium Bridge's `add_command` to simplify the codebase.
 

data/Gemfile

@@ -8,7 +8,7 @@ gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'parallel_tests'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.85.1'
+gem 'rubocop', '1.86.1'
 gem 'simplecov'
 gem 'steep', '~> 1.10.0'
 gem 'webmock', '~> 3.26.0'

data/lib/appium_lib_core/device.rb

@@ -20,26 +20,6 @@ module Appium
       class << self
         def extended(_mod)
           extend_webdriver_with_forwardable
-
-          # Compatibility for appium_lib. Below command are extended by `extend Appium::Core::Deivce`in appium_lib.
-          # TODO: Will remove
-          [
-            :take_element_screenshot, :save_viewport_screenshot,
-            :lock, :device_locked?, :unlock,
-            :hide_keyboard, :is_keyboard_shown,
-            :ime_activate, :ime_available_engines, :ime_active_engine, :ime_activated, :ime_deactivate,
-            :get_settings, :update_settings,
-            :within_context, :current_context, :available_contexts, :set_context,
-            :push_file, :pull_file, :pull_folder,
-            :keyevent, :press_keycode, :long_press_keycode,
-            :match_images_features, :find_image_occurrence, :get_images_similarity, :compare_images,
-            :app_strings, :background_app,
-            :install_app, :remove_app, :app_installed?, :activate_app, :terminate_app,
-            :app_state,
-            :stop_recording_screen, :stop_and_save_recording_screen,
-            :shake, :device_time,
-            :execute_driver, :execute_cdp
-          ].each(&method(:delegate_from_appium_driver))
         end
 
         # def extended

data/lib/appium_lib_core/driver.rb

@@ -13,6 +13,9 @@
 # limitations under the License.
 
 require 'uri'
+require 'socket'
+require 'ipaddr'
+require 'timeout'
 
 module Appium
   # The struct for 'location'
@@ -99,6 +102,59 @@ module Appium
         @port = capabilities[W3C_KEYS[:port]] || capabilities[KEYS[:port]]
         @path = capabilities[W3C_KEYS[:path]] || capabilities[KEYS[:path]]
       end
+
+      def valid?
+        return false unless [@protocol, @host, @port, @path].none?(&:nil?)
+
+        addresses = resolve_addresses(@host)
+        return false if addresses.empty?
+
+        addresses.find { |ip| disallowed? ip }.nil?
+      end
+
+      private
+
+      # Do not allow loopback, link-local, unspecified and multicast addresses for
+      # direct connect since they are not accessible from outside of the server.
+      DNS_RESOLVE_TIMEOUT_SECONDS = 30
+      LOOPBACK_RANGES = [IPAddr.new('127.0.0.0/8'), IPAddr.new('::1/128')].freeze
+      LINK_LOCAL_RANGES = [IPAddr.new('169.254.0.0/16'), IPAddr.new('fe80::/10')].freeze
+      UNSPECIFIED_RANGES = [IPAddr.new('0.0.0.0/32'), IPAddr.new('::/128')].freeze
+      MULTICAST_RANGES = [IPAddr.new('224.0.0.0/4'), IPAddr.new('ff00::/8')].freeze
+      DISALLOWED_RANGES = [
+        *LOOPBACK_RANGES,
+        *LINK_LOCAL_RANGES,
+        *UNSPECIFIED_RANGES,
+        *MULTICAST_RANGES
+      ].freeze
+
+      def resolve_addresses(host)
+        normalized_host = host.to_s.delete_prefix('[').delete_suffix(']')
+        # If the host is already an IP literal, skip DNS resolution to avoid blocking calls
+        return [normalized_host] if ip_literal?(normalized_host)
+
+        Timeout.timeout(DNS_RESOLVE_TIMEOUT_SECONDS) do
+          Socket.getaddrinfo(normalized_host, nil).map { |entry| entry[3] }.uniq
+        end
+      rescue Timeout::Error
+        ::Appium::Logger.warn("DNS resolution for '#{host}' timed out after #{DNS_RESOLVE_TIMEOUT_SECONDS}s")
+        []
+      rescue SocketError => e
+        ::Appium::Logger.warn("Failed to resolve host '#{host}' for direct connect: #{e.message}")
+        []
+      end
+
+      def ip_literal?(host)
+        IPAddr.new(host)
+        true
+      rescue IPAddr::InvalidAddressError
+        false
+      end
+
+      def disallowed?(ip)
+        address = IPAddr.new ip
+        DISALLOWED_RANGES.any? { |range| range.include? address }
+      end
     end
 
     class Driver
@@ -164,8 +220,7 @@ module Appium
       # @return [Appium::Core::Base::Driver]
       attr_reader :driver
 
-      # <b>[Experimental feature]</b><br>
-      # Enable an experimental feature updating Http client endpoint following below keys by Appium/Selenium server.<br>
+      # Enable updating Http client endpoint following below keys by Appium/Selenium server.<br>
       # This works with {Appium::Core::Base::Http::Default}.
       #
       # If your Selenium/Appium server decorates the new session capabilities response with the following keys:<br>
@@ -177,6 +232,12 @@ module Appium
       # ignore them if this parameter is <code>false</code>. Defaults to true.
       # These keys can have <code>appium:</code> prefix.
       #
+      # Note that the server should provide the keys with valid values. The host value must not be
+      # - loopback (for example `127.0.0.1`, `::1`)
+      # - link-local (for example `169.254.x.x`, `fe80::/10`)
+      # - unspecified/wildcard (`0.0.0.0`, `::`)
+      # - multicast (`224.0.0.0/4`, `ff00::/8`)
+      #
       # @return [Bool]
       attr_reader :direct_connect
 
@@ -419,7 +480,14 @@ module Appium
 
           if @direct_connect
             d_c = DirectConnections.new(@driver.capabilities)
-            @driver.update_sending_request_to(protocol: d_c.protocol, host: d_c.host, port: d_c.port, path: d_c.path)
+            if d_c.valid?
+              @driver.update_sending_request_to(protocol: d_c.protocol, host: d_c.host, port: d_c.port, path: d_c.path)
+            else
+              ::Appium::Logger.warn(
+                "Direct connect is enabled but the server did not provide valid direct connect information (#{d_c.protocol}, #{d_c.host}, #{d_c.port}, #{d_c.path}). " \
+                "Continue with the original URL (#{@custom_url})"
+              )
+            end
           end
         rescue Errno::ECONNREFUSED => e
           raise "ERROR: Unable to connect to Appium. Is the server running on #{@custom_url}? Error: #{e}"

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '12.1.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2026-03-21' unless defined? ::Appium::Core::DATE
+    VERSION = '13.0.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2026-05-10' unless defined? ::Appium::Core::DATE
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 13.0.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-22 00:00:00.000000000 Z
+date: 2026-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver