[Cache] Deprecate DoctrineProvider

derrabus · fabpot · commit 16fccfa6bdb4 · 2021-07-04T14:16:52.000+02:00
diff --git a/UPGRADE-5.4.md b/UPGRADE-5.4.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 5.3 to 5.4
 =======================
 
+Cache
+-----
+
+ * Deprecate `DoctrineProvider` because this class has been added to the `doctrine/cache` package`
+
 FrameworkBundle
 ---------------
 
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -11,6 +11,11 @@ DoctrineBridge
 
  * Remove `UserLoaderInterface::loadUserByUsername()` in favor of `UserLoaderInterface::loadUserByIdentifier()`
 
+Cache
+-----
+
+ * Remove `DoctrineProvider` because it has been added to the `doctrine/cache` package
+
 Config
 ------
 
diff --git a/composer.json b/composer.json
@@ -125,7 +125,7 @@
         "cache/integration-tests": "dev-master",
         "composer/package-versions-deprecated": "^1.8",
         "doctrine/annotations": "^1.12",
-        "doctrine/cache": "^1.6|^2.0",
+        "doctrine/cache": "^1.11|^2.0",
         "doctrine/collections": "~1.0",
         "doctrine/data-fixtures": "^1.1",
         "doctrine/dbal": "^2.10|^3.0",
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AnnotationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AnnotationsCacheWarmer.php
@@ -15,9 +15,9 @@
 use Doctrine\Common\Annotations\CachedReader;
 use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Common\Cache\Psr6\DoctrineProvider;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
-use Symfony\Component\Cache\DoctrineProvider;
 
 /**
  * Warms up annotation caches for classes found in composer's autoload class map
@@ -56,7 +56,7 @@ protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter)
         $annotatedClasses = include $annotatedClassPatterns;
         $reader = class_exists(PsrCachedReader::class)
             ? new PsrCachedReader($this->annotationReader, $arrayAdapter, $this->debug)
-            : new CachedReader($this->annotationReader, new DoctrineProvider($arrayAdapter), $this->debug)
+            : new CachedReader($this->annotationReader, DoctrineProvider::wrap($arrayAdapter), $this->debug)
         ;
 
         foreach ($annotatedClasses as $class) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/annotations.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/annotations.php
@@ -16,11 +16,11 @@
 use Doctrine\Common\Annotations\CachedReader;
 use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Common\Cache\Psr6\DoctrineProvider;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\AnnotationsCacheWarmer;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
-use Symfony\Component\Cache\DoctrineProvider;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
@@ -36,9 +36,11 @@
         ->set('annotations.cached_reader', CachedReader::class)
             ->args([
                 service('annotations.reader'),
-                inline_service(DoctrineProvider::class)->args([
-                    inline_service(ArrayAdapter::class),
-                ]),
+                inline_service(DoctrineProvider::class)
+                    ->factory([DoctrineProvider::class, 'wrap'])
+                    ->args([
+                        inline_service(ArrayAdapter::class),
+                    ]),
                 abstract_arg('Debug-Flag'),
             ])
 
@@ -50,6 +52,7 @@
             ])
 
         ->set('annotations.filesystem_cache', DoctrineProvider::class)
+            ->factory([DoctrineProvider::class, 'wrap'])
             ->args([
                 service('annotations.filesystem_cache_adapter'),
             ])
@@ -71,6 +74,7 @@
             ->tag('container.hot_path')
 
         ->set('annotations.cache', DoctrineProvider::class)
+            ->factory([DoctrineProvider::class, 'wrap'])
             ->args([
                 service('annotations.cache_adapter'),
             ])
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/AnnotationsCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/AnnotationsCacheWarmerTest.php
@@ -6,13 +6,13 @@
 use Doctrine\Common\Annotations\CachedReader;
 use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Common\Cache\Psr6\DoctrineProvider;
 use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\AnnotationsCacheWarmer;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\Adapter\NullAdapter;
 use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
-use Symfony\Component\Cache\DoctrineProvider;
 use Symfony\Component\Filesystem\Filesystem;
 
 class AnnotationsCacheWarmerTest extends TestCase
@@ -51,7 +51,7 @@ public function testAnnotationsCacheWarmerWithDebugDisabled()
             )
             : new CachedReader(
                 $this->getReadOnlyReader(),
-                new DoctrineProvider(new PhpArrayAdapter($cacheFile, new NullAdapter()))
+                DoctrineProvider::wrap(new PhpArrayAdapter($cacheFile, new NullAdapter()))
             )
         ;
         $refClass = new \ReflectionClass($this);
@@ -79,7 +79,7 @@ public function testAnnotationsCacheWarmerWithDebugEnabled()
             )
             : new CachedReader(
                 $this->getReadOnlyReader(),
-                new DoctrineProvider($phpArrayAdapter),
+                DoctrineProvider::wrap($phpArrayAdapter),
                 true
             )
         ;
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -34,7 +34,7 @@
     },
     "require-dev": {
         "doctrine/annotations": "^1.10.4",
-        "doctrine/cache": "^1.0|^2.0",
+        "doctrine/cache": "^1.11|^2.0",
         "doctrine/persistence": "^1.3|^2.0",
         "symfony/asset": "^5.3|^6.0",
         "symfony/browser-kit": "^5.4|^6.0",
@@ -70,6 +70,7 @@
         "symfony/phpunit-bridge": "^5.3|^6.0"
     },
     "conflict": {
+        "doctrine/cache": "<1.11",
         "doctrine/persistence": "<1.3",
         "phpdocumentor/reflection-docblock": "<3.2.2",
         "phpdocumentor/type-resolver": "<1.4.0",
diff --git a/src/Symfony/Component/Cache/CHANGELOG.md b/src/Symfony/Component/Cache/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.4
+---
+
+ * Deprecate `DoctrineProvider` because this class has been added to the `doctrine/cache` package
+
 5.3
 ---
 
diff --git a/src/Symfony/Component/Cache/DoctrineProvider.php b/src/Symfony/Component/Cache/DoctrineProvider.php
@@ -17,13 +17,17 @@
 
 /**
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @deprecated Use Doctrine\Common\Cache\Psr6\DoctrineProvider instead
  */
 class DoctrineProvider extends CacheProvider implements PruneableInterface, ResettableInterface
 {
     private $pool;
 
     public function __construct(CacheItemPoolInterface $pool)
     {
+        trigger_deprecation('symfony/cache', '5.4', '"%s" is deprecated, use "Doctrine\Common\Cache\Psr6\DoctrineProvider" instead.');
+
         $this->pool = $pool;
     }
 
diff --git a/src/Symfony/Component/Cache/Tests/DoctrineProviderTest.php b/src/Symfony/Component/Cache/Tests/DoctrineProviderTest.php
@@ -16,6 +16,9 @@
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\DoctrineProvider;
 
+/**
+ * @group legacy
+ */
 class DoctrineProviderTest extends TestCase
 {
     public function testProvider()
diff --git a/src/Symfony/Component/Validator/ValidatorBuilder.php b/src/Symfony/Component/Validator/ValidatorBuilder.php
@@ -19,7 +19,6 @@
 use Doctrine\Common\Cache\Psr6\DoctrineProvider;
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
-use Symfony\Component\Cache\DoctrineProvider as SymfonyDoctrineProvider;
 use Symfony\Component\Validator\Context\ExecutionContextFactory;
 use Symfony\Component\Validator\Exception\LogicException;
 use Symfony\Component\Validator\Exception\ValidatorException;
@@ -437,20 +436,10 @@ private function createAnnotationReader(): Reader
         }
 
         // Doctrine Annotations < 1.13, Doctrine Cache >= 1.11, Symfony Cache
-        if (class_exists(CachedReader::class) && class_exists(DoctrineProvider::class) && class_exists(ArrayAdapter::class)) {
+        if (class_exists(CachedReader::class) && class_exists(ArrayAdapter::class)) {
             return new CachedReader(new AnnotationReader(), DoctrineProvider::wrap(new ArrayAdapter()));
         }
 
-        // Doctrine Annotations < 1.13, Doctrine Cache < 1.11, Symfony Cache
-        if (class_exists(CachedReader::class) && !class_exists(DoctrineProvider::class) && class_exists(ArrayAdapter::class)) {
-            return new CachedReader(new AnnotationReader(), new SymfonyDoctrineProvider(new ArrayAdapter()));
-        }
-
-        // Doctrine Annotations < 1.13, Doctrine Cache < 1.11
-        if (class_exists(CachedReader::class) && class_exists(ArrayCache::class)) {
-            return new CachedReader(new AnnotationReader(), new ArrayCache());
-        }
-
         // Doctrine Annotation >= 1.13, Doctrine Cache >= 2, no Symfony Cache
         if (class_exists(PsrCachedReader::class)) {
             throw new LogicException('Enabling annotation based constraint mapping requires the package symfony/cache to be installed.');
diff --git a/src/Symfony/Component/Validator/composer.json b/src/Symfony/Component/Validator/composer.json
@@ -41,10 +41,11 @@
         "symfony/property-info": "^5.3|^6.0",
         "symfony/translation": "^4.4|^5.0|^6.0",
         "doctrine/annotations": "^1.10.4",
-        "doctrine/cache": "^1.0|^2.0",
+        "doctrine/cache": "^1.11|^2.0",
         "egulias/email-validator": "^2.1.10|^3"
     },
     "conflict": {
+        "doctrine/cache": "<1.11",
         "doctrine/lexer": "<1.0.2",
         "phpunit/phpunit": "<5.4.3",
         "symfony/dependency-injection": "<4.4",

Original file line number	Diff line number	Diff line change
`@@ -6,13 +6,13 @@`
`6`	`6`	`use Doctrine\Common\Annotations\CachedReader;`
`7`	`7`	`use Doctrine\Common\Annotations\PsrCachedReader;`
`8`	`8`	`use Doctrine\Common\Annotations\Reader;`
	`9`	`+use Doctrine\Common\Cache\Psr6\DoctrineProvider;`
`9`	`10`	`use PHPUnit\Framework\MockObject\MockObject;`
`10`	`11`	`use Symfony\Bundle\FrameworkBundle\CacheWarmer\AnnotationsCacheWarmer;`
`11`	`12`	`use Symfony\Bundle\FrameworkBundle\Tests\TestCase;`
`12`	`13`	`use Symfony\Component\Cache\Adapter\ArrayAdapter;`
`13`	`14`	`use Symfony\Component\Cache\Adapter\NullAdapter;`
`14`	`15`	`use Symfony\Component\Cache\Adapter\PhpArrayAdapter;`
`15`		`-use Symfony\Component\Cache\DoctrineProvider;`
`16`	`16`	`use Symfony\Component\Filesystem\Filesystem;`
`17`	`17`
`18`	`18`	`class AnnotationsCacheWarmerTest extends TestCase`
`@@ -51,7 +51,7 @@ public function testAnnotationsCacheWarmerWithDebugDisabled()`
`51`	`51`	`)`
`52`	`52`	`: new CachedReader(`
`53`	`53`	`$this->getReadOnlyReader(),`
`54`		`- new DoctrineProvider(new PhpArrayAdapter($cacheFile, new NullAdapter()))`
	`54`	`+ DoctrineProvider::wrap(new PhpArrayAdapter($cacheFile, new NullAdapter()))`
`55`	`55`	`)`
`56`	`56`	`;`
`57`	`57`	`$refClass = new \ReflectionClass($this);`
`@@ -79,7 +79,7 @@ public function testAnnotationsCacheWarmerWithDebugEnabled()`
`79`	`79`	`)`
`80`	`80`	`: new CachedReader(`
`81`	`81`	`$this->getReadOnlyReader(),`
`82`		`- new DoctrineProvider($phpArrayAdapter),`
	`82`	`+ DoctrineProvider::wrap($phpArrayAdapter),`
`83`	`83`	`true`
`84`	`84`	`)`
`85`	`85`	`;`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,17 @@`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* @author Nicolas Grekas <p@tchwork.com>`
	`20`	`+ *`
	`21`	`+ * @deprecated Use Doctrine\Common\Cache\Psr6\DoctrineProvider instead`
`20`	`22`	`*/`
`21`	`23`	`class DoctrineProvider extends CacheProvider implements PruneableInterface, ResettableInterface`
`22`	`24`	`{`
`23`	`25`	`private $pool;`
`24`	`26`
`25`	`27`	`public function __construct(CacheItemPoolInterface $pool)`
`26`	`28`	`{`
	`29`	`+ trigger_deprecation('symfony/cache', '5.4', '"%s" is deprecated, use "Doctrine\Common\Cache\Psr6\DoctrineProvider" instead.');`
	`30`	`+`
`27`	`31`	`$this->pool = $pool;`
`28`	`32`	`}`
`29`	`33`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@`
`16`	`16`	`use Symfony\Component\Cache\Adapter\ArrayAdapter;`
`17`	`17`	`use Symfony\Component\Cache\DoctrineProvider;`
`18`	`18`
	`19`	`+/**`
	`20`	`+ * @group legacy`
	`21`	`+ */`
`19`	`22`	`class DoctrineProviderTest extends TestCase`
`20`	`23`	`{`
`21`	`24`	`public function testProvider()`