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

Deuchnord · 2021-11-04T16:03:39Z

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:

Make a first PoC of the feature
Generate the curl command
Added some UX considerations to the button
Update the tests

carsonbot · 2021-11-04T16:03:41Z

Hey!

To help keep things organized, we don't allow "Draft" pull requests. Could you please click the "ready for review" button or close this PR and open a new one when you are done?

Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it. We just want it to be ready for a first review.

Cheers!

Carsonbot

stof · 2021-11-04T16:26:59Z

Make the _cURL' button show a small window that displays the curl command to copy (useful on browsers that do not support navigator.clipboard) along with a button to copy.

The WebProfiler pages are targetting modern browsers only. And all modern browsers support it navigator.clipboard. However, they support it only in secure contexts.
So the cases that would benefit from the displayed text are not older browsers, but non secure contexts.

src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php

Deuchnord · 2021-11-05T16:14:08Z

@stof @nicolas-grekas I'm not really sure of how I should handle the body in the generated curl command when it is a closure or a resource? (see https://symfony.com/doc/current/http_client.html#uploading-data)

stof · 2021-11-05T22:26:00Z

@Deuchnord for such cases, I would suggest skipping the "copy as curl" button

src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php

nicolas-grekas

I'm not sure the current logic works when there are redirects involved.
Can you add a test case that hits http://symfony.com/releases.json to trigger one?
The curl command-line should only contain the first call of course.

src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php

Deuchnord · 2022-03-04T15:20:47Z

I'm not sure the current logic works when there are redirects involved. Can you add a test case that hits http://symfony.com/releases.json to trigger one? The curl command-line should only contain the first call of course.

Looks like $trace['info']['url'] only contains the last URL of the redirection chain. Does it make sense it for you if the generated cURL command gives it directly?

nicolas-grekas · 2022-03-04T16:17:29Z

Looks like $trace['info']['url'] only contains the last URL of the redirection chain

indeed, but why don't we use $trace['url'] instead?

Deuchnord · 2022-03-04T17:02:00Z

Because I didn't spot it until now, thanks for pointing it 😅
It's fixed :)

nicolas-grekas · 2022-03-04T17:11:23Z

There's a failure on appveyor :)

Deuchnord · 2022-03-08T13:23:02Z

I'm not sure to understand the error given by the tests on AppVeyor:

1) Symfony\Component\HttpClient\Tests\DataCollector\HttpClientDataCollectorTest::testItGeneratesCurlCommandsAsExpected
Symfony\Component\HttpClient\Exception\TransportException: fopen(): Unable to find the wrapper "https" - did you forget to enable it when you configured PHP?

If I read the config file correctly, the php_openssl.dll is already activated, isn't it?

nicolas-grekas · 2022-03-08T14:56:21Z

openssl is first disabled then re-enabled, to ensure that the test suite doesn't rely on implicit deps, including ext-openssl.

…L command

fabpot · 2022-03-09T07:18:18Z

Thank you @Deuchnord.

sashaaro · 2022-05-12T20:40:34Z

can we collect class request objects and use https://github.com/php-http/message/blob/master/src/Formatter/CurlCommandFormatter.php for it? it can make service usable and universal

stof · 2022-05-13T08:40:04Z

There is no class request object in symfony/http-client

… body for c… (Phillip Look) This PR was merged into the 6.1 branch. Discussion ---------- [HttpClient][WebProfilerBundle] Catch errors when encoding body for c… | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | In Symfony 6.1 a [button to copy a request as a cURL command](#43931) was introduced for the profiler. But if I post a binary file containing null characters using the curl-http-client the `HttpClientDataCollector` throws an error. ``` Warning: Uncaught ValueError: escapeshellarg(): Argument #1 ($arg) must not contain any null bytes ``` My solution is to catch the `ValueError` in this situation and to return `null` as the resulting curl command. Returning `null` seems to be the standard handling for unexpectad values in this data collector. Commits ------- 36e6fa0 [HttpClient][WebProfilerBundle] Catch errors when encoding body for curl command line

… body for c… (Phillip Look) This PR was merged into the 6.1 branch. Discussion ---------- [HttpClient][WebProfilerBundle] Catch errors when encoding body for c… | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | In Symfony 6.1 a [button to copy a request as a cURL command](symfony/symfony#43931) was introduced for the profiler. But if I post a binary file containing null characters using the curl-http-client the `HttpClientDataCollector` throws an error. ``` Warning: Uncaught ValueError: escapeshellarg(): Argument #1 ($arg) must not contain any null bytes ``` My solution is to catch the `ValueError` in this situation and to return `null` as the resulting curl command. Returning `null` seems to be the standard handling for unexpectad values in this data collector. Commits ------- 36e6fa0935 [HttpClient][WebProfilerBundle] Catch errors when encoding body for curl command line

Deuchnord marked this pull request as ready for review November 4, 2021 16:05

carsonbot added Status: Needs Review Feature WebProfilerBundle labels Nov 4, 2021

carsonbot added this to the 6.0 milestone Nov 4, 2021

carsonbot changed the title ~~[Profiler] HttpClient: add button to copy a request to a cURL command~~ [WebProfilerBundle] HttpClient: add button to copy a request to a cURL command Nov 4, 2021

stof reviewed Nov 4, 2021

View reviewed changes

src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php Outdated Show resolved Hide resolved

stof reviewed Nov 4, 2021

View reviewed changes

src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php Outdated Show resolved Hide resolved

derrabus modified the milestones: 6.0, 6.1 Nov 4, 2021

Deuchnord force-pushed the profiler-http-client-curl-clipboard-button branch from 8e80365 to 4ba28ab Compare November 5, 2021 16:10

GromNaN reviewed Nov 5, 2021

View reviewed changes

src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php Outdated Show resolved Hide resolved

Deuchnord force-pushed the profiler-http-client-curl-clipboard-button branch 9 times, most recently from c2e3fff to d09175a Compare November 9, 2021 10:12

Deuchnord requested review from nicolas-grekas and stof November 9, 2021 10:20

Deuchnord force-pushed the profiler-http-client-curl-clipboard-button branch 2 times, most recently from b2fafdd to 0a3b52e Compare December 5, 2021 15:41

Deuchnord changed the title ~~[HttpClient][WebProfilerBundle] HttpClient: add button to copy a request to a cURL command~~ [HttpClient][WebProfilerBundle] Add button to copy a request to a cURL command Dec 14, 2021

Deuchnord force-pushed the profiler-http-client-curl-clipboard-button branch from 0a3b52e to 34ef21e Compare February 21, 2022 07:59

nicolas-grekas reviewed Feb 21, 2022

View reviewed changes

Deuchnord force-pushed the profiler-http-client-curl-clipboard-button branch from 812cb6c to 0b76a18 Compare March 4, 2022 15:24

Deuchnord changed the title ~~[HttpClient][WebProfilerBundle] Add button to copy a request to a cURL command~~ [HttpClient][WebProfilerBundle] Add button to copy a request as a cURL command Mar 4, 2022

Deuchnord force-pushed the profiler-http-client-curl-clipboard-button branch from 71e4d65 to d7adc1f Compare March 8, 2022 15:17

nicolas-grekas approved these changes Mar 8, 2022

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 8, 2022

fabpot mentioned this pull request Mar 9, 2022

Improve the HttpClient panel in the Web Profiler #33311

Closed

fabpot approved these changes Mar 9, 2022

View reviewed changes

[HttpClient][WebProfilerBundle] Add button to copy a request as a cUR…

67c9146

…L command

fabpot force-pushed the profiler-http-client-curl-clipboard-button branch from d7adc1f to 67c9146 Compare March 9, 2022 07:18

fabpot mentioned this pull request Mar 9, 2022

[HttpClient][WebProfilerBundle] Add button to copy a request as a cURL … symfony/symfony-docs#16581

Closed

fabpot merged commit 194e274 into symfony:6.1 Mar 9, 2022

Deuchnord deleted the profiler-http-client-curl-clipboard-button branch March 9, 2022 08:20

fabpot mentioned this pull request Apr 15, 2022

Release v6.1.0-BETA1 #46049

Merged

pl-github mentioned this pull request Jun 3, 2022

[HttpClient][WebProfilerBundle] Catch errors when encoding body for c… #46570

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Deuchnord commented Nov 4, 2021 •

edited

Loading

carsonbot commented Nov 4, 2021

stof commented Nov 4, 2021

Deuchnord commented Nov 5, 2021

stof commented Nov 5, 2021 •

edited

Loading

nicolas-grekas left a comment

Deuchnord commented Mar 4, 2022

nicolas-grekas commented Mar 4, 2022 •

edited

Loading

Deuchnord commented Mar 4, 2022

nicolas-grekas commented Mar 4, 2022

Deuchnord commented Mar 8, 2022

nicolas-grekas commented Mar 8, 2022

fabpot commented Mar 9, 2022

sashaaro commented May 12, 2022

stof commented May 13, 2022

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

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

Conversation

Deuchnord commented Nov 4, 2021 • edited Loading

carsonbot commented Nov 4, 2021

stof commented Nov 4, 2021

Deuchnord commented Nov 5, 2021

stof commented Nov 5, 2021 • edited Loading

nicolas-grekas left a comment

Choose a reason for hiding this comment

Deuchnord commented Mar 4, 2022

nicolas-grekas commented Mar 4, 2022 • edited Loading

Deuchnord commented Mar 4, 2022

nicolas-grekas commented Mar 4, 2022

Deuchnord commented Mar 8, 2022

nicolas-grekas commented Mar 8, 2022

fabpot commented Mar 9, 2022

sashaaro commented May 12, 2022

stof commented May 13, 2022

Deuchnord commented Nov 4, 2021 •

edited

Loading

stof commented Nov 5, 2021 •

edited

Loading

nicolas-grekas commented Mar 4, 2022 •

edited

Loading