Skip to content

fix: Serialize native PHP enums with name and value instead of opaque 'Object' string #2038

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.

Sign up for GitHub

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

Open
jarstelfox wants to merge 4 commits into
base: master
Choose a base branch
from
+82 −1
Open

fix: Serialize native PHP enums with name and value instead of opaque 'Object' string #2038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1767acf
fix: Serialize native PHP enums with their name and value instead of …
jarstelfox Mar 25, 2026
87b6262
style: Fix PHP-CS-Fixer docblock formatting
jarstelfox Mar 25, 2026
62a6bc9
fix: Move UnitEnum check after class serializers to preserve custom s…
jarstelfox Mar 26, 2026
92daa77
test: Add unit enum output format test alongside backed enum test
jarstelfox Mar 27, 2026
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: 10 additions & 1 deletion src/Serializer/AbstractSerializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ protected function serializeRecursively($value, int $_depth = 0)
return $this->formatDate($value);
}

if ($value instanceof \UnitEnum) {
return $this->serializeValue($value);
}

if ($this->serializeAllObjects || ($value instanceof \stdClass)) {
return $this->serializeObject($value, $_depth);
}
Expand Down Expand Up @@ -247,8 +251,13 @@ protected function serializeValue($value)

if ($value instanceof \UnitEnum) {
$reflection = new \ReflectionObject($value);
$enumValue = $reflection->getName() . '::' . $value->name;

if ($value instanceof \BackedEnum) {
return 'Enum ' . $enumValue . '(' . $value->value . ')';
}

return 'Enum ' . $reflection->getName() . '::' . $value->name;
return 'Enum ' . $enumValue;
}

if (\is_object($value)) {
Expand Down
62 changes: 62 additions & 0 deletions tests/Serializer/AbstractSerializerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,68 @@ public function testEnumsAreNames(): void
$this->assertSame('Enum Sentry\Tests\Serializer\SerializerTestEnum::CASE_NAME', $result);
}

/**
* @requires PHP >= 8.1
*/
public function testBackedEnumsIncludeValue(): void
{
$serializer = $this->createSerializer();
$input = SerializerTestBackedEnum::CASE_NAME;
$result = $this->invokeSerialization($serializer, $input);

$this->assertSame('Enum Sentry\Tests\Serializer\SerializerTestBackedEnum::CASE_NAME(case_value)', $result);
}

/**
* @requires PHP >= 8.1
*/
public function testUnitEnumsShowName(): void
{
$serializer = $this->createSerializer();
$input = SerializerTestEnum::CASE_NAME;
$result = $this->invokeSerialization($serializer, $input);

$this->assertSame('Enum Sentry\Tests\Serializer\SerializerTestEnum::CASE_NAME', $result);
}
Copy link
Copy Markdown

@cursor cursor bot Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New test duplicates existing test method exactly

Low Severity

testUnitEnumsShowName is an exact duplicate of the pre-existing testEnumsAreNames — identical serializer setup, identical input (SerializerTestEnum::CASE_NAME), and identical assertion. This adds no additional test coverage.

Fix in Cursor Fix in Web


/**
* @requires PHP >= 8.1
*
* @dataProvider serializeAllObjectsDataProvider
*/
public function testEnumsAreNotSerializedAsObjects(bool $serializeAllObjects): void
{
$serializer = $this->createSerializer();

if ($serializeAllObjects) {
$serializer->setSerializeAllObjects(true);
}

$input = SerializerTestEnum::CASE_NAME;
$result = $this->invokeSerialization($serializer, $input);

$this->assertSame('Enum Sentry\Tests\Serializer\SerializerTestEnum::CASE_NAME', $result);
}

/**
* @requires PHP >= 8.1
*
* @dataProvider serializeAllObjectsDataProvider
*/
public function testBackedEnumsAreNotSerializedAsObjects(bool $serializeAllObjects): void
{
$serializer = $this->createSerializer();

if ($serializeAllObjects) {
$serializer->setSerializeAllObjects(true);
}

$input = SerializerTestBackedEnum::CASE_NAME;
$result = $this->invokeSerialization($serializer, $input);

$this->assertSame('Enum Sentry\Tests\Serializer\SerializerTestBackedEnum::CASE_NAME(case_value)', $result);
}

public static function objectsWithIdPropertyDataProvider(): array
{
return [
Expand Down
10 changes: 10 additions & 0 deletions tests/Serializer/SerializerTestBackedEnum.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

declare(strict_types=1);

namespace Sentry\Tests\Serializer;

enum SerializerTestBackedEnum: string
{
case CASE_NAME = 'case_value';
}
Loading