Skip to content

Commit f65c418

Browse files
fabpotfabpot
committed
feature #221 Add configuration for new HttpCodeActivationStrategy (simshaun, fabpot)
This PR was merged into the 3.x-dev branch. Discussion ---------- Add configuration for new HttpCodeActivationStrategy Dependent upon symfony/symfony#23707 This PR introduces configuration to integrate a new `HttpCodeActivationStrategy`, offering an easy way to ignore specific HTTP status codes. Commits ------- 30a70a2 tweaked code 61a78a6 Add configuration for new HttpCodeActivationStrategy
2 parents 23a92d4 + 30a70a2 commit f65c418

File tree

4 files changed

+104
-0
lines changed

4 files changed

+104
-0
lines changed

‎DependencyInjection/Configuration.php‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
* - handler: the wrapped handler's name
9090
* - [action_level|activation_strategy]: minimum level or service id to activate the handler, defaults to WARNING
9191
* - [excluded_404s]: if set, the strategy will be changed to one that excludes 404s coming from URLs matching any of those patterns
92+
* - [excluded_http_codes]: if set, the strategy will be changed to one that excludes specific HTTP codes (requires Symfony Monolog bridge 4.1+)
9293
* - [buffer_size]: defaults to 0 (unlimited)
9394
* - [stop_buffering]: bool to disable buffering once the handler has been activated, defaults to true
9495
* - [passthru_level]: level name or int value for messages to always flush, disabled by default
@@ -316,6 +317,7 @@ public function getConfigTreeBuilder()
316317
->prototype('array')
317318
->fixXmlConfig('member')
318319
->fixXmlConfig('excluded_404')
320+
->fixXmlConfig('excluded_http_code')
319321
->fixXmlConfig('tag')
320322
->fixXmlConfig('accepted_level')
321323
->canBeUnset()
@@ -363,6 +365,40 @@ public function getConfigTreeBuilder()
363365
->canBeUnset()
364366
->prototype('scalar')->end()
365367
->end()
368+
->arrayNode('excluded_http_codes') // fingers_crossed
369+
->canBeUnset()
370+
->beforeNormalization()
371+
->always(function ($values) {
372+
return array_map(function ($value) {
373+
/*
374+
* Allows YAML:
375+
* excluded_http_codes: [403, 404, { 400: ['^/foo', '^/bar'] }]
376+
*
377+
* and XML:
378+
* <monolog:excluded-http-code code="403">
379+
* <monolog:url>^/foo</monolog:url>
380+
* <monolog:url>^/bar</monolog:url>
381+
* </monolog:excluded-http-code>
382+
* <monolog:excluded-http-code code="404" />
383+
*/
384+
385+
if (is_array($value)) {
386+
return isset($value['code']) ? $value : array('code' => key($value), 'urls' => current($value));
387+
}
388+
389+
return array('code' => $value, 'urls' => array());
390+
}, $values);
391+
})
392+
->end()
393+
->prototype('array')
394+
->children()
395+
->scalarNode('code')->end()
396+
->arrayNode('urls')
397+
->prototype('scalar')->end()
398+
->end()
399+
->end()
400+
->end()
401+
->end()
366402
->arrayNode('accepted_levels') // filter
367403
->canBeUnset()
368404
->prototype('scalar')->end()
@@ -658,6 +694,14 @@ public function getConfigTreeBuilder()
658694
->ifTrue(function ($v) { return 'fingers_crossed' === $v['type'] && !empty($v['excluded_404s']) && !empty($v['activation_strategy']); })
659695
->thenInvalid('You can not use excluded_404s together with a custom activation_strategy in a FingersCrossedHandler')
660696
->end()
697+
->validate()
698+
->ifTrue(function ($v) { return 'fingers_crossed' === $v['type'] && !empty($v['excluded_http_codes']) && !empty($v['activation_strategy']); })
699+
->thenInvalid('You can not use excluded_http_codes together with a custom activation_strategy in a FingersCrossedHandler')
700+
->end()
701+
->validate()
702+
->ifTrue(function ($v) { return 'fingers_crossed' === $v['type'] && !empty($v['excluded_http_codes']) && !empty($v['excluded_404s']); })
703+
->thenInvalid('You can not use excluded_http_codes together with excluded_404s in a FingersCrossedHandler')
704+
->end()
661705
->validate()
662706
->ifTrue(function ($v) { return 'filter' === $v['type'] && "DEBUG" !== $v['min_level'] && !empty($v['accepted_levels']); })
663707
->thenInvalid('You can not use min_level together with accepted_levels in a FilterHandler')

‎DependencyInjection/MonologExtension.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,17 @@ private function buildHandler(ContainerBuilder $container, $name, array $handler
324324
));
325325
$container->setDefinition($handlerId.'.not_found_strategy', $activationDef);
326326
$activation = new Reference($handlerId.'.not_found_strategy');
327+
} elseif (!empty($handler['excluded_http_codes'])) {
328+
if (!class_exists('Symfony\Bridge\Monolog\Handler\FingersCrossed\HttpCodeActivationStrategy')) {
329+
throw new \LogicException('"excluded_http_codes" cannot be used as your version of Monolog bridge does not support it.');
330+
}
331+
$activationDef = new Definition('Symfony\Bridge\Monolog\Handler\FingersCrossed\HttpCodeActivationStrategy', array(
332+
new Reference('request_stack'),
333+
$handler['excluded_http_codes'],
334+
$handler['action_level']
335+
));
336+
$container->setDefinition($handlerId.'.http_code_strategy', $activationDef);
337+
$activation = new Reference($handlerId.'.http_code_strategy');
327338
} else {
328339
$activation = $handler['action_level'];
329340
}

‎Resources/config/schema/monolog-1.0.xsd‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
<xsd:element name="elasticsearch" type="elasticsearch" minOccurs="0" maxOccurs="1" />
2525
<xsd:element name="config" type="xsd:anyType" minOccurs="0" maxOccurs="1" />
2626
<xsd:element name="excluded-404" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
27+
<xsd:element name="excluded-http-code" type="excluded-http-code" minOccurs="0" maxOccurs="unbounded" />
2728
<xsd:element name="tag" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
2829
<xsd:element name="accepted-level" type="level" minOccurs="0" maxOccurs="unbounded" />
2930
<xsd:element name="to-email" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
@@ -163,4 +164,11 @@
163164
<xsd:attribute name="user" type="xsd:string" />
164165
<xsd:attribute name="password" type="xsd:string" />
165166
</xsd:complexType>
167+
168+
<xsd:complexType name="excluded-http-code">
169+
<xsd:choice minOccurs="0" maxOccurs="unbounded">
170+
<xsd:element name="url" type="xsd:string" />
171+
</xsd:choice>
172+
<xsd:attribute name="code" type="xsd:integer" />
173+
</xsd:complexType>
166174
</xsd:schema>

‎Tests/DependencyInjection/MonologExtensionTest.php‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,47 @@ public function testFingersCrossedHandlerWhenExcluded404sAreSpecified()
383383
$this->assertDICConstructorArguments($handler, array(new Reference('monolog.handler.nested'), new Reference('monolog.handler.main.not_found_strategy'), 0, true, true, null));
384384
}
385385

386+
public function testFingersCrossedHandlerWhenExcludedHttpCodesAreSpecified()
387+
{
388+
if (!class_exists('Symfony\Bridge\Monolog\Handler\FingersCrossed\HttpCodeActivationStrategy')) {
389+
$this->markTestSkipped('Symfony Monolog 4.1+ is needed.');
390+
}
391+
392+
$container = $this->getContainer(array(array('handlers' => array(
393+
'main' => array(
394+
'type' => 'fingers_crossed',
395+
'handler' => 'nested',
396+
'excluded_http_codes' => array(403, 404, array(405 => array('^/foo', '^/bar')))
397+
),
398+
'nested' => array('type' => 'stream', 'path' => '/tmp/symfony.log')
399+
))));
400+
401+
$this->assertTrue($container->hasDefinition('monolog.logger'));
402+
$this->assertTrue($container->hasDefinition('monolog.handler.main'));
403+
$this->assertTrue($container->hasDefinition('monolog.handler.nested'));
404+
$this->assertTrue($container->hasDefinition('monolog.handler.main.http_code_strategy'));
405+
406+
$logger = $container->getDefinition('monolog.logger');
407+
$this->assertDICDefinitionMethodCallAt(0, $logger, 'useMicrosecondTimestamps', array('%monolog.use_microseconds%'));
408+
$this->assertDICDefinitionMethodCallAt(1, $logger, 'pushHandler', array(new Reference('monolog.handler.main')));
409+
410+
$strategy = $container->getDefinition('monolog.handler.main.http_code_strategy');
411+
$this->assertDICDefinitionClass($strategy, 'Symfony\Bridge\Monolog\Handler\FingersCrossed\HttpCodeActivationStrategy');
412+
$this->assertDICConstructorArguments($strategy, array(
413+
new Reference('request_stack'),
414+
array(
415+
array('code' => 403, 'urls' => array()),
416+
array('code' => 404, 'urls' => array()),
417+
array('code' => 405, 'urls' => array('^/foo', '^/bar'))
418+
),
419+
\Monolog\Logger::WARNING
420+
));
421+
422+
$handler = $container->getDefinition('monolog.handler.main');
423+
$this->assertDICDefinitionClass($handler, 'Monolog\Handler\FingersCrossedHandler');
424+
$this->assertDICConstructorArguments($handler, array(new Reference('monolog.handler.nested'), new Reference('monolog.handler.main.http_code_strategy'), 0, true, true, null));
425+
}
426+
386427
protected function getContainer(array $config = array(), array $thirdPartyDefinitions = array())
387428
{
388429
$container = new ContainerBuilder();

0 commit comments

Comments
 (0)