[Serializer] Improve CircularReference detection message #23322
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
dunglas
reviewed
Jun 28, 2017
| @@ -195,7 +195,7 @@ protected function handleCircularReference($object) | |||
| return call_user_func($this->circularReferenceHandler, $object); | |||
| } | |||
|
|
|||
| throw new CircularReferenceException(sprintf('A circular reference has been detected (configured limit: %d).', $this->circularReferenceLimit)); | |||
| throw new CircularReferenceException(sprintf('A circular reference has been detected (configured limit: %d) on %s.', $this->circularReferenceLimit, get_class($object))); | |||
There was a problem hiding this comment.
May I suggest A circular reference has been detected when serializing the object of class "App\Domain\User" identified by "00000000462ff471000000005e39f75b" (configured limit: 1).?
(Use spl_object_hash to get the id).
fe4161a to
dab69c3
Compare
Simperfit
approved these changes
Jul 1, 2017
| @@ -195,7 +195,7 @@ protected function handleCircularReference($object) | |||
| return call_user_func($this->circularReferenceHandler, $object); | |||
| } | |||
|
|
|||
| throw new CircularReferenceException(sprintf('A circular reference has been detected (configured limit: %d).', $this->circularReferenceLimit)); | |||
| throw new CircularReferenceException(sprintf('A circular reference has been detected when serializing the object of class "%s" identified by "%s" (configured limit: %d)', get_class($object), spl_object_hash($object), $this->circularReferenceLimit)); | |||
There was a problem hiding this comment.
does the hash provide any value?
There was a problem hiding this comment.
It may help if we catch this exception and show spl_hash of each normalized objects to compare. Honestly I'm not convinced too. I will remove it.
|
We could merge this as minor on the lowest branch where it applies, no need to consider it a new feature IMHO. |
dab69c3 to
3a529e3
Compare
|
Updated to lowest branch possible (2.7) |
|
Thank you @ScullWM. |
fabpot
added a commit
that referenced
this pull request
Jul 3, 2017
… (ScullWM) This PR was merged into the 2.7 branch. Discussion ---------- [Serializer] Improve CircularReference detection message | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT Hi, I've get a CircularReferenceException error while serializing object with nested levels. Detect a CircularReference is great, but having more information about the object that generate this exception is better. I simply suggest to add a `get_class` of the current object in the error message. Before: `A circular reference has been detected (configured limit: 1).` After (edit) `A circular reference has been detected when serializing the object of class "App\Domain\User" (configured limit: 1).` Commits ------- 3a529e3 Improve CircularReferenceException message
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,
I've get a CircularReferenceException error while serializing object with nested levels. Detect a CircularReference is great, but having more information about the object that generate this exception is better.
I simply suggest to add a
get_classof the current object in the error message.Before:
A circular reference has been detected (configured limit: 1).After (edit)
A circular reference has been detected when serializing the object of class "App\Domain\User" (configured limit: 1).