When converting ES document array to an object, handle the case where there may be a single object value for a 'multiple' object field instead of an array and vice versa (fixes #9)

Author: pmishev

Exception/DocumentConversionException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Sineflow\ElasticsearchBundle\Exception;
+
+/**
+ * Class DocumentConversionException
+ */
+class DocumentConversionException extends Exception
+{
+}

Result/DocumentConverter.php

@@ -5,6 +5,7 @@
 use Sineflow\ElasticsearchBundle\Document\DocumentInterface;
 use Sineflow\ElasticsearchBundle\Document\MLProperty;
 use Sineflow\ElasticsearchBundle\Document\ObjectInterface;
+use Sineflow\ElasticsearchBundle\Exception\DocumentConversionException;
 use Sineflow\ElasticsearchBundle\Mapping\DocumentMetadata;
 use Sineflow\ElasticsearchBundle\Mapping\DocumentMetadataCollector;
 
@@ -114,11 +115,26 @@ public function assignArrayToObject(array $array, ObjectInterface $object, array
                     }
                 }
             } elseif (in_array($propertyMetadata['type'], ['object', 'nested'])) {
+                // ES doesn't mind having either single or multiple objects with the same mapping, but in this bundle we must specifically declare either.
+                // So we must make sure everything works for a 'multiple' definition where we actually have a single object and vice versa.
+                if ($propertyMetadata['multiple'] && key($array[$esField]) !== 0) {
+                    // field is declared multiple, but actual data is single object
+                    $data = [$array[$esField]];
+                } elseif (!$propertyMetadata['multiple'] && key($array[$esField]) === 0) {
+                    // field is declared as single object, but actual data is an array of objects
+                    if (count($array[$esField]) > 1) {
+                        throw new DocumentConversionException(sprintf('Multiple objects found for a single object field `%s`', $propertyMetadata['propertyName']));
+                    }
+                    $data = current($array[$esField]);
+                } else {
+                    $data = $array[$esField];
+                }
+
                 if ($propertyMetadata['multiple']) {
-                    $objectValue = new ObjectIterator($this, $array[$esField], $propertyMetadata);
+                    $objectValue = new ObjectIterator($this, $data, $propertyMetadata);
                 } else {
                     $objectValue = $this->assignArrayToObject(
-                        $array[$esField],
+                        $data,
                         new $propertyMetadata['className'](),
                         $propertyMetadata['propertiesMetadata']
                     );

Tests/Functional/Result/DocumentConverterTest.php

@@ -3,6 +3,7 @@
 namespace Sineflow\ElasticsearchBundle\Tests\Functional\Result;
 
 use Sineflow\ElasticsearchBundle\Document\MLProperty;
+use Sineflow\ElasticsearchBundle\Exception\DocumentConversionException;
 use Sineflow\ElasticsearchBundle\Tests\AbstractContainerAwareTestCase;
 use Sineflow\ElasticsearchBundle\Tests\app\fixture\Acme\BarBundle\Document\ObjCategory;
 use Sineflow\ElasticsearchBundle\Tests\app\fixture\Acme\BarBundle\Document\Product;
@@ -26,6 +27,89 @@ class DocumentConverterTest extends AbstractContainerAwareTestCase
         'nonexisting' => 'should be skipped',
     ];
 
+    public function testAssignArrayToObjectWithNestedSingleValueInsteadOfArray()
+    {
+        $converter = $this->getContainer()->get('sfes.document_converter');
+        $metadataCollector = $this->getContainer()->get('sfes.document_metadata_collector');
+
+        // Raw doc with a single object value where an array of objects is expected according to metadata def
+        $rawDoc = [
+            '_id' => 'rawDocWithSingleObjValueInsteadOfArray',
+            'related_categories' => [
+                'id' => '123',
+                'title' => 'Acme',
+            ],
+        ];
+
+        $product = new Product();
+        $result = $converter->assignArrayToObject(
+            $rawDoc,
+            $product,
+            $metadataCollector->getDocumentMetadata('AcmeBarBundle:Product')->getPropertiesMetadata()
+        );
+        $category = $result->relatedCategories->current();
+
+        $this->assertEquals($category->id, 123);
+    }
+
+    public function testAssignArrayToObjectWithNestedSingleValueArrayInsteadOfSingleValue()
+    {
+        $converter = $this->getContainer()->get('sfes.document_converter');
+        $metadataCollector = $this->getContainer()->get('sfes.document_metadata_collector');
+
+        // Raw doc with array of single object where a single object value is expected according to metadata def
+        $rawDoc = [
+            '_id' => 'rawDocWithArrayValueInsteadOfSingleObject',
+            'category' => [
+                [
+                    'id' => '123',
+                    'title' => 'Acme',
+                ],
+            ],
+        ];
+
+        $product = new Product();
+        $result = $converter->assignArrayToObject(
+            $rawDoc,
+            $product,
+            $metadataCollector->getDocumentMetadata('AcmeBarBundle:Product')->getPropertiesMetadata()
+        );
+
+        $this->assertEquals($result->category->id, 123);
+    }
+
+    public function testAssignArrayToObjectWithNestedMultiValueArrayInsteadOfSingleValue()
+    {
+        $converter = $this->getContainer()->get('sfes.document_converter');
+        $metadataCollector = $this->getContainer()->get('sfes.document_metadata_collector');
+
+        // Raw doc with array of many objects where a single object value is expected according to metadata def
+        $rawDoc = [
+            '_id' => 'rawDocWithArrayValueInsteadOfSingleObject',
+            'category' => [
+                [
+                    'id' => '123',
+                    'title' => 'Acme',
+                ],
+                [
+                    'id' => '234',
+                    'title' => 'Ucme',
+                ],
+            ],
+        ];
+
+        $product = new Product();
+
+        $this->expectException(DocumentConversionException::class);
+        $this->expectExceptionMessage('Multiple objects found for a single object field `category`');
+
+        $converter->assignArrayToObject(
+            $rawDoc,
+            $product,
+            $metadataCollector->getDocumentMetadata('AcmeBarBundle:Product')->getPropertiesMetadata()
+        );
+    }
+
     public function testAssignArrayToObjectWithAllFieldsCorrectlySet()
     {
         $converter = $this->getContainer()->get('sfes.document_converter');