diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bug #30756 Changing to MessageDecodingFailedException so that invalid messages are rejected (weaverryan)

Browse Source 
This PR was merged into the 4.3-dev branch.

Discussion
----------

Changing to MessageDecodingFailedException so that invalid messages are rejected

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes
| New feature?  |  no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | #30649
| License       | MIT
| Doc PR        | not needed for bug fix

Bug fix if a message body is completely blank. I'm fixing this on master only, because in 4.2 and earlier, there is actually no system in place to fail serialization and cause the messages to be rejected. In 4.3, we just need to throw this exception.

Cheers!

Commits
-------

4be827d3ca Changing to MessageDecodingFailedException so that invalid messages are rejected
This commit is contained in:
Fabien Potencier 2019-03-31 18:34:24 +02:00
commit 825335374a
4 changed files with 44 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/Symfony/Component/Messenger/Tests/Transport/Serialization/PhpSerializerTest.php
View File

@ -28,6 +28,16 @@ class PhpSerializerTest extends TestCase
$this->assertEquals($envelope, $serializer->decode($serializer->encode($envelope)));
}
public function testDecodingFailsWithMissingBodyKey()
{
$this->expectException(MessageDecodingFailedException::class);
$this->expectExceptionMessage('Encoded envelope should have at least a "body".');
$serializer = new PhpSerializer();
$serializer->decode([]);
}
public function testDecodingFailsWithBadFormat()
{
$this->expectException(MessageDecodingFailedException::class);

31
src/Symfony/Component/Messenger/Tests/Transport/Serialization/SerializerTest.php
View File

@ -108,6 +108,37 @@ class SerializerTest extends TestCase
]);
}
/**
* @dataProvider getMissingKeyTests
*/
public function testDecodingFailsWithMissingKeys(array $data, string $expectedMessage)
{
$this->expectException(MessageDecodingFailedException::class);
$this->expectExceptionMessage($expectedMessage);
$serializer = new Serializer();
$serializer->decode($data);
}
public function getMissingKeyTests()
{
yield 'no_body' => [
['headers' => ['type' => 'bar']],
'Encoded envelope should have at least a "body" and some "headers".',
];
yield 'no_headers' => [
['body' => '{}'],
'Encoded envelope should have at least a "body" and some "headers".',
];
yield 'no_headers_type' => [
['body' => '{}', 'headers' => ['foo' => 'bar']],
'Encoded envelope does not have a "type" header.',
];
}
public function testDecodingFailsWithBadClass()
{
$this->expectException(MessageDecodingFailedException::class);

3
src/Symfony/Component/Messenger/Transport/Serialization/PhpSerializer.php
View File

@ -12,7 +12,6 @@
namespace Symfony\Component\Messenger\Transport\Serialization;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Exception\InvalidArgumentException;
use Symfony\Component\Messenger\Exception\MessageDecodingFailedException;
/**
@ -28,7 +27,7 @@ class PhpSerializer implements SerializerInterface
public function decode(array $encodedEnvelope): Envelope
{
if (empty($encodedEnvelope['body'])) {
throw new InvalidArgumentException('Encoded envelope should have at least a "body".');
throw new MessageDecodingFailedException('Encoded envelope should have at least a "body".');
}
return $this->safelyUnserialize($encodedEnvelope['body']);

5
src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php
View File

@ -12,7 +12,6 @@
namespace Symfony\Component\Messenger\Transport\Serialization;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Exception\InvalidArgumentException;
use Symfony\Component\Messenger\Exception\LogicException;
use Symfony\Component\Messenger\Exception\MessageDecodingFailedException;
use Symfony\Component\Messenger\Stamp\SerializerStamp;
@ -63,11 +62,11 @@ class Serializer implements SerializerInterface
public function decode(array $encodedEnvelope): Envelope
{
if (empty($encodedEnvelope['body']) || empty($encodedEnvelope['headers'])) {
throw new InvalidArgumentException('Encoded envelope should have at least a "body" and some "headers".');
throw new MessageDecodingFailedException('Encoded envelope should have at least a "body" and some "headers".');
}
if (empty($encodedEnvelope['headers']['type'])) {
throw new InvalidArgumentException('Encoded envelope does not have a "type" header.');
throw new MessageDecodingFailedException('Encoded envelope does not have a "type" header.');
}
$stamps = $this->decodeStamps($encodedEnvelope);