playwright-ruby-client 0.6.1 → 0.6.6

data/lib/playwright/channel_owners/binding_call.rb

@@ -30,7 +30,7 @@ module Playwright
         end
 
       begin
-        result = callback.call(source, *args)
+        result = PlaywrightApi.unwrap(callback.call(source, *args))
         @channel.send_message_to_server('resolve', result: JavaScript::ValueSerializer.new(result).serialize)
       rescue => err
         @channel.send_message_to_server('reject', error: { error: { message: err.message, name: 'Error' }})

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
 
@@ -339,10 +340,11 @@ module Playwright
       ChannelOwners::Response.from_nullable(resp)
     end
 
-    def emulate_media(colorScheme: nil, media: nil)
+    def emulate_media(colorScheme: nil, media: nil, reducedMotion: nil)
       params = {
         colorScheme: colorScheme,
         media: media,
+        reducedMotion: reducedMotion,
       }.compact
       @channel.send_message_to_server('emulateMedia', params)
 
@@ -713,7 +715,6 @@ module Playwright
       end
 
       wait_helper.wait_for_event(self, event, predicate: predicate)
-
       block&.call
 
       wait_helper.promise.value!
@@ -743,7 +744,7 @@ module Playwright
       expect_event(Events::Page::Popup, predicate: predicate, timeout: timeout, &block)
     end
 
-    def expect_request(urlOrPredicate, timeout: nil)
+    def expect_request(urlOrPredicate, timeout: nil, &block)
       predicate =
         case urlOrPredicate
         when String, Regexp
@@ -755,10 +756,10 @@ module Playwright
           -> (_) { true }
         end
 
-      expect_event(Events::Page::Request, predicate: predicate, timeout: timeout)
+      expect_event(Events::Page::Request, predicate: predicate, timeout: timeout, &block)
     end
 
-    def expect_response(urlOrPredicate, timeout: nil)
+    def expect_response(urlOrPredicate, timeout: nil, &block)
       predicate =
         case urlOrPredicate
         when String, Regexp
@@ -770,7 +771,7 @@ module Playwright
           -> (_) { true }
         end
 
-      expect_event(Events::Page::Response, predicate: predicate, timeout: timeout)
+      expect_event(Events::Page::Response, predicate: predicate, timeout: timeout, &block)
     end
 
     # called from Frame with send(:timeout_settings)

data/lib/playwright/channel_owners/web_socket.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :WebSocket do
+  end
+end

data/lib/playwright/channel_owners/worker.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :Worker do
+  end
+end

data/lib/playwright/playwright_api.rb

@@ -18,6 +18,17 @@ module Playwright
       end
     end
 
+    # Unwrap ChannelOwner / ApiImplementation.
+    # @note Intended for internal use only.
+    def self.unwrap(api)
+      case api
+      when PlaywrightApi
+        api.instance_variable_get(:@impl)
+      else
+        api
+      end
+    end
+
     class ChannelOwnerWrapper
       def initialize(impl)
         impl_class_name = impl.class.name
@@ -114,6 +125,8 @@ module Playwright
     private def wrap_impl(object)
       if object.is_a?(Array)
         object.map { |obj| wrap_impl(obj) }
+      elsif object.is_a?(Hash)
+        object.map { |key, obj| [key, wrap_impl(obj)] }.to_h
       else
         ::Playwright::PlaywrightApi.wrap(object)
       end
@@ -122,8 +135,10 @@ module Playwright
     private def unwrap_impl(object)
       if object.is_a?(Array)
         object.map { |obj| unwrap_impl(obj) }
+      elsif object.is_a?(Hash)
+        object.map { |key, obj| [key, unwrap_impl(obj)] }.to_h
       elsif object.is_a?(PlaywrightApi)
-        object.instance_variable_get(:@impl)
+        ::Playwright::PlaywrightApi.unwrap(object)
       else
         object
       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.1'
+  VERSION = '0.6.6'
   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
@@ -24,20 +25,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -59,12 +59,13 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          reducedMotion: nil,
           screen: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), 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), 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), screen: unwrap_impl(screen), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), 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), 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), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Performs a long tap on the widget defined by `selector`.
@@ -172,20 +173,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -84,13 +84,14 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          reducedMotion: nil,
           screen: nil,
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_context(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), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_context(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
 
     # Creates a new page in a new browser context. Closing this page will close the context as well.
@@ -119,12 +120,14 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          reducedMotion: nil,
           screen: nil,
           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), 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,20 +158,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     private def event_emitter_proxy