Make lazy BSON classes serializable

Author: alcaeus

src/Model/LazyBSONArray.php

@@ -109,6 +109,36 @@ public function __construct($input = null, ?CodecLibrary $codecLibrary = null)
         $this->codecLibrary = $codecLibrary ?? new LazyBSONCodecLibrary();
     }
 
+    /** @return array{bson: PackedArray<TValue>, set: array<int, TValue>, unset: array<int, true>, codecLibrary: CodecLibrary} */
+    public function __serialize(): array
+    {
+        return [
+            'bson' => $this->bson,
+            'set' => $this->set,
+            'unset' => $this->unset,
+            'codecLibrary' => $this->codecLibrary,
+        ];
+    }
+
+    /** @param array{bson: PackedArray<TValue>, set: array<int, TValue>, unset: array<int, true>, codecLibrary: CodecLibrary} $data */
+    public function __unserialize(array $data): void
+    {
+        $this->bson = $data['bson'];
+        $this->set = $data['set'];
+        $this->unset = $data['unset'];
+        $this->codecLibrary = $data['codecLibrary'];
+
+        $this->exists = array_map(
+        /** @param TValue $value */
+            fn ($value): bool => true,
+            $this->set,
+        );
+
+        foreach ($this->unset as $index => $unused) {
+            $this->exists[$index] = false;
+        }
+    }
+
     public function count(): int
     {
         $this->readEntirePackedArray();

src/Model/LazyBSONDocument.php

@@ -32,6 +32,7 @@
 
 use function array_filter;
 use function array_key_exists;
+use function array_map;
 use function count;
 use function get_object_vars;
 use function is_array;
@@ -130,6 +131,17 @@ public function __isset(string $name): bool
         return $this->exists[$name] ??= $this->bson->has($name);
     }
 
+    /** @return array{bson: Document<TValue>, set: array<string, TValue>, unset: array<string, true>, codecLibrary: CodecLibrary} */
+    public function __serialize(): array
+    {
+        return [
+            'bson' => $this->bson,
+            'set' => $this->set,
+            'unset' => $this->unset,
+            'codecLibrary' => $this->codecLibrary,
+        ];
+    }
+
     /** @param TValue $value */
     public function __set(string $property, $value): void
     {
@@ -138,6 +150,25 @@ public function __set(string $property, $value): void
         $this->exists[$property] = true;
     }
 
+    /** @param array{bson: Document<TValue>, set: array<string, TValue>, unset: array<string, true>, codecLibrary: CodecLibrary} $data */
+    public function __unserialize(array $data): void
+    {
+        $this->bson = $data['bson'];
+        $this->set = $data['set'];
+        $this->unset = $data['unset'];
+        $this->codecLibrary = $data['codecLibrary'];
+
+        $this->exists = array_map(
+        /** @param TValue $value */
+            fn ($value): bool => true,
+            $this->set,
+        );
+
+        foreach ($this->unset as $name => $unused) {
+            $this->exists[$name] = false;
+        }
+    }
+
     public function __unset(string $name): void
     {
         $this->unset[$name] = true;

tests/Model/LazyBSONArrayTest.php

@@ -11,6 +11,8 @@
 use stdClass;
 
 use function iterator_to_array;
+use function serialize;
+use function unserialize;
 
 class LazyBSONArrayTest extends TestCase
 {
@@ -258,4 +260,17 @@ public function testCount(): void
         $array[] = 'yay';
         $this->assertCount(3, $array);
     }
+
+    public function testSerialization(): void
+    {
+        $array = new LazyBSONArray(PackedArray::fromPHP(['foo', 'bar', 'baz']));
+        $array[0] = 'foobar';
+        $array[3] = 'yay!';
+        unset($array[1]);
+
+        $serialized = serialize($array);
+        $unserialized = unserialize($serialized);
+
+        $this->assertEquals(['foobar', 'baz', 'yay!'], iterator_to_array($unserialized));
+    }
 }

tests/Model/LazyBSONDocumentTest.php

@@ -11,6 +11,8 @@
 use stdClass;
 
 use function iterator_to_array;
+use function serialize;
+use function unserialize;
 
 class LazyBSONDocumentTest extends TestCase
 {
@@ -308,4 +310,17 @@ public function testCount(): void
         $document['baz'] = 'yay';
         $this->assertCount(2, $document);
     }
+
+    public function testSerialization(): void
+    {
+        $document = new LazyBSONDocument(Document::fromPHP(['foo' => 'bar', 'bar' => 'baz']));
+        $document['foo'] = 'foobar';
+        $document['baz'] = 'yay!';
+        unset($document['bar']);
+
+        $serialized = serialize($document);
+        $unserialized = unserialize($serialized);
+
+        $this->assertEquals(['foo' => 'foobar', 'baz' => 'yay!'], iterator_to_array($unserialized));
+    }
 }