ferrum-har 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140d6f93cceb0ee84d05e449aa1fb5a8680a562002850a6ac6e8aeb475505f12
-  data.tar.gz: 14dbb30ee107b7562e3167c44d8cd6460bb5d52a7dd1856caa849dd2e4c1b0f6
+  metadata.gz: 652f3679a70306ac244d2a0627a3609da85ae96c8360365c3b21c1cb315b994c
+  data.tar.gz: 77443a4e93f2e05dfbc63b3370176778c2857a4bdf8663c4c953a88f6eca635d
 SHA512:
-  metadata.gz: a157840990fdadd2b2dc4c42a9e0464f3b2ef1206da1c3cbd8c7f703d7e4ce5e309298eb25c43818907099fccb4d92329506fa56399f21edcc1e5f9980769b5c
-  data.tar.gz: dc280c46aa7285b6dbbaa0f11af62a7279e6d4272b9320171d06da3a1059950f307b5b6d294677d75206eac95f46278480062f0f7f2044e3aced3040ecc3ca71
+  metadata.gz: '0358163ac7ff98f450c9027f2909713d8d5fcfafb0e0668de62d3de288b62912b2109a091340236bb3719b12a92e159be0ab3f379fb3137120f4e900110ec536'
+  data.tar.gz: 6b5aab790b3d341338734b73527bdc3532613fc2248b3b291d1cf856b96b0444bb3073ca4f8fbe053ae5db806807a0f00834304ed22cb950602a15f324e0d32a

data/README.md

@@ -1,7 +1,9 @@
 ferrum-har
 ================
 
-[![Gem Version](https://img.shields.io/gem/v/ferrum-har?color=green)](https://img.shields.io/gem/v/ferrum-har?color=green)
+[![Gem Version](https://img.shields.io/gem/v/ferrum-har?color=green)](https://rubygems.org/gems/ferrum-har)
+[![specs workflow](https://github.com/hlascelles/ferrum-har/actions/workflows/specs.yml/badge.svg)](https://github.com/hlascelles/ferrum-har/actions)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 [ferrum-har](https://github.com/hlascelles/ferrum-har) is a gem that adds the ability to capture
 [HAR](https://en.wikipedia.org/wiki/HAR_(file_format)) files while running tests
@@ -15,6 +17,17 @@ Add ferrum-har to your Gemfile and `bundle install`:
 gem "ferrum-har"
 ```
 
+Since version 1.0, we have had to support [a change](https://developer.chrome.com/blog/extension-news-june-2025#deprecations)
+to the way Chrome handles extensions. You must
+use Chrome Testing to use ferrum-har. A rake task is provided to help you download a chrome binary.
+It will put it in a folder called 
+
+```bash
+bundle exec rake chrome:install
+```
+
+Alternatively you can use the ENV `BROWSER_PATH` to point to the binary location.
+
 ## Usage
 
 Use [ferrum](https://github.com/rubycdp/ferrum) as normal and call the `har` method on
@@ -27,6 +40,7 @@ test run. This is mandatory to obtain the HAR from Chrome.
 browser = Ferrum::Browser.new
 page = browser.create_page
 page.go_to("https://www.bbc.co.uk")
+page.network.wait_for_idle
 
 # Returns the HAR as a JSON string
 puts page.har

data/lib/ferrum/har/command_extension.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# This module is prepended to Ferrum::Browser::Command to check options required by ferrum-har
+module Ferrum
+  module Har
+    class ConfigurationError < RuntimeError
+    end
+
+    module BrowserCommandExtension
+      def merge_options
+        super.tap do |options|
+          check_har_related_browser_options(options)
+        end
+
+        @path = ENV["BROWSER_PATH"] ||
+                begin
+                  # Find the one in the temp download dir.
+                  Dir.glob(".chrome-for-testing/*/chrome-linux64/chrome").max_by { |p|
+                    Gem::Version.new(p.split("/")[1])
+                  }
+                end
+      end
+
+      private def check_har_related_browser_options(options)
+        options = options.transform_keys(&:to_s)
+
+        check_disable_extensions_option(options)
+        check_load_extension_option(options)
+        check_auto_open_option(options)
+        check_headless_option(options)
+      end
+
+      private def check_disable_extensions_option(options)
+        disable_extensions_option_value = options.key?("disable-extensions")
+        return unless disable_extensions_option_value
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          The ferrum-har gem requires the 'disable-extensions' browser option to be absent,
+          ie: extensions should be allowed. The gem will do this for you automatically, but if you
+          override the value, then ferrum-har will not work.
+
+          It was found to be set to '#{disable_extensions_option_value}'.
+        MSG
+      end
+
+      private def check_load_extension_option(options)
+        load_extension_option_value = options["load-extension"]
+        return unless load_extension_option_value != "#{Ferrum::Har::GEM_DIR}/extension"
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          The ferrum-har gem requires the 'load-extension' browser option to be set to
+          '#{Ferrum::Har::GEM_DIR}/extension'. It will do this for you automatically, but if you
+          override the value, then ferrum-har will not work.
+
+          It was found to be set to '#{load_extension_option_value}'.
+        MSG
+      end
+
+      private def check_auto_open_option(options)
+        auto_open_value = options["auto-open-devtools-for-tabs"]
+        return if auto_open_value.nil?
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          The ferrum-har gem requires the 'auto-open-devtools-for-tabs' browser option be enabled,
+          '#{Ferrum::Har::GEM_DIR}/extension'. It will do this for you automatically, but if you
+          override the value, then ferrum-har will not work.
+          ie: set to nil.
+
+          It was found to be set to '#{auto_open_value}'.
+        MSG
+      end
+
+      private def check_headless_option(options)
+        headless_value = options["headless"]
+        return unless options.key?("headless") && [false, nil].include?(headless_value)
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          If you are using ferrum headless, the ferrum-har gem requires the browser
+          option 'headless' to be set to 'new' instead of true or nil. Read this for more details:
+          https://developer.chrome.com/docs/chromium/new-headless
+
+          It was found to be set to '#{headless_value}'.
+        MSG
+      end
+    end
+  end
+end

data/lib/ferrum/har/options_extension.rb

@@ -10,6 +10,8 @@ module Ferrum
           # We have to remove the "disable-extensions" option from the default browser extension
           # list because the ferrum-har gem requires an (internal) extension to work.
           .except("disable-extensions")
+          # At some point past v134 this stopped extensions loading properly in the first tab.
+          .except("no-startup-window")
           .merge(
             "auto-open-devtools-for-tabs" => nil, # Chrome devtools must be open to invoke getHAR
             "load-extension" => "#{Ferrum::Har::GEM_DIR}/extension", # Extension that gets the HAR

data/lib/ferrum/har/version.rb

@@ -2,6 +2,6 @@
 
 module Ferrum
   module Har
-    VERSION = "0.1.3"
+    VERSION = "1.0.0"
   end
 end

data/lib/ferrum/har.rb

@@ -3,6 +3,7 @@
 require "ferrum"
 require "ferrum/browser/options/chrome"
 require "ferrum/har/version"
+require "ferrum/har/command_extension"
 require "ferrum/har/page_extension"
 require "ferrum/har/options_extension"
 
@@ -17,3 +18,6 @@ Ferrum::Page.prepend(Ferrum::Har::PageExtension)
 
 # Add the #merge_default method to Ferrum::Browser::Options::Chrome
 Ferrum::Browser::Options::Chrome.prepend(Ferrum::Har::OptionsExtension)
+
+# Add the #check_har_related_browser_options method to Ferrum::Browser::Command
+Ferrum::Browser::Command.prepend(Ferrum::Har::BrowserCommandExtension)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum-har
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2025-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium_chrome_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rubygem to convert ferrum traffic to HAR files
 email:
 - harry@harrylascelles.com
@@ -52,6 +66,7 @@ files:
 - extension/panel.html
 - extension/panel.js
 - lib/ferrum/har.rb
+- lib/ferrum/har/command_extension.rb
 - lib/ferrum/har/options_extension.rb
 - lib/ferrum/har/page_extension.rb
 - lib/ferrum/har/version.rb
@@ -73,14 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Rubygem to convert ferrum traffic to HAR files