[Profiler] HttpClient: add button to copy a request to a cURL command

Jérôme Deuchnord · Jérôme Deuchnord · commit d09175a1c183 · 2021-11-09T11:11:54.000+01:00
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/http_client.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/http_client.html.twig
@@ -94,6 +94,11 @@
                                                 Profile
                                             </th>
                                         {% endif %}
+                                        {% if trace.curlCommand is not null %}
+                                            <th>
+                                                <button class="btn btn-sm hidden" title="Copy as cURL command" data-clipboard-text="{{ trace.curlCommand }}">cURL</button>
+                                            </th>
+                                        {% endif %}
                                     </tr>
                                     </thead>
                                     <tbody>
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/base_js.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/base_js.html.twig
@@ -39,11 +39,17 @@ if (typeof Sfjs === 'undefined' || typeof Sfjs.loadToolbar === 'undefined') {
         }
 
         if (navigator.clipboard) {
-            document.querySelectorAll('[data-clipboard-text]').forEach(function(element) {
-                removeClass(element, 'hidden');
-                element.addEventListener('click', function() {
-                    navigator.clipboard.writeText(element.getAttribute('data-clipboard-text'));
-                })
+            document.addEventListener('readystatechange', () => {
+                if (document.readyState !== 'complete') {
+                    return;
+                }
+
+                document.querySelectorAll('[data-clipboard-text]').forEach(function (element) {
+                    removeClass(element, 'hidden');
+                    element.addEventListener('click', function () {
+                        navigator.clipboard.writeText(element.getAttribute('data-clipboard-text'));
+                    })
+                });
             });
         }
 
diff --git a/src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php b/src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php
@@ -163,8 +163,53 @@ private function collectOnClient(TraceableHttpClient $client): array
             unset($traces[$i]['info']); // break PHP reference used by TraceableHttpClient
             $traces[$i]['info'] = $this->cloneVar($info);
             $traces[$i]['options'] = $this->cloneVar($trace['options']);
+            $traces[$i]['curlCommand'] = $this->getCurlCommand($trace);
         }
 
         return [$errorCount, $traces];
     }
+
+    private function getCurlCommand(array $trace): ?string
+    {
+        $debug = explode("\n", ($trace['info']['debug']));
+        $url = $trace['info']['url'];
+        $command = ['curl', '--compressed'];
+
+        $dataArg = null;
+
+        if ($json = $trace['options']['json'] ?? null) {
+            $dataArg = '--data '.escapeshellarg(json_encode($json, \JSON_PRETTY_PRINT));
+        } elseif ($body = $trace['options']['body'] ?? null) {
+            if (\is_string($body)) {
+                $dataArg = '--data '.escapeshellarg($body);
+            } elseif (\is_array($body)) {
+                foreach ($body as $key => $value) {
+                    $dataArg = '--data '.escapeshellarg("$key=$value");
+                }
+            } else {
+                return null;
+            }
+        }
+
+        foreach ($debug as $line) {
+            $line = str_replace("\r", '', $line);
+            if ('' === $line || preg_match('/^[*<]|(Host: )/', $line)) {
+                continue;
+            }
+
+            if (preg_match('/^> ([A-Z]+)/', $line, $match)) {
+                $command[] = sprintf('--request %s', $match[1]);
+                $command[] = sprintf('--url %s', escapeshellarg($url));
+                continue;
+            }
+
+            $command[] = '--header '.escapeshellarg($line);
+        }
+
+        if (null !== $dataArg) {
+            $command[] = $dataArg;
+        }
+
+        return implode(" \\\n  ", $command);
+    }
 }
diff --git a/src/Symfony/Component/HttpClient/Tests/DataCollector/HttpClientDataCollectorTest.php b/src/Symfony/Component/HttpClient/Tests/DataCollector/HttpClientDataCollectorTest.php
@@ -166,6 +166,49 @@ public function testItIsEmptyAfterReset()
         $this->assertEquals(0, $sut->getRequestCount());
     }
 
+    public function testItGeneratesCurlCommandsAsExpected()
+    {
+        $sut = new HttpClientDataCollector();
+        $sut->registerClient('http_client', $this->httpClientThatHasTracedRequests([
+                [
+                    'method' => 'GET',
+                    'url' => 'https://symfony.com/releases.json',
+                ],
+            ]));
+        $sut->collect(new Request(), new Response());
+        $collectedData = $sut->getClients();
+        self::assertCount(1, $collectedData['http_client']['traces']);
+        $curlCommand = $collectedData['http_client']['traces'][0]['curlCommand'];
+        self::assertEquals("curl \\
+  --compressed \\
+  --request GET \\
+  --url 'https://symfony.com/releases.json' \\
+  --header 'Accept: */*' \\
+  --header 'Accept-Encoding: gzip' \\
+  --header 'User-Agent: Symfony HttpClient/Native'", $curlCommand
+);
+    }
+
+    public function testItDoesNotGeneratesCurlCommandsForUnsupportedBodyType()
+    {
+        $sut = new HttpClientDataCollector();
+        $sut->registerClient('http_client', $this->httpClientThatHasTracedRequests([
+                [
+                    'method' => 'GET',
+                    'url' => 'https://symfony.com/releases.json',
+                    'options' => [
+                        'body' => static fn (int $size): string => '',
+                    ],
+                ],
+            ]));
+        $sut->collect(new Request(), new Response());
+        $collectedData = $sut->getClients();
+        self::assertCount(1, $collectedData['http_client']['traces']);
+        $curlCommand = $collectedData['http_client']['traces'][0]['curlCommand'];
+        self::assertNull($curlCommand
+);
+    }
+
     private function httpClientThatHasTracedRequests($tracedRequests): TraceableHttpClient
     {
         $httpClient = new TraceableHttpClient(new NativeHttpClient());
