feat: use AfterPersist hook in PersistedObjectsTracker

Author: nikophil

config/persistence.php

@@ -6,8 +6,9 @@
 use Symfony\Component\HttpKernel\Event\TerminateEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Zenstruck\Foundry\Command\LoadFixturesCommand;
+use Zenstruck\Foundry\Persistence\Event\AfterPersist;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
-use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
+use Zenstruck\Foundry\Persistence\PersistedObjectsTracker;
 use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
 
 return static function (ContainerConfigurator $container): void {
@@ -38,6 +39,7 @@
             ->tag('kernel.event_listener', ['event' => TerminateEvent::class, 'method' => 'refresh'])
             ->tag('kernel.event_listener', ['event' => ConsoleTerminateEvent::class, 'method' => 'refresh'])
             ->tag('kernel.event_listener', ['event' => WorkerMessageHandledEvent::class, 'method' => 'refresh']) // @phpstan-ignore class.notFound
+            ->tag('foundry.hook', ['class' => null, 'method' => 'afterPersistHook', 'event' => AfterPersist::class])
         ;
     }
 };

src/Configuration.php

@@ -20,7 +20,7 @@
 use Zenstruck\Foundry\InMemory\CannotEnableInMemory;
 use Zenstruck\Foundry\InMemory\InMemoryRepositoryRegistry;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
-use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
+use Zenstruck\Foundry\Persistence\PersistedObjectsTracker;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>

src/Persistence/Proxy/PersistedObjectsTracker.php renamed to src/Persistence/PersistedObjectsTracker.php

@@ -9,9 +9,10 @@
  * file that was distributed with this source code.
  */
 
-namespace Zenstruck\Foundry\Persistence\Proxy;
+namespace Zenstruck\Foundry\Persistence;
 
 use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Persistence\Event\AfterPersist;
 
 /**
  * @internal
@@ -23,50 +24,51 @@ final class PersistedObjectsTracker
      *
      * @var \WeakMap<object, mixed> keys: objects, values: value ids
      */
-    private static \WeakMap $buffer;
+    private static \WeakMap $trackedObjects;
 
     public function __construct()
     {
-        self::$buffer ??= new \WeakMap();
+        self::$trackedObjects ??= new \WeakMap();
     }
 
     public function refresh(): void
     {
         self::proxifyObjects();
     }
 
-    public function add(object ...$objects): void
+    /**
+     * @param AfterPersist<object> $event
+     */
+    public function afterPersistHook(AfterPersist $event): void
     {
-        foreach ($objects as $object) {
-            if (self::$buffer->offsetExists($object) && self::$buffer[$object]) {
-                self::proxifyObject($object, self::$buffer[$object]);
-
-                continue;
-            }
-
-            self::$buffer[$object] = Configuration::instance()->persistence()->getIdentifierValues($object);
+        if ($event->factory instanceof PersistentProxyObjectFactory || !$event->factory->isAutorefreshEnabled()) {
+            return;
         }
+
+        $this->add($event->object);
     }
 
-    public static function updateIds(): void
+    public function add(object ...$objects): void
     {
-        foreach (self::$buffer as $object => $id) {
-            if ($id) {
+        foreach ($objects as $object) {
+            if (self::$trackedObjects->offsetExists($object) && self::$trackedObjects[$object]) {
+                self::proxifyObject($object, self::$trackedObjects[$object]);
+
                 continue;
             }
 
-            self::$buffer[$object] = Configuration::instance()->persistence()->getIdentifierValues($object);
+            self::$trackedObjects[$object] = Configuration::instance()->persistence()->getIdentifierValues($object);
         }
     }
 
     public static function reset(): void
     {
-        self::$buffer = new \WeakMap();
+        self::$trackedObjects = new \WeakMap();
     }
 
     public static function countObjects(): int
     {
-        return \count(self::$buffer);
+        return \count(self::$trackedObjects);
     }
 
     private static function proxifyObjects(): void
@@ -75,7 +77,7 @@ private static function proxifyObjects(): void
             return;
         }
 
-        foreach (self::$buffer as $object => $id) {
+        foreach (self::$trackedObjects as $object => $id) {
             if (!$id) {
                 continue;
             }

src/Persistence/PersistenceManager.php

@@ -22,7 +22,6 @@
 use Zenstruck\Foundry\Persistence\Exception\ObjectHasUnsavedChanges;
 use Zenstruck\Foundry\Persistence\Exception\ObjectNoLongerExist;
 use Zenstruck\Foundry\Persistence\Exception\RefreshObjectFailed;
-use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
 use Zenstruck\Foundry\Persistence\Relationship\RelationshipMetadata;
 use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
 
@@ -86,8 +85,6 @@ public function save(object $object): object
             $this->flush($om);
         }
 
-        PersistedObjectsTracker::updateIds();
-
         return $object;
     }
 
@@ -426,7 +423,6 @@ private function flushAllStrategies(): void
                 $this->flush($om);
             }
         }
-        PersistedObjectsTracker::updateIds();
     }
 
     /**

src/Persistence/PersistentObjectFactory.php

@@ -521,13 +521,6 @@ static function(object $object, array $parameters, PersistentObjectFactory $fact
                         return;
                     }
 
-                    if (
-                        $factoryUsed->isAutorefreshEnabled()
-                        && !$factoryUsed instanceof PersistentProxyObjectFactory
-                    ) {
-                        Configuration::instance()->persistedObjectsTracker?->add($object);
-                    }
-
                     $afterPersistCallbacks = [];
 
                     foreach ($factoryUsed->afterPersist as $afterPersist) {
@@ -557,7 +550,10 @@ static function(object $object, array $parameters, self $factoryUsed): bool {
         );
     }
 
-    private function isAutorefreshEnabled(): bool
+    /**
+     * @internal
+     */
+    public function isAutorefreshEnabled(): bool
     {
         return $this->autorefreshEnabled ??= Configuration::autoRefreshWithLazyObjectsIsEnabled();
     }

tests/Integration/ORM/AutoRefreshTest.php

@@ -23,7 +23,7 @@
 use PHPUnit\Framework\Attributes\Test;
 use Zenstruck\Foundry\Configuration;
 use Zenstruck\Foundry\Persistence\PersistentObjectFactory;
-use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
+use Zenstruck\Foundry\Persistence\PersistedObjectsTracker;
 use Zenstruck\Foundry\Tests\Fixture\DoctrineCascadeRelationship\ChangesEntityRelationshipCascadePersist;
 use Zenstruck\Foundry\Tests\Fixture\DoctrineCascadeRelationship\UsingRelationships;
 use Zenstruck\Foundry\Tests\Fixture\Entity\Contact;

tests/Integration/Persistence/AutoRefreshTestCase.php

@@ -25,7 +25,7 @@
 use Symfony\Component\HttpKernel\KernelInterface;
 use Zenstruck\Foundry\Configuration;
 use Zenstruck\Foundry\Persistence\PersistentObjectFactory;
-use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
+use Zenstruck\Foundry\Persistence\PersistedObjectsTracker;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
 use Zenstruck\Foundry\Tests\Fixture\Document\DocumentWithReadonly;