expect { }.to have_enqueued_mail().with() doesn't work with ActionMailer::MailDeliveryJob

[simmerz]

What Ruby, Rails and RSpec versions are you using?

Ruby version: 2.5.1
Rails version: 6.0.0
RSpec version: branch 4-0-dev

Observed behaviour

Given an email enqueued with:

SomeMailer.with(object: foo, option: { amended: true }).some_method.deliver_later

I would expect the following to pass:

expect { some_action_which_enqueues_mail }.to have_enqueued_mail(SomeMailer, :some_method).with(object: foo, option: { amended: true })

It doesn't pass when setting the default delivery job to ActionMailer::MailDeliveryJob but does when using the legacy ActionMailer::Parameterized::DeliveryJob (ie. config.load_defaults 5.2 and Rails.application.config.action_mailer.delivery_job = 'ActionMailer::MailDeliveryJob' commented out in config/initializers/new_framework_defaults_6_0.rb

The listed enqueued mails shows the mail has been enqueued, but I cannot seem to access it with my test criteria.

[benoittgt]

Hello @simmerz

Thanks for your issue. Could you provide a reproduction script or new Rails project?

Thanks

[simmerz]

Hi @benoittgt - here's a blank rails project recreating the issue: https://github.com/simmerz/rspec_mailer_bug

[JonRowe]

@benoittgt I'm pretty certain this has to do with the class used, its just not detecting the mail jobs used in Rails 6.

[simmerz]

@JonRowe without the with() it passes. Just not without, and it's specific to the new MailDeliveryJob class. The old ones work fine, but everything is being deprecated to be removed in Rails 6.1

[JonRowe]

@simmerz Interesting, then its probably the format of the arguments used, as thats how it changes when you use with https://github.com/rspec/rspec-rails/blob/master/lib/rspec/rails/matchers/have_enqueued_mail.rb#L68

[simmerz]

Failure output:

Failures:

  1) MailerTestService is expected to enqueues MailtestMailer.mailtest
     Failure/Error:
       expect { described_class.new.save }
         .to have_enqueued_mail(MailtestMailer, :mailtest)
         .with(option: { foo: 'bar' })
     
       expected to enqueue MailtestMailer.mailtest exactly 1 time with [{:option=>{:foo=>"bar"}}], but enqueued 0
       Queued deliveries:
         MailtestMailer.mailtest with [{"params"=>{"option"=>{"foo"=>"bar", "_aj_symbol_keys"=>["foo"]}, "_aj_symbol_keys"=>["option"]}, "args"=>[], "_aj_symbol_keys"=>["params", "args"]}]
     # ./spec/services/mailer_test_service_spec.rb:7:in `block (2 levels) in <top (required)>'

[JonRowe]

There we go then, it does some new mangling of arguments, previously they were just verbatim.

[simmerz]

So that's something I should be fixing in my code, or should be handled in the with() expectation?

[JonRowe]

Something that needs to be added to the params building code in the matcher when Rails 6 is being used with this new mailer class

[JonRowe]

You could work around it for now with a_hash_including("params" => a_hash_including("option" => "bar"))

[JonRowe]

I don't have time to work on this myself right now, do you feel like tackling a PR or @benoittgt ?

[simmerz]

Like you've described, if I use the following, the test passes:

.with(params: { option: { foo: 'bar' } }, args: [])

We need to handle someone creating a mail with params eg SomeMailer.with(params).mailer_method as well as with args eg SomeMailer.mailer_method(args)

I'm not sure what the best way to tackle those would be. Any pointers appreciated and I'd be happy to submit a PR

[JonRowe]

The tactic we've used before is to use the rails param parsing code itself to create the params we check against the queued ones.

[mkamensky]

I just ran into the same issue (I think) and fixed it by changing

rspec-rails/lib/rspec/rails/matchers/have_enqueued_mail.rb

Line 76 in e50def6

base_mailer_args + @mail_args

into:

base_mailer_args + [args: @mail_args]

I'm not sure this is the right fix, and that it works in the other configuration, but it worked for me.

[mkamensky]

Also, this requires changing mail_job_message as follows:

        def mail_job_message(job)
          mailer_method = job[:args][0..1].join('.')

          msg_parts = []
          msg_parts << "with #{::ActiveJob::Arguments.deserialize(job[:args][3]['args'])}" if job[:args][3]
          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