10000 Better DI type deprecation message by weaverryan · Pull Request #22999 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

Better DI type deprecation message #22999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 31, 2017
Merged

Better DI type deprecation message #22999

merged 1 commit into from
May 31, 2017

Conversation

weaverryan
Copy link
Member
@weaverryan weaverryan commented May 31, 2017 •
edited
Loading
Q A
Branch? 3,3
Bug fix? yes
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets #22951
License MIT
Doc PR n/a

This is the most common autowiring deprecation:

public function __construct(UserPasswordEncoder $encoder)

You should type-hint UserPasswordEncoderInterface

Current deprecation message:

Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won’t be supported in version 4.0. You should rename (or alias) the "security.user_password_encoder.generic" service to "Symfony\Component\Security\Core\Encoder\UserPasswordEncoder" instead.

Updated message:

Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won't be supported in version 4.0. Try changing the type-hint for argument "$encoder" of method "AppBundle\Service\TestServiceSubscriber::__construct()" to "Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface" instead.

This only happens if we detect that there is a service/alias in the container (e.g. ...\UserPasswordEncoderInterface) for the type-hint (...\UserPasswordEncoder). Otherwise, if there is no correct type-hint in the container, we give the old recommendation (about aliasing).

The only complex case (of giving good directions on where to fix things) is with a class that implements ServiceSubscriberInterface (where the type-hint is in the getSusbcribedServices() method). In that case, the notice is:

Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won't be supported in version 4.0. Try changing the type-hint for "Symfony\Component\Security\Core\Encoder\UserPasswordEncoder" in "AppBundle\Service\TestServiceSubscriber" to "Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface" instead.

@weaverryan weaverryan force-pushed the better-di-deprecation-message branch from f992217 to a990d5c Compare May 31, 2017 17:54
@weaverryan weaverryan mentioned this pull request May 31, 2017
Closed
@weaverryan
Copy link
Member Author

Fabbot failure is false

@fabpot
Copy link
Member
fabpot commented May 31, 2017

Thank you @weaverryan.

@fabpot fabpot merged commit a990d5c into symfony:3.3 May 31, 2017
fabpot added a commit that referenced this pull request May 31, 2017
@fabpot
bug #22999 Better DI type deprecation message (weaverryan)
5e40e19 
This PR was merged into the 3.3 branch.

Discussion
----------

Better DI type deprecation message

| Q             | A
| ------------- | ---
| Branch?       | 3,3
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #22951
| License       | MIT
| Doc PR        | n/a

This is the most common autowiring deprecation:

```php
public function __construct(UserPasswordEncoder $encoder)
```

You *should* type-hint `UserPasswordEncoderInterface`

Current deprecation message:
> Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won’t be supported in version 4.0. You should rename (or alias) the "security.user_password_encoder.generic" service to "Symfony\Component\Security\Core\Encoder\UserPasswordEncoder" instead.

Updated message:
> Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won't be supported in version 4.0. Try changing the type-hint for argument "$encoder" of method "AppBundle\Service\TestServiceSubscriber::__construct()" to "Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface" instead.

This only happens if we detect that there is a service/alias in the container (e.g. `...\UserPasswordEncoderInterface`) for the type-hint (`...\UserPasswordEncoder)`. Otherwise, if there is no correct type-hint in the container, we give the old recommendation (about aliasing).

The only complex case (of giving good directions on *where* to fix things) is with a class that implements `ServiceSubscriberInterface` (where the type-hint is in the `getSusbcribedServices()` method). In that case, the notice is:

> Autowiring services based on the types they implement is deprecated since Symfony 3.3 and won't be supported in version 4.0. Try changing the type-hint for "Symfony\Component\Security\Core\Encoder\UserPasswordEncoder" in "AppBundle\Service\TestServiceSubscriber" to "Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface" instead.

Commits
-------

a990d5c Improving deprecation message when hitting the "deprecated type" lookup, but an alias is available
@weaverryan weaverryan deleted the better-di-deprecation-message branch May 31, 2017 18:47
@fabpot fabpot mentioned this pull request Jun 5, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabpot fabpot fabpot approved these changes

Assignees
No one assigned
Labels
Bug Status: Needs Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@weaverryan @fabpot @carsonbot
0