capybara-playwright-driver 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff1545e5e7830f5c9c3a3880894c6c4b89cbe3104a18ee388870e16b6d31cd9c
-  data.tar.gz: 3add9f1a8aa12f459f2efe3b61d8c0200716201b02effacd666bd97f3220d479
+  metadata.gz: f12da8f24faaf7dca07c39e57c8ea56d79395a89c2240d99ff48fdc065e10dc1
+  data.tar.gz: 07c2560cc17f103aecd41ddd7267e9eb0abd310546f32756a852cc61e3e3f92d
 SHA512:
-  metadata.gz: 5a88d7c10d9002bf81c0c5d10760623e69d8b02ee86ef238d3a2138e333d936d3c3fc2c6954b483b93dec856653f99a84bbec59b61106fd5a6df3f374e1616d2
-  data.tar.gz: aa54328b1a239b1d2800052775a9620180a26cf90ac2cc3fe48334f0b4b4c3d983da29fbc1f3d9aad1b75101319d00e85cd597dcf6ad9d579bda7bee5d236340
+  metadata.gz: 0d1de191eff8c0a8a3da8366c38e367eaf215a836c5148cc1ed001c9af28b13f9d9126685a43fb0c871829f9b97e5ec55d0d1cbc77d44da5fb4e42b907941e2f
+  data.tar.gz: d7be26ec2e30b783a24324c923ac5ca9164a88077c7010a39e95757b3a0ef68bd156f849354085e8344f76a7f9a38843bc972ad516bd8c1416964aa2a486f538

data/README.md

@@ -26,17 +26,18 @@ Capybara.save_path = 'tmp/capybara'
 # run
 Capybara.app_host = 'https://github.com'
 visit '/'
-fill_in('q', with: 'Capybara')
+first('div.search-input-container').click
+fill_in('query-builder-test', with: 'Capybara')
 
 ## [REMARK] We can use Playwright-native selector and action, instead of Capybara DSL.
-# find('a[data-item-type="global_search"]').click
+# first('[aria-label="Capybara, Search all of GitHub"]').click
 page.driver.with_playwright_page do |page|
-  page.click('a[data-item-type="global_search"]')
+  page.get_by_label('Capybara, Search all of GitHub').click
 end
 
-all('.repo-list-item').each do |li|
+all('[data-testid="results-list"] h3').each do |li|
   #puts "#{li.all('a').first.text} by Capybara"
-  puts "#{li.with_playwright_element_handle { |handle| handle.query_selector('a').text_content }} by Playwright"
+  puts "#{li.with_playwright_element_handle { |handle| handle.text_content }} by Playwright"
 end
 ```
 

data/lib/capybara/playwright/browser.rb

@@ -14,25 +14,31 @@ module Capybara
 
       class NoSuchWindowError < StandardError ; end
 
-      def initialize(driver:, playwright_browser:, page_options:, record_video: false, default_navigation_timeout: nil)
+      def initialize(driver:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil)
         @driver = driver
         @playwright_browser = playwright_browser
         @page_options = page_options
         if record_video
           @page_options[:record_video_dir] ||= tmpdir
         end
+        @callback_on_save_trace = callback_on_save_trace
+        @default_timeout = default_timeout
         @default_navigation_timeout = default_navigation_timeout
         @playwright_page = create_page(create_browser_context)
       end
 
       private def create_browser_context
         @playwright_browser.new_context(**@page_options).tap do |browser_context|
+          browser_context.default_timeout = @default_timeout if @default_timeout
           browser_context.default_navigation_timeout = @default_navigation_timeout if @default_navigation_timeout
           browser_context.on('page', ->(page) {
             unless @playwright_page
               @playwright_page = page
             end
           })
+          if @callback_on_save_trace
+            browser_context.tracing.start(screenshots: true, snapshots: true)
+          end
         end
       end
 
@@ -47,6 +53,14 @@ module Capybara
       end
 
       def clear_browser_contexts
+        if @callback_on_save_trace
+          @playwright_browser.contexts.each do |browser_context|
+            filename = SecureRandom.hex(8)
+            zip_path = File.join(tmpdir, "#{filename}.zip")
+            browser_context.tracing.stop(path: zip_path)
+            @callback_on_save_trace.call(zip_path)
+          end
+        end
         @playwright_browser.contexts.each(&:close)
       end
 

data/lib/capybara/playwright/driver.rb

@@ -9,9 +9,15 @@ module Capybara
       def initialize(app, **options)
         @browser_runner = BrowserRunner.new(options)
         @page_options = PageOptions.new(options)
-        if options[:timeout].is_a?(Numeric)
+        if options[:timeout].is_a?(Numeric) # just for compatibility with capybara-selenium-driver
           @default_navigation_timeout = options[:timeout] * 1000
         end
+        if options[:default_timeout].is_a?(Numeric)
+          @default_timeout = options[:default_timeout] * 1000
+        end
+        if options[:default_navigation_timeout].is_a?(Numeric)
+          @default_navigation_timeout = options[:default_navigation_timeout] * 1000
+        end
       end
 
       def wait?; true; end
@@ -23,6 +29,8 @@ module Capybara
           playwright_browser: playwright_browser,
           page_options: @page_options.value,
           record_video: callback_on_save_screenrecord?,
+          callback_on_save_trace: @callback_on_save_trace,
+          default_timeout: @default_timeout,
           default_navigation_timeout: @default_navigation_timeout,
         )
       end

data/lib/capybara/playwright/driver_extension.rb

@@ -35,11 +35,46 @@ module Capybara
         @callback_on_save_screenrecord&.call(video_path)
       end
 
+      # Register trace save process.
+      # The callback is called just after trace is saved.
+      #
+      # The trace.zip path (String) is called back into the given block
+      def on_save_trace(&block)
+        @callback_on_save_trace = block
+      end
+
       def with_playwright_page(&block)
         raise ArgumentError.new('block must be given') unless block
 
         @browser&.with_playwright_page(&block)
       end
+
+      # Start Playwright tracing (doc: https://playwright.dev/docs/api/class-tracing#tracing-start)
+      def start_tracing(name: nil, screenshots: false, snapshots: false, sources: false, title: nil)
+        # Ensure playwright page is initialized.
+        browser
+
+        with_playwright_page do |playwright_page|
+          playwright_page.context.tracing.start(name: name, screenshots: screenshots, snapshots: snapshots, sources: sources, title: title)
+        end
+      end
+
+      # Stop Playwright tracing (doc: https://playwright.dev/docs/api/class-tracing#tracing-stop)
+      def stop_tracing(path: nil)
+        with_playwright_page do |playwright_page|
+          playwright_page.context.tracing.stop(path: path)
+        end
+      end
+
+      # Trace execution of the given block. The tracing is automatically stopped when the block is finished.
+      def trace(name: nil, screenshots: false, snapshots: false, sources: false, title: nil, path: nil, &block)
+        raise ArgumentError.new('block must be given') unless block
+
+        start_tracing(name: name, screenshots: screenshots, snapshots: snapshots, sources: sources, title: title)
+        block.call
+      ensure
+        stop_tracing(path: path)
+      end
     end
   end
 end

data/lib/capybara/playwright/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Playwright
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-playwright-driver
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara