Skip to content

[Debug][BC Break] Fixed deserialization of FlattenException by the Serializer component #33630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/Symfony/Component/Debug/Exception/FlattenException.php
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public function getHeaders()
return $this->headers;
}

public function setHeaders(array $headers)
public function setHeaders($headers)
{
$this->headers = $headers;
}
Expand Down Expand Up @@ -157,7 +157,7 @@ public function getPrevious()
return $this->previous;
}

public function setPrevious(self $previous)
public function setPrevious($previous)
{
$this->previous = $previous;
}
Expand All @@ -183,8 +183,13 @@ public function setTraceFromException(\Exception $exception)
$this->setTrace($exception->getTrace(), $exception->getFile(), $exception->getLine());
}

public function setTrace($trace, $file, $line)
public function setTrace($trace, $file = null, $line = null)
{
if (null === $file && null === $line && (null === $trace || isset($trace[0], $trace[0]['namespace']))) {
$this->trace = $trace;

return;
}
$this->trace = [];
$this->trace[] = [
'namespace' => '',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
use Symfony\Component\HttpKernel\Exception\TooManyRequestsHttpException;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;

class FlattenExceptionTest extends TestCase
{
Expand Down Expand Up @@ -295,6 +298,42 @@ public function testTooBigArray()
$this->assertStringNotContainsString('*value1*', $serializeTrace);
}

public function testInstancesCreatedWithConstructorAreDeserializable()
{
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);

$flattened = new FlattenException();
/** @var FlattenException $serialized */
$serialized = $serializer->deserialize($serializer->serialize($flattened, 'json'), FlattenException::class, 'json');

$this->assertSame($flattened->getMessage(), $serialized->getMessage());
$this->assertSame($flattened->getCode(), $serialized->getCode());
$this->assertSame($flattened->getStatusCode(), $serialized->getStatusCode());
$this->assertSame($flattened->getClass(), $serialized->getClass());
$this->assertSame($flattened->getFile(), $serialized->getFile());
$this->assertSame($flattened->getLine(), $serialized->getLine());
$this->assertSame($flattened->getPrevious(), $serialized->getPrevious());
$this->assertSame($flattened->getTrace(), $serialized->getTrace());
}

public function testInstancesCreatedFromExceptionAreDeserializable()
{
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);

$flattened = FlattenException::create($this->createException(42), 404, ['Content-Type' => 'application/json']);
/** @var FlattenException $serialized */
$serialized = $serializer->deserialize($serializer->serialize($flattened, 'json'), FlattenException::class, 'json');

$this->assertSame($flattened->getMessage(), $serialized->getMessage());
$this->assertSame($flattened->getCode(), $serialized->getCode());
$this->assertSame($flattened->getStatusCode(), $serialized->getStatusCode());
$this->assertSame($flattened->getClass(), $serialized->getClass());
$this->assertSame($flattened->getFile(), $serialized->getFile());
$this->assertSame($flattened->getLine(), $serialized->getLine());
$this->assertSame($flattened->getPrevious(), $serialized->getPrevious());
$this->assertSame($flattened->getTrace(), $serialized->getTrace());
}

private function createException($foo)
{
return new \Exception();
Expand Down
4 changes: 3 additions & 1 deletion src/Symfony/Component/Debug/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
"symfony/http-kernel": ">=2.3,<2.3.24|~2.4.0|>=2.5,<2.5.9|>=2.6,<2.6.2"
},
"require-dev": {
"symfony/http-kernel": "~2.8|~3.0|~4.0"
"symfony/http-kernel": "~2.8|~3.0|~4.0",
"symfony/property-access": "~3.0|~4.0",
"symfony/serializer": "~3.0|~4.0"
},
"autoload": {
"psr-4": { "Symfony\\Component\\Debug\\": "" },
Expand Down