puppeteer-ruby 0.45.6 → 0.50.0.alpha5

data/lib/puppeteer/web_socket_transport.rb

@@ -1,44 +1,86 @@
+# frozen_string_literal: true
+
+require "async"
+require "async/http/endpoint"
+require "async/websocket/client"
+
 class Puppeteer::WebSocketTransport
+  class ClosedError < Puppeteer::Error; end
+
   # @param {string} url
   # @return [Puppeteer::WebSocketTransport]
   def self.create(url)
-    ws = Puppeteer::WebSocket.new(
-      url: url,
-      max_payload_size: 256 * 1024 * 1024, # 256MB
-    )
-    (resolvable_future do |future|
-      ws.on_open do
-        future.fulfill(Puppeteer::WebSocketTransport.new(ws))
-      end
-      ws.on_error do |error_message|
-        future.reject(Puppeteer::WebSocket::TransportError.new(error_message))
-      end
-    end).value!
+    transport = new(url)
+    transport.connect.wait
+    transport
   end
 
-  # @param {!WebSocket::Driver} web_socket
-  def initialize(web_socket)
-    @ws = web_socket
-    @ws.on_message do |data|
-      @on_message&.call(data)
-    end
-    @ws.on_close do |reason, code|
-      @on_close&.call(reason, code)
-    end
-    @ws.on_error do |error|
-      # Silently ignore all errors - we don't know what to do with them.
+  def initialize(url)
+    @url = url
+    @endpoint = Async::HTTP::Endpoint.parse(url)
+    @connection = nil
+    @task = nil
+    @closed = false
+    @connected = false
+    @on_message = nil
+    @on_close = nil
+    @connect_promise = nil
+    @write_mutex = Mutex.new
+  end
+
+  def connect
+    return @connect_promise if @connect_promise
+
+    @connect_promise = Async::Promise.new
+    @task = Async do |task|
+      Async::WebSocket::Client.connect(@endpoint) do |connection|
+        @connection = connection
+        @connected = true
+        @connect_promise.resolve(true) unless @connect_promise.resolved?
+        receive_loop(connection)
+      end
+    rescue Async::Stop
+      # Task was stopped; ignore.
+    rescue => err
+      @connect_promise.reject(err) unless @connect_promise.resolved?
+      close
+    ensure
+      @connected = false
     end
+
+    @connect_promise
   end
 
   # @param message [String]
   def send_text(message)
-    @ws.send_text(message)
+    raise ClosedError.new("Transport is closed") if @closed
+
+    @write_mutex.synchronize do
+      @connection&.write(message)
+      @connection&.flush
+    end
+  rescue IOError, Errno::ECONNRESET, Errno::EPIPE
+    close
+    raise
   end
 
   def close
-    @ws.close
-  rescue EOFError
-    # ignore EOLError. The connection is already closed.
+    return if @closed
+
+    @closed = true
+    begin
+      @connection&.close
+    rescue Async::Stop
+      # Connection already closing; ignore.
+    end
+    @on_close&.call(nil, nil)
+    begin
+      @task&.stop
+    rescue Async::Stop
+      # Task was already stopping; ignore.
+    end
+  rescue IOError, Errno::ECONNRESET, Errno::EPIPE
+    @on_close&.call(nil, nil)
   end
 
   def on_close(&block)
@@ -48,4 +90,26 @@ class Puppeteer::WebSocketTransport
   def on_message(&block)
     @on_message = block
   end
+
+  def connected?
+    @connected && !@closed
+  end
+
+  def closed?
+    @closed
+  end
+
+  private def receive_loop(connection)
+    while (message = connection.read)
+      next if message.nil?
+
+      @on_message&.call(message.to_str)
+    end
+  rescue Async::Stop
+    # Task stopped; no-op.
+  rescue IOError, Errno::ECONNRESET, Errno::EPIPE
+    # Connection closed; no-op.
+  ensure
+    close unless @closed
+  end
 end

data/lib/puppeteer/web_worker.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+class Puppeteer::WorkerWorld
+  using Puppeteer::DefineAsyncMethod
+
+  # @rbs client: Puppeteer::CDPSession -- CDP session
+  def initialize(client)
+    @client = client
+    @context_promise = Async::Promise.new
+  end
+
+  # @rbs context: Puppeteer::ExecutionContext -- Execution context to bind
+  # @rbs return: void -- No return value
+  def set_context(context)
+    @context_promise.resolve(context) unless @context_promise.resolved?
+  end
+
+  # @rbs return: Puppeteer::ExecutionContext -- Worker execution context
+  def execution_context
+    @context_promise.wait
+  end
+
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: untyped -- Evaluation result
+  def evaluate(page_function, *args)
+    execution_context.evaluate(page_function, *args)
+  end
+
+  define_async_method :async_evaluate
+
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: Puppeteer::JSHandle -- Handle to evaluation result
+  def evaluate_handle(page_function, *args)
+    execution_context.evaluate_handle(page_function, *args)
+  end
+
+  define_async_method :async_evaluate_handle
+
+  # @rbs return: nil -- Workers do not have frames
+  def frame
+    nil
+  end
+
+  # @rbs return: void -- Dispose world resources
+  def dispose
+    @context_promise = Async::Promise.new
+  end
+end
+
+class Puppeteer::WebWorker
+  include Puppeteer::EventCallbackable
+  using Puppeteer::DefineAsyncMethod
+
+  # @rbs url: String -- Worker URL
+  def initialize(url)
+    @url = url
+    @timeout_settings = Puppeteer::TimeoutSettings.new
+  end
+
+  # @rbs return: Puppeteer::TimeoutSettings -- Timeout settings
+  attr_reader :timeout_settings
+
+  # @rbs return: String -- Worker URL
+  def url
+    @url
+  end
+
+  # @rbs return: Puppeteer::WorkerWorld -- Main realm
+  def main_realm
+    raise NotImplementedError
+  end
+
+  # @rbs return: Puppeteer::CDPSession -- CDP session
+  def client
+    raise NotImplementedError
+  end
+
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: untyped -- Evaluation result
+  def evaluate(page_function, *args)
+    main_realm.evaluate(page_function, *args)
+  end
+
+  define_async_method :async_evaluate
+
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: Puppeteer::JSHandle -- Handle to evaluation result
+  def evaluate_handle(page_function, *args)
+    main_realm.evaluate_handle(page_function, *args)
+  end
+
+  define_async_method :async_evaluate_handle
+
+  # @rbs return: void -- Not supported
+  def close
+    raise Puppeteer::Error.new('WebWorker.close() is not supported')
+  end
+end
+
+class Puppeteer::CdpWebWorker < Puppeteer::WebWorker
+  include Puppeteer::DebugPrint
+
+  # @rbs client: Puppeteer::CDPSession -- Worker CDP session
+  # @rbs url: String -- Worker URL
+  # @rbs target_id: String -- Target ID
+  # @rbs target_type: String -- Target type
+  # @rbs console_api_called: Proc? -- Console callback
+  # @rbs exception_thrown: Proc? -- Exception callback
+  # @rbs network_manager: untyped? -- Network manager for worker requests
+  def initialize(client, url, target_id, target_type, console_api_called, exception_thrown, network_manager: nil)
+    super(url)
+    @client = client
+    @target_id = target_id
+    @target_type = target_type
+    @world = Puppeteer::WorkerWorld.new(@client)
+
+    @client.once('Runtime.executionContextCreated') do |event|
+      @world.set_context(Puppeteer::ExecutionContext.new(@client, event['context'], @world))
+    end
+    if console_api_called
+      @client.on_event('Runtime.consoleAPICalled') do |event|
+        console_api_called.call(@world, event)
+      end
+    end
+    if exception_thrown
+      @client.on_event('Runtime.exceptionThrown') do |event|
+        exception_thrown.call(event['exceptionDetails'])
+      end
+    end
+    @client.once(CDPSessionEmittedEvents::Disconnected) do
+      @world.dispose
+    end
+
+    if network_manager
+      Async do
+        begin
+          network_manager.add_client(@client)
+        rescue => err
+          debug_puts(err)
+        end
+      end
+    end
+
+    @client.async_send_message('Runtime.enable')
+  end
+
+  # @rbs return: Puppeteer::WorkerWorld -- Main realm
+  def main_realm
+    @world
+  end
+
+  # @rbs return: Puppeteer::CDPSession -- Worker CDP session
+  def client
+    @client
+  end
+
+  # @rbs return: void -- Close the worker
+  def close
+    connection = @client.connection
+    case @target_type
+    when 'service_worker'
+      connection&.send_message('Target.closeTarget', targetId: @target_id)
+      connection&.send_message('Target.detachFromTarget', sessionId: @client.id)
+    when 'shared_worker'
+      connection&.send_message('Target.closeTarget', targetId: @target_id)
+    else
+      evaluate('() => self.close()')
+    end
+  end
+end

data/lib/puppeteer.rb

@@ -1,4 +1,19 @@
-require 'concurrent'
+require "async"
+require 'puppeteer/console_patch'
+
+# Check for Ruby versions affected by https://bugs.ruby-lang.org/issues/20907
+# which causes hangs due to "Attempt to unlock a mutex which is not locked" errors.
+# Fixed in: Ruby 3.2.7+, 3.3.7+, 3.4+
+ruby_version = Gem::Version.new(RUBY_VERSION)
+if ruby_version >= Gem::Version.new('3.2.0') && ruby_version < Gem::Version.new('3.2.7')
+  raise "Ruby #{RUBY_VERSION} has a known issue that causes puppeteer-ruby to hang. " \
+        "Please upgrade to Ruby 3.2.7+ or 3.3.7+ or 3.4+. " \
+        "See: https://github.com/socketry/async/issues/424"
+elsif ruby_version >= Gem::Version.new('3.3.0') && ruby_version < Gem::Version.new('3.3.7')
+  raise "Ruby #{RUBY_VERSION} has a known issue that causes puppeteer-ruby to hang. " \
+        "Please upgrade to Ruby 3.3.7+ or 3.4+. " \
+        "See: https://github.com/socketry/async/issues/424"
+end
 
 module Puppeteer; end
 
@@ -11,11 +26,12 @@ require 'puppeteer/geolocation'
 require 'puppeteer/viewport'
 
 # Modules
-require 'puppeteer/concurrent_ruby_utils'
+require "puppeteer/async_utils"
 require 'puppeteer/define_async_method'
 require 'puppeteer/debug_print'
 require 'puppeteer/event_callbackable'
 require 'puppeteer/if_present'
+require "puppeteer/reactor_runner"
 
 # Classes & values.
 require 'puppeteer/aria_query_handler'
@@ -37,7 +53,6 @@ require 'puppeteer/exception_details'
 require 'puppeteer/executable_path_finder'
 require 'puppeteer/execution_context'
 require 'puppeteer/file_chooser'
-require 'puppeteer/firefox_target_manager'
 require 'puppeteer/frame'
 require 'puppeteer/frame_manager'
 require 'puppeteer/http_request'
@@ -62,10 +77,11 @@ require 'puppeteer/task_manager'
 require 'puppeteer/tracing'
 require 'puppeteer/timeout_helper'
 require 'puppeteer/timeout_settings'
+require 'puppeteer/touch_handle'
 require 'puppeteer/touch_screen'
 require 'puppeteer/version'
 require 'puppeteer/wait_task'
-require 'puppeteer/web_socket'
+require 'puppeteer/web_worker'
 require 'puppeteer/web_socket_transport'
 
 # subclasses

data/puppeteer-ruby.gemspec

@@ -12,29 +12,33 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/YusukeIwaki/puppeteer-ruby'
 
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
+    git_files = `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/}) || f.include?(".git") || f.include?(".circleci") || f.start_with?("development/")
     end
+    sig_files = Dir.glob("sig/**/*.rbs")
+    git_files + sig_files
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6'
-  spec.add_dependency 'concurrent-ruby', '>= 1.1', '< 1.4'
-  spec.add_dependency 'websocket-driver', '>= 0.6.0'
+  spec.required_ruby_version = '>= 3.2'
+  spec.add_dependency "async", ">= 2.35.1", "< 3.0"
+  spec.add_dependency "async-http", ">= 0.60", "< 1.0"
+  spec.add_dependency "async-websocket", ">= 0.27", "< 1.0"
+  spec.add_dependency 'base64'
   spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'chunky_png'
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 13.1.0'
-  spec.add_development_dependency 'rollbar'
-  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'rake', '~> 13.3.1'
+  spec.add_development_dependency 'rspec', '~> 3.13.2'
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.50.0'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'sinatra', '< 4.0.0'
+  spec.add_development_dependency 'rbs-inline'
+  spec.add_development_dependency 'rubocop', '~> 1.82.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.9.0'
+  spec.add_development_dependency 'sinatra', '< 5.0.0'
+  spec.add_development_dependency 'steep'
   spec.add_development_dependency 'webrick'
-  spec.add_development_dependency 'yard'
 end

data/sig/_external.rbs

@@ -0,0 +1,8 @@
+module Async
+  class Promise[T]
+    def wait: () -> T
+    def resolved?: () -> bool
+    def resolve: (T value) -> void
+    def reject: (untyped error) -> void
+  end
+end