playwright-ruby-client 0.3.0 → 0.5.2

data/lib/playwright/connection.rb

@@ -12,6 +12,12 @@ module Playwright
       @transport.on_message_received do |message|
         dispatch(message)
       end
+      @transport.on_driver_crashed do
+        @callbacks.each_value do |callback|
+          callback.reject(::Playwright::DriverCrashedError.new)
+        end
+        raise ::Playwright::DriverCrashedError.new
+      end
 
       @objects = {} # Hash[ guid => ChannelOwner ]
       @waiting_for_object = {} # Hash[ guid => Promise<ChannelOwner> ]
@@ -19,26 +25,22 @@ module Playwright
       @root_object = RootChannelOwner.new(self)
     end
 
-    def run
-      @transport.run
+    def async_run
+      @transport.async_run
     end
 
     def stop
       @transport.stop
     end
 
-    def async_wait_for_object_with_known_name(guid)
+    def wait_for_object_with_known_name(guid)
       if @objects[guid]
         return @objects[guid]
       end
 
       callback = Concurrent::Promises.resolvable_future
       @waiting_for_object[guid] = callback
-      callback
-    end
-
-    def wait_for_object_with_known_name(guid)
-      async_wait_for_object_with_known_name.value!
+      callback.value!
     end
 
     def async_send_message_to_server(guid, method, params)
@@ -195,32 +197,9 @@ module Playwright
       end
       initializer = replace_guids_with_channels(initializer)
 
-      class_name = case type
-      when 'Browser'
-        case initializer['name']
-        when 'chromium'
-          'ChromiumBrowser'
-        when 'webkit'
-          'WebKitBrowser'
-        when 'firefox'
-          'FirefoxBrowser'
-        else
-          'Browser'
-        end
-      when 'BrowserContext'
-        browser_name = initializer['browserName']
-        if browser_name == 'chromium'
-          'ChromiumBrowserContext'
-        else
-          'BrowserContext'
-        end
-      else
-        type
-      end
-
       result =
         begin
-          ChannelOwners.const_get(class_name).new(
+          ChannelOwners.const_get(type).new(
             parent,
             type,
             guid,

data/lib/playwright/download.rb

@@ -0,0 +1,27 @@
+module Playwright
+  class Download
+    def initialize(url:, suggested_filename:, artifact:)
+      @url = url
+      @suggested_filename = suggested_filename
+      @artifact = artifact
+    end
+
+    attr_reader :url, :suggested_filename
+
+    def delete
+      @artifact.delete
+    end
+
+    def failure
+      @artifact.failure
+    end
+
+    def path
+      @artifact.path_after_finished
+    end
+
+    def save_as(path)
+      @artifact.save_as(path)
+    end
+  end
+end

data/lib/playwright/errors.rb

@@ -27,6 +27,12 @@ module Playwright
     end
   end
 
+  class DriverCrashedError < StandardError
+    def initialize
+      super("[BUG] Playwright driver is crashed!")
+    end
+  end
+
   class TimeoutError < Error
     def initialize(message:, stack: [])
       super(name: 'TimeoutError', message: message, stack: stack)

data/lib/playwright/events.rb

@@ -24,8 +24,10 @@ end
   },
 
   BrowserContext: {
+    BackgroundPage: 'backgroundpage',
     Close: 'close',
     Page: 'page',
+    ServiceWorker: 'serviceworker',
   },
 
   BrowserServer: {
@@ -67,11 +69,6 @@ end
     Close: 'close',
   },
 
-  ChromiumBrowserContext: {
-    BackgroundPage: 'backgroundpage',
-    ServiceWorker: 'serviceworker',
-  },
-
   ElectronApplication: {
     Close: 'close',
     Window: 'window',

data/lib/playwright/keyboard_impl.rb

@@ -10,7 +10,7 @@ module Playwright
     end
 
     def up(key)
-      @channel.send_message_to_server('keyboardDown', key: key)
+      @channel.send_message_to_server('keyboardUp', key: key)
     end
 
     def insert_text(text)

data/lib/playwright/mouse_impl.rb

@@ -3,5 +3,46 @@ module Playwright
     def initialize(channel)
       @channel = channel
     end
+
+    def move(x, y, steps: nil)
+      params = { x: x, y: y, steps: steps }.compact
+      @channel.send_message_to_server('mouseMove', params)
+      nil
+    end
+
+    def down(button: nil, clickCount: nil)
+      params = { button: button, clickCount: clickCount }.compact
+      @channel.send_message_to_server('mouseDown', params)
+      nil
+    end
+
+    def up(button: nil, clickCount: nil)
+      params = { button: button, clickCount: clickCount }.compact
+      @channel.send_message_to_server('mouseUp', params)
+      nil
+    end
+
+    def click(
+      x,
+      y,
+      button: nil,
+      clickCount: nil,
+      delay: nil)
+
+      params = {
+        x: x,
+        y: y,
+        button: button,
+        clickCount: clickCount,
+        delay: delay,
+      }.compact
+      @channel.send_message_to_server('mouseClick', params)
+
+      nil
+    end
+
+    def dblclick(x, y, button: nil, delay: nil)
+      click(x, y, button: button, clickCount: 2, delay: delay)
+    end
   end
 end

data/lib/playwright/route_handler_entry.rb

@@ -9,7 +9,7 @@ module Playwright
     end
 
     def handle(route, request)
-      if url_match?(request.url)
+      if @url_matcher.match?(request.url)
         @handler.call(route, request)
         true
       else
@@ -24,13 +24,5 @@ module Playwright
         @url_value == url
       end
     end
-
-    private def url_match?(request_url)
-      if @url_value.is_a?(Regexp)
-        @url_matcher.match?(request_url)
-      else
-        @url_matcher.match?(request_url) || File.fnmatch?(@url_value, request_url)
-      end
-    end
   end
 end

data/lib/playwright/transport.rb

@@ -12,20 +12,27 @@ module Playwright
     def initialize(playwright_cli_executable_path:)
       @driver_executable_path = playwright_cli_executable_path
       @debug = ENV['DEBUG'].to_s == 'true' || ENV['DEBUG'].to_s == '1'
+      @mutex = Mutex.new
     end
 
     def on_message_received(&block)
       @on_message = block
     end
 
+    def on_driver_crashed(&block)
+      @on_driver_crashed = block
+    end
+
     class AlreadyDisconnectedError < StandardError ; end
 
     # @param message [Hash]
     def send_message(message)
       debug_send_message(message) if @debug
       msg = JSON.dump(message)
-      @stdin.write([msg.size].pack('V')) # unsigned 32bit, little endian
-      @stdin.write(msg)
+      @mutex.synchronize {
+        @stdin.write([msg.size].pack('V')) # unsigned 32bit, little endian
+        @stdin.write(msg)
+      }
     rescue Errno::EPIPE
       raise AlreadyDisconnectedError.new('send_message failed')
     end
@@ -33,18 +40,17 @@ module Playwright
     # Terminate playwright-cli driver.
     def stop
       [@stdin, @stdout, @stderr].each { |io| io.close unless io.closed? }
+      @thread&.terminate
     end
 
     # Start `playwright-cli run-driver`
     #
     # @note This method blocks until playwright-cli exited. Consider using Thread or Future.
-    def run
-      @stdin, @stdout, @stderr, @thread = Open3.popen3(@driver_executable_path, 'run-driver')
+    def async_run
+      @stdin, @stdout, @stderr, @thread = Open3.popen3("#{@driver_executable_path} run-driver")
 
       Thread.new { handle_stdout }
       Thread.new { handle_stderr }
-
-      @thread.join
     end
 
     private
@@ -69,6 +75,21 @@ module Playwright
 
     def handle_stderr
       while err = @stderr.read
+        # sometimed driver crashes with the error below.
+        # --------
+        # undefined:1
+        # �
+        # ^
+
+        # SyntaxError: Unexpected token � in JSON at position 0
+        #     at JSON.parse (<anonymous>)
+        #     at Transport.transport.onmessage (/home/runner/work/playwright-ruby-client/playwright-ruby-client/node_modules/playwright/lib/cli/driver.js:42:73)
+        #     at Immediate.<anonymous> (/home/runner/work/playwright-ruby-client/playwright-ruby-client/node_modules/playwright/lib/protocol/transport.js:74:26)
+        #     at processImmediate (internal/timers.js:461:21)
+        if err.include?('undefined:1')
+          @on_driver_crashed&.call
+          break
+        end
         $stderr.write(err)
       end
     rescue IOError

data/lib/playwright/url_matcher.rb

@@ -8,7 +8,7 @@ module Playwright
     def match?(target_url)
       case @url
       when String
-        @url == target_url
+        @url == target_url || File.fnmatch?(@url, target_url)
       when Regexp
         @url.match?(target_url)
       else

data/lib/playwright/utils.rb

@@ -11,6 +11,14 @@ module Playwright
         if params[:extraHTTPHeaders]
           params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
         end
+        if params[:record_video_dir]
+          params[:recordVideo] = {
+            dir: params.delete(:record_video_dir)
+          }
+          if params[:record_video_size]
+            params[:recordVideo][:size] = params.delete(:record_video_size)
+          end
+        end
         if params[:storageState].is_a?(String)
           params[:storageState] = JSON.parse(File.read(params[:storageState]))
         end

data/lib/playwright/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.3.0'
+  VERSION = '0.5.2'
 end

data/lib/playwright/video.rb

@@ -0,0 +1,51 @@
+module Playwright
+  class Video
+    def initialize(page)
+      @page = page
+      @artifact = Concurrent::Promises.resolvable_future
+      if @page.closed?
+        on_page_closed
+      else
+        page.once('close', -> { on_page_closed })
+      end
+    end
+
+    private def on_page_closed
+      unless @artifact.resolved?
+        @artifact.reject('Page closed')
+      end
+    end
+
+    # called only from Page#on_video via send(:set_artifact, artifact)
+    private def set_artifact(artifact)
+      @artifact.fulfill(artifact)
+    end
+
+    def path
+      wait_for_artifact_and do |artifact|
+        artifact.absolute_path
+      end
+    end
+
+    def save_as(path)
+      wait_for_artifact_and do |artifact|
+        artifact.save_as(path)
+      end
+    end
+
+    def delete
+      wait_for_artifact_and do |artifact|
+        artifact.delete
+      end
+    end
+
+    private def wait_for_artifact_and(&block)
+      artifact = @artifact.value!
+      unless artifact
+        raise 'Page did not produce any video frames'
+      end
+
+      block.call(artifact)
+    end
+  end
+end

data/lib/playwright/wait_helper.rb

@@ -22,9 +22,9 @@ module Playwright
     def reject_on_timeout(timeout_ms, message)
       return if timeout_ms <= 0
 
-      Concurrent::Promises.schedule(timeout_ms / 1000.0) {
+      Concurrent::Promises.schedule(timeout_ms / 1000.0) do
         reject(TimeoutError.new(message: message))
-      }
+      end
 
       self
     end

data/lib/playwright.rb

@@ -17,6 +17,7 @@ require 'playwright/utils'
 require 'playwright/api_implementation'
 require 'playwright/channel'
 require 'playwright/channel_owner'
+require 'playwright/download'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
@@ -26,6 +27,7 @@ require 'playwright/timeout_settings'
 require 'playwright/transport'
 require 'playwright/url_matcher'
 require 'playwright/version'
+require 'playwright/video'
 require 'playwright/wait_helper'
 
 require 'playwright/playwright_api'
@@ -33,18 +35,54 @@ require 'playwright/playwright_api'
 Dir[File.join(__dir__, 'playwright_api', '*.rb')].each { |f| require f }
 
 module Playwright
-  module_function def create(playwright_cli_executable_path:, &block)
-    raise ArgumentError.new("block must be provided") unless block
+  class Execution
+    def initialize(connection, playwright)
+      @connection = connection
+      @playwright = playwright
+    end
+
+    def stop
+      @connection.stop
+    end
+
+    attr_reader :playwright
+  end
 
+  # Recommended to call this method with block.
+  #
+  # Playwright.create(...) do |playwright|
+  #   browser = playwright.chromium.launch
+  #   ...
+  # end
+  #
+  # When we use this method without block, an instance of Puppeteer::Execution is returned
+  # and we *must* call execution.stop on the end.
+  # The instance of playwright is available by calling execution.playwright
+  module_function def create(playwright_cli_executable_path:, &block)
     connection = Connection.new(playwright_cli_executable_path: playwright_cli_executable_path)
+    connection.async_run
+
+    execution =
+      begin
+        playwright = connection.wait_for_object_with_known_name('Playwright')
+        Execution.new(connection, PlaywrightApi.wrap(playwright))
+      rescue
+        connection.stop
+        raise
+      end
 
-    playwright_promise = connection.async_wait_for_object_with_known_name('Playwright')
-    Thread.new { connection.run }
-    playwright = PlaywrightApi.wrap(playwright_promise.value!)
-    begin
-      block.call(playwright)
-    ensure
-      connection.stop
+    if block
+      begin
+        block.call(execution.playwright)
+      ensure
+        execution.stop
+      end
+    else
+      execution
     end
   end
+
+  module_function def instance
+    @playwright_instance
+  end
 end

data/lib/playwright_api/accessibility.rb

@@ -6,7 +6,7 @@ module Playwright
   # Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
   # have wildly different output.
   # 
-  # Rendering engines of Chromium, Firefox and Webkit have a concept of "accessibility tree", which is then translated into
+  # Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into
   # different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
   # 
   # Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
@@ -28,6 +28,11 @@ module Playwright
     # console.log(snapshot);
     # ```
     # 
+    # ```java
+    # String snapshot = page.accessibility().snapshot();
+    # System.out.println(snapshot);
+    # ```
+    # 
     # ```python async
     # snapshot = await page.accessibility.snapshot()
     # print(snapshot)
@@ -38,6 +43,11 @@ module Playwright
     # print(snapshot)
     # ```
     # 
+    # ```csharp
+    # var accessibilitySnapshot = await Page.Accessibility.SnapshotAsync();
+    # Console.WriteLine(accessibilitySnapshot);
+    # ```
+    # 
     # An example of logging the focused node's name:
     # 
     #
@@ -57,6 +67,34 @@ module Playwright
     # }
     # ```
     # 
+    # ```csharp
+    # Func<AccessibilitySnapshotResult, AccessibilitySnapshotResult> findFocusedNode = root =>
+    # {
+    #     var nodes = new Stack<AccessibilitySnapshotResult>(new[] { root });
+    #     while (nodes.Count > 0)
+    #     {
+    #         var node = nodes.Pop();
+    #         if (node.Focused) return node;
+    #         foreach (var innerNode in node.Children)
+    #         {
+    #             nodes.Push(innerNode);
+    #         }
+    #     }
+    # 
+    #     return null;
+    # };
+    # 
+    # var accessibilitySnapshot = await Page.Accessibility.SnapshotAsync();
+    # var focusedNode = findFocusedNode(accessibilitySnapshot);
+    # if(focusedNode != null)
+    #   Console.WriteLine(focusedNode.Name);
+    # ```
+    # 
+    # ```java
+    # // FIXME
+    # String snapshot = page.accessibility().snapshot();
+    # ```
+    # 
     # ```python async
     # def find_focused_node(node):
     #     if (node.get("focused"))

data/lib/playwright_api/android.rb

@@ -3,18 +3,18 @@ module Playwright
   # 
   #
   # ```js
-  # const { _android } = require('playwright');
+  # const { _android: android } = require('playwright');
   # ```
   # 
   # An example of the Android automation script would be:
   # 
   #
   # ```js
-  # const { _android } = require('playwright');
+  # const { _android: android } = require('playwright');
   # 
   # (async () => {
   #   // Connect to the device.
-  #   const [device] = await playwright._android.devices();
+  #   const [device] = await android.devices();
   #   console.log(`Model: ${device.model()}`);
   #   console.log(`Serial: ${device.serial()}`);
   #   // Take screenshot of the whole device.
@@ -35,7 +35,7 @@ module Playwright
   # 
   #     // Work with WebView's page as usual.
   #     const page = await webview.page();
-  #     await page.page.waitForNavigation({ url: /.*microsoft\/playwright.*/ });
+  #     await page.waitForNavigation({ url: /.*microsoft\/playwright.*/ });
   #     console.log(await page.title());
   #   }
   # 
@@ -79,12 +79,6 @@ module Playwright
     end
     alias_method :default_timeout=, :set_default_timeout
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -97,6 +91,12 @@ module Playwright
       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

data/lib/playwright_api/android_device.rb

@@ -59,11 +59,12 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: 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), 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), 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`.
@@ -159,20 +160,14 @@ module Playwright
       raise NotImplementedError.new('web_views is not implemented yet.')
     end
 
-    # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
-    end
-
     # @nodoc
     def tap_on(selector, duration: nil, timeout: nil)
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def tree
+      wrap_impl(@impl.tree)
     end
 
     # -- inherited from EventEmitter --
@@ -187,6 +182,12 @@ module Playwright
       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