fix: address broken escaping of array items for JsonbArray and preserve integer values as strings if they are outside PHP integer range (#442)

Author: martin-georgiev

src/MartinGeorgiev/Doctrine/DBAL/Types/JsonbArray.php

@@ -4,12 +4,13 @@
 
 namespace MartinGeorgiev\Doctrine\DBAL\Types;
 
+use MartinGeorgiev\Utils\PostgresArrayToPHPArrayTransformer;
 use MartinGeorgiev\Utils\PostgresJsonToPHPArrayTransformer;
 
 /**
  * Implementation of PostgreSQL JSONB[] data type.
  *
- * @see https://www.postgresql.org/docs/9.4/static/arrays.html
+ * @see https://www.postgresql.org/docs/17/arrays.html
  * @since 0.1
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
@@ -22,12 +23,18 @@ class JsonbArray extends BaseArray
 
     protected function transformArrayItemForPostgres(mixed $item): string
     {
-        return $this->transformToPostgresJson($item);
+        // Quote each JSON value as a PostgreSQL array element and escape inner quotes and backslashes
+        $escaped = \strtr(
+            $this->transformToPostgresJson($item),
+            ['\\' => '\\\\', '"' => '\\"']
+        );
+
+        return '"'.$escaped.'"';
     }
 
     protected function transformPostgresArrayToPHPArray(string $postgresArray): array
     {
-        return PostgresJsonToPHPArrayTransformer::transformPostgresArrayToPHPArray($postgresArray);
+        return PostgresArrayToPHPArrayTransformer::transformPostgresArrayToPHPArray($postgresArray);
     }
 
     /**

src/MartinGeorgiev/Utils/PostgresJsonToPHPArrayTransformer.php

@@ -39,7 +39,7 @@ public static function transformPostgresArrayToPHPArray(string $postgresValue):
     public static function transformPostgresJsonEncodedValueToPHPArray(string $postgresValue): array
     {
         try {
-            $transformedValue = \json_decode($postgresValue, true, 512, JSON_THROW_ON_ERROR);
+            $transformedValue = \json_decode($postgresValue, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
             if (!\is_array($transformedValue)) {
                 throw InvalidJsonArrayItemForPHPException::forInvalidType($postgresValue);
             }
@@ -57,7 +57,7 @@ public static function transformPostgresJsonEncodedValueToPHPValue(string $postg
     {
         try {
             // @phpstan-ignore-next-line
-            return \json_decode($postgresValue, true, 512, JSON_THROW_ON_ERROR);
+            return \json_decode($postgresValue, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
         } catch (\JsonException) {
             throw InvalidJsonItemForPHPException::forInvalidType($postgresValue);
         }

tests/Integration/MartinGeorgiev/Doctrine/DBAL/Types/JsonbArrayTypeTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Integration\MartinGeorgiev\Doctrine\DBAL\Types;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+
+class JsonbArrayTypeTest extends ArrayTypeTestCase
+{
+    protected function getTypeName(): string
+    {
+        return 'jsonb[]';
+    }
+
+    protected function getPostgresTypeName(): string
+    {
+        return 'JSONB[]';
+    }
+
+    #[DataProvider('provideValidTransformations')]
+    #[Test]
+    public function can_handle_array_values(string $testName, array $arrayValue): void
+    {
+        parent::can_handle_array_values($testName, $arrayValue);
+    }
+
+    /**
+     * @return array<string, array{string, array<int, array<string, mixed>>}>
+     */
+    public static function provideValidTransformations(): array
+    {
+        return [
+            'simple jsonb array' => ['simple jsonb array', [
+                ['key1' => 'value1', 'key2' => false],
+                ['key1' => 'value2', 'key2' => true],
+            ]],
+            'jsonb array with nested structures' => ['jsonb array with nested structures', [
+                [
+                    'user' => ['id' => 1, 'name' => 'John'],
+                    'meta' => ['active' => true, 'roles' => ['admin', 'user']],
+                ],
+                [
+                    'user' => ['id' => 2, 'name' => 'Jane'],
+                    'meta' => ['active' => false, 'roles' => ['user']],
+                ],
+            ]],
+            'jsonb array with mixed types' => ['jsonb array with mixed types', [
+                [
+                    'string' => 'value',
+                    'number' => 42,
+                    'boolean' => false,
+                    'null' => null,
+                    'array' => [1, 2, 3],
+                    'object' => ['a' => 1],
+                ],
+                [
+                    'different' => 'structure',
+                    'count' => 999,
+                    'enabled' => true,
+                ],
+            ]],
+            'jsonb array with big integers' => ['jsonb array with big integers', [
+                [
+                    'bigint' => '9223372036854775807', // PHP_INT_MAX as string
+                    'regular' => 123,
+                ],
+                [
+                    'huge_number' => '18446744073709551615', // Larger than PHP_INT_MAX
+                    'small' => 1,
+                ],
+            ]],
+        ];
+    }
+}

tests/Unit/MartinGeorgiev/Doctrine/DBAL/Types/JsonbArrayTest.php

@@ -82,7 +82,7 @@ public static function provideValidTransformations(): array
                         'key5' => [304, 404, 504, 604],
                     ],
                 ],
-                'postgresValue' => '{{"key1":"value1","key2":false,"key3":"15","key4":15,"key5":[112,242,309,310]},{"key1":"value2","key2":true,"key3":"115","key4":115,"key5":[304,404,504,604]}}',
+                'postgresValue' => '{"{\"key1\":\"value1\",\"key2\":false,\"key3\":\"15\",\"key4\":15,\"key5\":[112,242,309,310]}","{\"key1\":\"value2\",\"key2\":true,\"key3\":\"115\",\"key4\":115,\"key5\":[304,404,504,604]}"}',
             ],
         ];
     }