Look through all errors, don't just go with last error

Author: skatkov

lib/rspec/rails/matchers/have_reported_error.rb

@@ -1,5 +1,3 @@
-require "rspec/rails/matchers/base_matcher"
-
 module RSpec
   module Rails
     module Matchers
@@ -26,25 +24,20 @@ def report(error, **attrs)
       # Matcher class for `have_reported_error`. Should not be instantiated directly.
       #
       # Provides a way to test that an error was reported to Rails.error.
-      # This matcher follows the same patterns as RSpec's built-in `raise_error` matcher.
       #
       # @api private
       # @see RSpec::Rails::Matchers#have_reported_error
       class HaveReportedError < RSpec::Rails::Matchers::BaseMatcher
-        # Initialize the matcher following raise_error patterns
-        #
-        # Uses UndefinedValue as default to distinguish between no argument 
-        # passed vs explicitly passed nil (same as raise_error matcher).
+        # Uses UndefinedValue as default to distinguish between no argument
+        # passed vs explicitly passed nil.
         #
-        # @param expected_error_or_message [Class, String, Regexp, nil] 
+        # @param expected_error_or_message [Class, String, Regexp, nil]
         #   Error class, message string, or message pattern
-        # @param expected_message [String, Regexp, nil] 
+        # @param expected_message [String, Regexp, nil]
         #   Expected message when first param is a class
         def initialize(expected_error_or_message = UndefinedValue, expected_message = nil)
-          @actual_error = nil
           @attributes = {}
-          @error_subscriber = nil
-          
+
           case expected_error_or_message
           when nil, UndefinedValue
             @expected_error = nil
@@ -67,7 +60,6 @@ def and(_)
           raise ArgumentError, "Chaining is not supported"
         end
 
-        # Check if the block reports an error matching our expectations
         def matches?(block)
           if block.nil?
             raise ArgumentError, "this matcher doesn't work with value expectations"
@@ -122,6 +114,18 @@ def failure_message
             end
           elsif @error_subscriber.events.empty?
             return 'Expected the block to report an error, but none was reported.'
+          elsif actual_error.nil?
+            # Errors were reported but none matched our expectations
+            reported_errors = @error_subscriber.events.map { |event| "#{event.error.class}: '#{event.error.message}'" }.join(', ')
+            if @expected_error && @expected_message
+              return "Expected error to be an instance of #{@expected_error} with message '#{@expected_message}', but got: #{reported_errors}"
+            elsif @expected_error
+              return "Expected error to be an instance of #{@expected_error}, but got: #{reported_errors}"
+            elsif @expected_message.is_a?(Regexp)
+              return "Expected error message to match #{@expected_message}, but got: #{reported_errors}"
+            elsif @expected_message.is_a?(String)
+              return "Expected error message to be '#{@expected_message}', but got: #{reported_errors}"
+            end
           else
             if @expected_error && !actual_error.is_a?(@expected_error)
               return "Expected error to be an instance of #{@expected_error}, but got #{actual_error.class} with message: '#{actual_error.message}'"
@@ -148,44 +152,61 @@ def failure_message_when_negated
 
         private
 
-        # Check if the reported error matches our class and message expectations
+        # Check if any of the reported errors matches our class and message expectations
         def error_matches_expectation?
-          return false if @error_subscriber.events.empty?
-          return true if @expected_error.nil? && @expected_message.nil?
+          return true if @expected_error.nil? && @expected_message.nil? && @error_subscriber.events.count.positive?
 
-          error_class_matches? && error_message_matches?
+          @error_subscriber.events.any? do |event|
+            error_class_matches?(event.error) && error_message_matches?(event.error)
+          end
         end
 
-        # Check if the actual error class matches the expected error class
-        def error_class_matches?
-          @expected_error.nil? || actual_error.is_a?(@expected_error)
+        # Check if the given error class matches the expected error class
+        def error_class_matches?(error)
+          @expected_error.nil? || error.is_a?(@expected_error)
         end
 
-        # Check if the actual error message matches the expected message pattern
-        def error_message_matches?
+        # Check if the given error message matches the expected message pattern
+        def error_message_matches?(error)
           return true if @expected_message.nil?
-          
+
           case @expected_message
           when Regexp
-            actual_error.message&.match(@expected_message)
+            error.message&.match(@expected_message)
           when String
-            actual_error.message == @expected_message
+            error.message == @expected_message
           else
             false
           end
         end
 
         def attributes_match_if_specified?
           return true if @attributes.empty?
-          return false if @error_subscriber.events.empty?
 
-          event_context = @error_subscriber.events.last.attributes[:context]
+          matching_event = find_matching_event
+          return false unless matching_event
+
+          event_context = matching_event.attributes[:context]
           attributes_match?(event_context)
         end
 
-        # Get the actual error that was reported (cached)
+        # Get the first matching error from all reported events (cached)
         def actual_error
-          @actual_error ||= (@error_subscriber.events.empty? ? nil : @error_subscriber.events.last.error)
+          @actual_error ||= find_matching_error
+        end
+
+        # Find the first error that matches our expectations
+        def find_matching_error
+          @error_subscriber.events.find do |event|
+            error_class_matches?(event.error) && error_message_matches?(event.error)
+          end&.error
+        end
+
+        # Find the first event that matches our expectations
+        def find_matching_event
+          @error_subscriber.events.find do |event|
+            error_class_matches?(event.error) && error_message_matches?(event.error)
+          end
         end
 
         def attributes_match?(actual)

spec/rspec/rails/matchers/have_reported_error_spec.rb

@@ -48,7 +48,7 @@ class AnotherTestError < StandardError; end
         expect {
           Rails.error.report(AnotherTestError.new("wrong error"))
         }.to have_reported_error(TestError)
-      }.to fail_with(/Expected error to be an instance of TestError, but got AnotherTestError/)
+      }.to fail_with(/Expected error to be an instance of TestError, but got: AnotherTestError/)
     end
   end
 
@@ -70,7 +70,7 @@ class AnotherTestError < StandardError; end
         expect {
           Rails.error.report(TestError.new("actual message"))
         }.to have_reported_error(TestError, "expected message")
-      }.to fail_with(/Expected error message to be 'expected message', but got: 'actual message'/)
+      }.to fail_with(/Expected error to be an instance of TestError with message 'expected message', but got: TestError/)
     end
   end
 
@@ -86,7 +86,7 @@ class AnotherTestError < StandardError; end
         expect {
           Rails.error.report(StandardError.new("error without match"))
         }.to have_reported_error(StandardError, /different pattern/)
-      }.to fail_with(/Expected error message to match/)
+      }.to fail_with(/Expected error to be an instance of StandardError with message/)
     end
   end
 
@@ -180,15 +180,15 @@ class AnotherTestError < StandardError; end
         expect {
           Rails.error.report(StandardError.new("actual message"))
         }.to have_reported_error("expected message")
-      }.to fail_with(/Expected error message to be 'expected message', but got: 'actual message'/)
+      }.to fail_with(/Expected error message to be 'expected message', but got: StandardError/)
     end
 
     it "fails when no error with matching pattern is reported" do
       expect {
         expect {
           Rails.error.report(StandardError.new("error without match"))
         }.to have_reported_error(/different pattern/)
-      }.to fail_with(/Expected error message to match/)
+      }.to fail_with(/Expected error message to match .+different pattern.+, but got: StandardError/)
     end
   end