feat: links handler

Author: soyuka

.github/workflows/ci.yml

@@ -858,7 +858,6 @@ jobs:
         run: |
           mkdir -p build/logs/behat
           vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction
-        continue-on-error: true
       - name: Upload test artifacts
         if: always()
         uses: actions/upload-artifact@v1

docs/adr/0003-uri-variables.md

@@ -37,7 +37,7 @@ We will use a POPO to define URI variables, for now these options are available:
 uriVariables: [
     'companyId' => new UriVariable(
         targetClass: Company::class,
-        inverseProperty: null,
+        targetProperty: null,
         property: 'company'
         identifiers: ['id'],
         compositeIdentifier: true,
@@ -53,7 +53,7 @@ Where `uriVariables` keys are the URI template's variable names. Its value is a
 
 - `targetClass` is the PHP FQDN of the class this value belongs to
 - `property` represents the property, the URI Variable is mapped to in the current class
-- `inverseProperty` represents the property, the URI Variable is mapped to in the related class and is not available in the current class
+- `targetProperty` represents the property, the URI Variable is mapped to in the related class and is not available in the current class
 - `identifiers` are the properties of the targetClass to which we map the URI variable
 - `compositeIdentifier` is used to match a single variable to multiple identifiers (`ida=1;idb=2` to `class::ida` and `class::idb`)
 
@@ -122,7 +122,7 @@ class Company {
 }
 ```
 
-Note that the above is a shortcut for: `new UriVariable(targetClass: Employee::class, inverseProperty: 'company')`
+Note that the above is a shortcut for: `new UriVariable(targetClass: Employee::class, targetProperty: 'company')`
 
 Corresponding DQL: 
 
@@ -259,7 +259,7 @@ class Employee {
 #[ApiResource("/employees/{employeeId}/company", uriVariables: [
     'employeeId' => new UriVariable(
         targetClass: Employee::class, 
-        inverseProperty: 'company'
+        targetProperty: 'company'
         property: null,
         identifiers: ['id'],
         compositeIdentifier: true

features/main/subresource.feature

@@ -223,7 +223,9 @@ Feature: Subresource support
     }
     """
 
+  @createSchema
   Scenario: Get the subresource relation item
+    Given there is a dummy object with a fourth level relation
     When I send a "GET" request to "/dummies/1/related_dummies/2"
     Then the response status code should be 200
     And the response should be in JSON
@@ -299,6 +301,7 @@ Feature: Subresource support
     }
     """
 
+  @createSchema
   Scenario: Get offers subresource from aggregate offers subresource
     Given I have a product with offers
     When I send a "GET" request to "/dummy_products/2/offers/1/offers"

src/Api/IdentifiersExtractor.php

@@ -94,13 +94,13 @@ private function getIdentifierValue($item, string $class, string $property, stri
                 continue;
             }
 
-            if ($type->getClassName() === $class) {
-                return $this->resolveIdentifierValue($this->propertyAccessor->getValue($item, "$propertyName.$property"), $parameterName);
-            }
-
             if ($type->isCollection() && ($collectionValueType = $type->getCollectionValueType()) && $collectionValueType->getClassName() === $class) {
                 return $this->resolveIdentifierValue($this->propertyAccessor->getValue($item, sprintf('%s[0].%s', $propertyName, $property)), $parameterName);
             }
+
+            if ($type->getClassName() === $class) {
+                return $this->resolveIdentifierValue($this->propertyAccessor->getValue($item, "$propertyName.$property"), $parameterName);
+            }
         }
 
         throw new RuntimeException('Not able to retrieve identifiers.');

src/Api/UriVariablesConverter.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Api;
 
 use ApiPlatform\Exception\InvalidUriVariableException;
+use ApiPlatform\Metadata\Link;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use Symfony\Component\PropertyInfo\Type;
@@ -46,10 +47,11 @@ public function convert(array $uriVariables, string $class, array $context = [])
     {
         $operation = $context['operation'] ?? $this->resourceMetadataCollectionFactory->create($class)->getOperation();
         $context = $context + ['operation' => $operation];
-        $uriVariablesDefinition = $operation->getUriVariables() ?? [];
+        $uriVariablesDefinitions = $operation->getUriVariables() ?? [];
 
         foreach ($uriVariables as $parameterName => $value) {
-            if ([] === $types = $this->getIdentifierTypes($uriVariablesDefinition[$parameterName]->getFromClass() ?? $class, $uriVariablesDefinition[$parameterName]->getIdentifiers() ?? [$parameterName])) {
+            $uriVariableDefinition = $uriVariablesDefinitions[$parameterName] ?? $uriVariablesDefinitions['id'] ?? new Link();
+            if ([] === $types = $this->getIdentifierTypes($uriVariableDefinition->getFromClass() ?? $class, $uriVariableDefinition->getIdentifiers() ?? [$parameterName])) {
                 continue;
             }
 

src/Bridge/Doctrine/Orm/State/CollectionProvider.php

@@ -61,6 +61,7 @@ public function provide(string $resourceClass, array $identifiers = [], ?string
 
         $this->handleLinks($queryBuilder, $identifiers, $queryNameGenerator, $context, $resourceClass, $operationName);
 
+        // dd($queryBuilder->getQuery());
         foreach ($this->collectionExtensions as $extension) {
             $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);
 

src/Bridge/Doctrine/Orm/State/ItemProvider.php

@@ -20,6 +20,7 @@
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\State\ProviderInterface;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\EntityRepository;
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
@@ -56,6 +57,7 @@ public function provide(string $resourceClass, array $identifiers = [], ?string
             return $manager->getReference($resourceClass, $identifiers);
         }
 
+        /** @var EntityRepository $repository */
         $repository = $manager->getRepository($resourceClass);
         if (!method_exists($repository, 'createQueryBuilder')) {
             throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');

src/Bridge/Doctrine/Orm/State/LinksHandlerTrait.php

@@ -16,9 +16,8 @@
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
 use ApiPlatform\Exception\RuntimeException;
 use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
-use ApiPlatform\Metadata\Link;
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\QueryBuilder;
-use Doctrine\Persistence\Mapping\ClassMetadata;
 
 trait LinksHandlerTrait
 {
@@ -31,81 +30,117 @@ private function handleLinks(QueryBuilder $queryBuilder, array $identifiers, Que
 
         $links = $operation instanceof GraphQlOperation ? $operation->getLinks() : $operation->getUriVariables();
 
-        if ($linkClass = $context['linkClass'] ?? false) {
-            foreach ($links as $link) {
-                if ($linkClass === $link->getFromClass()) {
-                    foreach ($identifiers as $identifier => $value) {
-                        $this->applyLink($queryBuilder, $queryNameGenerator, $doctrineClassMetadata, $alias, $link, $identifier, $value);
-                    }
+        // if ($linkClass = $context['linkClass'] ?? false) {
+        //     foreach ($links as $link) {
+        //         if ($linkClass === $link->getTargetClass()) {
+        //             foreach ($identifiers as $identifier => $value) {
+        //                 $this->applyLink($queryBuilder, $queryNameGenerator, $doctrineClassMetadata, $alias, $link, $identifier, $value);
+        //             }
+        //
+        //             return;
+        //         }
+        //     }
+        // }
 
-                    return;
-                }
+        if (!$links) {
+            return;
+        }
+
+        $previousAlias = $alias;
+        $previousIdentifiers = end($links)->getIdentifiers();
+        $expressions = [];
+        $identifiers = array_reverse($identifiers);
+
+        foreach (array_reverse($links) as $parameterName => $link) {
+            if ($link->getExpandedValue() || !$link->getFromClass()) {
+                continue;
             }
 
-            $operation = $this->resourceMetadataCollectionFactory->create($linkClass)->getOperation($operationName);
-            $links = $operation instanceof GraphQlOperation ? $operation->getLinks() : $operation->getUriVariables();
-            foreach ($links as $link) {
-                if ($resourceClass === $link->getFromClass()) {
-                    $link = $link->withFromProperty($link->getToProperty())->withFromClass($linkClass);
-                    foreach ($identifiers as $identifier => $value) {
-                        $this->applyLink($queryBuilder, $queryNameGenerator, $doctrineClassMetadata, $alias, $link, $identifier, $value);
-                    }
+            $identifierProperties = $link->getIdentifiers();
+            $currentAlias = $queryNameGenerator->generateJoinAlias($alias);
 
-                    return;
+            if ($link->getFromClass() === $resourceClass) {
+                $currentAlias = $alias;
+            }
+
+            if (!$link->getFromProperty() && !$link->getToProperty()) {
+                $doctrineClassMetadata = $manager->getClassMetadata($link->getFromClass());
+
+                foreach ($identifierProperties as $identifierProperty) {
+                    $placeholder = $queryNameGenerator->generateParameterName($identifierProperty);
+                    $queryBuilder->andWhere("{$currentAlias}.$identifierProperty = :$placeholder");
+                    $queryBuilder->setParameter($placeholder, array_shift($identifiers), $doctrineClassMetadata->getTypeOfField($identifierProperty));
                 }
+
+                $previousAlias = $currentAlias;
+                $previousIdentifiers = $identifierProperties;
+                continue;
             }
 
-            throw new RuntimeException(sprintf('The class "%s" cannot be retrieved from "%s".', $resourceClass, $linkClass));
-        }
+            if (1 < \count($previousIdentifiers) || 1 < \count($identifierProperties)) {
+                throw new RuntimeException('Composite identifiers on a relation can not be handled automatically, implement your own query.');
+            }
 
-        if (!$links) {
-            return;
-        }
+            $previousIdentifier = $previousIdentifiers[0];
+            $identifierProperty = $identifierProperties[0];
+            $placeholder = $queryNameGenerator->generateParameterName($identifierProperty);
+
+            if ($link->getFromProperty()) {
+                $doctrineClassMetadata = $manager->getClassMetadata($link->getFromClass());
+                $joinAlias = $queryNameGenerator->generateJoinAlias('m');
+                $assocationMapping = $doctrineClassMetadata->getAssociationMappings()[$link->getFromProperty()];
+                $relationType = $assocationMapping['type'];
+
+                if ($relationType & ClassMetadataInfo::TO_MANY) {
+                    $nextAlias = $queryNameGenerator->generateJoinAlias($alias);
+                    $expressions["$previousAlias.$previousIdentifier"] = "SELECT $joinAlias.{$previousIdentifier} FROM {$link->getFromClass()} $nextAlias INNER JOIN $nextAlias.{$link->getFromProperty()} $joinAlias WHERE $nextAlias.{$identifierProperty} = :$placeholder";
+                    $queryBuilder->setParameter($placeholder, array_shift($identifiers), $doctrineClassMetadata->getTypeOfField($identifierProperty));
+                    $previousAlias = $nextAlias;
+                    continue;
+                }
 
-        foreach ($identifiers as $identifier => $value) {
-            $link = $links[$identifier] ?? $links['id'];
+                // A single-valued association path expression to an inverse side is not supported in DQL queries.
+                if ($relationType & ClassMetadataInfo::TO_ONE && !$assocationMapping['isOwningSide']) {
+                    $queryBuilder->innerJoin("$previousAlias.".$assocationMapping['mappedBy'], $joinAlias);
+                } else {
+                    $queryBuilder->join(
+                        $link->getFromClass(),
+                        $joinAlias,
+                        'with',
+                        "{$previousAlias}.{$previousIdentifier} = $joinAlias.{$link->getFromProperty()}"
+                    );
+                }
+
+                $queryBuilder->andWhere("$joinAlias.$identifierProperty = :$placeholder");
+                $queryBuilder->setParameter($placeholder, array_shift($identifiers), $doctrineClassMetadata->getTypeOfField($identifierProperty));
+                $previousAlias = $joinAlias;
+                $previousIdentifier = $identifierProperty;
+                continue;
+            }
 
-            $this->applyLink($queryBuilder, $queryNameGenerator, $doctrineClassMetadata, $alias, $link, $identifier, $value);
+            $joinAlias = $queryNameGenerator->generateJoinAlias($alias);
+            $queryBuilder->join("{$previousAlias}.{$link->getToProperty()}", $joinAlias);
+            $queryBuilder->andWhere("$joinAlias.$identifierProperty = :$placeholder");
+            $queryBuilder->setParameter($placeholder, array_shift($identifiers), $doctrineClassMetadata->getTypeOfField($identifierProperty));
+            $previousAlias = $joinAlias;
+            $previousIdentifier = $identifierProperty;
         }
-    }
 
-    private function applyLink(QueryBuilder $queryBuilder, QueryNameGenerator $queryNameGenerator, ClassMetadata $doctrineClassMetadata, string $alias, Link $link, string $identifier, $value)
-    {
-        $placeholder = ':id_'.$identifier;
-        if ($fromProperty = $link->getFromProperty()) {
-            $propertyIdentifier = $link->getIdentifiers()[0];
-            $joinAlias = $queryNameGenerator->generateJoinAlias($fromProperty);
-
-            $queryBuilder->join(
-                $link->getFromClass(),
-                $joinAlias,
-                'with',
-                "$alias.$propertyIdentifier = $joinAlias.$fromProperty"
-            );
-
-            $expression = $queryBuilder->expr()->eq(
-                "{$joinAlias}.{$propertyIdentifier}",
-                $placeholder
-            );
-        } elseif ($property = $link->getToProperty()) {
-            $propertyIdentifier = $link->getIdentifiers()[0];
-            $joinAlias = $queryNameGenerator->generateJoinAlias($property);
-
-            $queryBuilder->join(
-                "$alias.$property",
-                $joinAlias,
-                );
-
-            $expression = $queryBuilder->expr()->eq(
-                "{$joinAlias}.{$propertyIdentifier}",
-                $placeholder
-            );
-        } else {
-            $expression = $queryBuilder->expr()->eq(
-                "{$alias}.{$identifier}", $placeholder
-            );
+        if ($expressions) {
+            $i = 0;
+            $clause = '';
+            foreach ($expressions as $alias => $expression) {
+                if (0 === $i) {
+                    $clause .= "$alias IN (".$expression;
+                    ++$i;
+                    continue;
+                }
+
+                $clause .= " AND $alias IN (".$expression;
+                ++$i;
+            }
+
+            $queryBuilder->andWhere($clause.str_repeat(')', $i));
         }
-        $queryBuilder->andWhere($expression);
-        $queryBuilder->setParameter($placeholder, $value, $doctrineClassMetadata->getTypeOfField($identifier));
     }
 }