-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Adding MigratingSessionHandler docs #9496
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.
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
Adding MigratingSessionHandler docs #9496
Conversation
…ssmotley) This PR was squashed before being merged into the 4.1-dev branch (closes #26096). Discussion ---------- [HttpFoundation] Added a migrating session handler | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | symfony/symfony-docs#9496 - [x] gather feedback for my changes - [x] submit changes to the documentation - [x] update the changelog When migrating to a new session handler on a live system, it's useful to be able to do it with no loss of session data. This migrating handler allows the sessions to be written to an additional handler to enable a migration workflow like: * Switch to migrating handler, with your new handler as the 'write only' one. The old handler behaves as usual and sessions get written to the new one. * After verifying the data in the new handler (and after the session gc period), switch the migrating handler to use your old handler as the 'write only' one instead, so the sessions will now be read from the new handler. This step allows easier rollbacks. * After verifying everything, switch from the migrating handler to the new handler Commits ------- 3acd548 [HttpFoundation] Added a migrating session handler
* Switch to the migrating handler, with your new handler as the write-only one. The old handler behaves as usual and sessions get written to the new one. | ||
* After your session gc period, verify the data in the new handler | ||
* Update the migrating handler to use the old handler as the write-only one, so the sessions will now be read from the new handler. This step allows easier rollbacks. | ||
* After verifying everything, switch from the migrating handler to the new handler |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing a full stop at the end
* After verifying everything, switch from the migrating handler to the new handler.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added that and tweaked the text a little bit.
Added full-stop and tweaked text.
Added missing "that".
Would it make sense to move the detailed description to a new guide and only link to it from this page? |
@xabbuh it looks like the page is becoming quite big already with this addition, it might be an option |
Thanks @rossmotley. This was a really nice first contribution to Symfony Docs! Thank you. |
…uiluz) This PR was merged into the 4.1 branch. Discussion ---------- Adding MigratingSessionHandler docs Adding `MigratingSessionHandler` documentation for symfony/symfony#26096 Commits ------- e93756f Added the versionadded directive 386f639 Reworded and simplified 7c8264d Update session_configuration.rst e971074 Update session_configuration.rst 91aa58d Adding MigratingSessionHandler docs
Adding
MigratingSessionHandler
documentation for symfony/symfony#26096