Merge pull request #1929 from alcaeus/fix-persistent-collection-serialisation

Fix serialisation of uninitialised PersistentCollection instances

Author: alcaeus

lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php

@@ -574,15 +574,15 @@ public function slice($offset, $length = null)
     }
 
     /**
-     * Called by PHP when this collection is serialized. Ensures that only the
-     * elements are properly serialized.
+     * Called by PHP when this collection is serialized. Ensures that the
+     * internal state of the collection can be reproduced after serialization
      *
      * @internal Tried to implement Serializable first but that did not work well
      *           with circular references. This solution seems simpler and works well.
      */
     public function __sleep()
     {
-        return array('coll', 'initialized');
+        return array('coll', 'initialized', 'mongoData', 'snapshot', 'isDirty', 'hints');
     }
 
     /* ArrayAccess implementation */

tests/Doctrine/ODM/MongoDB/Tests/PersistentCollectionTest.php

@@ -5,6 +5,9 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\PersistentCollection;
+use Documents\User;
+use MongoId;
+use stdClass;
 
 class PersistentCollectionTest extends BaseTest
 {
@@ -68,6 +71,54 @@ public function testGetTypeClassWorksAfterUnserialization()
         $this->assertInstanceOf(ClassMetadata::class, $unserialized->getTypeClass());
     }
 
+    public function testMongoDataIsPreservedDuringSerialization()
+    {
+        $mongoData = [
+            [
+                '$ref' => 'group',
+                '$id' => new MongoId()
+            ],
+            [
+                '$ref' => 'group',
+                '$id' => new MongoId()
+            ],
+        ];
+
+        $collection = new PersistentCollection(new ArrayCollection(), $this->dm, $this->uow);
+        $collection->setMongoData($mongoData);
+
+        $serialized = serialize($collection);
+        /** @var PersistentCollection $unserialized */
+        $unserialized = unserialize($serialized);
+
+        $unserialized->setOwner(new \Documents\User(), $this->dm->getClassMetadata(User::class)->getFieldMapping('groups'));
+        $unserialized->setDocumentManager($this->dm);
+
+        $this->assertCount(2, $unserialized->getMongoData());
+    }
+
+    public function testSnapshotIsPreservedDuringSerialization()
+    {
+        $collection = new PersistentCollection(new ArrayCollection(), $this->dm, $this->uow);
+        $collection->add(new stdClass());
+        $collection->takeSnapshot();
+
+        $this->assertCount(1, $collection->getSnapshot());
+        $this->assertFalse($collection->isDirty());
+        $this->assertCount(1, $collection->unwrap());
+
+        $serialized = serialize($collection);
+        /** @var PersistentCollection $unserialized */
+        $unserialized = unserialize($serialized);
+
+        $unserialized->setOwner(new \Documents\User(), $this->dm->getClassMetadata(User::class)->getFieldMapping('groups'));
+        $unserialized->setDocumentManager($this->dm);
+
+        $this->assertCount(1, $unserialized->getSnapshot());
+        $this->assertFalse($unserialized->isDirty());
+        $this->assertCount(1, $unserialized->unwrap());
+    }
+
     /**
      * @param array $expected
      * @param array $snapshot