adds JSON_ERROR_NON_BACKED_ENUM to allowed JSON::encode() errors. (…

…#1707)
getsentry · Feb 27, 2024 · 6f8cce5 · 6f8cce5
1 parent 1cd7ff0
commit 6f8cce5
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/src/Util/JSON.php b/src/Util/JSON.php
@@ -35,6 +35,9 @@ public static function encode($data, int $options = 0, int $maxDepth = 512): str
         $encodedData = json_encode($data, $options, $maxDepth);
 
         $allowedErrors = [\JSON_ERROR_NONE, \JSON_ERROR_RECURSION, \JSON_ERROR_INF_OR_NAN, \JSON_ERROR_UNSUPPORTED_TYPE];
+        if (\defined('JSON_ERROR_NON_BACKED_ENUM')) {
+            $allowedErrors[] = \JSON_ERROR_NON_BACKED_ENUM;
+        }
 
         $encounteredAnyError = json_last_error() !== \JSON_ERROR_NONE;
 

diff --git a/tests/Util/Fixtures/NonBackedEnum.php b/tests/Util/Fixtures/NonBackedEnum.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Tests\Util\Fixtures;
+
+enum NonBackedEnum
+{
+    case None;
+    case Some;
+}
diff --git a/tests/Util/JSONTest.php b/tests/Util/JSONTest.php
@@ -7,6 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use Sentry\Exception\JsonException;
 use Sentry\Tests\Util\Fixtures\JsonSerializableClass;
+use Sentry\Tests\Util\Fixtures\NonBackedEnum;
 use Sentry\Tests\Util\Fixtures\SimpleClass;
 use Sentry\Util\JSON;
 
@@ -143,6 +144,17 @@ public function testEncodeRespectsOptionsArgument(): void
         $this->assertSame('{}', JSON::encode([], \JSON_FORCE_OBJECT));
     }
 
+    /**
+     * The `JSON_ERROR_NON_BACKED_ENUM` constant is only exposed from 8.1.5 and up.
+     *
+     * @requires PHP >= 8.1.5
+     */
+    public function testEncodeGracefullyHandlesUnitEnums(): void
+    {
+        $result = JSON::encode([NonBackedEnum::None, NonBackedEnum::Some]);
+        $this->assertSame('[0,0]', $result);
+    }
+
     /**
      * @dataProvider decodeDataProvider
      */