Fix the notification email theme for asynchronously dispatched emails

krisbuist · krisbuist · commit 4b843d1eeae5 · 2022-11-03T10:41:56.000+01:00
When the `\Symfony\Component\Mailer\Messenger\SendEmailMessage` is dispatched asynchronously, the email message is serialised and unserialised. The theme that was set on the `NotificationEmail` was not included in the serialisation, causing the
value to return back to the default after deserialisation.
diff --git a/src/Symfony/Bridge/Twig/Mime/NotificationEmail.php b/src/Symfony/Bridge/Twig/Mime/NotificationEmail.php
@@ -210,15 +210,20 @@ private function getExceptionAsString($exception): string
      */
     public function __serialize(): array
     {
-        return [$this->context, parent::__serialize()];
+        return [$this->context, $this->theme, parent::__serialize()];
     }
 
     /**
      * @internal
      */
     public function __unserialize(array $data): void
     {
-        [$this->context, $parentData] = $data;
+        if (3 === \count($data)) {
+            [$this->context, $this->theme, $parentData] = $data;
+        } else {
+            // Backwards compatibility for deserializing data structures that were serialized without the theme
+            [$this->context, $parentData] = $data;
+        }
 
         parent::__unserialize($parentData);
     }
diff --git a/src/Symfony/Bridge/Twig/Tests/Mime/NotificationEmailTest.php b/src/Symfony/Bridge/Twig/Tests/Mime/NotificationEmailTest.php
@@ -46,6 +46,7 @@ public function testSerialize()
             ->importance(NotificationEmail::IMPORTANCE_HIGH)
             ->action('Bar', 'http://example.com/')
             ->context(['a' => 'b'])
+            ->theme('example')
         ));
         $this->assertEquals([
             'importance' => NotificationEmail::IMPORTANCE_HIGH,
@@ -57,6 +58,8 @@ public function testSerialize()
             'raw' => true,
             'a' => 'b',
         ], $email->getContext());
+
+        $this->assertSame('@email/example/notification/body.html.twig', $email->getHtmlTemplate());
     }
 
     public function testTheme()

Original file line number	Diff line number	Diff line change
`@@ -210,15 +210,20 @@ private function getExceptionAsString($exception): string`
`210`	`210`	`*/`
`211`	`211`	`public function __serialize(): array`
`212`	`212`	`{`
`213`		`- return [$this->context, parent::__serialize()];`
	`213`	`+ return [$this->context, $this->theme, parent::__serialize()];`
`214`	`214`	`}`
`215`	`215`
`216`	`216`	`/**`
`217`	`217`	`* @internal`
`218`	`218`	`*/`
`219`	`219`	`public function __unserialize(array $data): void`
`220`	`220`	`{`
`221`		`- [$this->context, $parentData] = $data;`
	`221`	`+ if (3 === \count($data)) {`
	`222`	`+ [$this->context, $this->theme, $parentData] = $data;`
	`223`	`+ } else {`
	`224`	`+ // Backwards compatibility for deserializing data structures that were serialized without the theme`
	`225`	`+ [$this->context, $parentData] = $data;`
	`226`	`+ }`
`222`	`227`
`223`	`228`	`parent::__unserialize($parentData);`
`224`	`229`	`}`