Use composition instead of inheritance in NotFoundActivationStrategy

pvgnd · pvgnd · commit 886bc80955e0 · 2020-03-29T11:39:45.000+02:00
diff --git a/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/NotFoundActivationStrategy.php b/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/NotFoundActivationStrategy.php
@@ -15,11 +15,15 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+trigger_deprecation('symfony/monolog-bridge', '5.1', 'The "%s" class is deprecated, use "%s" instead.', NotFoundActivationStrategy::class, NotFoundActivationStrategyDecorator::class);
+
 /**
  * Activation strategy that ignores 404s for certain URLs.
  *
  * @author Jordi Boggiano <j.boggiano@seld.be>
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 5.1, Symfony\Bridge\Monolog\Handler\FingersCrossed\NotFoundActivationStrategyDecorator instead.
  */
 class NotFoundActivationStrategy extends ErrorLevelActivationStrategy
 {
diff --git a/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/NotFoundActivationStrategyDecorator.php b/src/Symfony/Bridge/Monolog/Handler/FingersCrossed/NotFoundActivationStrategyDecorator.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Handler\FingersCrossed;
+
+use Monolog\Handler\FingersCrossed\ActivationStrategyInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+
+/**
+ * Activation strategy that ignores 404s for certain URLs.
+ *
+ * @author Jordi Boggiano <j.boggiano@seld.be>
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Pierrick Vignand <pierrick.vignand@gmail.com>
+ */
+final class NotFoundActivationStrategyDecorator implements ActivationStrategyInterface
+{
+    private $inner;
+    private $blacklist;
+    private $requestStack;
+
+    public function __construct(ActivationStrategyInterface $inner, RequestStack $requestStack, array $excludedUrls)
+    {
+        $this->inner = $inner;
+
+        $this->requestStack = $requestStack;
+        $this->blacklist = '{('.implode('|', $excludedUrls).')}i';
+    }
+
+    public function isHandlerActivated(array $record): bool
+    {
+        $isActivated = $this->inner->isHandlerActivated($record);
+
+        if (
+            $isActivated
+            && isset($record['context']['exception'])
+            && $record['context']['exception'] instanceof HttpException
+            && 404 == $record['context']['exception']->getStatusCode()
+            && ($request = $this->requestStack->getMasterRequest())
+        ) {
+            return !preg_match($this->blacklist, $request->getPathInfo());
+        }
+
+        return $isActivated;
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Tests/Handler/FingersCrossed/NotFoundActivationStrategyDecoratorTest.php b/src/Symfony/Bridge/Monolog/Tests/Handler/FingersCrossed/NotFoundActivationStrategyDecoratorTest.php
@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Tests\Handler\FingersCrossed;
+
+use Monolog\Handler\FingersCrossed\ErrorLevelActivationStrategy;
+use Monolog\Logger;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Monolog\Handler\FingersCrossed\NotFoundActivationStrategyDecorator;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+
+class NotFoundActivationStrategyDecoratorTest extends TestCase
+{
+    /**
+     * @dataProvider isActivatedProvider
+     */
+    public function testIsActivated($url, $record, $expected)
+    {
+        $requestStack = new RequestStack();
+        $requestStack->push(Request::create($url));
+
+        $strategy = new NotFoundActivationStrategyDecorator(new ErrorLevelActivationStrategy(Logger::WARNING), $requestStack, ['^/foo', 'bar']);
+
+        $this->assertEquals($expected, $strategy->isHandlerActivated($record));
+    }
+
+    public function isActivatedProvider()
+    {
+        return [
+            ['/test',      ['level' => Logger::DEBUG], false],
+            ['/foo',       ['level' => Logger::DEBUG, 'context' => $this->getContextException(404)], false],
+            ['/baz/bar',   ['level' => Logger::ERROR, 'context' => $this->getContextException(404)], false],
+            ['/foo',       ['level' => Logger::ERROR, 'context' => $this->getContextException(404)], false],
+            ['/foo',       ['level' => Logger::ERROR, 'context' => $this->getContextException(500)], true],
+
+            ['/test',      ['level' => Logger::ERROR], true],
+            ['/baz',       ['level' => Logger::ERROR, 'context' => $this->getContextException(404)], true],
+            ['/baz',       ['level' => Logger::ERROR, 'context' => $this->getContextException(500)], true],
+        ];
+    }
+
+    private function getContextException(int $code): array
+    {
+        return ['exception' => new HttpException($code)];
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Tests/Handler/FingersCrossed/NotFoundActivationStrategyTest.php b/src/Symfony/Bridge/Monolog/Tests/Handler/FingersCrossed/NotFoundActivationStrategyTest.php
@@ -22,6 +22,8 @@ class NotFoundActivationStrategyTest extends TestCase
 {
     /**
      * @dataProvider isActivatedProvider
+     *
+     * @group legacy
      */
     public function testIsActivated($url, $record, $expected)
     {

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@ class NotFoundActivationStrategyTest extends TestCase`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* @dataProvider isActivatedProvider`
	`25`	`+ *`
	`26`	`+ * @group legacy`
`25`	`27`	`*/`
`26`	`28`	`public function testIsActivated($url, $record, $expected)`
`27`	`29`	`{`