From 6ad46eeb1a302cf8ac71225f668caa11fd2c0472 Mon Sep 17 00:00:00 2001
From: Grzegorz Sadowski <sadowskigp@gmail.com>
Date: Fri, 2 Feb 2024 12:09:40 +0100
Subject: [PATCH] [Shop] Introduce BC solution for deprecated and overwritten
 email managers

---
 .../ReplaceEmailManagersPass.php              | 75 +++++++++++++++++++
 .../Resources/config/services/controller.xml  |  2 +-
 .../Resources/config/services/email.xml       | 14 +++-
 .../Resources/config/services/listeners.xml   |  2 +-
 .../ReplaceEmailManagersPassTest.php          | 62 +++++++++++++++
 5 files changed, 151 insertions(+), 4 deletions(-)
 create mode 100644 src/Sylius/Bundle/ShopBundle/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPass.php
 create mode 100644 src/Sylius/Bundle/ShopBundle/Tests/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPassTest.php

diff --git a/src/Sylius/Bundle/ShopBundle/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPass.php b/src/Sylius/Bundle/ShopBundle/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPass.php
new file mode 100644
index 000000000000..64f2f51ee70e
--- /dev/null
+++ b/src/Sylius/Bundle/ShopBundle/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPass.php
@@ -0,0 +1,75 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ShopBundle\DependencyInjection\Compiler\BackwardsCompatibility;
+
+use Sylius\Bundle\ShopBundle\Controller\ContactController;
+use Sylius\Bundle\ShopBundle\EventListener\OrderCompleteListener;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+use Symfony\Component\DependencyInjection\Reference;
+
+/** @internal */
+final class ReplaceEmailManagersPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        foreach ($container->getDefinitions() as $definition) {
+            if ($definition->getDecoratedService() === null) {
+                continue;
+            }
+
+            $decoratedServiceClass = $definition->getDecoratedService()[0];
+
+            if ($decoratedServiceClass === 'sylius.email_manager.contact') {
+                $this->replaceArgument(
+                    $container,
+                    'sylius.controller.shop.contact',
+                    ContactController::class,
+                    6,
+                    'sylius.email_manager.contact',
+                );
+
+                continue;
+            }
+
+            if ($decoratedServiceClass === 'sylius.email_manager.order') {
+                $this->replaceArgument(
+                    $container,
+                    'sylius.listener.order_complete',
+                    OrderCompleteListener::class,
+                    0,
+                    'sylius.email_manager.order',
+                );
+            }
+        }
+    }
+
+    public function replaceArgument(
+        ContainerBuilder $container,
+        string $serviceId,
+        string $serviceClass,
+        int $argumentIndex,
+        string $argumentId,
+    ): void {
+        try {
+            $listenerDefinition = $container->findDefinition($serviceId);
+            if ($listenerDefinition->getClass() === $serviceClass) {
+                $listenerDefinition->setArgument($argumentIndex, new Reference($argumentId));
+            }
+        } catch (ServiceNotFoundException) {
+            return;
+        }
+    }
+}
diff --git a/src/Sylius/Bundle/ShopBundle/Resources/config/services/controller.xml b/src/Sylius/Bundle/ShopBundle/Resources/config/services/controller.xml
index c369fc1494f3..b3ec867ac195 100644
--- a/src/Sylius/Bundle/ShopBundle/Resources/config/services/controller.xml
+++ b/src/Sylius/Bundle/ShopBundle/Resources/config/services/controller.xml
@@ -22,7 +22,7 @@
             <argument type="service" id="sylius.context.channel" />
             <argument type="service" id="sylius.context.customer" />
             <argument type="service" id="sylius.context.locale" />
-            <argument type="service" id="Sylius\Bundle\CoreBundle\Mailer\ContactEmailManagerInterface" />
+            <argument type="service" id="sylius.mailer.contact_email_manager.shop" />
         </service>
 
         <service id="sylius.controller.shop.homepage" class="Sylius\Bundle\ShopBundle\Controller\HomepageController">
diff --git a/src/Sylius/Bundle/ShopBundle/Resources/config/services/email.xml b/src/Sylius/Bundle/ShopBundle/Resources/config/services/email.xml
index ab0a35a63e7d..6512b0fff6fe 100644
--- a/src/Sylius/Bundle/ShopBundle/Resources/config/services/email.xml
+++ b/src/Sylius/Bundle/ShopBundle/Resources/config/services/email.xml
@@ -17,17 +17,27 @@
 
         <service id="sylius.email_manager.contact" class="Sylius\Bundle\ShopBundle\EmailManager\ContactEmailManager">
             <argument type="service" id="sylius.email_sender" />
+            <deprecated package="sylius/shop-bundle" version="1.13">The "%service_id%" service is deprecated since 1.13 and will be removed in 2.0. Use "sylius.mailer.contact_email_manager.shop" instead.</deprecated>
         </service>
         <service id="Sylius\Bundle\ShopBundle\EmailManager\ContactEmailManagerInterface" alias="sylius.email_manager.contact">
-            <deprecated package="sylius/shop-bundle" version="1.13">The "%alias_id%" service is deprecated since 1.13 and will be removed in 2.0. Use "Sylius\Bundle\CoreBundle\Mailer\ContactEmailManagerInterface" instead.</deprecated>
+            <deprecated package="sylius/shop-bundle" version="1.13">The "%alias_id%" service is deprecated since 1.13 and will be removed in 2.0. Use "sylius.mailer.contact_email_manager.shop" instead.</deprecated>
         </service>
 
         <service id="sylius.email_manager.order" class="Sylius\Bundle\ShopBundle\EmailManager\OrderEmailManager">
             <argument type="service" id="sylius.email_sender" />
             <argument type="service" id="sylius.mailer.order_email_manager" />
+            <deprecated package="sylius/shop-bundle" version="1.13">The "%service_id%" service is deprecated since 1.13 and will be removed in 2.0. Use "sylius.mailer.order_email_manager.shop" instead.</deprecated>
         </service>
         <service id="Sylius\Bundle\ShopBundle\EmailManager\OrderEmailManagerInterface" alias="sylius.email_manager.order">
-            <deprecated package="sylius/shop-bundle" version="1.13">The "%alias_id%" service is deprecated since 1.13 and will be removed in 2.0. Use "Sylius\Bundle\CoreBundle\Mailer\OrderEmailManagerInterface" instead.</deprecated>
+            <deprecated package="sylius/shop-bundle" version="1.13">The "%alias_id%" service is deprecated since 1.13 and will be removed in 2.0. Use "sylius.mailer.order_email_manager.shop" instead.</deprecated>
+        </service>
+
+        <service id="sylius.mailer.contact_email_manager.shop" class="Sylius\Bundle\CoreBundle\Mailer\ContactEmailManager">
+            <argument type="service" id="sylius.email_sender" />
+        </service>
+
+        <service id="sylius.mailer.order_email_manager.shop" class="Sylius\Bundle\CoreBundle\Mailer\OrderEmailManager">
+            <argument type="service" id="sylius.email_sender" />
         </service>
     </services>
 </container>
diff --git a/src/Sylius/Bundle/ShopBundle/Resources/config/services/listeners.xml b/src/Sylius/Bundle/ShopBundle/Resources/config/services/listeners.xml
index 8cef42e9d66c..1c40c457deb1 100644
--- a/src/Sylius/Bundle/ShopBundle/Resources/config/services/listeners.xml
+++ b/src/Sylius/Bundle/ShopBundle/Resources/config/services/listeners.xml
@@ -45,7 +45,7 @@
         </service>
 
         <service id="sylius.listener.order_complete" class="Sylius\Bundle\ShopBundle\EventListener\OrderCompleteListener">
-            <argument type="service" id="Sylius\Bundle\CoreBundle\Mailer\OrderEmailManagerInterface" />
+            <argument type="service" id="sylius.mailer.order_email_manager.shop" />
             <tag name="kernel.event_listener" event="sylius.order.post_complete" method="sendConfirmationEmail" />
         </service>
 
diff --git a/src/Sylius/Bundle/ShopBundle/Tests/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPassTest.php b/src/Sylius/Bundle/ShopBundle/Tests/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPassTest.php
new file mode 100644
index 000000000000..4497df13178e
--- /dev/null
+++ b/src/Sylius/Bundle/ShopBundle/Tests/DependencyInjection/Compiler/BackwardsCompatibility/ReplaceEmailManagersPassTest.php
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ShopBundle\Tests\DependencyInjection\Compiler\BackwardsCompatibility;
+
+use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractCompilerPassTestCase;
+use Sylius\Bundle\ShopBundle\DependencyInjection\Compiler\BackwardsCompatibility\ReplaceEmailManagersPass;
+use Sylius\Bundle\ShopBundle\EventListener\OrderCompleteListener;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+final class ReplaceEmailManagersPassTest extends AbstractCompilerPassTestCase
+{
+    /** @test */
+    public function it_replaces_decorated_order_email_manager_service_of_order_complete_listener_arguments(): void
+    {
+        $this->setDefinition('sylius.email_manager.order', new Definition());
+        $this->setDefinition('sylius.email_manager.order.decorated', (new Definition())->setDecoratedService('sylius.email_manager.order'));
+        $this->setDefinition('sylius.mailer.order_email_manager.shop', new Definition());
+        $this->setDefinition('sylius.listener.order_complete', new Definition(OrderCompleteListener::class, [new Reference('sylius.mailer.order_email_manager.shop')]));
+
+        $this->compile();
+
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument(
+            'sylius.listener.order_complete',
+            0,
+            'sylius.email_manager.order',
+        );
+    }
+
+    /** @test */
+    public function it_does_nothing_if_shipment_email_manager_service_is_not_decorated(): void
+    {
+        $this->setDefinition('sylius.email_manager.order', new Definition());
+        $this->setDefinition('sylius.mailer.order_email_manager.shop', new Definition());
+        $this->setDefinition('sylius.listener.order_complete', new Definition(OrderCompleteListener::class, [new Reference('sylius.mailer.order_email_manager.shop')]));
+
+        $this->compile();
+
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument(
+            'sylius.listener.order_complete',
+            0,
+            'sylius.mailer.order_email_manager.shop',
+        );
+    }
+
+    protected function registerCompilerPass(ContainerBuilder $container): void
+    {
+        $container->addCompilerPass(new ReplaceEmailManagersPass());
+    }
+}