Merge branch '2.9.x' into merge/2.9.x

* 2.9.x:
  Restore functional cache tests (doctrine#8981)
  Fix English in `note`. (doctrine#8987)
  Remove detach deprecation entry in UPGRADE.md (doctrine#8978)
  Bump to PHPStan 0.12.98 and Psalm 4.10.0 (doctrine#8979)

Signed-off-by: Alexander M. Turek <me@derrabus.de>

Author: derrabus

UPGRADE.md

@@ -179,24 +179,16 @@ The `Doctrine\ORM\Version` class is now deprecated and will be removed in Doctri
 please refrain from checking the ORM version at runtime or use
 [ocramius/package-versions](https://github.com/Ocramius/PackageVersions/).
 
-## Deprecated `EntityManager#merge()` and `EntityManager#detach()` methods
+## Deprecated `EntityManager#merge()` method
 
-Merge and detach semantics were a poor fit for the PHP "share-nothing" architecture.
-In addition to that, merging/detaching caused multiple issues with data integrity
+Merge semantics was a poor fit for the PHP "share-nothing" architecture.
+In addition to that, merging caused multiple issues with data integrity
 in the managed entity graph, which was constantly spawning more edge-case bugs/scenarios.
 
 The following API methods were therefore deprecated:
 
 * `EntityManager#merge()`
-* `EntityManager#detach()`
 * `UnitOfWork#merge()`
-* `UnitOfWork#detach()`
-
-Users are encouraged to migrate `EntityManager#detach()` calls to `EntityManager#clear()`.
-
-In order to maintain performance on batch processing jobs, it is endorsed to enable
-the second level cache (http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/second-level-cache.html)
-on entities that are frequently reused across multiple `EntityManager#clear()` calls.
 
 An alternative to `EntityManager#merge()` will not be provided by ORM 3.0, since the merging
 semantics should be part of the business domain rather than the persistence domain of an

composer.json

@@ -39,12 +39,12 @@
         "doctrine/annotations": "^1.13",
         "doctrine/coding-standard": "^9.0",
         "phpbench/phpbench": "^0.16.10 || ^1.0",
-        "phpstan/phpstan": "0.12.96",
+        "phpstan/phpstan": "0.12.98",
         "phpunit/phpunit": "^7.5 || ^8.5 || ^9.4",
         "squizlabs/php_codesniffer": "3.6.0",
         "symfony/cache": "^4.4 || ^5.2",
         "symfony/yaml": "^3.4 || ^4.0 || ^5.0 || ^6.0",
-        "vimeo/psalm": "4.9.3"
+        "vimeo/psalm": "4.10.0"
     },
     "conflict": {
         "doctrine/annotations": "<1.13 || >= 2.0"

docs/en/reference/working-with-objects.rst

@@ -27,7 +27,7 @@ Work that have not yet been persisted are lost.
 
 .. note::
 
-    Doctrine does NEVER touch the public API of methods in your entity
+    Doctrine NEVER touches the public API of methods in your entity
     classes (like getters and setters) nor the constructor method.
     Instead, it uses reflection to get/set data from/to your entity objects.
     When Doctrine fetches data from DB and saves it back,

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.9.3@4c262932602b9bbab5020863d1eb22d49de0dbf4">
+<files psalm-version="4.10.0@916b098b008f6de4543892b1e0651c1c3b92cbfa">
   <file src="lib/Doctrine/ORM/AbstractQuery.php">
     <DeprecatedClass occurrences="1">
       <code>IterableResult</code>
@@ -460,14 +460,12 @@
     <DeprecatedClass occurrences="2">
       <code>ProxyFactory</code>
     </DeprecatedClass>
-    <DeprecatedMethod occurrences="7">
+    <DeprecatedMethod occurrences="5">
       <code>getAutoGenerateProxyClasses</code>
       <code>getMetadataCacheImpl</code>
       <code>getProxyDir</code>
       <code>getProxyNamespace</code>
       <code>merge</code>
-      <code>setCacheDriver</code>
-      <code>setCacheDriver</code>
     </DeprecatedMethod>
     <DocblockTypeContradiction occurrences="9">
       <code>$entityName !== null &amp;&amp; ! is_string($entityName)</code>
@@ -3862,9 +3860,6 @@
       <code>new ClassLoader('Symfony\Component', $directory . '/Doctrine')</code>
       <code>new YamlDriver($paths)</code>
     </DeprecatedClass>
-    <DeprecatedMethod occurrences="1">
-      <code>setMetadataCacheImpl</code>
-    </DeprecatedMethod>
     <UnresolvableInclude occurrences="1">
       <code>require_once $directory . '/Doctrine/Common/ClassLoader.php'</code>
     </UnresolvableInclude>

tests/Doctrine/Tests/ORM/Cache/AbstractRegionTest.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\Tests\ORM\Cache;
 
+use Doctrine\Common\Cache\Cache;
 use Doctrine\Common\Cache\Psr6\DoctrineProvider;
 use Doctrine\ORM\Cache\Region;
 use Doctrine\Tests\Mocks\CacheEntryMock;
@@ -19,7 +20,7 @@ abstract class AbstractRegionTest extends OrmFunctionalTestCase
     /** @var Region */
     protected $region;
 
-    /** @var ArrayCache */
+    /** @var Cache */
     protected $cache;
 
     protected function setUp(): void

tests/Doctrine/Tests/ORM/Cache/DefaultRegionTest.php

@@ -6,17 +6,17 @@
 
 use BadMethodCallException;
 use Doctrine\Common\Cache\Cache;
-use Doctrine\Common\Cache\CacheProvider;
 use Doctrine\Common\Cache\Psr6\DoctrineProvider;
 use Doctrine\ORM\Cache\CollectionCacheEntry;
 use Doctrine\ORM\Cache\Region;
 use Doctrine\ORM\Cache\Region\DefaultRegion;
 use Doctrine\Tests\Mocks\CacheEntryMock;
 use Doctrine\Tests\Mocks\CacheKeyMock;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 
 use function assert;
-use function class_exists;
 
 /**
  * @group DDC-2183
@@ -36,15 +36,11 @@ public function testGetters(): void
 
     public function testSharedRegion(): void
     {
-        if (! class_exists(ArrayCache::class)) {
-            self::markTestSkipped('Test only applies with doctrine/cache 1.x');
-        }
-
         $cache   = new SharedArrayCache();
         $key     = new CacheKeyMock('key');
         $entry   = new CacheEntryMock(['value' => 'foo']);
-        $region1 = new DefaultRegion('region1', $cache->createChild());
-        $region2 = new DefaultRegion('region2', $cache->createChild());
+        $region1 = new DefaultRegion('region1', DoctrineProvider::wrap($cache->createChild()));
+        $region2 = new DefaultRegion('region2', DoctrineProvider::wrap($cache->createChild()));
 
         self::assertFalse($region1->contains($key));
         self::assertFalse($region2->contains($key));
@@ -135,76 +131,71 @@ public function corruptedDataDoesNotLeakIntoApplicationWhenGettingMultipleEntrie
     }
 }
 
-if (class_exists(ArrayCache::class)) {
-    /**
-     * Cache provider that offers child cache items (sharing the same array)
-     *
-     * Declared as a different class for readability purposes and kept in this file
-     * to keep its monstrosity contained.
-     *
-     * @internal
-     */
-    final class SharedArrayCache extends ArrayCache
+/**
+ * Cache provider that offers child cache items (sharing the same array)
+ *
+ * Declared as a different class for readability purposes and kept in this file
+ * to keep its monstrosity contained.
+ *
+ * @internal
+ */
+final class SharedArrayCache extends ArrayAdapter
+{
+    public function createChild(): CacheItemPoolInterface
     {
-        public function createChild(): Cache
-        {
-            return new class ($this) extends CacheProvider {
-                /** @var ArrayCache */
-                private $parent;
-
-                public function __construct(ArrayCache $parent)
-                {
-                    $this->parent = $parent;
-                }
-
-                /**
-                 * {@inheritDoc}
-                 */
-                protected function doFetch($id)
-                {
-                    return $this->parent->doFetch($id);
-                }
-
-                /**
-                 * {@inheritDoc}
-                 */
-                protected function doContains($id)
-                {
-                    return $this->parent->doContains($id);
-                }
-
-                /**
-                 * {@inheritDoc}
-                 */
-                protected function doSave($id, $data, $lifeTime = 0)
-                {
-                    return $this->parent->doSave($id, $data, $lifeTime);
-                }
-
-                /**
-                 * {@inheritDoc}
-                 */
-                protected function doDelete($id)
-                {
-                    return $this->parent->doDelete($id);
-                }
-
-                /**
-                 * {@inheritDoc}
-                 */
-                protected function doFlush()
-                {
-                    return $this->parent->doFlush();
-                }
-
-                /**
-                 * {@inheritDoc}
-                 */
-                protected function doGetStats()
-                {
-                    return $this->parent->doGetStats();
-                }
-            };
-        }
+        return new class ($this) implements CacheItemPoolInterface {
+            /** @var CacheItemPoolInterface */
+            private $parent;
+
+            public function __construct(CacheItemPoolInterface $parent)
+            {
+                $this->parent = $parent;
+            }
+
+            public function getItem($key): CacheItemInterface
+            {
+                return $this->parent->getItem($key);
+            }
+
+            public function getItems(array $keys = []): iterable
+            {
+                return $this->parent->getItems($keys);
+            }
+
+            public function hasItem($key): bool
+            {
+                return $this->parent->hasItem($key);
+            }
+
+            public function clear(): bool
+            {
+                return $this->parent->clear();
+            }
+
+            public function deleteItem($key): bool
+            {
+                return $this->parent->deleteItem($key);
+            }
+
+            public function deleteItems(array $keys): bool
+            {
+                return $this->parent->deleteItems($keys);
+            }
+
+            public function save(CacheItemInterface $item): bool
+            {
+                return $this->parent->save($item);
+            }
+
+            public function saveDeferred(CacheItemInterface $item): bool
+            {
+                return $this->parent->saveDeferred($item);
+            }
+
+            public function commit(): bool
+            {
+                return $this->parent->commit();
+            }
+        };
     }
 }