5942232691

Committed 22 Aug 2023 05:43PM UTC coverage: 58.819% (+0.001%) from 58.818%

Build # 5942232691

Build Type

push

github

Committed by

web-flow

Commit Message

fix(metadata): fix POST on subresource (#5734)

Run Details

4 of 4 new or added lines in 1 file covered. (100.0%)

10841 of 18431 relevant lines covered (58.82%)

19.76 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.48

/src/State/CreateProvider.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * 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\State;

use ApiPlatform\Exception\RuntimeException;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Link;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Post;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;

/**
 * An ItemProvider for POST operations on generated subresources.
 *
 * @see ApiPlatform\Tests\Fixtures\TestBundle\Entity\SubresourceEmployee
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 *
 * @experimental
 */
final class CreateProvider implements ProviderInterface
{
    public function __construct(private ProviderInterface $decorated, private ?PropertyAccessorInterface $propertyAccessor = null)
    {
        $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?object
    {
        if (!$uriVariables || !$operation instanceof HttpOperation || null !== $operation->getController()) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        $operationUriVariables = $operation->getUriVariables();
        $relationClass = current($operationUriVariables)->getFromClass();
        $key = key($operationUriVariables);
        $relationUriVariables = [];

        foreach ($operationUriVariables as $parameterName => $value) {
            if ($key === $parameterName) {
                $relationUriVariables['id'] = new Link(identifiers: $value->getIdentifiers(), fromClass: $value->getFromClass(), parameterName: $key);
                continue;
            }

            $relationUriVariables[$parameterName] = $value;
        }

        $relation = $this->decorated->provide(new Get(uriVariables: $relationUriVariables, class: $relationClass), $uriVariables);
        if (!$relation) {
            throw new NotFoundHttpException('Not Found');
        }

        try {
            $resource = new ($operation->getClass());
        } catch (\Throwable $e) {
            throw new RuntimeException(sprintf('An error occurred while trying to create an instance of the "%s" resource. Consider writing your own "%s" implementation and setting it as `provider` on your operation instead.', $operation->getClass(), ProviderInterface::class), 0, $e);
        }
        $property = $operationUriVariables[$key]->getToProperty() ?? $key;
        $this->propertyAccessor->setValue($resource, $property, $relation);

        return $resource;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\State;
15
16	use ApiPlatform\Exception\RuntimeException;
17	use ApiPlatform\Metadata\Get;
18	use ApiPlatform\Metadata\HttpOperation;
19	use ApiPlatform\Metadata\Link;
20	use ApiPlatform\Metadata\Operation;
21	use ApiPlatform\Metadata\Post;
22	use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
23	use Symfony\Component\PropertyAccess\PropertyAccess;
24	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
25
26	/**
27	* An ItemProvider for POST operations on generated subresources.
28	*
29	* @see ApiPlatform\Tests\Fixtures\TestBundle\Entity\SubresourceEmployee
30	*
31	* @author Antoine Bluchet <soyuka@gmail.com>
32	*
33	* @experimental
34	*/
35	final class CreateProvider implements ProviderInterface
36	{
37	public function __construct(private ProviderInterface $decorated, private ?PropertyAccessorInterface $propertyAccessor = null)
38	{
39	$this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();	6✔
40	}
41
42	public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?object
43	{
44	if (!$uriVariables \|\| !$operation instanceof HttpOperation \|\| null !== $operation->getController()) {	6✔
45	return $this->decorated->provide($operation, $uriVariables, $context);	2✔
46	}
47
48	$operationUriVariables = $operation->getUriVariables();	4✔
49	$relationClass = current($operationUriVariables)->getFromClass();	4✔
50	$key = key($operationUriVariables);	4✔
51	$relationUriVariables = [];	4✔
52
53	foreach ($operationUriVariables as $parameterName => $value) {	4✔
54	if ($key === $parameterName) {	4✔
55	$relationUriVariables['id'] = new Link(identifiers: $value->getIdentifiers(), fromClass: $value->getFromClass(), parameterName: $key);	4✔
56	continue;	4✔
57	}
58
59	$relationUriVariables[$parameterName] = $value;	×
60	}
61
62	$relation = $this->decorated->provide(new Get(uriVariables: $relationUriVariables, class: $relationClass), $uriVariables);	4✔
63	if (!$relation) {	4✔
64	throw new NotFoundHttpException('Not Found');	×
65	}
66
67	try {
68	$resource = new ($operation->getClass());	4✔
69	} catch (\Throwable $e) {	2✔
70	throw new RuntimeException(sprintf('An error occurred while trying to create an instance of the "%s" resource. Consider writing your own "%s" implementation and setting it as `provider` on your operation instead.', $operation->getClass(), ProviderInterface::class), 0, $e);	2✔
71	}
72	$property = $operationUriVariables[$key]->getToProperty() ?? $key;	2✔
73	$this->propertyAccessor->setValue($resource, $property, $relation);	2✔
74
75	return $resource;	2✔
76	}
77	}

api-platform / core / 5942232691

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous