playwright-ruby-client 1.27.0 → 1.28.0

data/lib/playwright/channel_owners/page.rb

@@ -8,6 +8,7 @@ module Playwright
     include LocatorUtils
     attr_writer :owned_context
 
+
     private def after_initialize
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
@@ -73,6 +74,14 @@ module Playwright
         worker = ChannelOwners::Worker.from(params['worker'])
         on_worker(worker)
       })
+
+      set_event_to_subscription_mapping({
+        Events::Page::Request => "request",
+        Events::Page::Response => "response",
+        Events::Page::RequestFinished => "requestFinished",
+        Events::Page::RequestFailed => "requestFailed",
+        Events::Page::FileChooser => "fileChooser",
+      })
     end
 
     attr_reader \
@@ -169,30 +178,6 @@ module Playwright
       video.send(:set_artifact, artifact)
     end
 
-    # @override
-    def on(event, callback)
-      if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: true)
-      end
-      super
-    end
-
-    # @override
-    def once(event, callback)
-      if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: true)
-      end
-      super
-    end
-
-    # @override
-    def off(event, callback)
-      super
-      if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: false)
-      end
-    end
-
     def context
       @browser_context
     end
@@ -366,16 +351,24 @@ module Playwright
 
     def emulate_media(colorScheme: nil, forcedColors: nil, media: nil, reducedMotion: nil)
       params = {
-        colorScheme: colorScheme,
-        forcedColors: forcedColors,
-        media: media,
-        reducedMotion: reducedMotion,
+        colorScheme: no_override_if_null(colorScheme),
+        forcedColors: no_override_if_null(forcedColors),
+        media: no_override_if_null(media),
+        reducedMotion: no_override_if_null(reducedMotion),
       }.compact
       @channel.send_message_to_server('emulateMedia', params)
 
       nil
     end
 
+    private def no_override_if_null(target)
+      if target == 'null'
+        'no-override'
+      else
+        target
+      end
+    end
+
     def set_viewport_size(viewportSize)
       @viewport_size = viewportSize
       @channel.send_message_to_server('setViewportSize', { viewportSize: viewportSize })
@@ -637,6 +630,7 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
@@ -645,6 +639,7 @@ module Playwright
         selector,
         force: force,
         modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
         position: position,
         strict: strict,
         timeout: timeout,

data/lib/playwright/connection.rb

@@ -43,7 +43,10 @@ module Playwright
     end
 
     def initialize_playwright
-      result = send_message_to_server('', 'initialize', { sdkLanguage: 'ruby' })
+      # Avoid Error: sdkLanguage: expected one of (javascript|python|java|csharp)
+      # ref: https://github.com/microsoft/playwright/pull/18308
+      # ref: https://github.com/YusukeIwaki/playwright-ruby-client/issues/228
+      result = send_message_to_server('', 'initialize', { sdkLanguage: 'python' })
       ChannelOwners::Playwright.from(result['playwright'])
     end
 

data/lib/playwright/locator_impl.rb

@@ -11,8 +11,7 @@ module Playwright
       selector_scopes = [selector]
 
       if hasText
-        text_selector = "text=#{escape_for_text_selector(hasText, false)}"
-        selector_scopes << "internal:has=#{text_selector.to_json}"
+        selector_scopes << "internal:has-text=#{escape_for_text_selector(hasText, false)}"
       end
 
       if has
@@ -187,6 +186,10 @@ module Playwright
       @frame.fill(@selector, value, strict: true, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
+    def clear(force: nil, noWaitAfter: nil, timeout: nil)
+      @frame.fill(@selector, '', strict: true, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
     def locator(selector, hasText: nil, has: nil)
       LocatorImpl.new(
         frame: @frame,
@@ -251,6 +254,15 @@ module Playwright
       @frame.focus(@selector, strict: true, timeout: timeout)
     end
 
+    def blur(timeout: nil)
+      params = {
+        selector: @selector,
+        strict: true,
+        timeout: timeout,
+      }.compact
+      @frame.channel.send_message_to_server('blur', params)
+    end
+
     def count
       @frame.eval_on_selector_all(@selector, 'ee => ee.length')
     end
@@ -262,6 +274,7 @@ module Playwright
     def hover(
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           timeout: nil,
           trial: nil)
@@ -269,6 +282,7 @@ module Playwright
         strict: true,
         force: force,
         modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
         trial: trial)

data/lib/playwright/locator_utils.rb

@@ -1,7 +1,10 @@
+require 'json'
+
 module Playwright
   module LocatorUtils
     def get_by_test_id(test_id)
-      locator(get_by_test_id_selector(test_id))
+      test_id_attribute_name = ::Playwright::LocatorUtils.instance_variable_get(:@test_id_attribute_name)
+      locator(get_by_test_id_selector(test_id_attribute_name, test_id))
     end
 
     def get_by_alt_text(text, exact: false)
@@ -35,11 +38,8 @@ module Playwright
       "internal:attr=[#{attr_name}=#{escape_for_attribute_selector_or_regex(text, exact)}]"
     end
 
-    private def get_by_test_id_selector(test_id)
-      get_by_attribute_text_selector(
-        ::Playwright::LocatorUtils.instance_variable_get(:@test_id_attribute_name),
-        test_id,
-        exact: true)
+    private def get_by_test_id_selector(test_id_attribute_name, test_id)
+      "internal:testid=[#{test_id_attribute_name}=#{escape_for_attribute_selector(test_id, true)}]"
     end
 
     private def get_by_label_selector(text, exact:)
@@ -59,7 +59,7 @@ module Playwright
     end
 
     private def get_by_text_selector(text, exact:)
-      "text=#{escape_for_text_selector(text, exact)}"
+      "internal:text=#{escape_for_text_selector(text, exact)}"
     end
 
     private def get_by_role_selector(role, **options)
@@ -67,7 +67,7 @@ module Playwright
 
       ex = {
         includeHidden: -> (value) { ['include-hidden', value.to_s] },
-        name: -> (value) { ['name', escape_for_attribute_selector_or_regex(value, false)]},
+        name: -> (value) { ['name', escape_for_attribute_selector_or_regex(value, options[:exact])]},
       }
 
       %i[
@@ -82,12 +82,12 @@ module Playwright
       ].each do |attr_name|
         if options.key?(attr_name)
           attr_value = options[attr_name]
-          props << ex[attr_name]&.call(attr_value) || [attr_name, attr_value.to_s]
+          props << (ex[attr_name]&.call(attr_value) || [attr_name, attr_value.to_s])
         end
       end
 
       opts = props.map { |k, v| "[#{k}=#{v}]"}.join('')
-      "role=#{role}#{opts}"
+      "internal:role=#{role}#{opts}"
     end
 
     # @param text [String]
@@ -103,16 +103,10 @@ module Playwright
       end
 
       if exact
-        _text = text.gsub(/["]/, '\\"')
-        return "\"#{_text}\""
-      end
-
-      if text.include?('"') || text.include?('>>') || text.start_with?('/')
-        _text = escape_for_regex(text).gsub(/\s+/, '\\s+')
-        return "/#{_text}/i"
+        "#{text.to_json}s"
+      else
+        "#{text.to_json}i"
       end
-
-      text
     end
 
     # @param text [Regexp|String]

data/lib/playwright/utils.rb

@@ -55,6 +55,12 @@ module Playwright
           params[:storageState] = JSON.parse(File.read(params[:storageState]))
         end
 
+        %i[colorScheme reducedMotion forcedColors].each do |key|
+          if params[key] == 'null'
+            params[key] = 'no-override'
+          end
+        end
+
         params
       end
     end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.27.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.27.0'
+  VERSION = '1.28.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.28.1'
 end

data/lib/playwright_api/android.rb

@@ -25,6 +25,12 @@ module Playwright
   # ```
   class Android < PlaywrightApi
 
+    # This methods attaches Playwright to an existing Android device. Use [`method: Android.launchServer`] to launch a new
+    # Android server instance.
+    def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
+      raise NotImplementedError.new('connect is not implemented yet.')
+    end
+
     # Returns the list of detected Android devices.
     def devices(host: nil, omitDriverInstall: nil, port: nil)
       wrap_impl(@impl.devices(host: unwrap_impl(host), omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
@@ -36,12 +42,6 @@ module Playwright
     end
     alias_method :default_timeout=, :set_default_timeout
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -54,6 +54,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/android_device.rb

@@ -173,12 +173,6 @@ module Playwright
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -191,6 +185,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/api_request_context.rb

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

data/lib/playwright_api/browser.rb

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

data/lib/playwright_api/browser_context.rb

@@ -406,12 +406,6 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -424,6 +418,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_type.rb

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

data/lib/playwright_api/cdp_session.rb

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

data/lib/playwright_api/console_message.rb

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

data/lib/playwright_api/dialog.rb

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

data/lib/playwright_api/element_handle.rb

@@ -251,10 +251,11 @@ module Playwright
     def hover(
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the `element.innerHTML`.
@@ -557,12 +558,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 off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -575,6 +570,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/frame.rb

@@ -357,7 +357,7 @@ module Playwright
     end
 
     # Allows locating input elements by the text of the associated label. For example, this method will find the input by
-    # label text Password in the following DOM:
+    # label text "Password" in the following DOM:
     #
     # ```html
     # <label for="password-input">Password:</label>
@@ -390,13 +390,14 @@ module Playwright
           role,
           checked: nil,
           disabled: nil,
+          exact: nil,
           expanded: nil,
           includeHidden: nil,
           level: nil,
           name: nil,
           pressed: nil,
           selected: nil)
-      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
     end
 
     # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
@@ -405,12 +406,44 @@ module Playwright
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
 
-    # Allows locating elements that contain given text.
+    # Allows locating elements that contain given text. Consider the following DOM structure:
+    #
+    # ```html
+    # <div>Hello <span>world</span></div>
+    # <div>Hello</div>
+    # ```
+    #
+    # You can locate by text substring, exact string, or a regular expression:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: Locator.filter`] that allows to match by another criteria, like an accessible role, and then filter
+    # by the text content.
+    #
+    # > NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
+    # one, turns line breaks into spaces and ignores leading and trailing whitespace.
+    # > NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
+    # example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
     def get_by_text(text, exact: nil)
       wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # Allows locating elements by their title. For example, this method will find the button by its title "Submit":
+    # Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
     #
     # ```html
     # <button title='Place the order'>Order Now</button>
@@ -455,11 +488,12 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns `element.innerHTML`.
@@ -874,12 +908,6 @@ module Playwright
       wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -892,6 +920,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end