8000 feature #28919 [DX][WebProfilerBundle] Add Pretty Print functionality… · symfony/web-profiler-bundle@a5aec0c · GitHub
[go: up one dir, main page]
Skip to content

Commit a5aec0c

Browse files
fabpotfabpot
committed
feature #28919 [DX][WebProfilerBundle] Add Pretty Print functionality for Request Content (SamFleming)
This PR was squashed before being merged into the 4.3-dev branch (closes #28919). Discussion ---------- [DX][WebProfilerBundle] Add Pretty Print functionality for Request Content | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | n/a ? ## Why? Quite often when attempting to debug issues with JSON requests sent to a Symfony API, I use the Web Profiler to check the request content. More often than not the request content isn't easily readable (99% of the time it's all stuck on a single line and impossible to read). I always find myself copying + pasting the content into a random online tool to have it "pretty-print" the JSON. Usually this isn't an issue, but can be annoying when offline. There's also the security issue of sending entire JSON payloads to a third-party server just for formatting 😳. Alternatively, maybe developers copy+paste into their chosen editors and this PR is all a waste of time — I hope not 😛. ## How? This PR adds "Pretty-Print" JSON functionality straight into the profiler. We can use `collector.requestheaders` to detect if the request was JSON and conditionally show the Pretty Print button. When the button is clicked, we format the JSON from the "Request Content" card. ## What does it look like? Before: ![without-pretty-print](https://user-images.githubusercontent.com/573318/47180751-36b0ce00-d319-11e8-86ed-eb0d78ebcbe3.png) After: ![pretty](https://user-images.githubusercontent.com/573318/47180763-3c0e1880-d319-11e8-995d-eba565aad827.png) Non-JSON Requests (unchanged): ![non-json-request](https://user-images.githubusercontent.com/573318/47181080-03227380-d31a-11e8-8cf2-e8b2e8c1a21d.png) ## Things to consider - Is `JSON.stringify(JSON.parse(content));` the safest, most efficient way to do this? - Should the "Pretty Print" button be in-line next to the "Request Content" header? I couldn't find a pattern for this sort of thing elsewhere in the profiler. - Do people want JSON formatted with 4 spaces, would 2 spaces be preferred? Should this be a configuration option stored in localStorage (such as the light/dark theme configuration)? - Should this be a toggle? E.g. click to pretty print, then click to undo ## Future Improvements Depending on how this is received it could be extended to support formatting different request content-types (e.g. XML formatting) — I assume. ## Progress - [x] Gather feedback and decide where to perform the pretty-print: [server-side, or client-side](symfony/symfony#28919 (comment)). *It was decided server-side would be better.* Commits ------- 9f85103151 [DX][WebProfilerBundle] Add Pretty Print functionality for Request Content
2 parents dba3819 + 4e7970d commit a5aec0c

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

‎Resources/views/Collector/request.html.twig

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,27 @@
161161
<p>Request content not available (it was retrieved as a resource).</p>
162162
</div>
163163
{% elseif collector.content %}
164-
<div class="card">
165-
<pre class="break-long-words">{{ collector.content }}</pre>
164+
<div class="sf-tabs">
165+
{% set prettyJson = collector.isJsonRequest ? collector.prettyJson : null %}
166+
{% if prettyJson is not null %}
167+
<div class="tab">
168+
<h3 class="tab-title">Pretty</h3>
169+
<div class="tab-content">
170+
<div class="card" style="max-height: 500px; overflow-y: auto;">
171+
<pre class="break-long-words">{{ prettyJson }}</pre>
172+
</div>
173+
</div>
174+
</div>
175+
{% endif %}
176+
177+
<div class="tab">
178+
<h3 class="tab-title">Raw</h3>
179+
<div class="tab-content">
180+
<div class="card">
181+
<pre class="break-long-words">{{ collector.content }}</pre>
182+
</div>
183+
</div>
184+
</div>
166185
</div>
167186
{% else %}
168187
<div class="empty">

‎Resources/views/Profiler/base_js.html.twig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@
556556
557557
/* create the tab navigation for each group of tabs */
558558
for (var i = 0; i < tabGroups.length; i++) {
559-
var tabs = tabGroups[i].querySelectorAll('.tab');
559+
var tabs = tabGroups[i].querySelectorAll(':scope > .tab');
560560
var tabNavigation = document.createElement('ul');
561561
tabNavigation.className = 'tab-navigation';
562562
@@ -582,7 +582,7 @@
582582
583583
/* display the active tab and add the 'click' event listeners */
584584
for (i = 0; i < tabGroups.length; i++) {
585-
tabNavigation = tabGroups[i].querySelectorAll('.tab-navigation li');
585+
tabNavigation = tabGroups[i].querySelectorAll(':scope > .tab-navigation li');
586586
587587
for (j = 0; j < tabNavigation.length; j++) {
588588
tabId = tabNavigation[j].getAttribute('data-tab-id');

0 commit comments

Comments
 (0)
0