feat: add debug info to subject (#69)

* feat: add debug info to subject

feat: add debug info to subject

* fix: fix tests

Author: MelvinAchterhuis

src/Resources/config/config.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/shopware/platform/master/src/Core/System/SystemConfig/Schema/config.xsd">
+    <card>
+        <title>Debug mode</title>
+        <title lang="de-DE">Debug-Modus</title>
+
+        <input-field type="bool">
+            <name>debugMode</name>
+            <label>Enable debug mode</label>
+            <label lang="de-DE">Debug-Modus aktivieren</label>
+            <helpText>Adds the technical name of the mail-template to the subject to easily identify which mail has been send</helpText>
+            <helpText lang="de-DE">Fügt den technischen Namen der Mail-Vorlage zum Betreff hinzu, um leicht zu erkennen, welche Mail gesendet wurde</helpText>
+        </input-field>
+    </card>
+</config>

src/Subscriber/FlowSubscriber.php

@@ -19,6 +19,9 @@
 use Shopware\Core\Framework\Validation\DataBag\DataBag;
 use Shopware\Core\System\Language\LanguageCollection;
 use Shopware\Core\System\Language\LanguageEntity;
+use Shopware\Core\System\SalesChannel\SalesChannelCollection;
+use Shopware\Core\System\SalesChannel\SalesChannelEntity;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\ParameterBag;
@@ -28,13 +31,16 @@ class FlowSubscriber implements EventSubscriberInterface
     /**
      * @param EntityRepository<MailTemplateTypeCollection> $mailTemplateTypeRepository
      * @param EntityRepository<LanguageCollection> $languageRepository
+     * @param EntityRepository<SalesChannelCollection> $salesChannelRepository
      */
     public function __construct(
         private readonly EntityRepository $mailTemplateTypeRepository,
         private readonly MailFinderServiceInterface $mailFinderService,
         #[Autowire(service: Translator::class)]
         private readonly AbstractTranslator $translator,
         private readonly EntityRepository $languageRepository,
+        private readonly SystemConfigService $systemConfigService,
+        private readonly EntityRepository $salesChannelRepository,
     ) {}
 
     public static function getSubscribedEvents(): array
@@ -77,6 +83,17 @@ private function sendMail(DataBag $dataBag, string $mailTemplateTypeId, Context
         }
 
         if ($subject) {
+            $salesChannelId = $dataBag->getString('salesChannelId');
+            $debugMode = $this->systemConfigService->getBool('FroshPlatformTemplateMail.config.debugMode', $salesChannelId);
+            if ($debugMode) {
+                $subject = sprintf(
+                    'DEBUG: %s (%s - %s - %s)',
+                    $subject,
+                    $this->getSalesChannelName($salesChannelId, $context),
+                    $this->getLocaleCode($context->getLanguageId(), $context),
+                    $technicalName,
+                );
+            }
             $dataBag->set('subject', $subject);
         }
     }
@@ -93,13 +110,11 @@ private function createTemplateMailContext(ParameterBag $dataBag, Context $conte
 
     private function fixTranslator(TemplateMailContext $businessEvent): void
     {
-        $criteria = new Criteria([$businessEvent->getContext()->getLanguageId()]);
-        $criteria->addAssociation('locale');
-
-        /** @var LanguageEntity $language */
-        $language = $this->languageRepository->search($criteria, $businessEvent->getContext())->first();
+        $localCode = $this->getLocaleCode(
+            $businessEvent->getContext()->getLanguageId(),
+            $businessEvent->getContext(),
+        );
 
-        $localCode = $language->getLocale()?->getCode();
         if ($localCode === null) {
             return;
         }
@@ -111,4 +126,25 @@ private function fixTranslator(TemplateMailContext $businessEvent): void
             $businessEvent->getContext(),
         );
     }
+
+    private function getLocaleCode(string $languageId, Context $context): ?string
+    {
+        $criteria = new Criteria([$languageId]);
+        $criteria->addAssociation('locale');
+
+        /** @var LanguageEntity $language */
+        $language = $this->languageRepository->search($criteria, $context)->first();
+
+        return $language->getLocale()?->getCode();
+    }
+
+    private function getSalesChannelName(string $salesChannelId, Context $context): ?string
+    {
+        $criteria = new Criteria([$salesChannelId]);
+
+        /** @var SalesChannelEntity $salesChannel */
+        $salesChannel = $this->salesChannelRepository->search($criteria, $context)->first();
+
+        return $salesChannel->getName();
+    }
 }

tests/Subscriber/FlowSubscriberTest.php

@@ -14,6 +14,7 @@
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\Validation\DataBag\DataBag;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 
 class FlowSubscriberTest extends TestCase
 {
@@ -34,6 +35,8 @@ public function testEmptyMailDoesNothing(): void
             $this->createMock(MailFinderServiceInterface::class),
             $this->createMock(AbstractTranslator::class),
             $this->createMock(EntityRepository::class),
+            $this->createMock(SystemConfigService::class),
+            $this->createMock(EntityRepository::class),
         );
 
         $subscriber->onFlowSendMailActionEvent(new FlowSendMailActionEvent(new DataBag([]), new MailTemplateEntity(), new StorableFlow('test', Context::createDefaultContext())));