playwright-ruby-client 1.57.0 → 1.57.2.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430aa6a1bab67d9edca2cce8f72c76578402ec3aab93f296366335d23894d3dd
-  data.tar.gz: 0efe7aba9e4c2e45f6374c957dad31630e66157124f4b1b5dc2589815d39e6fc
+  metadata.gz: 6d2a03c73551065e1c8bf121c3784103fb51b5dd4d9fd3b8f63cb2e86907369a
+  data.tar.gz: 7a66180bf3f8eae379ae8a4cbd5e1d67d8531cdfc0689719cf96524f294c5b89
 SHA512:
-  metadata.gz: 5d19738002e6edef932c3eba936a99ffc3b54d805640a806cb3e255542d56b72be7526cf69c6752ed409c1337899f9c132494335c76b0231601c5cd7a596a677
-  data.tar.gz: 5864d506cb7f6cfc4d0a35a65900241ca7a686f2b5e59716f16e4d4f588e832153bcff19bf71fae82bda9b91e55a7c9ee1f974e33d1541ad1a49e78a51e4b341
+  metadata.gz: 7ec32a794ca503b5d95c147834bbd7dd0b0e6c4b8b803df15c35cbe6f2044062cbc709eab9641a55da9aff084f549b98296ffe64d20a44e0ad2a41099e521927
+  data.tar.gz: 6bfce7e393d7ab498639dca2342dfe3434b87ce0bee462b7e8c42017965ff9512e1d232de2126de0b92983dc0eb9faa1c084283eac1521b2bceb4a2d8b152be3

data/documentation/docs/article/guides/rails_integration.md

@@ -43,9 +43,9 @@ If Playwright is running in an independent container, with docker-compose.yaml c
 
 ```
   playwright: # this is our PLAYWRIGHT_HOST value
-    image: mcr.microsoft.com/playwright:v1.56.1-noble
+    image: mcr.microsoft.com/playwright:v1.57.0-noble
     command: >
-      /bin/sh -c "npx -y playwright@1.56.1 run-server --port 3000 --host 0.0.0.0 --path /ws"
+      /bin/sh -c "npx -y playwright@1.57.0 run-server --port 3000 --host 0.0.0.0 --path /ws"
     init: true
     restart: unless-stopped
 ```

data/lib/playwright/channel_owners/api_request_context.rb

@@ -1,5 +1,5 @@
 require 'base64'
-require 'cgi'
+require 'cgi/escape'
 
 module Playwright
   define_channel_owner :APIRequestContext do
@@ -197,7 +197,7 @@ module Playwright
     end
 
     private def query_string_to_array(query_string)
-      params = CGI.parse(query_string)
+      params = cgi_parse(query_string)
 
       params.map do |key, values|
         values.map do |value|
@@ -206,6 +206,28 @@ module Playwright
       end.flatten
     end
 
+    # https://bugs.ruby-lang.org/issues/21258
+    # CGI.parse is defined in 'cgi' library.
+    # But it produces an error in Ruby 2.4 environment: undefined method `delete_prefix' for "CONTENT_LENGTH":String
+    # So we implement our own version of CGI.parse here.
+    private def cgi_parse(query)
+      # https://github.com/ruby/cgi/blob/master/lib/cgi/core.rb#L396
+      params = {}
+
+      query.split(/[&;]/).each do |pairs|
+        key, value = pairs.split('=',2).map do |v|
+          CGI.unescape(v)
+        end
+
+        next unless key
+        params[key] ||= []
+        next unless value
+        params[key] << value
+      end
+
+      params
+    end
+
     private def object_to_array(hash)
       hash&.map do |key, value|
         { name: key, value: value.to_s }

data/lib/playwright/channel_owners/binding_call.rb

@@ -1,11 +1,45 @@
 module Playwright
   define_channel_owner :BindingCall do
+    class << self
+      def call_queue
+        @call_queue ||= Queue.new
+      end
+
+      def worker_mutex
+        @worker_mutex ||= Mutex.new
+      end
+
+      def ensure_worker
+        worker_mutex.synchronize do
+          return if @worker&.alive?
+
+          @worker = Thread.new do
+            loop do
+              job = call_queue.pop
+              begin
+                job.call
+              rescue => err
+                $stderr.write("BindingCall worker error: #{err.class}: #{err.message}\n")
+                err.backtrace&.each { |line| $stderr.write("#{line}\n") }
+              end
+            end
+          end
+        end
+      end
+    end
+
     def name
       @initializer['name']
     end
 
     def call_async(callback)
-      Thread.new(callback) { call(callback) }
+      # Binding callbacks can be fired concurrently from multiple threads.
+      # Enqueue and execute them on a single worker thread so we:
+      # - preserve the delivery order of binding calls
+      # - avoid spawning a thread per call (bursty timers create many callbacks)
+      # - keep the protocol dispatch thread unblocked
+      self.class.ensure_worker
+      self.class.call_queue << -> { call(callback) }
     end
 
     # @param callback [Proc]
@@ -31,9 +65,9 @@ module Playwright
 
       begin
         result = PlaywrightApi.unwrap(callback.call(source, *args))
-        @channel.send_message_to_server('resolve', result: JavaScript::ValueSerializer.new(result).serialize)
+        @channel.async_send_message_to_server('resolve', result: JavaScript::ValueSerializer.new(result).serialize)
       rescue => err
-        @channel.send_message_to_server('reject', error: { error: { message: err.message, name: 'Error' }})
+        @channel.async_send_message_to_server('reject', error: { error: { message: err.message, name: 'Error' }})
       end
     end
   end

data/lib/playwright/channel_owners/web_socket.rb

@@ -48,7 +48,21 @@ module Playwright
 
       waiter.reject_on_event(@parent, 'close', -> { @parent.send(:close_error_with_reason) })
       waiter.wait_for_event(self, event, predicate: predicate)
+      if @closed
+        if event == Events::WebSocket::Close
+          waiter.force_fulfill(nil)
+        else
+          waiter.force_reject(SocketClosedError.new)
+        end
+      end
       block&.call
+      if @closed
+        if event == Events::WebSocket::Close
+          waiter.force_fulfill(nil)
+        else
+          waiter.force_reject(SocketClosedError.new)
+        end
+      end
 
       waiter.result.value!
     end

data/lib/playwright/connection.rb

@@ -11,9 +11,8 @@ module Playwright
         dispatch(message)
       end
       @transport.on_driver_crashed do
-        @callbacks.each_value do |callback|
-          callback.reject(::Playwright::DriverCrashedError.new)
-        end
+        callbacks = @callbacks_mutex.synchronize { @callbacks.values }
+        callbacks.each { |callback| callback.reject(::Playwright::DriverCrashedError.new) }
         raise ::Playwright::DriverCrashedError.new
       end
       @transport.on_driver_closed do
@@ -21,8 +20,10 @@ module Playwright
       end
 
       @objects = {} # Hash[ guid => ChannelOwner ]
+      @objects_mutex = Mutex.new
       @waiting_for_object = {} # Hash[ guid => Promise<ChannelOwner> ]
       @callbacks = {} # Hash [ guid => Promise<ChannelOwner> ]
+      @callbacks_mutex = Mutex.new
       @root_object = RootChannelOwner.new(self)
       @remote = false
       @tracing_count = 0
@@ -50,10 +51,10 @@ module Playwright
 
     def cleanup(cause: nil)
       @closed_error = TargetClosedError.new(message: cause)
-      @callbacks.each_value do |callback|
-        callback.reject(@closed_error)
+      callbacks = @callbacks_mutex.synchronize do
+        @callbacks.values.tap { @callbacks.clear }
       end
-      @callbacks.clear
+      callbacks.each { |callback| callback.reject(@closed_error) }
     end
 
     def initialize_playwright
@@ -80,7 +81,7 @@ module Playwright
       with_generated_id do |id|
         # register callback promise object first.
         # @see https://github.com/YusukeIwaki/puppeteer-ruby/pull/34
-        @callbacks[id] = callback
+        @callbacks_mutex.synchronize { @callbacks[id] = callback }
 
         _metadata = {}
         frames = []
@@ -107,12 +108,12 @@ module Playwright
         begin
           @transport.send_message(message)
         rescue => err
-          @callbacks.delete(id)
+          @callbacks_mutex.synchronize { @callbacks.delete(id) }
           callback.reject(err)
           raise unless err.is_a?(Transport::AlreadyDisconnectedError)
         end
 
-        if @tracing_count > 0 && !frames.empty? && guid != 'localUtils'
+        if @tracing_count > 0 && !frames.empty? && guid != 'localUtils' && !remote?
           @local_utils.add_stack_to_tracing_no_reply(id, frames)
         end
       end
@@ -132,21 +133,24 @@ module Playwright
     # end
     # ````
     def with_generated_id(&block)
-      @last_id ||= 0
-      block.call(@last_id += 1)
+      id = @callbacks_mutex.synchronize do
+        @last_id ||= 0
+        @last_id += 1
+      end
+      block.call(id)
     end
 
     # @param guid [String]
     # @param parent [Playwright::ChannelOwner]
     # @note This method should be used internally. Accessed via .send method from Playwright::ChannelOwner, so keep private!
     def update_object_from_channel_owner(guid, parent)
-      @objects[guid] = parent
+      @objects_mutex.synchronize { @objects[guid] = parent }
     end
 
     # @param guid [String]
     # @note This method should be used internally. Accessed via .send method from Playwright::ChannelOwner, so keep private!
     def delete_object_from_channel_owner(guid)
-      @objects.delete(guid)
+      @objects_mutex.synchronize { @objects.delete(guid) }
     end
 
     def dispatch(msg)
@@ -154,7 +158,7 @@ module Playwright
 
       id = msg['id']
       if id
-        callback = @callbacks.delete(id)
+        callback = @callbacks_mutex.synchronize { @callbacks.delete(id) }
 
         unless callback
           raise "Cannot find command to respond: #{id}"
@@ -190,13 +194,13 @@ module Playwright
         return
       end
 
-      object = @objects[guid]
+      object = @objects_mutex.synchronize { @objects[guid] }
       unless object
         raise "Cannot find object to \"#{method}\": #{guid}"
       end
 
       if method == "__adopt__"
-        child = @objects[params["guid"]]
+        child = @objects_mutex.synchronize { @objects[params["guid"]] }
         unless child
           raise "Unknown new child: #{params['guid']}"
         end
@@ -243,8 +247,9 @@ module Playwright
 
       if payload.is_a?(Hash)
         guid = payload['guid']
-        if guid && @objects[guid]
-          return @objects[guid].channel
+        if guid
+          object = @objects_mutex.synchronize { @objects[guid] }
+          return object.channel if object
         end
 
         return payload.map { |k, v| [k, replace_guids_with_channels(v)] }.to_h
@@ -255,7 +260,7 @@ module Playwright
 
     # @return [Playwright::ChannelOwner|nil]
     def create_remote_object(parent_guid:, type:, guid:, initializer:)
-      parent = @objects[parent_guid]
+      parent = @objects_mutex.synchronize { @objects[parent_guid] }
       unless parent
         raise "Cannot find parent object #{parent_guid} to create #{guid}"
       end
@@ -273,7 +278,7 @@ module Playwright
           raise "Missing type #{type}"
         end
 
-      callback = @waiting_for_object.delete(guid)
+      callback = @objects_mutex.synchronize { @waiting_for_object.delete(guid) }
       callback&.fulfill(result)
 
       result

data/lib/playwright/javascript/value_serializer.rb

@@ -1,5 +1,6 @@
 require_relative './visitor_info'
 require_relative './regex'
+require 'uri'
 
 module Playwright
   module JavaScript
@@ -60,7 +61,7 @@ module Playwright
         when Time
           require 'time'
           { d: value.utc.iso8601 }
-        when URI
+        when ::URI
           { u: value.to_s }
         when Regexp
           regex_value = Regex.new(value)

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.57.0'
+  VERSION = '1.57.2.alpha1'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.57.0'
 end

data/lib/playwright/waiter.rb

@@ -10,6 +10,7 @@ module Playwright
       @event = wait_name
       @channel = channel_owner.channel
       @registered_listeners = Set.new
+      @listeners_mutex = Mutex.new
       @logs = []
       wait_for_event_info_before
     end
@@ -50,8 +51,7 @@ module Playwright
           end
         end
       }
-      emitter.on(event, listener)
-      @registered_listeners << [emitter, event, listener]
+      register_listener(emitter, event, listener)
 
       self
     end
@@ -69,16 +69,22 @@ module Playwright
     end
 
     private def cleanup
-      @registered_listeners.each do |emitter, event, listener|
+      listeners = @listeners_mutex.synchronize do
+        @registered_listeners.to_a.tap { @registered_listeners.clear }
+      end
+      listeners.each do |emitter, event, listener|
         emitter.off(event, listener)
       end
-      @registered_listeners.clear
     end
 
     def force_fulfill(result)
       fulfill(result)
     end
 
+    def force_reject(error)
+      reject(error)
+    end
+
     private def fulfill(result)
       cleanup
       return if @result.resolved?
@@ -107,12 +113,24 @@ module Playwright
           reject(err)
         end
       }
-      emitter.on(event, listener)
-      @registered_listeners << [emitter, event, listener]
+      register_listener(emitter, event, listener)
 
       self
     end
 
+    private def register_listener(emitter, event, listener)
+      emitter.on(event, listener)
+      remove_later = false
+      @listeners_mutex.synchronize do
+        if @result.resolved?
+          remove_later = true
+        else
+          @registered_listeners << [emitter, event, listener]
+        end
+      end
+      emitter.off(event, listener) if remove_later
+    end
+
     attr_reader :result
 
     def log(message)

data/lib/playwright_api/android_device.rb

@@ -195,13 +195,13 @@ module Playwright
     end
 
     # @nodoc
-    def tap_on(selector, duration: nil, timeout: nil)
-      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
+    def should_close_connection_on_close!
+      wrap_impl(@impl.should_close_connection_on_close!)
     end
 
     # @nodoc
-    def should_close_connection_on_close!
-      wrap_impl(@impl.should_close_connection_on_close!)
+    def tap_on(selector, duration: nil, timeout: nil)
+      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/browser_context.rb

@@ -464,28 +464,28 @@ module Playwright
     end
 
     # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
+    def browser=(req)
+      wrap_impl(@impl.browser=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
     end
 
     # @nodoc
-    def browser=(req)
-      wrap_impl(@impl.browser=(unwrap_impl(req)))
+    def pause
+      wrap_impl(@impl.pause)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/locator.rb

@@ -1287,13 +1287,13 @@ module Playwright
     end
 
     # @nodoc
-    def expect(expression, options, title)
-      wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
+    def resolve_selector
+      wrap_impl(@impl.resolve_selector)
     end
 
     # @nodoc
-    def resolve_selector
-      wrap_impl(@impl.resolve_selector)
+    def expect(expression, options, title)
+      wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     end
 
     # @nodoc

data/lib/playwright_api/page.rb

@@ -1828,23 +1828,23 @@ module Playwright
     end
 
     # @nodoc
-    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
+    def stop_css_coverage
+      wrap_impl(@impl.stop_css_coverage)
     end
 
     # @nodoc
-    def stop_css_coverage
-      wrap_impl(@impl.stop_css_coverage)
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
     end
 
     # @nodoc
-    def owned_context=(req)
-      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
+    def owned_context=(req)
+      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/worker.rb

@@ -64,13 +64,13 @@ module Playwright
     end
 
     # @nodoc
-    def context=(req)
-      wrap_impl(@impl.context=(unwrap_impl(req)))
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    def context=(req)
+      wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --

data/playwright.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'
+  spec.add_dependency 'base64'
   spec.add_dependency 'concurrent-ruby', '>= 1.1.6'
   spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler'
@@ -32,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'faye-websocket'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'ostruct'
   spec.add_development_dependency 'puma'
   spec.add_development_dependency 'rack', '< 3'
   spec.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.57.0
+  version: 1.57.2.alpha1
 platform: ruby
 authors:
 - YusukeIwaki
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement