Integration with the profiler

[vincentchalamon]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	in progress
Fixed tickets	symfony/mercure#1

Menu icon

Panel

TODO

• Implement MercureDataCollector
• Declare services through extension
• Add collector view
• Update symfony/mercure dependency (waiting for Add TraceablePublisher mercure#15)
• Update recipe about enable_profiler configuration option: Add enable_profiler option on mercure-bundle recipes#667
• Update documentation: Update documentation for MercureBundle: add enable_profiler option symfony-docs#12598

[dunglas]

Maybe that a map hubUrl[publisher] would be better and less error prone? Or the hub URL could be injected in TraceablePublisher's constructor and then retrieved using a getter?

[vincentchalamon]

I didn't want to inject the hub Url in the TraceablePublisher because the url is only required by the WebProfiler view on this bundle, not on the lib.

[vincentchalamon]

Otherwise, we could remove the $hubUrls argument, as it's only used to display the hub url on the profiler. I don't find it so useful cause most of the time the user already know the hub url cause he configured it ^^

[dunglas]

Actually it could be useful for other use cases too to be able to access the hub URL. IMHO it fits well in the lib too.

[dunglas]

This definition should be in the XML file and then removed here if $config['enable_profiler'] is false. Doing this allows to have autocompletion in PHPStorm and the like.

[vincentchalamon]

To do so, I'll need to tag the publisher services and handle them through a CompilerPass to inject them in the MercureDataCollector, and manage the hub url too...

Isn't there an easier way to handle that?

[dunglas]

Suggested change

	$container->register('data_collector.mercure', MercureDataCollector::class)
	$container->register('mercure.data_collector', MercureDataCollector::class)

[vincentchalamon]

data_collector.<name> was to respect the same naming convention used by symfony/framework-bundle about DataCollectors: https://github.com/symfony/framework-bundle/blob/master/Resources/config/collectors.xml

[dunglas]

Yes because it's in FWBundle, but here as we aren't in FWBundle, we shouldn't "pollute" the global namespace and put every services under the mercure. key.