Merge pull request #134 from weaverryan/swift_performance

Adding a Swift MessageFactory for performance

Author: Seldaek

DependencyInjection/MonologExtension.php

@@ -390,33 +390,21 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
                     $prototype = new Reference($handler['email_prototype']['id']);
                 }
             } else {
-                $message = new Definition('Swift_Message');
-                $message->setLazy($handler['lazy']);
-                $message->setPublic(false);
-                $message->addMethodCall('setFrom', array($handler['from_email']));
-                $message->addMethodCall('setTo', array($handler['to_email']));
-                $message->addMethodCall('setSubject', array($handler['subject']));
-
-                if (isset($handler['mailer'])) {
-                    $mailer = $handler['mailer'];
-                } else {
-                    $mailer = 'mailer';
-                }
-
-                if (method_exists('Symfony\Component\DependencyInjection\Definition', 'setFactory')) {
-                    $message->setFactory(array(new Reference($mailer), 'createMessage'));
-                } else {
-                    $message->setFactoryService($mailer);
-                    $message->setFactoryMethod('createMessage');
-                }
-
-                if (isset($handler['content_type'])) {
-                    $message->addMethodCall('setContentType', array($handler['content_type']));
-                }
+                $messageFactory = new Definition('Symfony\Bundle\MonologBundle\SwiftMailer\MessageFactory');
+                $messageFactory->setLazy(true);
+                $messageFactory->setPublic(false);
+                $messageFactory->setArguments(array(
+                    new Reference($handler['mailer']),
+                    $handler['from_email'],
+                    $handler['to_email'],
+                    $handler['subject'],
+                    $handler['content_type']
+                ));
 
-                $messageId = sprintf('%s.mail_prototype', $handlerId);
-                $container->setDefinition($messageId, $message);
-                $prototype = new Reference($messageId);
+                $messageFactoryId = sprintf('%s.mail_message_factory', $handlerId);
+                $container->setDefinition($messageFactoryId, $messageFactory);
+                // set the prototype as a callable
+                $prototype = array(new Reference($messageFactoryId), 'createMessage');
             }
             $definition->setArguments(array(
                 new Reference($handler['mailer']),

SwiftMailer/MessageFactory.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MonologBundle\SwiftMailer;
+
+/**
+ * Helps create Swift_Message objects, lazily
+ *
+ * @author Ryan Weaver <[email protected]>
+ */
+class MessageFactory
+{
+    private $mailer;
+
+    private $fromEmail;
+
+    private $toEmail;
+
+    private $subject;
+
+    private $contentType;
+
+    public function __construct(\Swift_Mailer $mailer, $fromEmail, $toEmail, $subject, $contentType = null)
+    {
+        $this->mailer = $mailer;
+        $this->fromEmail = $fromEmail;
+        $this->toEmail = $toEmail;
+        $this->subject = $subject;
+        $this->contentType = $contentType;
+    }
+
+    /**
+     * Creates a Swift_Message template that will be used to send the log message
+     *
+     * @param string $content formatted email body to be sent
+     * @param array  $records Log records that formed the content
+     * @return \Swift_Message
+     */
+    public function createMessage($content, array $records)
+    {
+        /** @var \Swift_Message $message */
+        $message = $this->mailer->createMessage();
+        $message->setTo($this->toEmail);
+        $message->setFrom($this->fromEmail);
+        $message->setSubject($this->subject);
+
+        if ($this->contentType) {
+            $message->setContentType($this->contentType);
+        }
+
+        return $message;
+    }
+}

Tests/DependencyInjection/FixtureMonologExtensionTest.php

@@ -140,22 +140,26 @@ public function testSingleEmailRecipient()
     {
         $container = $this->getContainer('single_email_recipient');
 
-        $this->assertSame(array(
-            array('setFrom', array('[email protected]')),
-            array('setTo', array(array('[email protected]'))),
-            array('setSubject', array('An Error Occurred!')),
-        ), $container->getDefinition('monolog.handler.swift.mail_prototype')->getMethodCalls());
+        $this->assertEquals(array(
+            new Reference('mailer'),
+            '[email protected]', // from
+            array('[email protected]'), // to
+            'An Error Occurred!', // subject
+            null,
+        ), $container->getDefinition('monolog.handler.swift.mail_message_factory')->getArguments());
     }
 
     public function testMultipleEmailRecipients()
     {
         $container = $this->getContainer('multiple_email_recipients');
 
-        $this->assertSame(array(
-            array('setFrom', array('[email protected]')),
-            array('setTo', array(array('[email protected]', '[email protected]'))),
-            array('setSubject', array('An Error Occurred!')),
-        ), $container->getDefinition('monolog.handler.swift.mail_prototype')->getMethodCalls());
+        $this->assertEquals (array(
+            new Reference('mailer'),
+            '[email protected]',
+            array('[email protected]', '[email protected]'),
+            'An Error Occurred!',
+            null
+        ), $container->getDefinition('monolog.handler.swift.mail_message_factory')->getArguments());
     }
 
     public function testChannelParametersResolved()