Fix mailer argument deserialisation for 6.1 on Ruby 3.1

Author: JonRowe

.rubocop_todo.yml

@@ -9,7 +9,3 @@ Layout/LineLength:
 # Over time we'd like to get this down, but this is what we're at now.
 Metrics/MethodLength:
   Max: 43 # default: 10
-
-Metrics/ClassLength:
-  Exclude:
-    - lib/rspec/rails/matchers/have_enqueued_mail.rb

lib/rspec/rails/feature_check.rb

@@ -39,10 +39,6 @@ def has_action_mailbox?
         defined?(::ActionMailbox)
       end
 
-      def ruby_3_1?
-        RUBY_VERSION >= "3.1"
-      end
-
       def type_metatag(type)
         "type: :#{type}"
       end

lib/rspec/rails/matchers/have_enqueued_mail.rb

@@ -4,6 +4,7 @@
 require "rspec/mocks/argument_matchers"
 require "rspec/rails/matchers/active_job"
 
+# rubocop: disable Metrics/ClassLength
 module RSpec
   module Rails
     module Matchers
@@ -12,6 +13,7 @@ module Matchers
       # @private
       # @see RSpec::Rails::Matchers#have_enqueued_mail
       class HaveEnqueuedMail < ActiveJob::HaveEnqueuedJob
+
         MAILER_JOB_METHOD = 'deliver_now'.freeze
 
         include RSpec::Mocks::ArgumentMatchers
@@ -76,7 +78,7 @@ def job_match?(job)
         def arguments_match?(job)
           @args =
             if @mail_args.any?
-              base_mailer_args + process_arguments(job, @mail_args)
+              base_mailer_args + @mail_args
             elsif @mailer_class && @method_name
               base_mailer_args + [any_args]
             elsif @mailer_class
@@ -88,38 +90,12 @@ def arguments_match?(job)
           super(job)
         end
 
-        def process_arguments(job, given_mail_args)
-          # Old matcher behavior working with all builtin classes but ActionMailer::MailDeliveryJob
-          return given_mail_args if use_given_mail_args?(job)
-
-          # If matching args starts with a hash and job instance has params match with them
-          if given_mail_args.first.is_a?(Hash) && job[:args][3]['params'].present?
-            [hash_including(params: given_mail_args[0], args: given_mail_args.drop(1))]
-          else
-            [hash_including(args: given_mail_args)]
-          end
-        end
-
-        def use_given_mail_args?(job)
-          return true if FeatureCheck.has_action_mailer_parameterized? && job[:job] <= ActionMailer::Parameterized::DeliveryJob
-          return false if FeatureCheck.ruby_3_1?
-
-          !(FeatureCheck.has_action_mailer_unified_delivery? && job[:job] <= ActionMailer::MailDeliveryJob)
-        end
-
         def base_mailer_args
           [mailer_class_name, @method_name.to_s, MAILER_JOB_METHOD]
         end
 
         def yield_mail_args(block)
-          proc do |*job_args|
-            mailer_args = job_args - base_mailer_args
-            if mailer_args.first.is_a?(Hash)
-              block.call(*mailer_args.first[:args])
-            else
-              block.call(*mailer_args)
-            end
-          end
+          proc { |*job_args| block.call(*(job_args - base_mailer_args)) }
         end
 
         def check_active_job_adapter
@@ -145,22 +121,41 @@ def unmatching_mail_jobs_message
         end
 
         def mail_job_message(job)
-          mailer_method = job[:args][0..1].join('.')
-          mailer_args = deserialize_arguments(job)[3..-1]
-          mailer_args = mailer_args.first[:args] if unified_mail?(job)
+          job_args = deserialize_arguments(job)
+
+          mailer_method = job_args[0..1].join('.')
+          mailer_args = job_args[3..-1]
+
           msg_parts = []
-          display_args = display_mailer_args(mailer_args)
-          msg_parts << "with #{display_args}" if display_args.any?
+          msg_parts << "with #{mailer_args}" if mailer_args.any?
           msg_parts << "on queue #{job[:queue]}" if job[:queue] && job[:queue] != 'mailers'
           msg_parts << "at #{Time.at(job[:at])}" if job[:at]
 
           "#{mailer_method} #{msg_parts.join(', ')}".strip
         end
 
-        def display_mailer_args(mailer_args)
-          return mailer_args unless mailer_args.first.is_a?(Hash) && mailer_args.first.key?(:args)
+        # Ruby 3.1 changed how params were serialized on Rails 6.1
+        # so we override the active job implementation and customise it here.
+        def deserialize_arguments(job)
+          args = super
+
+          return args unless Hash === args.last
+
+          hash = args.pop
 
-          mailer_args.first[:args]
+          if hash.key?("_aj_ruby2_keywords")
+            keywords = hash["_aj_ruby2_keywords"]
+
+            original_hash = keywords.each_with_object({}) { |new_hash, keyword| new_hash[keyword.to_sym] = hash[keyword] }
+
+            args + [original_hash]
+          elsif hash.key?(:args) && hash.key?(:params)
+            args + [hash]
+          elsif hash.key?(:args)
+            args + hash[:args]
+          else
+            args + [hash]
+          end
         end
 
         def legacy_mail?(job)
@@ -174,6 +169,7 @@ def parameterized_mail?(job)
         def unified_mail?(job)
           RSpec::Rails::FeatureCheck.has_action_mailer_unified_delivery? && job[:job] <= ActionMailer::MailDeliveryJob
         end
+
       end
       # @api public
       # Passes if an email has been enqueued inside block.
@@ -229,3 +225,4 @@ def have_enqueued_mail(mailer_class = nil, mail_method_name = nil)
     end
   end
 end
+# rubocop: enable Metrics/ClassLength

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb

@@ -399,16 +399,18 @@ def self.name; "NonMailerJob"; end
         }.to have_enqueued_mail(UnifiedMailer, :email_with_args).with(1, 2)
       end
 
-      it "matches arguments when mailer is parameterized" do
+      it "passes with provided argument matchers" do
         expect {
           UnifiedMailer.with('foo' => 'bar').test_email.deliver_later
-        }.to have_enqueued_mail(UnifiedMailer, :test_email).with('foo' => 'bar')
-      end
+        }.to have_enqueued_mail(UnifiedMailer, :test_email).with(
+          a_hash_including(params: {'foo' => 'bar'})
+        )
 
-      it "matches arguments when mixing parameterized and non-parameterized emails" do
         expect {
           UnifiedMailer.with('foo' => 'bar').email_with_args(1, 2).deliver_later
-        }.to have_enqueued_mail(UnifiedMailer, :email_with_args).with({'foo' => 'bar'}, 1, 2)
+        }.to have_enqueued_mail(UnifiedMailer, :email_with_args).with(
+          a_hash_including(params: {'foo' => 'bar'}, args: [1, 2])
+        )
       end
 
       it "passes when using a mailer with `delivery_job` set to a sub class of `ActionMailer::DeliveryJob`" do