Merge remote-tracking branch 'johnkary/dynamicSwiftMessage'

composer.json

@@ -23,7 +23,8 @@
         "ruflin/elastica": "0.90.*",
         "doctrine/couchdb": "~1.0@dev",
         "aws/aws-sdk-php": "~2.4, >2.4.8",
-        "videlalvaro/php-amqplib": "~2.4"
+        "videlalvaro/php-amqplib": "~2.4",
+        "swiftmailer/swiftmailer": "~5.3"
     },
     "suggest": {
         "graylog2/gelf-php": "Allow sending log messages to a GrayLog2 server",

src/Monolog/Handler/SwiftMailerHandler.php

@@ -32,13 +32,8 @@ class SwiftMailerHandler extends MailHandler
     public function __construct(\Swift_Mailer $mailer, $message, $level = Logger::ERROR, $bubble = true)
     {
         parent::__construct($level, $bubble);
+
         $this->mailer = $mailer;
-        if (!$message instanceof \Swift_Message && is_callable($message)) {
-            $message = call_user_func($message);
-        }
-        if (!$message instanceof \Swift_Message) {
-            throw new \InvalidArgumentException('You must provide either a Swift_Message instance or a callable returning it');
-        }
         $this->message = $message;
     }
 
@@ -47,10 +42,32 @@ class SwiftMailerHandler extends MailHandler
      */
     protected function send($content, array $records)
     {
+        $this->mailer->send($this->buildMessage($content, $records));
+    }
+
+    /**
+     * Creates instance of Swift_Message to be sent
+     *
+     * @param string $content
+     * @param array  $records Log records that formed the content
+     * @return \Swift_Message
+     */
+    protected function buildMessage($content, array $records)
+    {
+        $message = null;
+        if ($this->message instanceof \Swift_Message) {
             $message = clone $this->message;
+        } else if (is_callable($this->message)) {
+            $message = call_user_func($this->message, $content, $records);
+        }
+
+        if (!$message instanceof \Swift_Message) {
+            throw new \InvalidArgumentException('Could not resolve message as instance of Swift_Message or a callable returning it');
+        }
+
         $message->setBody($content);
         $message->setDate(time());
 
-        $this->mailer->send($message);
+        return $message;
     }
 }

tests/Monolog/Handler/SwiftMailerHandlerTest.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Monolog\Handler;
+
+use Monolog\Logger;
+use Monolog\TestCase;
+
+class SwiftMailerHandlerTest extends TestCase
+{
+    /** @var \Swift_Mailer|\PHPUnit_Framework_MockObject_MockObject */
+    private $mailer;
+
+    public function setUp()
+    {
+        $this->mailer = $this
+            ->getMockBuilder('Swift_Mailer')
+            ->disableOriginalConstructor()
+            ->getMock();
+    }
+
+    public function testMessageCreationIsLazyWhenUsingCallback()
+    {
+        $this->mailer->expects($this->never())
+            ->method('send');
+
+        $callback = function () {
+            throw new \RuntimeException('Swift_Message creation callback should not have been called in this test');
+        };
+        $handler = new SwiftMailerHandler($this->mailer, $callback);
+
+        $records = array(
+            $this->getRecord(Logger::DEBUG),
+            $this->getRecord(Logger::INFO),
+        );
+        $handler->handleBatch($records);
+    }
+
+    public function testMessageCanBeCustomizedGivenLoggedData()
+    {
+        // Wire Mailer to expect a specific Swift_Message with a customized Subject
+        $expectedMessage = new \Swift_Message();
+        $this->mailer->expects($this->once())
+            ->method('send')
+            ->with($this->callback(function ($value) use ($expectedMessage) {
+                return $value instanceof \Swift_Message
+                    && $value->getSubject() === 'Emergency'
+                    && $value === $expectedMessage;
+            }));
+
+        // Callback dynamically changes subject based on number of logged records
+        $callback = function ($content, array $records) use ($expectedMessage) {
+            $subject = count($records) > 0 ? 'Emergency' : 'Normal';
+            $expectedMessage->setSubject($subject);
+
+            return $expectedMessage;
+        };
+        $handler = new SwiftMailerHandler($this->mailer, $callback);
+
+        // Logging 1 record makes this an Emergency
+        $records = array(
+            $this->getRecord(Logger::EMERGENCY),
+        );
+        $handler->handleBatch($records);
+    }
+}