[Workflow] deprecate GuardEvent::getContext method
#51484
Merged
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
GuardEvent::getContext methodGuardEvent::getContext method
6019e12 to
89e5c00
Compare
lyrixx
requested changes
Aug 25, 2023
89e5c00 to
c31d044
Compare
GuardEvent::getContext methodGuardEvent::getContext method
c31d044 to
d47b6be
Compare
d47b6be to
985b9db
Compare
fabpot
approved these changes
Aug 30, 2023
|
Thank you @hhamon. |
fabpot
added a commit
that referenced
this pull request
Aug 30, 2023
…ontextTrait` trait (hhamon) This PR was merged into the 7.0 branch. Discussion ---------- Remove `GuardEvent::getContext()` method and add `HasContextTrait` trait | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | Related to #51484 | License | MIT | Doc PR | ~ As discussed with `@lyrixx`, the `GuardEvent::getContext` method was confusing as the context given as the 3rd argument to the WorflowInterface::appy() method is never passed along to the guard events. According to `@lyrixx`, the guard listeners must take any decisions based on the subject itself and not on the given contextual data (which are supposed to remain metadata). As a consequence, calling the `GuardEvent::getContext()` method always returned an empty context array so far. To prevent this confusion any longer, the method has been deprecated in Symfony 6.4 (see #51484) and removed in this PR. The `GuardEvent` class hierarchy no longer has the `getContext` method while other event classes keep having it. Commits ------- 2aee3ae Remove `GuardEvent::getContext()` method and add `HasContextTrait` trait
fabpot
added a commit
that referenced
this pull request
Sep 5, 2023
…thout replacement (alexandre-daubois) This PR was merged into the 7.0 branch. Discussion ---------- [Workflow] Remove `GuardEvent::getContext()` method without replacement | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Follow-up of #51484 Commits ------- 8271c56 [Workflow] Remove `GuardEvent::getContext()` method without replacement
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.
As discussed with @lyrixx, this method is confusing as the context given as the 3rd argument to the
WorflowInterface::appy()method is never passed along to the guard events. According to @lyrixx, the guard listeners must take any decisions based on the subject itself and not on the given contextual data (which are supposed to remain metadata). As a consequence, calling thegetContextmethod on aGuardEventobject always returns an empty context.To prevent confusion and lower the BC breakage in 7.x, we advocate for deprecating this method in 6.4 and make it throw an exception in 7.0. Application codes should not call this method anyway as it always returns an empty array.
EDIT: a second approach in Symfony 7.x is to remove the
getContextmethod from the base abstract class and reimplement it as a dedicated trait that is used by all the other event classes exceptGuardEvent. This approach is probably a bit cleaner as the method will completly be dropped from theGuardEventclass scope.Any thoughts?