[VarDumper] New env var to select the dump format #25125

dunglas · 2017-11-22T21:49:53Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	symfony/symfony-docs#10275

This PR introduces a new environment variable that can be used to force dump() to generate HTML even in CLI, or CLI even in a web context.
It allows to dump large objects when debugging a command, to open the resulting HTML in a browser, and to benefit of the nice JS UI (folded by default, search engine...).

Example usage:

VAR_DUMPER_FORMAT=html vendor/bin/behat > tmp.html; open -a firefox tmp.html
VAR_DUMPER_FORMAT=cli vendor/bin/behat > tmp.txt

ogizanagi · 2017-11-23T07:18:04Z

You might have missed #23831 :)
Unless you think it's another convenient approach. But it mixes real output & dumps in CLI and #23831 answers other user-cases.

dunglas · 2017-11-23T07:28:12Z

Indeed I've missed #23831 and it looks very interesting but I don't think that it addresses the same use case.
This patch is intended for quick & dirty debugging, for instance for a command written in PHP not using Symfony at all, you just install var_dumper (or have it installed) globally and you can still get the HTML output by just prepending an env var.

it mixes real output

Yes it's intended (just as do the CLI formatter by default).

ogizanagi · 2017-11-23T08:35:20Z

It's always quick & dirty ;) Just trying to make it a bit more clean.
With #23831, you won't even need an env var. Just run your command and if the server is up it'll collect dumps.
Next steps for #23831 could be to provide a simple ServerDumper::register(string $host = null, bool $swallow = true) static method executing the manual wiring described in the PR description with default values so you just have to add one line to your app, and ship the symfony/var-dumper component with a simple script allowing to start the server.

But of course I also understand how a simple env var to prepend is convenient for punctual dumps, so I'm not against this feature at all.

theofidry · 2017-11-23T12:38:50Z

@dunglas I also think you can replace /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome tmp.html by open tmp.html which will use the default browser ;)

dunglas · 2017-11-23T13:30:31Z

@theofidry unfortunately I can't because my default browser is Firefox, and Firefox is very bad at reusing an existing instance (it usually ends up by an error).

ogizanagi · 2017-11-23T13:31:55Z

open -a "Google Chrome" tmp.html

? 😄

dunglas · 2017-11-23T13:38:19Z

@ogizanagi great thanks! This one works with Firefox too (but why, it's another topic).

dunglas · 2017-12-31T09:23:12Z

Are you ok to merge this one @symfony/deciders? I miss it almost every day 😄.

nicolas-grekas · 2018-03-22T16:18:20Z

src/Symfony/Component/VarDumper/VarDumper.php

@@ -29,7 +29,7 @@ public static function dump($var)
    {
        if (null === self::$handler) {
            $cloner = new VarCloner();
-            $dumper = in_array(PHP_SAPI, array('cli', 'phpdbg')) ? new CliDumper() : new HtmlDumper();
+            $dumper = in_array(PHP_SAPI, array('cli', 'phpdbg')) && !($_SERVER['VAR_DUMPER_HTML'] ?? false) ? new CliDumper() : new HtmlDumper();


it could work both ways: forcing CLI instead of HTML, for API responses

lyrixx · 2018-03-22T17:44:09Z

Note: it's related to #23442

dunglas · 2018-06-30T07:43:08Z

PR tweaked to be able to select any format, env var renamed to VAR_DUMPER_FORMAT.

lyrixx · 2018-07-02T09:51:08Z

I thinks I only works when using the dumper directly.
In a symfony app, the dumper is configured in the bundle.
IMHO this line should be updated too:

symfony/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php

Line 207 in 9efa555

    
           if (!\in_array(PHP_SAPI, array('cli', 'phpdbg'), true) && stripos($h[$i], 'html')) {

dunglas · 2018-07-13T11:46:27Z

@lyrixx done

fabpot · 2018-09-04T09:15:03Z

Thank you @dunglas.

…glas) This PR was squashed before being merged into the 4.2-dev branch (closes #25125). Discussion ---------- [VarDumper] New env var to select the dump format | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes  | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | todo This PR introduces a new environment variable that can be used to force `dump()` to generate HTML even in CLI, or CLI even in a web context. It allows to dump large objects when debugging a command, to open the resulting HTML in a browser, and to benefit of the nice JS UI (folded by default, search engine...). Example usage: VAR_DUMPER_FORMAT=html vendor/bin/behat > tmp.html; open -a firefox tmp.html VAR_DUMPER_FORMAT=cli vendor/bin/behat > tmp.txt Commits ------- 536125a [VarDumper] New env var to select the dump format

javiereguiluz · 2018-09-07T14:04:40Z

I've created symfony/symfony-docs#10275 to document this new feature. But please, don't forget to create a PR, or at least an issue, for every new feature. Thanks!

carsonbot added Status: Needs Review VarDumper Feature labels Nov 22, 2017

nicolas-grekas added this to the 4.1 milestone Nov 23, 2017

dunglas force-pushed the dump-html-cli branch from e338850 to fde9b7b Compare February 13, 2018 14:41

nicolas-grekas reviewed Mar 22, 2018

View reviewed changes

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

dunglas force-pushed the dump-html-cli branch from fde9b7b to 455a673 Compare June 30, 2018 07:40

dunglas changed the title ~~[VarDumper] Allow to dump HTML from the CLI~~ [VarDumper] New env var to select the dump format Jun 30, 2018

dunglas force-pushed the dump-html-cli branch from 455a673 to 3b7a695 Compare July 3, 2018 20:43

fabpot approved these changes Sep 4, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 4, 2018

[VarDumper] New env var to select the dump format

536125a

fabpot force-pushed the dump-html-cli branch from 3b7a695 to 536125a Compare September 4, 2018 09:11

fabpot merged commit 536125a into symfony:master Sep 4, 2018

javiereguiluz mentioned this pull request Sep 7, 2018

[VarDumper] New env var to select the dump format symfony/symfony-docs#10274

Closed

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

xabbuh mentioned this pull request Jun 23, 2019

[VarDumper] Dump in php log #30460

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VarDumper] New env var to select the dump format #25125

[VarDumper] New env var to select the dump format #25125

dunglas commented Nov 22, 2017 •

edited

Loading

ogizanagi commented Nov 23, 2017

dunglas commented Nov 23, 2017 •

edited

Loading

ogizanagi commented Nov 23, 2017 •

edited

Loading

theofidry commented Nov 23, 2017

dunglas commented Nov 23, 2017 •

edited

Loading

ogizanagi commented Nov 23, 2017 •

edited

Loading

dunglas commented Nov 23, 2017

dunglas commented Dec 31, 2017

nicolas-grekas Mar 22, 2018

dunglas Jun 30, 2018

lyrixx commented Mar 22, 2018

dunglas commented Jun 30, 2018

lyrixx commented Jul 2, 2018

dunglas commented Jul 13, 2018

fabpot commented Sep 4, 2018

javiereguiluz commented Sep 7, 2018

[VarDumper] New env var to select the dump format #25125

[VarDumper] New env var to select the dump format #25125

Conversation

dunglas commented Nov 22, 2017 • edited Loading

ogizanagi commented Nov 23, 2017

dunglas commented Nov 23, 2017 • edited Loading

ogizanagi commented Nov 23, 2017 • edited Loading

theofidry commented Nov 23, 2017

dunglas commented Nov 23, 2017 • edited Loading

ogizanagi commented Nov 23, 2017 • edited Loading

dunglas commented Nov 23, 2017

dunglas commented Dec 31, 2017

nicolas-grekas Mar 22, 2018

Choose a reason for hiding this comment

dunglas Jun 30, 2018

Choose a reason for hiding this comment

lyrixx commented Mar 22, 2018

dunglas commented Jun 30, 2018

lyrixx commented Jul 2, 2018

dunglas commented Jul 13, 2018

fabpot commented Sep 4, 2018

javiereguiluz commented Sep 7, 2018

dunglas commented Nov 22, 2017 •

edited

Loading

dunglas commented Nov 23, 2017 •

edited

Loading

ogizanagi commented Nov 23, 2017 •

edited

Loading

dunglas commented Nov 23, 2017 •

edited

Loading

ogizanagi commented Nov 23, 2017 •

edited

Loading