Skip to content

fix(jsonld): allow @id, @context and @type on denormalization 2 #6451

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

Merged
merged 4 commits into from
Jul 9, 2024
Merged

fix(jsonld): allow @id, @context and @type on denormalization 2 #6451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97f889e
fix(jsonld): allow @id, @context and @type when denormalizing
ili101 Jun 30, 2024
42a866b
Update features/main/standard_put.feature
soyuka Jul 8, 2024
66a49fd
fix: wrong resource iri
soyuka Jul 9, 2024
14cc145
fix: wrong resource iri
soyuka Jul 9, 2024
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
54 changes: 54 additions & 0 deletions features/main/standard_put.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,60 @@ Feature: Spec-compliant PUT support
}
"""

Scenario: Create a new resource with JSON-LD attributes
When I add "Content-Type" header equal to "application/ld+json"
And I send a "PUT" request to "/standard_puts/6" with body:
"""
{
"@id": "/standard_puts/6",
"@context": "/contexts/StandardPut",
"@type": "StandardPut",
"foo": "a",
"bar": "b"
}
"""
Then the response status code should be 201
And the response should be in JSON
And the JSON should be equal to:
"""
{
"@context": "/contexts/StandardPut",
"@id": "/standard_puts/6",
"@type": "StandardPut",
"id": 6,
"foo": "a",
"bar": "b"
}
"""

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a test that ensures an error is thrown if the value of the @id key doesn't match the URL?

Scenario: Fails to create a new resource with the wrong JSON-LD @id
When I add "Content-Type" header equal to "application/ld+json"
And I send a "PUT" request to "/standard_puts/7" with body:
"""
{
"@id": "/dummies/6",
"@context": "/contexts/StandardPut",
"@type": "StandardPut",
"foo": "a",
"bar": "b"
}
"""
Then the response status code should be 400

Scenario: Fails to create a new resource when the JSON-LD @id doesn't match the URI
When I add "Content-Type" header equal to "application/ld+json"
And I send a "PUT" request to "/standard_puts/7" with body:
"""
{
"@id": "/standard_puts/6",
"@context": "/contexts/StandardPut",
"@type": "StandardPut",
"foo": "a",
"bar": "b"
}
"""
Then the response status code should be 400

Scenario: Replace an existing resource
When I add "Content-Type" header equal to "application/ld+json"
And I send a "PUT" request to "/standard_puts/5" with body:
Expand Down
44 changes: 43 additions & 1 deletion src/JsonLd/Serializer/ItemNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@
use ApiPlatform\Api\ResourceClassResolverInterface as LegacyResourceClassResolverInterface;
use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
use ApiPlatform\JsonLd\ContextBuilderInterface;
use ApiPlatform\Metadata\Exception\ItemNotFoundException;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\IriConverterInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\ResourceAccessCheckerInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
Expand All @@ -47,6 +49,29 @@ final class ItemNormalizer extends AbstractItemNormalizer
use JsonLdContextTrait;

public const FORMAT = 'jsonld';
private const JSONLD_KEYWORDS = [
'@context',
'@direction',
'@graph',
'@id',
'@import',
'@included',
'@index',
'@json',
'@language',
'@list',
'@nest',
'@none',
'@prefix',
'@propagate',
'@protected',
'@reverse',
'@set',
'@type',
'@value',
'@version',
'@vocab',
];

public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface|LegacyIriConverterInterface $iriConverter, ResourceClassResolverInterface|LegacyResourceClassResolverInterface $resourceClassResolver, private readonly ContextBuilderInterface $contextBuilder, ?PropertyAccessorInterface $propertyAccessor = null, ?NameConverterInterface $nameConverter = null, ?ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ?ResourceAccessCheckerInterface $resourceAccessChecker = null, protected ?TagCollectorInterface $tagCollector = null)
{
Expand Down Expand Up @@ -148,9 +173,26 @@ public function denormalize(mixed $data, string $class, ?string $format = null,
throw new NotNormalizableValueException('Update is not allowed for this operation.');
}

$context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getResourceFromIri($data['@id'], $context + ['fetch_data' => true]);
try {
$context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getResourceFromIri($data['@id'], $context + ['fetch_data' => true], $context['operation'] ?? null);
} catch (ItemNotFoundException $e) {
$operation = $context['operation'] ?? null;
if (!($operation instanceof Put && ($operation->getExtraProperties()['standard_put'] ?? false))) {
throw $e;
}
}
}

return parent::denormalize($data, $class, $format, $context);
}

protected function getAllowedAttributes(string|object $classOrObject, array $context, bool $attributesAsString = false): array|bool
{
$allowedAttributes = parent::getAllowedAttributes($classOrObject, $context, $attributesAsString);
if (\is_array($allowedAttributes) && ($context['api_denormalize'] ?? false)) {
$allowedAttributes = array_merge($allowedAttributes, self::JSONLD_KEYWORDS);
}

return $allowedAttributes;
}
}
10 changes: 10 additions & 0 deletions src/Symfony/Routing/IriConverter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ public function getResourceFromIri(string $iri, array $context = [], ?Operation
throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
}

foreach ($context['uri_variables'] ?? [] as $key => $value) {
if (!isset($parameters[$key]) || $parameters[$key] !== (string) $value) {
throw new InvalidArgumentException(sprintf('The iri "%s" does not reference the correct resource.', $iri));
}
}

if ($operation && !is_a($parameters['_api_resource_class'], $operation->getClass(), true)) {
throw new InvalidArgumentException(sprintf('The iri "%s" does not reference the correct resource.', $iri));
}

$operation = $parameters['_api_operation'] = $this->resourceMetadataCollectionFactory->create($parameters['_api_resource_class'])->getOperation($parameters['_api_operation_name']);

if ($operation instanceof CollectionOperationInterface) {
Expand Down
Loading