playwright-ruby-client 1.31.1 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409785017cb92188415f2e06c7ed8f369cd95723a60b70dcf86b1e4e110ff07b
-  data.tar.gz: 79a75b15a818e32ec1cb2f6dda2f64b0eb0f18316373ec8c84cab208efae6593
+  metadata.gz: ebc7a6ffab254ce53486bcaf8ad642a42fbadd77f33f48598ee721935f795c98
+  data.tar.gz: bf6473ce5c3ea31bdcca4f072b68aeb4b1b49b0ffb24cc39a7d17955e5de49cf
 SHA512:
-  metadata.gz: 26e88e610f09aba2993c26866e5927ce972a9c63f50dda6b00f91d221d1925a70ee8820ecddcfa69579d29346a53e9a150e5dfa81d36f19f6c9da74d8135bb48
-  data.tar.gz: 8e25217e4425a3d3376710a872748d6acd966a1e941dbc5728bd8e63f05dd08cb04a1487fdda96cc5879db1b1e0ad2b5c8730bb0e057ca7ac416748ace60cea7
+  metadata.gz: 1e36fed96c70031d7b78ffffe1b3408251fb86b64afb634304d8fe3434b263de696e99b42cb330bb75b2f68a80683caf56e050dddf1b9ead61d97f2dd885b270
+  data.tar.gz: eb7607a301b420b0c3c587dfa562eccf459a943e425da930c7739a2faccb46888dbfeb84bd83953ef8eb1446322cdc8cd4c4e58f3ca71515999e11dfcd3ba121

data/documentation/docs/api/browser_context.md

@@ -333,7 +333,13 @@ To remove a route with its handler you can use [BrowserContext#unroute](./browse
 ## route_from_har
 
 ```
-def route_from_har(har, notFound: nil, update: nil, url: nil)
+def route_from_har(
+      har,
+      notFound: nil,
+      update: nil,
+      updateContent: nil,
+      updateMode: nil,
+      url: nil)
 ```
 
 

data/documentation/docs/api/frame.md

@@ -439,18 +439,20 @@ def get_by_label(text, exact: nil)
 ```
 
 
-Allows locating input elements by the text of the associated label.
+Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the `aria-label` attribute.
 
 **Usage**
 
-For example, this method will find the input by label text "Password" in the following DOM:
+For example, this method will find inputs by label "Username" and "Password" in the following DOM:
 
 ```html
+<input aria-label="Username">
 <label for="password-input">Password:</label>
 <input id="password-input">
 ```
 
 ```ruby
+page.get_by_label("Username").fill("john")
 page.get_by_label("Password").fill("secret")
 ```
 
@@ -777,7 +779,12 @@ Returns whether the element is [visible](https://playwright.dev/python/docs/acti
 ## locator
 
 ```
-def locator(selector, has: nil, hasText: nil)
+def locator(
+      selector,
+      has: nil,
+      hasNot: nil,
+      hasNotText: nil,
+      hasText: nil)
 ```
 
 

data/documentation/docs/api/frame_locator.md

@@ -79,18 +79,20 @@ def get_by_label(text, exact: nil)
 ```
 
 
-Allows locating input elements by the text of the associated label.
+Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the `aria-label` attribute.
 
 **Usage**
 
-For example, this method will find the input by label text "Password" in the following DOM:
+For example, this method will find inputs by label "Username" and "Password" in the following DOM:
 
 ```html
+<input aria-label="Username">
 <label for="password-input">Password:</label>
 <input id="password-input">
 ```
 
 ```ruby
+page.get_by_label("Username").fill("john")
 page.get_by_label("Password").fill("secret")
 ```
 
@@ -282,7 +284,12 @@ Returns locator to the last matching frame.
 ## locator
 
 ```
-def locator(selector, has: nil, hasText: nil)
+def locator(
+      selectorOrLocator,
+      has: nil,
+      hasNot: nil,
+      hasNotText: nil,
+      hasText: nil)
 ```
 
 

data/documentation/docs/api/locator.md

@@ -20,6 +20,12 @@ def all
 When locator points to a list of elements, returns array of locators, pointing
 to respective elements.
 
+**NOTE**: [Locator#all](./locator#all) does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.
+
+When the list of elements changes dynamically, [Locator#all](./locator#all) will produce unpredictable and flaky results.
+
+When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before calling [Locator#all](./locator#all).
+
 **Usage**
 
 ```ruby
@@ -441,7 +447,7 @@ To send fine-grained keyboard events, use [Locator#type](./locator#type).
 ## filter
 
 ```
-def filter(has: nil, hasText: nil)
+def filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil)
 ```
 
 
@@ -532,18 +538,20 @@ def get_by_label(text, exact: nil)
 ```
 
 
-Allows locating input elements by the text of the associated label.
+Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the `aria-label` attribute.
 
 **Usage**
 
-For example, this method will find the input by label text "Password" in the following DOM:
+For example, this method will find inputs by label "Username" and "Password" in the following DOM:
 
 ```html
+<input aria-label="Username">
 <label for="password-input">Password:</label>
 <input id="password-input">
 ```
 
 ```ruby
+page.get_by_label("Username").fill("john")
 page.get_by_label("Password").fill("secret")
 ```
 
@@ -911,7 +919,12 @@ banana = page.get_by_role("listitem").last
 ## locator
 
 ```
-def locator(selector, has: nil, hasText: nil)
+def locator(
+      selectorOrLocator,
+      has: nil,
+      hasNot: nil,
+      hasNotText: nil,
+      hasText: nil)
 ```
 
 
@@ -934,6 +947,29 @@ Returns locator to the n-th matching element. It's zero based, `nth(0)` selects
 banana = page.get_by_role("listitem").nth(2)
 ```
 
+## or
+
+```
+def or(locator)
+```
+
+
+Creates a locator that matches either of the two locators.
+
+**Usage**
+
+Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a "New email" button, or a dialog and act accordingly.
+
+```ruby
+new_email = page.get_by_role("button", name: "New")
+dialog = page.get_by_text("Confirm security settings")
+new_email.or(dialog).wait_for(state: 'visible')
+if dialog.visible?
+  page.get_by_role("button", name: "Dismiss").click
+end
+new_email.click
+```
+
 ## page
 
 ```

data/documentation/docs/api/page.md

@@ -651,18 +651,20 @@ def get_by_label(text, exact: nil)
 ```
 
 
-Allows locating input elements by the text of the associated label.
+Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the `aria-label` attribute.
 
 **Usage**
 
-For example, this method will find the input by label text "Password" in the following DOM:
+For example, this method will find inputs by label "Username" and "Password" in the following DOM:
 
 ```html
+<input aria-label="Username">
 <label for="password-input">Password:</label>
 <input id="password-input">
 ```
 
 ```ruby
+page.get_by_label("Username").fill("john")
 page.get_by_label("Password").fill("secret")
 ```
 
@@ -1013,7 +1015,12 @@ Returns whether the element is [visible](https://playwright.dev/python/docs/acti
 ## locator
 
 ```
-def locator(selector, has: nil, hasText: nil)
+def locator(
+      selector,
+      has: nil,
+      hasNot: nil,
+      hasNotText: nil,
+      hasText: nil)
 ```
 
 
@@ -1256,7 +1263,13 @@ To remove a route with its handler you can use [Page#unroute](./page#unroute).
 ## route_from_har
 
 ```
-def route_from_har(har, notFound: nil, update: nil, url: nil)
+def route_from_har(
+      har,
+      notFound: nil,
+      update: nil,
+      updateContent: nil,
+      updateMode: nil,
+      url: nil)
 ```
 
 

data/documentation/docs/api/route.md

@@ -122,6 +122,7 @@ def fetch(
       maxRedirects: nil,
       method: nil,
       postData: nil,
+      timeout: nil,
       url: nil)
 ```
 

data/documentation/docs/api/tracing.md

@@ -44,7 +44,7 @@ context.tracing.stop(path: 'trace.zip')
 ## start_chunk
 
 ```
-def start_chunk(title: nil)
+def start_chunk(name: nil, title: nil)
 ```
 
 

data/documentation/docs/include/api_coverage.md

@@ -463,6 +463,7 @@
 * last
 * locator
 * nth
+* or
 * page
 * press
 * screenshot

data/lib/playwright/channel.rb

@@ -67,6 +67,7 @@ module Playwright
 
     private def build_metadata_payload_from(api_name, stacks)
       {
+        wallTime: (Time.now.to_f * 1000).to_i,
         apiName: api_name,
         stack: stacks.map do |loc|
           { file: loc.absolute_path || '', line: loc.lineno, function: loc.label }

data/lib/playwright/channel_owners/browser.rb

@@ -32,10 +32,7 @@ module Playwright
 
       resp = @channel.send_message_to_server('newContext', params.compact)
       context = ChannelOwners::BrowserContext.from(resp)
-      @contexts << context
-      context.browser = self
-      context.options = params
-      context.send(:update_browser_type, @browser_type)
+      @browser_type.send(:did_create_context, context, params)
       return context unless block
 
       begin
@@ -62,9 +59,6 @@ module Playwright
 
     private def update_browser_type(browser_type)
       @browser_type = browser_type
-      @contexts.each do |context|
-        context.send(:update_browser_type, browser_type)
-      end
     end
 
     def close
@@ -110,7 +104,7 @@ module Playwright
       @closed_or_closing = true
     end
 
-    # called from BrowserType#connectOverCDP
+    # called from BrowserContext#initialize, BrowserType#connectOverCDP
     private def add_context(context)
       @contexts << context
     end

data/lib/playwright/channel_owners/browser_context.rb

@@ -9,6 +9,10 @@ module Playwright
     attr_reader :tracing, :request
 
     private def after_initialize
+      if @parent.is_a?(ChannelOwners::Browser)
+        @browser = @parent
+        @browser.send(:add_context, self)
+      end
       @pages = Set.new
       @routes = []
       @bindings = {}
@@ -62,14 +66,15 @@ module Playwright
       @closed_promise = Concurrent::Promises.resolvable_future
     end
 
-    private def update_browser_type(browser_type)
-      @browser_type = browser_type
+    private def update_options(context_options:, browser_options:)
+      @options = context_options
       if @options[:recordHar]
         @har_recorders[''] = {
           path: @options[:recordHar][:path],
           content: @options[:recordHar][:content]
         }
       end
+      @tracing.send(:update_traces_dir, browser_options[:tracesDir])
     end
 
     private def on_page(page)
@@ -290,12 +295,12 @@ module Playwright
       update_interception_patterns
     end
 
-    private def record_into_har(har, page, notFound:, url:)
+    private def record_into_har(har, page, notFound:, url:, updateContent:, updateMode:)
       params = {
         options: prepare_record_har_options(
           record_har_path: har,
-          record_har_content: "attach",
-          record_har_mode: "minimal",
+          record_har_content: updateContent || 'attach',
+          record_har_mode: updateMode || 'minimal',
           record_har_url_filter: url,
         )
       }
@@ -306,9 +311,9 @@ module Playwright
       @har_recorders[har_id] = { path: har, content: 'attach' }
     end
 
-    def route_from_har(har, notFound: nil, update: nil, url: nil)
+    def route_from_har(har, notFound: nil, update: nil, updateContent: nil, updateMode: nil, url: nil)
       if update
-        record_into_har(har, nil, notFound: notFound, url: url)
+        record_into_har(har, nil, notFound: notFound, url: url, updateContent: updateContent, updateMode: updateMode)
         return
       end
 

data/lib/playwright/channel_owners/browser_type.rb

@@ -13,7 +13,7 @@ module Playwright
     def launch(options, &block)
       resp = @channel.send_message_to_server('launch', options.compact)
       browser = ChannelOwners::Browser.from(resp)
-      browser.send(:update_browser_type, self)
+      did_launch_browser(browser)
       return browser unless block
 
       begin
@@ -30,8 +30,7 @@ module Playwright
 
       resp = @channel.send_message_to_server('launchPersistentContext', params.compact)
       context = ChannelOwners::Browser.from(resp)
-      context.options = params
-      context.send(:update_browser_type, self)
+      did_create_context(context, params, params)
       return context unless block
 
       begin
@@ -57,11 +56,11 @@ module Playwright
 
       result = @channel.send_message_to_server_result('connectOverCDP', params)
       browser = ChannelOwners::Browser.from(result['browser'])
-      browser.send(:update_browser_type, self)
+      did_launch_browser(browser)
 
       if result['defaultContext']
-        context = ChannelOwners::BrowserContext.from(result['defaultContext'])
-        browser.send(:add_context, context)
+        default_context = ChannelOwners::BrowserContext.from(result['defaultContext'])
+        did_create_context(default_context)
       end
 
       if block
@@ -74,5 +73,13 @@ module Playwright
         browser
       end
     end
+
+    private def did_create_context(context, context_options = {}, browser_options = {})
+      context.send(:update_options, context_options: context_options, browser_options: browser_options)
+    end
+
+    private def did_launch_browser(browser)
+      browser.send(:update_browser_type, self)
+    end
   end
 end

data/lib/playwright/channel_owners/frame.rb

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

data/lib/playwright/channel_owners/local_utils.rb

@@ -1,12 +1,7 @@
 module Playwright
   define_channel_owner :LocalUtils do
     # @param zip_file [String]
-    # @param name_value_array [Array<Hash<{name: string, value: string}>>]
-    def zip(zip_file, name_value_array)
-      params = {
-        zipFile: zip_file,
-        entries: name_value_array,
-      }
+    def zip(params)
       @channel.send_message_to_server('zip', params)
       nil
     end
@@ -39,5 +34,22 @@ module Playwright
     def har_unzip(zip_file, har_file)
       @channel.send_message_to_server('harUnzip', zipFile: zip_file, harFile: har_file)
     end
+
+    def tracing_started(traces_dir, trace_name)
+      params = {
+        tracesDir: traces_dir,
+        traceName: trace_name,
+      }.compact
+      @channel.send_message_to_server('tracingStarted', params)
+    end
+
+    def tracing_discarded(stacks_id)
+      @channel.send_message_to_server('traceDiscarded', stacksId: stacks_id)
+    end
+
+    def add_stack_to_tracing_no_reply(id, stack)
+      @channel.async_send_message_to_server('addStackToTracingNoReply', callData: { id: id, stack: stack })
+      nil
+    end
   end
 end

data/lib/playwright/channel_owners/page.rb

@@ -417,9 +417,9 @@ module Playwright
       update_interception_patterns
     end
 
-    def route_from_har(har, notFound: nil, update: nil, url: nil)
+    def route_from_har(har, notFound: nil, update: nil, url: nil, updateContent: nil, updateMode: nil)
       if update
-        @browser_context.send(:record_into_har, har, self, notFound: notFound, url: url)
+        @browser_context.send(:record_into_har, har, self, notFound: notFound, url: url, updateContent: updateContent, updateMode: updateMode)
         return
       end
 
@@ -614,8 +614,18 @@ module Playwright
         timeout: timeout)
     end
 
-    def locator(selector, hasText: nil, has: nil)
-      @main_frame.locator(selector, hasText: hasText, has: has)
+    def locator(
+      selector,
+      has: nil,
+      hasNot: nil,
+      hasNotText: nil,
+      hasText: nil)
+      @main_frame.locator(
+        selector,
+        has: has,
+        hasNot: hasNot,
+        hasNotText: hasNotText,
+        hasText: hasText)
     end
 
     def frame_locator(selector)

data/lib/playwright/channel_owners/request.rb

@@ -19,6 +19,7 @@ module Playwright
         responseEnd: -1,
       }
       @fallback_overrides = {}
+      @url = @initializer['url']
     end
 
     private def fallback_overrides
@@ -35,7 +36,11 @@ module Playwright
     end
 
     def url
-      @fallback_overrides[:url] || @initializer['url']
+      @fallback_overrides[:url] || @url
+    end
+
+    private def internal_url
+      @url
     end
 
     def resource_type

data/lib/playwright/channel_owners/route.rb

@@ -21,7 +21,7 @@ module Playwright
 
     def abort(errorCode: nil)
       handling_with_result(true) do
-        params = { errorCode: errorCode }.compact
+        params = { requestUrl: request.send(:internal_url), errorCode: errorCode }.compact
         # TODO _race_with_page_close
         @channel.async_send_message_to_server('abort', params)
       end
@@ -91,6 +91,7 @@ module Playwright
 
         params[:status] = option_status || 200
         params[:headers] = HttpHeaders.new(param_headers).as_serialized
+        params[:requestUrl] = request.send(:internal_url)
 
         @channel.async_send_message_to_server('fulfill', params)
       end
@@ -109,7 +110,7 @@ module Playwright
       end
     end
 
-    def fetch(headers: nil, method: nil, postData: nil, url: nil, maxRedirects: nil)
+    def fetch(headers: nil, method: nil, postData: nil, url: nil, maxRedirects: nil, timeout: nil)
       api_request_context = request.frame.page.context.request
       api_request_context.send(:_inner_fetch,
         request,
@@ -118,6 +119,7 @@ module Playwright
         method: method,
         data: postData,
         maxRedirects: maxRedirects,
+        timeout: timeout,
       )
     end
 
@@ -152,6 +154,7 @@ module Playwright
       if post_data_for_wire
         params[:postData] = post_data_for_wire
       end
+      params[:requestUrl] = request.send(:internal_url)
 
       # TODO _race_with_page_close
       @channel.async_send_message_to_server('continue', params)

data/lib/playwright/channel_owners/tracing.rb

@@ -7,12 +7,23 @@ module Playwright
         snapshots: snapshots,
         sources: sources,
       }.compact
+      @include_sources = params[:sources] || false
       @channel.send_message_to_server('tracingStart', params)
-      @channel.send_message_to_server('tracingStartChunk', { title: title }.compact)
+      trace_name = @channel.send_message_to_server('tracingStartChunk', { title: title, name: name }.compact)
+      start_collecting_stacks(trace_name)
     end
 
-    def start_chunk(title: nil)
-      @channel.send_message_to_server('tracingStartChunk', { title: title }.compact)
+    def start_chunk(title: nil, name: nil)
+      trace_name = @channel.send_message_to_server('tracingStartChunk', { title: title, name: name }.compact)
+      start_collecting_stacks(trace_name)
+    end
+
+    private def start_collecting_stacks(trace_name)
+      unless @is_tracing
+        @is_tracing = true
+        @connection.set_in_tracing(true)
+      end
+      @stacks_id = @connection.local_utils.tracing_started(@traces_dir, trace_name)
     end
 
     def stop_chunk(path: nil)
@@ -25,26 +36,61 @@ module Playwright
     end
 
     private def do_stop_chunk(file_path:)
-      mode = 'doNotSave'
-      if file_path
-        if @connection.remote?
-          mode = 'compressTrace'
-        else
-          mode = 'compressTraceAndSources'
+      if @is_tracing
+        @is_tracing = false
+        @connection.set_in_tracing(false)
+      end
+
+      unless file_path
+        # Not interested in any artifacts
+        @channel.send_message_to_server('tracingStopChunk', mode: 'discard')
+        if @stacks_id
+          @connection.local_utils.trace_discarded(@stacks_id)
         end
+
+        return
       end
 
-      result = @channel.send_message_to_server_result('tracingStopChunk', mode: mode)
-      return unless file_path # Not interested in artifacts.
-      return unless result['artifact'] # The artifact may be missing if the browser closed while stopping tracing.
+      unless @connection.remote?
+        result = @channel.send_message_to_server_result('tracingStopChunk', mode: 'entries')
+        @connection.local_utils.zip(
+          zipFile: file_path,
+          entries: result['entries'],
+          stacksId: @stacks_id,
+          mode: 'write',
+          includeSources: @include_sources,
+        )
+
+        return
+      end
 
+
+      result = @channel.send_message_to_server_result('tracingStopChunk', mode: 'archive')
+      # The artifact may be missing if the browser closed while stopping tracing.
+      unless result['artifact']
+        if @stacks_id
+          @connection.local_utils.trace_discarded(@stacks_id)
+        end
+
+        return
+      end
+
+      # Save trace to the final local file.
       artifact = ChannelOwners::Artifact.from(result['artifact'])
       artifact.save_as(file_path)
       artifact.delete
 
-      # // Add local sources to the remote trace if necessary.
-      # if (result.sourceEntries?.length)
-      #   await this._context._localUtils.zip(filePath, result.sourceEntries);
+      @connection.local_utils.zip(
+        zipFile: file_path,
+        entries: [],
+        stacksId: @stacks_id,
+        mode: 'append',
+        includeSources: @include_sources,
+      )
+    end
+
+    private def update_traces_dir(traces_dir)
+      @traces_dir = traces_dir
     end
   end
 end