playwright-ruby-client 0.1.0 → 0.5.3

data/lib/playwright/channel.rb

@@ -15,8 +15,9 @@ module Playwright
 
     # @param method [String]
     # @param params [Hash]
+    # @return [Playwright::ChannelOwner|nil]
     def send_message_to_server(method, params = {})
-      result = @connection.send_message_to_server(@guid, method, params)
+      result = send_message_to_server_result(method, params)
       if result.is_a?(Hash)
         _type, channel_owner = result.first
         channel_owner
@@ -27,8 +28,17 @@ module Playwright
 
     # @param method [String]
     # @param params [Hash]
-    def send_no_reply(method, params)
+    # @return [Hash]
+    def send_message_to_server_result(method, params)
+      @connection.send_message_to_server(@guid, method, params)
+    end
+
+    # @param method [String]
+    # @param params [Hash]
+    # @returns nil
+    def async_send_message_to_server(method, params = {})
       @connection.async_send_message_to_server(@guid, method, params)
+
       nil
     end
   end

data/lib/playwright/channel_owner.rb

@@ -59,16 +59,14 @@ module Playwright
       "#<#{@guid}>"
     end
 
-    private
-
-    def after_initialize
+    private def after_initialize
     end
 
-    def update_object_from_child(guid, child)
+    private def update_object_from_child(guid, child)
       @objects[guid] = child
     end
 
-    def delete_object_from_child(guid)
+    private def delete_object_from_child(guid)
       @objects.delete(guid)
     end
   end

data/lib/playwright/channel_owners/android.rb

@@ -1,6 +1,6 @@
 module Playwright
   define_channel_owner :Android do
-    def after_initialize
+    private def after_initialize
       @timeout_settings = TimeoutSettings.new
     end
 

data/lib/playwright/channel_owners/android_device.rb

@@ -2,7 +2,7 @@ module Playwright
   define_channel_owner :AndroidDevice do
     include Utils::PrepareBrowserContextOptions
 
-    def after_initialize
+    private def after_initialize
       @input = AndroidInputImpl.new(@channel)
     end
 
@@ -104,17 +104,17 @@ module Playwright
           isMobile: nil,
           javaScriptEnabled: nil,
           locale: nil,
-          logger: nil,
+          noViewport: nil,
           offline: nil,
           permissions: nil,
           proxy: nil,
-          recordHar: nil,
-          recordVideo: nil,
+          record_har_omit_content: nil,
+          record_har_path: nil,
+          record_video_dir: nil,
+          record_video_size: nil,
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
-          videoSize: nil,
-          videosPath: nil,
           viewport: nil,
           &block)
       params = {
@@ -131,17 +131,17 @@ module Playwright
         isMobile: isMobile,
         javaScriptEnabled: javaScriptEnabled,
         locale: locale,
-        logger: logger,
+        noViewport: noViewport,
         offline: offline,
         permissions: permissions,
         proxy: proxy,
-        recordHar: recordHar,
-        recordVideo: recordVideo,
+        record_har_omit_content: record_har_omit_content,
+        record_har_path: record_har_path,
+        record_video_dir: record_video_dir,
+        record_video_size: record_video_size,
         storageState: storageState,
         timezoneId: timezoneId,
         userAgent: userAgent,
-        videoSize: videoSize,
-        videosPath: videosPath,
         viewport: viewport,
       }.compact
       prepare_browser_context_options(params)

data/lib/playwright/channel_owners/artifact.rb

@@ -0,0 +1,30 @@
+module Playwright
+  define_channel_owner :Artifact do
+    private def after_initialize
+      @is_remote = false
+      @absolute_path = @initializer['absolutePath']
+    end
+
+    attr_reader :absolute_path
+
+    def path_after_finished
+      if @is_remote
+        raise "Path is not available when using browser_type.connect(). Use save_as() to save a local copy."
+      end
+      @channel.send_message_to_server('pathAfterFinished')
+    end
+
+    def save_as(path)
+      stream = ChannelOwners::Stream.from(@channel.send_message_to_server('saveAsStream'))
+      stream.save_as(path)
+    end
+
+    def failure
+      @channel.send_message_to_server('failure')
+    end
+
+    def delete
+      @channel.send_message_to_server('delete')
+    end
+  end
+end

data/lib/playwright/channel_owners/binding_call.rb

@@ -1,4 +1,7 @@
 module Playwright
   define_channel_owner :BindingCall do
+    def name
+      @initializer['name']
+    end
   end
 end

data/lib/playwright/channel_owners/browser.rb

@@ -4,7 +4,7 @@ module Playwright
     include Utils::Errors::SafeCloseError
     include Utils::PrepareBrowserContextOptions
 
-    def after_initialize
+    private def after_initialize
       @contexts = Set.new
       @channel.on('close', method(:on_close))
     end
@@ -59,12 +59,33 @@ module Playwright
       @initializer['version']
     end
 
+    def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
+      params = {
+        page: page&.channel,
+        categories: categories,
+        path: path,
+        screenshots: screenshots,
+      }.compact
+
+      @channel.send_message_to_server('startTracing', params)
+    end
+
+    def stop_tracing
+      encoded_binary = @channel.send_message_to_server("stopTracing")
+      return Base64.strict_decode64(encoded_binary)
+    end
+
     private def on_close(_ = {})
       @connected = false
       emit(Events::Browser::Disconnected)
       @closed_or_closing = false
     end
 
+    # called from BrowserType#connectOverCDP
+    private def add_context(context)
+      @contexts << context
+    end
+
     # called from BrowserContext#on_close with send(:remove_context), so keep private.
     private def remove_context(context)
       @contexts.delete(context)

data/lib/playwright/channel_owners/browser_context.rb

@@ -2,11 +2,16 @@ module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_browser_context.py
   define_channel_owner :BrowserContext do
     include Utils::Errors::SafeCloseError
-    attr_writer :browser, :owner_page, :options
+    attr_accessor :browser
+    attr_writer :owner_page, :options
 
-    def after_initialize
+    private def after_initialize
       @pages = Set.new
+      @routes = Set.new
+      @bindings = {}
+      @timeout_settings = TimeoutSettings.new
 
+      @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
       @channel.once('close', ->(_) { on_close })
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
       @channel.on('route', ->(params) {
@@ -18,11 +23,36 @@ module Playwright
       page.send(:update_browser_context, self)
       @pages << page
       emit(Events::BrowserContext::Page, page)
+      page.send(:emit_popup_event_from_browser_context)
     end
 
     private def on_route(route, request)
-      # @routes.each ...
-      route.continue_
+      # It is not desired to use PlaywrightApi.wrap directly.
+      # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
+      # Just a workaround...
+      wrapped_route = PlaywrightApi.wrap(route)
+      wrapped_request = PlaywrightApi.wrap(request)
+
+      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
+        route.continue
+      end
+    end
+
+    private def on_binding(binding_call)
+      func = @binding[binding_call.name]
+      if func
+        binding_call.call(func)
+      end
+    end
+
+    def set_default_navigation_timeout(timeout)
+      @timeout_settings.default_navigation_timeout = timeout
+      @channel.send_message_to_server('setDefaultNavigationTimeoutNoReply', timeout: timeout)
+    end
+
+    def set_default_timeout(timeout)
+      @timeout_settings.default_timeout = timeout
+      @channel.send_message_to_server('setDefaultTimeoutNoReply', timeout: timeout)
     end
 
     def pages
@@ -36,6 +66,111 @@ module Playwright
       ChannelOwners::Page.from(resp)
     end
 
+    def cookies(urls: nil)
+      target_urls =
+        if urls.nil?
+          []
+        elsif urls.is_a?(Enumerable)
+          urls
+        else
+          [urls]
+        end
+      @channel.send_message_to_server('cookies', urls: urls)
+    end
+
+    def add_cookies(cookies)
+      @channel.send_message_to_server('addCookies', cookies: cookies)
+    end
+
+    def clear_cookies
+      @channel.send_message_to_server('clearCookies')
+    end
+
+    def grant_permissions(permissions, origin: nil)
+      params = {
+        permissions: permissions,
+        origin: origin,
+      }.compact
+      @channel.send_message_to_server('grantPermissions', params)
+    end
+
+    def clear_permissions
+      @channel.send_message_to_server('clearPermissions')
+    end
+
+    def set_geolocation(geolocation)
+      @channel.send_message_to_server('setGeolocation', geolocation: geolocation)
+    end
+
+    def set_extra_http_headers(headers)
+      @channel.send_message_to_server('setExtraHTTPHeaders',
+        headers: HttpHeaders.new(headers).as_serialized)
+    end
+
+    def set_offline(offline)
+      @channel.send_message_to_server('setOffline', offline: offline)
+    end
+
+    def add_init_script(path: nil, script: nil)
+      source =
+        if path
+          File.read(path)
+        elsif script
+          script
+        else
+          raise ArgumentError.new('Either path or script parameter must be specified')
+        end
+
+      @channel.send_message_to_server('addInitScript', source: script)
+      nil
+    end
+
+    def expose_binding(name, callback, handle: nil)
+      if @pages.any? { |page| page.send(:has_bindings?, name) }
+        raise ArgumentError.new("Function \"#{name}\" has been already registered in one of the pages")
+      end
+      if @bindings.key?(name)
+        raise ArgumentError.new("Function \"#{name}\" has been already registered")
+      end
+      params = {
+        name: name,
+        needsHandle: handle,
+      }.compact
+      @bindings[name] = callback
+      @channel.send_message_to_server('exposeBinding', params)
+    end
+
+    def expose_function(name, callback)
+      expose_binding(name, ->(_source, *args) { callback.call(*args) }, )
+    end
+
+    def route(url, handler)
+      entry = RouteHandlerEntry.new(url, handler)
+      @routes << entry
+      if @routes.count >= 1
+        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: true)
+      end
+    end
+
+    def unroute(url, handler: nil)
+      @routes.reject! do |handler_entry|
+        handler_entry.same_value?(url: url, handler: handler)
+      end
+      if @routes.count == 0
+        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+      end
+    end
+
+    def expect_event(event, predicate: nil, timeout: nil, &block)
+      wait_helper = WaitHelper.new
+      wait_helper.reject_on_timeout(timeout || @timeout_settings.timeout, "Timeout while waiting for event \"#{event}\"")
+      wait_helper.wait_for_event(self, event, predicate: predicate)
+
+      block&.call
+
+      wait_helper.promise.value!
+    end
+
     private def on_close
       @closed_or_closing = true
       @browser&.send(:remove_context, self)
@@ -51,6 +186,18 @@ module Playwright
       raise unless safe_close_error?(err)
     end
 
+    def pause
+      @channel.send_message_to_server('pause')
+    end
+
+    def expect_page(predicate: nil, timeout: nil)
+      params = {
+        predicate: predicate,
+        timeout: timeout,
+      }.compact
+      expect_event(Events::BrowserContext::Page, params)
+    end
+
     # called from Page#on_close with send(:remove_page, page), so keep private
     private def remove_page(page)
       @pages.delete(page)
@@ -60,5 +207,9 @@ module Playwright
     private def _timeout_settings
       @timeout_settings
     end
+
+    private def has_record_video_option?
+      @options.key?(:recordVideo)
+    end
   end
 end

data/lib/playwright/channel_owners/browser_type.rb

@@ -22,5 +22,33 @@ module Playwright
         browser
       end
     end
+
+    def connect_over_cdp(endpointURL, slowMo: nil, timeout: nil, &block)
+      raise 'Connecting over CDP is only supported in Chromium.' unless name == 'chromium'
+
+      params = {
+        sdkLanguage: 'ruby',
+        endpointURL: endpointURL,
+        slowMo: slowMo,
+        timeout: timeout,
+      }.compact
+      result = @channel.send_message_to_server_result('connectOverCDP', params)
+      browser = ChannelOwners::Browser.from(result['browser'])
+
+      if result['defaultContext']
+        context = ChannelOwners::BrowserContext.from(result['defaultContext'])
+        browser.send(:add_context, context)
+      end
+
+      if block
+        begin
+          block.call(browser)
+        ensure
+          browser.close
+        end
+      else
+        browser
+      end
+    end
   end
 end

data/lib/playwright/channel_owners/dialog.rb

@@ -0,0 +1,28 @@
+module Playwright
+  define_channel_owner :Dialog do
+    def type
+      @initializer['type']
+    end
+
+    def message
+      @initializer['message']
+    end
+
+    def default_value
+      @initializer['defaultValue']
+    end
+
+    def accept(promptText: nil)
+      accept_async(prompt_text: promptText).value!
+    end
+
+    def accept_async(promptText: nil)
+      params = { promptText: promptText }.compact
+      @channel.async_send_message_to_server('accept', params)
+    end
+
+    def dismiss
+      @channel.async_send_message_to_server('dismiss')
+    end
+  end
+end