Entirely disable use of Provider on embedded resource

[MariusJam]

Description

Hi,

in some cases, we would need to be able to entirely disable the use of a provider for an embedded resource for a POST request. But, as soon as we provide the embedded resource's $id, we fall into this condition and the provider is used. Would that be possible to add a way to force a simple denormalization of the data provided in the post request rather than use the provider?

Example

In a proxy use case (no ORM used) :

<?php

#[ApiResource]
class Foo {
 public int $id;
 public string $name;
}

<?php

#[ApiResource]
class Bar {
 public int $id;

  #[ApiProperty(writableLink: true)]
 public Foo $foo;
}

Making a POST on /bars with {"foo: {"id": 1, "name": "SuperName"}} will fail with a Provider not found on operation... error. Whereas the same POST request without id: {"foo: {"name": "SuperName"}} will succeed.

[mrossard]

Could you explain the use case? What would happen exactly when you provide the id + name then? Wouldn't having a custom denormalizer for your Bar entity do the job then?

[MariusJam]

Hi,

The use case is an API with some ApiResource related to Doctrine entities and some others just used to call another api, transforming the response and send it back to the client (proxy use case)

When doing a POST request with an embedded resource which is not a Doctrine entity, we either do not have a provider implemented for the embedded resource or, when we do have one, we do not want necessarily to use it to call the third api (to avoid latency in the response).

What would happen exactly when you provide the id + name then?

If we do not have a provider implemented we get the Provider not found on operation... error

If we do have one, this increases the latency in the response whereas we actually do not need to call the third api.

Wouldn't having a custom denormalizer for your Bar entity do the job then?

IIRC, I have been trying different things with a custom normalizer but, to be honest, I always find it quite tricky to implement (but maybe I'm doing it the wrong way) and, in that specific case, it's quite complicated because the parent ApiResource has different embedded resources : some being a Doctrine entity and some others not.

<?php

#[ApiResource]
class Bar {
 public int $id;

  // Not a Doctrine entity but retrieved from another api => we'd like to be able to disable the use of a provider
  #[ApiProperty(writableLink: true)]
 public Foo $foo;

// This is a Doctrine entity => we're happy with the fact that the default ORM provider is used
 public Baz $baz;
}

[mrossard]

Then what would you want to happen in your app when you call POST on /bars with {"foo: {"id": 1, "name": "SuperName"}} ?
Does it call PATCH /Foos/1 on the 3rd party api with {"name": "SuperName"} or something like that?
If so, why is it done through /bars, shouldn't it simply be done through the /foos endpoint?

[MariusJam]

Hmmm.... that could be a possibility but, in our case, the id is actually shared between different services (it's an uuid) and, during the POST on /bars, different calls to different internal services are made. We don't want the front client to have the responsibility to do such requests in the right order.

[soyuka]

could you add a failing test case + give me the full stack trace ?

[soyuka]

btw #5583 probably fixes that, please try the latest version and check my test :)

[MariusJam]

Hi Soyuka,

I've tested with 3.1.11 but the issue is still there. #5583 doesn't fix it as, in our case, this is the DeserializeListener which is used. Here is the full stack trace:

ApiPlatform\Exception\RuntimeException:
Provider not found on operation "_api_/salary_employees{._format}_get"

  at vendor/api-platform/core/src/State/CallableProvider.php:46
  at ApiPlatform\State\CallableProvider->provide(object(Get), array(), array('fetch_data' => true))
     (vendor/api-platform/core/src/Symfony/Routing/IriConverter.php:95)
  at ApiPlatform\Symfony\Routing\IriConverter->getResourceFromIri('/salary_employees?id=0186169a-d71d-7a7b-8dda-39d9773bd67f', array('fetch_data' => true))
     (vendor/api-platform/core/src/Serializer/ItemNormalizer.php:83)
  at ApiPlatform\Serializer\ItemNormalizer->updateObjectToPopulate(array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Get), 'resource_class' => 'App\\ApiResource\\SalaryEmployee', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => true, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => 'a633d30bebd0bb6dce897fe02b8bf62c', 'deserialization_path' => 'subscriber'))
     (vendor/api-platform/core/src/Serializer/ItemNormalizer.php:62)
  at ApiPlatform\Serializer\ItemNormalizer->denormalize(array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'App\\ApiResource\\SalaryEmployee', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Get), 'resource_class' => 'App\\ApiResource\\SalaryEmployee', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => true, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => 'a633d30bebd0bb6dce897fe02b8bf62c', 'deserialization_path' => 'subscriber'))
     (vendor/symfony/serializer/Debug/TraceableNormalizer.php:71)
  at Symfony\Component\Serializer\Debug\TraceableNormalizer->denormalize(array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'App\\ApiResource\\SalaryEmployee', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Get), 'resource_class' => 'App\\ApiResource\\SalaryEmployee', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => true, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => 'a633d30bebd0bb6dce897fe02b8bf62c', 'deserialization_path' => 'subscriber'))
     (vendor/symfony/serializer/Serializer.php:227)
  at Symfony\Component\Serializer\Serializer->denormalize(array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'App\\ApiResource\\SalaryEmployee', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Get), 'resource_class' => 'App\\ApiResource\\SalaryEmployee', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => true, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => 'a633d30bebd0bb6dce897fe02b8bf62c', 'deserialization_path' => 'subscriber'))
     (vendor/api-platform/core/src/Serializer/AbstractItemNormalizer.php:537)
  at ApiPlatform\Serializer\AbstractItemNormalizer->denormalizeRelation('subscriber', object(ApiProperty), 'App\\ApiResource\\SalaryEmployee', array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Get), 'resource_class' => 'App\\ApiResource\\SalaryEmployee', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => true, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => 'a633d30bebd0bb6dce897fe02b8bf62c', 'deserialization_path' => 'subscriber'))
     (vendor/api-platform/core/src/Serializer/AbstractItemNormalizer.php:792)
  at ApiPlatform\Serializer\AbstractItemNormalizer->createAndValidateAttributeValue('subscriber', array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => '884cdd9449337e7263d37f421e62efa3', 'deserialization_path' => 'subscriber'))
     (vendor/api-platform/core/src/Serializer/AbstractItemNormalizer.php:735)
  at ApiPlatform\Serializer\AbstractItemNormalizer->createAttributeValue('subscriber', array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => '884cdd9449337e7263d37f421e62efa3', 'deserialization_path' => 'subscriber'))
     (vendor/api-platform/core/src/Serializer/AbstractItemNormalizer.php:457)
  at ApiPlatform\Serializer\AbstractItemNormalizer->setAttributeValue(object(DonationSubscription), 'subscriber', array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f'), 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => '884cdd9449337e7263d37f421e62efa3', 'deserialization_path' => 'subscriber'))
     (vendor/symfony/serializer/Normalizer/AbstractObjectNormalizer.php:382)
  at Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer->denormalize(array('fundraiser' => '/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f', 'roundingType' => 'cents', 'additionalDonation' => 500, 'subscriber' => array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f')), 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true, 'cache_key' => '884cdd9449337e7263d37f421e62efa3'))
     (vendor/api-platform/core/src/Serializer/AbstractItemNormalizer.php:219)
  at ApiPlatform\Serializer\AbstractItemNormalizer->denormalize(array('fundraiser' => '/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f', 'roundingType' => 'cents', 'additionalDonation' => 500, 'subscriber' => array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f')), 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91', 'api_denormalize' => true))
     (vendor/api-platform/core/src/Serializer/ItemNormalizer.php:71)
  at ApiPlatform\Serializer\ItemNormalizer->denormalize(array('fundraiser' => '/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f', 'roundingType' => 'cents', 'additionalDonation' => 500, 'subscriber' => array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f')), 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91'))
     (vendor/symfony/serializer/Debug/TraceableNormalizer.php:71)
  at Symfony\Component\Serializer\Debug\TraceableNormalizer->denormalize(array('fundraiser' => '/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f', 'roundingType' => 'cents', 'additionalDonation' => 500, 'subscriber' => array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f')), 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91'))
     (vendor/symfony/serializer/Serializer.php:227)
  at Symfony\Component\Serializer\Serializer->denormalize(array('fundraiser' => '/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f', 'roundingType' => 'cents', 'additionalDonation' => 500, 'subscriber' => array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f')), 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91'))
     (vendor/symfony/serializer/Serializer.php:145)
  at Symfony\Component\Serializer\Serializer->deserialize(array('fundraiser' => '/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f', 'roundingType' => 'cents', 'additionalDonation' => 500, 'subscriber' => array('id' => '0186169a-d71d-7a7b-8dda-39d9773bd67f')), 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91'))
     (vendor/symfony/serializer/Debug/TraceableSerializer.php:61)
  at Symfony\Component\Serializer\Debug\TraceableSerializer->deserialize('{	"fundraiser": "/fundraisers/8fedda19-5a4a-40a0-a5bf-80d7152e500f",	"roundingType": "cents",	"additionalDonation": 500,	"subscriber": {		"id": "0186169a-d71d-7a7b-8dda-39d9773bd67f"	}}', 'App\\ApiResource\\DonationSubscription', 'json', array('groups' => array('donation:subscription:write'), 'operation_name' => '_api_/donation_subscriptions{._format}_post', 'operation' => object(Post), 'resource_class' => 'App\\ApiResource\\DonationSubscription', 'skip_null_values' => true, 'iri_only' => false, 'request_uri' => '/donation_subscriptions', 'uri' => 'https://api.engagement.dev3/donation_subscriptions', 'input' => null, 'output' => null, 'api_allow_update' => false, 'exclude_from_cache_key' => array('root_operation', 'operation'), 'debug_trace_id' => '645a6462a9e91'))
     (vendor/api-platform/core/src/Symfony/EventListener/DeserializeListener.php:101)
  at ApiPlatform\Symfony\EventListener\DeserializeListener->onKernelRequest(object(RequestEvent), 'kernel.request', object(TraceableEventDispatcher))
     (vendor/symfony/event-dispatcher/Debug/WrappedListener.php:116)
  at Symfony\Component\EventDispatcher\Debug\WrappedListener->__invoke(object(RequestEvent), 'kernel.request', object(TraceableEventDispatcher))
     (vendor/symfony/event-dispatcher/EventDispatcher.php:206)
  at Symfony\Component\EventDispatcher\EventDispatcher->callListeners(array(object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener), object(WrappedListener)), 'kernel.request', object(RequestEvent))
     (vendor/symfony/event-dispatcher/EventDispatcher.php:56)
  at Symfony\Component\EventDispatcher\EventDispatcher->dispatch(object(RequestEvent), 'kernel.request')
     (vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php:127)
  at Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher->dispatch(object(RequestEvent), 'kernel.request')
     (vendor/symfony/http-kernel/HttpKernel.php:139)
  at Symfony\Component\HttpKernel\HttpKernel->handleRaw(object(Request), 1)
     (vendor/symfony/http-kernel/HttpKernel.php:74)
  at Symfony\Component\HttpKernel\HttpKernel->handle(object(Request), 1, true)
     (vendor/symfony/http-kernel/Kernel.php:184)
  at Symfony\Component\HttpKernel\Kernel->handle(object(Request))
     (public/index.php:32)   

I'll try to add a failing test case as requested but I'm not familiar with Behat so it might take a little while.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.