IBX-8190: Add Symfony's Serializer support

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

@@ -4,33 +4,35 @@
  * @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\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/DependencyInjection/IbexaRestExtension.php

@@ -43,6 +43,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $loader->load('input_parsers.yml');
         $loader->load('security.yml');
         $loader->load('default_settings.yml');
+        $loader->load('serializer.yaml');
 
         $processor = new ConfigurationProcessor($container, 'ibexa.site_access.config');
         $processor->mapConfigArray('rest_root_resources', $mergedConfig);

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/serializer.yaml

@@ -0,0 +1,39 @@
+services:
+    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:
+            $jsonEncoder: '@ibexa.rest.serializer.encoder.json'
+            $xmlEncoder: '@ibexa.rest.serializer.encoder.xml'
+            $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.rest.serializer.object_normalizer:
+        class: Symfony\Component\Serializer\Normalizer\ObjectNormalizer
+        tags:
+            - { name: ibexa.rest.serializer.normalizer, priority: -1000 }
+
+    Ibexa\Rest\Output\Normalizer\JsonSerializableNormalizer:
+        tags:
+            - { name: ibexa.rest.serializer.normalizer, priority: -1200 }

src/bundle/Resources/config/services.yml

@@ -149,7 +149,6 @@ services:
             - '@ibexa.api.service.section'
             - '@ibexa.api.repository'
             - '@Ibexa\Contracts\Core\Repository\PermissionResolver'
-            - '@Ibexa\Contracts\Core\Repository\ContentService\RelationListFacadeInterface'
         tags: [controller.service_arguments]
 
     Ibexa\Rest\Server\Controller\URLWildcard:
@@ -316,25 +315,29 @@ 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\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:
         arguments:
-            - '@Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator'
-        calls:
-            - [ setFormatOutput, [ "%kernel.debug%" ] ]
+            $fieldTypeHashGenerator: '@Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator'
 
     Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator:
         arguments:
@@ -359,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:
@@ -404,6 +405,10 @@ services:
         arguments:
             $parsingDispatcher: '@Ibexa\Contracts\Rest\Input\ParsingDispatcher'
 
+    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: