Sitelet https://web.archive.org/web/20201019185250/https://github.com/symfony/symfony/issues/33311
Skip to content

/ symfony

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the HttpClient panel in the Web Profiler #33311

Open
nicolas-grekas opened this issue Aug 23, 2019 · 8 comments
Open

Improve the HttpClient panel in the Web Profiler #33311

nicolas-grekas opened this issue Aug 23, 2019 · 8 comments
Labels
Good first issue Help wanted HttpClient

Comments

@nicolas-grekas
Copy link
Member

@nicolas-grekas nicolas-grekas commented Aug 23, 2019 •
edited

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 #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
This was referenced Aug 23, 2019
Closed
Merged
@ismail1432 ismail1432 mentioned this issue Aug 23, 2019
Merged
2 of 5 tasks complete
@Neirda24
Copy link

@Neirda24 Neirda24 commented Aug 25, 2019

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

@stof stof commented Aug 26, 2019

@Neirda24 that's indeed a good idea.
@k0d3r1s
Copy link
Contributor

@k0d3r1s k0d3r1s commented Sep 25, 2019

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?

Screenshot at 2019-09-25 19-24-41
Screenshot at 2019-09-25 19-25-18
@michaljusiega michaljusiega mentioned this issue Jan 12, 2020
Closed
@cristagu cristagu mentioned this issue Jan 19, 2020
Merged
@nicolas-grekas nicolas-grekas mentioned this issue Jan 20, 2020
Merged
@fabpot fabpot closed this Jan 22, 2020
fabpot added a commit that referenced this issue Jan 22, 2020
@fabpot
feature #35391 [WebProfilerBundle][HttpClient] Added profiler links i…
Loading status checks…
c4d15bc 
…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
fabpot added a commit that referenced this issue Jan 22, 2020
@fabpot
feature #35407 [HttpClient] collect the body of responses when possib…
Loading status checks…
07818f2 
…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
@nicolas-grekas nicolas-grekas reopened this Feb 3, 2020
nicolas-grekas added a commit that referenced this issue Feb 3, 2020
@nicolas-grekas
feature #33315 [WebProfiler] Improve HttpClient Panel (ismail1432)
Loading status checks…
fc30e61 
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 <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | np    <!-- please add some, will be required by reviewers -->
| Fixed tickets | #33311  <!-- #-prefixed issue number(s), if any -->
| 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
@noniagriconomie noniagriconomie mentioned this issue Jul 28, 2020
Closed
@derrabus
Copy link
Member

@derrabus derrabus commented Sep 17, 2020

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

I could really use that feature now. 🙈
@derrabus
Copy link
Member

@derrabus derrabus commented Sep 17, 2020

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
Copy link

@Neirda24 Neirda24 commented Sep 18, 2020

Maybe with a two tabs solution ? One RAW and one PARSED. It could be JSON or XML
@michaelKaefer
Copy link
Contributor

@michaelKaefer michaelKaefer commented Sep 30, 2020

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

@michaelKaefer michaelKaefer commented Oct 11, 2020

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().
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good first issue Help wanted HttpClient
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
@fabpot @nicolas-grekas @stof @derrabus @Neirda24 @michaelKaefer @k0d3r1s
You can’t perform that action at this time.