update

Author: DavidBadura

composer.json

@@ -22,7 +22,7 @@
     "php": "~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0",
     "doctrine/dbal": "^4.0.0",
     "doctrine/migrations": "^3.3.2",
-    "patchlevel/hydrator": "^1.8.0",
+    "patchlevel/hydrator": "^2.0.x-dev",
     "patchlevel/worker": "^1.4.0",
     "psr/cache": "^2.0.0 || ^3.0.0",
     "psr/clock": "^1.0",

composer.lock

@@ -11,7 +11,7 @@ powered by the reliable Doctrine ecosystem and focused on developer experience.
 * Automatic [snapshot](snapshots.md)-system to boost your performance
 * [Split](split-stream.md) big aggregates into multiple streams
 * Versioned and managed lifecycle of [subscriptions](subscription.md) like projections and processors
-* Safe usage of [Personal Data](personal-data.md) with crypto-shredding
+* Safe usage of [Personal Data](sensitive-data.md) with crypto-shredding
 * Smooth [upcasting](upcasting.md) of old events
 * Simple setup with [scheme management](store.md) and [doctrine migration](store.md)
 * Built in [cli commands](cli.md) with [symfony](https://symfony.com/)

docs/index.md

@@ -101,7 +101,7 @@ final class CreateHotel
 ```
 
 :::note
-If you have personal data, you can use [crypto-shredding](personal-data.md).
+    If you have personal data, you can use [crypto-shredding](sensitive_data.md).
 :::
 
 ### Aggregate
@@ -472,4 +472,4 @@ final class DTO
 * [How to define aggregates](aggregate.md)
 * [How to define events](events.md)
 * [How to snapshot aggregates](snapshots.md)
-* [How to work with personal data](personal-data.md)
+* [How to work with personal data](sensitive-data.md)

docs/normalizer.md

@@ -1,4 +1,4 @@
-# Personal Data (GDPR)
+# Sensitive Data
 
 According to GDPR, personal data must be able to be deleted upon request.
 But here we have the problem that our events are immutable and we cannot easily manipulate the event store.
@@ -42,48 +42,47 @@ final class EmailChanged
 
 :::tip
 You can use the `DataSubjectId` in aggregates for snapshots too.
-:::
-
-### PersonalData
+:::    
+### SensitiveData
 
-Next, you have to mark the properties that should be encrypted with the `#[PersonalData]` attribute.
+Next, you have to mark the properties that should be encrypted with the `#[SensitiveData]` attribute.
 
 ```php
 use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 final class EmailChanged
 {
     public function __construct(
         #[DataSubjectId]
         public readonly Uuid $profileId,
-        #[PersonalData]
+        #[SensitiveData]
         public readonly string|null $email,
     ) {
     }
 }
 ```
 
 :::tip
-You can use the `PersonalData` in aggregates for snapshots too.
+You can use the `SensitiveData` in aggregates for snapshots too.
 :::
 
 If the information could not be decrypted, then a fallback value will be used.
 The default fallback value is `null`.
 You can change this by setting the `fallback` parameter or using the `fallbackCallable` parameter.
 
 ```php
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 final class ProfileChanged
 {
     public function __construct(
         #[DataSubjectId]
         public readonly Uuid $profileId,
-        #[PersonalData(fallback: 'unknown')]
+        #[SensitiveData(fallback: 'unknown')]
         public readonly string $name,
-        #[PersonalData(fallbackCallable: [self::class, 'createAnonymousEmail'])]
+        #[SensitiveData(fallbackCallable: [self::class, 'createAnonymousEmail'])]
         public readonly string $email,
     ) {
     }
@@ -147,10 +146,10 @@ Now we have to put the whole thing together in a Personal Data Payload Cryptogra
 
 ```php
 use Patchlevel\EventSourcing\Cryptography\Store\CipherKeyStore;
-use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
+use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 
 /** @var CipherKeyStore $cipherKeyStore */
-$cryptographer = PersonalDataPayloadCryptographer::createWithDefaultSettings($cipherKeyStore);
+$cryptographer = SensitiveDataPayloadCryptographer::createWithDefaultSettings($cipherKeyStore);
 ```
 
 :::tip
@@ -163,9 +162,9 @@ The last step is to integrate the cryptographer into the event store.
 
 ```php
 use Patchlevel\EventSourcing\Serializer\DefaultEventSerializer;
-use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
+use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 
-/** @var PersonalDataPayloadCryptographer $cryptographer */
+/** @var SensitiveDataPayloadCryptographer $cryptographer */
 DefaultEventSerializer::createFromPaths(
     [__DIR__ . '/Events'],
     cryptographer: $cryptographer,
@@ -182,9 +181,9 @@ And for the snapshot store.
 
 ```php
 use Patchlevel\EventSourcing\Snapshot\DefaultSnapshotStore;
-use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
+use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 
-/** @var PersonalDataPayloadCryptographer $cryptographer */
+/** @var SensitiveDataPayloadCryptographer $cryptographer */
 $snapshotStore = DefaultSnapshotStore::createDefault(
     [
         /* adapters... */
@@ -212,7 +211,7 @@ use Patchlevel\EventSourcing\Message\Message;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 
 #[Processor('delete_personal_data')]
-final class DeletePersonalDataProcessor
+final class DeleteSensitiveDataProcessor
 {
     public function __construct(
         private readonly CipherKeyStore $cipherKeyStore,

docs/personal-data.md docs/sensitive-data.mddocs/personal-data.md renamed to docs/sensitive-data.md

@@ -265,4 +265,4 @@ You still have to bring the aggregate up to date by loading the missing events f
 * [How to define aggregates](aggregate.md)
 * [How to store and load aggregates](repository.md)
 * [How to split streams](split-stream.md)
-* [How to work with personal data](personal-data.md)
+* [How to work with personal data](sensitive-data.md)

docs/snapshots.md

@@ -1,19 +1,19 @@
 parameters:
 	ignoreErrors:
 		-
-			message: '#^Cannot unset offset ''url'' on array\{application_name\?\: string, charset\?\: string, dbname\?\: string, defaultTableOptions\?\: array\<string, mixed\>, driver\?\: ''ibm_db2''\|''mysqli''\|''oci8''\|''pdo_mysql''\|''pdo_oci''\|''pdo_pgsql''\|''pdo_sqlite''\|''pdo_sqlsrv''\|''pgsql''\|''sqlite3''\|''sqlsrv'', driverClass\?\: class\-string\<Doctrine\\DBAL\\Driver\>, driverOptions\?\: array\<mixed\>, host\?\: string, \.\.\.\}\.$#'
+			message: '#^Cannot unset offset ''url'' on array\{application_name\?\: string, charset\?\: string, defaultTableOptions\?\: array\<string, mixed\>, driver\?\: ''ibm_db2''\|''mysqli''\|''oci8''\|''pdo_mysql''\|''pdo_oci''\|''pdo_pgsql''\|''pdo_sqlite''\|''pdo_sqlsrv''\|''pgsql''\|''sqlite3''\|''sqlsrv'', driverClass\?\: class\-string\<Doctrine\\DBAL\\Driver\>, driverOptions\?\: array\<mixed\>, host\?\: string, keepReplica\?\: bool, \.\.\.\}\.$#'
 			identifier: unset.offset
 			count: 1
 			path: src/Console/DoctrineHelper.php
 
 		-
-			message: '#^Parameter \#1 \$key of class Patchlevel\\Hydrator\\Cryptography\\Cipher\\CipherKey constructor expects non\-empty\-string, string given\.$#'
+			message: '#^Parameter \#1 \$key of class Patchlevel\\Hydrator\\Extension\\Cryptography\\Cipher\\CipherKey constructor expects non\-empty\-string, string given\.$#'
 			identifier: argument.type
 			count: 1
 			path: src/Cryptography/DoctrineCipherKeyStore.php
 
 		-
-			message: '#^Parameter \#3 \$iv of class Patchlevel\\Hydrator\\Cryptography\\Cipher\\CipherKey constructor expects non\-empty\-string, string given\.$#'
+			message: '#^Parameter \#3 \$iv of class Patchlevel\\Hydrator\\Extension\\Cryptography\\Cipher\\CipherKey constructor expects non\-empty\-string, string given\.$#'
 			identifier: argument.type
 			count: 1
 			path: src/Cryptography/DoctrineCipherKeyStore.php
@@ -174,12 +174,6 @@ parameters:
 			count: 1
 			path: tests/Benchmark/BasicImplementation/Projection/ProfileProjector.php
 
-		-
-			message: '#^Parameter \#1 \$messageLoader of class Patchlevel\\EventSourcing\\Subscription\\Engine\\DefaultSubscriptionEngine constructor expects Patchlevel\\EventSourcing\\Subscription\\Engine\\MessageLoader, Patchlevel\\EventSourcing\\Store\\StreamDoctrineDbalStore given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/Benchmark/CommandToQueryBench.php
-
 		-
 			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with ''Patchlevel\\\\EventSourcing\\\\Tests\\\\Integration\\\\BankAccountSplitStream\\\\BankAccount'' and Patchlevel\\EventSourcing\\Tests\\Integration\\BankAccountSplitStream\\BankAccount will always evaluate to true\.$#'
 			identifier: staticMethod.alreadyNarrowedType
@@ -228,30 +222,6 @@ parameters:
 			count: 1
 			path: tests/Integration/BasicImplementation/BasicIntegrationTest.php
 
-		-
-			message: '#^Instantiated class Patchlevel\\EventSourcing\\Tests\\Integration\\BasicImplementation\\DoctrineDbalStore not found\.$#'
-			identifier: class.notFound
-			count: 1
-			path: tests/Integration/BasicImplementation/BasicIntegrationTest.php
-
-		-
-			message: '#^Parameter \#1 \$messageLoader of class Patchlevel\\EventSourcing\\Subscription\\Engine\\DefaultSubscriptionEngine constructor expects Patchlevel\\EventSourcing\\Subscription\\Engine\\MessageLoader, Patchlevel\\EventSourcing\\Tests\\Integration\\BasicImplementation\\DoctrineDbalStore given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/Integration/BasicImplementation/BasicIntegrationTest.php
-
-		-
-			message: '#^Parameter \#2 \$schemaConfigurator of class Patchlevel\\EventSourcing\\Schema\\DoctrineSchemaDirector constructor expects Patchlevel\\EventSourcing\\Schema\\DoctrineSchemaConfigurator, Patchlevel\\EventSourcing\\Tests\\Integration\\BasicImplementation\\DoctrineDbalStore given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/Integration/BasicImplementation/BasicIntegrationTest.php
-
-		-
-			message: '#^Parameter \#2 \$store of class Patchlevel\\EventSourcing\\Repository\\DefaultRepositoryManager constructor expects Patchlevel\\EventSourcing\\Store\\Store, Patchlevel\\EventSourcing\\Tests\\Integration\\BasicImplementation\\DoctrineDbalStore given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/Integration/BasicImplementation/BasicIntegrationTest.php
-
 		-
 			message: '#^Cannot access offset ''name'' on array\<string, mixed\>\|false\.$#'
 			identifier: offsetAccess.nonOffsetAccessible
@@ -276,24 +246,6 @@ parameters:
 			count: 1
 			path: tests/Integration/MicroAggregate/Profile.php
 
-		-
-			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertArrayHasKey\(\) with 0 and array\{array\<string, mixed\>\} will always evaluate to true\.$#'
-			identifier: staticMethod.alreadyNarrowedType
-			count: 1
-			path: tests/Integration/PersonalData/PersonalDataTest.php
-
-		-
-			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with ''Patchlevel\\\\EventSourcing\\\\Tests\\\\Integration\\\\PersonalData\\\\Profile'' and Patchlevel\\EventSourcing\\Tests\\Integration\\PersonalData\\Profile will always evaluate to true\.$#'
-			identifier: staticMethod.alreadyNarrowedType
-			count: 6
-			path: tests/Integration/PersonalData/PersonalDataTest.php
-
-		-
-			message: '#^Parameter \#2 \$haystack of static method PHPUnit\\Framework\\Assert\:\:assertStringNotContainsString\(\) expects string, mixed given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/Integration/PersonalData/PersonalDataTest.php
-
 		-
 			message: '#^Property Patchlevel\\EventSourcing\\Tests\\Integration\\Store\\Profile\:\:\$id is never read, only written\.$#'
 			identifier: property.onlyWritten

phpstan-baseline.neon

@@ -8,10 +8,10 @@
 use Doctrine\DBAL\Schema\Schema;
 use Patchlevel\EventSourcing\Schema\DoctrineHelper;
 use Patchlevel\EventSourcing\Schema\DoctrineSchemaConfigurator;
-use Patchlevel\Hydrator\Cryptography\Cipher\CipherKey;
-use Patchlevel\Hydrator\Cryptography\Store\CipherKeyNotExists;
-use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 
+use Patchlevel\Hydrator\Extension\Cryptography\Cipher\CipherKey;
+use Patchlevel\Hydrator\Extension\Cryptography\Store\CipherKeyNotExists;
+use Patchlevel\Hydrator\Extension\Cryptography\Store\CipherKeyStore;
 use function array_key_exists;
 use function base64_decode;
 use function base64_encode;

src/Cryptography/DoctrineCipherKeyStore.php

@@ -17,8 +17,8 @@ final class DefaultHeadersSerializer implements HeadersSerializer
 {
     public function __construct(
         private readonly MessageHeaderRegistry $messageHeaderRegistry,
-        private readonly Hydrator $hydrator,
-        private readonly Encoder $encoder,
+        private readonly Hydrator $hydrator = new MetadataHydrator(),
+        private readonly Encoder $encoder = new JsonEncoder(),
     ) {
     }
 
@@ -61,20 +61,22 @@ public function deserialize(string $string, array $options = []): array
     }
 
     /** @param list<string> $paths */
-    public static function createFromPaths(array $paths): static
-    {
+    public static function createFromPaths(
+        array $paths,
+        Hydrator $hydrator = new MetadataHydrator(),
+    ): static {
         return new self(
             (new AttributeMessageHeaderRegistryFactory())->create($paths),
-            new MetadataHydrator(),
+            $hydrator,
             new JsonEncoder(),
         );
     }
 
-    public static function createDefault(): static
+    public static function createDefault(Hydrator $hydrator = new MetadataHydrator()): static
     {
         return new self(
             MessageHeaderRegistry::createWithInternalHeaders(),
-            new MetadataHydrator(),
+            $hydrator,
             new JsonEncoder(),
         );
     }

src/Message/Serializer/DefaultHeadersSerializer.php

@@ -8,27 +8,30 @@
 use Patchlevel\EventSourcing\Metadata\Event\EventRegistry;
 use Patchlevel\EventSourcing\Serializer\Encoder\Encoder;
 use Patchlevel\EventSourcing\Serializer\Encoder\JsonEncoder;
-use Patchlevel\EventSourcing\Serializer\Upcast\Upcast;
-use Patchlevel\EventSourcing\Serializer\Upcast\Upcaster;
-use Patchlevel\Hydrator\Cryptography\PayloadCryptographer;
 use Patchlevel\Hydrator\Hydrator;
 use Patchlevel\Hydrator\MetadataHydrator;
 
 final class DefaultEventSerializer implements EventSerializer
 {
+    public const CONTEXT_EVENT_NAME = 'event_name';
+    public const CONTEXT_EVENT_CLASS = 'event_class';
+
     public function __construct(
         private EventRegistry $eventRegistry,
         private Hydrator $hydrator = new MetadataHydrator(),
         private Encoder $encoder = new JsonEncoder(),
-        private Upcaster|null $upcaster = null,
     ) {
     }
 
     /** @param array<string, mixed> $options */
     public function serialize(object $event, array $options = []): SerializedEvent
     {
         $name = $this->eventRegistry->eventName($event::class);
-        $data = $this->hydrator->extract($event);
+
+        $data = $this->hydrator->extract($event, [
+            self::CONTEXT_EVENT_NAME => $name,
+            self::CONTEXT_EVENT_CLASS => $event::class,
+        ]);
 
         return new SerializedEvent(
             $name,
@@ -40,30 +43,23 @@ public function serialize(object $event, array $options = []): SerializedEvent
     public function deserialize(SerializedEvent $data, array $options = []): object
     {
         $payload = $this->encoder->decode($data->payload, $options);
+        $class = $this->eventRegistry->eventClass($data->name);
 
-        $eventName = $data->name;
-        if ($this->upcaster) {
-            $upcast = ($this->upcaster)(new Upcast($data->name, $payload));
-            $eventName = $upcast->eventName;
-            $payload = $upcast->payload;
-        }
-
-        $class = $this->eventRegistry->eventClass($eventName);
-
-        return $this->hydrator->hydrate($class, $payload);
+        return $this->hydrator->hydrate($class, $payload, [
+            self::CONTEXT_EVENT_NAME => $data->name,
+            self::CONTEXT_EVENT_CLASS => $class,
+        ]);
     }
 
     /** @param list<string> $paths */
     public static function createFromPaths(
         array $paths,
-        Upcaster|null $upcaster = null,
-        PayloadCryptographer|null $cryptographer = null,
+        Hydrator $hydrator = new MetadataHydrator(),
     ): static {
         return new self(
             (new AttributeEventRegistryFactory())->create($paths),
-            new MetadataHydrator(cryptographer: $cryptographer),
+            $hydrator,
             new JsonEncoder(),
-            $upcaster,
         );
     }
 }