-
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reduce size of var-dumper dump payload.
- Loading branch information
1 parent
fed0a63
commit 475c10c
Showing
11 changed files
with
483 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Modules\VarDumper\Application\Dump; | ||
|
||
interface BodyInterface extends \Stringable, \JsonSerializable | ||
{ | ||
public function getType(): string; | ||
|
||
public function getValue(): string; | ||
} |
10 changes: 10 additions & 0 deletions
10
app/modules/VarDumper/Application/Dump/DumpIdGeneratorInterface.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Modules\VarDumper\Application\Dump; | ||
|
||
interface DumpIdGeneratorInterface | ||
{ | ||
public function generate(): string; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Modules\VarDumper\Application\Dump; | ||
|
||
final readonly class HtmlBody implements BodyInterface | ||
{ | ||
private string $id; | ||
private string $html; | ||
|
||
public function __construct( | ||
string $value, | ||
) { | ||
$this->html = $value; | ||
\preg_match_all('/sf-dump-\d+/', $value, $matches); | ||
$this->id = $matches[0][0]; | ||
} | ||
|
||
public function getId(): string | ||
{ | ||
return $this->id; | ||
} | ||
|
||
public function getType(): string | ||
{ | ||
return 'html'; | ||
} | ||
|
||
public function getValue(): string | ||
{ | ||
return $this->html; | ||
} | ||
|
||
public function __toString(): string | ||
{ | ||
return $this->html; | ||
} | ||
|
||
public function jsonSerialize(): string | ||
{ | ||
return $this->__toString(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,281 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Modules\VarDumper\Application\Dump; | ||
|
||
use Symfony\Component\VarDumper\Cloner\Cursor; | ||
use Symfony\Component\VarDumper\Cloner\Data; | ||
use Symfony\Component\VarDumper\Dumper\AbstractDumper; | ||
use Symfony\Component\VarDumper\Dumper\CliDumper; | ||
|
||
final class HtmlDumper extends CliDumper | ||
{ | ||
/** @var callable|resource|string|null */ | ||
public static $defaultOutput = 'php://output'; | ||
|
||
protected string $dumpPrefix = '<pre class=sf-dump id=%s data-indent-pad="%s">'; | ||
protected string $dumpSuffix = '</pre><script>Sfdump(%s)</script>'; | ||
protected string $dumpId = 'sf-dump'; | ||
protected $colors = true; | ||
protected int $lastDepth = -1; | ||
|
||
private array $displayOptions = [ | ||
'maxDepth' => 1, | ||
'maxStringLength' => 160, | ||
'fileLinkFormat' => null, | ||
]; | ||
private array $extraDisplayOptions = []; | ||
|
||
public function __construct(DumpIdGeneratorInterface $generator) | ||
{ | ||
AbstractDumper::__construct(null, null, 0); | ||
$this->dumpId = $generator->generate(); | ||
$this->displayOptions['fileLinkFormat'] = \ini_get('xdebug.file_link_format') ?: get_cfg_var( | ||
'xdebug.file_link_format', | ||
); | ||
} | ||
|
||
public function setStyles(array $styles): void | ||
{ | ||
$this->styles = $styles + $this->styles; | ||
} | ||
|
||
/** | ||
* Configures display options. | ||
* | ||
* @param array $displayOptions A map of display options to customize the behavior | ||
* | ||
* @return void | ||
*/ | ||
public function setDisplayOptions(array $displayOptions) | ||
{ | ||
$this->displayOptions = $displayOptions + $this->displayOptions; | ||
} | ||
|
||
public function dump(Data $data, $output = null, array $extraDisplayOptions = []): ?string | ||
{ | ||
$this->extraDisplayOptions = $extraDisplayOptions; | ||
$result = parent::dump($data, $output); | ||
$this->dumpId = 'sf-dump-' . mt_rand(); | ||
|
||
return $result; | ||
} | ||
|
||
/** | ||
* @return void | ||
*/ | ||
public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut) | ||
{ | ||
if ('' === $str && isset($cursor->attr['img-data'], $cursor->attr['content-type'])) { | ||
$this->dumpKey($cursor); | ||
$this->line .= $this->style('default', $cursor->attr['img-size'] ?? '', []); | ||
$this->line .= $cursor->depth >= $this->displayOptions['maxDepth'] ? ' <samp class=sf-dump-compact>' : ' <samp class=sf-dump-expanded>'; | ||
$this->endValue($cursor); | ||
$this->line .= $this->indentPad; | ||
$this->line .= sprintf( | ||
'<img src="data:%s;base64,%s" /></samp>', | ||
$cursor->attr['content-type'], | ||
base64_encode($cursor->attr['img-data']), | ||
); | ||
$this->endValue($cursor); | ||
} else { | ||
parent::dumpString($cursor, $str, $bin, $cut); | ||
} | ||
} | ||
|
||
/** | ||
* @return void | ||
*/ | ||
public function enterHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild) | ||
{ | ||
if (Cursor::HASH_OBJECT === $type) { | ||
$cursor->attr['depth'] = $cursor->depth; | ||
} | ||
parent::enterHash($cursor, $type, $class, false); | ||
|
||
if ($cursor->skipChildren || $cursor->depth >= $this->displayOptions['maxDepth']) { | ||
$cursor->skipChildren = false; | ||
$eol = ' class=sf-dump-compact>'; | ||
} else { | ||
$this->expandNextHash = false; | ||
$eol = ' class=sf-dump-expanded>'; | ||
} | ||
|
||
if ($hasChild) { | ||
$this->line .= '<samp data-depth=' . ($cursor->depth + 1); | ||
if ($cursor->refIndex) { | ||
$r = Cursor::HASH_OBJECT !== $type ? 1 - (Cursor::HASH_RESOURCE !== $type) : 2; | ||
$r .= $r && 0 < $cursor->softRefHandle ? $cursor->softRefHandle : $cursor->refIndex; | ||
|
||
$this->line .= sprintf(' id=%s-ref%s', $this->dumpId, $r); | ||
} | ||
$this->line .= $eol; | ||
$this->dumpLine($cursor->depth); | ||
} | ||
} | ||
|
||
/** | ||
* @return void | ||
*/ | ||
public function leaveHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild, int $cut) | ||
{ | ||
$this->dumpEllipsis($cursor, $hasChild, $cut); | ||
if ($hasChild) { | ||
$this->line .= '</samp>'; | ||
} | ||
parent::leaveHash($cursor, $type, $class, $hasChild, 0); | ||
} | ||
|
||
protected function style(string $style, string $value, array $attr = []): string | ||
{ | ||
if ('' === $value && ('label' !== $style || !isset($attr['file']) && !isset($attr['href']))) { | ||
return ''; | ||
} | ||
|
||
$v = esc($value); | ||
|
||
if ('ref' === $style) { | ||
if (empty($attr['count'])) { | ||
return sprintf('<a class=sf-dump-ref>%s</a>', $v); | ||
} | ||
$r = ('#' !== $v[0] ? 1 - ('@' !== $v[0]) : 2) . substr($value, 1); | ||
|
||
return sprintf( | ||
'<a class=sf-dump-ref href=#%s-ref%s title="%d occurrences">%s</a>', | ||
$this->dumpId, | ||
$r, | ||
1 + $attr['count'], | ||
$v, | ||
); | ||
} | ||
|
||
if ('const' === $style && isset($attr['value'])) { | ||
$style .= sprintf( | ||
' title="%s"', | ||
esc(\is_scalar($attr['value']) ? $attr['value'] : json_encode($attr['value'])), | ||
); | ||
} elseif ('note' === $style && 0 < ($attr['depth'] ?? 0) && false !== $c = strrpos($value, '\\')) { | ||
$style .= ' title=""'; | ||
$attr += [ | ||
'ellipsis' => \strlen($value) - $c, | ||
'ellipsis-type' => 'note', | ||
'ellipsis-tail' => 1, | ||
]; | ||
} | ||
|
||
if (isset($attr['ellipsis'])) { | ||
$class = 'sf-dump-ellipsis'; | ||
if (isset($attr['ellipsis-type'])) { | ||
$class = sprintf('"%s sf-dump-ellipsis-%s"', $class, $attr['ellipsis-type']); | ||
} | ||
$label = esc(substr($value, -$attr['ellipsis'])); | ||
$style = str_replace(' title="', " title=\"$v\n", $style); | ||
$v = sprintf('<span class=%s>%s</span>', $class, substr($v, 0, -\strlen($label))); | ||
|
||
if (!empty($attr['ellipsis-tail'])) { | ||
$tail = \strlen(esc(substr($value, -$attr['ellipsis'], $attr['ellipsis-tail']))); | ||
$v .= sprintf('<span class=%s>%s</span>%s', $class, substr($label, 0, $tail), substr($label, $tail)); | ||
} else { | ||
$v .= $label; | ||
} | ||
} | ||
|
||
$map = static::$controlCharsMap; | ||
$v = "<span class=sf-dump-{$style}>" . preg_replace_callback(static::$controlCharsRx, function ($c) use ($map) { | ||
$s = $b = '<span class="sf-dump-default'; | ||
$c = $c[$i = 0]; | ||
if ($ns = "\r" === $c[$i] || "\n" === $c[$i]) { | ||
$s .= ' sf-dump-ns'; | ||
} | ||
$s .= '">'; | ||
do { | ||
if (("\r" === $c[$i] || "\n" === $c[$i]) !== $ns) { | ||
$s .= '</span>' . $b; | ||
if ($ns = !$ns) { | ||
$s .= ' sf-dump-ns'; | ||
} | ||
$s .= '">'; | ||
} | ||
|
||
$s .= $map[$c[$i]] ?? sprintf('\x%02X', \ord($c[$i])); | ||
} while (isset($c[++$i])); | ||
|
||
return $s . '</span>'; | ||
}, $v) . '</span>'; | ||
|
||
if (!($attr['binary'] ?? false)) { | ||
$v = preg_replace_callback(static::$unicodeCharsRx, function ($c) { | ||
return '<span class=sf-dump-default>\u{' . strtoupper(dechex(mb_ord($c[0]))) . '}</span>'; | ||
}, $v); | ||
} | ||
|
||
if (isset($attr['file']) && $href = $this->getSourceLink($attr['file'], $attr['line'] ?? 0)) { | ||
$attr['href'] = $href; | ||
} | ||
if (isset($attr['href'])) { | ||
if ('label' === $style) { | ||
$v .= '^'; | ||
} | ||
$target = isset($attr['file']) ? '' : ' target="_blank"'; | ||
$v = sprintf( | ||
'<a href="%s"%s rel="noopener noreferrer">%s</a>', | ||
esc($this->utf8Encode($attr['href'])), | ||
$target, | ||
$v, | ||
); | ||
} | ||
if (isset($attr['lang'])) { | ||
$v = sprintf('<code class="%s">%s</code>', esc($attr['lang']), $v); | ||
} | ||
if ('label' === $style) { | ||
$v .= ' '; | ||
} | ||
|
||
return $v; | ||
} | ||
|
||
/** | ||
* @return void | ||
*/ | ||
protected function dumpLine(int $depth, bool $endOfValue = false) | ||
{ | ||
if (-1 === $this->lastDepth) { | ||
$this->line = sprintf($this->dumpPrefix, $this->dumpId, $this->indentPad) . $this->line; | ||
} | ||
|
||
if (-1 === $depth) { | ||
$args = ['"' . $this->dumpId . '"']; | ||
if ($this->extraDisplayOptions) { | ||
$args[] = json_encode($this->extraDisplayOptions, \JSON_FORCE_OBJECT); | ||
} | ||
// Replace is for BC | ||
$this->line .= sprintf(str_replace('"%s"', '%s', $this->dumpSuffix), implode(', ', $args)); | ||
} | ||
$this->lastDepth = $depth; | ||
|
||
$this->line = mb_encode_numericentity($this->line, [0x80, 0x10FFFF, 0, 0x1FFFFF], 'UTF-8'); | ||
|
||
if (-1 === $depth) { | ||
AbstractDumper::dumpLine(0); | ||
} | ||
AbstractDumper::dumpLine($depth); | ||
} | ||
|
||
private function getSourceLink(string $file, int $line): string|false | ||
{ | ||
$options = $this->extraDisplayOptions + $this->displayOptions; | ||
|
||
if ($fmt = $options['fileLinkFormat']) { | ||
return \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : $fmt->format($file, $line); | ||
} | ||
|
||
return false; | ||
} | ||
} | ||
|
||
function esc(string $str): string | ||
{ | ||
return htmlspecialchars($str, \ENT_QUOTES, 'UTF-8'); | ||
} | ||
|
13 changes: 13 additions & 0 deletions
13
app/modules/VarDumper/Application/Dump/MtRandDumpIdGenerator.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Modules\VarDumper\Application\Dump; | ||
|
||
final readonly class MtRandDumpIdGenerator implements DumpIdGeneratorInterface | ||
{ | ||
public function generate(): string | ||
{ | ||
return 'sf-dump-' . \mt_rand(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Modules\VarDumper\Application\Dump; | ||
|
||
final readonly class PrimitiveBody implements BodyInterface | ||
{ | ||
public function __construct( | ||
private string $type, | ||
private string $value, | ||
) { | ||
} | ||
|
||
public function getType(): string | ||
{ | ||
return $this->type; | ||
} | ||
|
||
public function getValue(): string | ||
{ | ||
return $this->value; | ||
} | ||
|
||
public function __toString(): string | ||
{ | ||
return $this->value; | ||
} | ||
|
||
public function jsonSerialize(): string | ||
{ | ||
return $this->__toString(); | ||
} | ||
} |
Oops, something went wrong.