Implement RBS trace

Author: aguspe

rb/Gemfile

@@ -10,3 +10,5 @@ gem 'activesupport', '~> 7.0', require: false, platforms: %i[mri mingw x64_mingw
 gem 'curb', '~> 1.0.5', require: false, platforms: %i[mri mingw x64_mingw]
 gem 'debug', '~> 1.7', require: false, platforms: %i[mri mingw x64_mingw]
 gem 'steep', '~> 1.5.0', require: false, platforms: %i[mri mingw x64_mingw]
+
+gem "rbs-trace", "~> 0.5.1"

rb/Gemfile.lock

@@ -100,6 +100,9 @@ GEM
       ffi (~> 1.0)
     rbs (3.9.2)
       logger
+    rbs-trace (0.5.1)
+      prism (>= 0.3.0)
+      rbs (>= 3.5.0)
     rchardet (1.9.0)
     rdoc (6.13.1)
       psych (>= 4.0.0)
@@ -199,6 +202,7 @@ DEPENDENCIES
   git (~> 1.19)
   rack (~> 2.0)
   rake (~> 13.0)
+  rbs-trace (~> 0.5.1)
   rspec (~> 3.0)
   rubocop (~> 1.75)
   rubocop-performance (~> 1.25)

rb/lib/selenium/webdriver.rb

@@ -95,6 +95,7 @@ def self.for(*args)
     # @return [Logger]
     #
 
+    # @rbs (**nil) -> Selenium::WebDriver::Logger
     def self.logger(**opts)
       level = $DEBUG || ENV.key?('DEBUG') ? :debug : :info
       @logger ||= WebDriver::Logger.new('Selenium', default_level: level, **opts)

rb/lib/selenium/webdriver/chrome.rb

@@ -31,6 +31,7 @@ def self.path=(path)
         @path = path
       end
 
+      # @rbs () -> nil
       def self.path
         @path ||= nil
       end

rb/lib/selenium/webdriver/chrome/driver.rb

@@ -30,11 +30,13 @@ module Chrome
       class Driver < Chromium::Driver
         include LocalDriver
 
+        # @rbs (?options: Selenium::WebDriver::Chrome::Options, ?service: Selenium::WebDriver::Chrome::Service, ?url: nil, **nil) -> void
         def initialize(options: nil, service: nil, url: nil, **opts)
           caps, url = initialize_local_driver(options, service, url)
           super(caps: caps, url: url, **opts)
         end
 
+        # @rbs () -> Symbol
         def browser
           :chrome
         end

rb/lib/selenium/webdriver/chrome/features.rb

@@ -35,10 +35,12 @@ module Features
           send_command: [:post, 'session/:session_id/goog/cdp/execute']
         }.freeze
 
+        # @rbs () -> Hash[untyped, untyped]
         def command_list
           CHROME_COMMANDS.merge(CHROMIUM_COMMANDS).merge(self.class::COMMANDS)
         end
 
+        # @rbs (Symbol) -> Array[untyped]
         def commands(command)
           command_list[command]
         end

rb/lib/selenium/webdriver/chrome/options.rb

@@ -32,6 +32,7 @@ def enable_logging(browser_options)
           browser_options['goog:loggingPrefs'] = @logging_prefs
         end
 
+        # @rbs () -> nil
         def binary_path
           Chrome.path
         end

rb/lib/selenium/webdriver/chrome/service.rb

@@ -26,6 +26,7 @@ class Service < WebDriver::Service
         SHUTDOWN_SUPPORTED = true
         DRIVER_PATH_ENV_KEY = 'SE_CHROMEDRIVER'
 
+        # @rbs () -> nil
         def log
           return @log unless @log.is_a? String
 

rb/lib/selenium/webdriver/chromium/features.rb

@@ -75,6 +75,7 @@ def delete_network_conditions
           execute :delete_network_conditions
         end
 
+        # @rbs (Hash[untyped, untyped]) -> Hash[untyped, untyped]
         def send_command(command_params)
           execute :send_command, {}, command_params
         end

rb/lib/selenium/webdriver/chromium/options.rb

@@ -67,6 +67,7 @@ class Options < WebDriver::Options
         # @option opts [Array<String>] window_types A list of window types to appear in the list of window handles
         #
 
+        # @rbs (?profile: nil, **Array[untyped] | Hash[untyped, untyped] | nil) -> void
         def initialize(profile: nil, **opts)
           super(**opts)
 
@@ -203,6 +204,7 @@ def enable_android(package: 'com.android.chrome', serial_number: nil, use_runnin
 
         protected
 
+        # @rbs (Hash[untyped, untyped]) -> void
         def process_browser_options(browser_options)
           enable_logging(browser_options) unless @logging_prefs.empty?
 
@@ -234,6 +236,7 @@ def validate_extension(path)
           @extensions << path
         end
 
+        # @rbs (Symbol | String) -> bool
         def camelize?(key)
           !%w[localState prefs].include?(key)
         end

rb/lib/selenium/webdriver/common/child_process.rb

@@ -34,21 +34,25 @@ class ChildProcess
       attr_accessor :detach
       attr_writer :io
 
+      # @rbs (*String) -> Selenium::WebDriver::ChildProcess
       def self.build(*command)
         new(*command)
       end
 
+      # @rbs (*String) -> void
       def initialize(*command)
         @command = command
         @detach = false
         @pid = nil
         @status = nil
       end
 
+      # @rbs () -> String
       def io
         @io ||= Platform.null_device
       end
 
+      # @rbs () -> nil
       def start
         options = {%i[out err] => io}
         options[:pgroup] = true unless Platform.windows? # NOTE: this is a bug only in Windows 7
@@ -74,6 +78,7 @@ def alive?
         @pid && !exited?
       end
 
+      # @rbs () -> bool
       def exited?
         return false unless @pid
 
@@ -90,6 +95,7 @@ def exited?
         true
       end
 
+      # @rbs (Integer) -> nil
       def poll_for_exit(timeout)
         WebDriver.logger.debug("Polling #{timeout} seconds for exit of #{@pid}", id: :process)
 
@@ -128,6 +134,7 @@ def kill(pid)
         Process.kill(SIGKILL, pid)
       end
 
+      # @rbs (Integer, ?Integer) -> Array[untyped]?
       def waitpid2(pid, flags = 0)
         Process.waitpid2(pid, flags)
       end

rb/lib/selenium/webdriver/common/driver.rb

@@ -41,6 +41,7 @@ class << self
         # @return [Driver]
         #
 
+        # @rbs (Symbol, ?Hash[untyped, untyped]) -> Selenium::WebDriver::Chrome::Driver
         def for(browser, opts = {})
           case browser
           when :chrome, :chrome_headless_shell
@@ -68,6 +69,7 @@ def for(browser, opts = {})
       # @api private
       #
 
+      # @rbs (?bridge: nil, ?listener: nil, **Hash[untyped, untyped] | URI::HTTP) -> void
       def initialize(bridge: nil, listener: nil, **opts)
         @devtools = nil
         bridge ||= create_bridge(**opts)
@@ -95,6 +97,7 @@ def status
       # @see Navigation
       #
 
+      # @rbs () -> Selenium::WebDriver::Navigation
       def navigate
         @navigate ||= WebDriver::Navigation.new(bridge)
       end
@@ -177,6 +180,7 @@ def page_source
       # Quit the browser
       #
 
+      # @rbs () -> nil
       def quit
         bridge.quit
       ensure
@@ -225,6 +229,7 @@ def window_handle
       #   The value returned from the script.
       #
 
+      # @rbs (String, *nil) -> String
       def execute_script(script, *args)
         bridge.execute_script(script, *args)
       end
@@ -319,13 +324,15 @@ def ref
 
       attr_reader :bridge
 
+      # @rbs (caps: Hash[untyped, untyped], url: URI::HTTP, ?http_client: nil) -> Selenium::WebDriver::Remote::Bridge
       def create_bridge(caps:, url:, http_client: nil)
         klass = caps['webSocketUrl'] ? Remote::BiDiBridge : Remote::Bridge
         klass.new(http_client: http_client, url: url).tap do |bridge|
           bridge.create_session(caps)
         end
       end
 
+      # @rbs (Selenium::WebDriver::Chrome::Service) -> URI::HTTP
       def service_url(service)
         @service_manager = service.launch
         @service_manager.uri
@@ -335,6 +342,7 @@ def screenshot
         bridge.screenshot
       end
 
+      # @rbs (Symbol) -> Array[untyped]
       def add_extensions(browser)
         extensions = case browser
                      when :chrome, :chrome_headless_shell, :msedge, :microsoftedge

rb/lib/selenium/webdriver/common/driver_extensions/has_cdp.rb

@@ -27,6 +27,7 @@ module HasCDP
         # @return [Hash]
         #
 
+        # @rbs (String, **String) -> Hash[untyped, untyped]
         def execute_cdp(cmd, **params)
           @bridge.send_command(cmd: cmd, params: params)
         end

rb/lib/selenium/webdriver/common/driver_finder.rb

@@ -26,25 +26,30 @@ def self.path(options, service_class)
         new(options, service_class.new).driver_path
       end
 
+      # @rbs (Selenium::WebDriver::Chrome::Options, Selenium::WebDriver::Chrome::Service) -> void
       def initialize(options, service)
         @options = options
         @service = service
       end
 
+      # @rbs () -> String
       def browser_path
         paths[:browser_path]
       end
 
+      # @rbs () -> String
       def driver_path
         paths[:driver_path]
       end
 
+      # @rbs () -> bool
       def browser_path?
         !browser_path.nil? && !browser_path.empty?
       end
 
       private
 
+      # @rbs () -> Hash[untyped, untyped]
       def paths
         @paths ||= begin
           path = @service.class.driver_path
@@ -76,6 +81,7 @@ def paths
         end
       end
 
+      # @rbs () -> Array[untyped]
       def to_args
         args = ['--browser', @options.browser_name]
         if @options.browser_version

rb/lib/selenium/webdriver/common/error.rb

@@ -25,6 +25,7 @@ module Error
       # @param [String, nil] error
       #
 
+      # @rbs (nil) -> nil
       def self.for_error(error)
         return if error.nil?
 

rb/lib/selenium/webdriver/common/local_driver.rb

@@ -20,6 +20,7 @@
 module Selenium
   module WebDriver
     module LocalDriver
+      # @rbs (Selenium::WebDriver::Chrome::Options, Selenium::WebDriver::Chrome::Service, nil) -> Array[untyped]
       def initialize_local_driver(options, service, url)
         raise ArgumentError, "Can't initialize #{self.class} with :url" if url
 
@@ -30,6 +31,7 @@ def initialize_local_driver(options, service, url)
         [caps, url]
       end
 
+      # @rbs (Selenium::WebDriver::Chrome::Options, Selenium::WebDriver::Chrome::Service) -> Hash[untyped, untyped]
       def process_options(options, service)
         default_options = Options.send(browser)
         options ||= default_options

rb/lib/selenium/webdriver/common/logger.rb

@@ -115,6 +115,7 @@ def allow(*ids)
       # @param [Symbol, Array<Symbol>] id
       # @yield see #deprecate
       #
+      # @rbs (String, ?id: Array[untyped] | Symbol) -> nil
       def debug(message, id: [], &block)
         discard_or_log(:debug, message, id, &block)
       end
@@ -191,6 +192,7 @@ def create_logger(name, level:)
         logger
       end
 
+      # @rbs (Symbol, String, Array[untyped] | Symbol) -> nil
       def discard_or_log(level, message, id)
         id = Array(id)
         return if @ignored.intersect?(id)

rb/lib/selenium/webdriver/common/navigation.rb

@@ -20,6 +20,7 @@
 module Selenium
   module WebDriver
     class Navigation
+      # @rbs (Selenium::WebDriver::Remote::Bridge) -> void
       def initialize(bridge)
         @bridge = bridge
       end
@@ -28,6 +29,7 @@ def initialize(bridge)
       # Navigate to the given URL
       #
 
+      # @rbs (String) -> void
       def to(url)
         @bridge.get url
       end