Implement JsonSerializable in lazy BSON classes

Author: alcaeus

.github/workflows/static-analysis.yml

@@ -63,5 +63,44 @@ jobs:
       - name: "Run Psalm"
         run: "vendor/bin/psalm --show-info=false --stats --output-format=github --threads=$(nproc)"
 
+  rector:
+    name: "Rector"
+    runs-on: "ubuntu-22.04"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v3"
+
+      - name: Setup cache environment
+        id: extcache
+        uses: shivammathur/cache-extensions@v1
+        with:
+          php-version: ${{ env.PHP_VERSION }}
+          extensions: "mongodb-${{ ENV.DRIVER_VERSION }}"
+          key: "extcache-v1"
+
+      - name: Cache extensions
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.extcache.outputs.dir }}
+          key: ${{ steps.extcache.outputs.key }}
+          restore-keys: ${{ steps.extcache.outputs.key }}
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          extensions: "mongodb-${{ ENV.DRIVER_VERSION }}"
+          php-version: "${{ env.PHP_VERSION }}"
+          tools: "cs2pr"
+
+      - name: "Show driver information"
+        run: "php --ri mongodb"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/[email protected]"
+        with:
+          composer-options: "--no-suggest"
+
       - name: "Run Rector"
         run: "vendor/bin/rector --ansi --dry-run"

src/Model/LazyBSONArray.php

@@ -23,6 +23,7 @@
 use CallbackFilterIterator;
 use Countable;
 use IteratorAggregate;
+use JsonSerializable;
 use MongoDB\BSON\PackedArray;
 use MongoDB\Codec\CodecLibrary;
 use MongoDB\Codec\LazyBSONCodecLibrary;
@@ -37,6 +38,7 @@
 use function count;
 use function is_array;
 use function is_numeric;
+use function iterator_to_array;
 use function max;
 use function MongoDB\recursive_copy;
 use function sprintf;
@@ -54,7 +56,7 @@
  * @template-implements ArrayAccess<int, TValue>
  * @template-implements IteratorAggregate<int, TValue>
  */
-final class LazyBSONArray implements ArrayAccess, Countable, IteratorAggregate
+final class LazyBSONArray implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
 {
     /** @var PackedArray<TValue> */
     private PackedArray $bson;
@@ -184,6 +186,11 @@ function ($value, int $offset) use (&$seen) {
         );
     }
 
+    public function jsonSerialize(): array
+    {
+        return iterator_to_array($this->getIterator());
+    }
+
     /** @param mixed $offset */
     public function offsetExists($offset): bool
     {

src/Model/LazyBSONDocument.php

@@ -24,6 +24,7 @@
 use Countable;
 use Iterator;
 use IteratorAggregate;
+use JsonSerializable;
 use MongoDB\BSON\Document;
 use MongoDB\Codec\CodecLibrary;
 use MongoDB\Codec\LazyBSONCodecLibrary;
@@ -38,6 +39,7 @@
 use function is_array;
 use function is_object;
 use function is_string;
+use function iterator_to_array;
 use function MongoDB\recursive_copy;
 use function sprintf;
 use function trigger_error;
@@ -54,7 +56,7 @@
  * @template-implements ArrayAccess<string, TValue>
  * @template-implements IteratorAggregate<string, TValue>
  */
-final class LazyBSONDocument implements ArrayAccess, Countable, IteratorAggregate
+final class LazyBSONDocument implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
 {
     /** @var Document<TValue> */
     private Document $bson;
@@ -218,6 +220,11 @@ function ($value, string $key) use (&$seen) {
         );
     }
 
+    public function jsonSerialize(): array
+    {
+        return iterator_to_array($this->getIterator());
+    }
+
     /** @param mixed $offset */
     public function offsetExists($offset): bool
     {

tests/Model/LazyBSONArrayTest.php

@@ -11,9 +11,12 @@
 use stdClass;
 
 use function iterator_to_array;
+use function json_encode;
 use function serialize;
 use function unserialize;
 
+use const JSON_THROW_ON_ERROR;
+
 class LazyBSONArrayTest extends TestCase
 {
     public static function provideTestArray(): Generator
@@ -273,4 +276,14 @@ public function testSerialization(): void
 
         $this->assertEquals(['foobar', 'baz', 'yay!'], iterator_to_array($unserialized));
     }
+
+    public function testJsonSerialize(): void
+    {
+        $array = new LazyBSONArray(PackedArray::fromPHP(['foo', 'bar', 'baz']));
+        $array[0] = 'foobar';
+        $array[3] = 'yay!';
+        unset($array[1]);
+
+        $this->assertJsonStringEqualsJsonString('["foobar","baz","yay!"]', json_encode($array, JSON_THROW_ON_ERROR));
+    }
 }

tests/Model/LazyBSONDocumentTest.php

@@ -11,9 +11,12 @@
 use stdClass;
 
 use function iterator_to_array;
+use function json_encode;
 use function serialize;
 use function unserialize;
 
+use const JSON_THROW_ON_ERROR;
+
 class LazyBSONDocumentTest extends TestCase
 {
     public static function provideTestDocument(): Generator
@@ -323,4 +326,14 @@ public function testSerialization(): void
 
         $this->assertEquals(['foo' => 'foobar', 'baz' => 'yay!'], iterator_to_array($unserialized));
     }
+
+    public function testJsonSerialize(): void
+    {
+        $document = new LazyBSONDocument(Document::fromPHP(['foo' => 'bar', 'bar' => 'baz']));
+        $document['foo'] = 'foobar';
+        $document['baz'] = 'yay!';
+        unset($document['bar']);
+
+        $this->assertJsonStringEqualsJsonString('{"foo":"foobar","baz":"yay!"}', json_encode($document, JSON_THROW_ON_ERROR));
+    }
 }