Skip to content

Refactor cycle breaking (visited tracking) in SubresourceOperationFactory #1279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Refactor cycle breaking (visited tracking) in SubresourceOperationFactory #1279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions src/Operation/Factory/SubresourceOperationFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,9 @@ public function create(string $resourceClass): array
* @param array $tree
* @param string $rootResourceClass null on the first iteration, it then keeps track of the origin resource class
* @param array $parentOperation the previous call operation
* @param array $visited
*/
private function computeSubresourceOperations(string $resourceClass, array &$tree, string $rootResourceClass = null, array $parentOperation = null, $parentVisiting = null)
private function computeSubresourceOperations(string $resourceClass, array &$tree, string $rootResourceClass = null, array $parentOperation = null, array $visited = [])
{
if (null === $rootResourceClass) {
$rootResourceClass = $resourceClass;
Expand All @@ -76,16 +77,9 @@ private function computeSubresourceOperations(string $resourceClass, array &$tre
$subresourceClass = $subresource->getResourceClass();
$subresourceMetadata = $this->resourceMetadataFactory->create($subresourceClass);

if (null === $parentOperation) {
$visiting = "$rootResourceClass-$property-$subresourceClass";
} else {
$suffix = "$property-$subresourceClass";

if (false !== strpos($parentVisiting, $suffix)) {
continue;
}

$visiting = "$parentVisiting-$suffix";
$visiting = "$resourceClass $property $subresourceClass";
if (isset($visited[$visiting])) {
continue;
}

$operationName = 'get';
Expand Down Expand Up @@ -137,9 +131,9 @@ private function computeSubresourceOperations(string $resourceClass, array &$tre
$operation['path'] .= sprintf('/%s%s', $this->pathSegmentNameGenerator->getSegmentName($property, $operation['collection']), self::FORMAT_SUFFIX);
}

$tree[$visiting] = $operation;
$tree[$operation['route_name']] = $operation;

$this->computeSubresourceOperations($subresourceClass, $tree, $rootResourceClass, $operation, $visiting);
$this->computeSubresourceOperations($subresourceClass, $tree, $rootResourceClass, $operation, $visited + [$visiting => true]);
}
}
}
14 changes: 7 additions & 7 deletions tests/Bridge/Symfony/Routing/ApiLoaderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public function testApiLoader()
);

$this->assertEquals(
$this->getSubresourceRoute('/dummies/{id}/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_dummies_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', DummyEntity::class, true]], 'collection' => true, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\DummyEntity-subresource-ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity']),
$this->getSubresourceRoute('/dummies/{id}/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_dummies_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', DummyEntity::class, true]], 'collection' => true, 'operationId' => 'api_dummies_subresources_get_subresource']),
$routeCollection->get('api_dummies_subresources_get_subresource')
);
}
Expand Down Expand Up @@ -160,32 +160,32 @@ public function testRecursiveSubresource()
$routeCollection = $this->getApiLoaderWithResourceMetadata($resourceMetadata, true)->load(null);

$this->assertEquals(
$this->getSubresourceRoute('/dummies/{id}/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_dummies_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', DummyEntity::class, true]], 'collection' => true, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\DummyEntity-subresource-ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity']),
$this->getSubresourceRoute('/dummies/{id}/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_dummies_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', DummyEntity::class, true]], 'collection' => true, 'operationId' => 'api_dummies_subresources_get_subresource']),
$routeCollection->get('api_dummies_subresources_get_subresource')
);

$this->assertEquals(
$this->getSubresourceRoute('/related_dummies/{id}/recursivesubresource/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_related_dummies_recursivesubresource_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', RelatedDummyEntity::class, true], ['recursivesubresource', DummyEntity::class, false]], 'collection' => true, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity-recursivesubresource-ApiPlatform\Core\Tests\Fixtures\DummyEntity-subresource-ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity']),
$this->getSubresourceRoute('/related_dummies/{id}/recursivesubresource/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_related_dummies_recursivesubresource_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', RelatedDummyEntity::class, true], ['recursivesubresource', DummyEntity::class, false]], 'collection' => true, 'operationId' => 'api_related_dummies_recursivesubresource_subresources_get_subresource']),
$routeCollection->get('api_related_dummies_recursivesubresource_subresources_get_subresource')
);

$this->assertEquals(
$this->getSubresourceRoute('/related_dummies/{id}/recursivesubresource.{_format}', 'api_platform.action.get_subresource', DummyEntity::class, 'api_related_dummies_recursivesubresource_get_subresource', ['property' => 'recursivesubresource', 'identifiers' => [['id', RelatedDummyEntity::class, true]], 'collection' => false, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity-recursivesubresource-ApiPlatform\Core\Tests\Fixtures\DummyEntity']),
$this->getSubresourceRoute('/related_dummies/{id}/recursivesubresource.{_format}', 'api_platform.action.get_subresource', DummyEntity::class, 'api_related_dummies_recursivesubresource_get_subresource', ['property' => 'recursivesubresource', 'identifiers' => [['id', RelatedDummyEntity::class, true]], 'collection' => false, 'operationId' => 'api_related_dummies_recursivesubresource_get_subresource']),
$routeCollection->get('api_related_dummies_recursivesubresource_get_subresource')
);

$this->assertEquals(
$this->getSubresourceRoute('/dummies/{id}/subresources/{subresource}/recursivesubresource.{_format}', 'api_platform.action.get_subresource', DummyEntity::class, 'api_dummies_subresources_recursivesubresource_get_subresource', ['property' => 'recursivesubresource', 'identifiers' => [['id', DummyEntity::class, true], ['subresource', RelatedDummyEntity::class, true]], 'collection' => false, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\DummyEntity-subresource-ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity-recursivesubresource-ApiPlatform\Core\Tests\Fixtures\DummyEntity']),
$this->getSubresourceRoute('/dummies/{id}/subresources/{subresource}/recursivesubresource.{_format}', 'api_platform.action.get_subresource', DummyEntity::class, 'api_dummies_subresources_recursivesubresource_get_subresource', ['property' => 'recursivesubresource', 'identifiers' => [['id', DummyEntity::class, true], ['subresource', RelatedDummyEntity::class, true]], 'collection' => false, 'operationId' => 'api_dummies_subresources_recursivesubresource_get_subresource']),
$routeCollection->get('api_dummies_subresources_recursivesubresource_get_subresource')
);

$this->assertEquals(
$this->getSubresourceRoute('/related_dummies/{id}/secondrecursivesubresource/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_related_dummies_secondrecursivesubresource_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', RelatedDummyEntity::class, true], ['secondrecursivesubresource', DummyEntity::class, false]], 'collection' => true, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity-secondrecursivesubresource-ApiPlatform\Core\Tests\Fixtures\DummyEntity-subresource-ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity']),
$this->getSubresourceRoute('/related_dummies/{id}/secondrecursivesubresource/subresources.{_format}', 'api_platform.action.get_subresource', RelatedDummyEntity::class, 'api_related_dummies_secondrecursivesubresource_subresources_get_subresource', ['property' => 'subresource', 'identifiers' => [['id', RelatedDummyEntity::class, true], ['secondrecursivesubresource', DummyEntity::class, false]], 'collection' => true, 'operationId' => 'api_related_dummies_secondrecursivesubresource_subresources_get_subresource']),
$routeCollection->get('api_related_dummies_secondrecursivesubresource_subresources_get_subresource')
);

$this->assertEquals(
$this->getSubresourceRoute('/related_dummies/{id}/secondrecursivesubresource.{_format}', 'api_platform.action.get_subresource', DummyEntity::class, 'api_related_dummies_secondrecursivesubresource_get_subresource', ['property' => 'secondrecursivesubresource', 'identifiers' => [['id', RelatedDummyEntity::class, true]], 'collection' => false, 'operationId' => 'ApiPlatform\Core\Tests\Fixtures\RelatedDummyEntity-secondrecursivesubresource-ApiPlatform\Core\Tests\Fixtures\DummyEntity']),
$this->getSubresourceRoute('/related_dummies/{id}/secondrecursivesubresource.{_format}', 'api_platform.action.get_subresource', DummyEntity::class, 'api_related_dummies_secondrecursivesubresource_get_subresource', ['property' => 'secondrecursivesubresource', 'identifiers' => [['id', RelatedDummyEntity::class, true]], 'collection' => false, 'operationId' => 'api_related_dummies_secondrecursivesubresource_get_subresource']),
$routeCollection->get('api_related_dummies_secondrecursivesubresource_get_subresource')
);
}
Expand Down
12 changes: 6 additions & 6 deletions tests/Operation/Factory/SubresourceOperationFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public function testCreate()
$subresourceOperationFactory = new SubresourceOperationFactory($resourceMetadataFactoryProphecy->reveal(), $propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal(), $pathSegmentNameGeneratorProphecy->reveal());

$this->assertEquals([
'ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subresource-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity' => [
'api_dummy_entities_subresource_get_subresource' => [
'property' => 'subresource',
'collection' => false,
'resource_class' => RelatedDummyEntity::class,
Expand All @@ -71,7 +71,7 @@ public function testCreate()
'route_name' => 'api_dummy_entities_subresource_get_subresource',
'path' => '/dummy_entities/{id}/subresource.{_format}',
],
'ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subresource-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity-anotherSubresource-ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity' => [
'api_dummy_entities_subresource_another_subresource_get_subresource' => [
'property' => 'anotherSubresource',
'collection' => false,
'resource_class' => DummyEntity::class,
Expand All @@ -83,7 +83,7 @@ public function testCreate()
'route_name' => 'api_dummy_entities_subresource_another_subresource_get_subresource',
'path' => '/dummy_entities/{id}/subresource/another_subresource.{_format}',
],
'ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subresource-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity-anotherSubresource-ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subcollection-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity' => [
'api_dummy_entities_subresource_another_subresource_subcollections_get_subresource' => [
'property' => 'subcollection',
'collection' => true,
'resource_class' => RelatedDummyEntity::class,
Expand All @@ -96,7 +96,7 @@ public function testCreate()
'route_name' => 'api_dummy_entities_subresource_another_subresource_subcollections_get_subresource',
'path' => '/dummy_entities/{id}/subresource/another_subresource/subcollections.{_format}',
],
'ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subcollection-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity' => [
'api_dummy_entities_subcollections_get_subresource' => [
'property' => 'subcollection',
'collection' => true,
'resource_class' => RelatedDummyEntity::class,
Expand All @@ -107,7 +107,7 @@ public function testCreate()
'route_name' => 'api_dummy_entities_subcollections_get_subresource',
'path' => '/dummy_entities/{id}/subcollections.{_format}',
],
'ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subcollection-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity-anotherSubresource-ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity' => [
'api_dummy_entities_subcollections_another_subresource_get_subresource' => [
'property' => 'anotherSubresource',
'collection' => false,
'resource_class' => DummyEntity::class,
Expand All @@ -119,7 +119,7 @@ public function testCreate()
'route_name' => 'api_dummy_entities_subcollections_another_subresource_get_subresource',
'path' => '/dummy_entities/{id}/subcollections/{subcollection}/another_subresource.{_format}',
],
'ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subcollection-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity-anotherSubresource-ApiPlatform\\Core\\Tests\\Fixtures\\DummyEntity-subresource-ApiPlatform\\Core\\Tests\\Fixtures\\RelatedDummyEntity' => [
'api_dummy_entities_subcollections_another_subresource_subresource_get_subresource' => [
'property' => 'subresource',
'collection' => false,
'resource_class' => RelatedDummyEntity::class,
Expand Down
2 changes: 1 addition & 1 deletion tests/Swagger/Serializer/DocumentationNormalizerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1572,7 +1572,7 @@ public function testNormalizeWithSubResource()
'/api/questions/{id}/answer' => new \ArrayObject([
'get' => new \ArrayObject([
'tags' => ['Answer', 'Question'],
'operationId' => 'ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Question-answer-ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Answer',
'operationId' => 'api_questions_answer_get_subresource',
'produces' => ['application/ld+json'],
'summary' => 'Retrieves a Answer resource.',
'responses' => [
Expand Down