playwright-ruby-client 0.0.6 → 0.2.0

data/lib/playwright/channel_owners/request.rb

@@ -3,7 +3,7 @@ require 'base64'
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Request do
-    def after_initialize
+    private def after_initialize
       @redirected_from = ChannelOwners::Request.from_nullable(@initializer['redirectedFrom'])
       @redirected_from&.send(:update_redirected_to, self)
       @timing = {
@@ -86,6 +86,14 @@ module Playwright
       @redirected_to = request
     end
 
+    private def update_failure_text(failure_text)
+      @failure_text = failure_text
+    end
+
+    private def update_response_end_timing(response_end_timing)
+      @timing[:responseEnd] = response_end_timing
+    end
+
     private def parse_headers(headers)
       headers.map do |header|
         [header['name'].downcase, header['value']]

data/lib/playwright/channel_owners/webkit_browser.rb

@@ -2,7 +2,7 @@ require_relative './browser'
 
 module Playwright
   module ChannelOwners
-    class WebkitBrowser < Browser
+    class WebKitBrowser < Browser
     end
   end
 end

data/lib/playwright/connection.rb

@@ -55,10 +55,13 @@ module Playwright
           method: method,
           params: replace_channels_with_guids(params),
         }
-        @transport.send_message(message)
-      rescue Transport::AlreadyDisconnectedError => err
-        @callbacks.delete(id)
-        callback.reject(err)
+        begin
+          @transport.send_message(message)
+        rescue => err
+          @callbacks.delete(id)
+          callback.reject(err)
+          raise unless err.is_a?(Transport::AlreadyDisconnectedError)
+        end
       end
 
       callback
@@ -132,7 +135,7 @@ module Playwright
         unless object
           raise "Cannot find object to dispose: #{guid}"
         end
-        object.dispose
+        object.send(:dispose!)
         return
       end
 
@@ -153,7 +156,7 @@ module Playwright
       end
 
       if payload.is_a?(Channel)
-        { guid: payload.guid }
+        return { guid: payload.guid }
       end
 
       if payload.is_a?(Hash)

data/lib/playwright/errors.rb

@@ -3,7 +3,7 @@ module Playwright
     # ref: https://github.com/microsoft/playwright-python/blob/0b4a980fed366c4c1dee9bfcdd72662d629fdc8d/playwright/_impl/_helper.py#L155
     def self.parse(error_payload)
       if error_payload['name'] == 'TimeoutError'
-        Playwright::TimeoutError.new(
+        TimeoutError.new(
           message: error_payload['message'],
           stack: error_payload['stack'].split("\n"),
         )
@@ -28,7 +28,7 @@ module Playwright
   end
 
   class TimeoutError < Error
-    def initialize(message:, stack:)
+    def initialize(message:, stack: [])
       super(name: 'TimeoutError', message: message, stack: stack)
     end
   end

data/lib/playwright/event_emitter.rb

@@ -34,11 +34,18 @@ module Playwright
   # A subset of Events/EventEmitter in Node.js
   module EventEmitter
     # @param event [String]
+    # @returns [Boolean]
     def emit(event, *args)
+      handled = false
       (@__event_emitter ||= {})[event.to_s]&.each do |callback|
         callback.call(*args)
+        handled = true
       end
-      self
+      handled
+    end
+
+    private def listener_count(event)
+      ((@__event_emitter ||= {})[event.to_s] ||= Set.new).count
     end
 
     # @param event [String]

data/lib/playwright/event_emitter_proxy.rb

@@ -0,0 +1,49 @@
+module Playwright
+  class EventEmitterProxy
+    include EventEmitter
+
+    # @param src [PlaywrightApi]
+    # @param dest [EventEmitter]
+    def initialize(api, impl)
+      @api = api
+      @impl = impl
+      @listeners = {}
+    end
+
+    def on(event, callback)
+      if listener_count(event) == 0
+        subscribe(event)
+      end
+      super
+    end
+
+    def once(event, callback)
+      if listener_count(event) == 0
+        subscribe(event)
+      end
+      super
+    end
+
+    def off(event, callback)
+      super
+      if listener_count(event) == 0
+        unsubscribe(event)
+      end
+    end
+
+    private def subscribe(event)
+      @listeners[event] = ->(*args) {
+        wrapped_args = args.map { |arg| ::Playwright::PlaywrightApi.wrap(arg) }
+        emit(event, *wrapped_args)
+      }
+      @impl.on(event, @listeners[event])
+    end
+
+    private def unsubscribe(event)
+      listener = @listeners.delete(event)
+      if listener
+        @impl.off(event, listener)
+      end
+    end
+  end
+end

data/lib/playwright/file_chooser_impl.rb

@@ -0,0 +1,23 @@
+module Playwright
+  define_api_implementation :FileChooserImpl do
+    def initialize(page:, element_handle:, is_multiple:)
+      @page = page
+      @element_handle = element_handle
+      @is_multiple = is_multiple
+    end
+
+    attr_reader :page
+
+    def element
+      @element_handle
+    end
+
+    def multiple?
+      @is_multiple
+    end
+
+    def set_files(files, noWaitAfter: nil, timeout: nil)
+      @element_handle.set_input_files(files, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+  end
+end

data/lib/playwright/http_headers.rb

@@ -0,0 +1,20 @@
+module Playwright
+  class HttpHeaders
+    # @param headers [Hash]
+    def initialize(headers)
+      @headers = headers
+    end
+
+    def as_serialized
+      @headers.map do |key, value|
+        { name: key, value: value }
+      end
+    end
+
+    def self.parse_serialized(serialized_headers)
+      new(serialized_headers.map do |header|
+        [header['name'].downcase, header['value']]
+      end.to_h)
+    end
+  end
+end

data/lib/playwright/input_files.rb

@@ -0,0 +1,42 @@
+require 'base64'
+require 'mime/types'
+
+module Playwright
+  class InputFiles
+    def initialize(files)
+      @params = convert(files)
+    end
+
+    def as_params
+      @params
+    end
+
+    private def convert(files)
+      return convert([files]) unless files.is_a?(Array)
+
+      files.map do |file|
+        case file
+        when String
+          {
+            name: File.basename(file),
+            mimeType: mime_type_for(file),
+            buffer: Base64.strict_encode64(File.read(file)),
+          }
+        when File
+          {
+            name: File.basename(file.path),
+            mimeType: mime_type_for(file.path),
+            buffer: Base64.strict_encode64(file.read),
+          }
+        else
+          raise ArgumentError.new('file must be a String or File.')
+        end
+      end
+    end
+
+    private def mime_type_for(filepath)
+      mime_types = MIME::Types.type_for(filepath)
+      mime_types.first.to_s || 'application/octet-stream'
+    end
+  end
+end

data/lib/playwright/javascript/expression.rb

@@ -47,6 +47,21 @@ module Playwright
         )
         ValueParser.new(value).parse
       end
+
+      def wait_for_function(channel, polling:, timeout:)
+        params = {
+          expression: @expression,
+          isFunction: false,
+          arg: @serialized_arg,
+          polling: polling,
+          timeout: timeout,
+        }.compact
+        if polling.is_a?(Numeric)
+          params[:pollingInterval] = polling
+        end
+        resp = channel.send_message_to_server('waitForFunction', params)
+        ChannelOwners::JSHandle.from(resp)
+      end
     end
   end
 end

data/lib/playwright/javascript/function.rb

@@ -47,6 +47,21 @@ module Playwright
         )
         ValueParser.new(value).parse
       end
+
+      def wait_for_function(channel, polling:, timeout:)
+        params = {
+          expression: @definition,
+          isFunction: true,
+          arg: @serialized_arg,
+          polling: polling,
+          timeout: timeout,
+        }.compact
+        if polling.is_a?(Numeric)
+          params[:pollingInterval] = polling
+        end
+        resp = channel.send_message_to_server('waitForFunction', params)
+        ChannelOwners::JSHandle.from(resp)
+      end
     end
   end
 end

data/lib/playwright/javascript/value_parser.rb

@@ -61,7 +61,7 @@ module Playwright
         end
 
         if hash.key?('o')
-          return hash['o'].map { |key, value| [key, parse_hash(value)].to_h }
+          return hash['o'].map { |obj| [obj['k'], parse_hash(obj['v'])] }.to_h
         end
 
         if hash.key?('h')

data/lib/playwright/javascript/value_serializer.rb

@@ -15,9 +15,9 @@ module Playwright
       # ref: https://github.com/microsoft/playwright-python/blob/25a99d53e00e35365cf5113b9525272628c0e65f/playwright/_impl/_js_handle.py#L99
       private def serialize_value(value)
         case value
-        when JSHandle
+        when ChannelOwners::JSHandle
           index = @handles.count
-          @handles << v
+          @handles << value.channel
           { h: index }
         when nil
           { v: 'undefined' }
@@ -28,23 +28,23 @@ module Playwright
         when -Float::INFINITY
           { v: '-Infinity' }
         when true, false
-          { b: v }
+          { b: value }
         when Numeric
-          { n: v }
+          { n: value }
         when String
-          { s: v }
+          { s: value }
         when Time
           require 'time'
-          { d: v.utc.iso8601 }
+          { d: value.utc.iso8601 }
         when Regexp
           flags = []
-          flags << 'ms' if (v.options & Regexp::MULTILINE) != 0
-          flags << 'i' if (v.options & Regexp::IGNORECASE) != 0
-          { r: { p: v.source, f: flags.join('') } }
+          flags << 'ms' if (value.options & Regexp::MULTILINE) != 0
+          flags << 'i' if (value.options & Regexp::IGNORECASE) != 0
+          { r: { p: value.source, f: flags.join('') } }
         when Array
-          { a: v.map { |value| serialize_value(value) } }
+          { a: value.map { |v| serialize_value(v) } }
         when Hash
-          { o: v.map { |key, value| [key, serialize_value(value)] }.to_h }
+          { o: value.map { |key, v| { k: key, v: serialize_value(v) } } }
         else
           raise ArgumentError.new("Unexpected value: #{value}")
         end

data/lib/playwright/{input_types/keyboard.rb → keyboard_impl.rb}

@@ -1,5 +1,9 @@
 module Playwright
-  define_input_type :Keyboard do
+  define_api_implementation :KeyboardImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+
     def down(key)
       @channel.send_message_to_server('keyboardDown', key: key)
       nil
@@ -13,7 +17,7 @@ module Playwright
       @channel.send_message_to_server('keyboardInsertText', text: text)
     end
 
-    def type_text(text, delay: nil)
+    def type(text, delay: nil)
       params = {
         text: text,
         delay: delay,

data/lib/playwright/mouse_impl.rb

@@ -0,0 +1,7 @@
+module Playwright
+  define_api_implementation :MouseImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+  end
+end

data/lib/playwright/playwright_api.rb

@@ -1,27 +1,34 @@
 module Playwright
   class PlaywrightApi
-    # Wrap ChannelOwner.
+    # Wrap ChannelOwner / ApiImplementation.
     # Playwright::ChannelOwners::XXXXX will be wrapped as Playwright::XXXXX
+    # Playwright::YYYYImpl will be wrapped as Playwright::YYYY
     # Playwright::XXXXX is automatically generated by development/generate_api
     #
-    # @param channel_owner [ChannelOwner]
+    # @param channel_owner [ChannelOwner|ApiImplementation]
     # @note Intended for internal use only.
-    def self.from_channel_owner(channel_owner)
-      Factory.new(channel_owner, 'ChannelOwners').create
+    def self.wrap(channel_owner_or_api_implementation)
+      case channel_owner_or_api_implementation
+      when ChannelOwner
+        ChannelOwnerWrapper.new(channel_owner_or_api_implementation).wrap
+      when ApiImplementation
+        ApiImplementationWrapper.new(channel_owner_or_api_implementation).wrap
+      else
+        nil
+      end
     end
 
-    class Factory
-      def initialize(impl, module_name)
+    class ChannelOwnerWrapper
+      def initialize(impl)
         impl_class_name = impl.class.name
-        unless impl_class_name.include?("::#{module_name}::")
-          raise "#{impl_class_name} is not #{module_name}"
+        unless impl_class_name.include?("::ChannelOwners::")
+          raise "#{impl_class_name} is not ChannelOwners"
         end
 
         @impl = impl
-        @module_name = module_name
       end
 
-      def create
+      def wrap
         api_class = detect_class_for(@impl.class)
         if api_class
           api_class.new(@impl)
@@ -33,11 +40,11 @@ module Playwright
       private
 
       def expected_class_name_for(klass)
-        klass.name.split("::#{@module_name}::").last
+        klass.name.split("::ChannelOwners::").last
       end
 
       def superclass_exist?(klass)
-        ![::Playwright::ChannelOwner, ::Playwright::InputType, Object].include?(klass.superclass)
+        ![::Playwright::ChannelOwner, Object].include?(klass.superclass)
       end
 
       def detect_class_for(klass)
@@ -52,7 +59,44 @@ module Playwright
       end
     end
 
-    # @param impl [Playwright::ChannelOwner|Playwright::InputType]
+    class ApiImplementationWrapper
+      def initialize(impl)
+        impl_class_name = impl.class.name
+        unless impl_class_name.end_with?("Impl")
+          raise "#{impl_class_name} is not Impl"
+        end
+
+        @impl = impl
+      end
+
+      def wrap
+        api_class = detect_class_for(@impl.class)
+        if api_class
+          api_class.new(@impl)
+        else
+          raise NotImplementedError.new("Playwright::#{expected_class_name_for(@impl.class)} is not implemented")
+        end
+      end
+
+      private
+
+      def expected_class_name_for(klass)
+        # KeyboardImpl -> Keyboard
+        # MouseImpl -> Mouse
+        klass.name[0...-4].split("::").last
+      end
+
+      def detect_class_for(klass)
+        class_name = expected_class_name_for(klass)
+        if ::Playwright.const_defined?(class_name)
+          ::Playwright.const_get(class_name)
+        else
+          nil
+        end
+      end
+    end
+
+    # @param impl [Playwright::ChannelOwner|Playwright::ApiImplementation]
     def initialize(impl)
       @impl = impl
     end
@@ -72,13 +116,16 @@ module Playwright
     end
 
     private def wrap_impl(object)
-      case object
-      when ChannelOwner
-        PlaywrightApi.from_channel_owner(object)
-      when InputType
-        Factory.new(object, 'InputTypes').create
-      when Array
+      if object.is_a?(Array)
         object.map { |obj| wrap_impl(obj) }
+      else
+        ::Playwright::PlaywrightApi.wrap(object) || object
+      end
+    end
+
+    private def unwrap_impl(object)
+      if object.is_a?(PlaywrightApi)
+        object.instance_variable_get(:@impl)
       else
         object
       end