bug #48097 Fix search scope when performing fallback mapping driver detection (spideyfusion)

fabpot · fabpot · commit b25499d70dab · 2022-11-04T07:16:00.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- Fix search scope when performing fallback mapping driver detection | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a When using `auto_mapping` inside `orm` configuration to enable automatic entity registration for all bundles that are used within your application, the fallback mechanism for determining which mapping driver should be used for extracting entity information has a wrong starting point. Instead of beginning its search from the `Entity` folder, the entire bundle root gets traversed recursively, which can lead to wrong mapping driver being selected or just plainly having a performance hit during development just because the potential list of files that need to be examined can get huge. We actually stumbled upon this bug because we noticed a big jump in memory usage during development (`850+ MB vs ~100 MB`) ever since we switched to using attributes for describing our entities. Turns out, the `DoctrineBridge` was scanning all files inside our `Resources` folder (and we had **a lot** of files in there). Commits ------- c305722 Fix search scope when performing fallback mapping driver detection
diff --git a/src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php b/src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php
@@ -279,8 +279,8 @@ protected function detectMetadataDriver(string $dir, ContainerBuilder $container
             }
             $container->fileExists($resource, false);
 
-            if ($container->fileExists($dir.'/'.$this->getMappingObjectDefaultName(), false)) {
-                return $this->detectMappingType($dir, $container);
+            if ($container->fileExists($discoveryPath = $dir.'/'.$this->getMappingObjectDefaultName(), false)) {
+                return $this->detectMappingType($discoveryPath, $container);
             }
 
             return null;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Bundles/AttributesBundle/AnnotatedEntity/Person.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Bundles/AttributesBundle/AnnotatedEntity/Person.php
@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\AttributesBundle\AnnotatedEntity;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Id;
+
+/**
+ * @Entity
+ */
+class Person
+{
+    /** @Id @Column(type="integer") */
+    protected $id;
+
+    /** @Column(type="string") */
+    public $name;
+
+    public function __construct($id, $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function __toString(): string
+    {
+        return (string) $this->name;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -279,8 +279,8 @@ protected function detectMetadataDriver(string $dir, ContainerBuilder $container`
`279`	`279`	`}`
`280`	`280`	`$container->fileExists($resource, false);`
`281`	`281`
`282`		`- if ($container->fileExists($dir.'/'.$this->getMappingObjectDefaultName(), false)) {`
`283`		`- return $this->detectMappingType($dir, $container);`
	`282`	`+ if ($container->fileExists($discoveryPath = $dir.'/'.$this->getMappingObjectDefaultName(), false)) {`
	`283`	`+ return $this->detectMappingType($discoveryPath, $container);`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`return null;`