Get cache from MetadataFactory

Author: franmomu

CHANGELOG.md

@@ -30,6 +30,7 @@ a release.
 - Sluggable: Cast slug to string before passing it as argument 2 to `preg_match()` (#2473)
 - Sortable: [SortableGroup] Fix sorting date columns in SQLite (#2462).
 - PHPDoc of `AbstractMaterializedPath::removeNode()` and `AbstractMaterializedPath::getChildren()`
+- Retrieving the proper metadata cache from Doctrine when using a CacheWarmer.
 
 ## [3.7.0] - 2022-05-17
 ## Added

phpstan-baseline.neon

@@ -180,6 +180,11 @@ parameters:
 			count: 1
 			path: src/Mapping/MappedEventSubscriber.php
 
+		-
+			message: "#^Call to protected method getCache\\(\\) of class Doctrine\\\\Persistence\\\\Mapping\\\\AbstractClassMetadataFactory\\<Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\>\\.$#"
+			count: 1
+			path: src/Mapping/MappedEventSubscriber.php
+
 		-
 			message: "#^Call to an undefined method Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\:\\:getFieldMapping\\(\\)\\.$#"
 			count: 1

src/Mapping/MappedEventSubscriber.php

@@ -21,6 +21,7 @@
 use Doctrine\Common\EventSubscriber;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\Persistence\Mapping\AbstractClassMetadataFactory;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\Event\AdapterInterface;
@@ -291,8 +292,17 @@ private function getCacheItemPool(ObjectManager $objectManager): CacheItemPoolIn
             return $this->cacheItemPool;
         }
 
+        // TODO: The user should configure its own cache, we are using the one from Doctrine for BC. We should deprecate using
+        // the one from Doctrine when the bundle offers an easy way to configure this cache, otherwise users using the bundle
+        // will see lots of deprecations without an easy way to avoid them.
+
         if ($objectManager instanceof EntityManagerInterface || $objectManager instanceof DocumentManager) {
-            $metadataCache = $objectManager->getConfiguration()->getMetadataCache();
+            $metadataFactory = $objectManager->getMetadataFactory();
+            $getCache = \Closure::bind(static function (AbstractClassMetadataFactory $metadataFactory): ?CacheItemPoolInterface {
+                return $metadataFactory->getCache();
+            }, null, \get_class($metadataFactory));
+
+            $metadataCache = $getCache($metadataFactory);
 
             if (null !== $metadataCache) {
                 $this->cacheItemPool = $metadataCache;

src/Tree/Strategy/ORM/Closure.php

@@ -13,13 +13,15 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata as ORMClassMetadata;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\Persistence\Mapping\AbstractClassMetadataFactory;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\ObjectManager;
 use Gedmo\Exception\RuntimeException;
 use Gedmo\Mapping\Event\AdapterInterface;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
 use Gedmo\Tree\Strategy;
 use Gedmo\Tree\TreeListener;
+use Psr\Cache\CacheItemPoolInterface;
 
 /**
  * This strategy makes tree act like
@@ -194,16 +196,21 @@ public function processMetadataLoad($em, $meta)
         }
 
         if (!$hasTheUserExplicitlyDefinedMapping) {
-            $cacheDriver = $em->getConfiguration()->getMetadataCache();
+            $metadataFactory = $em->getMetadataFactory();
+            $getCache = \Closure::bind(static function (AbstractClassMetadataFactory $metadataFactory): ?CacheItemPoolInterface {
+                return $metadataFactory->getCache();
+            }, null, \get_class($metadataFactory));
 
-            if (null !== $cacheDriver) {
+            $metadataCache = $getCache($metadataFactory);
+
+            if (null !== $metadataCache) {
                 // @see https://github.com/doctrine/persistence/pull/144
                 // @see \Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::getCacheKey()
                 $cacheKey = str_replace('\\', '__', $closureMetadata->getName()).'__CLASSMETADATA__';
 
-                $item = $cacheDriver->getItem($cacheKey);
+                $item = $metadataCache->getItem($cacheKey);
 
-                $cacheDriver->save($item->set($closureMetadata));
+                $metadataCache->save($item->set($closureMetadata));
             }
         }
     }

tests/Gedmo/Mapping/MappingEventSubscriberTest.php

@@ -15,9 +15,11 @@
 use Doctrine\Common\EventManager;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
+use Doctrine\Persistence\Mapping\AbstractClassMetadataFactory;
 use Gedmo\Mapping\ExtensionMetadataFactory;
 use Gedmo\Sluggable\SluggableListener;
 use Gedmo\Tests\Mapping\Fixture\Sluggable;
+use Psr\Cache\CacheItemPoolInterface;
 
 final class MappingEventSubscriberTest extends ORMMappingTestCase
 {
@@ -42,9 +44,14 @@ protected function setUp(): void
         $this->em = EntityManager::create($conn, $config, new EventManager());
     }
 
-    public function testGetConfigurationCachedFromDoctrine(): void
+    public function testGetMetadataFactoryCacheFromDoctrine(): void
     {
-        $cache = $this->em->getConfiguration()->getMetadataCache();
+        $metadataFactory = $this->em->getMetadataFactory();
+        $getCache = \Closure::bind(static function (AbstractClassMetadataFactory $metadataFactory): ?CacheItemPoolInterface {
+            return $metadataFactory->getCache();
+        }, null, \get_class($metadataFactory));
+
+        $cache = $getCache($metadataFactory);
 
         $cacheKey = ExtensionMetadataFactory::getCacheId(Sluggable::class, 'Gedmo\Sluggable');