Add MailDeliveryJob for unified mail delivery #34591

gmcgibbon · 2018-12-02T04:31:00Z

Summary

In #34367, we merged a breaking change to actionmailer that changed the parameters of DeliveryJob. This will cause upgrade pains for any app delivering mail in the background. This patch attempts to rectify the situation by reverting and deprecating DeliveryJob and Parameterized::DeliveryJob and introducing NewDeliveryJob to send either kind of mail.

Because web and job workers aren't always deployed to in lockstep, and enqueued jobs can be worked off at any time during a deployment, we have two problems to solve:

Old delivery jobs need to be able to be worked off by a rails 6 job worker.
New delivery jobs have to be able to be worked off by an old rails 5.x job worker.

So, the parameter change to DeliveryJob needs to be reverted and Parameterized::DeliveryJob needs to be brought back to satisfy problem 1. And, the NewDeliveryJob class needs to be backported to 5.x to satisfy problem 2. I'll followup with a backport PR if we can all agree on this course of action.

cc @eileencodes @Edouard-chin

eileencodes

I haven't tried this with our app but I think it looks good. One concern I have is the name NewDeliveryJob isn't going to be a good name in a few years so I think we should change it to something we want to keep long term.

And, the NewDeliveryJob class needs to be backported to 5.x to satisfy problem 2. I'll followup with a backport PR if we can all agree on this course of action.

I think if the code isn't deprecated until 6.1 and the jobs work in 6.0 then we don't need a backport.

eileencodes · 2018-12-03T13:31:20Z

actionmailer/lib/action_mailer.rb

@@ -52,6 +52,7 @@ module ActionMailer
  autoload :TestHelper
  autoload :MessageDelivery
  autoload :DeliveryJob
+  autoload :NewDeliveryJob


I'm not sure NewDeliveryJob is the best name. We don't want users to have to change the constant name back after we fully remove DeliveryJob (and after a few years NewDeliveryJob will be a strange name cause it's not new anymore). What about a name that better describes the roll of this job AND has the new code like MailDeliveryJob?

My plan was to deprecate NewDeliveryJob and rename to DeliveryJob in 6.2 or 7.0 but that will also cause problems for people that upgrade multiple versions at a time. I'll rename to MailDeliveryJob!

eileencodes · 2018-12-03T13:40:39Z

actionmailer/lib/action_mailer/new_delivery_job.rb

+    def perform(mailer, mail_method, delivery_method, params:, args:) #:nodoc:
+      mailer_class = params ? mailer.constantize.with(params) : mailer.constantize
+      mailer_class.public_send(mail_method, *args).send(delivery_method)
+    end


Sorry missed this on the first round of review - I think params should be nil by default right? Since parameter jobs are a special kind of job?

eileencodes · 2018-12-03T13:41:33Z

actionmailer/lib/action_mailer/delivery_job.rb

-      mailer_class.public_send(mail_method, *args).send(delivery_method)
+    before_perform do
+      ActiveSupport::Deprecation.warn <<~MSG.squish
+        Sending mail with DeliveryJob and Parameterized::DeliveryJob


Since Parameterized::DeliveryJob isn't released yet can we instead deprecate just DeliveryJob and then recommend the new one? If you need the params key then you should use the new one.

I removed Parameterized::DeliveryJob from the warning, but the warning will still happen for parameterized delivery jobs because its a subclass. I assume this is good enough?

I was thinking that Parameterized::DeliveryJob has never been released so we can delete the code that supported Parameterized::DeliveryJob and anyone who needs a Parameterized::DeliveryJob would use the new MailDeliveryJob instead.

I think it is released in all versions since 5.1.0

Ah I see I was thinking of this PR 251b9d4 which is only in master.

rafaelfranca · 2018-12-03T20:20:55Z

Don't we need to add back Parameterized::DeliveryJob? Otherwise it will fail if a Rails 6 worker get a job enqueued in Rails 5.2.

rafaelfranca · 2018-12-03T20:22:00Z

Ah, just saw it.

eileencodes · 2018-12-04T14:06:01Z

actionmailer/lib/action_mailer/delivery_job.rb

+    before_perform do
+      ActiveSupport::Deprecation.warn <<~MSG.squish
+        Sending mail with DeliveryJob is deprecated and
+        will be removed in Rails 6.1. Please use NewDeliveryJob instead.


This should say MailDeliveryJob now. Also let's add back in the Paramertized deprecation since I was wrong about when it was added.

Add `MailDeliveryJob` for delivering both regular and parameterized mail. Deprecate using `DeliveryJob` and `Parameterized::DeliveryJob`.

gmcgibbon · 2018-12-04T16:12:35Z

I think if the code isn't deprecated until 6.1 and the jobs work in 6.0 then we don't need a backport.

I'm fairly certain that (depending on the number of job workers you have, and your infrastructure) there can be big delays in waiting for all workers to be updated to the latest deployed version of an app. I believe I've seen an old job worker pickup a job enqueued from a new web worker before. Doesn't this mean we should backport MailDeliveryJob to a 5.x release?

mjankowski · 2019-02-25T19:14:24Z

actionmailer/lib/action_mailer/mail_delivery_job.rb

+require "active_job"
+
+module ActionMailer
+  # The <tt>ActionMailer::NewDeliveryJob</tt> class is used when you


It looks like this one mention of NewDeliveryJob stuck around even though most others were updated to MailDeliveryJob instead?

Fixed. Thanks

* Update gemfile and run rails app:upgrade * Fix optional belongs to in mail alias * Temp disable bullet * Fix scope deprecation warnings (rails/rails#35186) * Fix mail delivery job deprecation (rails/rails#34591) * Switch to load 6.0 - Fix deprecation warnings about initalizers - Fix model_name eager loading - Fix autoimport - Fix carrierwave * Cleanup * Rubocop * Re-enable bullet * Fix bullet * Update lockfile * Update activity spec and rubocop-performance version * rubocop * Typo * Remove secret token since it is not used since rails 6 * Remove carrierwave uploader * Sentry.rb * Add additional test case for accept mail

mathieujobin · 2020-04-28T06:01:19Z

Hey started,

started getting this deprecation warning and I was wondering why...
didn't you want to update the default at https://github.com/rails/rails/blob/master/actionmailer/lib/action_mailer/base.rb#L460 ??

gmcgibbon assigned rafaelfranca Dec 2, 2018

rails-bot bot added the actionmailer label Dec 2, 2018

eileencodes requested changes Dec 3, 2018

View reviewed changes

eileencodes reviewed Dec 3, 2018

View reviewed changes

rafaelfranca added this to the 6.0.0 milestone Dec 3, 2018

gmcgibbon force-pushed the new_delivery_job branch from 4f557d3 to a72684c Compare December 3, 2018 16:17

gmcgibbon changed the title ~~Add NewDeliveryJob for unified mail delivery~~ Add MailDeliveryJob for unified mail delivery Dec 3, 2018

eileencodes reviewed Dec 4, 2018

View reviewed changes

Add MailDeliveryJob for unified mail delivery

f5050d9

Add `MailDeliveryJob` for delivering both regular and parameterized mail. Deprecate using `DeliveryJob` and `Parameterized::DeliveryJob`.

gmcgibbon force-pushed the new_delivery_job branch from a72684c to f5050d9 Compare December 4, 2018 16:00

eileencodes approved these changes Dec 5, 2018

View reviewed changes

eileencodes merged commit d76d8f7 into rails:master Dec 5, 2018

gmcgibbon deleted the new_delivery_job branch December 5, 2018 16:59

gmcgibbon mentioned this pull request Dec 12, 2018

Move MailDeliveryJob default to 6.0 defaults #34692

Merged

mjankowski reviewed Feb 25, 2019

View reviewed changes

ignatiusreza mentioned this pull request May 13, 2019

add missing require to have_enqueued_mail rspec/rspec-rails#2117

Merged

Edouard-chin mentioned this pull request Oct 30, 2019

assert_enqueued_emails does not work when sending a parameterized email #37605

Closed

Matthijsy added a commit to csvalpha/amber-api that referenced this pull request Nov 25, 2019

Fix mail delivery job deprecation (rails/rails#34591)

1b15a13

mathieujobin mentioned this pull request Apr 28, 2020

MailDeliveryJob should be the new default #39072

Closed

rhymes mentioned this pull request May 23, 2020

Upgrade to Rails 6.0 forem/forem#7658

Merged

12 tasks

jlledom mentioned this pull request Jul 13, 2023

THREESCALE-7405: Update Rails to 6.0 3scale/porta#3456

Merged

Add MailDeliveryJob for unified mail delivery #34591

Add MailDeliveryJob for unified mail delivery #34591

gmcgibbon commented Dec 2, 2018

eileencodes left a comment

eileencodes Dec 3, 2018

gmcgibbon Dec 3, 2018

eileencodes Dec 3, 2018

eileencodes Dec 3, 2018

gmcgibbon Dec 3, 2018

eileencodes Dec 3, 2018

gmcgibbon Dec 3, 2018

eileencodes Dec 3, 2018

rafaelfranca commented Dec 3, 2018

rafaelfranca commented Dec 3, 2018

eileencodes Dec 4, 2018

gmcgibbon commented Dec 4, 2018

mjankowski Feb 25, 2019

rafaelfranca Feb 25, 2019

mathieujobin commented Apr 28, 2020

Add MailDeliveryJob for unified mail delivery #34591

Add MailDeliveryJob for unified mail delivery #34591

Conversation

gmcgibbon commented Dec 2, 2018

Summary

eileencodes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafaelfranca commented Dec 3, 2018

rafaelfranca commented Dec 3, 2018

Choose a reason for hiding this comment

gmcgibbon commented Dec 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mathieujobin commented Apr 28, 2020