Viewing file:  HttpClientDataCollector.php (7.94 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\HttpClient\DataCollector;
use Symfony\Component\HttpClient\HttpClientTrait;
use Symfony\Component\HttpClient\TraceableHttpClient;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\DataCollector\DataCollector;
use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
use Symfony\Component\VarDumper\Caster\ImgStub;
/**
* @author Jérémy Romey <jeremy@free-agent.fr>
*/
final class HttpClientDataCollector extends DataCollector implements LateDataCollectorInterface
{
use HttpClientTrait;
/**
* @var TraceableHttpClient[]
*/
private array $clients = [];
public function registerClient(string $name, TraceableHttpClient $client)
{
$this->clients[$name] = $client;
}
public function collect(Request $request, Response $response, \Throwable $exception = null)
{
$this->reset();
foreach ($this->clients as $name => $client) {
[$errorCount, $traces] = $this->collectOnClient($client);
$this->data['clients'][$name] = [
'traces' => $traces,
'error_count' => $errorCount,
];
$this->data['request_count'] += \count($traces);
$this->data['error_count'] += $errorCount;
}
}
public function lateCollect()
{
foreach ($this->clients as $client) {
$client->reset();
}
}
public function getClients(): array
{
return $this->data['clients'] ?? [];
}
public function getRequestCount(): int
{
return $this->data['request_count'] ?? 0;
}
public function getErrorCount(): int
{
return $this->data['error_count'] ?? 0;
}
public function getName(): string
{
return 'http_client';
}
public function reset()
{
$this->data = [
'clients' => [],
'request_count' => 0,
'error_count' => 0,
];
}
private function collectOnClient(TraceableHttpClient $client): array
{
$traces = $client->getTracedRequests();
$errorCount = 0;
$baseInfo = [
'response_headers' => 1,
'retry_count' => 1,
'redirect_count' => 1,
'redirect_url' => 1,
'user_data' => 1,
'error' => 1,
'url' => 1,
];
foreach ($traces as $i => $trace) {
if (400 <= ($trace['info']['http_code'] ?? 0)) {
++$errorCount;
}
$info = $trace['info'];
$traces[$i]['http_code'] = $info['http_code'] ?? 0;
unset($info['filetime'], $info['http_code'], $info['ssl_verify_result'], $info['content_type']);
if (($info['http_method'] ?? null) === $trace['method']) {
unset($info['http_method']);
}
if (($info['url'] ?? null) === $trace['url']) {
unset($info['url']);
}
foreach ($info as $k => $v) {
if (!$v || (is_numeric($v) && 0 > $v)) {
unset($info[$k]);
}
}
if (\is_string($content = $trace['content'])) {
$contentType = 'application/octet-stream';
foreach ($info['response_headers'] ?? [] as $h) {
if (0 === stripos($h, 'content-type: ')) {
$contentType = substr($h, \strlen('content-type: '));
break;
}
}
if (str_starts_with($contentType, 'image/') && class_exists(ImgStub::class)) {
$content = new ImgStub($content, $contentType, '');
} else {
$content = [$content];
}
$content = ['response_content' => $content];
} elseif (\is_array($content)) {
$content = ['response_json' => $content];
} else {
$content = [];
}
if (isset($info['retry_count'])) {
$content['retries'] = $info['previous_info'];
unset($info['previous_info']);
}
$debugInfo = array_diff_key($info, $baseInfo);
$info = ['info' => $debugInfo] + array_diff_key($info, $debugInfo) + $content;
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
{
if (!isset($trace['info']['debug'])) {
return null;
}
$url = $trace['info']['original_url'] ?? $trace['info']['url'] ?? $trace['url'];
$command = ['curl', '--compressed'];
if (isset($trace['options']['resolve'])) {
$port = parse_url($url, \PHP_URL_PORT) ?: (str_starts_with('http:', $url) ? 80 : 443);
foreach ($trace['options']['resolve'] as $host => $ip) {
if (null !== $ip) {
$command[] = '--resolve '.escapeshellarg("$host:$port:$ip");
}
}
}
$dataArg = [];
if ($json = $trace['options']['json'] ?? null) {
if (!$this->argMaxLengthIsSafe($payload = self::jsonEncode($json))) {
return null;
}
$dataArg[] = '--data '.escapeshellarg($payload);
} elseif ($body = $trace['options']['body'] ?? null) {
if (\is_string($body)) {
if (!$this->argMaxLengthIsSafe($body)) {
return null;
}
try {
$dataArg[] = '--data '.escapeshellarg($body);
} catch (\ValueError) {
return null;
}
} elseif (\is_array($body)) {
$body = explode('&', self::normalizeBody($body));
foreach ($body as $value) {
if (!$this->argMaxLengthIsSafe($payload = urldecode($value))) {
return null;
}
$dataArg[] = '--data '.escapeshellarg($payload);
}
} else {
return null;
}
}
$dataArg = empty($dataArg) ? null : implode(' ', $dataArg);
foreach (explode("\n", $trace['info']['debug']) as $line) {
$line = substr($line, 0, -1);
if (str_starts_with('< ', $line)) {
// End of the request, beginning of the response. Stop parsing.
break;
}
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);
}
/**
* Let's be defensive : we authorize only size of 8kio on Windows for escapeshellarg() argument to avoid a fatal error.
*
* @see https://github.com/php/php-src/blob/9458f5f2c8a8e3d6c65cc181747a5a75654b7c6e/ext/standard/exec.c#L397
*/
private function argMaxLengthIsSafe(string $payload): bool
{
return \strlen($payload) < ('\\' === \DIRECTORY_SEPARATOR ? 8100 : 256000);
}
}
|