Avoid serialization loop with IndexMetadata during serialization (#186)

Author: alexander-schranz

.github/workflows/test-application.yaml

@@ -78,7 +78,15 @@ jobs:
                     - php-version: '8.3'
                       elasticsearch-version: '7.17.19'
                       elasticsearch-package-constraint: '~7.17.0'
-                      minimum-stability: 'dev'
+                      minimum-stability: 'stable'
+                      dependency-versions: 'highest'
+                      tools: 'composer:v2'
+                      php-cs-fixer: false
+
+                    - php-version: '8.4'
+                      elasticsearch-version: '7.17.19'
+                      elasticsearch-package-constraint: '~7.17.0'
+                      minimum-stability: 'stable'
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
                       php-cs-fixer: false

Search/Metadata/ClassMetadata.php

@@ -90,6 +90,9 @@ public function unserializeFromArray(array $data): void
         list($data, $indexMetadata, $this->repositoryMethod) = $data;
         parent::unserializeFromArray($data);
         $this->indexMetadatas = $indexMetadata;
+        foreach ($this->indexMetadatas as $indexMetadata) {
+            $indexMetadata->setClassMetadata($this);
+        }
     }
 
     /**

Search/Metadata/IndexMetadata.php

@@ -11,11 +11,15 @@
 
 namespace Massive\Bundle\SearchBundle\Search\Metadata;
 
+use Metadata\SerializationHelper;
+
 /**
  * Metadata for searchable objects.
  */
-class IndexMetadata implements IndexMetadataInterface
+class IndexMetadata implements IndexMetadataInterface, \Serializable
 {
+    use SerializationHelper;
+
     /**
      * @var string
      */
@@ -170,4 +174,34 @@ public function setClassMetadata(ClassMetadata $classMetadata)
     {
         $this->classMetadata = $classMetadata;
     }
+
+    public function serializeToArray(): array
+    {
+        return [
+            $this->name,
+            $this->indexName,
+            $this->fieldMapping,
+            $this->idField,
+            $this->urlField,
+            $this->titleField,
+            $this->descriptionField,
+            $this->imageUrlField,
+            $this->localeField,
+        ];
+    }
+
+    public function unserializeFromArray(array $data): void
+    {
+        list(
+            $this->name,
+            $this->indexName,
+            $this->fieldMapping,
+            $this->idField,
+            $this->urlField,
+            $this->titleField,
+            $this->descriptionField,
+            $this->imageUrlField,
+            $this->localeField
+        ) = $data;
+    }
 }

Tests/Unit/Search/Metadata/ClassMetadataTest.php

@@ -74,4 +74,15 @@ public function testSerializeUnserialize()
 
         $this->assertEquals($this->classMetadata, \unserialize(\serialize($this->classMetadata)));
     }
+
+    public function testSerializeUnserializeWithIndexMetadata()
+    {
+        $classMetadata = new ClassMetadata('\stdClass');
+        $classMetadata->addIndexMetadata(
+            'foo_context',
+            new IndexMetadata()
+        );
+
+        $this->assertEquals($classMetadata, \unserialize(\serialize($classMetadata)));
+    }
 }