playwright-ruby-client 1.18.1 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4743c153d270bd3343d7f59b53e1ef03ebecf65495804c79ef4561e5db1263ac
-  data.tar.gz: 2f5db2b025b62ebece498cce6edc8f02f85a07377dee2945fbbcfb60e6718c48
+  metadata.gz: 68d737d7d01fd92889e417be20bca72ee6247258d07dc8b18f44a1b07967a2c1
+  data.tar.gz: 18522777dc4ef3e19a9be4a17710cfdef404fc441dcf2a5a28b82138175dfebd
 SHA512:
-  metadata.gz: 36f2d941a86f2533ad494013346f68a3840e33065bf1d3021ff071f6caec635e890378eb7a88df3d096ffa85a86b037e93dae68535c0d30baacc699cb62292a5
-  data.tar.gz: 38757489faccca207351dfc8ff1d5519ee7fe329726a0024fe80fe83eb772abed986dbfcde5ad0b1cd5987a5b79666a4675cb360bb3333b1b29e4065087b2b75
+  metadata.gz: bf0887d285eabec5cf17b380d99e566f1b1399e089614adf23d99a38f0975e5f1b9fb6eb8891d67857b21945b5ad00772202caf337aeac53439407f20f5386f9
+  data.tar.gz: 95553f620063bbd52ded34d1f260a920fd82ba127868f1c85c43ac0b466ed9e93a1fce5d6319805e8f13ade1f3ad3c0aa03795be4387b3354664e26c2c1f4e00

data/documentation/docs/api/api_request_context.md

@@ -28,7 +28,17 @@ playwright.chromium.launch do |browser|
     data: { name: 'test-repo-1' },
   )
   response.ok? # => true
-  response.json['name'] # => "tes≈-repo-1"
+  response.json['name'] # => "test-repo-1"
+
+  # Delete a repository.
+  response = api_request_context.delete(
+    "/repos/YourName/test-repo-1",
+    headers: {
+      "Accept": "application/vnd.github.v3+json",
+      "Authorization": "Bearer #{API_TOKEN}",
+    },
+  )
+  response.ok? # => true
 end
 ```
 

data/documentation/docs/api/frame.md

@@ -549,7 +549,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the

data/documentation/docs/api/frame_locator.md

@@ -65,7 +65,7 @@ Returns locator to the last matching frame.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the FrameLocator's subtree.

data/documentation/docs/api/locator.md

@@ -311,7 +311,7 @@ When working with iframes, you can create a frame locator that will enter the if
 that iframe:
 
 ```ruby
-locator = page.frame_locator("text=Submit").locator("text=Submit")
+locator = page.frame_locator("iframe").locator("text=Submit")
 locator.click
 ```
 
@@ -430,7 +430,7 @@ Returns locator to the last matching element.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
@@ -443,6 +443,14 @@ def nth(index)
 
 Returns locator to the n-th matching element.
 
+## page
+
+```
+def page
+```
+
+A page this locator belongs to.
+
 ## press
 
 ```

data/documentation/docs/api/page.md

@@ -774,7 +774,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the
@@ -1491,6 +1491,9 @@ response = page.expect_response(/example.com\/resource/) do
   page.click("input")
 end
 puts response.body
+puts response.ok?
+
+page.wait_for_load_state # wait for request finished.
 
 # or with a predicate
 page.content = '<form action="https://example.com/resource"><input type="submit" /></form>'
@@ -1498,6 +1501,7 @@ response = page.expect_response(->(res) { res.url.start_with? 'https://example.c
   page.click("input")
 end
 puts response.body
+puts response.ok?
 ```
 
 

data/documentation/docs/api/route.md

@@ -45,6 +45,7 @@ def fulfill(
       contentType: nil,
       headers: nil,
       path: nil,
+      response: nil,
       status: nil)
 ```
 

data/documentation/docs/api/tracing.md

@@ -23,7 +23,12 @@ end
 ## start
 
 ```
-def start(name: nil, screenshots: nil, snapshots: nil, title: nil)
+def start(
+      name: nil,
+      screenshots: nil,
+      snapshots: nil,
+      sources: nil,
+      title: nil)
 ```
 
 Start tracing.

data/documentation/docs/include/api_coverage.md

@@ -430,6 +430,7 @@
 * last
 * locator
 * nth
+* page
 * press
 * screenshot
 * scroll_into_view_if_needed

data/lib/playwright/api_response_impl.rb

@@ -66,6 +66,10 @@ module Playwright
       @request.channel.send_message_to_server("disposeAPIResponse", fetchUid: fetch_uid)
     end
 
+    private def _request
+      @request
+    end
+
     private def fetch_uid
       @initializer['fetchUid']
     end

data/lib/playwright/channel_owner.rb

@@ -72,6 +72,10 @@ module Playwright
     private def delete_object_from_child(guid)
       @objects.delete(guid)
     end
+
+    private def same_connection?(other)
+      @connection == other.instance_variable_get(:@connection)
+    end
   end
 
   class RootChannelOwner < ChannelOwner

data/lib/playwright/channel_owners/api_request_context.rb

@@ -2,6 +2,10 @@ 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

data/lib/playwright/channel_owners/browser_context.rb

@@ -14,7 +14,7 @@ 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'])) })
@@ -72,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
 
@@ -360,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)

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,8 @@ 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")
+      popen3_args = {}
+      @stdin, @stdout, @stderr, @thread = run_driver_with_open3
       @stdin.binmode  # Ensure Strings are written 1:1 without encoding conversion, necessary for integer values
 
       Thread.new { handle_stdout }
@@ -55,6 +56,18 @@ module Playwright
 
     private
 
+    def run_driver_with_open3
+      Open3.popen3("#{@driver_executable_path} run-driver", { pgroup: true })
+    rescue ArgumentError => err
+      # Windows doesn't accept pgroup parameter.
+      # ArgumentError: wrong exec option symbol: pgroup
+      if err.message =~ /pgroup/
+        Open3.popen3("#{@driver_executable_path} run-driver")
+      else
+        raise
+      end
+    end
+
     def handle_stdout(packet_size: 32_768)
       while chunk = @stdout.read(4)
         length = chunk.unpack1('V') # unsigned 32bit, little endian

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.18.1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.1'
+  VERSION = '1.19.1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.19.2'
 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_context.rb

@@ -16,13 +16,13 @@ module Playwright
   #     # This will launch a new browser, create a context and page. When making HTTP
   #     # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
   #     # it will automatically set the cookies to the browser page and vise versa.
-  #     browser = playwright.chromium.launch()
+  #     browser = p.chromium.launch()
   #     context = browser.new_context(base_url="https://api.github.com")
   #     api_request_context = context.request
   #     page = context.new_page()
   #
   #     # Alternatively you can create a APIRequestContext manually without having a browser context attached:
-  #     # api_request_context = playwright.request.new_context(base_url="https://api.github.com")
+  #     # api_request_context = p.request.new_context(base_url="https://api.github.com")
   #
   #
   #     # Create a repository.
@@ -173,20 +173,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/browser.rb

@@ -168,20 +168,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