playwright-ruby-client 1.26.0 → 1.28.0

data/lib/playwright/channel_owner.rb

@@ -36,6 +36,7 @@ module Playwright
       @type = type
       @guid = guid
       @initializer = initializer
+      @event_to_subscription_mapping = {}
 
       after_initialize
     end
@@ -59,6 +60,46 @@ module Playwright
       @objects.clear
     end
 
+    private def set_event_to_subscription_mapping(event_to_subscription_mapping)
+      @event_to_subscription_mapping = event_to_subscription_mapping
+    end
+
+    private def update_subscription(event, enabled)
+      protocol_event = @event_to_subscription_mapping[event]
+      if protocol_event
+        payload = {
+          event: protocol_event,
+          enabled: enabled,
+        }
+        @channel.async_send_message_to_server('updateSubscription', payload)
+      end
+    end
+
+    # @override
+    def on(event, callback)
+      if listener_count(event) == 0
+        update_subscription(event, true)
+      end
+      super
+    end
+
+    # @override
+    def once(event, callback)
+      if listener_count(event) == 0
+        update_subscription(event, true)
+      end
+      super
+    end
+
+    # @override
+    def off(event, callback)
+      super
+      if listener_count(event) == 0
+        update_subscription(event, false)
+      end
+    end
+
+
     # Suppress long long inspect log and avoid RSpec from hanging up...
     def inspect
       to_s

data/lib/playwright/channel_owners/browser_context.rb

@@ -58,6 +58,12 @@ module Playwright
           ChannelOwners::Page.from_nullable(params['page']),
         )
       })
+      set_event_to_subscription_mapping({
+        Events::BrowserContext::Request => "request",
+        Events::BrowserContext::Response => "response",
+        Events::BrowserContext::RequestFinished => "requestFinished",
+        Events::BrowserContext::RequestFailed => "requestFailed",
+      })
 
       @closed_promise = Concurrent::Promises.resolvable_future
     end

data/lib/playwright/channel_owners/element_handle.rb

@@ -76,10 +76,17 @@ module Playwright
         nil
       end
 
-      def hover(force: nil, modifiers: nil, position: nil, timeout: nil, trial: nil)
+      def hover(
+            force: nil,
+            modifiers: nil,
+            noWaitAfter: nil,
+            position: nil,
+            timeout: nil,
+            trial: nil)
         params = {
           force: force,
           modifiers: modifiers,
+          noWaitAfter: noWaitAfter,
           position: position,
           timeout: timeout,
           trial: trial,

data/lib/playwright/channel_owners/frame.rb

@@ -1,6 +1,10 @@
+require_relative '../locator_utils'
+
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_frame.py
   define_channel_owner :Frame do
+    include LocatorUtils
+
     private def after_initialize
       if @initializer['parentFrame']
         @parent_frame = ChannelOwners::Frame.from(@initializer['parentFrame'])
@@ -457,6 +461,7 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
@@ -465,6 +470,7 @@ module Playwright
         selector: selector,
         force: force,
         modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
         position: position,
         strict: strict,
         timeout: timeout,

data/lib/playwright/channel_owners/page.rb

@@ -1,11 +1,14 @@
 require 'base64'
+require_relative '../locator_utils'
 
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_page.py
   define_channel_owner :Page do
     include Utils::Errors::SafeCloseError
+    include LocatorUtils
     attr_writer :owned_context
 
+
     private def after_initialize
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
@@ -71,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 \
@@ -167,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
@@ -364,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 })
@@ -635,6 +630,7 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
@@ -643,6 +639,7 @@ module Playwright
         selector,
         force: force,
         modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
         position: position,
         strict: strict,
         timeout: timeout,

data/lib/playwright/channel_owners/selectors.rb

@@ -18,5 +18,9 @@ module Playwright
 
       nil
     end
+
+    def text_id_attribute=(attribute_name)
+      ::Playwright::LocatorUtils.instance_variable_set(:@test_id_attribute_name, attribute_name)
+    end
   end
 end

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/frame_locator_impl.rb

@@ -1,5 +1,9 @@
+require_relative './locator_utils'
+
 module Playwright
   define_api_implementation :FrameLocatorImpl do
+    include LocatorUtils
+
     def initialize(frame:, timeout_settings:, frame_selector:)
       @frame = frame
       @timeout_settings = timeout_settings
@@ -10,7 +14,7 @@ module Playwright
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
-        selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
+        selector: "#{@frame_selector} >> internal:control=enter-frame >> #{selector}",
         hasText: hasText,
         has: has,
       )
@@ -20,7 +24,7 @@ module Playwright
       FrameLocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
-        frame_selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
+        frame_selector: "#{@frame_selector} >> internal:control=enter-frame >> #{selector}",
       )
     end
 

data/lib/playwright/locator_impl.rb

@@ -1,49 +1,24 @@
 require 'json'
+require_relative './locator_utils'
 
 module Playwright
-  class EscapeWithQuotes
-    def initialize(text, char = "'")
-      stringified = text.to_json
-      escaped_text = stringified[1...-1].gsub(/\\"/, '"')
-
-      case char
-      when '"'
-        text = escaped_text.gsub(/["]/, '\\"')
-        @text = "\"#{text}\""
-      when "'"
-        text = escaped_text.gsub(/[']/, '\\\'')
-        @text = "'#{text}'"
-      else
-        raise ArgumentError.new('Invalid escape char')
-      end
-    end
-
-    def to_s
-      @text
-    end
-  end
-
   define_api_implementation :LocatorImpl do
+    include LocatorUtils
+
     def initialize(frame:, timeout_settings:, selector:, hasText: nil, has: nil)
       @frame = frame
       @timeout_settings = timeout_settings
       selector_scopes = [selector]
 
-      case hasText
-      when Regexp
-        regex = JavaScript::Regex.new(hasText)
-        source = EscapeWithQuotes.new(regex.source, '"')
-        selector_scopes << "has=#{"text=/#{regex.source}/#{regex.flag}".to_json}"
-      when String
-        text = EscapeWithQuotes.new(hasText, '"')
-        selector_scopes << ":scope:has-text(#{text})"
+      if hasText
+        selector_scopes << "internal:has-text=#{escape_for_text_selector(hasText, false)}"
       end
 
       if has
         unless same_frame?(has)
           raise DifferentFrameError.new
         end
-        selector_scopes << "has=#{has.send(:selector_json)}"
+        selector_scopes << "internal:has=#{has.send(:selector_json)}"
       end
 
       @selector = selector_scopes.join(' >> ')
@@ -211,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,
@@ -275,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
@@ -286,6 +274,7 @@ module Playwright
     def hover(
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           timeout: nil,
           trial: nil)
@@ -293,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

@@ -0,0 +1,136 @@
+require 'json'
+
+module Playwright
+  module LocatorUtils
+    def get_by_test_id(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)
+      locator(get_by_alt_text_selector(text, exact: exact))
+    end
+
+    def get_by_label(text, exact: false)
+      locator(get_by_label_selector(text, exact: exact))
+    end
+
+    def get_by_placeholder(text, exact: false)
+      locator(get_by_placeholder_selector(text, exact: exact))
+    end
+
+    def get_by_text(text, exact: false)
+      locator(get_by_text_selector(text, exact: exact))
+    end
+
+    def get_by_title(text, exact: false)
+      locator(get_by_title_selector(text, exact: exact))
+    end
+
+    def get_by_role(role, **options)
+      locator(get_by_role_selector(role, **(options.compact)))
+    end
+
+    # set from Playwright::Selectors#test_id_attribute=
+    @test_id_attribute_name = 'data-testid'
+
+    private def get_by_attribute_text_selector(attr_name, text, exact: false)
+      "internal:attr=[#{attr_name}=#{escape_for_attribute_selector_or_regex(text, exact)}]"
+    end
+
+    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:)
+      "internal:label=#{escape_for_text_selector(text, exact)}"
+    end
+
+    private def get_by_alt_text_selector(text, exact:)
+      get_by_attribute_text_selector('alt', text, exact: exact)
+    end
+
+    private def get_by_title_selector(text, exact:)
+      get_by_attribute_text_selector('title', text, exact: exact)
+    end
+
+    private def get_by_placeholder_selector(text, exact:)
+      get_by_attribute_text_selector('placeholder', text, exact: exact)
+    end
+
+    private def get_by_text_selector(text, exact:)
+      "internal:text=#{escape_for_text_selector(text, exact)}"
+    end
+
+    private def get_by_role_selector(role, **options)
+      props = []
+
+      ex = {
+        includeHidden: -> (value) { ['include-hidden', value.to_s] },
+        name: -> (value) { ['name', escape_for_attribute_selector_or_regex(value, options[:exact])]},
+      }
+
+      %i[
+        checked
+        disabled
+        selected
+        expanded
+        includeHidden
+        level
+        name
+        pressed
+      ].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])
+        end
+      end
+
+      opts = props.map { |k, v| "[#{k}=#{v}]"}.join('')
+      "internal:role=#{role}#{opts}"
+    end
+
+    # @param text [String]
+    private def escape_for_regex(text)
+      text.gsub(/[.*+?^>${}()|\[\]\\]/) { "\\#{$&}" }
+    end
+
+    # @param text [Regexp|String]
+    private def escape_for_text_selector(text, exact)
+      if text.is_a?(Regexp)
+        regex = JavaScript::Regex.new(text)
+        return "/#{regex.source}/#{regex.flag}"
+      end
+
+      if exact
+        "#{text.to_json}s"
+      else
+        "#{text.to_json}i"
+      end
+    end
+
+    # @param text [Regexp|String]
+    private def escape_for_attribute_selector_or_regex(text, exact)
+      if text.is_a?(Regexp)
+        regex = JavaScript::Regex.new(text)
+        "/#{regex.source}/#{regex.flag}"
+      else
+        escape_for_attribute_selector(text, exact)
+      end
+    end
+
+    # @param text [String]
+    private def escape_for_attribute_selector(text, exact)
+      # TODO: this should actually be
+      # cssEscape(value).replace(/\\ /g, ' ')
+      # However, our attribute selectors do not conform to CSS parsing spec,
+      # so we escape them differently.
+      _text = text.gsub(/["]/, '\\"')
+      if exact
+        "\"#{_text}\""
+      else
+        "\"#{_text}\"i"
+      end
+    end
+  end
+end

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.26.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.26.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