Add RBS comments

Author: aguspe

rb/lib/selenium/devtools.rb

@@ -22,6 +22,7 @@ module DevTools
     class << self
       attr_accessor :version
 
+      # @rbs () -> void
       def load_version
         require "selenium/devtools/v#{@version}"
       rescue LoadError

rb/lib/selenium/server.rb

@@ -215,6 +215,7 @@ def stop
       @log_file&.close
     end
 
+    # @rbs () -> String
     def webdriver_url
       "http://#{@host}:#{@port}/wd/hub"
     end

rb/lib/selenium/webdriver/atoms.rb

@@ -20,17 +20,20 @@
 module Selenium
   module WebDriver
     module Atoms
+      # @rbs (Symbol) -> String
       def atom_script(function_name)
         format("/* #{function_name} */return (%<atom>s).apply(null, arguments)",
                atom: read_atom(function_name))
       end
 
       private
 
+      # @rbs (Symbol) -> String
       def read_atom(function)
         File.read(File.expand_path("../atoms/#{function}.js", __FILE__))
       end
 
+      # @rbs (Symbol, *Selenium::WebDriver::Element | String | Hash[untyped, untyped]) -> (String | Array[untyped])
       def execute_atom(function_name, *arguments)
         execute_script(atom_script(function_name), *arguments)
       end

rb/lib/selenium/webdriver/bidi.rb

@@ -31,30 +31,37 @@ class BiDi
       autoload :InterceptedAuth, 'selenium/webdriver/bidi/network/intercepted_auth'
       autoload :InterceptedItem, 'selenium/webdriver/bidi/network/intercepted_item'
 
+      # @rbs (url: String) -> void
       def initialize(url:)
         @ws = WebSocketConnection.new(url: url)
       end
 
+      # @rbs () -> nil
       def close
         @ws.close
       end
 
+      # @rbs () -> Hash[untyped, untyped]
       def callbacks
         @ws.callbacks
       end
 
+      # @rbs (String) -> void
       def add_callback(event, &block)
         @ws.add_callback(event, &block)
       end
 
+      # @rbs (String, Integer) -> void
       def remove_callback(event, id)
         @ws.remove_callback(event, id)
       end
 
+      # @rbs () -> Selenium::WebDriver::BiDi::Session
       def session
         @session ||= Session.new(self)
       end
 
+      # @rbs (String, **String | String | Integer | String | bool) -> Hash[untyped, untyped]
       def send_cmd(method, **params)
         data = {method: method, params: params.compact}
         message = @ws.send_cmd(**data)
@@ -63,6 +70,7 @@ def send_cmd(method, **params)
         message['result']
       end
 
+      # @rbs (Hash[untyped, untyped]) -> String
       def error_message(message)
         "#{message['error']}: #{message['message']}\n#{message['stacktrace']}"
       end

rb/lib/selenium/webdriver/bidi/browsing_context.rb

@@ -32,6 +32,7 @@ class BrowsingContext
         }.freeze
 
         # TODO: store current window handle in bridge object instead of always calling it
+        # @rbs (Selenium::WebDriver::Remote::BiDiBridge) -> void
         def initialize(bridge)
           @bridge = bridge
           @bidi = @bridge.bidi
@@ -44,6 +45,7 @@ def initialize(bridge)
         # @param url [String] The URL to navigate to.
         # @param context_id [String, NilClass] The ID of the browsing context to navigate in.
         #   Defaults to the window handle of the current context.
+        # @rbs (String, ?context_id: nil) -> Hash[untyped, untyped]
         def navigate(url, context_id: nil)
           context_id ||= @bridge.window_handle
           @bidi.send_cmd('browsingContext.navigate', context: context_id, url: url, wait: @readiness)
@@ -55,6 +57,7 @@ def navigate(url, context_id: nil)
         #   Positive values go forwards, negative values go backwards.
         # @param context_id [String, NilClass] The ID of the context to traverse.
         #   Defaults to the window handle of the current context.
+        # @rbs (Integer, ?context_id: nil) -> Hash[untyped, untyped]
         def traverse_history(delta, context_id: nil)
           context_id ||= @bridge.window_handle
           @bidi.send_cmd('browsingContext.traverseHistory', context: context_id, delta: delta)
@@ -65,6 +68,7 @@ def traverse_history(delta, context_id: nil)
         #   Defaults to the window handle of the current context.
         # @param [Boolean] ignore_cache Whether to bypass the cache when reloading.
         #   Defaults to false.
+        # @rbs (?context_id: nil, ?ignore_cache: bool) -> Hash[untyped, untyped]
         def reload(context_id: nil, ignore_cache: false)
           context_id ||= @bridge.window_handle
           params = {context: context_id, ignore_cache: ignore_cache, wait: @readiness}
@@ -75,6 +79,7 @@ def reload(context_id: nil, ignore_cache: false)
         #
         # @param [String] context_id The ID of the context to close.
         #   Defaults to the window handle of the current context.
+        # @rbs (?context_id: String) -> void
         def close(context_id: nil)
           context_id ||= @bridge.window_handle
           @bidi.send_cmd('browsingContext.close', context: context_id)
@@ -88,23 +93,27 @@ def close(context_id: nil)
         #   Defaults to the current window handle.
         #
         # @return [String] The context ID of the created browsing context.
+        # @rbs (?type: nil, ?context_id: nil) -> String
         def create(type: nil, context_id: nil)
           type ||= :window
           context_id ||= @bridge.window_handle
           result = @bidi.send_cmd('browsingContext.create', type: type.to_s, referenceContext: context_id)
           result['context']
         end
 
+        # @rbs (?context_id: nil, ?width: Integer, ?height: Integer, ?device_pixel_ratio: Float) -> void
         def set_viewport(context_id: nil, width: nil, height: nil, device_pixel_ratio: nil)
           context_id ||= @bridge.window_handle
           params = {context: context_id, viewport: {width:, height:}, device_pixel_ratio:}
           @bidi.send_cmd('browsingContext.setViewport', **params)
         end
 
+        # @rbs (String, ?accept: bool, ?text: nil | String) -> void
         def handle_user_prompt(context_id, accept: true, text: nil)
           @bidi.send_cmd('browsingContext.handleUserPrompt', context: context_id, accept: accept, text: text)
         end
 
+        # @rbs (?context_id: nil) -> void
         def activate(context_id: nil)
           context_id ||= @bridge.window_handle
           @bidi.send_cmd('browsingContext.activate', context: context_id)

rb/lib/selenium/webdriver/bidi/log_handler.rb

@@ -24,13 +24,15 @@ class LogHandler
         ConsoleLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source, :method, :args)
         JavaScriptLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source)
 
+        # @rbs (Selenium::WebDriver::BiDi) -> void
         def initialize(bidi)
           @bidi = bidi
           @log_entry_subscribed = false
         end
 
         # @return [int] id of the handler
         # steep:ignore:start
+        # @rbs (String) -> Integer
         def add_message_handler(type)
           subscribe_log_entry unless @log_entry_subscribed
           @bidi.add_callback('log.entryAdded') do |params|
@@ -43,13 +45,15 @@ def add_message_handler(type)
         # steep:ignore:end
 
         # @param [int] id of the handler previously added
+        # @rbs (Integer) -> nil
         def remove_message_handler(id)
           @bidi.remove_callback('log.entryAdded', id)
           unsubscribe_log_entry if @log_entry_subscribed && @bidi.callbacks['log.entryAdded'].empty?
         end
 
         private
 
+        # @rbs () -> bool
         def subscribe_log_entry
           @bidi.session.subscribe('log.entryAdded')
           @log_entry_subscribed = true

rb/lib/selenium/webdriver/bidi/log_inspector.rb

@@ -40,6 +40,7 @@ class LogInspector
           WARNING: 'warning'
         }.freeze
 
+        # @rbs (Selenium::WebDriver::Chrome::Driver, ?nil) -> void
         def initialize(driver, browsing_context_ids = nil)
           WebDriver.logger.deprecate('LogInspector class',
                                      'Script class with driver.script',
@@ -54,6 +55,7 @@ def initialize(driver, browsing_context_ids = nil)
           @bidi.session.subscribe('log.entryAdded', browsing_context_ids)
         end
 
+        # @rbs (?Selenium::WebDriver::BiDi::FilterBy?) -> void
         def on_console_entry(filter_by = nil, &block)
           check_valid_filter(filter_by)
 
@@ -63,6 +65,7 @@ def on_console_entry(filter_by = nil, &block)
           end
         end
 
+        # @rbs (?Selenium::WebDriver::BiDi::FilterBy?) -> void
         def on_javascript_log(filter_by = nil, &block)
           check_valid_filter(filter_by)
 
@@ -72,13 +75,15 @@ def on_javascript_log(filter_by = nil, &block)
           end
         end
 
+        # @rbs () -> void
         def on_javascript_exception(&block)
           on_log do |params|
             type = params['type']
             javascript_log_events(params, FilterBy.log_level('error'), &block) if type.eql?('javascript')
           end
         end
 
+        # @rbs (?Selenium::WebDriver::BiDi::FilterBy?) -> Integer?
         def on_log(filter_by = nil, &block)
           unless filter_by.nil?
             check_valid_filter(filter_by)
@@ -94,17 +99,20 @@ def on_log(filter_by = nil, &block)
 
         private
 
+        # @rbs (Symbol) -> Integer
         def on(event, &block)
           event = EVENTS[event] if event.is_a?(Symbol)
           @bidi.add_callback("log.#{event}", &block)
         end
 
+        # @rbs (Selenium::WebDriver::BiDi::FilterBy?) -> void
         def check_valid_filter(filter_by)
           return if filter_by.nil? || filter_by.instance_of?(FilterBy)
 
           raise "Pass valid FilterBy object. Received: #{filter_by.inspect}"
         end
 
+        # @rbs (Hash[untyped, untyped], Selenium::WebDriver::BiDi::FilterBy?) -> Array[untyped]?
         def console_log_events(params, filter_by)
           event = ConsoleLogEntry.new(
             level: params['level'],
@@ -125,6 +133,7 @@ def console_log_events(params, filter_by)
           yield(event)
         end
 
+        # @rbs (Hash[untyped, untyped], Selenium::WebDriver::BiDi::FilterBy?) -> Selenium::WebDriver::BiDi::JavascriptLogEntry?
         def javascript_log_events(params, filter_by)
           event = JavascriptLogEntry.new(
             level: params['level'],

rb/lib/selenium/webdriver/bidi/network.rb

@@ -36,10 +36,12 @@ class Network
           auth_required: 'authRequired'
         }.freeze
 
+        # @rbs (Selenium::WebDriver::BiDi) -> void
         def initialize(bidi)
           @bidi = bidi
         end
 
+        # @rbs (?phases: Array[untyped], ?contexts: nil, ?url_patterns: Array[untyped], ?pattern_type: nil | Symbol) -> Hash[untyped, untyped]
         def add_intercept(phases: [], contexts: nil, url_patterns: nil, pattern_type: :string)
           url_patterns = url_patterns && pattern_type ? UrlPattern.format_pattern(url_patterns, pattern_type) : nil
           @bidi.send_cmd('network.addIntercept',
@@ -48,10 +50,12 @@ def add_intercept(phases: [], contexts: nil, url_patterns: nil, pattern_type: :s
                          urlPatterns: url_patterns)
         end
 
+        # @rbs (String) -> void
         def remove_intercept(intercept)
           @bidi.send_cmd('network.removeIntercept', intercept: intercept)
         end
 
+        # @rbs (String, String, String) -> Hash[untyped, untyped]
         def continue_with_auth(request_id, username, password)
           @bidi.send_cmd(
             'network.continueWithAuth',
@@ -65,6 +69,7 @@ def continue_with_auth(request_id, username, password)
           )
         end
 
+        # @rbs (String) -> Hash[untyped, untyped]
         def continue_without_auth(request_id)
           @bidi.send_cmd(
             'network.continueWithAuth',
@@ -73,6 +78,7 @@ def continue_without_auth(request_id)
           )
         end
 
+        # @rbs (String) -> Hash[untyped, untyped]
         def cancel_auth(request_id)
           @bidi.send_cmd(
             'network.continueWithAuth',
@@ -81,6 +87,7 @@ def cancel_auth(request_id)
           )
         end
 
+        # @rbs (**(String | Array[untyped])? | String | Hash[untyped, untyped] | Array[untyped]) -> Hash[untyped, untyped]?
         def continue_request(**args)
           @bidi.send_cmd(
             'network.continueRequest',
@@ -93,13 +100,15 @@ def continue_request(**args)
           )
         end
 
+        # @rbs (String) -> Hash[untyped, untyped]?
         def fail_request(request_id)
           @bidi.send_cmd(
             'network.failRequest',
             request: request_id
           )
         end
 
+        # @rbs (**(String | Array[untyped])? | (String | Array[untyped] | Hash[untyped, untyped])?) -> Hash[untyped, untyped]?
         def continue_response(**args)
           @bidi.send_cmd(
             'network.continueResponse',
@@ -112,6 +121,7 @@ def continue_response(**args)
           )
         end
 
+        # @rbs (**(String | Array[untyped] | Hash[untyped, untyped] | Integer)?) -> Hash[untyped, untyped]
         def provide_response(**args)
           @bidi.send_cmd(
             'network.provideResponse',
@@ -124,10 +134,12 @@ def provide_response(**args)
           )
         end
 
+        # @rbs (String, *String) -> Hash[untyped, untyped]
         def set_cache_behavior(behavior, *contexts)
           @bidi.send_cmd('network.setCacheBehavior', cacheBehavior: behavior, contexts: contexts)
         end
 
+        # @rbs (Symbol) -> Hash[untyped, untyped]
         def on(event, &block)
           event = EVENTS[event] if event.is_a?(Symbol)
           @bidi.add_callback(event, &block)

rb/lib/selenium/webdriver/bidi/network/intercepted_auth.rb

@@ -21,14 +21,17 @@ module Selenium
   module WebDriver
     class BiDi
       class InterceptedAuth < InterceptedItem
+        # @rbs (String, String) -> Hash[untyped, untyped]
         def authenticate(username, password)
           network.continue_with_auth(id, username, password)
         end
 
+        # @rbs () -> Hash[untyped, untyped]
         def skip
           network.continue_without_auth(id)
         end
 
+        # @rbs () -> Hash[untyped, untyped]
         def cancel
           network.cancel_auth(id)
         end

rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb

@@ -23,11 +23,13 @@ class BiDi
       class InterceptedItem
         attr_reader :network, :request
 
+        # @rbs (Selenium::WebDriver::BiDi::Network, Hash[untyped, untyped]) -> void
         def initialize(network, request)
           @network = network
           @request = request
         end
 
+        # @rbs () -> String
         def id
           @id ||= @request['request']
         end