feat: Serialize Enum variants with the variant name

With enum types it's almost always useful to know exactly which variant is being
logged. But the current serializers don't differentiate between enums and objects.

This changes the serializers to add the variant name of the enum that is being
serialized.

Author: blackwolf12333

phpunit.xml.dist

@@ -14,6 +14,7 @@
     <testsuites>
         <testsuite name="unit">
             <directory>tests</directory>
+            <directory phpVersion="8.1">tests/Php81</directory>
             <directory suffix=".phpt">tests/phpt</directory>
         </testsuite>
 

src/Serializer/AbstractSerializer.php

@@ -241,6 +241,12 @@ protected function serializeValue($value)
             return $value;
         }
 
+        if ($value instanceof \UnitEnum) {
+            $reflection = new \ReflectionObject($value);
+
+            return 'Enum ' . $reflection->getName() . '::' . $value->name;
+        }
+
         if (\is_object($value)) {
             $reflection = new \ReflectionObject($value);
 

tests/Php81/Serializer/AbstractSerializerTest.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Tests\Php81\Serializer;
+
+use PHPUnit\Framework\TestCase;
+use Sentry\Serializer\AbstractSerializer;
+use Sentry\Serializer\RepresentationSerializerInterface;
+use Sentry\Serializer\SerializerInterface;
+
+abstract class AbstractSerializerTest extends TestCase
+{
+    abstract protected function createSerializer(): AbstractSerializer;
+
+    /**
+     * This method is only existed because of testSerializeCallable.
+     */
+    public static function setUpBeforeClass(): void
+    {
+    }
+
+    public static function serializeAllObjectsDataProvider(): array
+    {
+        return [
+            ['serializeAllObjects' => false],
+            ['serializeAllObjects' => true],
+        ];
+    }
+
+    public function testEnumsAreNames(): void
+    {
+        $serializer = $this->createSerializer();
+        $input = SerializerTestEnum::CASE_NAME;
+        $result = $this->invokeSerialization($serializer, $input);
+
+        $this->assertSame('Enum Sentry\Tests\Php81\Serializer\SerializerTestEnum::CASE_NAME', $result);
+    }
+
+    public function testEnumInArray(): void
+    {
+        $serializer = $this->createSerializer();
+        $input = ['foo' => SerializerTestEnum::CASE_NAME];
+
+        $result = $this->invokeSerialization($serializer, $input);
+
+        $this->assertSame(['foo' => 'Enum ' . SerializerTestEnum::class . '::' . SerializerTestEnum::CASE_NAME->name], $result);
+    }
+
+    public static function serializationForBadStringsDataProvider(): array
+    {
+        $utf8String = 'äöü';
+
+        return [
+            [mb_convert_encoding($utf8String, 'ISO-8859-1', 'UTF-8'), $utf8String, 'ISO-8859-1, ASCII, UTF-8'],
+            ["\xC2\xA2\xC2", "\xC2\xA2\x3F"], // ill-formed 2-byte character U+00A2 (CENT SIGN)
+        ];
+    }
+
+    protected function invokeSerialization(AbstractSerializer $serializer, $input)
+    {
+        if ($serializer instanceof SerializerInterface) {
+            return $serializer->serialize($input);
+        }
+
+        if ($serializer instanceof RepresentationSerializerInterface) {
+            return $serializer->representationSerialize($input);
+        }
+
+        throw new \InvalidArgumentException('Unrecognized AbstractSerializer: ' . \get_class($serializer));
+    }
+}
+
+enum SerializerTestEnum
+{
+    case CASE_NAME;
+}

tests/Php81/Serializer/RepresentationSerializerTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Tests\Php81\Serializer;
+
+use Sentry\Options;
+use Sentry\Serializer\AbstractSerializer;
+use Sentry\Serializer\RepresentationSerializer;
+
+final class RepresentationSerializerTest extends AbstractSerializerTest
+{
+    /**
+     * @return RepresentationSerializer
+     */
+    protected function createSerializer(): AbstractSerializer
+    {
+        return new RepresentationSerializer(new Options());
+    }
+}

tests/Php81/Serializer/SerializerTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Tests\Php81\Serializer;
+
+use Sentry\Options;
+use Sentry\Serializer\AbstractSerializer;
+use Sentry\Serializer\Serializer;
+
+final class SerializerTest extends AbstractSerializerTest
+{
+    /**
+     * @return Serializer
+     */
+    protected function createSerializer(?Options $options = null): AbstractSerializer
+    {
+        return new Serializer($options ?? new Options());
+    }
+}