Merge pull request #33824 from yskkin/suppress_logging

Skip delivery notification when perform_deliveries is false.

7 files changed, 58 insertions, 23 deletions

diff --git a/actionmailer/CHANGELOG.md b/actionmailer/CHANGELOG.md
index 1468a89e96..5158f23a27 100644
--- a/actionmailer/CHANGELOG.md
+++ b/actionmailer/CHANGELOG.md
@@ -1,3 +1,11 @@
+*   Add `perform_deliveries` to a payload of `deliver.action_mailer` notification.
+
+    *Yoshiyuki Kinjo*
+
+*   Change delivery logging message when `perform_deliveries` is false.
+
+    *Yoshiyuki Kinjo*
+
 *   Allow call `assert_enqueued_email_with` with no block.
 
     Example:
diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb
index 7f22af83b0..55f701b18e 100644
--- a/actionmailer/lib/action_mailer/base.rb
+++ b/actionmailer/lib/action_mailer/base.rb
@@ -588,15 +588,16 @@ module ActionMailer
     private
 
       def set_payload_for_mail(payload, mail)
-        payload[:mailer]     = name
-        payload[:message_id] = mail.message_id
-        payload[:subject]    = mail.subject
-        payload[:to]         = mail.to
-        payload[:from]       = mail.from
-        payload[:bcc]        = mail.bcc if mail.bcc.present?
-        payload[:cc]         = mail.cc  if mail.cc.present?
-        payload[:date]       = mail.date
-        payload[:mail]       = mail.encoded
+        payload[:mailer]             = name
+        payload[:message_id]         = mail.message_id
+        payload[:subject]            = mail.subject
+        payload[:to]                 = mail.to
+        payload[:from]               = mail.from
+        payload[:bcc]                = mail.bcc if mail.bcc.present?
+        payload[:cc]                 = mail.cc  if mail.cc.present?
+        payload[:date]               = mail.date
+        payload[:mail]               = mail.encoded
+        payload[:perform_deliveries] = mail.perform_deliveries
       end
 
       def method_missing(method_name, *args)
diff --git a/actionmailer/lib/action_mailer/log_subscriber.rb b/actionmailer/lib/action_mailer/log_subscriber.rb
index 87cfbfff28..25c99342c2 100644
--- a/actionmailer/lib/action_mailer/log_subscriber.rb
+++ b/actionmailer/lib/action_mailer/log_subscriber.rb
@@ -9,8 +9,13 @@ module ActionMailer
     # An email was delivered.
     def deliver(event)
       info do
+        perform_deliveries = event.payload[:perform_deliveries]
         recipients = Array(event.payload[:to]).join(", ")
-        "Sent mail to #{recipients} (#{event.duration.round(1)}ms)"
+        if perform_deliveries
+          "Sent mail to #{recipients} (#{event.duration.round(1)}ms)"
+        else
+          "Skipped sending mail to #{recipients} as `perform_deliveries` is false"
+        end
       end
 
       debug { event.payload[:mail] }
diff --git a/actionmailer/test/log_subscriber_test.rb b/actionmailer/test/log_subscriber_test.rb
index 2e89758dfb..7686fd10c9 100644
--- a/actionmailer/test/log_subscriber_test.rb
+++ b/actionmailer/test/log_subscriber_test.rb
@@ -37,6 +37,20 @@ class AMLogSubscriberTest < ActionMailer::TestCase
     BaseMailer.deliveries.clear
   end
 
+  def test_deliver_message_when_perform_deliveries_is_false
+    BaseMailer.welcome_without_deliveries.deliver_now
+    wait
+
+    assert_equal(1, @logger.logged(:info).size)
+    assert_match("Skipped sending mail to system@test.lindsaar.net as `perform_deliveries` is false", @logger.logged(:info).first)
+
+    assert_equal(2, @logger.logged(:debug).size)
+    assert_match(/BaseMailer#welcome_without_deliveries: processed outbound mail in [\d.]+ms/, @logger.logged(:debug).first)
+    assert_match("Welcome", @logger.logged(:debug).second)
+  ensure
+    BaseMailer.deliveries.clear
+  end
+
   def test_receive_is_notified
     fixture = File.read(File.expand_path("fixtures/raw_email", __dir__))
     TestMailer.receive(fixture)
diff --git a/actionmailer/test/mailers/base_mailer.rb b/actionmailer/test/mailers/base_mailer.rb
index bfaecdb658..a3101207dc 100644
--- a/actionmailer/test/mailers/base_mailer.rb
+++ b/actionmailer/test/mailers/base_mailer.rb
@@ -21,6 +21,11 @@ class BaseMailer < ActionMailer::Base
     mail(template_name: "welcome", template_path: path)
   end
 
+  def welcome_without_deliveries
+    mail(template_name: "welcome")
+    mail.perform_deliveries = false
+  end
+
   def html_only(hash = {})
     mail(hash)
   end
diff --git a/guides/source/action_mailer_basics.md b/guides/source/action_mailer_basics.md
index 37cbf3f53d..406615f681 100644
--- a/guides/source/action_mailer_basics.md
+++ b/guides/source/action_mailer_basics.md
@@ -787,7 +787,7 @@ files (environment.rb, production.rb, etc...)
 |`sendmail_settings`|Allows you to override options for the `:sendmail` delivery method.<ul><li>`:location` - The location of the sendmail executable. Defaults to `/usr/sbin/sendmail`.</li><li>`:arguments` - The command line arguments to be passed to sendmail. Defaults to `-i`.</li></ul>|
 |`raise_delivery_errors`|Whether or not errors should be raised if the email fails to be delivered. This only works if the external email server is configured for immediate delivery.|
 |`delivery_method`|Defines a delivery method. Possible values are:<ul><li>`:smtp` (default), can be configured by using `config.action_mailer.smtp_settings`.</li><li>`:sendmail`, can be configured by using `config.action_mailer.sendmail_settings`.</li><li>`:file`: save emails to files; can be configured by using `config.action_mailer.file_settings`.</li><li>`:test`: save emails to `ActionMailer::Base.deliveries` array.</li></ul>See [API docs](http://api.rubyonrails.org/classes/ActionMailer/Base.html) for more info.|
-|`perform_deliveries`|Determines whether deliveries are actually carried out when the `deliver` method is invoked on the Mail message. By default they are, but this can be turned off to help functional testing.|
+|`perform_deliveries`|Determines whether deliveries are actually carried out when the `deliver` method is invoked on the Mail message. By default they are, but this can be turned off to help functional testing. If this value is `false`, `deliveries` array will not be populated even if delivery_method is :test.|
 |`deliveries`|Keeps an array of all the emails sent out through the Action Mailer with delivery_method :test. Most useful for unit and functional testing.|
 |`default_options`|Allows you to set default values for the `mail` method options (`:from`, `:reply_to`, etc.).|
 
diff --git a/guides/source/active_support_instrumentation.md b/guides/source/active_support_instrumentation.md
index 8581817d71..69c6a6e414 100644
--- a/guides/source/active_support_instrumentation.md
+++ b/guides/source/active_support_instrumentation.md
@@ -319,17 +319,18 @@ Action Mailer
 
 ### deliver.action_mailer
 
-| Key           | Value                                        |
-| ------------- | -------------------------------------------- |
-| `:mailer`     | Name of the mailer class                     |
-| `:message_id` | ID of the message, generated by the Mail gem |
-| `:subject`    | Subject of the mail                          |
-| `:to`         | To address(es) of the mail                   |
-| `:from`       | From address of the mail                     |
-| `:bcc`        | BCC addresses of the mail                    |
-| `:cc`         | CC addresses of the mail                     |
-| `:date`       | Date of the mail                             |
-| `:mail`       | The encoded form of the mail                 |
+| Key                   | Value                                                |
+| --------------------- | ---------------------------------------------------- |
+| `:mailer`             | Name of the mailer class                             |
+| `:message_id`         | ID of the message, generated by the Mail gem         |
+| `:subject`            | Subject of the mail                                  |
+| `:to`                 | To address(es) of the mail                           |
+| `:from`               | From address of the mail                             |
+| `:bcc`                | BCC addresses of the mail                            |
+| `:cc`                 | CC addresses of the mail                             |
+| `:date`               | Date of the mail                                     |
+| `:mail`               | The encoded form of the mail                         |
+| `:perform_deliveries` | Whether delivery of this message is performed or not |
 
 ```ruby
 {
@@ -339,7 +340,8 @@ Action Mailer
   to: ["users@rails.com", "dhh@rails.com"],
   from: ["me@rails.com"],
   date: Sat, 10 Mar 2012 14:18:09 +0100,
-  mail: "..." # omitted for brevity
+  mail: "...", # omitted for brevity
+  perform_deliveries: true
 }
 ```