Update in-memory collections before dispatching the postRemove event

Make sure in-memory collections have removed entities unset before the `postRemove` event is dispatched. This is related to #11098, although by itself probably not going to fix the regression.

 #### Background

When an entity is removed from the database, the UoW also takes care of removing that entity from all in-memory collections. #10763 moved this cleanup and taking snapshots of updated collections to a very late stage during the commit phase, in order to avoid other side effects.

Now, part of the issue in #11098 is that `postRemove` event listeners will be called at a point where the database-level `DELETE` has happened (although the transaction has not yet been committed), but the in-memory collections have not yet been updated.

 #### Suggested change

This PR splits taking the new collection snapshots and updating in-memory collections. The in-memory update happens along with the database-level execution, collection snapshots still happen after transaction commit.

Author: mpdude

lib/Doctrine/ORM/UnitOfWork.php

@@ -491,20 +491,12 @@ public function commit($entity = null)
 
         $this->afterTransactionComplete();
 
-        // Unset removed entities from collections, and take new snapshots from
-        // all visited collections.
-        foreach ($this->visitedCollections as $coid => $coll) {
-            if (isset($this->pendingCollectionElementRemovals[$coid])) {
-                foreach ($this->pendingCollectionElementRemovals[$coid] as $key => $valueIgnored) {
-                    unset($coll[$key]);
-                }
-            }
-
+        // Take new snapshots from all visited collections.
+        foreach ($this->visitedCollections as $coll) {
             $coll->takeSnapshot();
         }
 
         $this->dispatchPostFlushEvent();
-
         $this->postCommitCleanup($entity);
     }
 
@@ -1317,6 +1309,14 @@ private function executeDeletions(): void
             }
         }
 
+        // Unset removed entities from collections
+        foreach ($this->pendingCollectionElementRemovals as $coid => $keys) {
+            $collection = $this->visitedCollections[$coid];
+            foreach ($keys as $key => $valueIgnored) {
+                unset($collection[$key]);
+            }
+        }
+
         // Defer dispatching `postRemove` events to until all entities have been removed.
         foreach ($eventsToDispatch as $event) {
             $this->listenersInvoker->invoke(

tests/Doctrine/Tests/ORM/Functional/EntityListenersTest.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\Tests\ORM\Functional;
 
+use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Event\PostPersistEventArgs;
 use Doctrine\ORM\Event\PostRemoveEventArgs;
 use Doctrine\ORM\Event\PreFlushEventArgs;
@@ -12,6 +13,7 @@
 use Doctrine\ORM\UnitOfWork;
 use Doctrine\Persistence\Event\LifecycleEventArgs;
 use Doctrine\Tests\Models\Company\CompanyContractListener;
+use Doctrine\Tests\Models\Company\CompanyEmployee;
 use Doctrine\Tests\Models\Company\CompanyFixContract;
 use Doctrine\Tests\Models\Company\CompanyPerson;
 use Doctrine\Tests\OrmFunctionalTestCase;
@@ -266,4 +268,44 @@ public function postRemove(PostRemoveEventArgs $args): void
 
         self::assertSame(2, $listener->invocationCount);
     }
+
+    public function testPostRemoveCalledAfterAllInMemoryCollectionsHaveBeenUpdated(): void
+    {
+        $contract = new CompanyFixContract();
+        $contract->setFixPrice(2000);
+
+        $engineer = new CompanyEmployee();
+        $engineer->setName('J. Doe');
+        $engineer->setSalary(50);
+        $engineer->setDepartment('tech');
+
+        $contract->addEngineer($engineer);
+        $engineer->contracts = new ArrayCollection([$contract]);
+
+        $this->_em->persist($contract);
+        $this->_em->persist($engineer);
+        $this->_em->flush();
+
+        $this->_em->getEventManager()->addEventListener([Events::postRemove], new class ($contract) {
+            /** @var CompanyFixContract */
+            private $contract;
+
+            public function __construct(CompanyFixContract $contract)
+            {
+                $this->contract = $contract;
+            }
+
+            public function postRemove(): void
+            {
+                Assert::assertEmpty($this->contract->getEngineers()); // Assert collection has been updated before event was dispatched
+                Assert::assertTrue($this->contract->getEngineers()->isDirty()); // Collections are still dirty (is that relevant?)
+            }
+        });
+
+        $this->_em->remove($engineer);
+        $this->_em->flush();
+
+        self::assertEmpty($contract->getEngineers());
+        self::assertFalse($contract->getEngineers()->isDirty());
+    }
 }