Add exception rate limiter

Author: guanguans

composer.json

@@ -65,7 +65,9 @@
         "illuminate/http": "^5.5 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
         "illuminate/log": "^5.5 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
         "illuminate/queue": "^5.5 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
-        "illuminate/support": "^5.5 || ^6.0 || ^7.0 || ^8.0 || ^9.0"
+        "illuminate/support": "^5.5 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "symfony/cache": "^5.0 || 6.0",
+        "symfony/rate-limiter": "^5.0 || ^6.0"
     },
     "require-dev": {
         "brainmaestro/composer-git-hooks": "^2.7",

config/exception-notify.php

@@ -56,6 +56,26 @@
     */
     'dont_report' => [],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Exception notification rate limiter.
+    |--------------------------------------------------------------------------
+    |
+    | The exception notification rate limiter is used to prevent sending
+    | exception notification to the same channel too frequently.
+    |
+    */
+    'rate_limiter' => [
+        // Limit the number of exceptions.
+        'limit' => (int) env('EXCEPTION_NOTIFY_LIMIT', 1),
+
+        // Time interval.
+        'interval' => env('EXCEPTION_NOTIFY_INTERVAL', '1 minutes'),
+
+        // Cache adapter.
+        'cache_adapter' => \Symfony\Component\Cache\Adapter\FilesystemAdapter::class,
+    ],
+
     /*
     |--------------------------------------------------------------------------
     | Report title.

src/ExceptionNotifyManager.php

@@ -34,6 +34,7 @@
 use Illuminate\Support\Manager;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
+use Symfony\Component\RateLimiter\RateLimiterFactory;
 use Throwable;
 
 class ExceptionNotifyManager extends Manager
@@ -112,7 +113,13 @@ public function shouldntReport(Throwable $e): bool
             }
         }
 
-        return false;
+        /* @var RateLimiterFactory $rateLimiterFactory */
+        $rateLimiterFactory = $this->container->make(RateLimiterFactory::class);
+
+        return ! $rateLimiterFactory
+            ->create(md5($e->getFile().$e->getLine().$e->getCode().$e->getMessage()))
+            ->consume()
+            ->isAccepted();
     }
 
     public function shouldReport(Throwable $e): bool

src/ExceptionNotifyServiceProvider.php

@@ -22,6 +22,8 @@
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Str;
 use Laravel\Lumen\Application as LumenApplication;
+use Symfony\Component\RateLimiter\RateLimiterFactory;
+use Symfony\Component\RateLimiter\Storage\CacheStorage;
 
 class ExceptionNotifyServiceProvider extends ServiceProvider
 {
@@ -49,6 +51,7 @@ public function register()
         $this->setupConfig();
         $this->registerExceptionNotifyManager();
         $this->registerCollectorManager();
+        $this->registerRateLimiterFactory();
     }
 
     /**
@@ -96,6 +99,22 @@ protected function registerExceptionNotifyManager()
         $this->app->alias(ExceptionNotifyManager::class, 'exception.notifier');
     }
 
+    protected function registerRateLimiterFactory()
+    {
+        $this->app->singleton(RateLimiterFactory::class, function (Container $app) {
+            return new RateLimiterFactory([
+                'id' => 'exception_notify',
+                'policy' => 'token_bucket',
+                'limit' => $app['config']['exception-notify.rate_limiter.limit'],
+                'rate' => [
+                    'interval' => $app['config']['exception-notify.rate_limiter.interval'],
+                ],
+            ], new CacheStorage($app->make($app['config']['exception-notify.rate_limiter.cache_adapter'])));
+        });
+
+        $this->app->alias(RateLimiterFactory::class, 'exception.rate-limiter-factory');
+    }
+
     protected function registerReportingEvent()
     {
         foreach ($this->app['config']['exception-notify.reporting'] as $listener) {