feat: create proxy system with PHP 8.4 lazy proxies

Author: nikophil

.github/workflows/ci.yml

@@ -329,7 +329,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.3
+          php-version: 8.4
           coverage: none
 
       - name: Install dependencies

composer.json

@@ -32,16 +32,18 @@
         "doctrine/common": "^3.2.2",
         "doctrine/doctrine-bundle": "^2.10",
         "doctrine/doctrine-migrations-bundle": "^2.2|^3.0",
-        "doctrine/persistence": "^2.0|^3.0|^4.0",
-        "doctrine/mongodb-odm-bundle": "^4.6|^5.0",
         "doctrine/mongodb-odm": "^2.4",
+        "doctrine/mongodb-odm-bundle": "^4.6|^5.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": "^7.2",
         "symfony/console": "^6.4|^7.0",
         "symfony/dotenv": "^6.4|^7.0",
         "symfony/framework-bundle": "^6.4|^7.0",
         "symfony/maker-bundle": "^1.55",
         "symfony/phpunit-bridge": "^6.4|^7.0",
+        "symfony/routing": "^7.2",
         "symfony/runtime": "^6.4|^7.0",
         "symfony/translation-contracts": "^3.4",
         "symfony/uid": "^6.4|^7.0",

config/persistence.php

@@ -2,7 +2,9 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
+use Zenstruck\Foundry\Persistence\Proxy\KernelTerminateListener;
 use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
 
 return static function (ContainerConfigurator $container): void {
@@ -18,4 +20,10 @@
                 tagged_iterator('.foundry.persistence.schema_resetter'),
             ])
     ;
+
+    if (PHP_VERSION_ID >= 80400) {
+        $container->services()->set('.foundry.proxy.kernel_terminate_listener', KernelTerminateListener::class)
+            ->tag('kernel.event_listener', ['event' => TerminateEvent::class, 'method' => '__invoke'])
+        ;
+    }
 };

src/Persistence/PersistentObjectFactory.php

@@ -27,6 +27,8 @@
 use Zenstruck\Foundry\Persistence\Relationship\OneToManyRelationship;
 use Zenstruck\Foundry\Persistence\Relationship\OneToOneRelationship;
 
+use Zenstruck\Foundry\Persistence\Proxy\CreatedObjectsTracker;
+
 use function Zenstruck\Foundry\force;
 use function Zenstruck\Foundry\get;
 use function Zenstruck\Foundry\set;
@@ -454,6 +456,10 @@ final protected function initializeInternal(): static
         return parent::initializeInternal()
             ->afterInstantiate(
                 static function(object $object, array $parameters, PersistentObjectFactory $factoryUsed): void {
+                    if (PHP_VERSION_ID >= 80400) {
+                        CreatedObjectsTracker::add($object);
+                    }
+
                     if (!$factoryUsed->isPersisting()) {
                         return;
                     }

src/Persistence/Proxy/CreatedObjectsTracker.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Zenstruck\Foundry\Persistence\Proxy;
+
+use WeakReference;
+
+use function Zenstruck\Foundry\Persistence\refresh;
+
+final class CreatedObjectsTracker
+{
+    /** @var list<\WeakReference<object>> */
+    private static $buffer = [];
+
+    public static function add(object $object): void
+    {
+        self::$buffer[] = \WeakReference::create($object);
+    }
+
+    public static function proxifyObjects(): void
+    {
+        self::$buffer = array_values(
+            array_map(
+                static function (WeakReference $weakRef) {
+                    $object = $weakRef->get() ?? throw new \LogicException('Object cannot be null.');
+                    $clone = clone $object;
+                    (new \ReflectionClass($object))->resetAsLazyProxy($object, fn() => refresh($clone));
+
+                    return \WeakReference::create($object);
+                },
+                array_filter(self::$buffer, static fn (WeakReference $weakRef) => $weakRef->get() !== null),
+            )
+        );
+    }
+}

src/Persistence/Proxy/KernelTerminateListener.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Zenstruck\Foundry\Persistence\Proxy;
+
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+
+final class KernelTerminateListener
+{
+    public function __invoke(TerminateEvent $event): void
+    {
+        CreatedObjectsTracker::proxifyObjects();
+    }
+}

tests/Fixture/TestKernel.php

@@ -11,10 +11,15 @@
 
 namespace Zenstruck\Foundry\Tests\Fixture;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\MakerBundle\MakerBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
 use Zenstruck\Foundry\ORM\ResetDatabase\ResetDatabaseMode;
+use Zenstruck\Foundry\Tests\Fixture\Entity\Address;
+use Zenstruck\Foundry\Tests\Fixture\Entity\GenericEntity;
 use Zenstruck\Foundry\Tests\Fixture\Factories\ArrayFactory;
 use Zenstruck\Foundry\Tests\Fixture\Factories\Object1Factory;
 use Zenstruck\Foundry\Tests\Fixture\InMemory\InMemoryAddressRepository;
@@ -56,4 +61,14 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
         $c->register(InMemoryAddressRepository::class)->setAutowired(true)->setAutoconfigured(true);
         $c->register(InMemoryContactRepository::class)->setAutowired(true)->setAutoconfigured(true);
     }
+
+    #[Route('/update/{id}', name: 'test')]
+    public function __invoke(EntityManagerInterface $entityManager, int $id): Response
+    {
+        $genericEntity = $entityManager->find(GenericEntity::class, $id);
+        $genericEntity?->setProp1('foo');
+        $entityManager->flush();
+
+        return new Response();
+    }
 }

tests/Integration/ORM/GenericEntityFactoryTest.php

@@ -11,7 +11,11 @@
 
 namespace Zenstruck\Foundry\Tests\Integration\ORM;
 
+use Doctrine\ORM\EntityManagerInterface;
+use PHPUnit\Framework\Attributes\RequiresPhp;
 use PHPUnit\Framework\Attributes\Test;
+use Zenstruck\Foundry\Persistence\Proxy\CreatedObjectsTracker;
+use Zenstruck\Foundry\Tests\Fixture\Entity\GenericEntity;
 use Zenstruck\Foundry\Tests\Fixture\Factories\Entity\EmptyConstructorFactory;
 use Zenstruck\Foundry\Tests\Fixture\Factories\Entity\GenericEntityFactory;
 use Zenstruck\Foundry\Tests\Integration\Persistence\GenericFactoryTestCase;
@@ -27,6 +31,28 @@ final class GenericEntityFactoryTest extends GenericFactoryTestCase
 {
     use RequiresORM;
 
+    /**
+     * @test
+     * @requires PHP >= 8.4
+     */
+    #[Test]
+    #[RequiresPhp('>= 8.4')]
+    public function it_can_refresh_objects_with_php84_proxies(): void
+    {
+        $object = $this->factory()->create();
+        self::ensureKernelShutdown();
+
+        self::assertSame('default1', $object->getProp1());
+        self::assertFalse((new \ReflectionClass($object))->isUninitializedLazyObject($object));
+
+        $client = self::createClient();
+        $client->request('GET', "/update/{$object->id}");
+
+        self::assertTrue((new \ReflectionClass($object))->isUninitializedLazyObject($object));
+        self::assertSame('foo', $object->getProp1());
+        self::assertFalse((new \ReflectionClass($object))->isUninitializedLazyObject($object));
+    }
+
     /**
      * @test
      */

tests/Integration/ORM/GenericEntityProxyFactoryTest.php

@@ -11,8 +11,10 @@
 
 namespace Zenstruck\Foundry\Tests\Integration\ORM;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory;
 use Zenstruck\Foundry\Tests\Fixture\Entity\EdgeCases\EntityWithReadonly\EntityWithReadonly;
+use Zenstruck\Foundry\Tests\Fixture\Entity\GenericEntity;
 use Zenstruck\Foundry\Tests\Fixture\Factories\Entity\GenericProxyEntityFactory;
 use Zenstruck\Foundry\Tests\Integration\Persistence\GenericProxyFactoryTestCase;
 use Zenstruck\Foundry\Tests\Integration\RequiresORM;

tests/Integration/Persistence/GenericFactoryTestCase.php

@@ -14,6 +14,7 @@
 use PHPUnit\Framework\Attributes\Depends;
 use PHPUnit\Framework\Attributes\Test;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Zenstruck\Foundry\Configuration;
 use Zenstruck\Foundry\Exception\PersistenceDisabled;
 use Zenstruck\Foundry\Object\Instantiator;
@@ -37,7 +38,7 @@
 /**
  * @author Kevin Bond <[email protected]>
  */
-abstract class GenericFactoryTestCase extends KernelTestCase
+abstract class GenericFactoryTestCase extends WebTestCase
 {
     use Factories, ResetDatabase;