Improve the HttpClient panel in the Web Profiler #33311

nicolas-grekas · 2019-08-23T17:13:42Z

PR #33015 introduces a profiler panel for the HttpClient component.
It was decided to merge it and improve it in nex iterations.

Here are the ideas that would be great to contribute, help wante:

the panel UI could be improved I suppose, e.g. a tooltip on hover in the toolbar
putting requests in the "Performance" tab would be great (all timings are already in the collected "info")
~~response bodies are not collected yet~~ [HttpClient] collect the body of responses when possible #35407
when a transport error occurs, (ie the "error" info is populated) we should maybe have a better display too?
~~add a copy-as-curl button next to each request~~ [HttpClient][WebProfilerBundle] Add button to copy a request as a cURL command #43931

Neirda24 · 2019-08-25T08:48:35Z

To improve DX, what if we parse the headers in the response and detect the debug token link to display it. WDYT ?

stof · 2019-08-26T08:06:43Z

@Neirda24 that's indeed a good idea.

k0d3r1s · 2019-09-25T16:30:14Z

i have a guzzle collector but I couldn't fit httpclient datacollector data into it. how much is it possible to change what this collector already does and how it collects data?

@Neirda24

…n the Web Profiler -> Http Client panel (cristagu) This PR was squashed before being merged into the 5.1-dev branch (closes #35391). Discussion ---------- [WebProfilerBundle][HttpClient] Added profiler links in the Web Profiler -> Http Client panel | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | [#33311](#33311) | License | MIT | Doc PR | - As per @Neirda24's idea in this [comment](#33311 (comment)), I parsed the response headers collected by the TraceableHttpClient and created profiler links in the HttpClient Web Profiler panel for all the requests having the 'X-Debug-Token' header. ![profiler](https://user-images.githubusercontent.com/26301369/72686050-19a91300-3af9-11ea-998b-db063a3aa358.PNG) Commits ------- 70e11f9 [WebProfilerBundle][HttpClient] Added profiler links in the Web Profiler -> Http Client panel

…le (nicolas-grekas) This PR was merged into the 5.1-dev branch. Discussion ---------- [HttpClient] collect the body of responses when possible | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Part of #33311 | License | MIT | Doc PR | - This is missing one thing: the HTML part in the profiler. ![image](https://user-images.githubusercontent.com/243674/72798816-29813e00-3c44-11ea-9586-99c2c6b91640.png) ![image](https://user-images.githubusercontent.com/243674/72798851-3f8efe80-3c44-11ea-973b-7ecc64a5a542.png) Commits ------- 121f728 [HttpClient] collect the body of responses when possible

This PR was merged into the 5.1-dev branch. Discussion ---------- [WebProfiler] Improve HttpClient Panel | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no  | Tests pass? | np  | Fixed tickets | #33311  | License | MIT | Doc PR | ? Wishlist from issue : - [x] the panel UI could be improved I suppose, e.g. a tooltip on hover in the toolbar - [ ] putting requests in the "Performance" tab would be great (all timings are already in the collected "info") - [ ] ~response bodies are not collected yet~ #33315 (comment) - [ ] when a transport error occurs, (ie the "error" info is populated) we should maybe have a better display too? - [x] add a copy-as-curl button next to each request **[EDIT 07 oct 19]** This PR contains : - Display a tooltip in Toolbar - Add a link only for GET Request in profiler panel ![image](https://user-images.githubusercontent.com/13260307/66316799-389be480-e910-11e9-888e-7703c87c7b10.png) Commits ------- e2e6bd0 [WebProfiler] Improve HttpClient Panel

derrabus · 2020-09-17T13:09:18Z

add a copy-as-curl button next to each request

I could really use that feature now. 🙈

derrabus · 2020-09-17T13:26:00Z

Another idea for the profiler: If the API answers in JSON, we could try to parse and pretty-print it. Right now, I receive a string response_content that is a little hard to read.

Neirda24 · 2020-09-18T06:45:56Z

Maybe with a two tabs solution ? One RAW and one PARSED. It could be JSON or XML

michaelKaefer · 2020-09-30T17:18:11Z

Info: since it got the labels Good first issue and Help wanted I start to work on the remaining tasks.

michaelKaefer · 2020-10-11T19:43:36Z

I hope someone can guide me on implementing this task: putting requests in the "Performance" tab would be great (all timings are already in the collected "info")

The times in the "Performance" tab are measured by calling Stopwatch::start() and Stopwatch::stop() (so I suppose this has to be done for every request and the collected "info" does not help here).

The Stopwatch::start() can be called in TraceableHttpClient::request() or somewhere in TraceableResponse. But where do we know that the response is complete so that we can call Stopwatch::stop()? I tried to use the on_progress callback but that does not work since we never know if it is the last call of the callback. I also tried Response::getContent() but that does not work if the client code never calls $response->getContent().

erickr · 2020-10-26T18:24:55Z

@michaelKaefer did you get going on this? I'm also interested to learn more, perhaps we can dig together if you want some assistance or sparring of course.. 😎

jderusse · 2020-10-26T18:57:54Z

@michaelKaefer , @erickr the StopWatch has already been implemented #38688

michaelKaefer · 2020-10-27T20:42:21Z

So I am out here. Current state:

the panel UI could be improved I suppose, e.g. a tooltip on hover in the toolbar
~~putting requests in the "Performance" tab would be great (all timings are already in the collected "info")~~ [HttpClient] Add a Stopwatch on TraceableHttpClient #38688
~~response bodies are not collected yet~~ [HttpClient] collect the body of responses when possible #35407
when a transport error occurs, (ie the "error" info is populated) we should maybe have a better display too?
add a copy-as-curl button next to each request ---> Started here and taken by @derrabus

carsonbot · 2021-04-28T13:04:23Z

Thank you for this issue.
There has not been a lot of activity here for a while. Has this been resolved?

derrabus · 2021-04-28T17:51:26Z

Not yet, @carsonbot!

ankahla · 2021-09-28T14:11:09Z

As menstionned here #33311 (comment) guzzle output the request headers (including default headers in configuration).
@nicolas-grekas even with this PR #35407 we still not collecting all headers (headers defined in configuration are missing).
I think we need to expose defaultHeaders and get them from HttpClientTrait directly.

abdellahrk · 2021-11-17T10:58:00Z

Hello devs, any issue here still not solved yet? I'll like to jump in.
Thank you.

…equest as a cURL command (Deuchnord) This PR was squashed before being merged into the 6.1 branch. Discussion ---------- [HttpClient][WebProfilerBundle] Add button to copy a request as a cURL command | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | #33311  | License | MIT | Doc PR | Adding a button to each request in the HttpClient section to copy it as a `curl` command that can be then pasted either in the terminal (on Linux and Mac) or in an application that can parse it (like Insomnia). Work in progress: - [x] Make a first PoC of the feature - [x] Generate the `curl` command - [x] Added some UX considerations to the button - [x] Update the tests  Commits ------- 67c9146 [HttpClient][WebProfilerBundle] Add button to copy a request as a cURL command

nicolas-grekas · 2022-04-03T16:42:42Z

I think we're done here, no need to keep this issue open. PR welcome of course if you have ideas to improve the panel!

nicolas-grekas added HttpClient Good first issue Ideal for your first contribution! (some Symfony experience may be required) Help wanted Issues and PRs which are looking for volunteers to complete them. labels Aug 23, 2019

This was referenced Aug 23, 2019

[HttpClient] Added TraceableHttpClient and WebProfiler panel #30494

Closed

[HttpClient] Added TraceableHttpClient and WebProfiler panel #33015

Merged

ismail1432 mentioned this issue Aug 23, 2019

[WebProfiler] Improve HttpClient Panel #33315

Merged

5 tasks

michaljusiega mentioned this issue Jan 12, 2020

[HttpClient][WDT] Add missing response content #35317

Closed

cristagu mentioned this issue Jan 19, 2020

[WebProfilerBundle][HttpClient] Added profiler links in the Web Profiler -> Http Client panel #35391

Merged

nicolas-grekas mentioned this issue Jan 20, 2020

[HttpClient] collect the body of responses when possible #35407

Merged

fabpot closed this as completed Jan 22, 2020

nicolas-grekas reopened this Feb 3, 2020

noniagriconomie mentioned this issue Jul 28, 2020

[Profiler] Add HttpClient copy as curl feature #37691

Closed

carsonbot added the Stalled label Apr 28, 2021

carsonbot removed the Stalled label Apr 28, 2021

ankahla mentioned this issue Oct 6, 2021

HttpClient panel in the Web Profiler not displaying all request headers #43348

Closed

Deuchnord mentioned this issue Nov 4, 2021

[HttpClient][WebProfilerBundle] Add button to copy a request as a cURL command #43931

Merged

4 tasks

derrabus added the Keep open label Nov 21, 2021

nicolas-grekas closed this as completed Apr 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the HttpClient panel in the Web Profiler #33311

Improve the HttpClient panel in the Web Profiler #33311

nicolas-grekas commented Aug 23, 2019 •

edited by fabpot

Loading

Neirda24 commented Aug 25, 2019

stof commented Aug 26, 2019

k0d3r1s commented Sep 25, 2019

derrabus commented Sep 17, 2020

derrabus commented Sep 17, 2020

Neirda24 commented Sep 18, 2020

michaelKaefer commented Sep 30, 2020

michaelKaefer commented Oct 11, 2020

erickr commented Oct 26, 2020

jderusse commented Oct 26, 2020

michaelKaefer commented Oct 27, 2020

carsonbot commented Apr 28, 2021

derrabus commented Apr 28, 2021

ankahla commented Sep 28, 2021 •

edited

Loading

abdellahrk commented Nov 17, 2021

nicolas-grekas commented Apr 3, 2022

Improve the HttpClient panel in the Web Profiler #33311

Improve the HttpClient panel in the Web Profiler #33311

Comments

nicolas-grekas commented Aug 23, 2019 • edited by fabpot Loading

Neirda24 commented Aug 25, 2019

stof commented Aug 26, 2019

k0d3r1s commented Sep 25, 2019

derrabus commented Sep 17, 2020

derrabus commented Sep 17, 2020

Neirda24 commented Sep 18, 2020

michaelKaefer commented Sep 30, 2020

michaelKaefer commented Oct 11, 2020

erickr commented Oct 26, 2020

jderusse commented Oct 26, 2020

michaelKaefer commented Oct 27, 2020

carsonbot commented Apr 28, 2021

derrabus commented Apr 28, 2021

ankahla commented Sep 28, 2021 • edited Loading

abdellahrk commented Nov 17, 2021

nicolas-grekas commented Apr 3, 2022

nicolas-grekas commented Aug 23, 2019 •

edited by fabpot

Loading

ankahla commented Sep 28, 2021 •

edited

Loading