[Routing][Security] Document the LogoutRouteLoader
#19000
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
This was referenced Oct 6, 2023
javiereguiluz
added
Routing
Security
Waiting Code Merge
carsonbot
changed the title
LogoutRouteLoaderLogoutRouteLoader
wouterj
added a commit
to symfony/symfony
that referenced
this pull request
Oct 15, 2023
…TheCat) This PR was merged into the 6.4 branch. Discussion ---------- [Routing][SecurityBundle] Add `LogoutRouteLoader` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #50920 | License | MIT | Doc PR | symfony/symfony-docs#19000 #50920 is about avoiding for users to create logout routes. Given [we don’t want to allow bundles registering routes](#37786), I added a `LogoutRouteLoader` service bearing the `routing.route_loader` tag to be imported by the user. Such import could be added to the SecurityBundle recipe: ```yaml # config/routes/security.yaml logout: resource: security.route_loader.logout type: service ``` To invalidate routes when logout paths change, I stored them in a parameter so that the `ContainerParametersResourceChecker` can check the collection. Not sure if it’s okay or if a better way exists. Commits ------- 0a558d0 [SecurityBundle][Routing] Add `LogoutRouteLoader`
alamirault
reviewed
Oct 15, 2023
alamirault
suggested changes
Oct 15, 2023
There was a problem hiding this comment.
Thanks @MatTheCat for this PR and improving DX !
I had so many time forget to create logout route, or an empty controller felt weird in source code
wouterj
reviewed
Oct 16, 2023
Comment on lines
+1847
to
+1848
| Symfony will then un-authenticate users navigating to the configured ``path``, | ||
| and redirect them to the configured ``target``. |
There was a problem hiding this comment.
Suggested change
| Symfony will then un-authenticate users navigating to the configured ``path``, | |
| and redirect them to the configured ``target``. | |
| Symfony will then un-authenticate users navigating to the configured ``path``, | |
| and redirect them to the configured ``target``. You can generate URLs to this | |
| path using the ``_security_<firewallname>`` route name (e.g. ``_security_main``). |
There was a problem hiding this comment.
Shouldn’t the LogoutUrlGenerator be mentioned instead?
MatTheCat
force-pushed
the
logout-route-loader
branch
from
6584810 to
715899b
Compare
tobias-93
reviewed
Dec 12, 2023
wouterj
force-pushed
the
logout-route-loader
branch
from
209f22b to
8906132
Compare
|
Thank you @MatTheCat for also providing the docs of this cool feature! |
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.
Related to
LogoutRouteLoadersymfony#50946