Problem with custom variables in query / uriTemplate

[bizley]

API Platform version(s) affected: 3.0.3

Description
If you set custom uriTemplate for an operation with non-identifiers as variables you will get 404 or 500.

How to reproduce
Add operation with template similar to:

uriTemplate: '/photos/{uuid}/resize/{width}/{height}',

where {uuid} is an UUID identifier.

As I can see additional variables are "resolved" as identifiers for the relations in the data provider resulting in query broken or yielding no results at all.

Possible Solution
I have made something I called NoExtraLinkProvider which is basically ApiPlatform\Doctrine\Orm\State\ItemProvider with additional code:

if ($operation instanceof HttpOperation && array_key_exists('uuid', $uriVariables)) {
    $uriVariables = ['uuid' => $uriVariables['uuid']];
    $operation = $operation->withUriVariables(['uuid' => $operation->getUriVariables()['uuid']]);
}

which removes any uriVariables added automatically by the framework. With help of that I can get the Photo resource by {uuid} and pass additional {with} and {height} to my controller.

But this does not help with collection operations (without {uuid}, different resource but similar problem, like /resources/search/{search}) and I don't know what to do here.

Additional Context
I did not find how to do this in v3, in v2 it worked without any problems. Maybe I'm doing something wrong (most probably) or maybe there is something missing in this beautiful framework. Please help or point me to the proper place to find help. Thank you.

[soyuka]

Just disabling those non-identifying uri variables should work:

#[Get(uriVariables: ['uuid'])]

[bizley]

Unfortunately not.

ApiPlatform\Symfony\EventListener\ReadListener adds them back in line 87 (getOperationUriVariables()) and then ApiPlatform\Doctrine\Orm\State\ItemProvider generates query (handleLinks()) like

SELECT o FROM App\Entity\Photo o WHERE o.id = :id_p1 AND o.id = :id_p2 AND o.uuid = :uuid_p3

using passed {width} and {height} values there which results in nothing found in DB and thus 404.

I wonder if that is because Photo entity comes with

#[ApiProperty(identifier: false)]
private ?int $id = null;

#[ApiProperty(identifier: true)]
private ?string $uuid = null;

so somehow the id keeps coming back in handleLinks().

[soyuka]

Hi, getting back onto this, it looks like it's not behaving like you want for now but I'll work on adding something to change this. For now you can do like this with a custom provider:

#[Get(uriTemplate: '/photos/{id}/resize/{width}/{height}', uriVariables: ['id' => new Link(identifiers: ['id'])], provider: TestProvider::class)]

class TestProvider {
  public function __construct(private ProviderInterface $provider) {}

  public function provide(Operation $operation, array $uriVariables = [], array $context = []) {
    return $this->provider->provide($operation->withUriVariables(['id' => $operation->getUriVariables()['id']]), ['id' => $uriVariables['id'], $context);
  }
}

You need to inject the api_platform.doctrine.orm.state.item_provider I'll work on that to fix this thanks for the bug report.

[soyuka]

Side note: there's an issue with URI Variables beeing overriden even though it's setup by the user when uriTemplate contains more variables then the defined uri variables.

[bizley]

Thank you, I see your temp fix proposal is basically the same idea I had. Also side note - I don't rely on providing any variable there since the main identifier variable (uuid in my case) is automatically set; this might be the source of the problem, I would happy set it manually in order to not auto-set the rest of them from uriTemplate.

[soyuka]

Actually when you set something inside the metadata yourself it should not get overridden. Here we've a bug where in API Platform 3 we read your uriTemplate (photos/{uuid}/resize/{width}/{height}) and we find out there are 3 variables. We then override your configuration to add the ones that you didn't set up. This is definitely wrong and they should be left untouched if specified in the first place. This means that by setting this:

#[Get(uriVariables: ['uuid'])]

API Platform shouldn't be aware of height and width at all (even though its not perfect and I'd rather suggest creating your own Provider that handles the 3 variables).