Adding Definition::addError() and a compiler pass to throw errors as exceptions #24290
Conversation
This file contains hidden or 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
0a55740 to
f882813
Compare
| @@ -11,6 +11,8 @@ | |||
|
|
|||
| namespace Symfony\Component\DependencyInjection\Compiler; | |||
|
|
|||
| @trigger_error('The '.__NAMESPACE__.'\AutowireExceptionPass class is deprecated since version 3.4 and will be removed in 4.0. Use the DefinitionErrorExceptionPass class instead.', E_USER_DEPRECATED); | |||
There was a problem hiding this comment.
missing annotation on the class
| */ | ||
| public function __construct($throwOnAutowireException = true) | ||
| { | ||
| $this->throwOnAutowiringException = $throwOnAutowireException; | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated |
There was a problem hiding this comment.
since version 3.4, to be removed in 4.0
| @@ -35,10 +42,19 @@ protected function processValue($value, $isRoot = false) | |||
| foreach ($value->getArguments() as $k => $v) { | |||
| if ($k !== $i++) { | |||
| if (!is_int($k)) { | |||
| throw new RuntimeException(sprintf('Invalid constructor argument for service "%s": integer expected but found string "%s". Check your service definition.', $this->currentId, $k)); | |||
| $value->addError(sprintf('Invalid constructor argument for service "%s": integer expected but found string "%s". Check your service definition.', $this->currentId, $k)); | |||
There was a problem hiding this comment.
dedup the msg with a var? (same below)
ecd0fbb to
33d38f7
Compare
|
Good suggestions! They're all handled :) |
| @@ -1090,7 +1093,7 @@ public function setFoo(Foo $foo) | |||
| // should be called | |||
| } | |||
|
|
|||
| /** @inheritdoc*/ | |||
| /** {@inheritdoc}*/ | |||
There was a problem hiding this comment.
should be reverted, a fabbot false-positive
unrelated: InlineServiceDefinitionsPass::getInlinedServiceIds() should be deprecated also
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
|
||
| /** | ||
| * Throws autowire exceptions from AutowirePass for definitions that still exist. | ||
| * | ||
| * @deprecated AutowireExceptionPass is deprecated since version 3.4 and will be removed in 4.0. |
There was a problem hiding this comment.
@deprecated since version 3.4, will be removed in 4.0.
nicolas-grekas
approved these changes
Sep 24, 2017
|
Tests pass, fabbot failure is false! Should be ready to go :) |
|
Thank you @weaverryan. |
nicolas-grekas
added a commit
that referenced
this pull request
Sep 25, 2017
…hrow errors as exceptions (weaverryan) This PR was squashed before being merged into the 3.4 branch (closes #24290). Discussion ---------- Adding Definition::addError() and a compiler pass to throw errors as exceptions | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes & no | New feature? | yes | BC breaks? | no | Deprecations? | yes (very minor) | Tests pass? | yes | Fixed tickets | #23606 | License | MIT | Doc PR | Not needed Hi guys! Very simple: when there is an error with a Definition, we can now call `Definition::addError()` instead of throwing an exception. Then, a new compiler pass (after removal) actually throws an exception. The advantage is that we can avoid throwing exceptions for services that are ultimately removed from the container. That's important for auto-registration, where we commonly register all services in `src/`... but then many of them are removed later. A few interesting notes: - We can probably convert more things from exceptions to `Definition::addError()`. I've only converted autowiring errors and things in `CheckArgumentsValidityPass` (that was necessary because it was throwing exceptions in some cases due to autowiring failing... which was the true error) - `Definition` can hold multiple errors, but I'm only showing the first error in the exception message. The reason is clarity: I think usually the first error is the most (or only) important. But having `Definition::addError()` avoids the possibility of a later error overriding an earlier one Cheers! Commits ------- a85b37a Adding Definition::addError() and a compiler pass to throw errors as exceptions
This was referenced Oct 2, 2017
nicolas-grekas
added a commit
that referenced
this pull request
Oct 2, 2017
This PR was merged into the 3.4 branch. Discussion ---------- [DI] Fix missing CHANGELOG update + typo | Q | A | ------------- | --- | Branch? | 3.4 <!-- see comment below --> | Bug fix? | no | New feature? | no <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | no | Deprecations? | no <!-- don't forget to update UPGRADE-*.md files --> | Tests pass? | yes | Fixed tickets | #24290 <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | N/A Commits ------- f9aeee5 [DI] Fix missing CHANGELOG update + typo
nicolas-grekas
added a commit
that referenced
this pull request
Oct 2, 2017
This PR was merged into the 4.0-dev branch. Discussion ---------- [DI] Remove AutowireExceptionPass | Q | A | ------------- | --- | Branch? | master <!-- see comment below --> | Bug fix? | no | New feature? | yes <!-- don't forget to update src/**/CHANGELOG.md files --> | BC breaks? | yes | Deprecations? | no <!-- don't forget to update UPGRADE-*.md files --> | Tests pass? | yes | Fixed tickets | #24290 <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | N/A Commits ------- 2ada558 [DI] Remove AutowireExceptionPass
This was referenced Oct 18, 2017
Merged
Merged
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.
Hi guys!
Very simple: when there is an error with a Definition, we can now call
Definition::addError()instead of throwing an exception. Then, a new compiler pass (after removal) actually throws an exception. The advantage is that we can avoid throwing exceptions for services that are ultimately removed from the container. That's important for auto-registration, where we commonly register all services insrc/... but then many of them are removed later.A few interesting notes:
Definition::addError(). I've only converted autowiring errors and things inCheckArgumentsValidityPass(that was necessary because it was throwing exceptions in some cases due to autowiring failing... which was the true error)Definitioncan hold multiple errors, but I'm only showing the first error in the exception message. The reason is clarity: I think usually the first error is the most (or only) important. But havingDefinition::addError()avoids the possibility of a later error overriding an earlier oneCheers!