playwright-ruby-client 0.2.0 → 0.5.4

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

@@ -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
 
     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

data/lib/playwright/channel_owners/element_handle.rb

@@ -82,7 +82,7 @@ module Playwright
           modifiers: modifiers,
           position: position,
           timeout: timeout,
-        }
+        }.compact
         @channel.send_message_to_server('hover', params)
 
         nil
@@ -179,7 +179,7 @@ module Playwright
           value: value,
           noWaitAfter: noWaitAfter,
           timeout: timeout,
-        }
+        }.compact
         @channel.send_message_to_server('fill', params)
 
         nil
@@ -230,10 +230,11 @@ module Playwright
         nil
       end
 
-      def check(force: nil, noWaitAfter: nil, timeout: nil)
+      def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
+          position: position,
           timeout: timeout,
         }.compact
         @channel.send_message_to_server('check', params)
@@ -241,10 +242,11 @@ module Playwright
         nil
       end
 
-      def uncheck(force: nil, noWaitAfter: nil, timeout: nil)
+      def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
+          position: position,
           timeout: timeout,
         }.compact
         @channel.send_message_to_server('uncheck', params)

data/lib/playwright/channel_owners/frame.rb

@@ -98,6 +98,15 @@ module Playwright
       request&.response
     end
 
+    def wait_for_url(url, timeout: nil, waitUntil: nil)
+      matcher = UrlMatcher.new(url)
+      if matcher.match?(@url)
+        wait_for_load_state(state: waitUntil, timeout: timeout)
+      else
+        expect_navigation(timeout: timeout, url: url, waitUntil: waitUntil)
+      end
+    end
+
     def wait_for_load_state(state: nil, timeout: nil)
       option_state = state || 'load'
       option_timeout = timeout || @page.send(:timeout_settings).navigation_timeout
@@ -464,11 +473,18 @@ module Playwright
       nil
     end
 
-    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
+    def check(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
       params = {
         selector: selector,
         force: force,
         noWaitAfter:  noWaitAfter,
+        position: position,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('check', params)
@@ -476,11 +492,18 @@ module Playwright
       nil
     end
 
-    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
+    def uncheck(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
       params = {
         selector: selector,
         force: force,
         noWaitAfter:  noWaitAfter,
+        position: position,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('uncheck', params)

data/lib/playwright/channel_owners/js_handle.rb

@@ -9,8 +9,8 @@ module Playwright
       @preview
     end
 
-    private def on_preview_updated(preview)
-      @preview = preview
+    private def on_preview_updated(params)
+      @preview = params['preview']
     end
 
     def evaluate(pageFunction, arg: nil)

data/lib/playwright/channel_owners/page.rb

@@ -14,12 +14,21 @@ module Playwright
       @mouse = MouseImpl.new(@channel)
       @touchscreen = TouchscreenImpl.new(@channel)
 
-      @viewport_size = @initializer['viewportSize']
+      if @initializer['viewportSize']
+        @viewport_size = {
+          width: @initializer['viewportSize']['width'],
+          height: @initializer['viewportSize']['height'],
+        }
+      end
       @closed = false
+      @bindings = {}
+      @routes = Set.new
+
       @main_frame = ChannelOwners::Frame.from(@initializer['mainFrame'])
       @main_frame.send(:update_page_from_page, self)
       @frames = Set.new
       @frames << @main_frame
+      @opener = ChannelOwners::Page.from_nullable(@initializer['opener'])
 
       @channel.once('close', ->(_) { on_close })
       @channel.on('console', ->(params) {
@@ -29,9 +38,7 @@ module Playwright
       @channel.on('crash', ->(_) { emit(Events::Page::Crash) })
       @channel.on('dialog', method(:on_dialog))
       @channel.on('domcontentloaded', ->(_) { emit(Events::Page::DOMContentLoaded) })
-      @channel.on('download', ->(params) {
-        emit(Events::Page::Download, ChannelOwners::Download.from(params['download']))
-      })
+      @channel.on('download', method(:on_download))
       @channel.on('fileChooser', ->(params) {
         chooser = FileChooserImpl.new(
                     page: self,
@@ -49,9 +56,6 @@ module Playwright
       @channel.on('pageError', ->(params) {
         emit(Events::Page::PageError, Error.parse(params['error']['error']))
       })
-      @channel.on('popup', ->(params) {
-        emit(Events::Page::Popup, ChannelOwners::Page.from(params['page']))
-      })
       @channel.on('request', ->(params) {
         emit(Events::Page::Request, ChannelOwners::Request.from(params['request']))
       })
@@ -74,9 +78,7 @@ module Playwright
       @channel.on('route', ->(params) {
         on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
       })
-      @channel.on('video', ->(params) {
-        video.send(:update_relative_path, params['relativePath'])
-      })
+      @channel.on('video', method(:on_video))
       @channel.on('webSocket', ->(params) {
         emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
       })
@@ -96,12 +98,12 @@ module Playwright
     private def on_request_failed(request, response_end_timing, failure_text)
       request.send(:update_failure_text, failure_text)
       request.send(:update_response_end_timing, response_end_timing)
-      emit(Events::Page::RequestFailed)
+      emit(Events::Page::RequestFailed, request)
     end
 
     private def on_request_finished(request, response_end_timing)
       request.send(:update_response_end_timing, response_end_timing)
-      emit(Events::Page::RequestFinished)
+      emit(Events::Page::RequestFinished, request)
     end
 
     private def on_frame_attached(frame)
@@ -117,8 +119,15 @@ module Playwright
     end
 
     private def on_route(route, request)
-      # @routes.each ...
-      @browser_context.send(:on_route, route, request)
+      # 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) }
+        @browser_context.send(:on_route, route, request)
+      end
     end
 
     private def on_close
@@ -130,14 +139,28 @@ module Playwright
     private def on_dialog(params)
       dialog = ChannelOwners::Dialog.from(params['dialog'])
       unless emit(Events::Page::Dialog, dialog)
-        dialog.dismiss # FIXME: this should be asynchronous
+        dialog.dismiss
       end
     end
 
+    private def on_download(params)
+      download = Download.new(
+        url: params['url'],
+        suggested_filename: params['suggestedFilename'],
+        artifact: ChannelOwners::Artifact.from(params['artifact']),
+      )
+      emit(Events::Page::Download, download)
+    end
+
+    private def on_video(params)
+      artifact = ChannelOwners::Artifact.from(params['artifact'])
+      video.send(:set_artifact, artifact)
+    end
+
     # @override
     def on(event, callback)
       if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: true)
+        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: true)
       end
       super
     end
@@ -145,7 +168,7 @@ module Playwright
     # @override
     def once(event, callback)
       if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: true)
+        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: true)
       end
       super
     end
@@ -154,7 +177,7 @@ module Playwright
     def off(event, callback)
       super
       if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: false)
+        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: false)
       end
     end
 
@@ -163,8 +186,17 @@ module Playwright
     end
 
     def opener
-      resp = @channel.send_message_to_server('opener')
-      ChannelOwners::Page.from(resp)
+      if @opener&.closed?
+        nil
+      else
+        @opener
+      end
+    end
+
+    private def emit_popup_event_from_browser_context
+      if @opener && !@opener.closed?
+        @opener.emit(Events::Page::Popup, self)
+      end
     end
 
     def frame(name: nil, url: nil)
@@ -311,6 +343,10 @@ module Playwright
       @main_frame.wait_for_load_state(state: state, timeout: timeout)
     end
 
+    def wait_for_url(url, timeout: nil, waitUntil: nil)
+      @main_frame.wait_for_url(url, timeout: timeout,  waitUntil: waitUntil)
+    end
+
     def go_back(timeout: nil, waitUntil: nil)
       params = { timeout: timeout, waitUntil: waitUntil }.compact
       resp = @channel.send_message_to_server('goBack', params)
@@ -347,7 +383,7 @@ module Playwright
     def add_init_script(path: nil, script: nil)
       source =
         if path
-          File.read(path, 'r')
+          File.read(path)
         elsif script
           script
         else
@@ -358,6 +394,23 @@ module Playwright
       nil
     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 screenshot(
       path: nil,
       type: nil,
@@ -546,12 +599,24 @@ module Playwright
       @main_frame.press(selector, key, delay: delay, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
-    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
-      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    def check(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
+      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
     end
 
-    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
-      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    def uncheck(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
+      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
     end
 
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
@@ -597,6 +662,36 @@ module Playwright
       decoded_binary
     end
 
+    def video
+      return nil unless @browser_context.send(:has_record_video_option?)
+      @video ||= Video.new(self)
+    end
+
+    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      params = {
+        resetOnNavigation: resetOnNavigation,
+        reportAnonymousScripts: reportAnonymousScripts,
+      }.compact
+
+      @channel.send_message_to_server('startJSCoverage', params)
+    end
+
+    def stop_js_coverage
+      @channel.send_message_to_server('stopJSCoverage')
+    end
+
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      params = {
+        resetOnNavigation: resetOnNavigation,
+      }.compact
+
+      @channel.send_message_to_server('startCSSCoverage', params)
+    end
+
+    def stop_css_coverage
+      @channel.send_message_to_server('stopCSSCoverage')
+    end
+
     class CrashedError < StandardError
       def initialize
         super('Page crashed')
@@ -634,6 +729,18 @@ module Playwright
       wait_helper.promise.value!
     end
 
+    def expect_console_message(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::Console, predicate: predicate, timeout: timeout, &block)
+    end
+
+    def expect_download(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::Download, predicate: predicate, timeout: timeout, &block)
+    end
+
+    def expect_file_chooser(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::FileChooser, predicate: predicate, timeout: timeout, &block)
+    end
+
     def expect_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
       @main_frame.expect_navigation(
         timeout: timeout,
@@ -642,6 +749,10 @@ module Playwright
         &block)
     end
 
+    def expect_popup(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::Popup, predicate: predicate, timeout: timeout, &block)
+    end
+
     def expect_request(urlOrPredicate, timeout: nil)
       predicate =
         case urlOrPredicate
@@ -682,5 +793,10 @@ module Playwright
     private def timeout_settings
       @timeout_settings
     end
+
+    # called from BrowserContext#expose_binding
+    private def has_bindings?(name)
+      @bindings.key?(name)
+    end
   end
 end