[Messenger] PhpSerializer: TypeError should throw MessageDecodingFailedException

B-Galati · B-Galati · commit d896fbf0c8db · 2024-01-30T11:48:48.000+01:00
Actually, the fix should handle more cases than only TypeError.
diff --git a/src/Symfony/Component/Messenger/Tests/Fixtures/DummyMessageTyped.php b/src/Symfony/Component/Messenger/Tests/Fixtures/DummyMessageTyped.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Symfony\Component\Messenger\Tests\Fixtures;
+
+class DummyMessageTyped implements DummyMessageInterface
+{
+    private string $message;
+
+    public function __construct(string $message)
+    {
+        $this->message = $message;
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerTest.php
@@ -16,11 +16,12 @@
 use Symfony\Component\Messenger\Exception\MessageDecodingFailedException;
 use Symfony\Component\Messenger\Stamp\NonSendableStampInterface;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
+use Symfony\Component\Messenger\Tests\Fixtures\DummyMessageTyped;
 use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
 
 class PhpSerializerTest extends TestCase
 {
-    public function testEncodedIsDecodable()
+    public function testEncodedIsDecodable(): void
     {
         $serializer = new PhpSerializer();
 
@@ -31,53 +32,53 @@ public function testEncodedIsDecodable()
         $this->assertEquals($envelope, $serializer->decode($encoded));
     }
 
-    public function testDecodingFailsWithMissingBodyKey()
+    public function testDecodingFailsWithMissingBodyKey(): void
     {
+        $serializer = new PhpSerializer();
+
         $this->expectException(MessageDecodingFailedException::class);
         $this->expectExceptionMessage('Encoded envelope should have at least a "body", or maybe you should implement your own serializer');
 
-        $serializer = new PhpSerializer();
-
         $serializer->decode([]);
     }
 
-    public function testDecodingFailsWithBadFormat()
+    public function testDecodingFailsWithBadFormat(): void
     {
+        $serializer = new PhpSerializer();
+
         $this->expectException(MessageDecodingFailedException::class);
         $this->expectExceptionMessageMatches('/Could not decode/');
 
-        $serializer = new PhpSerializer();
-
         $serializer->decode([
             'body' => '{"message": "bar"}',
         ]);
     }
 
-    public function testDecodingFailsWithBadBase64Body()
+    public function testDecodingFailsWithBadBase64Body(): void
     {
+        $serializer = new PhpSerializer();
+
         $this->expectException(MessageDecodingFailedException::class);
         $this->expectExceptionMessageMatches('/Could not decode/');
 
-        $serializer = new PhpSerializer();
-
         $serializer->decode([
             'body' => 'x',
         ]);
     }
 
-    public function testDecodingFailsWithBadClass()
+    public function testDecodingFailsWithBadClass(): void
     {
+        $serializer = new PhpSerializer();
+
         $this->expectException(MessageDecodingFailedException::class);
         $this->expectExceptionMessageMatches('/class "ReceivedSt0mp" not found/');
 
-        $serializer = new PhpSerializer();
-
         $serializer->decode([
             'body' => 'O:13:"ReceivedSt0mp":0:{}',
         ]);
     }
 
-    public function testEncodedSkipsNonEncodeableStamps()
+    public function testEncodedSkipsNonEncodeableStamps(): void
     {
         $serializer = new PhpSerializer();
 
@@ -89,7 +90,7 @@ public function testEncodedSkipsNonEncodeableStamps()
         $this->assertStringNotContainsString('DummyPhpSerializerNonSendableStamp', $encoded['body']);
     }
 
-    public function testNonUtf8IsBase64Encoded()
+    public function testNonUtf8IsBase64Encoded(): void
     {
         $serializer = new PhpSerializer();
 
@@ -99,6 +100,22 @@ public function testNonUtf8IsBase64Encoded()
         $this->assertTrue((bool) preg_match('//u', $encoded['body']), 'Encodes non-UTF8 payloads');
         $this->assertEquals($envelope, $serializer->decode($encoded));
     }
+
+    /**
+     * @requires PHP >= 7.4
+     */
+    public function testDecodingFailsForPropertyTypeMismatch(): void
+    {
+        $serializer = new PhpSerializer();
+        $encodedEnvelope = $serializer->encode(new Envelope(new DummyMessageTyped('true')));
+        // Simulate a change of property type in the code base
+        $encodedEnvelope['body'] = str_replace('s:4:\"true\"', 'b:1', $encodedEnvelope['body']);
+
+        $this->expectException(MessageDecodingFailedException::class);
+        $this->expectExceptionMessageMatches('/Could not unserialize/');
+
+        $serializer->decode($encodedEnvelope);
+    }
 }
 
 class DummyPhpSerializerNonSendableStamp implements NonSendableStampInterface
diff --git a/src/Symfony/Component/Messenger/Transport/Serialization/PhpSerializer.php b/src/Symfony/Component/Messenger/Transport/Serialization/PhpSerializer.php
@@ -73,13 +73,20 @@ private function safelyUnserialize(string $contents)
         });
 
         try {
-            $meta = unserialize($contents);
+            /** @var Envelope */
+            $envelope = unserialize($contents);
+        } catch (\Throwable $e) {
+            if ($e instanceof MessageDecodingFailedException) {
+                throw $e;
+            }
+
+            throw new MessageDecodingFailedException('Could not unserialize Envelope: '.$e->getMessage(), 0, $e);
         } finally {
             restore_error_handler();
             ini_set('unserialize_callback_func', $prevUnserializeHandler);
         }
 
-        return $meta;
+        return $envelope;
     }
 
     /**
