playwright-ruby-client 1.20.2 → 1.21.0

data/lib/playwright/channel_owners/browser_context.rb

@@ -367,5 +367,13 @@ module Playwright
     private def base_url
       @options[:baseURL]
     end
+
+    # called from InputFiles
+    # @param name [string]
+    # @return [WritableStream]
+    private def create_temp_file(name)
+      result = @channel.send_message_to_server('createTempFile', name: name)
+      ChannelOwners::WritableStream.from(result)
+    end
   end
 end

data/lib/playwright/channel_owners/element_handle.rb

@@ -205,9 +205,14 @@ module Playwright
       end
 
       def set_input_files(files, noWaitAfter: nil, timeout: nil)
-        file_payloads = InputFiles.new(files).as_params
-        params = { files: file_payloads, noWaitAfter: noWaitAfter, timeout: timeout }.compact
-        @channel.send_message_to_server('setInputFiles', params)
+        frame = owner_frame
+        unless frame
+          raise 'Cannot set input files to detached element'
+        end
+
+        method_name, params = InputFiles.new(frame.page.context, files).as_method_and_params
+        params.merge!({ noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+        @channel.send_message_to_server(method_name, params)
 
         nil
       end
@@ -282,18 +287,22 @@ module Playwright
 
       def screenshot(
         animations: nil,
+        caret: nil,
         mask: nil,
         omitBackground: nil,
         path: nil,
         quality: nil,
+        scale: nil,
         timeout: nil,
         type: nil)
 
         params = {
           animations: animations,
+          caret: caret,
           omitBackground: omitBackground,
           path: path,
           quality: quality,
+          scale: scale,
           timeout: timeout,
           type: type,
         }.compact

data/lib/playwright/channel_owners/frame.rb

@@ -487,15 +487,14 @@ module Playwright
     end
 
     def set_input_files(selector, files, noWaitAfter: nil, strict: nil, timeout: nil)
-      file_payloads = InputFiles.new(files).as_params
-      params = {
-        files: file_payloads,
+      method_name, params = InputFiles.new(page.context, files).as_method_and_params
+      params.merge!({
         selector: selector,
         noWaitAfter: noWaitAfter,
         strict: strict,
         timeout: timeout,
-      }.compact
-      @channel.send_message_to_server('setInputFiles', params)
+      }.compact)
+      @channel.send_message_to_server(method_name, params)
 
       nil
     end

data/lib/playwright/channel_owners/page.rb

@@ -408,15 +408,17 @@ module Playwright
     end
 
     def screenshot(
-      path: nil,
-      type: nil,
-      quality: nil,
-      fullPage: nil,
-      clip: nil,
-      omitBackground: nil,
       animations: nil,
+      caret: nil,
+      clip: nil,
+      fullPage: nil,
       mask: nil,
-      timeout: nil)
+      omitBackground: nil,
+      path: nil,
+      quality: nil,
+      scale: nil,
+      timeout: nil,
+      type: nil)
 
       params = {
         type: type,
@@ -425,6 +427,8 @@ module Playwright
         clip: clip,
         omitBackground: omitBackground,
         animations: animations,
+        caret: caret,
+        scale: scale,
         timeout: timeout,
       }.compact
       if mask.is_a?(Enumerable)

data/lib/playwright/channel_owners/writable_stream.rb

@@ -0,0 +1,14 @@
+require 'base64'
+
+module Playwright
+  define_channel_owner :WritableStream do
+    # @param readable [File|IO]
+    def write(readable, bufsize = 1048576)
+      while buf = readable.read(bufsize)
+        binary = Base64.strict_encode64(buf)
+        @channel.send_message_to_server('write', binary: binary)
+      end
+      @channel.send_message_to_server('close')
+    end
+  end
+end

data/lib/playwright/input_files.rb

@@ -2,18 +2,64 @@ require 'base64'
 
 module Playwright
   class InputFiles
-    def initialize(files)
-      @params = convert(files)
+    def initialize(context, files)
+      @context = context
+      if files.is_a?(Enumerable)
+        @files = files
+      else
+        @files = [files]
+      end
     end
 
-    def as_params
-      @params
+    def as_method_and_params
+      if has_large_file?
+        ['setInputFilePaths', params_for_set_input_file_paths]
+      else
+        ['setInputFiles', params_for_set_input_files]
+      end
     end
 
-    private def convert(files)
-      return convert([files]) unless files.is_a?(Array)
+    private def has_large_file?
+      max_bufsize = 1024 * 1024 # 1MB
 
-      files.map do |file|
+      @files.any? do |file|
+        case file
+        when String
+          File::Stat.new(file).size > max_bufsize
+        when File
+          file.stat.size > max_bufsize
+        else
+          raise_argument_error
+        end
+      end
+    end
+
+    private def params_for_set_input_file_paths
+      writable_streams = @files.map do |file|
+        case file
+        when String
+          writable_stream = @context.send(:create_temp_file, File.basename(file))
+
+          File.open(file, 'rb') do |file|
+            writable_stream.write(file)
+          end
+
+          writable_stream.channel
+        when File
+          writable_stream = @context.send(:create_temp_file, File.basename(file.path))
+          writable_stream.write(file)
+
+          writable_stream.channel
+        else
+          raise_argument_error
+        end
+      end
+
+      { streams: writable_streams }
+    end
+
+    private def params_for_set_input_files
+      file_payloads = @files.map do |file|
         case file
         when String
           {
@@ -26,9 +72,15 @@ module Playwright
             buffer: Base64.strict_encode64(file.read),
           }
         else
-          raise ArgumentError.new('file must be a String or File.')
+          raise_argument_error
         end
       end
+
+      { files: file_payloads }
+    end
+
+    private def raise_argument_error
+      raise ArgumentError.new('file must be a String or File.')
     end
   end
 end

data/lib/playwright/locator_impl.rb

@@ -314,19 +314,24 @@ module Playwright
 
     def screenshot(
           animations: nil,
+          caret: nil,
           mask: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
+          scale: nil,
           timeout: nil,
           type: nil)
+
       with_element(timeout: timeout) do |handle, options|
         handle.screenshot(
           animations: animations,
+          caret: caret,
           mask: mask,
           omitBackground: omitBackground,
           path: path,
           quality: quality,
+          scale: scale,
           timeout: options[:timeout],
           type: type)
       end

data/lib/playwright/transport.rb

@@ -110,12 +110,22 @@ module Playwright
 
     def debug_send_message(message)
       metadata = message.delete(:metadata)
-      puts "\x1b[33mSEND>\x1b[0m#{message}"
+      puts "\x1b[33mSEND>\x1b[0m#{shorten_double_quoted_string(message)}"
       message[:metadata] = metadata
     end
 
     def debug_recv_message(message)
-      puts "\x1b[33mRECV>\x1b[0m#{message}"
+      puts "\x1b[33mRECV>\x1b[0m#{shorten_double_quoted_string(message)}"
+    end
+
+    def shorten_double_quoted_string(message, maxlen: 512)
+      message.to_s.gsub(/"([^"]+)"/) do |str|
+        if $1.length > maxlen
+          "\"#{$1[0...maxlen]}...\""
+        else
+          str
+        end
+      end
     end
   end
 end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.20.2'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.20.2'
+  VERSION = '1.21.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.21.1'
 end

data/lib/playwright_api/accessibility.rb

@@ -35,7 +35,8 @@ module Playwright
     #         return node
     #     for child in (node.get("children") or []):
     #         found_node = find_focused_node(child)
-    #         return found_node
+    #         if (found_node)
+    #             return found_node
     #     return None
     #
     # snapshot = page.accessibility.snapshot()

data/lib/playwright_api/android.rb

@@ -26,8 +26,8 @@ module Playwright
   class Android < PlaywrightApi
 
     # Returns the list of detected Android devices.
-    def devices(port: nil)
-      wrap_impl(@impl.devices(port: unwrap_impl(port)))
+    def devices(omitDriverInstall: nil, port: nil)
+      wrap_impl(@impl.devices(omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
     end
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
@@ -36,12 +36,6 @@ module Playwright
     end
     alias_method :default_timeout=, :set_default_timeout
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -54,6 +48,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/android_device.rb

@@ -169,12 +169,6 @@ module Playwright
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -187,6 +181,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/api_request.rb

@@ -1,7 +1,7 @@
 module Playwright
-  # Exposes API that can be used for the Web API testing. Each Playwright browser context has a APIRequestContext instance
-  # attached which shares cookies with the page context. Its also possible to create a new APIRequestContext instance
-  # manually. For more information see [here](./class-apirequestcontext).
+  # Exposes API that can be used for the Web API testing. This class is used for creating `APIRequestContext` instance which
+  # in turn can be used for sending web requests. An instance of this class can be obtained via
+  # [`property: Playwright.request`]. For more information see `APIRequestContext`.
   class APIRequest < PlaywrightApi
 
     # Creates new instances of `APIRequestContext`.

data/lib/playwright_api/api_request_context.rb

@@ -1,9 +1,22 @@
 module Playwright
   # This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
-  # environment or the service to your e2e test. When used on `Page` or a `BrowserContext`, this API will automatically use
-  # the cookies from the corresponding `BrowserContext`. This means that if you log in using this API, your e2e test will be
+  # environment or the service to your e2e test.
+  #
+  # Each Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with the
+  # browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`]. It is also
+  # possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`].
+  #
+  # **Cookie management**
+  #
+  # `APIRequestContext` retuned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie storage
+  # with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values from the
+  # browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext` cookies
+  # and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
   # logged in and vice versa.
   #
+  # If you want API requests to not interfere with the browser cookies you shoud create a new `APIRequestContext` by calling
+  # [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.
+  #
   # ```python sync
   # import os
   # from playwright.sync_api import sync_playwright
@@ -171,12 +184,6 @@ module Playwright
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -189,6 +196,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser.rb

@@ -166,12 +166,6 @@ module Playwright
       wrap_impl(@impl.version)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -184,6 +178,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_context.rb

@@ -376,6 +376,11 @@ module Playwright
       wrap_impl(@impl.pause)
     end
 
+    # @nodoc
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def enable_debug_console!
       wrap_impl(@impl.enable_debug_console!)
@@ -391,17 +396,6 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -414,6 +408,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_type.rb

@@ -18,12 +18,12 @@ module Playwright
   # ```
   class BrowserType < PlaywrightApi
 
-    # This methods attaches Playwright to an existing browser instance.
+    # This method attaches Playwright to an existing browser instance.
     def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
       raise NotImplementedError.new('connect is not implemented yet.')
     end
 
-    # This methods attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
+    # This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
     #
     # The default browser context is accessible via [`method: Browser.contexts`].
     #
@@ -146,12 +146,6 @@ module Playwright
       wrap_impl(@impl.name)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -164,6 +158,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/cdp_session.rb

@@ -33,12 +33,6 @@ module Playwright
       wrap_impl(@impl.send_message(unwrap_impl(method), params: unwrap_impl(params)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -51,6 +45,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/console_message.rb

@@ -1,5 +1,24 @@
 module Playwright
-  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event.
+  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event. For each console messages logged
+  # in the page there will be corresponding event in the Playwright context.
+  #
+  # ```python sync
+  # # Listen for all console logs
+  # page.on("console", lambda msg: print(msg.text))
+  #
+  # # Listen for all console events and handle errors
+  # page.on("console", lambda msg: print(f"error: {msg.text}") if msg.type == "error" else None)
+  #
+  # # Get the next console log
+  # with page.expect_console_message() as msg_info:
+  #     # Issue console.log inside the page
+  #     page.evaluate("console.log('hello', 42, { foo: 'bar' })")
+  # msg = msg_info.value
+  #
+  # # Deconstruct print arguments
+  # msg.args[0].json_value() # hello
+  # msg.args[1].json_value() # 42
+  # ```
   class ConsoleMessage < PlaywrightApi
 
     # List of arguments passed to a `console` function call. See also [`event: Page.console`].
@@ -23,12 +42,6 @@ module Playwright
       wrap_impl(@impl.type)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -41,6 +54,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/dialog.rb

@@ -58,12 +58,6 @@ module Playwright
       wrap_impl(@impl.accept_async(promptText: unwrap_impl(promptText)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -76,6 +70,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end