playwright-ruby-client 1.59.1 → 1.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8943d61bb3cd1ebe3737284e7556d8bcb4b1be154105c2bb05f8d8d77ba51aca
-  data.tar.gz: 15fdc15c33208bb8389306733807768797038d7a788c9f3e5f7465680823ebb7
+  metadata.gz: ac9256b441d66c5a19585735b23567b6dc1eedca695812ee3388f48918054970
+  data.tar.gz: 9a13c1dcfc540d7bc1120743af1806a338185a2bd6eb41331e2273425af790c6
 SHA512:
-  metadata.gz: 1787fb9a9b61c92bb3cb0adc512e18349ae2830d59914e6ac6c202361b849d20e0c09f3fef4ecfa250b90e6858ce60a381c3fe76fcb3c96fd9b42ccf548d26e0
-  data.tar.gz: b72617a5d25b592c8e3a8d54dc887a56776448be204cc7d1e901145d449b3aadca42090010978c547c8e8e1cc1f0418415624008cd60122eea3a41a4d76c1af8
+  metadata.gz: f8fae6bb376c4586a90464a2db4d06b3362a822d191456dcf5ad75f74ae67ed99462403aa4cdca4d817eb58d59ec30380a9b72c5d6cee2f5475a0fda4e2c05a8
+  data.tar.gz: b59cc6913b92826850611eab5967f72c2545549f2ac83c8268d59d6ef61152523a1fcb62759278487661369449a817222ecd514a0c066ea913b3e4607a4b0463

data/documentation/docs/api/api_request.md

@@ -4,4 +4,28 @@ sidebar_position: 10
 
 # APIRequest
 
-Not Implemented
+
+Exposes API that can be used for the Web API testing. This class is used for creating
+[APIRequestContext](./api_request_context) instance which in turn can be used for sending web requests. An instance
+of this class can be obtained via [Playwright#request](./playwright#request). For more information
+see [APIRequestContext](./api_request_context).
+
+## new_context
+
+```
+def new_context(
+      baseURL: nil,
+      clientCertificates: nil,
+      extraHTTPHeaders: nil,
+      failOnStatusCode: nil,
+      httpCredentials: nil,
+      ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
+      proxy: nil,
+      storageState: nil,
+      timeout: nil,
+      userAgent: nil)
+```
+
+
+Creates new instances of [APIRequestContext](./api_request_context).

data/documentation/docs/api/api_request_context.md

@@ -8,21 +8,21 @@ sidebar_position: 10
 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.
 
-Each Playwright browser context has associated with it [APIRequestContext](./api_request_context) instance which shares cookie storage with
-the browser context and can be accessed via [BrowserContext#request](./browser_context#request) or [Page#request](./page#request).
-It is also possible to create a new APIRequestContext instance manually by calling [APIRequest#new_context](./api_request#new_context).
+Each Playwright browser context has an associated [APIRequestContext](./api_request_context), accessible via
+[BrowserContext#request](./browser_context#request) or [Page#request](./page#request) (these return the
+
+**same instance** — `page.request` is a shortcut for `page.context().request`).
+You can also create a standalone, isolated instance with [APIRequest#new_context](./api_request#new_context).
 
 **Cookie management**
 
-[APIRequestContext](./api_request_context) returned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie
-storage with the corresponding [BrowserContext](./browser_context). 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](./browser_context) 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.
+The [APIRequestContext](./api_request_context) returned by [BrowserContext#request](./browser_context#request) and
+
+[Page#request](./page#request) uses the same cookie jar as its [BrowserContext](./browser_context):
 
-If you want API requests to not interfere with the browser cookies you should create a new [APIRequestContext](./api_request_context) by
-calling [APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie
-storage.
+If you want API requests that do **not** share cookies with the browser, create an
+isolated context via [APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context)
+object will have its own isolated cookie storage.
 
 ```ruby
 playwright.chromium.launch do |browser|
@@ -296,3 +296,5 @@ def put(
 Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response.
 The method will populate request cookies from the context and update
 context cookies from the response. The method will automatically follow redirects.
+
+## tracing

data/documentation/docs/api/browser.md

@@ -193,6 +193,15 @@ This is a convenience API that should only be used for the single-page scenarios
 testing frameworks should explicitly create [Browser#new_context](./browser#new_context) followed by the
 [BrowserContext#new_page](./browser_context#new_page) to control their exact life times.
 
+## bind
+
+```
+def bind(title, host: nil, port: nil, workspaceDir: nil)
+```
+
+
+Binds the browser to a named pipe or web socket, making it available for other clients to connect to.
+
 ## start_tracing
 
 ```
@@ -227,6 +236,15 @@ def stop_tracing
 
 Returns the buffer with trace data.
 
+## unbind
+
+```
+def unbind
+```
+
+
+Unbinds the browser server previously bound with [Browser#bind](./browser#bind).
+
 ## version
 
 ```

data/documentation/docs/api/browser_context.md

@@ -154,7 +154,7 @@ are returned.
 ## expose_binding
 
 ```
-def expose_binding(name, callback, handle: nil)
+def expose_binding(name, callback)
 ```
 
 

data/documentation/docs/api/browser_type.md

@@ -19,6 +19,23 @@ chromium.launch do |browser|
 end
 ```
 
+## connect
+
+```
+def connect(
+      endpoint,
+      exposeNetwork: nil,
+      headers: nil,
+      slowMo: nil,
+      timeout: nil,
+      &block)
+```
+
+
+This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
+
+**NOTE**: The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
+
 ## connect_over_cdp
 
 ```
@@ -26,6 +43,7 @@ def connect_over_cdp(
       endpointURL,
       headers: nil,
       isLocal: nil,
+      noDefaults: nil,
       slowMo: nil,
       timeout: nil,
       &block)

data/documentation/docs/api/frame.md

@@ -486,6 +486,7 @@ page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
 def get_by_role(
       role,
       checked: nil,
+      description: nil,
       disabled: nil,
       exact: nil,
       expanded: nil,

data/documentation/docs/api/frame_locator.md

@@ -131,6 +131,7 @@ page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
 def get_by_role(
       role,
       checked: nil,
+      description: nil,
       disabled: nil,
       exact: nil,
       expanded: nil,

data/documentation/docs/api/locator.md

@@ -87,7 +87,7 @@ button = page.get_by_role("button").and(page.get_by_title("Subscribe"))
 ## aria_snapshot
 
 ```
-def aria_snapshot(depth: nil, mode: nil, timeout: nil)
+def aria_snapshot(boxes: nil, depth: nil, mode: nil, timeout: nil)
 ```
 
 
@@ -441,6 +441,31 @@ source.drag_to(
 )
 ```
 
+## drop
+
+```
+def drop(payload, position: nil, timeout: nil)
+```
+
+
+Simulate an external drag-and-drop of files or clipboard-like data onto this locator.
+
+**Details**
+
+Dispatches the native `dragenter`, `dragover`, and `drop` events at the center of the
+target element with a synthetic [DataTransfer] carrying the provided files and/or data
+entries. Works cross-browser by constructing the [DataTransfer] in the page context.
+
+If the target element's `dragover` listener does not call `preventDefault()`, the target
+is considered to have rejected the drop: Playwright dispatches `dragleave` and this
+method throws.
+
+**Usage**
+
+Drop a file buffer onto an upload area:
+
+Drop plain text and a URL together:
+
 ## element_handle
 
 ```
@@ -721,6 +746,7 @@ page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
 def get_by_role(
       role,
       checked: nil,
+      description: nil,
       disabled: nil,
       exact: nil,
       expanded: nil,
@@ -869,10 +895,19 @@ You can check the issues count after locating it by the title text:
 page.get_by_title("Issues count").text_content # => "25 issues"
 ```
 
+## hide_highlight
+
+```
+def hide_highlight
+```
+
+
+Hides the element highlight previously added by [Locator#highlight](./locator#highlight).
+
 ## highlight
 
 ```
-def highlight
+def highlight(style: nil)
 ```
 
 

data/documentation/docs/api/locator_assertions.md

@@ -647,7 +647,7 @@ expect(locator).to have_count(3)
 ## to_have_css
 
 ```ruby
-expect(locator).to have_css(name, value, timeout: nil)
+expect(locator).to have_css(name, value, pseudo: nil, timeout: nil)
 ```
 
 

data/documentation/docs/api/page.md

@@ -457,7 +457,7 @@ result_handle.dispose
 ## expose_binding
 
 ```
-def expose_binding(name, callback, handle: nil)
+def expose_binding(name, callback)
 ```
 
 
@@ -690,6 +690,7 @@ page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
 def get_by_role(
       role,
       checked: nil,
+      description: nil,
       disabled: nil,
       exact: nil,
       expanded: nil,
@@ -889,6 +890,15 @@ Found" and 500 "Internal Server Error".  The status code for such responses can
 **NOTE**: Headless mode doesn't support navigation to a PDF document. See the
 [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
 
+## hide_highlight
+
+```
+def hide_highlight
+```
+
+
+Hide all locator highlight overlays previously added by [Locator#highlight](./locator#highlight) on this page.
+
 ## hover
 
 ```
@@ -1521,7 +1531,7 @@ page.goto("https://example.com")
 ## aria_snapshot
 
 ```
-def aria_snapshot(depth: nil, mode: nil, timeout: nil)
+def aria_snapshot(boxes: nil, depth: nil, mode: nil, timeout: nil)
 ```
 
 

data/documentation/docs/api/page_assertions.md

@@ -34,6 +34,34 @@ def not_to_have_url(urlOrRegExp, ignoreCase: nil, timeout: nil)
 
 The opposite of [PageAssertions#to_have_url](./page_assertions#to_have_url).
 
+## to_match_aria_snapshot
+
+```
+def to_match_aria_snapshot(expected, timeout: nil)
+```
+
+
+Asserts that the page body matches the given [accessibility snapshot](https://playwright.dev/python/docs/aria-snapshots).
+
+**Usage**
+
+```ruby
+page.goto("https://demo.playwright.dev/todomvc/")
+expect(page).to match_aria_snapshot(<<~YAML)
+  - heading "todos"
+  - textbox "What needs to be done?"
+YAML
+```
+
+## not_to_match_aria_snapshot
+
+```
+def not_to_match_aria_snapshot(expected, timeout: nil)
+```
+
+
+The opposite of [PageAssertions#to_match_aria_snapshot](./page_assertions#to_match_aria_snapshot).
+
 ## to_have_title
 
 ```

data/documentation/docs/api/playwright.md

@@ -54,6 +54,11 @@ end
 
 This object can be used to launch or connect to Firefox, returning instances of [Browser](./browser).
 
+## request
+
+
+Exposes API that can be used for the Web API testing.
+
 ## selectors
 
 

data/documentation/docs/api/tracing.md

@@ -77,6 +77,26 @@ page.goto("http://example.com")
 context.tracing.stop_chunk(path: "trace2.zip")
 ```
 
+## start_har
+
+```
+def start_har(path, content: nil, mode: nil, urlFilter: nil)
+```
+
+
+Start recording a HAR (HTTP Archive) of network activity in this context. The HAR file is written to disk when [Tracing#stop_har](./tracing#stop_har) is called, or when the returned `Disposable` is disposed.
+
+Only one HAR recording can be active at a time per [BrowserContext](./browser_context).
+
+**Usage**
+
+```ruby
+context.tracing.start_har("trace.har")
+page = context.new_page
+page.goto("https://playwright.dev")
+context.tracing.stop_har
+```
+
 ## group
 
 ```
@@ -128,3 +148,12 @@ def stop_chunk(path: nil)
 
 
 Stop the trace chunk. See [Tracing#start_chunk](./tracing#start_chunk) for more details about multiple trace chunks.
+
+## stop_har
+
+```
+def stop_har
+```
+
+
+Stop HAR recording and save the HAR file to the path given to [Tracing#start_har](./tracing#start_har).

data/documentation/docs/include/api_coverage.md

@@ -293,6 +293,7 @@
 * go_forward
 * ~~request_gc~~
 * goto
+* hide_highlight
 * hover
 * inner_html
 * inner_text
@@ -422,15 +423,15 @@
 * new_browser_cdp_session
 * new_context
 * new_page
-* ~~bind~~
+* bind
 * start_tracing
 * stop_tracing
-* ~~unbind~~
+* unbind
 * version
 
 ## BrowserType
 
-* ~~connect~~
+* connect
 * connect_over_cdp
 * executable_path
 * launch
@@ -443,7 +444,7 @@
 * chromium
 * devices
 * firefox
-* ~~request~~
+* request
 * selectors
 * webkit
 
@@ -451,10 +452,12 @@
 
 * start
 * start_chunk
+* start_har
 * group
 * group_end
 * stop
 * stop_chunk
+* stop_har
 
 ## Locator
 
@@ -474,6 +477,7 @@
 * description
 * dispatch_event
 * drag_to
+* drop
 * element_handle
 * element_handles
 * content_frame
@@ -493,6 +497,7 @@
 * get_by_test_id
 * get_by_text
 * get_by_title
+* hide_highlight
 * highlight
 * hover
 * inner_html
@@ -564,10 +569,11 @@
 * post
 * put
 * ~~storage_state~~
+* tracing
 
-## ~~APIRequest~~
+## APIRequest
 
-* ~~new_context~~
+* new_context
 
 ## LocatorAssertions
 
@@ -628,59 +634,7 @@
 
 * not_to_have_title
 * not_to_have_url
+* to_match_aria_snapshot
+* not_to_match_aria_snapshot
 * to_have_title
 * to_have_url
-
-## Android
-
-* ~~connect~~
-* devices
-* set_default_timeout
-
-## AndroidDevice
-
-* close
-* ~~drag~~
-* ~~fill~~
-* ~~fling~~
-* info
-* ~~install_apk~~
-* launch_browser
-* ~~long_tap~~
-* model
-* ~~open~~
-* ~~pinch_close~~
-* ~~pinch_open~~
-* ~~press~~
-* ~~push~~
-* screenshot
-* ~~scroll~~
-* serial
-* ~~set_default_timeout~~
-* shell
-* ~~swipe~~
-* ~~tap_point~~
-* ~~wait~~
-* ~~wait_for_event~~
-* ~~web_view~~
-* ~~web_views~~
-* input
-
-## AndroidInput
-
-* drag
-* press
-* ~~swipe~~
-* tap_point
-* type
-
-## ~~AndroidSocket~~
-
-* ~~close~~
-* ~~write~~
-
-## ~~AndroidWebView~~
-
-* ~~page~~
-* ~~pid~~
-* ~~pkg~~

data/lib/playwright/api_request_impl.rb

@@ -0,0 +1,70 @@
+require 'base64'
+require 'json'
+
+module Playwright
+  define_api_implementation :APIRequestImpl do
+    def initialize(playwright)
+      @playwright = playwright
+    end
+
+    def new_context(
+          baseURL: nil,
+          clientCertificates: nil,
+          extraHTTPHeaders: nil,
+          failOnStatusCode: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
+          proxy: nil,
+          storageState: nil,
+          timeout: nil,
+          userAgent: nil)
+      params = {
+        baseURL: baseURL,
+        clientCertificates: prepare_client_certificates(clientCertificates),
+        extraHTTPHeaders: extraHTTPHeaders ? HttpHeaders.new(extraHTTPHeaders).as_serialized : nil,
+        failOnStatusCode: failOnStatusCode,
+        httpCredentials: httpCredentials,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        maxRedirects: maxRedirects,
+        proxy: proxy,
+        storageState: prepare_storage_state(storageState),
+        timeout: timeout,
+        userAgent: userAgent,
+      }.compact
+
+      result = @playwright.channel.send_message_to_server_result('newRequest', params)
+      context = ChannelOwners::APIRequestContext.from(result['request'])
+      context.send(:_update_timeout_settings, TimeoutSettings.new.tap { |settings| settings.default_timeout = timeout if timeout })
+      context
+    end
+
+    private def prepare_storage_state(storage_state)
+      storage_state.is_a?(String) ? JSON.parse(File.read(storage_state)) : storage_state
+    end
+
+    private def prepare_client_certificates(client_certificates)
+      return unless client_certificates.is_a?(Array)
+
+      client_certificates.filter_map do |item|
+        out_record = {
+          origin: item[:origin],
+          passphrase: item[:passphrase],
+        }
+
+        { pfxPath: 'pfx', certPath: 'cert', keyPath: 'key' }.each do |key, out_key|
+          if (filepath = item[key])
+            out_record[out_key] = Base64.encode64(File.read(filepath)) rescue ''
+          elsif (value = item[out_key.to_sym])
+            out_record[out_key] = value
+          end
+        end
+
+        out_record.compact!
+        next nil if out_record.empty?
+
+        out_record
+      end
+    end
+  end
+end

data/lib/playwright/channel_owners/api_request_context.rb

@@ -8,13 +8,17 @@ module Playwright
       @timeout_settings = TimeoutSettings.new
     end
 
+    attr_reader :tracing
+
     private def _update_timeout_settings(timeout_settings)
       @timeout_settings = timeout_settings
     end
 
     def dispose(reason: nil)
       @close_reason = reason
-      @channel.send_message_to_server('dispose')
+      @tracing.send(:export_all_hars)
+      @channel.send_message_to_server('dispose', { reason: reason }.compact)
+      @tracing.send(:reset_stack_counter)
     end
 
     def delete(url, **options)

data/lib/playwright/channel_owners/binding_call.rb

@@ -53,15 +53,9 @@ module Playwright
         page: PlaywrightApi.wrap(frame.page),
         frame: PlaywrightApi.wrap(frame),
       }
-      args =
-        if @initializer['handle']
-          handle = ChannelOwners::ElementHandle.from(@initializer['handle'])
-          [handle]
-        else
-          @initializer['args'].map do |arg|
-            JavaScript::ValueParser.new(arg).parse
-          end
-        end
+      args = @initializer['args'].map do |arg|
+        JavaScript::ValueParser.new(arg).parse
+      end
 
       begin
         result = PlaywrightApi.unwrap(callback.call(source, *args))

data/lib/playwright/channel_owners/browser.rb

@@ -87,6 +87,22 @@ module Playwright
       @initializer['version']
     end
 
+    def bind(title, host: nil, metadata: nil, port: nil, workspaceDir: nil)
+      params = {
+        title: title,
+        host: host,
+        metadata: metadata,
+        port: port,
+        workspaceDir: workspaceDir,
+      }.compact
+      @channel.send_message_to_server_result('startServer', params)
+    end
+
+    def unbind
+      @channel.send_message_to_server('stopServer')
+      nil
+    end
+
     def new_browser_cdp_session
       resp = @channel.send_message_to_server('newBrowserCDPSession')
       ChannelOwners::CDPSession.from(resp)
@@ -135,6 +151,7 @@ module Playwright
       if @browser_type
         setup_browser_context(context)
       end
+      emit(Events::Browser::Context, context)
     end
 
     private def setup_browser_context(context)