Remove proxy class generators, only native lazy objects are supported

Remove dependencies to proxy-manager and var-exporter

Author: GromNaN

.github/workflows/continuous-integration.yml

@@ -111,7 +111,6 @@ jobs:
       - name: "Remove optional dependencies"
         if: "${{ matrix.remove-optional-dependencies }}"
         run: |
-          composer remove --no-update friendsofphp/proxy-manager-lts symfony/var-exporter
           composer remove --no-update --dev symfony/cache doctrine/orm doctrine/annotations
           composer remove --no-update --dev doctrine/coding-standard phpstan/phpstan phpstan/phpstan-deprecation-rule phpstan/phpstan-phpunit
 
@@ -138,6 +137,4 @@ jobs:
         run: "vendor/bin/phpunit --exclude-group=atlas ${{ matrix.dependencies == 'lowest' && '--do-not-fail-on-deprecation --do-not-fail-on-warning --do-not-fail-on-notice' || '' }}"
         env:
           DOCTRINE_MONGODB_SERVER: ${{ steps.setup-mongodb.outputs.cluster-uri }}
-          USE_LAZY_GHOST_OBJECT: 0
-          USE_NATIVE_LAZY_OBJECT: 1
           CRYPT_SHARED_LIB_PATH: ${{ steps.setup-mongodb.outputs.crypt-shared-lib-path }}

UPGRADE-3.0.md

@@ -47,14 +47,26 @@ no longer implements the `PropertyChangedListener` interface.
 `AnnotationDriver` class defined in `doctrine/persistence` (or in ODM's 
 compatibility layer)
 
-## Proxy Class Name Resolution
+## Proxy Classes replaced by Native Lazy Objects
+
+The proxy system based on generated proxy classes has been replaced by
+native PHP lazy objects. The proxy classes don't exist anymore and don't
+need to be generated.
+
+The following methods have been removed from `Doctrine\ODM\MongoDB\Configuration`:
+- `setProxyDir` and `getProxyDir`,
+- `setProxyNamespace` and `getProxyNamespace`,
+- `setUseLazyGhostObject` and `getUseLazyGhostObject`,
+- `setUseNativeLazyObject` and `getUseNativeLazyObject`,
+- `getProxyManagerConfiguration`
+- `getProxyFactory`
 
 The `Doctrine\ODM\MongoDB\Proxy\Resolver\ClassNameResolver` interface has been
 dropped in favor of the `Doctrine\Persistence\Mapping\ProxyClassNameResolver`
 interface.
 
 The `getClassNameResolver` method in `DocumentManager` has been removed. To
-retrieve the mapped class name for any object or class string,  fetch metadata
+retrieve the mapped class name for any object or class string, fetch metadata
 for the class and read the class using `$metadata->getName()`. The metadata
 layer is aware of these proxy namespace changes and how to resolve them, so
 users should always go through the metadata layer to retrieve mapped class

benchmark/BaseBench.php

@@ -32,16 +32,13 @@ public function initDocumentManager(): void
     {
         $config = new Configuration();
 
-        $config->setProxyDir(__DIR__ . '/../../tests/Proxies');
-        $config->setProxyNamespace('Proxies');
         $config->setHydratorDir(__DIR__ . '/../../tests/Hydrators');
         $config->setHydratorNamespace('Hydrators');
         $config->setPersistentCollectionDir(__DIR__ . '/../../tests/PersistentCollections');
         $config->setPersistentCollectionNamespace('PersistentCollections');
         $config->setDefaultDB(self::DATABASE_NAME);
         $config->setMetadataDriverImpl(self::createMetadataDriverImpl());
         $config->setMetadataCache(new ArrayAdapter());
-        $config->setUseNativeLazyObject(true);
 
         $client = new Client(
             getenv('DOCTRINE_MONGODB_SERVER') ?: self::DEFAULT_MONGODB_SERVER,

composer.json

@@ -34,12 +34,10 @@
         "doctrine/event-manager": "^1.0 || ^2.0",
         "doctrine/instantiator": "^1.1 || ^2",
         "doctrine/persistence": "^3.2 || ^4",
-        "friendsofphp/proxy-manager-lts": "^1.0",
         "mongodb/mongodb": "^2.1.1",
         "psr/cache": "^1.0 || ^2.0 || ^3.0",
         "symfony/console": "^5.4 || ^6.4 || ^7.0 || ^8.0",
-        "symfony/deprecation-contracts": "^2.2 || ^3.0",
-        "symfony/var-exporter": "^6.4.1 || ^7.0 || ^8.0"
+        "symfony/deprecation-contracts": "^2.2 || ^3.0"
     },
     "require-dev": {
         "ext-bcmath": "*",

docs/en/cookbook/blending-orm-and-mongodb-odm.rst

@@ -200,9 +200,8 @@ The above would output the following:
     (
         [id:Entities\Order:private] => 53
         [productId:Entities\Order:private] => 4c74a1868ead0ed7a9000000
-        [product:Entities\Order:private] => Proxies\DocumentsProductProxy Object
+        [product:Entities\Order:private] => Entities\Order Object
             (
-                [__isInitialized__] => 1
                 [id:Documents\Product:private] => 4c74a1868ead0ed7a9000000
                 [title:Documents\Product:private] => Test Product
             )

docs/en/cookbook/queryable-encryption.rst

@@ -147,8 +147,6 @@ to ``<database>.datakeys`` by default, but you can change it using the
     ]);
 
     // Other configuration
-    $config->setProxyDir(__DIR__ . '/Proxies');
-    $config->setProxyNamespace('Proxies');
     $config->setHydratorDir(__DIR__ . '/Hydrators');
     $config->setHydratorNamespace('Hydrators');
     $config->setPersistentCollectionDir(__DIR__ . '/PersistentCollections');

docs/en/reference/architecture.rst

@@ -72,18 +72,10 @@ subsequent access must be through the interface type.
 Serializing documents
 ~~~~~~~~~~~~~~~~~~~~~
 
-Serializing documents can be problematic and is not really
-recommended, at least not as long as a document instance still holds
-references to proxy objects or is still managed by an
-DocumentManager. If you intend to serialize (and unserialize) document
-instances that still hold references to proxy objects you may run
-into problems with private properties because of technical
-limitations. Proxy objects implement ``__sleep`` and it is not
-possible for ``__sleep`` to return names of private properties in
-parent classes. On the other hand it is not a solution for proxy
-objects to implement ``Serializable`` because Serializable does not
-work well with any potential cyclic object references (at least we
-did not find a way yet, if you did, please contact us).
+Calling `serialize` for serializing documents does not trigger initialization
+of lazy objects in relations. Instead, only the identifier fields are serialized.
+When unserializing, the objects that were not initialized before serialization
+will not contain any data except for the identifier fields. They cannot be used.
 
 The DocumentManager
 -------------------

docs/en/reference/bidirectional-references.rst

@@ -170,8 +170,8 @@ you must null it out on the ``Cart.customer`` side:
 .. note::
 
     When specifying inverse one-to-one relationships the referenced document is
-    loaded directly when the owning document is hydrated instead of using a
-    proxy. In the example above, loading a ``Customer`` object from the database
+    loaded directly when the owning document is hydrated instead of using a lazy
+    object. In the example above, loading a ``Customer`` object from the database
     would also cause the corresponding ``Cart`` to be loaded. This can cause
     performance issues when loading many ``Customer`` objects at once.
 

docs/en/reference/console-commands.rst

@@ -7,7 +7,6 @@ Console component, to ease your development process:
 - ``odm:clear-cache:metadata`` - Clear all metadata cache of the various cache drivers.
 - ``odm:query`` - Query mongodb and inspect the outputted results from your document classes.
 - ``odm:generate:hydrators`` - Generates hydrator classes for document classes.
-- ``odm:generate:proxies`` - Generates proxy classes for document classes.
 - ``odm:schema:create`` - Allows you to create databases, collections and indexes for your documents
 - ``odm:schema:drop`` - Allows you to drop databases, collections and indexes for your documents
 - ``odm:schema:update`` - Allows you to update indexes for your documents

docs/en/reference/events.rst

@@ -183,7 +183,7 @@ the life-time of their registered documents.
    ``onClear`` - The onClear event occurs after the UnitOfWork has had
    its state cleared.
 -
-   ``documentNotFound`` - The documentNotFound event occurs when a proxy object
+   ``documentNotFound`` - The documentNotFound event occurs when a lazy object
    could not be initialized. This event is not a lifecycle callback.
 -
    ``postCollectionLoad`` - The postCollectionLoad event occurs just after
@@ -644,7 +644,7 @@ Define the ``EventTest`` class with a ``documentNotFound()`` method:
     {
         public function documentNotFound(\Doctrine\ODM\MongoDB\Event\DocumentNotFoundEventArgs $eventArgs): void
         {
-            $proxy = $eventArgs->getObject();
+            $document = $eventArgs->getObject();
             $identifier = $eventArgs->getIdentifier();
             // do something
             // To prevent the documentNotFound exception from being thrown, call the disableException() method: