Core: Custom filter AbstractFilter deprecation notice

[townsymush]

I am using the following docs to create a custom filter https://api-platform.com/docs/core/filters#creating-custom-filters

It states to extend the AbstractFilter as a helper for creating the filter but on doing so I am receiving the following deprecation error.

User Deprecated: Passing an instance of "Symfony\Component\HttpFoundation\RequestStack" is deprecated since 2.2. Use "filters" context key instead.

What is the alternative at this stage?

[dunglas]

It's weird... Do you use autowiring? Can you provide a minimal reproducer on GitHub?

[townsymush]

Yeah, it is a bit odd. Here is a quick knock up to replicate the issue

https://github.com/townsymush/api-platform-deprecation-error

[antograssiot]

@townsymush You should try to update your DomainFilter to extend ApiPlatform\Core\Bridge\Doctrine\Orm\FilterAbstractContextAwareFilter instead of AbstractFilter if I remember/read correctly

[townsymush]

@antograssiot unfortunately, although the filter still works after changing it to the AbstractContextAwareFilter I still get the deprecation notice. I also cleared the cache and restarted the server just to be sure.

[antograssiot]

https://github.com/townsymush/api-platform-deprecation-error/blob/master/config/services.yaml#L30
you're passing the request stack, you need to remove it as explained in the message then

[townsymush]

Yes, I understand that, but if I do this my filter will not run.
https://github.com/api-platform/core/blob/master/src/Bridge/Doctrine/Orm/Filter/AbstractFilter.php#L66

So it's not clear on my alternative

[antograssiot]

Can't look deeper right now but from what i know aftrr upgrading several filters, https://github.com/api-platform/core/blob/master/src/Bridge/Doctrine/Orm/Filter/AbstractContextAwareFilter.php#L24 your filter should not be in a position to call the parent::apply() that you mentionned...This is why you need the new abstract filter that I mentionned earlier. Is your context set correctly ?

[teohhanhui]

Yes, I understand that, but if I do this my filter will not run.
https://github.com/api-platform/core/blob/master/src/Bridge/Doctrine/Orm/Filter/AbstractFilter.php#L66

It is overridden in https://github.com/api-platform/core/blob/v2.2.5/src/Bridge/Doctrine/Orm/Filter/AbstractContextAwareFilter.php so you'll be fine.

[townsymush]

Thanks both. I do not have any context set, which is why it is calling the parent::apply method. Where would I set the context for the filter?

[townsymush]

Hey guys, so this issue seems related to using the @ApiResource(attributes={"filters"={RegexpFilter::class}}) Annotation. Do you think it should be removed from the documentation? Or a warning stating this is deprecated and state the preferred @ApiFilter annotation as the filters context isn't that clear on what the problem is.

[raziel057]

I encountered the same issue while upgrading api platform to 2.2. To fix the issue I had to change my filter to extend AbstractContextAwareFilter rather than AbstractFilter.

And then declare the service like this:

'AppBundle\Filter\FullNameFilter':
        arguments: [ '@doctrine' ]
        tags: [ 'api_platform.filter' ]

Rather than:

'AppBundle\Filter\FullNameFilter':
        arguments: [ '@doctrine', '@request_stack', '@?logger' ]
        tags: [ 'api_platform.filter' ]

[soyuka]

Closing, thanks @raziel057 for the answer.