Contrib.social

REST module integration issues (handle exceptions)

Open on Drupal.org →
Created on 29 November 2024, 4 months ago

Problem/Motivation

Using rdf_sync in combination with the rest module can have some side effects.

If we:
- setup rdf_sync mapping for node page bundle
- setup REST resource for "entity.node", formats: jsonld rdfxml ntriples turtle n3, methods: GET
- and we access rest route for an entity bundle that is not mapped e.g: article, /node/1?_format=jsonld
- we get an error within \EasyRdf\Parser\RdfPhp::parse

The RdfSyncNormalizer is not called in this case because RdfSyncNormalizer::supportsNormalization checks for isMappedEntity. Serialization's ContentEntityNormalizer is called instead, then RdfSyncEncoder is called. This results in errors because the data is not as expected.

Steps to reproduce

See above.

Proposed resolution

See #2979753: Allow services tagged as 'encoder' to opt out of inclusion in the serializer.formats container paramater → and linked issues.

- We could do something similar to what jsonapi did and remove rdf_sync formats from 'serializer.formats' container parameter. This way the REST module can still be used for entity resources/routes but not for login/logout routes. See \Drupal\serialization\EventSubscriber\UserRouteAlterSubscriber::onRoutingAlterAddFormats
- Update RdfSyncNormalizer and move isMappedEntity from ::supportsNormalization to ::normalize. If the entity is unmapped, throw a NotEncodableValueException which can be caught later by a custom exception handler
- The 'serialization.exception.default' service doesn't support rdf_sync formats. It also attempts to serialize errors messages. Create and replace it with a custom exception subscriber that can be used allowing us to return 406 Not Acceptable when attempting to normalize an unmapped entity.

Remaining tasks

?

User interface changes

?

API changes

?

Data model changes

?

🐛 Bug report
Status

Active

Version

1.0

Component

Code

Created by

🇧🇪Belgium herved

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024