playwright-ruby-client 0.6.3 → 0.7.1

data/lib/playwright/channel_owners/browser.rb

@@ -30,24 +30,28 @@ module Playwright
       @contexts << context
       context.browser = self
       context.options = params
+      return context unless block
 
-      if block
-        begin
-          block.call(context)
-        ensure
-          context.close
-        end
-      else
-        context
+      begin
+        block.call(context)
+      ensure
+        context.close
       end
     end
 
-    def new_page(**options)
+    def new_page(**options, &block)
       context = new_context(**options)
       page = context.new_page
       page.owned_context = context
       context.owner_page = page
-      page
+
+      return page unless block
+
+      begin
+        block.call(page)
+      ensure
+        page.close
+      end
     end
 
     def close
@@ -63,6 +67,11 @@ module Playwright
       @initializer['version']
     end
 
+    def new_browser_cdp_session
+      resp = @channel.send_message_to_server('newBrowserCDPSession')
+      ChannelOwners::CDPSession.from(resp)
+    end
+
     def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
       params = {
         page: page&.channel,

data/lib/playwright/channel_owners/browser_context.rb

@@ -98,6 +98,11 @@ module Playwright
       page&.emit(Events::Page::Response, response)
     end
 
+    def new_cdp_session(page)
+      resp = @channel.send_message_to_server('newCDPSession', page: page.channel)
+      ChannelOwners::CDPSession.from(resp)
+    end
+
     def set_default_navigation_timeout(timeout)
       @timeout_settings.default_navigation_timeout = timeout
       @channel.send_message_to_server('setDefaultNavigationTimeoutNoReply', timeout: timeout)
@@ -113,10 +118,17 @@ module Playwright
     end
 
     # @returns [Playwright::Page]
-    def new_page
+    def new_page(&block)
       raise 'Please use browser.new_context' if @owner_page
       resp = @channel.send_message_to_server('newPage')
-      ChannelOwners::Page.from(resp)
+      page = ChannelOwners::Page.from(resp)
+      return page unless block
+
+      begin
+        block.call(page)
+      ensure
+        page.close
+      end
     end
 
     def cookies(urls: nil)

data/lib/playwright/channel_owners/browser_type.rb

@@ -1,5 +1,7 @@
 module Playwright
   define_channel_owner :BrowserType do
+    include Utils::PrepareBrowserContextOptions
+
     def name
       @initializer['name']
     end
@@ -11,15 +13,28 @@ module Playwright
     def launch(options, &block)
       resp = @channel.send_message_to_server('launch', options.compact)
       browser = ChannelOwners::Browser.from(resp)
+      return browser unless block
 
-      if block
-        begin
-          block.call(browser)
-        ensure
-          browser.close
-        end
-      else
-        browser
+      begin
+        block.call(browser)
+      ensure
+        browser.close
+      end
+    end
+
+    def launch_persistent_context(userDataDir, **options, &block)
+      params = options.dup
+      prepare_browser_context_options(params)
+      params['userDataDir'] = userDataDir
+
+      resp = @channel.send_message_to_server('launchPersistentContext', params.compact)
+      context = ChannelOwners::Browser.from(resp)
+      return context unless block
+
+      begin
+        block.call(context)
+      ensure
+        context.close
       end
     end
 

data/lib/playwright/channel_owners/cdp_session.rb

@@ -0,0 +1,19 @@
+module Playwright
+  define_channel_owner :CDPSession do
+    private def after_initialize
+      @channel.on('event', method(:on_event))
+    end
+
+    private def on_event(params)
+      emit(params['method'], params['params'])
+    end
+
+    def send_message(method, params: {})
+      @channel.send_message_to_server('send', method: method, params: params)
+    end
+
+    def detach
+      @channel.send_message_to_server('detach')
+    end
+  end
+end

data/lib/playwright/channel_owners/page.rb

@@ -759,6 +759,10 @@ module Playwright
       expect_event(Events::Page::Request, predicate: predicate, timeout: timeout, &block)
     end
 
+    def expect_request_finished(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::RequestFinished, predicate: predicate, timeout: timeout, &block)
+    end
+
     def expect_response(urlOrPredicate, timeout: nil, &block)
       predicate =
         case urlOrPredicate
@@ -774,6 +778,10 @@ module Playwright
       expect_event(Events::Page::Response, predicate: predicate, timeout: timeout, &block)
     end
 
+    def expect_websocket(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::WebSocket, predicate: predicate, timeout: timeout, &block)
+    end
+
     # called from Frame with send(:timeout_settings)
     private def timeout_settings
       @timeout_settings

data/lib/playwright/channel_owners/response.rb

@@ -4,7 +4,7 @@ require 'json'
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Response do
-    def after_initialize
+    private def after_initialize
       @request = ChannelOwners::Request.from(@initializer['request'])
       timing = @initializer['timing']
       @request.send(:update_timings,

data/lib/playwright/channel_owners/web_socket.rb

@@ -0,0 +1,87 @@
+require 'base64'
+
+module Playwright
+  define_channel_owner :WebSocket do
+    private def after_initialize
+      @closed = false
+
+      @channel.on('frameSent', -> (params) {
+        on_frame_sent(params['opcode'], params['data'])
+      })
+      @channel.on('frameReceived', -> (params) {
+        on_frame_received(params['opcode'], params['data'])
+      })
+      @channel.on('socketError', -> (params) {
+        emit(Events::WebSocket::Error, params['error'])
+      })
+      @channel.on('close', -> (_) { on_close })
+    end
+
+    def url
+      @initializer['url']
+    end
+
+    class SocketClosedError < StandardError
+      def initialize
+        super('Socket closed')
+      end
+    end
+
+    class SocketError < StandardError
+      def initialize
+        super('Socket error')
+      end
+    end
+
+    class PageClosedError < StandardError
+      def initialize
+        super('Page closed')
+      end
+    end
+
+    def expect_event(event, predicate: nil, timeout: nil, &block)
+      wait_helper = WaitHelper.new
+      wait_helper.reject_on_timeout(timeout || @parent.send(:timeout_settings).timeout, "Timeout while waiting for event \"#{event}\"")
+
+      unless event == Events::WebSocket::Close
+        wait_helper.reject_on_event(self, Events::WebSocket::Close, SocketClosedError.new)
+      end
+
+      unless event == Events::WebSocket::Error
+        wait_helper.reject_on_event(self, Events::WebSocket::Error, SocketError.new)
+      end
+
+      wait_helper.reject_on_event(@parent, 'close', PageClosedError.new)
+      wait_helper.wait_for_event(self, event, predicate: predicate)
+      block&.call
+
+      wait_helper.promise.value!
+    end
+    alias_method :wait_for_event, :expect_event
+
+    private def on_frame_sent(opcode, data)
+      if opcode == 2
+        emit(Events::WebSocket::FrameSent, Base64.strict_decode64(data))
+      else
+        emit(Events::WebSocket::FrameSent, data)
+      end
+    end
+
+    private def on_frame_received(opcode, data)
+      if opcode == 2
+        emit(Events::WebSocket::FrameReceived, Base64.strict_decode64(data))
+      else
+        emit(Events::WebSocket::FrameReceived, data)
+      end
+    end
+
+    def closed?
+      @closed
+    end
+
+    private def on_close
+      @closed = true
+      emit(Events::WebSocket::Close)
+    end
+  end
+end

data/lib/playwright/tracing_impl.rb

@@ -15,17 +15,17 @@ module Playwright
     end
 
     # Stop tracing.
-    def stop
+    def stop(path: nil)
       @channel.send_message_to_server('tracingStop')
-    end
 
-    def export(path)
-      resp = @channel.send_message_to_server('tracingExport')
-      artifact = ChannelOwners::Artifact.from(resp)
-      # if self._context._browser:
-      #   artifact._is_remote = self._context._browser._is_remote
-      artifact.save_as(path)
-      artifact.delete
+      if path
+        resp = @channel.send_message_to_server('tracingExport')
+        artifact = ChannelOwners::Artifact.from(resp)
+        # if self._context._browser:
+        #   artifact._is_remote = self._context._browser._is_remote
+        artifact.save_as(path)
+        artifact.delete
+      end
     end
   end
 end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.6.3'
+  VERSION = '0.7.1'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.12.0'
 end

data/lib/playwright_api/android.rb

@@ -1,12 +1,13 @@
 module Playwright
-  # Playwright has **experimental** support for Android automation. You can access android namespace via:
+  # Playwright has **experimental** support for Android automation. See [here](./mobile.md) for more information. You can
+  # access android namespace via:
   #
   # An example of the Android automation script would be:
   #
   # Note that since you don't need Playwright to install web browsers when testing Android, you can omit browser download
   # via setting the following environment variable when installing Playwright:
   #
-  # ```sh js
+  # ```bash js
   # PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
   # ```
   class Android < PlaywrightApi

data/lib/playwright_api/browser.rb

@@ -50,7 +50,7 @@ module Playwright
     #
     # Returns the newly created browser session.
     def new_browser_cdp_session
-      raise NotImplementedError.new('new_browser_cdp_session is not implemented yet.')
+      wrap_impl(@impl.new_browser_cdp_session)
     end
 
     # Creates a new browser context. It won't share cookies/cache with other browser contexts.
@@ -125,8 +125,9 @@ module Playwright
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
-          viewport: nil)
-      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport)))
+          viewport: nil,
+          &block)
+      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # > NOTE: Tracing is only supported on Chromium-based browsers.

data/lib/playwright_api/browser_context.rb

@@ -204,12 +204,12 @@ module Playwright
     #
     # Returns the newly created session.
     def new_cdp_session(page)
-      raise NotImplementedError.new('new_cdp_session is not implemented yet.')
+      wrap_impl(@impl.new_cdp_session(unwrap_impl(page)))
     end
 
     # Creates a new page in the browser context.
-    def new_page
-      wrap_impl(@impl.new_page)
+    def new_page(&block)
+      wrap_impl(@impl.new_page(&wrap_block_call(block)))
     end
 
     # Returns all open pages in the context.

data/lib/playwright_api/browser_type.rb

@@ -83,9 +83,9 @@ module Playwright
           proxy: nil,
           slowMo: nil,
           timeout: nil,
-          traceDir: nil,
+          tracesDir: nil,
           &block)
-      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), traceDir: unwrap_impl(traceDir), &wrap_block_call(block)))
+      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), tracesDir: unwrap_impl(tracesDir), &wrap_block_call(block)))
     end
 
     # Returns the persistent browser context instance.
@@ -131,10 +131,11 @@ module Playwright
           slowMo: nil,
           timeout: nil,
           timezoneId: nil,
-          traceDir: nil,
+          tracesDir: nil,
           userAgent: nil,
-          viewport: nil)
-      raise NotImplementedError.new('launch_persistent_context is not implemented yet.')
+          viewport: nil,
+          &block)
+      wrap_impl(@impl.launch_persistent_context(unwrap_impl(userDataDir), acceptDownloads: unwrap_impl(acceptDownloads), args: unwrap_impl(args), bypassCSP: unwrap_impl(bypassCSP), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), hasTouch: unwrap_impl(hasTouch), headless: unwrap_impl(headless), httpCredentials: unwrap_impl(httpCredentials), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), timezoneId: unwrap_impl(timezoneId), tracesDir: unwrap_impl(tracesDir), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.

data/lib/playwright_api/cdp_session.rb

@@ -26,11 +26,33 @@ module Playwright
     # Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to
     # send messages.
     def detach
-      raise NotImplementedError.new('detach is not implemented yet.')
+      wrap_impl(@impl.detach)
     end
 
     def send_message(method, params: nil)
-      raise NotImplementedError.new('send_message is not implemented yet.')
+      wrap_impl(@impl.send_message(unwrap_impl(method), params: unwrap_impl(params)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      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
   end
 end

data/lib/playwright_api/page.rb

@@ -1158,8 +1158,8 @@ module Playwright
     # Performs action and waits for a `Request` to finish loading. If predicate is provided, it passes `Request` value into
     # the `predicate` function and waits for `predicate(request)` to return a truthy value. Will throw an error if the page is
     # closed before the [`event: Page.requestFinished`] event is fired.
-    def expect_request_finished(predicate: nil, timeout: nil)
-      raise NotImplementedError.new('expect_request_finished is not implemented yet.')
+    def expect_request_finished(predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_request_finished(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     # Returns the matched response. See [waiting for event](./events.md#waiting-for-event) for more details about events.
@@ -1239,8 +1239,8 @@ module Playwright
     # Performs action and waits for a new `WebSocket`. If predicate is provided, it passes `WebSocket` value into the
     # `predicate` function and waits for `predicate(webSocket)` to return a truthy value. Will throw an error if the page is
     # closed before the WebSocket event is fired.
-    def expect_websocket(predicate: nil, timeout: nil)
-      raise NotImplementedError.new('expect_websocket is not implemented yet.')
+    def expect_websocket(predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_websocket(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     # Performs action and waits for a new `Worker`. If predicate is provided, it passes `Worker` value into the `predicate`
@@ -1277,6 +1277,11 @@ module Playwright
       wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
+    # @nodoc
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
+    end
+
     # @nodoc
     def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
       wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
@@ -1287,11 +1292,6 @@ module Playwright
       wrap_impl(@impl.stop_css_coverage)
     end
 
-    # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
-    end
-
     # @nodoc
     def guid
       wrap_impl(@impl.guid)