[Messenger] PhpSerializer: TypeError should throw MessageDecodingFailedException

B-Galati · B-Galati · commit 3f55e5e6b62f · 2023-12-22T10:26:32.000+01:00
Actually, the fix should handle more cases than only TypeError.
diff --git a/src/Symfony/Component/Messenger/Tests/Fixtures/DummyMessage.php b/src/Symfony/Component/Messenger/Tests/Fixtures/DummyMessage.php
@@ -4,7 +4,7 @@
 
 class DummyMessage implements DummyMessageInterface
 {
-    private $message;
+    private string $message;
 
     public function __construct(string $message)
     {
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\MessageDecodingFailedException;
+use Symfony\Component\Messenger\Stamp\MessageDecodingFailedStamp;
 use Symfony\Component\Messenger\Stamp\NonSendableStampInterface;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
@@ -100,6 +101,19 @@ public function testNonUtf8IsBase64Encoded()
         $this->assertEquals($envelope, $serializer->decode($encoded));
     }
 
+    public function testDecodingFailsForPropertyTypeMismatch()
+    {
+        $this->expectException(MessageDecodingFailedException::class);
+        $this->expectExceptionMessageMatches('/Could not decode/');
+
+        $serializer = $this->createPhpSerializer();
+        $encodedEnvelope = $serializer->encode(new Envelope(new DummyMessage('true')));
+        // Simulate a change of property type in the code base
+        $encodedEnvelope['body'] = str_replace('s:4:\"true\"', 'b:1', $encodedEnvelope['body']);
+
+        $serializer->decode($encodedEnvelope);
+    }
+
     protected function createPhpSerializer(): PhpSerializer
     {
         return new PhpSerializer();
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerWithClassNotFoundSupportTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerWithClassNotFoundSupportTest.php
@@ -22,6 +22,7 @@ class PhpSerializerWithClassNotFoundSupportTest extends PhpSerializerTest
     public function testDecodingFailsWithBadClass()
     {
         $this->expectException(MessageDecodingFailedException::class);
+        $this->expectExceptionMessageMatches('/Could not decode/');
 
         $serializer = $this->createPhpSerializer();
 
diff --git a/src/Symfony/Component/Messenger/Transport/Serialization/PhpSerializer.php b/src/Symfony/Component/Messenger/Transport/Serialization/PhpSerializer.php
@@ -93,6 +93,12 @@ private function safelyUnserialize(string $contents): Envelope
         try {
             /** @var Envelope */
             $envelope = unserialize($contents);
+        } catch (\Throwable $e) {
+            if ($e instanceof MessageDecodingFailedException) {
+                throw $e;
+            }
+
+            throw new MessageDecodingFailedException(sprintf('Could not decode message using PHP serialization: %s.', $contents), previous: $e);
         } finally {
             restore_error_handler();
             ini_set('unserialize_callback_func', $prevUnserializeHandler);

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`class DummyMessage implements DummyMessageInterface`
`6`	`6`	`{`
`7`		`- private $message;`
	`7`	`+ private string $message;`
`8`	`8`
`9`	`9`	`public function __construct(string $message)`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ class PhpSerializerWithClassNotFoundSupportTest extends PhpSerializerTest`
`22`	`22`	`public function testDecodingFailsWithBadClass()`
`23`	`23`	`{`
`24`	`24`	`$this->expectException(MessageDecodingFailedException::class);`
	`25`	`+ $this->expectExceptionMessageMatches('/Could not decode/');`
`25`	`26`
`26`	`27`	`$serializer = $this->createPhpSerializer();`
`27`	`28`