playwright-ruby-client 0.6.2 → 0.7.0

data/lib/playwright/channel_owners/browser.rb

@@ -7,7 +7,7 @@ module Playwright
     private def after_initialize
       @connected = true
       @closed_or_closing = false
-      @remote = true
+      @remote = false
 
       @contexts = Set.new
       @channel.on('close', method(:on_close))
@@ -30,36 +30,32 @@ 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
       return if @closed_or_closing
-      if @remote
-        @contexts.each do |context|
-          context.pages.each do |page|
-            page.send(:on_close)
-          end
-          context.send(:on_close)
-        end
-      end
       @closed_or_closing = true
       @channel.send_message_to_server('close')
       nil
@@ -89,14 +85,6 @@ module Playwright
 
     private def on_close(_ = {})
       @connected = false
-      if @remote
-        @contexts.each do |context|
-          context.pages.each do |page|
-            page.send(:on_close)
-          end
-          context.send(:on_close)
-        end
-      end
       emit(Events::Browser::Disconnected, self)
       @closed_or_closing = true
     end

data/lib/playwright/channel_owners/browser_context.rb

@@ -46,6 +46,8 @@ module Playwright
           ChannelOwners::Request.from_nullable(params['page']),
         )
       })
+
+      @closed_promise = Concurrent::Promises.resolvable_future
     end
 
     private def on_page(page)
@@ -111,10 +113,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)
@@ -223,15 +232,14 @@ module Playwright
     end
 
     private def on_close
-      @closed_or_closing = true
       @browser&.send(:remove_context, self)
       emit(Events::BrowserContext::Close)
+      @closed_promise.fulfill(true)
     end
 
     def close
-      return if @closed_or_closing
-      @closed_or_closing = true
       @channel.send_message_to_server('close')
+      @closed_promise.value!
       nil
     rescue => err
       raise unless safe_close_error?(err)

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/page.rb

@@ -65,7 +65,8 @@ module Playwright
         emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
       })
       @channel.on('worker', ->(params) {
-        on_worker(ChannelOwners::Worker.from(params['worker']))
+        worker = ChannelOwners::Worker.from(params['worker'])
+        # on_worker(worker)
       })
     end
 
@@ -773,6 +774,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/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.2'
+  VERSION = '0.7.0'
   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
@@ -22,12 +23,6 @@ module Playwright
     end
     alias_method :default_timeout=, :set_default_timeout
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -40,6 +35,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/android_device.rb

@@ -171,12 +171,6 @@ module Playwright
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -189,6 +183,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser.rb

@@ -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.
@@ -155,12 +156,6 @@ module Playwright
       wrap_impl(@impl.version)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -173,6 +168,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_context.rb

@@ -208,8 +208,8 @@ module Playwright
     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.
@@ -382,12 +382,6 @@ module Playwright
       wrap_impl(@impl.pause)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -400,6 +394,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end