Merge branch 'sw-26672/fix-mail-log-entry-bug' into '5.7'

SW-26672 - Fix mail log contact reference loading

See merge request shopware/5/product/shopware!801

Author: mitelg

.phpstan-baseline.neon

@@ -7895,16 +7895,6 @@ parameters:
 			count: 1
 			path: engine/Shopware/Bundle/MailBundle/Service/LogEntryBuilder.php
 
-		-
-			message: "#^PHPDoc tag @var for variable \\$collection contains generic class Doctrine\\\\Common\\\\Collections\\\\ArrayCollection but does not specify its types\\: TKey, T$#"
-			count: 1
-			path: engine/Shopware/Bundle/MailBundle/Service/LogEntryBuilder.php
-
-		-
-			message: "#^Parameter \\#1 \\$subject of method Shopware\\\\Models\\\\Mail\\\\Log\\:\\:setSubject\\(\\) expects string\\|null, string\\|false given\\.$#"
-			count: 1
-			path: engine/Shopware/Bundle/MailBundle/Service/LogEntryBuilder.php
-
 		-
 			message: "#^Parameter \\#1 \\$body of method Zend_Mail\\:\\:createAttachment\\(\\) expects string, string\\|false given\\.$#"
 			count: 2

engine/Shopware/Bundle/MailBundle/Service/LogEntryBuilder.php

@@ -1,4 +1,6 @@
 <?php
+
+declare(strict_types=1);
 /**
  * Shopware 5
  * Copyright (c) shopware AG
@@ -48,20 +50,11 @@ class LogEntryBuilder implements LogEntryBuilderInterface
     public const SHOP_ASSOCIATION = 'shop';
     public const SHOP_ID_ASSOCIATION = 'shopId';
 
-    /**
-     * @var EntityManagerInterface
-     */
-    private $entityManager;
+    private EntityManagerInterface $entityManager;
 
-    /**
-     * @var MailRepository
-     */
-    private $mailRepository;
+    private MailRepository $mailRepository;
 
-    /**
-     * @var OrderRepository
-     */
-    private $orderRepository;
+    private OrderRepository $orderRepository;
 
     public function __construct(EntityManagerInterface $entityManager)
     {
@@ -77,9 +70,9 @@ public function build(Enlight_Components_Mail $mail): Log
     {
         $logEntry = new Log();
 
-        $logEntry->setSubject(iconv_mime_decode($mail->getSubject()));
+        $logEntry->setSubject((string) iconv_mime_decode($mail->getSubject()));
         $logEntry->setSender($mail->getFrom());
-        $logEntry->setSentAt(new DateTime($mail->getDate()));
+        $logEntry->setSentAt(new DateTime((string) $mail->getDate()));
         $logEntry->setContentText($mail->getPlainBodyText());
 
         if ($mail->getBodyHtml() instanceof Zend_Mime_Part) {
@@ -111,7 +104,6 @@ protected function assignType(Log $logEntry, ?string $templateName): void
 
     protected function assignOrder(Log $logEntry, Enlight_Components_Mail $mail): void
     {
-        /** @var Order|null $order */
         $order = $this->resolveOrderByAssociation($mail);
 
         if ($order !== null) {
@@ -120,7 +112,6 @@ protected function assignOrder(Log $logEntry, Enlight_Components_Mail $mail): vo
             return;
         }
 
-        /** @var Order|null $order */
         $order = $this->resolveOrderByType($logEntry->getType());
 
         if ($order !== null) {
@@ -137,7 +128,6 @@ protected function assignShop(Log $logEntry, Enlight_Components_Mail $mail): voi
         }
 
         if ($mail->getAssociation(self::SHOP_ID_ASSOCIATION) !== null) {
-            /** @var Shop $shop */
             $shop = $this->entityManager->getPartialReference(
                 Shop::class,
                 $mail->getAssociation(self::SHOP_ID_ASSOCIATION)
@@ -227,10 +217,13 @@ protected function assignRecipients(Log $logEntry, array $recipients = []): void
         foreach ($knownRecipients as $recipient) {
             unset($unknownRecipients[$recipient['mail_address']]);
 
-            $associatedContacts[] = $this->entityManager->getPartialReference(
+            $contact = $this->entityManager->getReference(
                 Contact::class,
                 $recipient['id']
             );
+            if ($contact instanceof Contact) {
+                $associatedContacts[] = $contact;
+            }
         }
 
         foreach (array_keys($unknownRecipients) as $recipient) {
@@ -239,13 +232,15 @@ protected function assignRecipients(Log $logEntry, array $recipients = []): void
 
             $this->persistContact($contact);
 
-            $associatedContacts[] = $this->entityManager->getPartialReference(
+            $fetchedContact = $this->entityManager->getReference(
                 Contact::class,
                 $contact->getId()
             );
+            if ($fetchedContact instanceof Contact) {
+                $associatedContacts[] = $fetchedContact;
+            }
         }
 
-        /** @var ArrayCollection<Contact> $collection */
         $collection = new ArrayCollection($associatedContacts);
         $logEntry->setRecipients($collection);
     }
@@ -275,8 +270,7 @@ protected function assignDocuments(Log $logEntry, Enlight_Components_Mail $mail)
             return;
         }
 
-        $orderRepository = $this->entityManager->getRepository(Order::class);
-        $documents = $orderRepository->getDocuments([$logEntry->getOrder()->getId()]);
+        $documents = $this->entityManager->getRepository(Order::class)->getDocuments([$logEntry->getOrder()->getId()]);
         $filenameIdMap = [];
 
         foreach ($documents as $document) {
@@ -287,15 +281,15 @@ protected function assignDocuments(Log $logEntry, Enlight_Components_Mail $mail)
             }
         }
 
-        /** @var Zend_Mime_Part $part */
         foreach ($mail->getParts() as $part) {
             if (isset($filenameIdMap[$part->filename])) {
-                /** @var Document $document */
                 $document = $this->entityManager->getPartialReference(
                     Document::class,
                     $filenameIdMap[$part->filename]
                 );
-                $logEntry->addDocument($document);
+                if ($document instanceof Document) {
+                    $logEntry->addDocument($document);
+                }
             }
         }
     }

tests/Functional/Bundle/MailBundle/LogEntryBuilderTest.php

@@ -40,26 +40,45 @@ class LogEntryBuilderTest extends TestCase
     use DatabaseTransactionBehaviour;
     use MailBundleTestTrait;
 
+    private const TEST_MAIL = '[email protected]';
+
     private LogEntryBuilderInterface $builder;
 
+    private ModelManager $modelManager;
+
     protected function setUp(): void
     {
         parent::setUp();
 
-        $entityManager = $this->getContainer()->get(ModelManager::class);
-        $this->builder = new LogEntryBuilder($entityManager);
+        $this->modelManager = $this->getContainer()->get(ModelManager::class);
+        $this->builder = new LogEntryBuilder($this->modelManager);
     }
 
     public function testBuildWithSimpleMail(): void
     {
         $mail = $this->createSimpleMail();
-        $entry = $this->builder->build($mail);
+        $log = $this->builder->build($mail);
+
+        static::assertSame($mail->getSubject(), $log->getSubject());
+        static::assertSame($mail->getFrom(), $log->getSender());
+        static::assertInstanceOf(Contact::class, $log->getRecipients()->first());
+        static::assertSame($mail->getPlainBodyText(), $log->getContentText());
+    }
 
-        static::assertNotNull($entry);
+    public function testBuildWithDetachedRecipient(): void
+    {
+        $contact = new Contact();
+        $contact->setMailAddress(self::TEST_MAIL);
+        $this->modelManager->persist($contact);
+        $this->modelManager->flush($contact);
+        $this->modelManager->detach($contact);
+
+        $mail = $this->createSimpleMail();
+        $mail->clearRecipients();
+        $mail->addTo(self::TEST_MAIL);
 
-        static::assertSame($mail->getSubject(), $entry->getSubject());
-        static::assertSame($mail->getFrom(), $entry->getSender());
-        static::assertInstanceOf(Contact::class, $entry->getRecipients()->first());
-        static::assertSame($mail->getPlainBodyText(), $entry->getContentText());
+        $recipient = $this->builder->build($mail)->getRecipients()->first();
+        static::assertInstanceOf(Contact::class, $recipient);
+        static::assertSame(self::TEST_MAIL, $recipient->getMailAddress());
     }
 }