lighthouse-matchers 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b73401322398ad659f111555923e60f2859c90e1e24893c209686842340de06
-  data.tar.gz: 2fec0776316b961004e8254ab49f374dc56eff5096a3336d2216294b10cbe13c
+  metadata.gz: 13b0c2fb40335271d04162ba9302b8f8601a294d6c8c26b6e904322013daf227
+  data.tar.gz: 891fa3772857cb424f555b49985347867b2ab89560e5fa3c5992fe689e8d49ed
 SHA512:
-  metadata.gz: f847e1a748e9097df8a7345e60f3249f15ae9c3031885a756c9ce2a6bf582032d4de281c2f2b6c088a73baca86a7158f3101f637f9c376298b665848d1f9f7c2
-  data.tar.gz: f461dd4cc3b146228986c833857421a9861b9b65d0b1095b90f10dae40bed454009c83fc5b1dadb60ca246a43768fec984226933fd980abe81aa990681c3c715
+  metadata.gz: 58d574c6e7bce9e98fac696113867807615e996d1c564520c276a5eb296fa76d83e6c1714d63a6a6fae4008549c896215e87562535dbcdd7a5194a9bc592e7e2
+  data.tar.gz: f24d482030024f6bb8a20d9b679cdcad500b892097e7d6b95fa1c6ea0b0d8c2c6c248d0a1ab7913f903a0886c5cec06aa8bc79871b01bb43f1eb7fcb630f0f85

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.4.0] - 2025-09-17
+### Added
+- Added config options for "preset" and "form-factor" so those parameters can be passed to the `lighthouse` command ([#71](https://github.com/ackama/lighthouse-matchers/pull/71))
+
+## [1.3.0] - 2025-08-13
+### Added
+- Write audit results to disk on failure so they can be viewed using the browser viewer ([#68](https://github.com/ackama/lighthouse-matchers/pull/68))
+
+### Changed
+- Prefix warnings with the full example description ([#69](https://github.com/ackama/lighthouse-matchers/pull/69))
+
 ## [1.2.0] - 2024-07-13
 ### Changed
 - Raise an explict error when the audit category is not found ([#56](https://github.com/ackama/lighthouse-matchers/pull/56))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lighthouse-matchers (1.2.0)
+    lighthouse-matchers (1.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,8 +14,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (2.2.0)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.4.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -43,9 +42,8 @@ GEM
     rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    strscan (3.1.0)
     unicode-display_width (2.1.0)
-    webrick (1.7.0)
+    webrick (1.8.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -102,7 +102,15 @@ All configuration keys are accessible against the `Lighthouse::Matchers` object.
   for the CLI. This setting can be used if the Lighthouse tool is installed in a non-standard location.
 * **`minimum_score`:** The default minimum score that audits must meet for the matcher to pass.
   The default value of this configuration setting is '100' - e.g. audits must fully comply to pass.
+* **`preset`:** The built-in configuration that will be used by Lighthouse CLI if defined
+  Options: "perf", "experimental", "desktop"
+* **`form_factor`:** If defined, this value changes how performance metrics are measured and whether mobile only checks are performed
+  If you are intending to run lighthouse to only test the desktop version of your site, it is recommended that you use preset instead.
+  Options: "desktop", "mobile"
 * **`chrome_flags`:** Any additional flags that should be passed to Chrome when Lighthouse launches a browser instance. As an example, running Lighthouse in Docker requires the normal headless Chrome flags (`--headless`, `--no-sandbox`) for Chrome to successfully start. Chrome flags can either be specified as an array (`["headless", "no-sandbox"]`) or as a string (`--headless --no-sandbox`).
+* **`results_directory`:** Directory to write lighthouse results on failure
+  * Defaults to `<RSpec.configuration.default_path>/lighthouse` if `RSpec` is defined, otherwise a temporary directory prefixed with `lighthouse-matchers-`
+  * For Rails applications, we recommend setting this to `Rails.root.join('/tmp/lighthouse')` in your `rails_helper.rb`
 
 ## Compatibility
 

data/lib/lighthouse/audit_service.rb

@@ -15,6 +15,8 @@ class AuditService
     @runner = Lighthouse::Matchers.runner
     @cmd = Lighthouse::Matchers.lighthouse_cli
     @chrome_flags = Lighthouse::Matchers.chrome_flags
+    @preset = Lighthouse::Matchers.preset
+    @form_factor = Lighthouse::Matchers.form_factor
   end
 
   def passing_score?
@@ -29,6 +31,10 @@ class AuditService
     results['runWarnings']
   end
 
+  def results
+    @results ||= JSON.parse(output)
+  end
+
   private
 
   def category
@@ -48,14 +54,12 @@ class AuditService
       builder << " --only-categories=#{@audit}"
       builder << " --port=#{@port}" if @port
       builder << " --chrome-flags='#{@chrome_flags}'" if @chrome_flags
+      builder << " --preset=#{@preset}" if @preset
+      builder << " --form-factor=#{@form_factor}" if @form_factor
     end.strip
   end
 
   def output
     @output ||= @runner.call("#{@cmd} #{opts}")
   end
-
-  def results
-    @results ||= JSON.parse(output)
-  end
 end

data/lib/lighthouse/matchers/rspec.rb

@@ -4,28 +4,35 @@ require 'rspec/expectations'
 require 'lighthouse/matchers'
 require 'lighthouse/audit_service'
 require 'json'
+require 'digest'
+require 'fileutils'
 
-RSpec::Matchers.define :pass_lighthouse_audit do |audit, args = {}|
+RSpec::Matchers.define :pass_lighthouse_audit do |audit, args = {}| # rubocop:disable Metrics/BlockLength
   score ||= args.fetch(:score, Lighthouse::Matchers.minimum_score)
 
   match do |target|
-    audit_service = AuditService.new(url(target), audit, score)
+    @audit_service = AuditService.new(url(target), audit, score)
 
-    audit_service.run_warnings.each do |warning|
+    @audit_service.run_warnings.each do |warning|
       RSpec.configuration.reporter.message(
-        "#{RSpec.current_example.location}: [lighthouse] #{warning}"
+        "#{RSpec.current_example.full_description}: [lighthouse] #{warning}"
       )
     end
 
-    @measured_score = audit_service.measured_score
+    @measured_score = @audit_service.measured_score
 
-    audit_service.passing_score?
+    @audit_service.passing_score?
   end
 
   failure_message do |target|
     <<~FAIL
       expected #{url(target)} to pass Lighthouse #{audit} audit
       with a minimum score of #{score}, but only scored #{@measured_score.to_i}
+
+      Full report:
+       #{save_audit_results}
+
+       To view this report, load this file into https://googlechrome.github.io/lighthouse/viewer/
     FAIL
   end
 
@@ -34,4 +41,15 @@ RSpec::Matchers.define :pass_lighthouse_audit do |audit, args = {}|
   def url(target)
     target.respond_to?(:current_url) ? target.current_url : target
   end
+
+  def save_audit_results
+    body = JSON.pretty_generate(@audit_service.results)
+
+    path = File.join(Lighthouse::Matchers.results_directory, "#{Digest::SHA1.hexdigest(body)}.json")
+
+    FileUtils.mkdir_p(Lighthouse::Matchers.results_directory)
+    File.write(path, body)
+
+    path
+  end
 end

data/lib/lighthouse/matchers/version.rb

@@ -2,6 +2,6 @@
 
 module Lighthouse
   module Matchers
-    VERSION = '1.2.0'
+    VERSION = '1.4.0'
   end
 end

data/lib/lighthouse/matchers.rb

@@ -9,8 +9,8 @@ module Lighthouse
   module Matchers # rubocop:disable Style/Documentation
     class Error < StandardError; end
     class << self
-      attr_writer :minimum_score, :lighthouse_cli, :runner, :chrome_flags
-      attr_accessor :remote_debugging_port
+      attr_writer :minimum_score, :lighthouse_cli, :runner, :chrome_flags, :results_directory
+      attr_accessor :remote_debugging_port, :preset, :form_factor
 
       def minimum_score
         @minimum_score ||= default_minimum_score
@@ -31,6 +31,14 @@ module Lighthouse
         @chrome_flags.map { |f| "--#{f}" }.join(' ')
       end
 
+      def results_directory
+        @results_directory ||= if defined?(RSpec)
+                                 File.join(RSpec.configuration.default_path, 'lighthouse')
+                               else
+                                 Dir.mktmpdir('lighthouse-matchers-')
+                               end
+      end
+
       private
 
       def guess_lighthouse_cli