Add support for PHP 8.4 Lazy Objects with configuration flag (#2840)

Author: GromNaN

.github/workflows/atlas-ci.yml

@@ -96,4 +96,4 @@ jobs:
         run: "vendor/bin/phpunit --group atlas"
         env:
           DOCTRINE_MONGODB_SERVER: "mongodb://127.0.0.1:27017/?directConnection=true"
-          USE_LAZY_GHOST_OBJECTS: ${{ matrix.proxy == 'lazy-ghost' && '1' || '0' }}
+          USE_LAZY_GHOST_OBJECT: ${{ matrix.proxy == 'lazy-ghost' && '1' || '0' }}

.github/workflows/continuous-integration.yml

@@ -77,6 +77,13 @@ jobs:
             dependencies: "highest"
             symfony-version: "stable"
             proxy: "proxy-manager"
+          # Test with Native Lazy Objects
+          - php-version: "8.4"
+            mongodb-version: "8.0"
+            driver-version: "stable"
+            dependencies: "highest"
+            symfony-version: "stable"
+            proxy: "native"
           # Test with extension 1.21
           - topology: "server"
             php-version: "8.2"
@@ -162,5 +169,6 @@ jobs:
         run: "vendor/bin/phpunit --exclude-group=atlas"
         env:
           DOCTRINE_MONGODB_SERVER: ${{ steps.setup-mongodb.outputs.cluster-uri }}
-          USE_LAZY_GHOST_OBJECTS: ${{ matrix.proxy == 'lazy-ghost' && '1' || '0' }}"
+          USE_LAZY_GHOST_OBJECT: ${{ matrix.proxy == 'lazy-ghost' && '1' || '0' }}"
+          USE_NATIVE_LAZY_OBJECT: ${{ matrix.proxy == 'native' && '1' || '0' }}"
           CRYPT_SHARED_LIB_PATH: ${{ steps.setup-mongodb.outputs.crypt-shared-lib-path }}

composer.json

@@ -71,6 +71,7 @@
             "Doctrine\\ODM\\MongoDB\\Tests\\": "tests/Doctrine/ODM/MongoDB/Tests",
             "Documentation\\": "tests/Documentation",
             "Documents\\": "tests/Documents",
+            "Documents84\\": "tests/Documents84",
             "Stubs\\": "tests/Stubs",
             "TestDocuments\\" :"tests/Doctrine/ODM/MongoDB/Tests/Mapping/Driver/fixtures"
         }

lib/Doctrine/ODM/MongoDB/Configuration.php

@@ -47,6 +47,8 @@
 use function trigger_deprecation;
 use function trim;
 
+use const PHP_VERSION_ID;
+
 /**
  * Configuration class for the DocumentManager. When setting up your DocumentManager
  * you can optionally specify an instance of this class as the second argument.
@@ -145,7 +147,8 @@ class Configuration
 
     private bool $useTransactionalFlush = false;
 
-    private bool $useLazyGhostObject = false;
+    private bool $lazyGhostObject  = false;
+    private bool $nativeLazyObject = false;
 
     private static string $version;
 
@@ -688,24 +691,47 @@ public function isTransactionalFlushEnabled(): bool
      */
     public function setUseLazyGhostObject(bool $flag): void
     {
+        if ($this->nativeLazyObject) {
+            throw new LogicException('Cannot enable or disable LazyGhostObject when native lazy objects are enabled.');
+        }
+
         if ($flag === false) {
             if (! class_exists(ProxyManagerConfiguration::class)) {
                 throw new LogicException('Package "friendsofphp/proxy-manager-lts" is required to disable LazyGhostObject.');
             }
 
-            trigger_deprecation(
-                'doctrine/mongodb-odm',
-                '2.10',
-                'Using "friendsofphp/proxy-manager-lts" is deprecated. Use "symfony/var-exporter" LazyGhostObjects instead.',
-            );
+            trigger_deprecation('doctrine/mongodb-odm', '2.10', 'Using "friendsofphp/proxy-manager-lts" is deprecated. Use "symfony/var-exporter" LazyGhostObjects instead.');
         }
 
-        $this->useLazyGhostObject = $flag;
+        if ($flag === true && PHP_VERSION_ID >= 80400) {
+            trigger_deprecation('doctrine/mongodb-odm', '2.14', 'Using "symfony/var-exporter" lazy ghost objects is deprecated and will be impossible in Doctrine MongoDB ODM 3.0.');
+        }
+
+        $this->lazyGhostObject = $flag;
     }
 
     public function isLazyGhostObjectEnabled(): bool
     {
-        return $this->useLazyGhostObject;
+        return $this->lazyGhostObject;
+    }
+
+    public function setUseNativeLazyObject(bool $nativeLazyObject): void
+    {
+        if (PHP_VERSION_ID < 80400 && $nativeLazyObject) {
+            throw new LogicException('Native lazy objects require PHP 8.4 or higher.');
+        }
+
+        $this->nativeLazyObject = $nativeLazyObject;
+        $this->lazyGhostObject  = ! $nativeLazyObject || $this->lazyGhostObject;
+    }
+
+    public function isNativeLazyObjectEnabled(): bool
+    {
+        if (PHP_VERSION_ID >= 80400 && ! $this->nativeLazyObject) {
+            trigger_deprecation('doctrine/mongodb-odm', '2.14', 'Not using native lazy objects is deprecated and will be impossible in Doctrine MongoDB ODM 3.0.');
+        }
+
+        return $this->nativeLazyObject;
     }
 
     /**

lib/Doctrine/ODM/MongoDB/DocumentManager.php

@@ -10,6 +10,7 @@
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactoryInterface;
 use Doctrine\ODM\MongoDB\Mapping\MappingException;
 use Doctrine\ODM\MongoDB\Proxy\Factory\LazyGhostProxyFactory;
+use Doctrine\ODM\MongoDB\Proxy\Factory\NativeLazyObjectFactory;
 use Doctrine\ODM\MongoDB\Proxy\Factory\ProxyFactory;
 use Doctrine\ODM\MongoDB\Proxy\Factory\StaticProxyFactory;
 use Doctrine\ODM\MongoDB\Proxy\Resolver\CachingClassNameResolver;
@@ -31,7 +32,6 @@
 use MongoDB\Driver\ClientEncryption;
 use MongoDB\Driver\ReadPreference;
 use MongoDB\GridFS\Bucket;
-use ProxyManager\Proxy\GhostObjectInterface;
 use RuntimeException;
 use Throwable;
 
@@ -179,11 +179,13 @@ protected function __construct(?Client $client = null, ?Configuration $config =
             $this->config->getAutoGenerateHydratorClasses(),
         );
 
-        $this->unitOfWork        = new UnitOfWork($this, $this->eventManager, $this->hydratorFactory);
-        $this->schemaManager     = new SchemaManager($this, $this->metadataFactory);
-        $this->proxyFactory      = $this->config->isLazyGhostObjectEnabled()
-            ? new LazyGhostProxyFactory($this, $this->config->getProxyDir(), $this->config->getProxyNamespace(), $this->config->getAutoGenerateProxyClasses())
-            : new StaticProxyFactory($this);
+        $this->unitOfWork    = new UnitOfWork($this, $this->eventManager, $this->hydratorFactory);
+        $this->schemaManager = new SchemaManager($this, $this->metadataFactory);
+        $this->proxyFactory  = match (true) {
+            $this->config->isNativeLazyObjectEnabled() => new NativeLazyObjectFactory($this),
+            $this->config->isLazyGhostObjectEnabled() => new LazyGhostProxyFactory($this, $this->config->getProxyDir(), $this->config->getProxyNamespace(), $this->config->getAutoGenerateProxyClasses()),
+            default => new StaticProxyFactory($this),
+        };
         $this->repositoryFactory = $this->config->getRepositoryFactory();
     }
 
@@ -607,7 +609,7 @@ public function flush(array $options = []): void
      * @param mixed           $identifier
      * @param class-string<T> $documentName
      *
-     * @return T|(T&GhostObjectInterface<T>)
+     * @return T
      *
      * @template T of object
      */
@@ -624,9 +626,8 @@ public function getReference(string $documentName, $identifier): object
             return $document;
         }
 
-        /** @var T&GhostObjectInterface<T> $document */
         $document = $this->proxyFactory->getProxy($class, $identifier);
-        $this->unitOfWork->registerManaged($document, $identifier, []);
+        $this->unitOfWork->registerManaged($document, $identifier, [$class->identifier => $identifier]);
 
         return $document;
     }

lib/Doctrine/ODM/MongoDB/Hydrator/HydratorFactory.php

@@ -33,6 +33,7 @@
 use function uniqid;
 
 use const DIRECTORY_SEPARATOR;
+use const PHP_VERSION_ID;
 
 /**
  * The HydratorFactory class is responsible for instantiating a correct hydrator
@@ -187,7 +188,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
         if (array_key_exists('%1$s', $data) && ($data['%1$s'] !== null || ($this->class->fieldMappings['%2$s']['nullable'] ?? false))) {
             $value = $data['%1$s'];
             %3$s
-            $this->class->reflFields['%2$s']->setValue($document, $return === null ? null : clone $return);
+            $this->class->propertyAccessors['%2$s']->setValue($document, $return === null ? null : clone $return);
             $hydratedData['%2$s'] = $return;
         }
 
@@ -210,7 +211,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
             } else {
                 \$return = null;
             }
-            \$this->class->reflFields['%2\$s']->setValue(\$document, \$return);
+            \$this->class->propertyAccessors['%2\$s']->setValue(\$document, \$return);
             \$hydratedData['%2\$s'] = \$return;
         }
 
@@ -239,7 +240,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
                 $return = $this->dm->getReference($className, $id);
             }
 
-            $this->class->reflFields['%2$s']->setValue($document, $return);
+            $this->class->propertyAccessors['%2$s']->setValue($document, $return);
             $hydratedData['%2$s'] = $return;
         }
 
@@ -256,7 +257,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
 
         $className = $this->class->fieldMappings['%2$s']['targetDocument'];
         $return = $this->dm->getRepository($className)->%3$s($document);
-        $this->class->reflFields['%2$s']->setValue($document, $return);
+        $this->class->propertyAccessors['%2$s']->setValue($document, $return);
         $hydratedData['%2$s'] = $return;
 
 EOF
@@ -280,7 +281,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
         );
         $sort = $this->class->fieldMappings['%2$s']['sort'] ?? [];
         $return = $this->dm->getUnitOfWork()->getDocumentPersister($className)->load($criteria, null, [], 0, $sort);
-        $this->class->reflFields['%2$s']->setValue($document, $return);
+        $this->class->propertyAccessors['%2$s']->setValue($document, $return);
         $hydratedData['%2$s'] = $return;
 
 EOF
@@ -307,7 +308,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
         if ($mongoData) {
             $return->setMongoData($mongoData);
         }
-        $this->class->reflFields['%2$s']->setValue($document, $return);
+        $this->class->propertyAccessors['%2$s']->setValue($document, $return);
         $hydratedData['%2$s'] = $return;
 
 EOF
@@ -345,7 +346,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
                 }
             }
 
-            $this->class->reflFields['%2$s']->setValue($document, $return);
+            $this->class->propertyAccessors['%2$s']->setValue($document, $return);
             $hydratedData['%2$s'] = $return;
         }
 
@@ -450,6 +451,10 @@ public function hydrate(object $document, array $data, array $hints = []): array
             }
         }
 
+        if (PHP_VERSION_ID >= 80400) {
+            $metadata->reflClass->markLazyObjectAsInitialized($document);
+        }
+
         if ($document instanceof InternalProxy) {
             // Skip initialization to not load any object data
             $document->__setInitialized(true);