Merge pull request #859 from soyuka/proposal-circular-eager-loading

Proposal to avoid join recursivity in eager loading

Author: dunglas

features/main/circular_reference.feature

@@ -4,7 +4,6 @@ Feature: Circular references handling
   I should be able to catch circular references.
 
   @createSchema
-  @dropSchema
   Scenario: Create a circular reference
     When I add "Content-Type" header equal to "application/ld+json"
     And I send a "POST" request to "/circular_references" with body:
@@ -33,3 +32,39 @@ Feature: Circular references handling
       ]
     }
     """
+
+  @dropSchema
+  Scenario: Fetch circular reference
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "POST" request to "/circular_references" with body:
+    """
+    {}
+    """
+    And I add "Content-Type" header equal to "application/ld+json"
+    And I send a "PUT" request to "/circular_references/2" with body:
+    """
+    {
+      "parent": "/circular_references/1"
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/CircularReference",
+      "@id": "/circular_references/2",
+      "@type": "CircularReference",
+      "parent": {
+          "@id": "/circular_references/1",
+          "@type": "CircularReference",
+          "parent": "/circular_references/1",
+          "children": [
+              "/circular_references/1",
+              "/circular_references/2"
+          ]
+      },
+      "children": []
+    }
+    """

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

@@ -151,6 +151,11 @@ private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInt
                 continue;
             }
 
+            if ($mapping['targetEntity'] === $resourceClass) {
+                $queryBuilder->addSelect($associationAlias);
+                continue;
+            }
+
             $this->joinRelations($queryBuilder, $queryNameGenerator, $mapping['targetEntity'], $forceEager, $associationAlias, $propertyMetadataOptions, $method === 'leftJoin', $joinCount);
         }
     }

tests/Fixtures/TestBundle/Entity/CircularReference.php

@@ -21,7 +21,7 @@
  *
  * @author Kévin Dunglas <[email protected]>
  *
- * @ApiResource(attributes={"normalization_context"={"groups": {"circular"}}, "force_eager"=false})
+ * @ApiResource(attributes={"normalization_context"={"groups": {"circular"}}})
  * @ORM\Entity
  */
 class CircularReference