Merge pull request #3078 from stof/remove_swiftmailer

stof · web-flow · commit 0e2475a51816 · 2024-06-24T20:04:01.000+02:00
Remove the mailer implementation based on Swiftmailer
diff --git a/composer.json b/composer.json
@@ -51,7 +51,6 @@
     "require-dev": {
         "doctrine/doctrine-bundle": "^1.3 || ^2",
         "friendsofphp/php-cs-fixer": "^3.0.2, !=3.5.0",
-        "swiftmailer/swiftmailer": "^4.3 || ^5.0 || ^6.0",
         "symfony/console": "^6.4 || ^7.0",
         "symfony/mailer": "^6.4 || ^7.0",
         "symfony/mime": "^6.4 || ^7.0",
diff --git a/docs/emails.rst b/docs/emails.rst
@@ -38,11 +38,10 @@ a form to enter in a new password.
 Default Mailer Implementations
 ------------------------------
 
-The bundle comes with 3 mailer implementations. They are listed below
+The bundle comes with 2 mailer implementations. They are listed below
 by service id:
 
 - ``fos_user.mailer.twig_symfony`` uses symfony/mailer to send emails and Twig blocks to render the message.
-- ``fos_user.mailer.twig_swift`` uses Swiftmailer to send emails and Twig blocks to render the message.
 - ``fos_user.mailer.noop`` is a mailer implementation which performs no operation, so no emails are sent.
 
 .. note::
@@ -215,7 +214,7 @@ An example is listed below.
 
 To see an example of a working implementation of the ``MailerInterface``
 see the `ZetaMailer`_ class of the `ZetaWebmailBundle`_. This implementation
-uses the Zeta Components Mail to send emails instead of Swiftmailer.
+uses the Zeta Components Mail to send emails instead of the mailer component.
 
 .. _ZetaMailer: https://github.com/simplethings/ZetaWebmailBundle/blob/master/UserBundle/ZetaMailer.php
 .. _ZetaWebmailBundle: https://github.com/simplethings/ZetaWebmailBundle
diff --git a/docs/index.rst b/docs/index.rst
@@ -370,7 +370,7 @@ logging in, creating users, etc.
 .. note::
 
     In order to use the built-in email functionality (confirmation of the account,
-    resetting of the password), you must activate and configure the SwiftmailerBundle.
+    resetting of the password), you must activate and configure the mailer.
 
 Step 7: Update your database schema
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -18,6 +18,6 @@
     </filter>
 
     <php>
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="ignoreFile=tests/ignored-deprecations.txt&amp;max[total]=0" />
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[total]=0" />
     </php>
 </phpunit>
diff --git a/src/DependencyInjection/Compiler/CheckForSwiftMailerPass.php b/src/DependencyInjection/Compiler/CheckForSwiftMailerPass.php
diff --git a/src/DependencyInjection/FOSUserExtension.php b/src/DependencyInjection/FOSUserExtension.php
@@ -212,7 +212,6 @@ private function loadRegistration(array $config, ContainerBuilder $container, Xm
             $fromEmail = $config['confirmation']['from_email'];
             unset($config['confirmation']['from_email']);
         }
-        $container->setParameter('fos_user.registration.confirmation.from_email', [$fromEmail['address'] => $fromEmail['sender_name']]);
         $container->setParameter('fos_user.registration.confirmation.from_address', $fromEmail);
 
         $this->remapParametersNamespaces($config, $container, [
@@ -247,7 +246,6 @@ private function loadResetting(array $config, ContainerBuilder $container, XmlFi
             $fromEmail = $config['email']['from_email'];
             unset($config['email']['from_email']);
         }
-        $container->setParameter('fos_user.resetting.email.from_email', [$fromEmail['address'] => $fromEmail['sender_name']]);
         $container->setParameter('fos_user.resetting.email.from_address', $fromEmail);
 
         $this->remapParametersNamespaces($config, $container, [
diff --git a/src/FOSUserBundle.php b/src/FOSUserBundle.php
@@ -14,7 +14,6 @@
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DoctrineMongoDBMappingsPass;
 use FOS\UserBundle\DependencyInjection\Compiler\CheckForSessionPass;
-use FOS\UserBundle\DependencyInjection\Compiler\CheckForSwiftMailerPass;
 use FOS\UserBundle\DependencyInjection\Compiler\InjectRememberMeServicesPass;
 use FOS\UserBundle\DependencyInjection\Compiler\InjectUserCheckerPass;
 use FOS\UserBundle\DependencyInjection\Compiler\ValidationPass;
@@ -34,7 +33,6 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new InjectUserCheckerPass());
         $container->addCompilerPass(new InjectRememberMeServicesPass());
         $container->addCompilerPass(new CheckForSessionPass());
-        $container->addCompilerPass(new CheckForSwiftMailerPass());
 
         $this->addRegisterMappingsPass($container);
     }
diff --git a/src/Mailer/NoopMailer.php b/src/Mailer/NoopMailer.php
@@ -16,7 +16,7 @@
 /**
  * This mailer does nothing.
  * It is used when the 'email' configuration is not set,
- * and allows to use this bundle without swiftmailer.
+ * and allows to use this bundle without a mailer component.
  *
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  */
diff --git a/src/Mailer/TwigSwiftMailer.php b/src/Mailer/TwigSwiftMailer.php
diff --git a/src/Resources/config/mailer.xml b/src/Resources/config/mailer.xml
@@ -7,12 +7,6 @@
     <parameters>
         <parameter key="fos_user.resetting.email.template">@FOSUser/Resetting/email.txt.twig</parameter>
         <parameter key="fos_user.registration.confirmation.template">@FOSUser/Registration/email.txt.twig</parameter>
-        <parameter key="fos_user.registration.confirmation.from_email" type="collection">
-            <parameter key="no-registration@acme.com">Acme Ltd</parameter>
-        </parameter>
-        <parameter key="fos_user.resetting.email.from_email" type="collection">
-            <parameter key="no-resetting@acme.com">Acme Ltd</parameter>
-        </parameter>
         <parameter key="fos_user.registration.confirmation.from_address" type="collection">
             <parameter key="address">no-registration@acme.com</parameter>
             <parameter key="sender_name">Acme Ltd</parameter>
@@ -24,23 +18,6 @@
     </parameters>
 
     <services>
-        <service id="fos_user.mailer.twig_swift" class="FOS\UserBundle\Mailer\TwigSwiftMailer" public="false">
-            <argument type="service" id="swiftmailer.mailer" />
-            <argument type="service" id="router" />
-            <argument type="service" id="twig" />
-            <argument type="collection">
-                <argument key="template" type="collection">
-                    <argument key="confirmation">%fos_user.registration.confirmation.template%</argument>
-                    <argument key="resetting">%fos_user.resetting.email.template%</argument>
-                </argument>
-                <argument key="from_email" type="collection">
-                    <argument key="confirmation">%fos_user.registration.confirmation.from_email%</argument>
-                    <argument key="resetting">%fos_user.resetting.email.from_email%</argument>
-                </argument>
-            </argument>
-            <tag name="fos_user.requires_swift" />
-        </service>
-
         <service id="fos_user.mailer.twig_symfony" class="FOS\UserBundle\Mailer\TwigSymfonyMailer" public="false">
             <argument type="service" id="mailer" />
             <argument type="service" id="router" />
diff --git a/tests/DependencyInjection/FOSUserExtensionTest.php b/tests/DependencyInjection/FOSUserExtensionTest.php
@@ -100,14 +100,14 @@ public function testDisableRegistration()
         $loader->load([$config], $this->configuration);
         $this->assertNotHasDefinition('fos_user.registration.form.factory');
 
-        $mailer = $this->configuration->getDefinition('fos_user.mailer.twig_swift');
+        $mailer = $this->configuration->getDefinition('fos_user.mailer.twig_symfony');
         $parameters = $this->configuration->getParameterBag()->resolveValue(
             $mailer->getArgument(3)
         );
         $this->assertSame(
             [
-                'confirmation' => ['no-registration@acme.com' => 'Acme Ltd'],
-                'resetting' => ['admin@acme.org' => 'Acme Corp'],
+                'confirmation' => ['address' => 'no-registration@acme.com', 'sender_name' => 'Acme Ltd'],
+                'resetting' => ['address' => 'admin@acme.org', 'sender_name' => 'Acme Corp'],
             ],
             $parameters['from_email']
         );
@@ -122,14 +122,14 @@ public function testDisableResetting()
         $loader->load([$config], $this->configuration);
         $this->assertNotHasDefinition('fos_user.resetting.form.factory');
 
-        $mailer = $this->configuration->getDefinition('fos_user.mailer.twig_swift');
+        $mailer = $this->configuration->getDefinition('fos_user.mailer.twig_symfony');
         $parameters = $this->configuration->getParameterBag()->resolveValue(
             $mailer->getArgument(3)
         );
         $this->assertSame(
             [
-                'confirmation' => ['admin@acme.org' => 'Acme Corp'],
-                'resetting' => ['no-resetting@acme.com' => 'Acme Ltd'],
+                'confirmation' => ['address' => 'admin@acme.org', 'sender_name' => 'Acme Corp'],
+                'resetting' => ['address' => 'no-resetting@acme.com', 'sender_name' => 'Acme Ltd'],
             ],
             $parameters['from_email']
         );
@@ -166,8 +166,8 @@ public function testEmailsDisabledFeature($testConfig, $registration, $resetting
         $config = array_merge($config, $testConfig);
         $loader->load([$config], $this->configuration);
 
-        $this->assertParameter($registration, 'fos_user.registration.confirmation.from_email');
-        $this->assertParameter($resetting, 'fos_user.resetting.email.from_email');
+        $this->assertParameter($registration, 'fos_user.registration.confirmation.from_address');
+        $this->assertParameter($resetting, 'fos_user.resetting.email.from_address');
     }
 
     public function providerEmailsDisabledFeature()
@@ -190,13 +190,13 @@ public function providerEmailsDisabledFeature()
             ],
         ];
 
-        $default = ['admin@acme.org' => 'Acme Corp'];
-        $overriden = ['ltd@acme.com' => 'Acme Ltd'];
+        $default = ['address' => 'admin@acme.org', 'sender_name' => 'Acme Corp'];
+        $overriden = ['address' => 'ltd@acme.com', 'sender_name' => 'Acme Ltd'];
 
         return [
-            [$configBothFeaturesDisabled, ['no-registration@acme.com' => 'Acme Ltd'], ['no-resetting@acme.com' => 'Acme Ltd']],
-            [$configResettingDisabled, $default, ['no-resetting@acme.com' => 'Acme Ltd']],
-            [$configRegistrationDisabled, ['no-registration@acme.com' => 'Acme Ltd'], $default],
+            [$configBothFeaturesDisabled, ['address' => 'no-registration@acme.com', 'sender_name' => 'Acme Ltd'], ['address' => 'no-resetting@acme.com', 'sender_name' => 'Acme Ltd']],
+            [$configResettingDisabled, $default, ['address' => 'no-resetting@acme.com', 'sender_name' => 'Acme Ltd']],
+            [$configRegistrationDisabled, ['address' => 'no-registration@acme.com', 'sender_name' => 'Acme Ltd'], $default],
             [$configOverridenRegistrationEmail, $overriden, $default],
             [$configOverridenResettingEmail, $default, $overriden],
         ];
@@ -289,10 +289,10 @@ public function testUserLoadConfirmationEmailWithDefaults()
         $this->createEmptyConfiguration();
 
         $this->assertParameter(false, 'fos_user.registration.confirmation.enabled');
-        $this->assertParameter(['admin@acme.org' => 'Acme Corp'], 'fos_user.registration.confirmation.from_email');
+        $this->assertParameter(['address' => 'admin@acme.org', 'sender_name' => 'Acme Corp'], 'fos_user.registration.confirmation.from_address');
         $this->assertParameter('@FOSUser/Registration/email.txt.twig', 'fos_user.registration.confirmation.template');
         $this->assertParameter('@FOSUser/Resetting/email.txt.twig', 'fos_user.resetting.email.template');
-        $this->assertParameter(['admin@acme.org' => 'Acme Corp'], 'fos_user.resetting.email.from_email');
+        $this->assertParameter(['address' => 'admin@acme.org', 'sender_name' => 'Acme Corp'], 'fos_user.resetting.email.from_address');
         $this->assertParameter(86400, 'fos_user.resetting.token_ttl');
     }
 
@@ -301,10 +301,10 @@ public function testUserLoadConfirmationEmail()
         $this->createFullConfiguration();
 
         $this->assertParameter(true, 'fos_user.registration.confirmation.enabled');
-        $this->assertParameter(['register@acme.org' => 'Acme Corp'], 'fos_user.registration.confirmation.from_email');
+        $this->assertParameter(['address' => 'register@acme.org', 'sender_name' => 'Acme Corp'], 'fos_user.registration.confirmation.from_address');
         $this->assertParameter('AcmeMyBundle:Registration:mail.txt.twig', 'fos_user.registration.confirmation.template');
         $this->assertParameter('AcmeMyBundle:Resetting:mail.txt.twig', 'fos_user.resetting.email.template');
-        $this->assertParameter(['reset@acme.org' => 'Acme Corp'], 'fos_user.resetting.email.from_email');
+        $this->assertParameter(['address' => 'reset@acme.org', 'sender_name' => 'Acme Corp'], 'fos_user.resetting.email.from_address');
         $this->assertParameter(7200, 'fos_user.resetting.retry_ttl');
     }
 
diff --git a/tests/Mailer/TwigSwiftMailerTest.php b/tests/Mailer/TwigSwiftMailerTest.php
diff --git a/tests/ignored-deprecations.txt b/tests/ignored-deprecations.txt

Original file line number	Diff line number	Diff line change
`@@ -212,7 +212,6 @@ private function loadRegistration(array $config, ContainerBuilder $container, Xm`
`212`	`212`	`$fromEmail = $config['confirmation']['from_email'];`
`213`	`213`	`unset($config['confirmation']['from_email']);`
`214`	`214`	`}`
`215`		`- $container->setParameter('fos_user.registration.confirmation.from_email', [$fromEmail['address'] => $fromEmail['sender_name']]);`
`216`	`215`	`$container->setParameter('fos_user.registration.confirmation.from_address', $fromEmail);`
`217`	`216`
`218`	`217`	`$this->remapParametersNamespaces($config, $container, [`
`@@ -247,7 +246,6 @@ private function loadResetting(array $config, ContainerBuilder $container, XmlFi`
`247`	`246`	`$fromEmail = $config['email']['from_email'];`
`248`	`247`	`unset($config['email']['from_email']);`
`249`	`248`	`}`
`250`		`- $container->setParameter('fos_user.resetting.email.from_email', [$fromEmail['address'] => $fromEmail['sender_name']]);`
`251`	`249`	`$container->setParameter('fos_user.resetting.email.from_address', $fromEmail);`
`252`	`250`
`253`	`251`	`$this->remapParametersNamespaces($config, $container, [`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`/**`
`17`	`17`	`* This mailer does nothing.`
`18`	`18`	`* It is used when the 'email' configuration is not set,`
`19`		`- * and allows to use this bundle without swiftmailer.`
	`19`	`+ * and allows to use this bundle without a mailer component.`
`20`	`20`	`*`
`21`	`21`	`* @author Thibault Duplessis <thibault.duplessis@gmail.com>`
`22`	`22`	`*/`