Optional debug logging

[4c0n]

Finding out what is going wrong in prod environments can be tricky sometimes.
This PR allows an optional logger to be passed which enables a debug log.

Now finding out what's happening is a breeze.

[rijnhard]

Seriously the amount of hours I'm spending on debugging this... can this please be merged?

[Seldaek]

Thanks - makes sense. I'd appreciate if anyone has time to send a README PR to add an example of how this can be configured to get logging enable though

[NikoGrano]

I can see this being a really useful feature and just found it out via changelog. However, when something ain't documented, nobody is using it.

Currently, I am "reverse engineering" this feature to get it working...

@4c0n Would you mind to share us how you intended this feature to be used?

[4c0n]

I can see this being a really useful feature and just found it out via changelog. However, when something ain't documented, nobody is using it.

Currently, I am "reverse engineering" this feature to get it working...

@4c0n Would you mind to share us how you intended this feature to be used?

It's really easy, you override the service of the bundle and have your logger service injected.

[NikoGrano]

This is the approach I did, however, it is vulnerable to any BC changes. A better approach would be having the option to set logger in the configuration of the bundle. I totally understand if you are lacking time to implement it.

When possible, would you mind still documenting this?

In addition to this, adding logging also here, wouldn't hurt. For example, I had a case where one of the required headers wasn't allowed.

NelmioCorsBundle/EventListener/CorsListener.php

Lines 248 to 252 in b111f4b

	if (!in_array($header, $options['allow_headers'], true)) {
	$sanitizedMessage = htmlentities('Unauthorized header '.$header, ENT_QUOTES, 'UTF-8');
	$response->setStatusCode(400);
	$response->setContent($sanitizedMessage);
	break;

[4c0n]

This is the approach I did, however, it is vulnerable to any BC changes. A better approach would be having the option to set logger in the configuration of the bundle. I totally understand if you are lacking time to implement it.

When possible, would you mind still documenting this?

In addition to this, adding logging also here, wouldn't hurt. For example, I had a case where one of the required headers wasn't allowed.

NelmioCorsBundle/EventListener/CorsListener.php

Lines 248 to 252 in b111f4b

	if (!in_array($header, $options['allow_headers'], true)) {
	$sanitizedMessage = htmlentities('Unauthorized header '.$header, ENT_QUOTES, 'UTF-8');
	$response->setStatusCode(400);
	$response->setContent($sanitizedMessage);
	break;

BC changes should be in new major versions only, in which case you should review if your setup is compatible with the new version regardless.
I don't use this bundle anymore and I would suggest that you contribute the changes you envision yourself. I contributed this, because for me these changes were sufficient to solve the issues I was facing, however I had to use a fork and go through a lot more effort than I would have wished to find out what exactly was happening.
Mind you it took a really long time before this was merged and I have lost interest in the meantime.

[Seldaek]

See #197 for docs for now.. But if anyone wants to improve this with docs or ideally a config option to enable logging that'd be great.