Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #23831 [VarDumper] Introduce a new way to collect dumps throu…
…gh a server dumper (ogizanagi, nicolas-grekas) This PR was merged into the 4.1-dev branch. Discussion ---------- [VarDumper] Introduce a new way to collect dumps through a server dumper | Q | A | ------------- | --- | Branch? | 4.1 <!-- see comment below --> | Bug fix? | no | New feature? | yes <!-- don't forget updating src/**/CHANGELOG.md files --> | BC breaks? | no | Deprecations? | no <!-- don't forget updating UPGRADE-*.md files --> | Tests pass? | yes | Fixed tickets | #22987 <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | todo <!--highly recommended for new features--> Could also be interesting as alternate solution for #23442. Inspired by the [`ServerLogHandler`](#21080) and @nicolas-grekas's [comment](#22987 (comment)) in #22987. --- ## Description This PR introduces a new `server:dump` command available in the `VarDumper` component. Conjointly with a new `ServerDumper` data dumper, it allows to send serialized `Data` clones to a single centralized server, in charge of dumping them on CLI output, or in an file in HTML format. ## Showcase ### HTTP calls For instance, when working on an API and dumping something, you might end up with a mix of your response and the CLI dumped version of the data you asked: ```php class HelloController extends AbstractController { /** * @route("/hello") */ public function hello(Request $request, UserInterface $user) { dump($request->attributes, $user); return JsonResponse::create([ 'status' => 'OK', 'message' => "Hello {$user->getUsername()}" ]); } } ``` <img width="732" alt="screenshot 2017-08-08 a 16 44 24" src="https://user-images.githubusercontent.com/2211145/29077731-0b2152d6-7c59-11e7-99dd-2d060a906d48.PNG"> You might even get the HTML dump version [under some conditions](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php#L146-L157). Dumping to a server allows collecting dumps in a separate place: <!---->  ~⚠️ By swallowing the previous dumpers output, the dump data collector is not active when running the dump server. Disable swallowing if you want both.~ ➜ Dumps are still collected in the profiler thanks to f24712e ### CLI calls The best probably is (to me) that you can also debug CLI applications...  <!----> ...and get HTML formatted dumps:  <!----> <!----> hence, benefit from all the features of this format (collapse, search, ...) ### HTML output at a glance <img width="831" alt="screenshot 2017-08-11 a 19 28 25" src="https://user-images.githubusercontent.com/2211145/29225513-eae349f2-7ece-11e7-9861-8cda9e80ba7f.PNG"> The HTML output benefits from all the `HtmlDumper` features and contains extra informations about the context (sources, requests, command line, ...). It doesn't aim to replace the profiler for HTTP calls with the framework, but is really handy for CLI apps or by wiring it in your own web app, out of the framework usage. ### CLI output at a glance <img width="829" alt="screenshot 2017-08-11 a 19 52 57" src="https://user-images.githubusercontent.com/2211145/29225482-c24afe18-7ece-11e7-8e83-d019b0d8303e.PNG"> ## Usage within the framework ### Config For instance, in your `config_dev.yml`: ```yml #config_dev.yml debug: server_dump: true ``` or in your `config.yml`: ```yml #config.yml debug: server_dump: '%kernel.debug%' ``` ~~The configuration also allows to set a `host` option, but there is already a sensible default value (`tcp://0.0.0.0:9912`) so you don't have to deal with it.~~ Since b002175, in case you want to change the default host value used, simply use the `VAR_DUMPER_SERVER` env var. When the server is running, all dumps are collected by the server and previous dumpers ones are "swallowed" ~~by default. If you want both to collect dumps on the server AND keep previous dumpers on regular outputs, you can disable swallowing:~~ <!-- ```yml debug: server_dump: swallow: false ``` --> When the server isn't running or in case of failure to send the data clones to the server, the server dumper will delegates to the configured wrapped dumper, so dumps are displayed and collected as usual. ### Running the server ```bash bin/console server:dump [--format=cli|html] ``` #### Options - ~~The `output` option defaults to `null` which will display dumps on CLI. It accepts a file path in which dumps will be collected in HTML format.~~ - The `format` option allows to switch format to use. For instance, use the `html` format and redirect the output to a file in order to open it in your browser and inspect dumps in HTML format. - ~~The default `host` value is the same as the one configured under the `debug.server_dump.host` config option, so you don't have to deal with it in most cases.~~ Since b002175, in case you want to change the default host value used, simply use the `VAR_DUMPER_SERVER` env var: ```bash VAR_DUMPER_SERVER=0.0.0.0:9204 bin/console server:dump ``` ## Manual wiring If you want to wire it yourself in your own project or using it to inspect dumps as html before the kernel is even boot for instance: ```php $host = 'tcp://0.0.0.0:9912'; // use null to read from the VAR_DUMPER_SERVER env var $cloner = new VarCloner(); $dumper = new ServerDumper($host, new CliDumper()); VarDumper::setHandler(function ($var) use ($dumper, $cloner) { $dumper->dump($cloner->cloneVar($var)); }); ``` ## Create your own server app The component already provides a default server app by means of the `ServerDumpCommand`, but you could also build your own by using the `DumpServer`: ```php $host = 'tcp://0.0.0.0:9912'; // use null to read from the VAR_DUMPER_SERVER env var $server = new DumpServer($host); $server->start(); $server->listen(function (Data $data, array $context, $clientId) { // do something }); ``` Commits ------- 138dad6 [VarDumper] Some tweaks after Nicolas' commit & ServerDumperPlaceholderCommand 088c52e [VarDumper] Review config to use debug.dump_destination & tweak data collector 3db1404 [VarDumper] Introduce a new way to collect dumps through a server dumper
- Loading branch information
--){kind=link}
--){kind=link}
--){kind=link}
--){kind=link}
