TalvBansal\ThrottledFailedJobMonitor\RoutesThrottledNotifications

Complexity

Total Complexity

6

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	limiter()	0	4	1
A	throttleKey()	0	6	1
A	maxAttempts()	0	4	1

<?php

namespace TalvBansal\ThrottledFailedJobMonitor;

use Illuminate\Cache\RateLimiter;
use Illuminate\Notifications\RoutesNotifications;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Str;
use TalvBansal\ThrottledFailedJobMonitor\Event\NotificationLimitReached;

/**
 * Trait RoutesThrottledNotifications.
 */
trait RoutesThrottledNotifications
{
    use RoutesNotifications {
        RoutesNotifications::notify as parentNotify;
    }

    public function notify($instance): void
    {
        if ($instance instanceof ThrottledNotification) {
            $key = $this->throttleKey($instance);
            if ($this->limiter()->tooManyAttempts($key, $this->maxAttempts())) {
                Log::notice("Skipping sending notification with key `$key`. Rate limit reached.");
                event(new NotificationLimitReached($key));

                return;
            }

            $this->limiter()->hit($key, ($instance->throttleDecayMinutes() * 60));
        }

        // Execute the original notify() method.
        $this->parentNotify($instance);

The method parentNotify() does not exist on TalvBansal\ThrottledFailedJobMonitor\RoutesThrottledNotifications. Did you maybe mean notify()?

    }

    /**
     * Get the rate limiter instance.
     */
    protected function limiter(): RateLimiter
    {
        return app(RateLimiter::class);
    }

    /**
     * Build the notification throttle key from the Notification class name,
     * the Notification's throttle key id.
     * @param ThrottledNotification $instance
     * @return string
     */
    protected function throttleKey(ThrottledNotification $instance)
    {
        return Str::kebab(
            class_basename($instance).'-'.$instance->throttleKeyId()
        );
    }

    /**
     * Set the max attempts to 1.
     */
    protected function maxAttempts()
    {
        return 1;
    }
}