Fix deprecation warning for UserInterface on Symfony 4 #3033
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The deprecated annotation removed in 2.2.3 had a purpose: deprecated interfaces are allowed to extend deprecated interfaces of another package without triggering a warning in DebugClassLoader. However, applying it on the public UserInterface was the mistake. Instead of having an internal interface that is extended by the conditional declaration of the public interface, the implementation is now reversed. An internal CompatUserInterface is now declared conditionally to handle the BC layer, and the public UserInterface extends it. As our UserInterface and the CompatUserInterface are in the same package, UserInterface is allowed to extend CompatUserInterface without warning even when it is marked as deprecated, making both DebugClassLoader and downstream static analyzers happy.
stof
force-pushed
the
fix_user_deprecation
branch
from
d2b8c05
to
334a6e8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The deprecated annotation removed in 2.2.3 had a purpose: deprecated interfaces are allowed to extend deprecated interfaces of another package without triggering a warning in DebugClassLoader. However, applying it on the public UserInterface was the mistake. Instead of having an internal interface that is extended by the conditional declaration of the public interface, the implementation is now reversed. An internal CompatUserInterface is now declared conditionally to handle the BC layer, and the public UserInterface extends it.
As our UserInterface and the CompatUserInterface are in the same package, UserInterface is allowed to extend CompatUserInterface without warning even when it is marked as deprecated, making both DebugClassLoader and downstream static analyzers happy.