playwright-ruby-client 1.60.0 → 1.61.0

data/lib/playwright/waiter.rb

@@ -12,33 +12,14 @@ module Playwright
       @registered_listeners = Set.new
       @listeners_mutex = Mutex.new
       @logs = []
-      wait_for_event_info_before
+      send_wait_info(waitId: @wait_id, phase: 'before', event: @event)
     end
 
-    private def wait_for_event_info_before
-      @channel.async_send_message_to_server(
-        "waitForEventInfo",
-        {
-          "info": {
-            "waitId": @wait_id,
-            "phase": "before",
-            "event": @event,
-          }
-        },
-      )
-    end
-
-    private def wait_for_event_info_after(error: nil)
-      @channel.async_send_message_to_server(
-        "waitForEventInfo",
-        {
-          "info": {
-            "waitId": @wait_id,
-            "phase": "after",
-            "error": error,
-          }.compact,
-        },
-      )
+    private def send_wait_info(params)
+      @channel.async_send_message_to_server('__waitInfo__', params.compact)
+    rescue
+      # Fire-and-forget. The server intentionally does not reply and this must
+      # not affect the API call that is being waited for.
     end
 
     def reject_on_event(emitter, event, error_or_proc, predicate: nil)
@@ -89,7 +70,7 @@ module Playwright
       cleanup
       return if @result.resolved?
       @result.fulfill(result)
-      wait_for_event_info_after
+      send_wait_info(waitId: @wait_id, phase: 'after')
     end
 
     private def reject(error)
@@ -98,7 +79,7 @@ module Playwright
       klass = error.is_a?(TimeoutError) ? TimeoutError : Error
       ex = klass.new(message: "#{error.message}#{format_log_recording(@logs)}")
       @result.reject(ex)
-      wait_for_event_info_after(error: ex)
+      send_wait_info(waitId: @wait_id, phase: 'after', error: ex.message)
     end
 
     # @param [Playwright::EventEmitter]
@@ -135,20 +116,7 @@ module Playwright
 
     def log(message)
       @logs << message
-      begin
-        @channel.async_send_message_to_server(
-          "waitForEventInfo",
-          {
-            "info": {
-              "waitId": @wait_id,
-              "phase": "log",
-              "message": message,
-            },
-          },
-        )
-      rescue => err
-        # ignore
-      end
+      send_wait_info(waitId: @wait_id, phase: 'log', message: message)
     end
 
     # @param logs [Array<String>]

data/lib/playwright/web_storage_impl.rb

@@ -0,0 +1,34 @@
+module Playwright
+  # ref: https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/client/webStorage.ts
+  define_api_implementation :WebStorageImpl do
+    # @param page [ChannelOwners::Page]
+    # @param kind [String] 'local' or 'session'
+    def initialize(page, kind)
+      @page = page
+      @kind = kind
+    end
+
+    def items
+      @page.channel.send_message_to_server('webStorageItems', kind: @kind)
+    end
+
+    def get_item(name)
+      @page.channel.send_message_to_server('webStorageGetItem', kind: @kind, name: name)
+    end
+
+    def set_item(name, value)
+      @page.channel.send_message_to_server('webStorageSetItem', kind: @kind, name: name, value: value)
+      nil
+    end
+
+    def remove_item(name)
+      @page.channel.send_message_to_server('webStorageRemoveItem', kind: @kind, name: name)
+      nil
+    end
+
+    def clear
+      @page.channel.send_message_to_server('webStorageClear', kind: @kind)
+      nil
+    end
+  end
+end

data/lib/playwright_api/api_request_context.rb

@@ -290,12 +290,6 @@ module Playwright
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -308,6 +302,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/api_response.rb

@@ -55,6 +55,18 @@ module Playwright
       wrap_impl(@impl.ok)
     end
 
+    #
+    # Returns SSL and other security information. Resolves to `null` for non-HTTPS responses. For redirected requests, returns the information for the last request in the redirect chain.
+    def security_details
+      wrap_impl(@impl.security_details)
+    end
+
+    #
+    # Returns the IP address and port of the server. Resolves to `null` if the server address is not available. For redirected requests, returns the information for the last request in the redirect chain.
+    def server_addr
+      wrap_impl(@impl.server_addr)
+    end
+
     #
     # Contains the status code of the response (e.g., 200 for a success).
     def status

data/lib/playwright_api/browser.rb

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

data/lib/playwright_api/browser_context.rb

@@ -25,6 +25,13 @@ module Playwright
       wrap_impl(@impl.clock)
     end
 
+    #
+    # Virtual WebAuthn authenticator for this context. Lets tests seed credentials and intercept
+    # `navigator.credentials.create()` / `navigator.credentials.get()` ceremonies.
+    def credentials # property
+      wrap_impl(@impl.credentials)
+    end
+
     #
     # Debugger allows to pause and resume the execution.
     def debugger # property
@@ -490,34 +497,28 @@ module Playwright
     end
 
     # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
-    end
-
-    # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    def browser=(req)
+      wrap_impl(@impl.browser=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
     end
 
     # @nodoc
-    def browser=(req)
-      wrap_impl(@impl.browser=(unwrap_impl(req)))
+    def pause
+      wrap_impl(@impl.pause)
     end
 
     # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --
@@ -532,6 +533,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_type.rb

@@ -51,13 +51,14 @@ module Playwright
     # ```
     def connect_over_cdp(
           endpointURL,
+          artifactsDir: nil,
           headers: nil,
           isLocal: nil,
           noDefaults: nil,
           slowMo: nil,
           timeout: nil,
           &block)
-      wrap_impl(@impl.connect_over_cdp(unwrap_impl(endpointURL), headers: unwrap_impl(headers), isLocal: unwrap_impl(isLocal), noDefaults: unwrap_impl(noDefaults), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+      wrap_impl(@impl.connect_over_cdp(unwrap_impl(endpointURL), artifactsDir: unwrap_impl(artifactsDir), headers: unwrap_impl(headers), isLocal: unwrap_impl(isLocal), noDefaults: unwrap_impl(noDefaults), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     #
@@ -183,12 +184,6 @@ module Playwright
       wrap_impl(@impl.name)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -201,6 +196,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/cdp_session.rb

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

data/lib/playwright_api/credentials.rb

@@ -0,0 +1,120 @@
+module Playwright
+  #
+  # `Credentials` is a virtual WebAuthn authenticator scoped to a `BrowserContext`. It lets tests
+  # register passkeys and answer `navigator.credentials.create()` / `navigator.credentials.get()`
+  # ceremonies in the page, without a real authenticator or hardware security key.
+  #
+  # There are two common ways to use it:
+  #
+  # **Usage: seed a known credential**
+  #
+  # ```python sync
+  # context = browser.new_context()
+  #
+  # # A passkey your backend already provisioned for a test user.
+  # context.credentials.create(
+  #     "example.com",
+  #     id=known_credential_id,  # base64url
+  #     user_handle=known_user_handle,  # base64url
+  #     private_key=known_private_key,  # base64url PKCS#8 (DER)
+  #     public_key=known_public_key,  # base64url SPKI (DER)
+  # )
+  # context.credentials.install()
+  #
+  # page = context.new_page()
+  # page.goto("https://example.com/login")
+  # # The page's navigator.credentials.get() is answered with the seeded passkey.
+  # ```
+  #
+  # **Usage: capture a passkey, then reuse it**
+  #
+  # ```python sync
+  # # setup test: let the app register a passkey, then save it.
+  # context = browser.new_context()
+  # context.credentials.install()
+  #
+  # page = context.new_page()
+  # page.goto("https://example.com/register")
+  # page.get_by_role("button", name="Create a passkey").click()
+  #
+  # # Read back the passkey the page registered — it includes the private key.
+  # [credential] = context.credentials.get(rp_id="example.com")
+  # with open("playwright/.auth/passkey.json", "w") as f:
+  #     json.dump(credential, f)
+  # ```
+  #
+  # ```python sync
+  # # later test: seed the captured passkey so the app starts already enrolled.
+  # with open("playwright/.auth/passkey.json") as f:
+  #     credential = json.load(f)
+  # context = browser.new_context()
+  # context.credentials.create(
+  #     credential["rpId"],
+  #     id=credential["id"],
+  #     user_handle=credential["userHandle"],
+  #     private_key=credential["privateKey"],
+  #     public_key=credential["publicKey"],
+  # )
+  # context.credentials.install()
+  #
+  # page = context.new_page()
+  # page.goto("https://example.com/login")
+  # # navigator.credentials.get() resolves the captured passkey — already signed in.
+  # ```
+  #
+  # **Defaults**
+  class Credentials < PlaywrightApi
+
+    #
+    # Installs the virtual WebAuthn authenticator into the context, overriding
+    # `navigator.credentials.create()` and `navigator.credentials.get()` in all current
+    # and future pages. Call this before the page first touches `navigator.credentials`.
+    #
+    # Required: until [`method: Credentials.install`] is called, no interception is in place and the page sees
+    # the platform's native (or absent) WebAuthn behaviour. Seeding credentials with
+    # [`method: Credentials.create`] without installing populates the authenticator, but the
+    # page will never see those credentials.
+    def install
+      wrap_impl(@impl.install)
+    end
+
+    #
+    # Seeds a virtual WebAuthn credential and returns it.
+    #
+    # With only `rpId`, generates a fresh **ECDSA P-256** keypair, credential id and user handle. The
+    # seeded credential is discoverable (resident), so the page can resolve it from both
+    # username-then-passkey and usernameless passkey flows. The returned object carries the private and public keys, so it can be persisted to disk and re-seeded in a later test.
+    #
+    # To **import a known credential**, supply all four of `id`, `userHandle`, `privateKey` and
+    # `publicKey` together.
+    #
+    # Call [`method: Credentials.install`] before navigating to a page that uses WebAuthn.
+    def create(
+          rpId,
+          id: nil,
+          privateKey: nil,
+          publicKey: nil,
+          userHandle: nil)
+      wrap_impl(@impl.create(unwrap_impl(rpId), id: unwrap_impl(id), privateKey: unwrap_impl(privateKey), publicKey: unwrap_impl(publicKey), userHandle: unwrap_impl(userHandle)))
+    end
+
+    #
+    # Removes a credential from the authenticator by its id. Works for any credential currently held —
+    # both those seeded with [`method: Credentials.create`] and those the page registered itself by
+    # calling `navigator.credentials.create()`.
+    def delete(id)
+      wrap_impl(@impl.delete(unwrap_impl(id)))
+    end
+
+    #
+    # Returns every credential currently held by the authenticator, optionally filtered by `rpId` or
+    # `id`. This includes both credentials seeded with [`method: Credentials.create`] and credentials
+    # the page registered itself by calling `navigator.credentials.create()`.
+    #
+    # Each returned credential includes its private and public keys, so a passkey the app just
+    # registered can be saved and re-seeded into a later test with [`method: Credentials.create`] — see the second example in the class overview.
+    def get(id: nil, rpId: nil)
+      wrap_impl(@impl.get(id: unwrap_impl(id), rpId: unwrap_impl(rpId)))
+    end
+  end
+end

data/lib/playwright_api/dialog.rb

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

data/lib/playwright_api/element_handle.rb

@@ -574,12 +574,6 @@ module Playwright
       wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -592,6 +586,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/frame.rb

@@ -255,7 +255,7 @@ module Playwright
     # `ElementHandle` instances can be passed as an argument to the [`method: Frame.evaluate`]:
     #
     # ```python sync
-    # body_handle = frame.evaluate("document.body")
+    # body_handle = frame.evaluate_handle("document.body")
     # html = frame.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
     # body_handle.dispose()
     # ```
@@ -282,14 +282,14 @@ module Playwright
     # A string can also be passed in instead of a function.
     #
     # ```python sync
-    # a_handle = page.evaluate_handle("document") # handle for the "document"
+    # a_handle = frame.evaluate_handle("document") # handle for the "document"
     # ```
     #
     # `JSHandle` instances can be passed as an argument to the [`method: Frame.evaluateHandle`]:
     #
     # ```python sync
-    # a_handle = page.evaluate_handle("document.body")
-    # result_handle = page.evaluate_handle("body => body.innerHTML", a_handle)
+    # a_handle = frame.evaluate_handle("document.body")
+    # result_handle = frame.evaluate_handle("body => body.innerHTML", a_handle)
     # print(result_handle.json_value())
     # result_handle.dispose()
     # ```
@@ -1042,13 +1042,13 @@ module Playwright
     end
 
     # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    def drop(selector, payload, position: nil, strict: nil, timeout: nil)
+      wrap_impl(@impl.drop(unwrap_impl(selector), unwrap_impl(payload), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
     # @nodoc
-    def drop(selector, payload, position: nil, strict: nil, timeout: nil)
-      wrap_impl(@impl.drop(unwrap_impl(selector), unwrap_impl(payload), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
     end
 
     # @nodoc
@@ -1066,12 +1066,6 @@ module Playwright
       wrap_impl(@impl.expect(unwrap_impl(selector), unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -1084,6 +1078,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/js_handle.rb

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

data/lib/playwright_api/locator.rb

@@ -1325,6 +1325,11 @@ module Playwright
       wrap_impl(@impl.wait_for(state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
     end
 
+    # @nodoc
+    def _assertions(timeout, is_not, message)
+      wrap_impl(@impl._assertions(unwrap_impl(timeout), unwrap_impl(is_not), unwrap_impl(message)))
+    end
+
     # @nodoc
     def resolve_selector
       wrap_impl(@impl.resolve_selector)
@@ -1335,11 +1340,6 @@ module Playwright
       wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     end
 
-    # @nodoc
-    def _assertions(timeout, is_not, message)
-      wrap_impl(@impl._assertions(unwrap_impl(timeout), unwrap_impl(is_not), unwrap_impl(message)))
-    end
-
     # @nodoc
     def to_s
       wrap_impl(@impl.to_s)