Fix normalization with NormalizableInterface

Author: norkunas

composer.json

@@ -56,7 +56,8 @@
   "config": {
     "sort-packages": true,
     "allow-plugins": {
-      "phpstan/extension-installer": true
+      "phpstan/extension-installer": true,
+      "php-http/discovery": true
     }
   },
   "scripts": {

src/SearchableEntity.php

@@ -7,6 +7,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Symfony\Component\Config\Definition\Exception\Exception;
 use Symfony\Component\Serializer\Exception\ExceptionInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizableInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
@@ -22,8 +23,7 @@ final class SearchableEntity
     /** @var ClassMetadata<object> */
     private ClassMetadata $entityMetadata;
 
-    /** @var object */
-    private $normalizer;
+    private ?NormalizerInterface $normalizer;
 
     private bool $useSerializerGroups;
 
@@ -34,14 +34,13 @@ final class SearchableEntity
      * SearchableEntity constructor.
      *
      * @param object                $entity
-     * @param object|null           $normalizer
      * @param ClassMetadata<object> $entityMetadata
      */
     public function __construct(
         string $indexUid,
         $entity,
         ClassMetadata $entityMetadata,
-        $normalizer = null,
+        ?NormalizerInterface $normalizer = null,
         array $extra = []
     ) {
         $this->indexUid = $indexUid;
@@ -71,7 +70,11 @@ public function getSearchableArray(): array
             $context['groups'] = [Searchable::NORMALIZATION_GROUP];
         }
 
-        if ($this->normalizer instanceof NormalizerInterface) {
+        if ($this->entity instanceof NormalizableInterface && null !== $this->normalizer) {
+            return $this->entity->normalize($this->normalizer, Searchable::NORMALIZATION_FORMAT, $context);
+        }
+
+        if (null !== $this->normalizer) {
             return $this->normalizer->normalize($this->entity, Searchable::NORMALIZATION_FORMAT, $context);
         }
 
@@ -86,7 +89,7 @@ private function setId(): void
             throw new Exception('Entity has no primary key');
         }
 
-        if (1 == \count($ids)) {
+        if (1 === \count($ids)) {
             $this->id = reset($ids);
         } else {
             $objectID = '';

src/Services/MeilisearchService.php

@@ -16,14 +16,14 @@
 use Symfony\Component\Config\Definition\Exception\Exception;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
-use Symfony\Component\Serializer\SerializerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * Class MeilisearchService.
  */
 final class MeilisearchService implements SearchService
 {
-    private SerializerInterface $normalizer;
+    private NormalizerInterface $normalizer;
     private Engine $engine;
     private Collection $configuration;
     private PropertyAccessor $propertyAccessor;
@@ -33,7 +33,7 @@ final class MeilisearchService implements SearchService
     private array $classToSerializerGroupMapping;
     private array $indexIfMapping;
 
-    public function __construct(SerializerInterface $normalizer, Engine $engine, array $configuration)
+    public function __construct(NormalizerInterface $normalizer, Engine $engine, array $configuration)
     {
         $this->normalizer = $normalizer;
         $this->engine = $engine;

tests/Entity/SelfNormalizable.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Bundle\Test\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Meilisearch\Bundle\Searchable;
+use Symfony\Component\Serializer\Normalizer\NormalizableInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * @ORM\Entity
+ */
+class SelfNormalizable implements NormalizableInterface
+{
+    /**
+     * @ORM\Id
+     *
+     * @ORM\Column(type="integer")
+     */
+    private int $id;
+
+    /**
+     * @ORM\Column(type="string")
+     */
+    private string $name;
+
+    /**
+     * @ORM\Column(type="datetime_immutable")
+     */
+    private \DateTimeImmutable $createdAt;
+
+    public function __construct(int $id, string $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+        $this->createdAt = new \DateTimeImmutable();
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getCreatedAt(): \DateTimeImmutable
+    {
+        return $this->createdAt;
+    }
+
+    public function normalize(NormalizerInterface $normalizer, $format = null, array $context = []): array
+    {
+        if (Searchable::NORMALIZATION_FORMAT === $format) {
+            return [
+                'id' => $this->id,
+                'name' => 'this test is correct',
+                'self_normalized' => true,
+            ];
+        }
+
+        return [];
+    }
+}

tests/Integration/CommandsTest.php

@@ -5,6 +5,7 @@
 namespace Meilisearch\Bundle\Tests\Integration;
 
 use Meilisearch\Bundle\Tests\BaseKernelTestCase;
+use Meilisearch\Bundle\Test\Entity\SelfNormalizable;
 use Meilisearch\Client;
 use Meilisearch\Endpoints\Indexes;
 use Meilisearch\Exceptions\ApiException;
@@ -330,4 +331,41 @@ public function testCreateExecuteIndexCreation(): void
 
         $this->assertEquals($this->client->getTasks()->getResults()[0]['type'], 'indexCreation');
     }
+
+    public function testImportsSelfNormalizable(): void
+    {
+        for ($i = 1; $i <= 2; ++$i) {
+            $this->entityManager->persist(new SelfNormalizable($i, "Self normalizabie $i"));
+        }
+
+        $this->entityManager->flush();
+
+        $importCommand = $this->application->find('meili:import');
+        $importCommandTester = new CommandTester($importCommand);
+        $importCommandTester->execute(['--indices' => 'self_normalizable']);
+
+        $importOutput = $importCommandTester->getDisplay();
+
+        $this->assertSame(<<<'EOD'
+Importing for index Meilisearch\Bundle\Test\Entity\SelfNormalizable
+Indexed 2 / 2 Meilisearch\Bundle\Test\Entity\SelfNormalizable entities into sf_phpunit__self_normalizable index
+Done!
+
+EOD, $importOutput);
+
+        self::assertSame([
+            [
+                'objectID' => 1,
+                'id' => 1,
+                'name' => 'this test is correct',
+                'self_normalized' => true,
+            ],
+            [
+                'objectID' => 2,
+                'id' => 2,
+                'name' => 'this test is correct',
+                'self_normalized' => true,
+            ],
+        ], $this->client->index('sf_phpunit__self_normalizable')->getDocuments()->getResults());
+    }
 }

tests/config/meilisearch.yaml

@@ -34,3 +34,5 @@ meilisearch:
         -   name: pages
             class: 'Meilisearch\Bundle\Tests\Entity\Page'
             enable_serializer_groups: true
+        -   name: self_normalizable
+            class: 'Meilisearch\Bundle\Test\Entity\SelfNormalizable'