ferrum-har 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 652f3679a70306ac244d2a0627a3609da85ae96c8360365c3b21c1cb315b994c
-  data.tar.gz: 77443a4e93f2e05dfbc63b3370176778c2857a4bdf8663c4c953a88f6eca635d
+  metadata.gz: ae66c86e06740c5afb98f7633cbf466c71935fd406de55f196ec0c5a92668ed2
+  data.tar.gz: 5da78a09c0f1b07987c9497edaf20f542d0b37e827d944c936a72ad019b44b5e
 SHA512:
-  metadata.gz: '0358163ac7ff98f450c9027f2909713d8d5fcfafb0e0668de62d3de288b62912b2109a091340236bb3719b12a92e159be0ab3f379fb3137120f4e900110ec536'
-  data.tar.gz: 6b5aab790b3d341338734b73527bdc3532613fc2248b3b291d1cf856b96b0444bb3073ca4f8fbe053ae5db806807a0f00834304ed22cb950602a15f324e0d32a
+  metadata.gz: cc7dd1f84801f144725b561ed64a0a3c5d54c5b165c053da47a407b9682bcac4cfc62ba7294eea2eef8160744e17c54f845f926fb43dc00f03cef347e3ef511f
+  data.tar.gz: 6d793bb6ea3ff0df10a1b1b5c7576a546a91a5b00108c83491952c768b3e94f32b369ad8666ce8ed7f72ed4f940b7927730ee1605b3f5f0883936504c9e67a63

data/README.md

@@ -18,15 +18,18 @@ 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 
+to the way Chrome handles extensions which means you must use [Chrome For Testing](https://developer.chrome.com/blog/chrome-for-testing)
+to use ferrum-har. This involves downloading that Chrome version as a binary.
+
+A rake task is provided to help you download the binary, supplied by the [selenium_chrome_helper](https://github.com/pepito2k/selenium_chrome_helper) gem.
+It will put it in a folder called `.chrome-for-testing` in your project root. To execute it, run:
 
 ```bash
 bundle exec rake chrome:install
 ```
 
-Alternatively you can use the ENV `BROWSER_PATH` to point to the binary location.
+Alternatively you can use the ENV `BROWSER_PATH` to point to the binary location. Note, you can't
+point it to your standard Chrome installation, it must be the Chrome Testing binary.
 
 ## Usage
 
@@ -74,10 +77,26 @@ For further reading, a full list of Chrome switches can be found
 `ferrum-har` uses [semantic versioning](https://semver.org/), so major version changes will usually 
 require additional actions to be taken upgrading from one major version to another. 
 
+## Persistent Chrome profile
+
+You can specify the ENV `FERRUM_HAR_BROWSER_CONFIG_DIR` to point to a persistent Chrome profile dir
+between runs. This will allow you to do slow setup once, then do fast reruns of your tests. Note
+this should only be used for development purposes, your tests should not rely on a persistent
+profile in CI.
+
+See the [spec/acceptance/test.rb](https://github.com/hlascelles/ferrum-har/blob/master/spec/acceptance/test.rb) for
+an example of how to use this.
+
+## Single file example
+
+A single file example of how to use `ferrum-har` can be found in [spec/acceptance/test.rb](https://github.com/hlascelles/ferrum-har/blob/master/spec/acceptance/test.rb).
+
 ## Changelog
 
 A full changelog can be found here: [CHANGELOG.md](https://github.com/hlascelles/ferrum-har/blob/master/CHANGELOG.md)
 
+```
+
 ## Further work
 
 Some ideas for improvements.

data/lib/ferrum/har/command_extension.rb

@@ -6,19 +6,27 @@ module Ferrum
     class ConfigurationError < RuntimeError
     end
 
+    class << self
+      def find_chrome_for_testing_binary
+        Dir.glob(".chrome-for-testing/**/chrome").max_by { |p| Gem::Version.new(p.split("/")[1]) }
+      end
+    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
+        @path = ENV["BROWSER_PATH"] || Ferrum::Har.find_chrome_for_testing_binary
+
+        return if @path
+
+        raise <<~ERR
+          Browser path not found. Please set BROWSER_PATH environment variable, or trigger a download of Chrome Testing by using:
+
+          bundle exec rake chrome:install
+        ERR
       end
 
       private def check_har_related_browser_options(options)

data/lib/ferrum/har/options_extension.rb

@@ -6,9 +6,11 @@ module Ferrum
   module Har
     module OptionsExtension
       def merge_default(flags, options)
-        super
-          # 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.
+        original_result = super
+        # 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.
+        changed =
+          original_result
           .except("disable-extensions")
           # At some point past v134 this stopped extensions loading properly in the first tab.
           .except("no-startup-window")
@@ -16,6 +18,16 @@ module Ferrum
             "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
           )
+
+        # To get a custom config dir to work, we have to remove the "disable-web-security" option
+        if ENV["FERRUM_HAR_BROWSER_CONFIG_DIR"]
+          changed =
+            changed
+            .except("disable-web-security")
+            .merge("user-data-dir" => ENV["FERRUM_HAR_BROWSER_CONFIG_DIR"])
+        end
+
+        changed
       end
     end
   end

data/lib/ferrum/har/page_extension.rb

@@ -12,7 +12,7 @@ module Ferrum
       def har
         network.wait_for_idle
         execute("document.ferrumHarRequested = true;")
-        base64_encoded_har = Ferrum::Utils::Attempt.with_retry(
+        har_hash_result = Ferrum::Utils::Attempt.with_retry(
           errors: [HarNotReadyError],
           # 10 seconds
           max: 20,
@@ -21,13 +21,18 @@ module Ferrum
           found = evaluate("document.ferrumHar;")
           raise HarNotReadyError unless found
 
-          found
+          inlined_har = Base64.decode64(found)
+          har_hash = JSON.parse(inlined_har)
+          raise HarNotReadyError, "Result does not appear to be a HAR" unless har_hash.key?("log")
+
+          entries = har_hash.dig("log", "entries")
+          # If entries is nil or empty, the HAR is not ready yet.
+          raise HarNotReadyError if entries.nil? || entries.empty?
+
+          har_hash
         end
-        inlined_har = Base64.decode64(base64_encoded_har)
-        har_hash = JSON.parse(inlined_har)
-        raise "Result does not appear to be a HAR" unless har_hash.key?("log")
 
-        JSON.pretty_generate(har_hash)
+        JSON.pretty_generate(har_hash_result)
       end
     end
   end

data/lib/ferrum/har/version.rb

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

data/lib/ferrum/har.rb

@@ -7,6 +7,13 @@ require "ferrum/har/command_extension"
 require "ferrum/har/page_extension"
 require "ferrum/har/options_extension"
 
+# The chrome downloader helper
+if Gem.loaded_specs.key?("rake")
+  require "selenium_chrome_helper"
+  require "rake"
+  load "tasks/install.rake" # Load the chrome testing downloader task
+end
+
 module Ferrum
   module Har
     GEM_DIR = File.expand_path("../..", __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum-har
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-12 00:00:00.000000000 Z
+date: 2025-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64