IBX-8190: Add Symfony's Serializer support

src/bundle/DependencyInjection/Compiler/ValueObjectVisitorPass.php → src/bundle/DependencyInjection/Compiler/ValueObjectVisitorResolverPass.php

@@ -7,30 +7,31 @@
 
 namespace Ibexa\Bundle\Rest\DependencyInjection\Compiler;
 
-use Ibexa\Contracts\Rest\Output\ValueObjectVisitorDispatcher;
+use Ibexa\Contracts\Rest\Output\ValueObjectVisitorResolver;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
  * Compiler pass for the ibexa.rest.output.value_object.visitor tag.
- * Maps an fully qualified class to a value object visitor.
+ * Maps a fully qualified class to a value object visitor.
  */
-class ValueObjectVisitorPass implements CompilerPassInterface
+final readonly class ValueObjectVisitorResolverPass implements CompilerPassInterface
 {
-    public const OUTPUT_VALUE_OBJECT_VISITOR_SERVICE_TAG = 'ibexa.rest.output.value_object.visitor';
+    public const string OUTPUT_VALUE_OBJECT_VISITOR_SERVICE_TAG = 'ibexa.rest.output.value_object.visitor';
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
-        if (!$container->hasDefinition(ValueObjectVisitorDispatcher::class)) {
+        if (!$container->hasDefinition(ValueObjectVisitorResolver::class)) {
             return;
         }
 
-        $definition = $container->getDefinition(ValueObjectVisitorDispatcher::class);
+        $definition = $container->getDefinition(ValueObjectVisitorResolver::class);
 
         $taggedServiceIds = $container->findTaggedServiceIds(
             self::OUTPUT_VALUE_OBJECT_VISITOR_SERVICE_TAG
         );
+
         foreach ($taggedServiceIds as $id => $attributes) {
             foreach ($attributes as $attribute) {
                 if (!isset($attribute['type'])) {

src/bundle/IbexaRestBundle.php

@@ -22,7 +22,7 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new Compiler\InputHandlerPass());
         $container->addCompilerPass(new Compiler\InputParserPass());
         $container->addCompilerPass(new Compiler\OutputVisitorPass());
-        $container->addCompilerPass(new Compiler\ValueObjectVisitorPass());
+        $container->addCompilerPass(new Compiler\ValueObjectVisitorResolverPass());
 
         if ($container->hasExtension('lexik_jwt_authentication')) {
             $container->addCompilerPass(new Compiler\LexikAuthorizationHeaderBridgePass());

src/bundle/Resources/config/services.yml

@@ -315,27 +315,31 @@ services:
     ibexa.rest.output.visitor.json:
         class: Ibexa\Contracts\Rest\Output\Visitor
         arguments:
-            - '@Ibexa\Rest\Output\Generator\Json'
-            - '@Ibexa\Contracts\Rest\Output\ValueObjectVisitorDispatcher'
+            $generator: '@Ibexa\Rest\Output\Generator\Json'
+            $normalizer: '@ibexa.rest.serializer'
+            $encoder: '@ibexa.rest.serializer.encoder.json'
+            $valueObjectVisitorResolver: '@Ibexa\Contracts\Rest\Output\ValueObjectVisitorResolver'
+            $format: 'json'
         tags:
             - { name: ibexa.rest.output.visitor, regexps: ibexa.rest.output.visitor.json.regexps }
 
     ibexa.rest.output.visitor.xml:
         class: Ibexa\Contracts\Rest\Output\Visitor
         arguments:
-            - '@Ibexa\Rest\Output\Generator\Xml'
-            - '@Ibexa\Contracts\Rest\Output\ValueObjectVisitorDispatcher'
+            $generator: '@Ibexa\Rest\Output\Generator\InMemory\Xml'
+            $normalizer: '@ibexa.rest.serializer'
+            $encoder: '@ibexa.rest.serializer.encoder.xml'
+            $valueObjectVisitorResolver: '@Ibexa\Contracts\Rest\Output\ValueObjectVisitorResolver'
+            $format: 'xml'
         tags:
             - { name: ibexa.rest.output.visitor, regexps: ibexa.rest.output.visitor.xml.regexps }
 
     # format output generators
-    Ibexa\Rest\Output\Generator\Xml:
+    Ibexa\Rest\Output\Generator\InMemory\Xml:
         arguments:
-            - '@Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator'
-        calls:
-            - [ setFormatOutput, [ "%kernel.debug%" ] ]
+            $fieldTypeHashGenerator: '@Ibexa\Rest\Output\Generator\InMemory\Xml\FieldTypeHashGenerator'
 
-    Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator:
+    Ibexa\Rest\Output\Generator\InMemory\Xml\FieldTypeHashGenerator:
         arguments:
             $normalizer: '@ibexa.rest.serializer'
             $logger: '@logger'
@@ -358,8 +362,6 @@ services:
             - { name: monolog.logger, channel: ibexa.rest }
 
     # value objects visitors
-    Ibexa\Contracts\Rest\Output\ValueObjectVisitorDispatcher: ~
-
     ibexa.rest.output.value_object_visitor.Exception.InvalidArgumentException:
         class: Ibexa\Rest\Server\Output\ValueObjectVisitor\InvalidArgumentException
         tags:
@@ -403,6 +405,38 @@ services:
         arguments:
             $parsingDispatcher: '@Ibexa\Contracts\Rest\Input\ParsingDispatcher'
 
+    ibexa.rest.serializer.encoder.json:
+        class: Symfony\Component\Serializer\Encoder\JsonEncoder
+        tags:
+            - ibexa.rest.serializer.encoder
+
+    ibexa.rest.serializer.encoder.xml:
+        class: Symfony\Component\Serializer\Encoder\XmlEncoder
+        tags:
+            - ibexa.rest.serializer.encoder
+
+    Ibexa\Contracts\Rest\Output\VisitorAdapterNormalizer:
+        arguments:
+            $valueObjectVisitorResolver: '@Ibexa\Contracts\Rest\Output\ValueObjectVisitorResolver'
+        tags:
+            - { name: ibexa.rest.serializer.normalizer, priority: -1000 }
+
+    Ibexa\Rest\Output\Normalizer\JsonObjectNormalizer:
+        tags:
+            - { name: ibexa.rest.serializer.normalizer, priority: -500 }
+
+    Ibexa\Rest\Output\Normalizer\ArrayListNormalizer:
+        tags:
+            - { name: ibexa.rest.serializer.normalizer, priority: -400 }
+
+    Ibexa\Rest\Output\Normalizer\ArrayObjectNormalizer:
+        tags:
+            - { name: ibexa.rest.serializer.normalizer, priority: -400 }
+
+    Ibexa\Contracts\Rest\Output\ValueObjectVisitorResolverInterface: '@Ibexa\Contracts\Rest\Output\ValueObjectVisitor'
+
+    Ibexa\Contracts\Rest\Output\ValueObjectVisitorResolver: ~
+
     Ibexa\Contracts\Rest\Input\Parser\Query\SortClause\BaseSortClauseProcessor:
         abstract: true
         arguments:

src/contracts/Output/Exceptions/AbstractExceptionVisitor.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
 namespace Ibexa\Contracts\Rest\Output\Exceptions;
 
 use Ibexa\Contracts\Rest\Output\Generator;

src/contracts/Output/Generator.php

@@ -416,4 +416,19 @@ protected function checkEnd($type, $data)
      * @return mixed
      */
     abstract public function serializeBool($boolValue);
+
+    public function getData(): object
+    {
+        throw new \LogicException(sprintf(
+            '%s does not maintain state',
+            static::class,
+        ));
+    }
+
+    /**
+     * @param array<mixed> $data
+     *
+     * @return array<mixed>
+     */
+    abstract public function getEncoderContext(array $data): array;
 }

src/contracts/Output/ValueObjectVisitorResolver.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Rest\Output;
+
+final class ValueObjectVisitorResolver implements ValueObjectVisitorResolverInterface
+{
+    /** @var array<class-string, ValueObjectVisitor> */
+    private array $visitors;
+
+    /**
+     * @param class-string $visitedClassName
+     */
+    public function addVisitor(string $visitedClassName, ValueObjectVisitor $visitor): void
+    {
+        $this->visitors[$visitedClassName] = $visitor;
+    }
+
+    public function resolveValueObjectVisitor(object $object): ?ValueObjectVisitor
+    {
+        $className = $object::class;
+
+        do {
+            if (isset($this->visitors[$className])) {
+                return $this->visitors[$className];
+            }
+        } while ($className = get_parent_class($className));
+
+        return null;
+    }
+}

src/contracts/Output/ValueObjectVisitorResolverInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Rest\Output;
+
+interface ValueObjectVisitorResolverInterface
+{
+    public function resolveValueObjectVisitor(object $object): ?ValueObjectVisitor;
+}