capybara-playwright-driver 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e6ff7fd5aaa4b41cc19395605ea19820f140703b1e52d7e2e07aaaa73f0428a
-  data.tar.gz: d77b98b91bad49e4a115b2cc7c8238611f02389e882a444d065418aeea3c2ae2
+  metadata.gz: '08985d0c37caddddfb7059ad5a4447df6264d00ee692b04b123eb1a52452a479'
+  data.tar.gz: 2570f39ea3cb9571910d8d70d1b2bbd2f4a011f974e2a0e0c984c36319fa0753
 SHA512:
-  metadata.gz: e3eafd55be3b31d780fe7f4f1c7f5c3afa35ead692a5ce8ea22e755c4cceab37d390bbcf875fad6ae355e5475e047dc4719bbf6ebfd7abaf04732d52e9ed7c60
-  data.tar.gz: 7cf9a6db8a89ba6437e6790812924682c08bbf55bc182737159aea1883190313a86aeddf86a85219fba048ed884b93a0cfd868e97f74b25e171974f0c56ebabc
+  metadata.gz: 8a8a2b2897c5a5b4baca85fb223b128ff620db07327c80e82da543a77a89d74726f682b0c0f952bb797b13c2fa209421cef527c5edab7790d0d2c66efb702554
+  data.tar.gz: d7b1db32061db7491d5d0d6595e35d90a72731b6d5a011f5cf56ce5985b8d94c58d4fc46dd4b18e95ddfab519cf1df57cf74bfc25de1aa787367f69dea290734

data/capybara-playwright.gemspec

@@ -27,6 +27,7 @@ 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_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
 
@@ -310,7 +336,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/driver.rb

@@ -1,7 +1,10 @@
+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'
@@ -18,10 +21,20 @@ module Capybara
       def needs_server?; true; end
 
       def browser
-        @browser ||= create_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 create_browser
+      private def playwright_browser
+        @playwright_browser ||= create_playwright_browser
+      end
+
+      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 +43,45 @@ 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,
-        )
+        browser_type = playwright_execution.playwright.send(@browser_type)
+        browser_options = @browser_options.value
+        browser_type.launch(**browser_options)
       end
 
-      private def execute_playwright
-        ::Playwright.create(playwright_cli_executable_path: @playwright_cli_executable_path)
+      private def playwright_execution
+        @playwright_execution ||= ::Playwright.create(
+          playwright_cli_executable_path: @playwright_cli_executable_path,
+        )
       end
 
       private def quit
-        @browser&.quit
-        @execution&.stop
+        @playwright_browser&.close
+        @playwright_browser = nil
+        @playwright_execution&.stop
+        @playwright_execution = nil
       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 +125,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.3'
   end
 end

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.3
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.9
+- !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
@@ -172,9 +186,11 @@ files:
 - lib/capybara/playwright/browser_options.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: