playwright-ruby-client 0.0.8 → 0.3.0

data/lib/playwright/channel_owners/frame.rb

@@ -1,7 +1,7 @@
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_frame.py
   define_channel_owner :Frame do
-    def after_initialize
+    private def after_initialize
       if @initializer['parentFrame']
         @parent_frame = ChannelOwners::Frame.from(@initializer['parentFrame'])
         @parent_frame.send(:append_child_frame_from_child, self)
@@ -144,6 +144,13 @@ module Playwright
       end
     end
 
+    def wait_for_selector(selector, state: nil, timeout: nil)
+      params = { selector: selector, state: state, timeout: timeout }.compact
+      resp = @channel.send_message_to_server('waitForSelector', params)
+
+      ChannelOwners::ElementHandle.from_nullable(resp)
+    end
+
     def checked?(selector, timeout: nil)
       params = { selector: selector, timeout: timeout }.compact
       @channel.send_message_to_server('isChecked', params)
@@ -391,8 +398,20 @@ module Playwright
       nil
     end
 
-    def select_option(selector, values, noWaitAfter: nil, timeout: nil)
-      base_params = SelectOptionValues.new(values).as_params
+    def select_option(
+          selector,
+          element: nil,
+          index: nil,
+          value: nil,
+          label: nil,
+          noWaitAfter: nil,
+          timeout: nil)
+      base_params = SelectOptionValues.new(
+        element: element,
+        index: index,
+        value: value,
+        label: label,
+      ).as_params
       params = base_params + { selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
       @channel.send_message_to_server('selectOption', params)
 
@@ -400,8 +419,8 @@ module Playwright
     end
 
     def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
-      base_params = InputFiles.new(values).as_params
-      params = base_params + { selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
+      file_payloads = InputFiles.new(files).as_params
+      params = { files: file_payloads, selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
       @channel.send_message_to_server('setInputFiles', params)
 
       nil

data/lib/playwright/channel_owners/js_handle.rb

@@ -1,6 +1,6 @@
 module Playwright
   define_channel_owner :JSHandle do
-    def after_initialize
+    private def after_initialize
       @preview = @initializer['preview']
       @channel.on('previewUpdated', method(:on_preview_updated))
     end

data/lib/playwright/channel_owners/page.rb

@@ -6,16 +6,24 @@ module Playwright
     include Utils::Errors::SafeCloseError
     attr_writer :owned_context
 
-    def after_initialize
+    private def after_initialize
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
       @accessibility = Accessibility.new(@channel)
-      @keyboard = InputTypes::Keyboard.new(@channel)
-      @mouse = InputTypes::Mouse.new(@channel)
-      @touchscreen = InputTypes::Touchscreen.new(@channel)
-
-      @viewport_size = @initializer['viewportSize']
+      @keyboard = KeyboardImpl.new(@channel)
+      @mouse = MouseImpl.new(@channel)
+      @touchscreen = TouchscreenImpl.new(@channel)
+
+      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
@@ -26,7 +34,19 @@ module Playwright
         console_message = ChannelOwners::ConsoleMessage.from(params['message'])
         emit(Events::Page::Console, console_message)
       })
+      @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('fileChooser', ->(params) {
+        chooser = FileChooserImpl.new(
+                    page: self,
+                    element_handle: ChannelOwners::ElementHandle.from(params['element']),
+                    is_multiple: params['isMultiple'])
+        emit(Events::Page::FileChooser, chooser)
+      })
       @channel.on('frameAttached', ->(params) {
         on_frame_attached(ChannelOwners::Frame.from(params['frame']))
       })
@@ -34,9 +54,43 @@ module Playwright
         on_frame_detached(ChannelOwners::Frame.from(params['frame']))
       })
       @channel.on('load', ->(_) { emit(Events::Page::Load) })
+      @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']))
+      })
+      @channel.on('requestFailed', ->(params) {
+        on_request_failed(
+          ChannelOwners::Request.from(params['request']),
+          params['responseEndTiming'],
+          params['failureText'],
+        )
+      })
+      @channel.on('requestFinished', ->(params) {
+        on_request_finished(
+          ChannelOwners::Request.from(params['request']),
+          params['responseEndTiming'],
+        )
+      })
+      @channel.on('response', ->(params) {
+        emit(Events::Page::Response, ChannelOwners::Response.from(params['response']))
+      })
+      @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('webSocket', ->(params) {
+        emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
+      })
+      @channel.on('worker', ->(params) {
+        on_worker(ChannelOwners::Worker.from(params['worker']))
+      })
     end
 
     attr_reader \
@@ -47,6 +101,17 @@ module Playwright
       :viewport_size,
       :main_frame
 
+    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, request)
+    end
+
+    private def on_request_finished(request, response_end_timing)
+      request.send(:update_response_end_timing, response_end_timing)
+      emit(Events::Page::RequestFinished, request)
+    end
+
     private def on_frame_attached(frame)
       frame.send(:update_page_from_page, self)
       @frames << frame
@@ -59,12 +124,55 @@ module Playwright
       emit(Events::Page::FrameDetached, frame)
     end
 
+    private def 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
       @closed = true
       @browser_context.send(:remove_page, self)
       emit(Events::Page::Close)
     end
 
+    private def on_dialog(params)
+      dialog = ChannelOwners::Dialog.from(params['dialog'])
+      unless emit(Events::Page::Dialog, dialog)
+        dialog.dismiss
+      end
+    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
@@ -74,14 +182,7 @@ module Playwright
       ChannelOwners::Page.from(resp)
     end
 
-    def frame(frameSelector)
-      name, url =
-        if frameSelector.is_a?(Hash)
-          [frameSelector[:name], frameSelector[:url]]
-        else
-          [frameSelector, nil]
-        end
-
+    def frame(name: nil, url: nil)
       if name
         @frames.find { |f| f.name == name }
       elsif url
@@ -121,6 +222,38 @@ module Playwright
       @main_frame.query_selector_all(selector)
     end
 
+    def wait_for_selector(selector, state: nil, timeout: nil)
+      @main_frame.wait_for_selector(selector, state: state, timeout: timeout)
+    end
+
+    def checked?(selector, timeout: nil)
+      @main_frame.checked?(selector, timeout: timeout)
+    end
+
+    def disabled?(selector, timeout: nil)
+      @main_frame.disabled?(selector, timeout: timeout)
+    end
+
+    def editable?(selector, timeout: nil)
+      @main_frame.editable?(selector, timeout: timeout)
+    end
+
+    def enabled?(selector, timeout: nil)
+      @main_frame.enabled?(selector, timeout: timeout)
+    end
+
+    def hidden?(selector, timeout: nil)
+      @main_frame.hidden?(selector, timeout: timeout)
+    end
+
+    def visible?(selector, timeout: nil)
+      @main_frame.visible?(selector, timeout: timeout)
+    end
+
+    def dispatch_event(selector, type, eventInit: nil, timeout: nil)
+      @main_frame.dispatch_event(selector, type, eventInit: eventInit, timeout: timeout)
+    end
+
     def evaluate(pageFunction, arg: nil)
       @main_frame.evaluate(pageFunction, arg: arg)
     end
@@ -145,6 +278,25 @@ module Playwright
       @main_frame.add_style_tag(content: content, path: path, url: url)
     end
 
+    def expose_function(name, callback)
+      @channel.send_message_to_server('exposeBinding', name: name)
+      @bindings[name] = ->(_source, *args) { callback.call(*args) }
+    end
+
+    def expose_binding(name, callback, handle: nil)
+      params = {
+        name: name,
+        needsHandle: handle,
+      }.compact
+      @channel.send_message_to_server('exposeBinding', params)
+      @bindings[name] = callback
+    end
+
+    def set_extra_http_headers(headers)
+      serialized_headers = HttpHeaders.new(headers).as_serialized
+      @channel.send_message_to_server('setExtraHTTPHeaders', headers: serialized_headers)
+    end
+
     def url
       @main_frame.url
     end
@@ -174,12 +326,70 @@ module Playwright
       @main_frame.wait_for_load_state(state: state, timeout: timeout)
     end
 
+    def go_back(timeout: nil, waitUntil: nil)
+      params = { timeout: timeout, waitUntil: waitUntil }.compact
+      resp = @channel.send_message_to_server('goBack', params)
+      ChannelOwners::Response.from_nullable(resp)
+    end
+
+    def go_forward(timeout: nil, waitUntil: nil)
+      params = { timeout: timeout, waitUntil: waitUntil }.compact
+      resp = @channel.send_message_to_server('goForward', params)
+      ChannelOwners::Response.from_nullable(resp)
+    end
+
+    def emulate_media(colorScheme: nil, media: nil)
+      params = {
+        colorScheme: colorScheme,
+        media: media,
+      }.compact
+      @channel.send_message_to_server('emulateMedia', params)
+
+      nil
+    end
+
     def set_viewport_size(viewportSize)
       @viewport_size = viewportSize
       @channel.send_message_to_server('setViewportSize', { viewportSize: viewportSize })
       nil
     end
 
+    def bring_to_front
+      @channel.send_message_to_server('bringToFront')
+      nil
+    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 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,
@@ -269,6 +479,23 @@ module Playwright
       )
     end
 
+    def tap_point(
+          selector,
+          force: nil,
+          modifiers: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil)
+      @main_frame.tap_point(
+        selector,
+        force: force,
+        modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
+        position: position,
+        timeout: timeout,
+      )
+    end
+
     def fill(selector, value, noWaitAfter: nil, timeout: nil)
       @main_frame.fill(selector, value, noWaitAfter: noWaitAfter, timeout: timeout)
     end
@@ -277,6 +504,60 @@ module Playwright
       @main_frame.focus(selector, timeout: timeout)
     end
 
+    def text_content(selector, timeout: nil)
+      @main_frame.text_content(selector, timeout: timeout)
+    end
+
+    def inner_text(selector, timeout: nil)
+      @main_frame.inner_text(selector, timeout: timeout)
+    end
+
+    def inner_html(selector, timeout: nil)
+      @main_frame.inner_html(selector, timeout: timeout)
+    end
+
+    def get_attribute(selector, name, timeout: nil)
+      @main_frame.get_attribute(selector, name, timeout: timeout)
+    end
+
+    def hover(
+          selector,
+          force: nil,
+          modifiers: nil,
+          position: nil,
+          timeout: nil)
+      @main_frame.hover(
+        selector,
+        force: force,
+        modifiers: modifiers,
+        position: position,
+        timeout: timeout,
+      )
+    end
+
+    def select_option(
+          selector,
+          element: nil,
+          index: nil,
+          value: nil,
+          label: nil,
+          noWaitAfter: nil,
+          timeout: nil)
+      @main_frame.select_option(
+        selector,
+        element: element,
+        index: index,
+        value: value,
+        label: label,
+        noWaitAfter: noWaitAfter,
+        timeout: timeout,
+      )
+    end
+
+    def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+      @main_frame.set_input_files(selector, files, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
     def type(
       selector,
       text,
@@ -297,10 +578,57 @@ 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)
+    end
+
+    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
+      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
       @main_frame.wait_for_function(pageFunction, arg: arg, polling: polling, timeout: timeout)
     end
 
+    def pdf(
+          displayHeaderFooter: nil,
+          footerTemplate: nil,
+          format: nil,
+          headerTemplate: nil,
+          height: nil,
+          landscape: nil,
+          margin: nil,
+          pageRanges: nil,
+          path: nil,
+          preferCSSPageSize: nil,
+          printBackground: nil,
+          scale: nil,
+          width: nil)
+
+      params = {
+        displayHeaderFooter: displayHeaderFooter,
+        footerTemplate: footerTemplate,
+        format: format,
+        headerTemplate: headerTemplate,
+        height: height,
+        landscape: landscape,
+        margin: margin,
+        pageRanges: pageRanges,
+        preferCSSPageSize: preferCSSPageSize,
+        printBackground: printBackground,
+        scale: scale,
+        width: width,
+      }.compact
+      encoded_binary = @channel.send_message_to_server('pdf', params)
+      decoded_binary = Base64.strict_decode64(encoded_binary)
+      if path
+        File.open(path, 'wb') do |f|
+          f.write(decoded_binary)
+        end
+      end
+      decoded_binary
+    end
+
     class CrashedError < StandardError
       def initialize
         super('Page crashed')
@@ -319,20 +647,9 @@ module Playwright
       end
     end
 
-    def expect_event(event, optionsOrPredicate: nil, &block)
-      predicate, timeout =
-        case optionsOrPredicate
-        when Proc
-          [optionsOrPredicate, nil]
-        when Hash
-          [optionsOrPredicate[:predicate], optionsOrPredicate[:timeout]]
-        else
-          [nil, nil]
-        end
-      timeout ||= @timeout_settings.timeout
-
+    def expect_event(event, predicate: nil, timeout: nil, &block)
       wait_helper = WaitHelper.new
-      wait_helper.reject_on_timeout(timeout, "Timeout while waiting for event \"#{event}\"")
+      wait_helper.reject_on_timeout(timeout || @timeout_settings.timeout, "Timeout while waiting for event \"#{event}\"")
 
       unless event == Events::Page::Crash
         wait_helper.reject_on_event(self, Events::Page::Crash, CrashedError.new)
@@ -349,6 +666,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,
@@ -357,6 +686,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
@@ -369,7 +702,7 @@ module Playwright
           -> (_) { true }
         end
 
-      expect_event(Events::Page::Request, optionsOrPredicate: { predicate: predicate, timeout: timeout})
+      expect_event(Events::Page::Request, predicate: predicate, timeout: timeout)
     end
 
     def expect_response(urlOrPredicate, timeout: nil)
@@ -384,7 +717,7 @@ module Playwright
           -> (_) { true }
         end
 
-      expect_event(Events::Page::Response, optionsOrPredicate: { predicate: predicate, timeout: timeout})
+      expect_event(Events::Page::Response, predicate: predicate, timeout: timeout)
     end
 
     # called from BrowserContext#on_page with send(:update_browser_context, page), so keep private.
@@ -397,5 +730,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