playwright-ruby-client 1.57.0 → 1.59.0

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/console_message_impl.rb

@@ -25,5 +25,9 @@ module Playwright
     def location
       @event['location']
     end
+
+    def timestamp
+      @event['timestamp']
+    end
   end
 end

data/lib/playwright/disposable.rb

@@ -0,0 +1,11 @@
+module Playwright
+  class Disposable
+    def initialize(impl)
+      @impl = impl
+    end
+
+    def dispose
+      @impl.dispose
+    end
+  end
+end

data/lib/playwright/har_router.rb

@@ -53,9 +53,10 @@ module Playwright
         # test when HAR was recorded but we'd abort it immediately.
         return if response['status'] == -1
 
+        headers = merge_har_response_headers(response['headers'])
         route.fulfill(
           status: response['status'],
-          headers: response['headers'].map { |header| [header['name'], header['value']] }.to_h,
+          headers: headers,
           body: Base64.strict_decode64(response['body']),
         )
       else
@@ -82,6 +83,20 @@ module Playwright
       page.once(Events::Page::Close, method(:dispose))
     end
 
+    private def merge_har_response_headers(headers)
+      headers.each_with_object({}) do |header, merged|
+        name = header['name']
+        value = header['value']
+
+        if name.casecmp('set-cookie').zero?
+          key = merged.keys.find { |existing| existing.casecmp('set-cookie').zero? } || name
+          merged[key] = merged[key] ? "#{merged[key]}\n#{value}" : value
+        else
+          merged[name] = value
+        end
+      end
+    end
+
     def dispose
       @local_utils.async_har_close(@har_id)
     end

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/locator_assertions_impl.rb

@@ -21,7 +21,7 @@ module Playwright
     private def expect_impl(expression, expect_options, expected, message, title)
       expect_options[:timeout] ||= @default_expect_timeout
       expect_options[:isNot] = @is_not
-      message.gsub!("expected to", "not expected to") if @is_not
+      message = message.gsub("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
       result = @locator.expect(expression, expect_options, title)

data/lib/playwright/locator_impl.rb

@@ -426,11 +426,27 @@ module Playwright
       end
     end
 
-    def aria_snapshot(timeout: nil)
-      @frame.channel.send_message_to_server('ariaSnapshot', {
+    def aria_snapshot(depth: nil, mode: nil, timeout: nil, _track: nil)
+      params = {
         selector: @selector,
         timeout: _timeout(timeout),
-      }.compact)
+      }
+      params[:depth] = depth if depth
+      params[:mode] = mode if mode
+      if _track
+        params.delete(:selector)
+        params[:track] = _track
+      end
+      result = @frame.channel.send_message_to_server_result('ariaSnapshot', params.compact)
+      result['snapshot']
+    end
+
+    def normalize
+      resolved_selector = @frame.channel.send_message_to_server('resolveSelector', { selector: @selector })
+      LocatorImpl.new(
+        frame: @frame,
+        selector: resolved_selector,
+      )
     end
 
     def scroll_into_view_if_needed(timeout: nil)

data/lib/playwright/page_assertions_impl.rb

@@ -22,7 +22,7 @@ module Playwright
     private def expect_impl(expression, expect_options, expected, message, title)
       expect_options[:timeout] ||= @default_expect_timeout
       expect_options[:isNot] = @is_not
-      message.gsub!("expected to", "not expected to") if @is_not
+      message = message.gsub("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
       result = @frame.expect(nil, expression, expect_options, title)

data/lib/playwright/screencast.rb

@@ -0,0 +1,91 @@
+require 'base64'
+
+module Playwright
+  class Screencast
+    def initialize(page)
+      @page = page
+      @started = false
+      @save_path = nil
+      @artifact = nil
+      @on_frame = nil
+      @page.send(:channel).on('screencastFrame', method(:handle_screencast_frame))
+    end
+
+    def start(path: nil, size: nil, quality: nil, &on_frame)
+      raise 'Screencast is already started' if @started
+
+      @started = true
+      @on_frame = on_frame if on_frame
+
+      params = {}
+      params[:record] = true if path
+      params[:size] = size if size
+      params[:quality] = quality if quality
+      params[:sendFrames] = true if on_frame
+
+      result = @page.send(:channel).send_message_to_server_result('screencastStart', params)
+      if result.is_a?(Hash) && result['artifact']
+        @artifact = ChannelOwners::Artifact.from(result['artifact'])
+        @save_path = path
+      end
+
+      DisposableStub.new { stop }
+    end
+
+    def stop
+      return unless @started
+
+      @started = false
+      @on_frame = nil
+      @page.send(:channel).send_message_to_server('screencastStop')
+
+      if @save_path && @artifact
+        @artifact.save_as(@save_path)
+      end
+      @artifact = nil
+      @save_path = nil
+    end
+
+    def show_overlay(html, duration: nil)
+      params = { html: html }
+      params[:duration] = duration if duration
+      result = @page.send(:channel).send_message_to_server_result('screencastShowOverlay', params)
+      overlay_id = result['id'] if result.is_a?(Hash)
+      DisposableStub.new {
+        @page.send(:channel).send_message_to_server('screencastRemoveOverlay', id: overlay_id) if overlay_id
+      }
+    end
+
+    def show_chapter(title, description: nil, duration: nil)
+      params = { title: title }
+      params[:description] = description if description
+      params[:duration] = duration if duration
+      @page.send(:channel).send_message_to_server('screencastChapter', params)
+    end
+
+    def show_actions(duration: nil, fontSize: nil, position: nil)
+      params = {}
+      params[:duration] = duration if duration
+      params[:fontSize] = fontSize if fontSize
+      params[:position] = position if position
+      @page.send(:channel).send_message_to_server('screencastShowActions', params)
+      DisposableStub.new { hide_actions }
+    end
+
+    def hide_actions
+      @page.send(:channel).send_message_to_server('screencastHideActions')
+    end
+
+    def show_overlays
+      @page.send(:channel).send_message_to_server('screencastSetOverlayVisible', visible: true)
+    end
+
+    def hide_overlays
+      @page.send(:channel).send_message_to_server('screencastSetOverlayVisible', visible: false)
+    end
+
+    private def handle_screencast_frame(event)
+      @on_frame&.call(Base64.strict_decode64(event['data']))
+    end
+  end
+end

data/lib/playwright/utils.rb

@@ -1,6 +1,22 @@
 require 'base64'
 
 module Playwright
+  class DisposableStub
+    def initialize(&block)
+      @block = block
+    end
+
+    def dispose
+      return unless @block
+
+      block = @block
+      @block = nil
+      block.call
+    rescue TargetClosedError
+      nil
+    end
+  end
+
   module Utils
     module PrepareBrowserContextOptions
       # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
@@ -19,6 +35,9 @@ module Playwright
           if params[:record_video_size]
             params[:recordVideo][:size] = params.delete(:record_video_size)
           end
+          if params[:record_video_show_actions]
+            params[:recordVideo][:showActions] = params.delete(:record_video_show_actions)
+          end
         end
         if params[:storageState].is_a?(String)
           params[:storageState] = JSON.parse(File.read(params[:storageState]))

data/lib/playwright/version.rb

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

data/lib/playwright/video.rb

@@ -1,9 +1,11 @@
 module Playwright
   class Video
-    def initialize(page)
+    def initialize(page, artifact: nil)
       @page = page
       @artifact = Concurrent::Promises.resolvable_future
-      if @page.closed?
+      if artifact
+        @artifact.fulfill(artifact)
+      elsif @page.closed?
         on_page_closed
       else
         page.once('close', -> { on_page_closed })
@@ -16,9 +18,9 @@ module Playwright
       end
     end
 
-    # called only from Page#on_video via send(:set_artifact, artifact)
+    # called only from Page with send(:set_artifact, artifact)
     private def set_artifact(artifact)
-      @artifact.fulfill(artifact)
+      @artifact.fulfill(artifact) unless @artifact.resolved?
     end
 
     def path

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.rb

@@ -20,6 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/disposable'
 require 'playwright/har_router'
 require 'playwright/raw_headers'
 require 'playwright/route_handler'
@@ -28,6 +29,7 @@ require 'playwright/timeout_settings'
 require 'playwright/transport'
 require 'playwright/url_matcher'
 require 'playwright/version'
+require 'playwright/screencast'
 require 'playwright/video'
 require 'playwright/waiter'
 

data/lib/playwright_api/android.rb

@@ -21,7 +21,7 @@ module Playwright
     #
     # This methods attaches Playwright to an existing Android device.
     # Use [`method: Android.launchServer`] to launch a new Android server instance.
-    def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
+    def connect(endpoint, headers: nil, slowMo: nil, timeout: nil)
       raise NotImplementedError.new('connect is not implemented yet.')
     end
 
@@ -43,12 +43,6 @@ module Playwright
       wrap_impl(@impl.set_default_navigation_timeout(unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -61,6 +55,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/android_device.rb

@@ -194,20 +194,14 @@ module Playwright
       raise NotImplementedError.new('web_views is not implemented yet.')
     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)))
-    end
-
     # @nodoc
     def should_close_connection_on_close!
       wrap_impl(@impl.should_close_connection_on_close!)
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    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 --
@@ -222,6 +216,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/api_request_context.rb

@@ -286,12 +286,6 @@ module Playwright
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -304,6 +298,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser.rb

@@ -172,6 +172,12 @@ module Playwright
       wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), clientCertificates: unwrap_impl(clientCertificates), colorScheme: unwrap_impl(colorScheme), contrast: unwrap_impl(contrast), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
+    #
+    # Binds the browser to a named pipe or web socket, making it available for other clients to connect to.
+    def bind(title, host: nil, port: nil, workspaceDir: nil)
+      raise NotImplementedError.new('bind is not implemented yet.')
+    end
+
     #
     # **NOTE**: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be found [here](./class-tracing).
     #
@@ -197,18 +203,18 @@ module Playwright
       wrap_impl(@impl.stop_tracing)
     end
 
+    #
+    # Unbinds the browser server previously bound with [`method: Browser.bind`].
+    def unbind
+      raise NotImplementedError.new('unbind is not implemented yet.')
+    end
+
     #
     # Returns the browser version.
     def version
       wrap_impl(@impl.version)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -221,6 +227,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end