feat: create proxy system with PHP 8.4 lazy proxies

fix: review

Author: nikophil

composer.json

@@ -35,14 +35,16 @@
         "doctrine/doctrine-migrations-bundle": "^2.2|^3.0",
         "doctrine/mongodb-odm": "^2.4",
         "doctrine/mongodb-odm-bundle": "^4.6|^5.0",
-        "doctrine/persistence": "^2.0|^3.0|^4.0",
         "doctrine/orm": "^2.16|^3.0",
+        "doctrine/persistence": "^2.0|^3.0|^4.0",
         "phpunit/phpunit": "^9.5.0 || ^10.0 || ^11.0 || ^12.0",
+        "symfony/browser-kit": "^6.4|^7.0|^8.0",
         "symfony/console": "^6.4|^7.0|^8.0",
         "symfony/dotenv": "^6.4|^7.0|^8.0",
         "symfony/framework-bundle": "^6.4|^7.0|^8.0",
         "symfony/maker-bundle": "^1.55",
         "symfony/phpunit-bridge": "^6.4|^7.0|^8.0",
+        "symfony/routing": "^6.4|^7.0|^8.0",
         "symfony/runtime": "^6.4|^7.0|^8.0",
         "symfony/translation-contracts": "^3.4",
         "symfony/uid": "^6.4|^7.0|^8.0",

config/persistence.php

@@ -2,8 +2,12 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Zenstruck\Foundry\Command\LoadFixturesCommand;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
+use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
 use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
 
 return static function (ContainerConfigurator $container): void {
@@ -27,4 +31,13 @@
                 'description' => 'Load stories which are marked with #[AsFixture] attribute.',
             ])
     ;
+
+    if (PHP_VERSION_ID >= 80400) {
+        $container->services()->set('.foundry.persistence.objects_tracker', PersistedObjectsTracker::class)
+            ->tag('kernel.reset', ['method' => 'refresh'])
+            ->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
+        ;
+    }
 };

config/services.php

@@ -35,6 +35,7 @@
             param('zenstruck_foundry.persistence.flush_once'),
             '%env(default:zenstruck_foundry.faker.seed:int:FOUNDRY_FAKER_SEED)%',
             service('.zenstruck_foundry.in_memory.repository_registry'),
+            service('.foundry.persistence.objects_tracker')->nullOnInvalid(),
         ])
         ->public()
     ;

phpstan.neon

@@ -69,6 +69,11 @@ parameters:
         - identifier: missingType.callable
           path: tests/Fixture/Maker/expected/
 
+        # we're currently running static analysis with PHP 8.3
+        - message: '#Call to an undefined method ReflectionClass\<(.*)\>::isUninitializedLazyObject\(\).#'
+        - message: '#Call to an undefined method ReflectionClass\<(.*)\>::resetAsLazyProxy\(\).#'
+        - message: '#Call to an undefined method ReflectionClass\<(.*)\>::initializeLazyObject\(\).#'
+
     excludePaths:
         - tests/Fixture/Maker/expected/can_create_factory_with_auto_activated_not_persisted_option.php
         - tests/Fixture/Maker/expected/can_create_factory_interactively.php

phpunit

@@ -3,8 +3,10 @@
 set -o errexit
 set -o nounset
 
+COMPOSER_BIN="php -d xdebug.mode=off $(which composer)"
+
 check_phpunit_version() {
-    INSTALLED_PHPUNIT_VERSION=$(composer info phpunit/phpunit | grep versions |  cut -c 14-)
+    INSTALLED_PHPUNIT_VERSION=$(${COMPOSER_BIN} info phpunit/phpunit | grep versions |  cut -c 14-)
 
     REQUIRED_PHPUNIT_VERSION="${1?}"
 
@@ -35,7 +37,7 @@ SHOULD_UPDATE_PHPUNIT=$(check_phpunit_version "${PHPUNIT_VERSION}")
 
 if [ "${SHOULD_UPDATE_PHPUNIT}" = "0" ]; then
   echo "ℹ️  Upgrading PHPUnit to ${PHPUNIT_VERSION}"
-  composer update dama/doctrine-test-bundle brianium/paratest "phpunit/phpunit:^${PHPUNIT_VERSION}" -W
+  ${COMPOSER_BIN} update dama/doctrine-test-bundle brianium/paratest "phpunit/phpunit:^${PHPUNIT_VERSION}" -W
 fi
 ### <<
 

phpunit-deprecation-baseline.xml

@@ -4,6 +4,7 @@
         <line number="25" hash="c6af5d66288d0667e424978000f29571e4954b81">
             <issue><![CDATA[Since symfony/framework-bundle 6.4: Not setting the "framework.php_errors.log" config option is deprecated. It will default to "true" in 7.0.]]></issue>
             <issue><![CDATA[Since symfony/var-exporter 7.3: Generating lazy proxy for class "Zenstruck\Foundry\Tests\Integration\ForceFactoriesTraitUsage\SomeObject" is deprecated; leverage native lazy objects instead.]]></issue>
+            <issue><![CDATA[Since zenstruck/foundry 2.6: Proxy usage is deprecated in PHP 8.4. Use directly PersistentObjectFactory, Foundry now leverages the native PHP lazy system to auto-refresh objects.]]></issue>
         </line>
     </file>
 </files>

src/Configuration.php

@@ -19,6 +19,7 @@
 use Zenstruck\Foundry\InMemory\CannotEnableInMemory;
 use Zenstruck\Foundry\InMemory\InMemoryRepositoryRegistry;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
+use Zenstruck\Foundry\Persistence\Proxy\PersistedObjectsTracker;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -60,6 +61,7 @@ public function __construct(
         public readonly bool $flushOnce = false,
         ?int $forcedFakerSeed = null,
         public readonly ?InMemoryRepositoryRegistry $inMemoryRepositoryRegistry = null,
+        public readonly ?PersistedObjectsTracker $persistedObjectsTracker = null,
     ) {
         if (null === self::$instance) {
             $this->faker->seed(self::fakerSeed($forcedFakerSeed));

src/Persistence/PersistenceManager.php

@@ -22,6 +22,8 @@
 use Zenstruck\Foundry\Persistence\Relationship\RelationshipMetadata;
 use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
 
+use function Zenstruck\Foundry\set;
+
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  *
@@ -147,7 +149,7 @@ public function flush(ObjectManager $om): void
      *
      * @return T
      */
-    public function refresh(object &$object, bool $force = false): object
+    public function refresh(object &$object, bool $force = false, bool $allowRefreshDeletedObject = false): object
     {
         if (!$this->flush && !$force) {
             return $object;
@@ -157,6 +159,11 @@ public function refresh(object &$object, bool $force = false): object
             return $object->_refresh();
         }
 
+        if (\PHP_VERSION_ID >= 80400 && ($reflector = new \ReflectionClass($object))->isUninitializedLazyObject($object)) {
+            /** @var T $object */
+            $object = $reflector->initializeLazyObject($object);
+        }
+
         $strategy = $this->strategyFor($object::class);
 
         if ($strategy->hasChanges($object)) {
@@ -165,33 +172,49 @@ public function refresh(object &$object, bool $force = false): object
 
         $om = $strategy->objectManagerFor($object::class);
 
-        if ($strategy->contains($object)) {
-            try {
-                $om->refresh($object);
-            } catch (\LogicException|\Error) {
-                // prevent entities/documents with readonly properties to create an error
-                // LogicException is for ORM / Error is for ODM
-                // @see https://github.com/doctrine/orm/issues/9505
-            }
-
-            return $object;
-        }
-
         if ($strategy->isEmbeddable($object)) {
             return $object;
         }
 
-        $id = $om->getClassMetadata($object::class)->getIdentifierValues($object);
+        if (!$strategy->contains($object)) {
+            $objectFromDb = null;
 
-        if (!$id || !($object = $om->find($object::class, $id))) { // @phpstan-ignore parameterByRef.type
-            throw RefreshObjectFailed::objectNoLongExists();
+            $id = $om->getClassMetadata($object::class)->getIdentifierValues($object);
+
+            if ($id) {
+                // "merge" object if it is not managed
+                $objectFromDb = $om->find($object::class, $id);
+            }
+
+            if ($objectFromDb) {
+                $object = $objectFromDb;
+            } else {
+                if ($allowRefreshDeletedObject) {
+                    return $object;
+                }
+
+                throw RefreshObjectFailed::objectNoLongExists();
+            }
+        }
+
+        try {
+            $om->refresh($object);
+        } catch (\LogicException|\Error) {
+            // prevent entities/documents with readonly properties to create an error
+            // LogicException is for ORM / Error is for ODM
+            // @see https://github.com/doctrine/orm/issues/9505
         }
 
         return $object;
     }
 
     public function isPersisted(object $object): bool
     {
+        if (\PHP_VERSION_ID >= 80400 && ($reflector = new \ReflectionClass($object))->isUninitializedLazyObject($object)) {
+            /** @var object $object */
+            $object = $reflector->initializeLazyObject($object);
+        }
+
         // prevents doctrine to use its cache and think the object is persisted
         if ($this->strategyFor($object::class)->isScheduledForInsert($object)) {
             return false;

src/Persistence/PersistentObjectFactory.php

@@ -483,6 +483,10 @@ static function(object $object, array $parameters, PersistentObjectFactory $fact
                         return;
                     }
 
+                    if (\PHP_VERSION_ID >= 80400 && !$factoryUsed instanceof PersistentProxyObjectFactory) {
+                        Configuration::instance()->persistedObjectsTracker?->add($object);
+                    }
+
                     $afterPersistCallbacks = [];
 
                     foreach ($factoryUsed->afterPersist as $afterPersist) {

src/Persistence/PersistentProxyObjectFactory.php

@@ -22,6 +22,19 @@
  */
 abstract class PersistentProxyObjectFactory extends PersistentObjectFactory
 {
+    public function __construct()
+    {
+        parent::__construct();
+
+        if (\PHP_VERSION_ID >= 80400) {
+            trigger_deprecation(
+                'zenstruck/foundry',
+                '2.6',
+                'Proxy usage is deprecated in PHP 8.4. Use directly PersistentObjectFactory, Foundry now leverages the native PHP lazy system to auto-refresh objects.',
+            );
+        }
+    }
+
     /**
      * @return class-string<T>
      */
@@ -151,6 +164,6 @@ final public static function repository(): ObjectRepository
     {
         Configuration::instance()->assertPersistenceEnabled();
 
-        return new ProxyRepositoryDecorator(static::class(), Configuration::instance()->isInMemoryEnabled()); // @phpstan-ignore argument.type, return.type
+        return new ProxyRepositoryDecorator(static::class(), Configuration::instance()->isInMemoryEnabled()); // @phpstan-ignore return.type
     }
 }