[Serializer] Add serializer profiler #45656
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
715a7e0 to
233c54b
Compare
|
Hey! I think @alexandre-daubois has recently worked with this code. Maybe they can help review this? Cheers! Carsonbot |
kaznovac
reviewed
Mar 7, 2022
src/Symfony/Component/Serializer/Encoder/TraceableEncoder.php.orig
Outdated
Show resolved
Hide resolved
94noni
reviewed
Mar 7, 2022
233c54b to
a57cce3
Compare
5 tasks
a57cce3 to
0e20ad6
Compare
chalasr
approved these changes
Apr 1, 2022
fabpot
approved these changes
Apr 1, 2022
|
|
||
| {% block menu %} | ||
| <span class="label {{ not collector.handledCount ? 'disabled' }}"> | ||
| <span class="icon">{{ include('@WebProfiler/Icon/validator.svg') }}</span> |
There was a problem hiding this comment.
Icon needs to be updated. We are working on updating all icons soon, so let's not block this PR for now.
|
Thank you @mtarld. |
Merged
fabpot
added a commit
that referenced
this pull request
May 4, 2022
…ofiler panel (javiereguiluz) This PR was merged into the 6.1 branch. Discussion ---------- [WebProfilerBundle] Update the icon of the Serializer profiler panel | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - In the PR that added the Serializer profiler panel, the new icon was left as a pending thing. See #45656 (comment) This PR adds the new icon and it looks like this: <img width="264" alt="icon-serializer" src="https://user-images.githubusercontent.com/73419/166722845-a9852079-1436-44a9-9421-399e2e9d312e.png"> Two comments: (1) The icon style doesn't 100% match the style of the other icons. Don't worry about that. We plan to update all icons for Symfony 6.2 and they all will use that style. (2) I know the icon might not be super clear and I'm open to better suggestions for this icon ... but it seems that it's impossible to conceptualize the "serializer" concept in an icon. See the biggest icon libraries in the world: * Iconfinder: it has nothing about that: https://www.iconfinder.com/search?q=serializer * The Noun Project: it has an icon of a triangle. It looks totally random to me: https://thenounproject.com/search/icons/?iconspage=1&q=serializer So, I did this: I looked for "serializer" in Google Images (https://www.google.com/search?q=serializer&tbm=isch) and found that most images are block diagrams with lots of horizontal arrows. That's why I opted for the "two horizontal arrows" icon. Commits ------- 8bfb80b [WebProfilerBundle] Update the icon of the Serializer profiler panel
Guikingone
added a commit
to Guikingone/SchedulerBundle
that referenced
this pull request
May 26, 2022
Guikingone
added a commit
to Guikingone/SchedulerBundle
that referenced
this pull request
May 31, 2022
Guikingone
added a commit
to Guikingone/SchedulerBundle
that referenced
this pull request
Jun 1, 2022
…ormalizer added (#260) * refactor(serializer): support for TraceableNormalizer && TraceableDenormalizer added See symfony/symfony#45656 * refactor(core): serializer dependencies improved * refactor(core): improvements on static analysis * refactor(serializer): improvements * refactor(serializer): TaskNormalizer fixed
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.
By design, it's quite hard to find out what happens when serializing data using the serializer.
Indeed, it's hard to discover which normalizer and which encoder was used due to the "kind of chain of responsibility pattern".
This PR adds a way to trace what happens during the serialization process (and how long each step took).
To do that, the
serializerservice is decorated to traceserialize,deserialize,normalize,denormalize,encodeanddecodemethods calls.Each normalizer and encoder is decorated as well so that it can fill the trace when called.
Finally, the
SerializerDataCollectoris collecting data during the whole process and aggregating it once as the end to make it available to the profiler.Please note that tracing is only available when calling the
serializerservice.When calling a normalizer/encoder directly, nothing will be traced (which is fair enough IMHO as most of the users are serializing data using the
serializerservice).At the moment, I reused the validator icon because I haven't created one specifically for the serializer.
I asked somebody to create that icon for me, but maybe there is someone used to it that wanna take care of it?
Since Symfony 6.1 will require PHP 8.1 as a minimum dependency, I used constructor property promotion.
But I'm not sure that's the coding standard that Symfony wanna use in the future, so I can use regular constructor property assignment if it's preferred.