Merge release 1.20.0 into 2.0.x

.github/workflows/backward-compatibility-check.yml

@@ -27,16 +27,16 @@ jobs:
           fetch-depth: 0
 
       - name: "Install PHP"
-        uses: "shivammathur/setup-php@2.36.0"
+        uses: "shivammathur/setup-php@2.37.0"
         with:
           php-version: "${{ matrix.php-version }}"
           ini-values: memory_limit=-1
 
-      - uses: ramsey/composer-install@3.2.0
+      - uses: ramsey/composer-install@4.0.0
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
-      - uses: ramsey/composer-install@3.2.0
+      - uses: ramsey/composer-install@4.0.0
         with:
           dependency-versions: ${{ matrix.dependencies }}
           working-directory: 'tools'

.github/workflows/benchmark.yml

@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: "Install PHP"
-        uses: "shivammathur/setup-php@2.36.0"
+        uses: "shivammathur/setup-php@2.37.0"
         with:
           coverage: "none"
           php-version: "${{ matrix.php-version }}"
@@ -33,7 +33,7 @@ jobs:
         with:
           ref: ${{ github.base_ref }}
 
-      - uses: ramsey/composer-install@3.2.0
+      - uses: ramsey/composer-install@4.0.0
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
@@ -45,7 +45,7 @@ jobs:
         with:
           clean: false
 
-      - uses: ramsey/composer-install@3.2.0
+      - uses: ramsey/composer-install@4.0.0
         with:
           dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/coding-standard.yml

@@ -29,12 +29,12 @@ jobs:
               uses: actions/checkout@v6
 
             - name: "Install PHP"
-              uses: "shivammathur/setup-php@2.36.0"
+              uses: "shivammathur/setup-php@2.37.0"
               with:
                   php-version: "${{ matrix.php-version }}"
                   ini-values: memory_limit=-1
 
-            - uses: ramsey/composer-install@3.2.0
+            - uses: ramsey/composer-install@4.0.0
               with:
                 dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/mutation-tests-diff.yml

@@ -27,13 +27,13 @@ jobs:
                   fetch-depth: 0
 
             - name: "Install PHP"
-              uses: "shivammathur/setup-php@2.36.0"
+              uses: "shivammathur/setup-php@2.37.0"
               with:
                   coverage: "pcov"
                   php-version: "${{ matrix.php-version }}"
                   ini-values: memory_limit=-1
 
-            - uses: ramsey/composer-install@3.2.0
+            - uses: ramsey/composer-install@4.0.0
               with:
                 dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/mutation-tests.yml

@@ -29,13 +29,13 @@ jobs:
               uses: actions/checkout@v6
 
             - name: "Install PHP"
-              uses: "shivammathur/setup-php@2.36.0"
+              uses: "shivammathur/setup-php@2.37.0"
               with:
                   coverage: "pcov"
                   php-version: "${{ matrix.php-version }}"
                   ini-values: memory_limit=-1
 
-            - uses: ramsey/composer-install@3.2.0
+            - uses: ramsey/composer-install@4.0.0
               with:
                 dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/phpstan.yml

@@ -29,12 +29,12 @@ jobs:
               uses: actions/checkout@v6
 
             - name: "Install PHP"
-              uses: "shivammathur/setup-php@2.36.0"
+              uses: "shivammathur/setup-php@2.37.0"
               with:
                   php-version: "${{ matrix.php-version }}"
                   ini-values: memory_limit=-1
 
-            - uses: ramsey/composer-install@3.2.0
+            - uses: ramsey/composer-install@4.0.0
               with:
                 dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/unit.yml

@@ -46,13 +46,13 @@ jobs:
               uses: actions/checkout@v6
 
             - name: "Install PHP"
-              uses: "shivammathur/setup-php@2.36.0"
+              uses: "shivammathur/setup-php@2.37.0"
               with:
                   coverage: "pcov"
                   php-version: "${{ matrix.php-version }}"
                   ini-values: memory_limit=-1
 
-            - uses: ramsey/composer-install@3.2.0
+            - uses: ramsey/composer-install@4.0.0
               with:
                 dependency-versions: ${{ matrix.dependencies }}
                 composer-options: ${{ matrix.composer-options }}

README.md

@@ -125,6 +125,24 @@ $oldEvent == $event // true
 > [!WARNING]
 > It is important to know that the constructor is not called!
 
+#### Object to populate
+
+If you want to hydrate an object that already exists, you can specify the object to populate.
+This is useful if you want to update an existing object.
+
+```php
+$dto = new Dto();
+
+$event = $hydrator->hydrate(
+    $dto::class,
+    [
+      'name' => 'patchlevel',
+    ], [
+        MetadataHydrator::OBJECT_TO_POPULATE => $dto,
+    ],
+);
+```
+
 ### Normalizer
 
 For more complex structures, i.e. non-scalar data types, we use normalizers.

phpstan-baseline.neon

@@ -114,6 +114,36 @@ parameters:
 			count: 3
 			path: src/Metadata/AttributeMetadataFactory.php
 
+		-
+			message: '#^Method Patchlevel\\Hydrator\\MetadataHydrator\:\:doHydrate\(\) should return T of object but returns mixed\.$#'
+			identifier: return.type
+			count: 1
+			path: src/MetadataHydrator.php
+
+		-
+			message: '#^Parameter \#1 \$object of method Patchlevel\\Hydrator\\Metadata\\CallbackMetadata\:\:invoke\(\) expects object, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/MetadataHydrator.php
+
+		-
+			message: '#^Parameter \#1 \$object of method Patchlevel\\Hydrator\\Metadata\\PropertyMetadata\:\:setValue\(\) expects object, mixed given\.$#'
+			identifier: argument.type
+			count: 2
+			path: src/MetadataHydrator.php
+
+		-
+			message: '#^Method Patchlevel\\Hydrator\\Middleware\\TransformMiddleware\:\:hydrate\(\) should return T of object but returns mixed\.$#'
+			identifier: return.type
+			count: 1
+			path: src/Middleware/TransformMiddleware.php
+
+		-
+			message: '#^Parameter \#1 \$object of method Patchlevel\\Hydrator\\Metadata\\PropertyMetadata\:\:setValue\(\) expects object, mixed given\.$#'
+			identifier: argument.type
+			count: 2
+			path: src/Middleware/TransformMiddleware.php
+
 		-
 			message: '#^Property Patchlevel\\Hydrator\\Normalizer\\EnumNormalizer\:\:\$enum \(class\-string\<BackedEnum\>\|null\) does not accept string\.$#'
 			identifier: assign.propertyType

src/Extension/Cryptography/CryptographyExtension.php

@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Cryptography;
 
+use Patchlevel\Hydrator\Cryptography\PayloadCryptographer;
 use Patchlevel\Hydrator\Extension;
 use Patchlevel\Hydrator\StackHydratorBuilder;
 
@@ -12,12 +13,19 @@ final class CryptographyExtension implements Extension
 {
     public function __construct(
         private readonly Cryptographer $cryptography,
+        private readonly PayloadCryptographer|null $legacyCryptographer = null,
     ) {
     }
 
     public function configure(StackHydratorBuilder $builder): void
     {
         $builder->addMetadataEnricher(new CryptographyMetadataEnricher(), 64);
         $builder->addMiddleware(new CryptographyMiddleware($this->cryptography), 64);
+
+        if ($this->legacyCryptographer === null) {
+            return;
+        }
+
+        $builder->addMiddleware(new LegacyCryptographyDecryptMiddleware($this->legacyCryptographer), 65);
     }
 }

src/Extension/Cryptography/CryptographyMiddleware.php

@@ -40,6 +40,12 @@ public function hydrate(ClassMetadata $metadata, array $data, array $context, St
     {
         $context[SubjectIds::class] = $subjectIds = $this->resolveSubjectIds($metadata, $data, $context);
 
+        if ($context[LegacyCryptographyDecryptMiddleware::class] ?? false) {
+            unset($context[LegacyCryptographyDecryptMiddleware::class]);
+
+            return $stack->next()->hydrate($metadata, $data, $context, $stack);
+        }
+
         foreach ($metadata->properties as $propertyMetadata) {
             $info = $propertyMetadata->extras[SensitiveDataInfo::class] ?? null;
 

src/Extension/Cryptography/LegacyCryptographyDecryptMiddleware.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Extension\Cryptography;
+
+use Patchlevel\Hydrator\Cryptography\PayloadCryptographer;
+use Patchlevel\Hydrator\Metadata\ClassMetadata;
+use Patchlevel\Hydrator\Middleware\Middleware;
+use Patchlevel\Hydrator\Middleware\Stack;
+
+/** @experimental */
+final readonly class LegacyCryptographyDecryptMiddleware implements Middleware
+{
+    public function __construct(
+        private PayloadCryptographer $payloadCryptographer,
+    ) {
+    }
+
+    /**
+     * @param ClassMetadata<T>     $metadata
+     * @param array<string, mixed> $data
+     * @param array<string, mixed> $context
+     *
+     * @return T
+     *
+     * @template T of object
+     */
+    public function hydrate(ClassMetadata $metadata, array $data, array $context, Stack $stack): object
+    {
+        $processedData = $this->payloadCryptographer->decrypt($metadata, $data);
+
+        if ($processedData !== $data) {
+            $context[self::class] = true;
+        }
+
+        return $stack->next()->hydrate($metadata, $processedData, $context, $stack);
+    }
+
+    /**
+     * @param ClassMetadata<T>     $metadata
+     * @param T                    $object
+     * @param array<string, mixed> $context
+     *
+     * @return array<string, mixed>
+     *
+     * @template T of object
+     */
+    public function extract(ClassMetadata $metadata, object $object, array $context, Stack $stack): array
+    {
+        return $stack->next()->extract($metadata, $object, $context, $stack);
+    }
+}

src/Extension/Cryptography/Store/Psr16CacheStoreDecorator.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Extension\Cryptography\Store;
+
+use DateInterval;
+use Patchlevel\Hydrator\Extension\Cryptography\Cipher\CipherKey;
+use Psr\SimpleCache\CacheInterface;
+
+final readonly class Psr16CacheStoreDecorator implements CipherKeyStore
+{
+    public function __construct(
+        private CipherKeyStore $cipherKeyStore,
+        private CacheInterface $cache,
+        private DateInterval|int|null $ttl = null,
+    ) {
+    }
+
+    public function currentKeyFor(string $subjectId): CipherKey
+    {
+        $key = 'subjectId:' . $subjectId;
+        $entry = $this->cache->get($key);
+
+        if ($entry instanceof CipherKey) {
+            return $entry;
+        }
+
+        $entry = $this->cipherKeyStore->currentKeyFor($subjectId);
+
+        $this->cache->set($key, $entry, $this->ttl);
+
+        return $entry;
+    }
+
+    public function get(string $id): CipherKey
+    {
+        $key = 'id:' . $id;
+        $entry = $this->cache->get($key);
+
+        if ($entry instanceof CipherKey) {
+            return $entry;
+        }
+
+        $entry = $this->cipherKeyStore->get($id);
+
+        $this->cache->set($key, $entry, $this->ttl);
+
+        return $entry;
+    }
+
+    public function store(CipherKey $key): void
+    {
+        $this->cipherKeyStore->store($key);
+
+        $this->cache->set('id:' . $key->id, $key, $this->ttl);
+        $this->cache->set('subjectId:' . $key->subjectId, $key, $this->ttl);
+    }
+
+    public function remove(string $id): void
+    {
+        $this->cipherKeyStore->remove($id);
+
+        $this->cache->delete('id:' . $id);
+    }
+
+    public function removeWithSubjectId(string $subjectId): void
+    {
+        $this->cipherKeyStore->removeWithSubjectId($subjectId);
+
+        $this->cache->delete('subjectId:' . $subjectId);
+    }
+}