fix(ProxyGenerator): Prevent Doctrine entities from being proxied.

Author: priyadi

CHANGELOG.md

@@ -15,6 +15,7 @@
 * fix: Fix deprecations.
 * refactor(`ProxyGeneratorInterface`): Use class as input. Remove dependency on `ObjectToObjectMetadata`.
 * refactor(`ProxyGeneratorInterface`): Move proxy namespace to top-level namespace.
+* fix(`ProxyGenerator`): Prevent Doctrine entities from being proxied.
 
 ## 0.7.3
 

config/services.php

@@ -27,6 +27,7 @@
 use Rekalogika\Mapper\Mapping\Implementation\WarmableMappingFactory;
 use Rekalogika\Mapper\Mapping\MappingFactoryInterface;
 use Rekalogika\Mapper\ObjectCache\Implementation\ObjectCacheFactory;
+use Rekalogika\Mapper\Proxy\Implementation\DoctrineProxyGenerator;
 use Rekalogika\Mapper\Proxy\Implementation\ProxyGenerator;
 use Rekalogika\Mapper\Proxy\Implementation\ProxyRegistry;
 use Rekalogika\Mapper\SubMapper\Implementation\SubMapperFactory;
@@ -377,6 +378,14 @@
     $services
         ->set('rekalogika.mapper.proxy_generator', ProxyGenerator::class);
 
+    $services
+        ->set('rekalogika.mapper.proxy_generator.doctrine', DoctrineProxyGenerator::class)
+        ->decorate('rekalogika.mapper.proxy_generator')
+        ->args([
+            service('.inner'),
+            service('doctrine'),
+        ]);
+
     $services
         ->set('rekalogika.mapper.proxy_registry', ProxyRegistry::class)
         ->args([

src/Proxy/Exception/ProxyNotSupportedException.php

@@ -22,8 +22,11 @@ class ProxyNotSupportedException extends RuntimeException
     /**
      * @param class-string $class
      */
-    public function __construct(string $class, \Throwable $previous)
-    {
+    public function __construct(
+        string $class,
+        ?string $reason = null,
+        ?\Throwable $previous = null
+    ) {
         parent::__construct(
             sprintf(
                 'Creating a proxy for class "%s" is not supported.',
@@ -32,7 +35,11 @@ public function __construct(string $class, \Throwable $previous)
             previous: $previous
         );
 
-        $this->reason = $previous->getMessage();
+        $this->reason = $reason ?? $previous?->getMessage() ?? sprintf(
+            'Reason is not provided, thrown by "%s", line %d.',
+            $this->getFile(),
+            $this->getLine()
+        );
     }
 
     public function getReason(): string

src/Proxy/Implementation/DoctrineProxyGenerator.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of rekalogika/mapper package.
+ *
+ * (c) Priyadi Iman Nurcahyo <https://rekalogika.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE file
+ * that was distributed with this source code.
+ */
+
+namespace Rekalogika\Mapper\Proxy\Implementation;
+
+use Doctrine\Persistence\ManagerRegistry;
+use Rekalogika\Mapper\Proxy\Exception\ProxyNotSupportedException;
+use Rekalogika\Mapper\Proxy\ProxyGeneratorInterface;
+use Rekalogika\Mapper\Proxy\ProxySpecification;
+
+/**
+ * Prevent proxy creation for Doctrine entities.
+ */
+final class DoctrineProxyGenerator implements ProxyGeneratorInterface
+{
+    public function __construct(
+        private ProxyGeneratorInterface $decorated,
+        private ManagerRegistry $managerRegistry
+    ) {
+    }
+
+    public function generateProxy(string $class): ProxySpecification
+    {
+        $manager = $this->managerRegistry->getManagerForClass($class);
+
+        if ($manager) {
+            throw new ProxyNotSupportedException($class, reason: 'Doctrine entities do not support proxying.');
+        }
+
+        return $this->decorated->generateProxy($class);
+    }
+}

src/Proxy/Implementation/ProxyGenerator.php

@@ -29,7 +29,7 @@ public function generateProxy(string $class): ProxySpecification
         try {
             $proxyCode = $this->generateProxyCode($class);
         } catch (LogicException $e) {
-            throw new ProxyNotSupportedException($class, $e);
+            throw new ProxyNotSupportedException($class, previous: $e);
         }
 
         return new ProxySpecification($proxyClass, $proxyCode);

tests/Fixtures/Doctrine/SimpleEntity.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of rekalogika/mapper package.
+ *
+ * (c) Priyadi Iman Nurcahyo <https://rekalogika.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE file
+ * that was distributed with this source code.
+ */
+
+namespace Rekalogika\Mapper\Tests\Fixtures\Doctrine;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+class SimpleEntity
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column()]
+    private ?int $id = null;
+
+    #[ORM\Column()]
+    private ?string $name = null;
+
+    public function getId(): int
+    {
+        if ($this->id === null) {
+            throw new \LogicException('The identifier is not set.');
+        }
+        return $this->id;
+    }
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(?string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+}

tests/Fixtures/Doctrine/SimpleEntityInputDto.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of rekalogika/mapper package.
+ *
+ * (c) Priyadi Iman Nurcahyo <https://rekalogika.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE file
+ * that was distributed with this source code.
+ */
+
+namespace Rekalogika\Mapper\Tests\Fixtures\Doctrine;
+
+class SimpleEntityInputDto
+{
+    public ?string $name = null;
+}

tests/IntegrationTest/DoctrineTest.php

@@ -17,6 +17,8 @@
 use Rekalogika\Mapper\Tests\Fixtures\Doctrine\EntityWithMultipleIdentifier;
 use Rekalogika\Mapper\Tests\Fixtures\Doctrine\EntityWithSingleIdentifier;
 use Rekalogika\Mapper\Tests\Fixtures\Doctrine\EntityWithSingleIdentifierDto;
+use Rekalogika\Mapper\Tests\Fixtures\Doctrine\SimpleEntity;
+use Rekalogika\Mapper\Tests\Fixtures\Doctrine\SimpleEntityInputDto;
 use Rekalogika\Mapper\Transformer\EagerPropertiesResolver\EagerPropertiesResolverInterface;
 use Rekalogika\Mapper\Transformer\EagerPropertiesResolver\Implementation\DoctrineEagerPropertiesResolver;
 use Symfony\Component\VarExporter\LazyObjectInterface;
@@ -101,5 +103,13 @@ public function testCompositeId(): void
         $this->assertEquals(['id1', 'id2'], $eagerProperties);
     }
 
+    public function testInputDtoToEntityMapping(): void
+    {
+        $input = new SimpleEntityInputDto();
+        $input->name = 'my-name';
+
+        $entity = $this->mapper->map($input, SimpleEntity::class);
+        $this->assertNotInstanceOf(LazyObjectInterface::class, $entity);
+    }
 
 }