playwright-ruby-client 1.18.0 → 1.19.0

data/lib/playwright/channel_owners/api_request_context.rb

@@ -1,4 +1,240 @@
+require 'base64'
+
 module Playwright
   define_channel_owner :APIRequestContext do
+    private def after_initialize
+      @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
+    end
+
+    def dispose
+      @channel.send_message_to_server('dispose')
+    end
+
+    def delete(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'DELETE',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def head(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'HEAD',
+        failOnStatusCode: failOnStatusCode,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def get(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'GET',
+        failOnStatusCode: failOnStatusCode,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def patch(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'PATCH',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def put(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'PUT',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def post(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'POST',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def fetch(
+          urlOrRequest,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          method: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+
+      if [ChannelOwners::Request, String].none? { |type| urlOrRequest.is_a?(type) }
+        raise ArgumentError.new("First argument must be either URL string or Request")
+      end
+      if [data, form, multipart].compact.count > 1
+        raise ArgumentError.new("Only one of 'data', 'form' or 'multipart' can be specified")
+      end
+
+      request = urlOrRequest.is_a?(ChannelOwners::Request) ? urlOrRequest : nil
+      headers_obj = headers || request&.headers
+      fetch_params = {
+        url: request&.url || urlOrRequest,
+        params: object_to_array(params),
+        method: method || request&.method || 'GET',
+        headers: headers_obj ? HttpHeaders.new(headers_obj).as_serialized : nil,
+      }
+
+      json_data = nil
+      form_data = nil
+      multipart_data = nil
+      post_data_buffer = nil
+      if data
+        case data
+        when String
+          if headers_obj&.any? { |key, value| key.downcase == 'content-type' && value == 'application/json' }
+            json_data = data
+          else
+            post_data_buffer = data
+          end
+        when Hash, Array, Numeric, true, false
+          json_data = data
+        else
+          raise ArgumentError.new("Unsupported 'data' type: #{data.class}")
+        end
+      elsif form
+        form_data = object_to_array(form)
+      elsif multipart
+        multipart_data = multipart.map do |name, value|
+          if file_payload?(value)
+            { name: name, file: file_payload_to_json(value) }
+          else
+            { name: name, value: value.to_s }
+          end
+        end
+      end
+
+      if !json_data && !form_data && !multipart_data
+        post_data_buffer ||= request&.post_data_buffer
+      end
+      if post_data_buffer
+        fetch_params[:postData] = Base64.strict_encode64(post_data_buffer)
+      end
+
+      fetch_params[:jsonData] = json_data
+      fetch_params[:formData] = form_data
+      fetch_params[:multipartData] = multipart_data
+      fetch_params[:timeout] = timeout
+      fetch_params[:failOnStatusCode] = failOnStatusCode
+      fetch_params[:ignoreHTTPSErrors] = ignoreHTTPSErrors
+      fetch_params.compact!
+      response = @channel.send_message_to_server('fetch', fetch_params)
+
+      APIResponseImpl.new(self, response)
+    end
+
+    private def file_payload?(value)
+      value.is_a?(Hash) &&
+        %w(name mimeType buffer).all? { |key| value.has_key?(key) || value.has_key?(key.to_sym) }
+    end
+
+    private def file_payload_to_json(payload)
+      {
+        name: payload[:name] || payload['name'],
+        mimeType: payload[:mimeType] || payload['mimeType'],
+        buffer: Base64.strict_encode64(payload[:buffer] || payload['buffer'])
+      }
+    end
+
+    private def object_to_array(hash)
+      hash&.map do |key, value|
+        { name: key, value: value.to_s }
+      end
+    end
   end
 end

data/lib/playwright/channel_owners/browser_context.rb

@@ -4,7 +4,7 @@ module Playwright
     include Utils::Errors::SafeCloseError
     attr_accessor :browser
     attr_writer :owner_page, :options
-    attr_reader :tracing
+    attr_reader :tracing, :request
 
     private def after_initialize
       @pages = Set.new
@@ -14,7 +14,9 @@ module Playwright
       @service_workers = Set.new
       @background_pages = Set.new
 
-      @tracing = TracingImpl.new(@channel, self)
+      @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
+      @request = ChannelOwners::APIRequestContext.from(@initializer['APIRequestContext'])
+
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
       @channel.once('close', ->(_) { on_close })
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
@@ -70,13 +72,19 @@ module Playwright
       wrapped_route = PlaywrightApi.wrap(route)
       wrapped_request = PlaywrightApi.wrap(request)
 
-      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
-        route.continue
-      else
+      handler_entry = @routes.find do |entry|
+        entry.match?(request.url)
+      end
+
+      if handler_entry
+        handler_entry.async_handle(wrapped_route, wrapped_request)
+
         @routes.reject!(&:expired?)
         if @routes.count == 0
           @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
         end
+      else
+        route.continue
       end
     end
 
@@ -358,10 +366,5 @@ module Playwright
     private def base_url
       @options[:baseURL]
     end
-
-    # called from Tracing
-    private def remote_connection?
-      @connection.remote?
-    end
   end
 end

data/lib/playwright/channel_owners/frame.rb

@@ -400,8 +400,8 @@ module Playwright
       nil
     end
 
-    def locator(selector, hasText: nil)
-      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector, hasText: hasText)
+    def locator(selector, hasText: nil, has: nil)
+      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector, hasText: hasText, has: has)
     end
 
     def frame_locator(selector)

data/lib/playwright/channel_owners/page.rb

@@ -98,13 +98,19 @@ module Playwright
       wrapped_route = PlaywrightApi.wrap(route)
       wrapped_request = PlaywrightApi.wrap(request)
 
-      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
-        @browser_context.send(:on_route, route, request)
-      else
+      handler_entry = @routes.find do |entry|
+        entry.match?(request.url)
+      end
+
+      if handler_entry
+        handler_entry.async_handle(wrapped_route, wrapped_request)
+
         @routes.reject!(&:expired?)
         if @routes.count == 0
           @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
         end
+      else
+        @browser_context.send(:on_route, route, request)
       end
     end
 
@@ -558,8 +564,8 @@ module Playwright
         timeout: timeout)
     end
 
-    def locator(selector, hasText: nil)
-      @main_frame.locator(selector, hasText: hasText)
+    def locator(selector, hasText: nil, has: nil)
+      @main_frame.locator(selector, hasText: hasText, has: has)
     end
 
     def frame_locator(selector)
@@ -733,6 +739,10 @@ module Playwright
       @workers.to_a
     end
 
+    def request
+      @browser_context.request
+    end
+
     def pause
       @browser_context.send(:pause)
     end

data/lib/playwright/channel_owners/route.rb

@@ -17,16 +17,30 @@ module Playwright
           contentType: nil,
           headers: nil,
           path: nil,
-          status: nil)
+          status: nil,
+          response: nil)
       params = {
         contentType: contentType,
         status: status,
       }.compact
+      option_body = body
+
+      if response
+        params[:status] ||= response.status
+        params[:headers] ||= response.headers
+
+        if !body && !path && response.is_a?(APIResponse)
+          if response.send(:_request).send(:same_connection?, self)
+            params[:fetchResponseUid] = response.send(:fetch_uid)
+          else
+            option_body = response.body
+          end
+        end
+      end
 
-      length = 0
       content =
-        if body
-          body
+        if option_body
+          option_body
         elsif path
           File.read(path)
         else

data/lib/playwright/{tracing_impl.rb → channel_owners/tracing.rb}

@@ -1,15 +1,11 @@
 module Playwright
-  define_api_implementation :TracingImpl do
-    def initialize(channel, context)
-      @channel = channel
-      @context = context
-    end
-
-    def start(name: nil, title: nil, screenshots: nil, snapshots: nil)
+  define_channel_owner :Tracing do
+    def start(name: nil, title: nil, screenshots: nil, snapshots: nil, sources: nil)
       params = {
         name: name,
         screenshots: screenshots,
         snapshots: snapshots,
+        sources: sources,
       }.compact
       @channel.send_message_to_server('tracingStart', params)
       @channel.send_message_to_server('tracingStartChunk', { title: title }.compact)
@@ -31,7 +27,7 @@ module Playwright
     private def do_stop_chunk(file_path:)
       mode = 'doNotSave'
       if file_path
-        if @context.send(:remote_connection?)
+        if @connection.remote?
           mode = 'compressTrace'
         else
           mode = 'compressTraceAndSources'

data/lib/playwright/frame_locator_impl.rb

@@ -6,12 +6,13 @@ module Playwright
       @frame_selector = frame_selector
     end
 
-    def locator(selector, hasText: nil)
+    def locator(selector, hasText: nil, has: nil)
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
         selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
         hasText: hasText,
+        has: has,
       )
     end
 

data/lib/playwright/locator_impl.rb

@@ -24,29 +24,51 @@ module Playwright
   end
 
   define_api_implementation :LocatorImpl do
-    def initialize(frame:, timeout_settings:, selector:, hasText: nil)
+    def initialize(frame:, timeout_settings:, selector:, hasText: nil, has: nil)
       @frame = frame
       @timeout_settings = timeout_settings
-      @selector =
-        case hasText
-        when Regexp
-          source = EscapeWithQuotes.new(hasText.source, '"')
-          flags = []
-          flags << 'ms' if (hasText.options & Regexp::MULTILINE) != 0
-          flags << 'i' if (hasText.options & Regexp::IGNORECASE) != 0
-          "#{selector} >> :scope:text-matches(#{source}, \"#{flags.join('')}\")"
-        when String
-          text = EscapeWithQuotes.new(hasText, '"')
-          "#{selector} >> :scope:has-text(#{text})"
-        else
-          selector
+      selector_scopes = [selector]
+
+      case hasText
+      when Regexp
+        source = EscapeWithQuotes.new(hasText.source, '"')
+        flags = []
+        flags << 'ms' if (hasText.options & Regexp::MULTILINE) != 0
+        flags << 'i' if (hasText.options & Regexp::IGNORECASE) != 0
+        selector_scopes << ":scope:text-matches(#{source}, \"#{flags.join('')}\")"
+      when String
+        text = EscapeWithQuotes.new(hasText, '"')
+        selector_scopes << ":scope:has-text(#{text})"
+      end
+
+      if has
+        unless same_frame?(has)
+          raise DifferentFrameError.new
         end
+        selector_scopes << "has=#{has.send(:selector_json)}"
+      end
+
+      @selector = selector_scopes.join(' >> ')
     end
 
     def to_s
       "Locator@#{@selector}"
     end
 
+    class DifferentFrameError < StandardError
+      def initialize
+        super('Inner "has" locator must belong to the same frame.')
+      end
+    end
+
+    private def same_frame?(other)
+      @frame == other.instance_variable_get(:@frame)
+    end
+
+    private def selector_json
+      @selector.to_json
+    end
+
     private def with_element(timeout: nil, &block)
       timeout_or_default = @timeout_settings.timeout(timeout)
       start_time = Time.now
@@ -67,6 +89,10 @@ module Playwright
       end
     end
 
+    def page
+      @frame.page
+    end
+
     def bounding_box(timeout: nil)
       with_element(timeout: timeout) do |handle|
         handle.bounding_box
@@ -180,12 +206,13 @@ module Playwright
       @frame.fill(@selector, value, strict: true, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
-    def locator(selector, hasText: nil)
+    def locator(selector, hasText: nil, has: nil)
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
         selector: "#{@selector} >> #{selector}",
         hasText: hasText,
+        has: has,
       )
     end
 

data/lib/playwright/route_handler.rb

@@ -5,7 +5,7 @@ module Playwright
         @count = count
       end
 
-      def handle
+      def increment
         return false if expired?
 
         @count = @count - 1
@@ -18,7 +18,7 @@ module Playwright
     end
 
     class StubCounter
-      def handle
+      def increment
         true
       end
 
@@ -43,14 +43,17 @@ module Playwright
         end
     end
 
-    def handle(route, request)
-      return false unless @counter.handle
+    def match?(url)
+      @url_matcher.match?(url)
+    end
+
+    def async_handle(route, request)
+      @counter.increment
 
-      if @url_matcher.match?(request.url)
+      Concurrent::Promises.future do
         @handler.call(route, request)
-        true
-      else
-        false
+      rescue => err
+        puts err, err.backtrace
       end
     end
 

data/lib/playwright/transport.rb

@@ -46,7 +46,7 @@ module Playwright
     #
     # @note This method blocks until playwright-cli exited. Consider using Thread or Future.
     def async_run
-      @stdin, @stdout, @stderr, @thread = Open3.popen3("#{@driver_executable_path} run-driver")
+      @stdin, @stdout, @stderr, @thread = Open3.popen3("#{@driver_executable_path} run-driver", { pgroup: true })
       @stdin.binmode  # Ensure Strings are written 1:1 without encoding conversion, necessary for integer values
 
       Thread.new { handle_stdout }

data/lib/playwright/version.rb

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

data/lib/playwright_api/android.rb

@@ -38,20 +38,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -176,20 +176,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/api_request.rb

@@ -0,0 +1,20 @@
+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).
+  class APIRequest < PlaywrightApi
+
+    # Creates new instances of `APIRequestContext`.
+    def new_context(
+          baseURL: nil,
+          extraHTTPHeaders: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          proxy: nil,
+          storageState: nil,
+          timeout: nil,
+          userAgent: nil)
+      raise NotImplementedError.new('new_context is not implemented yet.')
+    end
+  end
+end