Merge release 3.22.1 into 3.23.x

composer.json

@@ -58,6 +58,7 @@
     "phpstan/phpstan": "^2.1.11",
     "phpstan/phpstan-phpunit": "^2.0",
     "phpunit/phpunit": "^11.5.15",
+    "symfony/cache": "^6.4.0 || ^7.0.0 || ^8.0.0",
     "symfony/messenger": "^5.4.31 || ^6.4.0 || ^7.0.1 || ^8.0.0",
     "symfony/var-dumper": "^5.4.29 || ^6.4.0 || ^7.0.0 || ^8.0.0",
     "wnx/commonmark-markdown-renderer": "^1.5.0"

src/Metadata/AggregateRoot/Psr16AggregateRootMetadataFactory.php

@@ -5,6 +5,7 @@
 namespace Patchlevel\EventSourcing\Metadata\AggregateRoot;
 
 use Patchlevel\EventSourcing\Aggregate\AggregateRoot;
+use Patchlevel\EventSourcing\Metadata\CacheKey;
 use Psr\SimpleCache\CacheInterface;
 
 final class Psr16AggregateRootMetadataFactory implements AggregateRootMetadataFactory
@@ -24,16 +25,15 @@ public function __construct(
      */
     public function metadata(string $aggregate): AggregateRootMetadata
     {
-        /** @var ?AggregateRootMetadata<T> $metadata */
-        $metadata = $this->cache->get($aggregate);
+        $metadata = $this->cache->get(CacheKey::forAggregateRoot($aggregate));
 
-        if ($metadata !== null) {
+        if ($metadata instanceof AggregateRootMetadata && $metadata->className === $aggregate) {
             return $metadata;
         }
 
         $metadata = $this->aggregateRootMetadataFactory->metadata($aggregate);
 
-        $this->cache->set($aggregate, $metadata);
+        $this->cache->set(CacheKey::forAggregateRoot($aggregate), $metadata);
 
         return $metadata;
     }

src/Metadata/AggregateRoot/Psr6AggregateRootMetadataFactory.php

@@ -5,6 +5,7 @@
 namespace Patchlevel\EventSourcing\Metadata\AggregateRoot;
 
 use Patchlevel\EventSourcing\Aggregate\AggregateRoot;
+use Patchlevel\EventSourcing\Metadata\CacheKey;
 use Psr\Cache\CacheItemPoolInterface;
 
 final class Psr6AggregateRootMetadataFactory implements AggregateRootMetadataFactory
@@ -24,13 +25,14 @@ public function __construct(
      */
     public function metadata(string $aggregate): AggregateRootMetadata
     {
-        $item = $this->cache->getItem($aggregate);
+        $item = $this->cache->getItem(CacheKey::forAggregateRoot($aggregate));
 
         if ($item->isHit()) {
-            /** @var AggregateRootMetadata<T> $data */
             $data = $item->get();
 
-            return $data;
+            if ($data instanceof AggregateRootMetadata && $data->className === $aggregate) {
+                return $data;
+            }
         }
 
         $metadata = $this->aggregateRootMetadataFactory->metadata($aggregate);

src/Metadata/CacheKey.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\EventSourcing\Metadata;
+
+use function hash;
+
+/**
+ * PSR-6 and PSR-16 reserve the characters {}()/\@: and only guarantee keys up to 64 characters,
+ * so class names are hashed instead of being used as they are.
+ * The prefix keeps the metadata types apart if they share the same cache.
+ *
+ * @internal
+ */
+final class CacheKey
+{
+    /** @param class-string $class */
+    public static function forAggregateRoot(string $class): string
+    {
+        return 'aggregate_root_metadata_' . hash('xxh128', $class);
+    }
+
+    /** @param class-string $class */
+    public static function forEvent(string $class): string
+    {
+        return 'event_metadata_' . hash('xxh128', $class);
+    }
+
+    /** @param class-string $class */
+    public static function forSubscriber(string $class): string
+    {
+        return 'subscriber_metadata_' . hash('xxh128', $class);
+    }
+}

src/Metadata/Event/Psr16EventMetadataFactory.php

@@ -4,6 +4,7 @@
 
 namespace Patchlevel\EventSourcing\Metadata\Event;
 
+use Patchlevel\EventSourcing\Metadata\CacheKey;
 use Psr\SimpleCache\CacheInterface;
 
 final class Psr16EventMetadataFactory implements EventMetadataFactory
@@ -17,16 +18,15 @@ public function __construct(
     /** @param class-string $event */
     public function metadata(string $event): EventMetadata
     {
-        /** @var ?EventMetadata $metadata */
-        $metadata = $this->cache->get($event);
+        $metadata = $this->cache->get(CacheKey::forEvent($event));
 
-        if ($metadata !== null) {
+        if ($metadata instanceof EventMetadata) {
             return $metadata;
         }
 
         $metadata = $this->eventMetadataFactory->metadata($event);
 
-        $this->cache->set($event, $metadata);
+        $this->cache->set(CacheKey::forEvent($event), $metadata);
 
         return $metadata;
     }

src/Metadata/Event/Psr6EventMetadataFactory.php

@@ -4,10 +4,9 @@
 
 namespace Patchlevel\EventSourcing\Metadata\Event;
 
+use Patchlevel\EventSourcing\Metadata\CacheKey;
 use Psr\Cache\CacheItemPoolInterface;
 
-use function assert;
-
 final class Psr6EventMetadataFactory implements EventMetadataFactory
 {
     public function __construct(
@@ -19,13 +18,14 @@ public function __construct(
     /** @param class-string $event */
     public function metadata(string $event): EventMetadata
     {
-        $item = $this->cache->getItem($event);
+        $item = $this->cache->getItem(CacheKey::forEvent($event));
 
         if ($item->isHit()) {
             $data = $item->get();
-            assert($data instanceof EventMetadata);
 
-            return $data;
+            if ($data instanceof EventMetadata) {
+                return $data;
+            }
         }
 
         $metadata = $this->eventMetadataFactory->metadata($event);

src/Metadata/Subscriber/Psr16SubscriberMetadataFactory.php

@@ -4,6 +4,7 @@
 
 namespace Patchlevel\EventSourcing\Metadata\Subscriber;
 
+use Patchlevel\EventSourcing\Metadata\CacheKey;
 use Psr\SimpleCache\CacheInterface;
 
 final class Psr16SubscriberMetadataFactory implements SubscriberMetadataFactory
@@ -17,16 +18,15 @@ public function __construct(
     /** @param class-string $subscriber */
     public function metadata(string $subscriber): SubscriberMetadata
     {
-        /** @var ?SubscriberMetadata $metadata */
-        $metadata = $this->cache->get($subscriber);
+        $metadata = $this->cache->get(CacheKey::forSubscriber($subscriber));
 
-        if ($metadata !== null) {
+        if ($metadata instanceof SubscriberMetadata) {
             return $metadata;
         }
 
         $metadata = $this->subscriberMetadataFactory->metadata($subscriber);
 
-        $this->cache->set($subscriber, $metadata);
+        $this->cache->set(CacheKey::forSubscriber($subscriber), $metadata);
 
         return $metadata;
     }