Merge branch '4.4' into main

Author: Steveb-p

src/bundle/Resources/config/services.yml

@@ -8,6 +8,16 @@ parameters:
         - '(^.*/.*$)'
 
 services:
+    Ibexa\Bundle\Rest\Serializer\SerializerFactory:
+        arguments:
+            - !tagged_iterator 'ibexa.rest.serializer.normalizer'
+            - !tagged_iterator 'ibexa.rest.serializer.encoder'
+
+    ibexa.rest.serializer:
+        class: Symfony\Component\Serializer\Serializer
+        autoconfigure: false
+        factory: [ '@Ibexa\Bundle\Rest\Serializer\SerializerFactory', 'create' ]
+
     Ibexa\Bundle\Rest\Routing\OptionsLoader:
         arguments:
             - '@Ibexa\Bundle\Rest\Routing\OptionsLoader\RouteCollectionMapper'
@@ -308,15 +318,25 @@ services:
         calls:
             - [ setFormatOutput, [ "%kernel.debug%" ] ]
 
-    Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator: ~
+    Ibexa\Rest\Output\Generator\Xml\FieldTypeHashGenerator:
+        arguments:
+            $normalizer: '@ibexa.rest.serializer'
+            $logger: '@logger'
+        tags:
+            - { name: monolog.logger, channel: ibexa.rest }
 
     Ibexa\Rest\Output\Generator\Json:
         arguments:
             - '@Ibexa\Rest\Output\Generator\Json\FieldTypeHashGenerator'
         calls:
             - [ setFormatOutput, [ "%kernel.debug%" ] ]
 
-    Ibexa\Rest\Output\Generator\Json\FieldTypeHashGenerator: ~
+    Ibexa\Rest\Output\Generator\Json\FieldTypeHashGenerator:
+        arguments:
+            $normalizer: '@ibexa.rest.serializer'
+            $logger: '@logger'
+        tags:
+            - { name: monolog.logger, channel: ibexa.rest }
 
     # value objects visitors
     Ibexa\Contracts\Rest\Output\ValueObjectVisitorDispatcher: ~

src/bundle/Serializer/SerializerFactory.php

@@ -0,0 +1,50 @@
+<?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\Bundle\Rest\Serializer;
+
+use Symfony\Component\Serializer\Serializer;
+use Traversable;
+
+final class SerializerFactory
+{
+    /**
+     * @var iterable<\Symfony\Component\Serializer\Normalizer\NormalizerInterface|\Symfony\Component\Serializer\Normalizer\DenormalizerInterface>
+     */
+    private iterable $normalizers;
+
+    /**
+     * @var iterable<\Symfony\Component\Serializer\Encoder\EncoderInterface|\Symfony\Component\Serializer\Encoder\DecoderInterface>
+     */
+    private iterable $encoders;
+
+    /**
+     * @param iterable<\Symfony\Component\Serializer\Normalizer\NormalizerInterface|\Symfony\Component\Serializer\Normalizer\DenormalizerInterface> $normalizers
+     * @param iterable<\Symfony\Component\Serializer\Encoder\EncoderInterface|\Symfony\Component\Serializer\Encoder\DecoderInterface> $encoders
+     */
+    public function __construct(iterable $normalizers, iterable $encoders)
+    {
+        $this->normalizers = $normalizers;
+        $this->encoders = $encoders;
+    }
+
+    public function create(): Serializer
+    {
+        $normalizers = $this->normalizers;
+        if ($normalizers instanceof Traversable) {
+            $normalizers = iterator_to_array($normalizers);
+        }
+
+        $encoders = $this->encoders;
+        if ($encoders instanceof Traversable) {
+            $encoders = iterator_to_array($encoders);
+        }
+
+        return new Serializer($normalizers, $encoders);
+    }
+}

src/lib/Output/Generator/Json/FieldTypeHashGenerator.php

@@ -6,8 +6,27 @@
  */
 namespace Ibexa\Rest\Output\Generator\Json;
 
-class FieldTypeHashGenerator
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\Serializer\Exception\ExceptionInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class FieldTypeHashGenerator implements LoggerAwareInterface
 {
+    use LoggerAwareTrait;
+
+    private NormalizerInterface $normalizer;
+
+    public function __construct(
+        NormalizerInterface $normalizer,
+        ?LoggerInterface $logger = null
+    ) {
+        $this->normalizer = $normalizer;
+        $this->logger = $logger ?? new NullLogger();
+    }
+
     /**
      * Generates the field type value $hashValue as a child of the given Object
      * using $hashElementName as the property name.
@@ -32,24 +51,20 @@ public function generateHashValue($parent, $hashElementName, $hashValue)
      */
     protected function generateValue($parent, $value)
     {
-        switch (($hashValueType = gettype($value))) {
-            case 'NULL':
-            case 'boolean':
-            case 'integer':
-            case 'double':
-            case 'string':
-
-                // Will be handled accordingly on serialization
-                return $value;
-                break;
-
-            case 'array':
-                return $this->generateArrayValue($parent, $value);
-                break;
-
-            default:
-                throw new \Exception('Invalid type in Field value hash: ' . $hashValueType);
+        if ($value === null || is_scalar($value)) {
+            // Will be handled accordingly on serialization
+            return $value;
         }
+
+        if (is_array($value)) {
+            return $this->generateArrayValue($parent, $value);
+        }
+
+        if (is_object($value)) {
+            return $this->generateObjectValue($parent, $value);
+        }
+
+        throw new \Exception('Invalid type in Field value hash: ' . get_debug_type($value));
     }
 
     /**
@@ -126,6 +141,33 @@ protected function isNumericArray(array $value)
 
         return true;
     }
+
+    /**
+     * @param \Ibexa\Rest\Output\Generator\Json\ArrayObject|\Ibexa\Rest\Output\Generator\Json\JsonObject $parent
+     *
+     * @return mixed
+     */
+    private function generateObjectValue($parent, object $value)
+    {
+        try {
+            $value = $this->normalizer->normalize($value, 'json', ['parent' => $parent]);
+        } catch (ExceptionInterface $e) {
+            $message = sprintf(
+                'Unable to normalize value for type "%s". %s. '
+                . 'Ensure that a normalizer is registered with tag: "%s".',
+                get_class($value),
+                $e->getMessage(),
+                'ibexa.rest.serializer.normalizer',
+            );
+            $this->logger->error($message, [
+                'exception' => $e,
+            ]);
+
+            $value = null;
+        }
+
+        return $this->generateValue($parent, $value);
+    }
 }
 
 class_alias(FieldTypeHashGenerator::class, 'EzSystems\EzPlatformRest\Output\Generator\Json\FieldTypeHashGenerator');

src/lib/Output/Generator/Xml/FieldTypeHashGenerator.php

@@ -6,8 +6,27 @@
  */
 namespace Ibexa\Rest\Output\Generator\Xml;
 
-class FieldTypeHashGenerator
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\Serializer\Exception\ExceptionInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class FieldTypeHashGenerator implements LoggerAwareInterface
 {
+    use LoggerAwareTrait;
+
+    private NormalizerInterface $normalizer;
+
+    public function __construct(
+        NormalizerInterface $normalizer,
+        ?LoggerInterface $logger = null
+    ) {
+        $this->normalizer = $normalizer;
+        $this->logger = $logger ?? new NullLogger();
+    }
+
     /**
      * Generates the field type value $hashValue into the $writer creating an
      * element with $hashElementName as its parent.
@@ -31,33 +50,22 @@ public function generateHashValue(\XMLWriter $writer, $hashElementName, $hashVal
      */
     protected function generateValue(\XmlWriter $writer, $value, $key = null, $elementName = 'value')
     {
-        switch (($hashValueType = gettype($value))) {
-            case 'NULL':
-                $this->generateNullValue($writer, $key, $elementName);
-                break;
-
-            case 'boolean':
-                $this->generateBooleanValue($writer, $value, $key, $elementName);
-                break;
-
-            case 'integer':
-                $this->generateIntegerValue($writer, $value, $key, $elementName);
-                break;
-
-            case 'double':
-                $this->generateFloatValue($writer, $value, $key, $elementName);
-                break;
-
-            case 'string':
-                $this->generateStringValue($writer, $value, $key, $elementName);
-                break;
-
-            case 'array':
-                $this->generateArrayValue($writer, $value, $key, $elementName);
-                break;
-
-            default:
-                throw new \Exception('Invalid type in Field value hash: ' . $hashValueType);
+        if ($value === null) {
+            $this->generateNullValue($writer, $key, $elementName);
+        } elseif (is_bool($value)) {
+            $this->generateBooleanValue($writer, $value, $key, $elementName);
+        } elseif (is_int($value)) {
+            $this->generateIntegerValue($writer, $value, $key, $elementName);
+        } elseif (is_float($value)) {
+            $this->generateFloatValue($writer, $value, $key, $elementName);
+        } elseif (is_string($value)) {
+            $this->generateStringValue($writer, $value, $key, $elementName);
+        } elseif (is_array($value)) {
+            $this->generateArrayValue($writer, $value, $key, $elementName);
+        } elseif (is_object($value)) {
+            $this->generateObjectValue($value, $writer, $key, $elementName);
+        } else {
+            throw new \Exception('Invalid type in Field value hash: ' . get_debug_type($value));
         }
     }
 
@@ -229,6 +237,26 @@ protected function generateKeyAttribute(\XmlWriter $writer, $key = null)
             $writer->endAttribute();
         }
     }
+
+    private function generateObjectValue(object $value, \XmlWriter $writer, ?string $key, string $elementName): void
+    {
+        try {
+            $value = $this->normalizer->normalize($value, 'xml');
+        } catch (ExceptionInterface $e) {
+            $message = sprintf(
+                'Unable to normalize value for type "%s". %s. '
+                . 'Ensure that a normalizer is registered with tag: "%s".',
+                get_class($value),
+                $e->getMessage(),
+                'ibexa.rest.serializer.normalizer',
+            );
+            $this->logger->error($message, [
+                'exception' => $e,
+            ]);
+            $value = null;
+        }
+        $this->generateValue($writer, $value, $key, $elementName);
+    }
 }
 
 class_alias(FieldTypeHashGenerator::class, 'EzSystems\EzPlatformRest\Output\Generator\Xml\FieldTypeHashGenerator');