Merge pull request #300 from patchlevel/improve-hydrator-integration

add DatePoint & Uid normalizer and hydrator guesser injection

Author: DavidBadura

composer.json

@@ -20,6 +20,7 @@
   "require": {
     "php": "~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0",
     "patchlevel/event-sourcing": "^3.18.0",
+    "patchlevel/hydrator": "^1.18.0",
     "symfony/cache": "^6.4.0 || ^7.0.0 || ^8.0.0",
     "symfony/config": "^6.4.0 || ^7.0.0 || ^8.0.0",
     "symfony/console": "^6.4.1 || ^7.0.1 || ^8.0.0",
@@ -40,6 +41,7 @@
     "phpstan/phpstan-symfony": "^2.0.8",
     "phpunit/phpunit": "^11.5.45",
     "roave/security-advisories": "dev-master",
+    "symfony/clock": "^6.4.0 || ^7.0.0 || ^8.0.0",
     "symfony/uid": "^6.4.0 || ^7.0.0 || ^8.0.0",
     "symfony/var-dumper": "^6.4.0 || ^7.0.0 || ^8.0.0",
     "symfony/web-profiler-bundle": "^6.4.0 || ^7.0.0 || ^8.0.0",

composer.lock

@@ -496,11 +496,10 @@ patchlevel_event_sourcing:
             default_exceptions:
                 - Patchlevel\EventSourcing\Repository\AggregateOutdated
 ```
-
 !!! note
 
     You can find out more about instant retry [here](https://event-sourcing.patchlevel.io/latest/command_bus/#instant-retry).
-
+    
 ## Query Bus
 
 You can enable the query bus integration to use queries to retrieve data from your system. For this bundle we provide
@@ -675,13 +674,12 @@ patchlevel_event_sourcing:
     cryptography:
       use_encrypted_field_name: true
 ```
-
 !!! tip
 
     You should activate `use_encrypted_field_name` to mark the fields that are encrypted.
     That allows you later to migrate not encrypted fields to encrypted fields.
     If you have already encrypted fields, you can activate `fallback_to_field_name` to use the old field name as fallback.
-
+    
 If you want to use another algorithm, you can specify this here:
 
 ```yaml

docs/pages/configuration.md

@@ -153,28 +153,48 @@ This bundle adds more Symfony specific normalizers in addition to the existing b
 
     You can find the other build-in normalizers [here](https://event-sourcing.patchlevel.io/latest/normalizer/#built-in-normalizer)
 
-### Uuid
+!!! tip
+
+    The Hydrator can automatically determine the appropriate normalizer based on the data type and annotations.
+    You don't have to specify the normalizer manually like in the example below.
+    
+### Uid
 
-With the `Uuid` Normalizer, as the name suggests, you can convert Symfony Uuid objects to a string and back again.
+With the `Uid` Normalizer, as the name suggests, you can convert Symfony Uuid and Ulid objects to a string and back again.
 
 ```php
-use Patchlevel\EventSourcingBundle\Normalizer\SymfonyUuidNormalizer;
+use Patchlevel\EventSourcingBundle\Normalizer\UidNormalizer;
 use Symfony\Component\Uid\Uuid;
 
 final class DTO
 {
-    #[SymfonyUuidNormalizer]
+    #[UidNormalizer]
     public Uuid $id;
 }
 ```
 !!! warning
 
-    The symfony uuid don't implement the `AggregateId` interface, so it can be used as aggregate id.
+    The symfony uuid don't implement the `AggregateId` interface, so it can not be used as an aggregate id directly.
+    Use instead the `Patchlevel\EventSourcing\Aggregate\Uuid` class.
 
 !!! tip
 
     Use the `Uuid` implementation and `IdNormalizer` from the library to use it as an aggregate id.
 
+### DatePoint
+
+With the `DatePoint` Normalizer, you can convert a `DatePoint` object to a string and back again.
+
+```php
+use Patchlevel\EventSourcingBundle\Normalizer\DatePointNormalizer;
+use Symfony\Component\Clock\DatePoint;
+
+final class DTO
+{
+    #[DatePointNormalizer]
+    public DatePoint $createdAt;
+}
+```
 ## Upcasting
 
 ```php

docs/pages/usage.md

@@ -6,6 +6,7 @@
     <arg name="cache" value=".phpcs-cache"/>
 
     <file>src</file>
+    <file>tests</file>
 
     <rule ref="PatchlevelCodingStandard">
         <exclude name="Generic.Files.LineLength.TooLong" />

phpcs.xml.dist

@@ -18,6 +18,30 @@ parameters:
 			count: 1
 			path: src/DependencyInjection/QueryHandlerCompilerPass.php
 
+		-
+			message: '#^Method Patchlevel\\EventSourcingBundle\\Normalizer\\SymfonyGuesser\:\:guess\(\) has parameter \$type with generic class Symfony\\Component\\TypeInfo\\Type\\ObjectType but does not specify its types\: T$#'
+			identifier: missingType.generics
+			count: 1
+			path: src/Normalizer/SymfonyGuesser.php
+
+		-
+			message: '#^Parameter \#1 \$uidClass of class Patchlevel\\EventSourcingBundle\\Normalizer\\UidNormalizer constructor expects class\-string\<Symfony\\Component\\Uid\\AbstractUid\>\|null, string given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/Normalizer/SymfonyGuesser.php
+
+		-
+			message: '#^Property Patchlevel\\EventSourcingBundle\\Normalizer\\UidNormalizer\:\:\$uidClass \(class\-string\<Symfony\\Component\\Uid\\AbstractUid\>\|null\) does not accept string\.$#'
+			identifier: assign.propertyType
+			count: 1
+			path: src/Normalizer/UidNormalizer.php
+
+		-
+			message: '#^Method Fixtures\\DummyGuesser\:\:guess\(\) has parameter \$type with generic class Symfony\\Component\\TypeInfo\\Type\\ObjectType but does not specify its types\: T$#'
+			identifier: missingType.generics
+			count: 1
+			path: tests/Fixtures/DummyGuesser.php
+
 		-
 			message: '#^Property Patchlevel\\EventSourcingBundle\\Tests\\Fixtures\\Profile\:\:\$id is never read, only written\.$#'
 			identifier: property.onlyWritten

phpstan-baseline.neon

@@ -126,6 +126,7 @@
 use Patchlevel\EventSourcingBundle\DataCollector\MessageCollectorEventBus;
 use Patchlevel\EventSourcingBundle\Doctrine\DbalConnectionFactory;
 use Patchlevel\EventSourcingBundle\EventBus\SymfonyEventBus;
+use Patchlevel\EventSourcingBundle\Normalizer\SymfonyGuesser;
 use Patchlevel\EventSourcingBundle\QueryBus\SymfonyQueryBus;
 use Patchlevel\EventSourcingBundle\RequestListener\AutoSetupListener;
 use Patchlevel\EventSourcingBundle\RequestListener\SubscriptionRebuildAfterFileChangeListener;
@@ -140,6 +141,9 @@
 use Patchlevel\Hydrator\Cryptography\PayloadCryptographer;
 use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
+use Patchlevel\Hydrator\Guesser\BuiltInGuesser;
+use Patchlevel\Hydrator\Guesser\ChainGuesser;
+use Patchlevel\Hydrator\Guesser\Guesser;
 use Patchlevel\Hydrator\Hydrator;
 use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
 use Patchlevel\Hydrator\Metadata\MetadataFactory;
@@ -463,7 +467,10 @@ static function (ChildDefinition $definition): void {
                     continue;
                 }
 
-                throw new InvalidArgumentException(sprintf('Unknown retry strategy type "%s"', $strategyConfig['type']));
+                throw new InvalidArgumentException(sprintf(
+                    'Unknown retry strategy type "%s"',
+                    $strategyConfig['type'],
+                ));
             }
         }
 
@@ -617,7 +624,24 @@ static function (ChildDefinition $definition): void {
 
     private function configureHydrator(ContainerBuilder $container): void
     {
-        $container->register(AttributeMetadataFactory::class);
+        $container->register(ChainGuesser::class)
+            ->setArguments([new TaggedIteratorArgument('event_sourcing.hydrator.guesser')]);
+
+        $container->register(BuiltInGuesser::class)
+            ->addTag('event_sourcing.hydrator.guesser', ['priority' => -100]);
+
+        $container->register(SymfonyGuesser::class)
+            ->addTag('event_sourcing.hydrator.guesser', ['priority' => -50]);
+
+        $container->registerForAutoconfiguration(Guesser::class)
+            ->addTag('event_sourcing.hydrator.guesser');
+
+        $container->register(AttributeMetadataFactory::class)
+            ->setArguments([
+                null,
+                new Reference(ChainGuesser::class),
+            ]);
+
         $container->setAlias(MetadataFactory::class, AttributeMetadataFactory::class);
 
         $container->register(MetadataHydrator::class)

src/DependencyInjection/PatchlevelEventSourcingExtension.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcingBundle\Normalizer;
+
+use Attribute;
+use Patchlevel\Hydrator\Normalizer\InvalidArgument;
+use Patchlevel\Hydrator\Normalizer\Normalizer;
+use Symfony\Component\Clock\DatePoint;
+
+use function is_string;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class DatePointNormalizer implements Normalizer
+{
+    public function __construct(
+        private string $format = DatePoint::ATOM,
+    ) {
+    }
+
+    public function normalize(mixed $value): string|null
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (!$value instanceof DatePoint) {
+            throw InvalidArgument::withWrongType(DatePoint::class . '|null', $value);
+        }
+
+        return $value->format($this->format);
+    }
+
+    public function denormalize(mixed $value): DatePoint|null
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (!is_string($value)) {
+            throw InvalidArgument::withWrongType('string|null', $value);
+        }
+
+        return DatePoint::createFromFormat($this->format, $value);
+    }
+}

src/Normalizer/DatePointNormalizer.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcingBundle\Normalizer;
+
+use Patchlevel\Hydrator\Guesser\Guesser;
+use Patchlevel\Hydrator\Normalizer\Normalizer;
+use Symfony\Component\Clock\DatePoint;
+use Symfony\Component\TypeInfo\Type\ObjectType;
+use Symfony\Component\Uid\AbstractUid;
+
+final class SymfonyGuesser implements Guesser
+{
+    public function guess(ObjectType $type): Normalizer|null
+    {
+        if ($type->isIdentifiedBy(AbstractUid::class)) {
+            return new UidNormalizer($type->getClassName());
+        }
+
+        if ($type->isIdentifiedBy(DatePoint::class)) {
+            return new DatePointNormalizer();
+        }
+
+        return null;
+    }
+}

src/Normalizer/SymfonyGuesser.php

@@ -11,6 +11,7 @@
 
 use function is_string;
 
+/** @deprecated Use SymfonyUidNormalizer instead, which supports all Uid types, not just Uuid. */
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class SymfonyUuidNormalizer implements Normalizer
 {