upgrade hydrator 2.0

DavidBadura · DavidBadura · commit 28d5d9e9ce4e · 2025-11-16T21:00:32.000+01:00
diff --git a/composer.json b/composer.json
@@ -22,7 +22,7 @@
     "php": "~8.2.0 || ~8.3.0 || ~8.4.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",
diff --git a/composer.lock b/composer.lock
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -105,7 +105,7 @@ nav:
     - Identifier: identifier.md
     - Normalizer: normalizer.md
     - Snapshots: snapshots.md
-    - Personal Data: personal_data.md
+    - Sensitive Data: sensitive_data.md
     - Upcasting: upcasting.md
     - Message Decorator: message_decorator.md
     - Split Stream: split_stream.md
diff --git a/docs/pages/index.md b/docs/pages/index.md
@@ -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/)
diff --git a/docs/pages/normalizer.md b/docs/pages/normalizer.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
 
@@ -459,4 +459,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)
diff --git a/docs/pages/sensitive_data.md b/docs/pages/sensitive_data.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.
@@ -43,45 +43,45 @@ final class EmailChanged
 
     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,
     ) {
     }
@@ -144,10 +144,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
 
@@ -159,9 +159,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,
@@ -177,9 +177,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... */
@@ -206,7 +206,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,
diff --git a/docs/pages/snapshots.md b/docs/pages/snapshots.md
@@ -261,4 +261,4 @@ And if the version is no longer correct and the snapshot is therefore invalid, t
 * [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)
diff --git a/tests/Integration/SensitiveData/Events/NameChanged.php b/tests/Integration/SensitiveData/Events/NameChanged.php
@@ -2,20 +2,20 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events;
 
 use Patchlevel\EventSourcing\Attribute\Event;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\ProfileId;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\ProfileId;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 #[Event('profile.name_changed')]
 final class NameChanged
 {
     public function __construct(
         #[DataSubjectId]
         public readonly ProfileId $aggregateId,
-        #[PersonalData(fallback: 'unknown')]
+        #[SensitiveData(fallback: 'unknown')]
         public readonly string $name,
     ) {
     }
diff --git a/tests/Integration/SensitiveData/Events/PersonalDataRemoved.php b/tests/Integration/SensitiveData/Events/PersonalDataRemoved.php
@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events;
 
 use Patchlevel\EventSourcing\Attribute\Event;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\ProfileId;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\ProfileId;
 
 #[Event('profile.personal_data_removed')]
 final class PersonalDataRemoved
diff --git a/tests/Integration/SensitiveData/Events/ProfileCreated.php b/tests/Integration/SensitiveData/Events/ProfileCreated.php
@@ -2,20 +2,20 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events;
 
 use Patchlevel\EventSourcing\Attribute\Event;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\ProfileId;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\ProfileId;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 #[Event('profile.created')]
 final class ProfileCreated
 {
     public function __construct(
         #[DataSubjectId]
         public ProfileId $profileId,
-        #[PersonalData(fallback: 'unknown')]
+        #[SensitiveData(fallback: 'unknown')]
         public string $name,
     ) {
     }
diff --git a/tests/Integration/SensitiveData/Processor/DeletePersonalDataProcessor.php b/tests/Integration/SensitiveData/Processor/DeletePersonalDataProcessor.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData\Processor;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Processor;
 
 use Patchlevel\EventSourcing\Attribute\Processor;
 use Patchlevel\EventSourcing\Attribute\Subscribe;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events\PersonalDataRemoved;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events\PersonalDataRemoved;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 
 #[Processor('delete_personal_data')]
diff --git a/tests/Integration/SensitiveData/Profile.php b/tests/Integration/SensitiveData/Profile.php
@@ -2,18 +2,18 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData;
 
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
 use Patchlevel\EventSourcing\Attribute\Snapshot;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events\NameChanged;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events\PersonalDataRemoved;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\Events\ProfileCreated;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events\NameChanged;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events\PersonalDataRemoved;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Events\ProfileCreated;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 #[Aggregate('profile')]
 #[Snapshot('default', 2)]
@@ -23,7 +23,7 @@ final class Profile extends BasicAggregateRoot
     #[DataSubjectId]
     private ProfileId $id;
 
-    #[PersonalData(fallback: 'unknown')]
+    #[SensitiveData(fallback: 'unknown')]
     private string $name;
 
     public static function create(ProfileId $id, string $name): self
diff --git a/tests/Integration/SensitiveData/ProfileId.php b/tests/Integration/SensitiveData/ProfileId.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData;
 
 use Patchlevel\EventSourcing\Identifier\Identifier;
 use Patchlevel\EventSourcing\Identifier\RamseyUuidV7Behaviour;
diff --git a/tests/Integration/SensitiveData/SensitiveDataTest.php b/tests/Integration/SensitiveData/SensitiveDataTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Patchlevel\EventSourcing\Tests\Integration\PersonalData;
+namespace Patchlevel\EventSourcing\Tests\Integration\SensitiveData;
 
 use Doctrine\DBAL\Connection;
 use Patchlevel\EventSourcing\Cryptography\DoctrineCipherKeyStore;
@@ -19,13 +19,13 @@
 use Patchlevel\EventSourcing\Subscription\Store\DoctrineSubscriptionStore;
 use Patchlevel\EventSourcing\Subscription\Subscriber\MetadataSubscriberAccessorRepository;
 use Patchlevel\EventSourcing\Tests\DbalManager;
-use Patchlevel\EventSourcing\Tests\Integration\PersonalData\Processor\DeletePersonalDataProcessor;
-use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
+use Patchlevel\EventSourcing\Tests\Integration\SensitiveData\Processor\DeletePersonalDataProcessor;
+use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 use PHPUnit\Framework\Attributes\CoversNothing;
 use PHPUnit\Framework\TestCase;
 
 #[CoversNothing]
-final class PersonalDataTest extends TestCase
+final class SensitiveDataTest extends TestCase
 {
     private Connection $connection;
 
@@ -42,7 +42,7 @@ public function tearDown(): void
     public function testSuccessfulWithEvent(): void
     {
         $cipherKeyStore = new DoctrineCipherKeyStore($this->connection);
-        $cryptographer = PersonalDataPayloadCryptographer::createWithOpenssl($cipherKeyStore);
+        $cryptographer = SensitiveDataPayloadCryptographer::createWithOpenssl($cipherKeyStore);
 
         $store = new StreamDoctrineDbalStore(
             $this->connection,
@@ -91,7 +91,7 @@ public function testSuccessfulWithEvent(): void
     public function testRemoveKeyWithEvent(): void
     {
         $cipherKeyStore = new DoctrineCipherKeyStore($this->connection);
-        $cryptographer = PersonalDataPayloadCryptographer::createWithOpenssl($cipherKeyStore);
+        $cryptographer = SensitiveDataPayloadCryptographer::createWithOpenssl($cipherKeyStore);
 
         $subscriptionStore = new DoctrineSubscriptionStore(
             $this->connection,
@@ -166,7 +166,7 @@ public function testRemoveKeyWithEvent(): void
     public function testRemoveKeyWithEventAndSnapshot(): void
     {
         $cipherKeyStore = new DoctrineCipherKeyStore($this->connection);
-        $cryptographer = PersonalDataPayloadCryptographer::createWithOpenssl($cipherKeyStore);
+        $cryptographer = SensitiveDataPayloadCryptographer::createWithOpenssl($cipherKeyStore);
 
         $subscriptionStore = new DoctrineSubscriptionStore(
             $this->connection,
