[HttpFoundation] deprecate call to Request::getSession() when Request::hasSession() returns false #26564
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
Contributor
fmata
commented
Mar 16, 2018
•
| Q | A |
|---|---|
| Branch? | master |
| Bug fix? | no |
| New feature? | no |
| BC breaks? | no |
| Deprecations? | yes |
| Tests pass? | yes |
| Fixed tickets | #26539 |
| License | MIT |
nicolas-grekas
requested changes
Mar 16, 2018
| @@ -725,6 +725,10 @@ public function getSession() | |||
| $this->setSession($session = $session()); | |||
| } | |||
|
|
|||
| if (null === $session) { | |||
| @trigger_error(sprintf('Calling "%s()" when "%s::hasSession()" returns false is deprecated since Symfony 4.1 and will throw an exception in 5.0.', __METHOD__, __CLASS__), E_USER_DEPRECATED); | |||
There was a problem hiding this comment.
Calling "%s()" when non session has been set is deprecated since Symfony 4.1 and will throw an exception in 5.0. Use "hasSession()" instead.
also, please add the exception tight now, but as a commented line, so that upgrading for 5.0 is made trivial:
// throw new ...
There was a problem hiding this comment.
Message updated.
About the // throw new ... I thought a type hinting on the return type with SessionInterface was enough, PHP will throw :
TypeError : Return value of Request::getSession() must implement interface SessionInterface.
WDYT ?
There was a problem hiding this comment.
I think we can provide a friendlier message, don't you?
nicolas-grekas
approved these changes
Mar 16, 2018
Tobion
reviewed
Mar 16, 2018
| @@ -725,6 +725,11 @@ public function getSession() | |||
| $this->setSession($session = $session()); | |||
| } | |||
|
|
|||
| if (null === $session) { | |||
| @trigger_error(sprintf('Calling "%s()" when non session has been set is deprecated since Symfony 4.1 and will throw an exception in 5.0. Use "hasSession()" instead.', __METHOD__), E_USER_DEPRECATED); | |||
Tobion
reviewed
Mar 17, 2018
| @@ -54,6 +54,7 @@ HttpFoundation | |||
|
|
|||
| * The `$size` argument of the `UploadedFile` constructor has been removed. | |||
| * The `getClientSize()` method of the `UploadedFile` class has been removed. | |||
| * The `getSession()` method of the `Request` class throws an exception when session is null. | |||
There was a problem hiding this comment.
mentioning the deprecation in UPGRADE-4.1.md and HttpFoundation/CHANGELOG.md is missing
There was a problem hiding this comment.
Done. I will send a PR (edit : #26580) to update the Github PR template to help contributors to do such things, thanks.
…::hasSession() returns false
fabpot
approved these changes
Mar 18, 2018
|
Thank you @fmata. |
fabpot
added a commit
that referenced
this pull request
Mar 18, 2018
…() when Request::hasSession() returns false (fmata) This PR was merged into the 4.1-dev branch. Discussion ---------- [HttpFoundation] deprecate call to Request::getSession() when Request::hasSession() returns false | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #26539 | License | MIT Commits ------- 4110d57 [HttpFoundation] deprecate call to Request::getSession() when Request::hasSession() returns false
Merged
nicolas-grekas
added a commit
that referenced
this pull request
May 25, 2018
…r (alekitto) This PR was merged into the 4.1 branch. Discussion ---------- [HttpKernel] fix deprecation in AbstractTestSessionListener | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT After #26564 functional tests began to emit a deprecation warning because of `getSession()` being called without verifying the existence of a session. Commits ------- 0ecaefe [HttpKernel] fix deprecation in AbstractTestSessionListener
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.