fix(doctrine): FilterEagerLoadingExtension breaks DQL if property name endings matches with query builder aliases (#4592)

* Issue #4591 bugfix: FilterEagerLoadingExtension breaks DQL if property name endings matches with query builder aliases

* test: edit a unit test

* test: replace EmbeddableDummy class with DummyCarInfo

Author: bsidev

src/Bridge/Doctrine/Orm/Extension/FilterEagerLoadingExtension.php

@@ -141,14 +141,14 @@ private function getQueryBuilderWithNewAliases(QueryBuilder $queryBuilder, Query
         // Change join aliases
         foreach ($joinParts[$originAlias] as $joinPart) {
             /** @var Join $joinPart */
-            $joinString = str_replace($aliases, $replacements, $joinPart->getJoin());
+            $joinString = preg_replace($this->buildReplacePatterns($aliases), $replacements, $joinPart->getJoin());
             $pos = strpos($joinString, '.');
             if (false === $pos) {
                 if (null !== $joinPart->getCondition() && null !== $this->resourceClassResolver && $this->resourceClassResolver->isResourceClass($joinString)) {
                     $newAlias = $queryNameGenerator->generateJoinAlias($joinPart->getAlias());
                     $aliases[] = "{$joinPart->getAlias()}.";
                     $replacements[] = "$newAlias.";
-                    $condition = str_replace($aliases, $replacements, $joinPart->getCondition());
+                    $condition = preg_replace($this->buildReplacePatterns($aliases), $replacements, $joinPart->getCondition());
                     $join = new Join($joinPart->getJoinType(), $joinPart->getJoin(), $newAlias, $joinPart->getConditionType(), $condition);
                     /* @phpstan-ignore-next-line */
                     $queryBuilderClone->add('join', [$replacement => $join], true);
@@ -161,12 +161,19 @@ private function getQueryBuilderWithNewAliases(QueryBuilder $queryBuilder, Query
             $newAlias = $queryNameGenerator->generateJoinAlias($association);
             $aliases[] = "{$joinPart->getAlias()}.";
             $replacements[] = "$newAlias.";
-            $condition = str_replace($aliases, $replacements, $joinPart->getCondition() ?? '');
+            $condition = preg_replace($this->buildReplacePatterns($aliases), $replacements, $joinPart->getCondition() ?? '');
             QueryBuilderHelper::addJoinOnce($queryBuilderClone, $queryNameGenerator, $alias, $association, $joinPart->getJoinType(), $joinPart->getConditionType(), $condition, $originAlias, $newAlias);
         }
 
-        $queryBuilderClone->add('where', str_replace($aliases, $replacements, (string) $wherePart));
+        $queryBuilderClone->add('where', preg_replace($this->buildReplacePatterns($aliases), $replacements, (string) $wherePart));
 
         return $queryBuilderClone;
     }
+
+    private function buildReplacePatterns(array $aliases): array
+    {
+        return array_map(static function (string $alias): string {
+            return '/\b'.preg_quote($alias, '/').'/';
+        }, $aliases);
+    }
 }

tests/Bridge/Doctrine/Orm/Extension/FilterEagerLoadingExtensionTest.php

@@ -232,7 +232,9 @@ public function testApplyCollectionCorrectlyReplacesJoinCondition()
             ->from(DummyCar::class, 'o')
             ->leftJoin('o.colors', 'colors', 'ON', 'o.id = colors.car AND colors.id IN (1,2,3)')
             ->where('o.colors = :foo')
-            ->setParameter('foo', 1);
+            ->andWhere('o.info.name = :bar')
+            ->setParameter('foo', 1)
+            ->setParameter('bar', 'a');
 
         $queryNameGenerator = $this->prophesize(QueryNameGeneratorInterface::class);
         $queryNameGenerator->generateJoinAlias('colors')->shouldBeCalled()->willReturn('colors_2');
@@ -248,7 +250,7 @@ public function testApplyCollectionCorrectlyReplacesJoinCondition()
 WHERE o IN(
   SELECT o_2 FROM ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar o_2
   LEFT JOIN o_2.colors colors_2 ON o_2.id = colors_2.car AND colors_2.id IN (1,2,3)
-  WHERE o_2.colors = :foo
+  WHERE o_2.colors = :foo AND o_2.info.name = :bar
 )
 SQL;
 

tests/Fixtures/TestBundle/Entity/DummyCar.php

@@ -124,10 +124,18 @@ class DummyCar
      */
     private $brand = 'DummyBrand';
 
+    /**
+     * @var DummyCarInfo
+     *
+     * @ORM\Embedded(class="DummyCarInfo")
+     */
+    private $info;
+
     public function __construct()
     {
         $this->id = new DummyCarIdentifier();
         $this->colors = new ArrayCollection();
+        $this->info = new DummyCarInfo();
     }
 
     public function getId()
@@ -219,4 +227,14 @@ public function setBrand(string $brand): void
     {
         $this->brand = $brand;
     }
+
+    public function getInfo(): DummyCarInfo
+    {
+        return $this->info;
+    }
+
+    public function setInfo(DummyCarInfo $info): void
+    {
+        $this->info = $info;
+    }
 }

tests/Fixtures/TestBundle/Entity/DummyCarInfo.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @author Sergey Balasov <[email protected]>
+ *
+ * @ORM\Embeddable
+ */
+class DummyCarInfo
+{
+    /**
+     * @var string
+     *
+     * @ORM\Column(nullable=true)
+     */
+    public $name;
+}

tests/Util/AnnotationFilterExtractorTraitTest.php

@@ -41,7 +41,7 @@ public function testReadAnnotations()
 
         $this->assertEquals($this->extractor->getFilters($reflectionClass), [
             'annotated_api_platform_core_tests_fixtures_test_bundle_entity_dummy_car_api_platform_core_bridge_doctrine_orm_filter_date_filter' => [
-                ['properties' => ['id' => 'exclude_null', 'colors' => 'exclude_null', 'name' => 'exclude_null', 'canSell' => 'exclude_null', 'availableAt' => 'exclude_null', 'brand' => 'exclude_null', 'secondColors' => 'exclude_null', 'thirdColors' => 'exclude_null', 'uuid' => 'exclude_null']],
+                ['properties' => ['id' => 'exclude_null', 'colors' => 'exclude_null', 'name' => 'exclude_null', 'canSell' => 'exclude_null', 'availableAt' => 'exclude_null', 'brand' => 'exclude_null', 'secondColors' => 'exclude_null', 'thirdColors' => 'exclude_null', 'uuid' => 'exclude_null', 'info' => 'exclude_null']],
                 DateFilter::class,
             ],
             'annotated_api_platform_core_tests_fixtures_test_bundle_entity_dummy_car_api_platform_core_bridge_doctrine_orm_filter_boolean_filter' => [