capybara-playwright-driver 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e6ff7fd5aaa4b41cc19395605ea19820f140703b1e52d7e2e07aaaa73f0428a
-  data.tar.gz: d77b98b91bad49e4a115b2cc7c8238611f02389e882a444d065418aeea3c2ae2
+  metadata.gz: 2f43dbe09eba1cda75ed608f418120fbe5daebe99aa4bebde377ef120bd88d3f
+  data.tar.gz: 825d1aa7230177a37c7f6ce23ce656961084a2f13bfe8e5e36674836866a477e
 SHA512:
-  metadata.gz: e3eafd55be3b31d780fe7f4f1c7f5c3afa35ead692a5ce8ea22e755c4cceab37d390bbcf875fad6ae355e5475e047dc4719bbf6ebfd7abaf04732d52e9ed7c60
-  data.tar.gz: 7cf9a6db8a89ba6437e6790812924682c08bbf55bc182737159aea1883190313a86aeddf86a85219fba048ed884b93a0cfd868e97f74b25e171974f0c56ebabc
+  metadata.gz: 9f989b332d2d69bf84e3b270478514cee94a1ed3dc40c6868b8c61565248fa0d597e16f1575a42344bd13cbb4ecce8277956813d67df8b407351db72e684778d
+  data.tar.gz: df9dfa30c1f50fb1dc3c037b1b7445308e5301632ec6f8d16ba05f53b071f8a106355ae5d8d59b6885892c70bd7b2b713fe3a6d2f3c763ba528cd37c0c8ec899

data/capybara-playwright.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
   spec.add_dependency 'capybara'
-  spec.add_dependency 'playwright-ruby-client', '>= 0.5.9'
+  spec.add_dependency 'playwright-ruby-client', '>= 0.8.0'
+  spec.add_development_dependency 'allure-rspec'
   spec.add_development_dependency 'bundler', '~> 2.2.3'
   spec.add_development_dependency 'launchy', '>= 2.0.4'
   spec.add_development_dependency 'pry-byebug'

data/lib/capybara/playwright/browser.rb

@@ -1,16 +1,26 @@
+require_relative './tmpdir_owner'
+
 module Capybara
   module Playwright
+    # Responsibility of this class is:
+    # - Handling Capybara::Driver commands.
+    # - Managing Playwright browser contexts and pages.
+    #
+    # Note that this class doesn't manage Playwright::Browser.
+    # We should not use Playwright::Browser#close in this class.
     class Browser
+      include TmpdirOwner
       extend Forwardable
 
       class NoSuchWindowError < StandardError ; end
 
-      def initialize(playwright:, driver:, browser_type:, browser_options:, page_options:)
+      def initialize(driver:, playwright_browser:, page_options:, record_video: false)
         @driver = driver
-
-        browser_type = playwright.send(browser_type)
-        @playwright_browser = browser_type.launch(**browser_options)
+        @playwright_browser = playwright_browser
         @page_options = page_options
+        if record_video
+          @page_options[:record_video_dir] ||= tmpdir
+        end
         @playwright_page = create_page(create_browser_context)
       end
 
@@ -34,8 +44,8 @@ module Capybara
         end
       end
 
-      def quit
-        @playwright_browser.close
+      def clear_browser_contexts
+        @playwright_browser.contexts.each(&:close)
       end
 
       def current_url
@@ -155,6 +165,22 @@ module Capybara
         wrap_node(result)
       end
 
+      # Not used by Capybara::Session.
+      # Intended to be directly called by user.
+      def video_path
+        return nil if !@playwright_page || @playwright_page.closed?
+
+        @playwright_page.video&.path
+      end
+
+      # Not used by Capybara::Session.
+      # Intended to be directly called by user.
+      def raw_screenshot(**options)
+        return nil if !@playwright_page || @playwright_page.closed?
+
+        @playwright_page.screenshot(**options)
+      end
+
       def save_screenshot(path, **options)
         assert_page_alive
 
@@ -302,7 +328,24 @@ module Capybara
         when ::Playwright::ElementHandle
           Node.new(@driver, @playwright_page, arg)
         when ::Playwright::JSHandle
-          arg.json_value
+          obj_type, is_array = arg.evaluate('obj => [typeof obj, Array.isArray(obj)]')
+          if obj_type == 'object'
+            if is_array
+              # Firefox often include 'toJSON' into properties.
+              # https://github.com/microsoft/playwright/issues/7015
+              #
+              # Get rid of non-numeric entries.
+              arg.properties.select { |key, _| key.to_i.to_s == key.to_s }.map  do |_, value|
+                wrap_node(value)
+              end
+            else
+              arg.properties.map do |key, value|
+                [key, wrap_node(value)]
+              end.to_h
+            end
+          else
+            arg.json_value
+          end
         else
           arg
         end
@@ -310,7 +353,6 @@ module Capybara
 
       def with_playwright_page(&block)
         assert_page_alive
-        raise ArgumentError.new('block must be given') unless block
 
         block.call(@playwright_page)
       end

data/lib/capybara/playwright/browser_runner.rb

@@ -0,0 +1,99 @@
+module Capybara
+    module Playwright
+      # playwright-ruby-client provides 3 methods to launch/connect browser.
+      #
+      # Playwright.create do |playwright|
+      #   playwright.chromium.launch do |browser|
+      #
+      # Playwright.connect_to_playwright_server do |playwright| ...
+      #   playwright.chromium.launch do |browser|
+      #
+      # Playwright.connect_to_browser_server do |browser| ...
+      #
+      # This class provides start/stop methods for driver.
+      # This is responsible for
+      # - managing PlaywrightExecution
+      # - launching browser with given option if needed
+      class BrowserRunner
+        class PlaywrightConnectToPlaywrightServer
+          def initialize(endpoint_url, options)
+            @ws_endpoint = endpoint_url
+            @browser_type = options[:browser_type] || :chromium
+            unless %i(chromium firefox webkit).include?(@browser_type)
+              raise ArgumentError.new("Unknown browser_type: #{@browser_type}")
+            end
+            @browser_options = BrowserOptions.new(options)
+          end
+
+          def playwright_execution
+            @playwright_execution ||= ::Playwright.connect_to_playwright_server(@ws_endpoint)
+          end
+
+          def playwright_browser
+            browser_type = playwright_execution.playwright.send(@browser_type)
+            browser_options = @browser_options.value
+            browser_type.launch(**browser_options)
+          end
+        end
+
+        class PlaywrightConnectToBrowserServer
+          def initialize(endpoint_url)
+            @ws_endpoint = endpoint_url
+          end
+
+          def playwright_execution
+            @playwright_execution ||= ::Playwright.connect_to_browser_server(@ws_endpoint)
+          end
+
+          def playwright_browser
+            playwright_execution.browser
+          end
+        end
+
+        class PlaywrightCreate
+          def initialize(options)
+            @playwright_cli_executable_path = options[:playwright_cli_executable_path] || 'npx playwright'
+            @browser_type = options[:browser_type] || :chromium
+            unless %i(chromium firefox webkit).include?(@browser_type)
+              raise ArgumentError.new("Unknown browser_type: #{@browser_type}")
+            end
+            @browser_options = BrowserOptions.new(options)
+          end
+
+          def playwright_execution
+            @playwright_execution ||= ::Playwright.create(
+              playwright_cli_executable_path: @playwright_cli_executable_path,
+            )
+          end
+
+          def playwright_browser
+            browser_type = playwright_execution.playwright.send(@browser_type)
+            browser_options = @browser_options.value
+            browser_type.launch(**browser_options)
+          end
+        end
+
+        def initialize(options)
+          @runner =
+            if options[:playwright_server_endpoint_url]
+              PlaywrightConnectToPlaywrightServer.new(options[:playwright_server_endpoint_url], options)
+            elsif options[:browser_server_endpoint_url]
+              PlaywrightConnectToBrowserServer.new(options[:browser_server_endpoint_url])
+            else
+              PlaywrightCreate.new(options)
+            end
+        end
+
+        # @return [::Playwright::Browser]
+        def start
+          @playwright_execution = @runner.playwright_execution
+          @runner.playwright_browser
+        end
+
+        def stop
+          @playwright_execution&.stop
+          @playwright_execution = nil
+        end
+      end
+    end
+  end

data/lib/capybara/playwright/driver.rb

@@ -1,27 +1,34 @@
+require_relative './driver_extension'
+
 module Capybara
   module Playwright
     class Driver < ::Capybara::Driver::Base
       extend Forwardable
+      include DriverExtension
 
       def initialize(app, **options)
-        @playwright_cli_executable_path = options[:playwright_cli_executable_path] || 'npx playwright'
-        @browser_type = options[:browser_type] || :chromium
-        unless %i(chromium firefox webkit).include?(@browser_type)
-          raise ArgumentError.new("Unknown browser_type: #{@browser_type}")
-        end
-
-        @browser_options = BrowserOptions.new(options)
+        @browser_runner = BrowserRunner.new(options)
         @page_options = PageOptions.new(options)
       end
 
       def wait?; true; end
       def needs_server?; true; end
 
-      def browser
-        @browser ||= create_browser
+      private def browser
+        @browser ||= ::Capybara::Playwright::Browser.new(
+          driver: self,
+          playwright_browser: playwright_browser,
+          page_options: @page_options.value,
+          record_video: callback_on_save_screenrecord?,
+        )
+      end
+
+      private def playwright_browser
+        @playwright_browser ||= create_playwright_browser
       end
 
-      private def create_browser
+      private def create_playwright_browser
+        # clean up @playwright_browser and @playwright_execution on exit.
         main = Process.pid
         at_exit do
           # Store the exit status of the test run since it goes away after calling the at_exit proc...
@@ -30,27 +37,36 @@ module Capybara
           exit @exit_status if @exit_status # Force exit with stored status
         end
 
-        @execution = execute_playwright
-        ::Capybara::Playwright::Browser.new(
-          playwright: @execution.playwright,
-          driver: self,
-          browser_type: @browser_type,
-          browser_options: @browser_options.value,
-          page_options: @page_options.value,
-        )
-      end
-
-      private def execute_playwright
-        ::Playwright.create(playwright_cli_executable_path: @playwright_cli_executable_path)
+        @browser_runner.start
       end
 
       private def quit
-        @browser&.quit
-        @execution&.stop
+        @playwright_browser&.close
+        @playwright_browser = nil
+        @browser_runner.stop
       end
 
       def reset!
-        quit
+        # screenshot is available only before closing page.
+        if callback_on_save_screenshot?
+          raw_screenshot = @browser&.raw_screenshot
+          if raw_screenshot
+            callback_on_save_screenshot(raw_screenshot)
+          end
+        end
+
+        # video path can be aquired only before closing context.
+        # video is completedly saved only after closing context.
+        video_path = @browser&.video_path
+
+        # [NOTE] @playwright_browser should keep alive for better performance.
+        # Only `Browser` is disposed.
+        @browser&.clear_browser_contexts
+
+        if video_path
+          callback_on_save_screenrecord(video_path)
+        end
+
         @browser = nil
       end
 
@@ -94,9 +110,6 @@ module Capybara
       def_delegator(:browser, :switch_to_window)
       def_delegator(:browser, :accept_modal)
       def_delegator(:browser, :dismiss_modal)
-
-      # capybara-playwright-driver specific methods
-      def_delegator(:browser, :with_playwright_page)
     end
   end
 end

data/lib/capybara/playwright/driver_extension.rb

@@ -0,0 +1,45 @@
+module Capybara
+  module Playwright
+    module DriverExtension
+      # Register screenshot save process.
+      # The callback is called just before page is closed.
+      # (just before #reset_session!)
+      #
+      # The **binary** (String) of the page screenshot is called back into the given block
+      def on_save_raw_screenshot_before_reset(&block)
+        @callback_on_save_screenshot = block
+      end
+
+      private def callback_on_save_screenshot?
+        !!@callback_on_save_screenshot
+      end
+
+      private def callback_on_save_screenshot(raw_screenshot)
+        @callback_on_save_screenshot&.call(raw_screenshot)
+      end
+
+      # Register screenrecord save process.
+      # The callback is called just after page is closed.
+      # (just after #reset_session!)
+      #
+      # The video path (String) is called back into the given block
+      def on_save_screenrecord(&block)
+        @callback_on_save_screenrecord = block
+      end
+
+      private def callback_on_save_screenrecord?
+        !!@callback_on_save_screenrecord
+      end
+
+      private def callback_on_save_screenrecord(video_path)
+        @callback_on_save_screenrecord&.call(video_path)
+      end
+
+      def with_playwright_page(&block)
+        raise ArgumentError.new('block must be given') unless block
+
+        @browser&.with_playwright_page(&block)
+      end
+    end
+  end
+end

data/lib/capybara/playwright/tmpdir_owner.rb

@@ -0,0 +1,40 @@
+module Capybara
+  module Playwright
+    module TmpdirOwner
+      require 'tmpdir'
+
+      def tmpdir
+        return @tmpdir if @tmpdir
+
+        dir = Dir.mktmpdir
+        ObjectSpace.define_finalizer(self, TmpdirRemover.new(dir))
+        @tmpdir = dir
+      end
+
+      def remove_tmpdir
+        if @tmpdir
+          FileUtils.remove_entry(@tmpdir, true)
+          ObjectSpace.undefine_finalizer(self)
+          @tmpdir = nil
+        end
+      end
+
+      class TmpdirRemover
+        def initialize(tmpdir)
+          @pid = Process.pid
+          @tmpdir = tmpdir
+        end
+
+        def call(*args)
+          return if @pid != Process.pid
+
+          begin
+            FileUtils.remove_entry(@tmpdir, true)
+          rescue => err
+            $stderr.puts err
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capybara/playwright/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Playwright
-    VERSION = '0.1.2'
+    VERSION = '0.1.6'
   end
 end

data/lib/capybara/playwright.rb

@@ -4,6 +4,7 @@ require 'capybara'
 require 'playwright'
 
 require 'capybara/playwright/browser'
+require 'capybara/playwright/browser_runner'
 require 'capybara/playwright/browser_options'
 require 'capybara/playwright/dialog_event_handler'
 require 'capybara/playwright/driver'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-playwright-driver
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: allure-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,11 +184,14 @@ files:
 - lib/capybara/playwright.rb
 - lib/capybara/playwright/browser.rb
 - lib/capybara/playwright/browser_options.rb
+- lib/capybara/playwright/browser_runner.rb
 - lib/capybara/playwright/dialog_event_handler.rb
 - lib/capybara/playwright/driver.rb
+- lib/capybara/playwright/driver_extension.rb
 - lib/capybara/playwright/node.rb
 - lib/capybara/playwright/page.rb
 - lib/capybara/playwright/page_options.rb
+- lib/capybara/playwright/tmpdir_owner.rb
 - lib/capybara/playwright/version.rb
 homepage: https://github.com/YusukeIwaki/capybara-playwright-driver
 licenses: