fix(serializer): deprecate SerializerAwareProviderInterface and SerializableProvider

[vinceAmstoutz]

Q	A
Branch?	4.2
Tickets	-
License	MIT

Made the deprecation before the removal made in #7314.

Reason: Direct access to private services is discouraged because this practice:

• Violates the dependency injection principle, which is at the heart of Symfony's architecture.
• Creates a strong coupling between your code and the container, making it less modular.
• Makes your application more fragile and much more difficult to maintain and test.

That's why PHPStan reported an error, which is ignored by our PHPStan config here: https://github.com/vinceAmstoutz/api-platform-core/blob/9e382e01bb4529d4ae63dbbeda01839d1da2994a/phpstan.neon.dist#L107-L110.

Historic reason:

After looking at its history, it looks like a legacy code backported from version to version of api-platform/core for backward compatibility. As discussed with @soyuka, it might be possible this behavior (this interface + DataProviderPass) was introduced long time ago to prevent a circular reference between any State Provider directly using the Serializer.

[vincentchalamon]

@vinceAmstoutz the deprecation reason seems a bit generic to me, could you elaborate it please? Could be in the PR description for history purpose 🙂 Thanks!

[vinceAmstoutz]

@vinceAmstoutz the deprecation reason seems a bit generic to me, could you elaborate it please? Could be in the PR description for history purpose 🙂 Thanks!

Thanks for your review @vincentchalamon! I added a description on the PR to solve that, is it ok for you?

[vincentchalamon]

@vinceAmstoutz the deprecation reason seems a bit generic to me, could you elaborate it please? Could be in the PR description for history purpose 🙂 Thanks!

Thanks for your review @vincentchalamon! I added a description on the PR to solve that, is it ok for you?

OK but that doesn't explain to me why this class has been originally added, and why we don't need it anymore.

After looking at its history, it looks like a legacy code backported from version to version of api-platform/core for backward compatibility. As discussed with @soyuka, it might be possible this behavior (this interface + DataProviderPass) was introduced long time ago to prevent a circular reference between any State Provider directly using the Serializer.

To validate this deprecation, I suggest to:

1. ensure using the Serializer directly in a State Provider doesn't create any exception nor circular reference of any type
2. update this PR description with the previous explanation for history purpose

WDYT @soyuka @vinceAmstoutz?

[vinceAmstoutz]

@vinceAmstoutz the deprecation reason seems a bit generic to me, could you elaborate it please? Could be in the PR description for history purpose 🙂 Thanks!

Thanks for your review @vincentchalamon! I added a description on the PR to solve that, is it ok for you?

OK but that doesn't explain to me why this class has been originally added, and why we don't need it anymore.

After looking at its history, it looks like a legacy code backported from version to version of api-platform/core for backward compatibility. As discussed with @soyuka, it might be possible this behavior (this interface + DataProviderPass) was introduced long time ago to prevent a circular reference between any State Provider directly using the Serializer.

To validate this deprecation, I suggest to:

1. ensure using the Serializer directly in a State Provider doesn't create any exception nor circular reference of any type

2. update this PR description with the previous explanation for history purpose

WDYT @soyuka @vinceAmstoutz?

Thanks for your research @vincentchalamon.

After some tests it's ok for me to use the Serializer directly in a State Provider (no exception and seems to have also no circular reference - not sure at 100% for this one)

Alos, I updated the PR description by adding your explanation. Is it better? Do not hesitate to improve it on your own if you want.

[vincentchalamon]

[nice to have]
Add a TODO in DataProviderPass to don't forget to remove it in 5.0

[vinceAmstoutz]

[nice to have] Add a TODO in DataProviderPass to don't forget to remove it in 5.0

Done. I also added it for src/Symfony/Bundle/ApiPlatformBundle.php and tests/Symfony/Bundle/ApiPlatformBundleTest.php.