add 'checkIgnore' support

Andrii Afanasiev · Andrii Afanasiev · commit 9f0f01926c38 · 2018-04-09T11:00:56.000+02:00
diff --git a/Provider/InterfaceCheckIgnore.php b/Provider/InterfaceCheckIgnore.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace SymfonyRollbarBundle\Provider;
+
+/**
+ * Interface InterfaceCheckIgnore
+ *
+ * @package SymfonyRollbarBundle\Provider
+ */
+interface InterfaceCheckIgnore
+{
+    /**
+     * @param boolean                                 $isUncaught
+     * @param \Rollbar\ErrorWrapper|\Exception|string $toLog
+     * @param \Rollbar\Payload\Payload                $payload
+     *
+     * @return boolean
+     */
+    public function checkIgnore($isUncaught, $toLog, $payload);
+}
diff --git a/Provider/RollbarHandler.php b/Provider/RollbarHandler.php
@@ -39,6 +39,16 @@ class RollbarHandler extends AbstractProcessingHandler
      */
     protected $rbConfig;
 
+    /**
+     * List of configuration options where we have to try to inject services
+     * @var array
+     */
+    protected $injectServices = [
+        // config option, method
+        'person_fn'   => 'getPerson',
+        'checkIgnore' => 'checkIgnore',
+    ];
+
     /**
      * Monolog vs Rollbar
      * @var array
@@ -95,26 +105,42 @@ protected function initialize()
             $rConfig[$key] = $value;
         }
 
-        // DI for 'person_fn'
-        if (!empty($rConfig['person_fn'])) {
-            if ($this->container->has($rConfig['person_fn'])) {
-                $service = $this->container->get($rConfig['person_fn']);
-            } elseif (class_exists($rConfig['person_fn'])) {
-                $service = new $rConfig['person_fn']($this->container);
+        foreach ($this->injectServices as $option => $method) {
+            if (empty($rConfig[$option])) {
+                continue;
             }
 
-            if (!empty($service) && $service instanceof AbstractPersonProvider) {
-                $rConfig['person_fn'] = [$service, 'getPerson'];
-            } else {
-                $rConfig['person_fn'] = is_callable($rConfig['person_fn']) ? $rConfig['person_fn'] : null;
-            }
+            $rConfig[$option] = $this->injectService($rConfig[$option], $method);
         }
 
         $this->exclude = empty($config['exclude']) ? [] : $config['exclude'];
 
         return $rConfig;
     }
 
+    /**
+     * Inject service into configuration
+     *
+     * @param string $name
+     * @param string $method
+     *
+     * @return array|callable|null
+     */
+    protected function injectService($name, $method)
+    {
+        if ($this->container->has($name)) {
+            $service = $this->container->get($name);
+        } elseif (class_exists($name)) {
+            $service = new $name($this->container);
+        }
+
+        if (!empty($service) && method_exists($service, $method)) {
+            return [$service, $method];
+        } else {
+            return is_callable($name) ? $name : null;
+        }
+    }
+
     /**
      * @return \Symfony\Component\DependencyInjection\ContainerInterface
      */
diff --git a/Tests/Fixtures/CheckIgnoreProvider.php b/Tests/Fixtures/CheckIgnoreProvider.php
@@ -0,0 +1,36 @@
+<?php
+namespace SymfonyRollbarBundle\Tests\Fixtures;
+
+use SymfonyRollbarBundle\Provider\InterfaceCheckIgnore;
+
+class CheckIgnoreProvider implements InterfaceCheckIgnore
+{
+    /**
+     * @var bool
+     */
+    protected $ignore = false;
+
+    /**
+     * @param boolean                                 $isUncaught
+     * @param \Rollbar\ErrorWrapper|\Exception|string $toLog
+     * @param \Rollbar\Payload\Payload                $payload
+     *
+     * @return boolean
+     */
+    public function checkIgnore($isUncaught, $toLog, $payload)
+    {
+        return $this->ignore;
+    }
+
+    /**
+     * @param bool $ignore
+     *
+     * @return $this
+     */
+    public function setIgnore($ignore = false)
+    {
+        $this->ignore = $ignore;
+
+        return $this;
+    }
+}
diff --git a/Tests/Fixtures/app/config/config_test.yml b/Tests/Fixtures/app/config/config_test.yml
@@ -13,6 +13,7 @@ symfony_rollbar:
     access_token: 'SOME_ROLLBAR_ACCESS_TOKEN_123456'
     environment: '%kernel.environment%'
     person_fn: \SymfonyRollbarBundle\Tests\Fixtures\PersonProvider
+    checkIgnore: \SymfonyRollbarBundle\Tests\Fixtures\CheckIgnoreProvider
 
   rollbar_js:
     accessToken: 'SOME_ROLLBAR_ACCESS_TOKEN_654321'
diff --git a/Tests/Fixtures/app/config/config_test_if.yml b/Tests/Fixtures/app/config/config_test_if.yml
@@ -12,6 +12,7 @@ symfony_rollbar:
     access_token: 'SOME_ROLLBAR_ACCESS_TOKEN_123456'
     environment: '%kernel.environment%'
     person_fn: "get_awesome_person"
+    checkIgnore: "should_ignore"
 
   rollbar_js:
     accessToken: 'SOME_ROLLBAR_ACCESS_TOKEN_654321'
diff --git a/Tests/Fixtures/app/config/config_test_is.yml b/Tests/Fixtures/app/config/config_test_is.yml
@@ -13,6 +13,7 @@ symfony_rollbar:
     access_token: 'SOME_ROLLBAR_ACCESS_TOKEN_123456'
     environment: '%kernel.environment%'
     person_fn: "symfony_rollbar.fixture.person_provider"
+    checkIgnore: "symfony_rollbar.fixture.check_ignore_provider"
 
   rollbar_js:
     accessToken: 'SOME_ROLLBAR_ACCESS_TOKEN_654321'
diff --git a/Tests/Fixtures/app/config/services.yml b/Tests/Fixtures/app/config/services.yml
@@ -1,8 +1,13 @@
 parameters:
   symfony_rollbar.fixture.person_provider.class: \SymfonyRollbarBundle\Tests\Fixtures\PersonProvider
+  symfony_rollbar.fixture.check_ignore_provider.class: \SymfonyRollbarBundle\Tests\Fixtures\CheckIgnoreProvider
 
 services:
   symfony_rollbar.fixture.person_provider:
     class: "%symfony_rollbar.fixture.person_provider.class%"
     public: true
     arguments: ["@service_container"]
+
+  symfony_rollbar.fixture.check_ignore_provider:
+      class: "%symfony_rollbar.fixture.check_ignore_provider.class%"
+      public: true
diff --git a/Tests/Fixtures/global_fn.php b/Tests/Fixtures/global_fn.php
@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * @return array
+ */
+function get_awesome_person()
+{
+    return [
+        'id'       => 'global_id',
+        'username' => 'global_username',
+        'email'    => 'global_email',
+    ];
+}
+
+/**
+ * @param boolean                                 $isUncaught
+ * @param \Rollbar\ErrorWrapper|\Exception|string $toLog
+ * @param \Rollbar\Payload\Payload                $payload
+ *
+ * @return boolean
+ */
+function should_ignore($isUncaught, $toLog, $payload)
+{
+    return false;
+}
diff --git a/Tests/Fixtures/global_person_fn.php b/Tests/Fixtures/global_person_fn.php
diff --git a/Tests/SymfonyRollbarBundle/DependencyInjection/ConfigurationTest.php b/Tests/SymfonyRollbarBundle/DependencyInjection/ConfigurationTest.php
@@ -35,7 +35,7 @@ public function testParameters()
                 'base_api_url'                   => 'https://api.rollbar.com/api/1/',
                 'branch'                         => Configuration::BRANCH,
                 'capture_error_stacktraces'      => true,
-                'checkIgnore'                    => null,
+                'checkIgnore'                    => '\SymfonyRollbarBundle\Tests\Fixtures\CheckIgnoreProvider',
                 'code_version'                   => '',
                 'enable_utf8_sanitization'       => true,
                 'environment'                    => static::$kernel->getEnvironment(),
diff --git a/Tests/SymfonyRollbarBundle/Provider/CheckIgnoreTest.php b/Tests/SymfonyRollbarBundle/Provider/CheckIgnoreTest.php
@@ -0,0 +1,101 @@
+<?php
+
+namespace SymfonyRollbarBundle\Tests\Provider;
+
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use SymfonyRollbarBundle\Provider\RollbarHandler;
+use SymfonyRollbarBundle\Tests\Fixtures\CheckIgnoreProvider;
+
+/**
+ * Class CheckIgnoreTest
+ *
+ * @package SymfonyRollbarBundle\Tests\Provider
+ */
+class CheckIgnoreTest extends KernelTestCase
+{
+    /**
+     * @dataProvider generatorProviderEnv
+     *
+     * @param string $env
+     * @param \SymfonyRollbarBundle\Provider\PersonInterface $expected
+     *
+     * @throws \ReflectionException
+     */
+    public function testCheckIgnore($env, $expected)
+    {
+        static::bootKernel(['environment' => $env]);
+
+        $container = static::$kernel->getContainer();
+        $handler   = new RollbarHandler($container);
+
+        $method = new \ReflectionMethod($handler, 'initialize');
+        $method->setAccessible(true);
+
+        $config = $method->invoke($handler);
+        $this->assertNotEmpty($config['checkIgnore']);
+
+        $call = $config['checkIgnore'];
+        $this->assertEquals(2, count($call), "The 'checkIgnore' should contains 2 elements");
+
+        /** @var \SymfonyRollbarBundle\Tests\Fixtures\CheckIgnoreProvider $service */
+        $service = $call[0];
+        $method  = $call[1];
+        $this->assertInstanceOf(CheckIgnoreProvider::class, $service);
+        $this->assertEquals('checkIgnore', $method);
+
+        $service->setIgnore($expected);
+
+        $message = new \Rollbar\Payload\Message('rollbar');
+        $body    = new \Rollbar\Payload\Body($message);
+        $data    = new \Rollbar\Payload\Data($env, $body);
+        $payload = new \Rollbar\Payload\Payload($data, $config['access_token']);
+
+        $ignore = call_user_func($call, false, 'toLog', $payload);
+
+        if (!empty($ignore)) {
+            $this->assertEquals($expected, $ignore);
+        } else {
+            $this->assertFalse($ignore);
+        }
+    }
+
+    public function generatorProviderEnv()
+    {
+        return [
+            ['test', false],
+            ['test', true],
+            ['test_is', false],
+            ['test_is', true],
+        ];
+    }
+
+    /**
+     * @throws \ReflectionException
+     */
+    public function testPersonProviderFunction()
+    {
+        $env = 'test_if';
+        include_once __DIR__ . '/../../Fixtures/global_fn.php';
+        static::bootKernel(['environment' => $env]);
+
+        $container = static::$kernel->getContainer();
+        $handler   = new RollbarHandler($container);
+
+        $method = new \ReflectionMethod($handler, 'initialize');
+        $method->setAccessible(true);
+
+        $config = $method->invoke($handler);
+        $this->assertNotEmpty($config['checkIgnore']);
+
+        $method = $config['checkIgnore'];
+        $this->assertEquals('should_ignore', $method);
+
+        $message = new \Rollbar\Payload\Message('rollbar');
+        $body    = new \Rollbar\Payload\Body($message);
+        $data    = new \Rollbar\Payload\Data($env, $body);
+        $payload = new \Rollbar\Payload\Payload($data, $config['access_token']);
+
+        $ignore = call_user_func($method, false, 'toLog', $payload);
+        $this->assertFalse($ignore);
+    }
+}
diff --git a/Tests/SymfonyRollbarBundle/Provider/PersonProviderTest.php b/Tests/SymfonyRollbarBundle/Provider/PersonProviderTest.php
@@ -61,18 +61,18 @@ public function generatorProviderEnv()
         return [
             ['test', null],
             ['test', new AwesomePerson('person_id_1', 'username', 'email')],
-            ['test_ps', null],
-            ['test_ps', new AwesomePerson('person_id_2', 'username', 'email')],
+            ['test_is', null],
+            ['test_is', new AwesomePerson('person_id_2', 'username', 'email')],
         ];
     }
 
     /**
      * @throws \ReflectionException
      */
-    public function testProviderFunction()
+    public function testPersonProviderFunction()
     {
-        include_once __DIR__ . '/../../Fixtures/global_person_fn.php';
-        static::bootKernel(['environment' => 'test_pf']);
+        include_once __DIR__ . '/../../Fixtures/global_fn.php';
+        static::bootKernel(['environment' => 'test_if']);
 
         $container = static::$kernel->getContainer();
         $handler   = new RollbarHandler($container);
