TalvBansal\ThrottledFailedJobMonitor\Notification

Complexity

Total Complexity

9

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	via()	0	4	1
A	setEvent()	0	6	1
A	getEvent()	0	4	1
A	toMail()	0	10	1
A	toSlack()	0	14	1
A	toMsTeams()	0	19	1
A	throttleDecayMinutes()	0	4	1
A	throttleKeyId()	0	9	2

<?php

namespace TalvBansal\ThrottledFailedJobMonitor;

use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Messages\SlackAttachment;
use Illuminate\Notifications\Messages\SlackMessage;
use Illuminate\Notifications\Notification as IlluminateNotification;
use Illuminate\Queue\Events\JobFailed;
use Illuminate\Support\Str;
use NotificationChannels\MsTeams\MsTeamsMessage;

class Notification extends IlluminateNotification implements ThrottledNotification
{
    /** @var \Illuminate\Queue\Events\JobFailed */
    protected $event;

    public function via($notifiable): array

The parameter $notifiable is not used and could be removed.

    {
        return config('throttled-failed-jobs.channels');
    }

    public function setEvent(JobFailed $event): self
    {
        $this->event = $event;

        return $this;
    }

    public function getEvent(): JobFailed
    {
        return $this->event;
    }

    public function toMail($notifiable): MailMessage

The parameter $notifiable is not used and could be removed.

    {
        return (new MailMessage)
            ->error()
            ->subject('A job failed at '.config('app.url'))
            ->line("Exception message: {$this->event->exception->getMessage()}")
            ->line("Job class: {$this->event->job->resolveName()}")
            ->line("Job body: {$this->event->job->getRawBody()}")
            ->line("Exception: {$this->event->exception->getTraceAsString()}");
    }

    public function toSlack(): SlackMessage
    {
        return (new SlackMessage)
            ->error()
            ->content('A job failed at '.config('app.url'))
            ->attachment(function (SlackAttachment $attachment) {
                $attachment->fields([
                    'Exception message' => $this->event->exception->getMessage(),
                    'Job class' => $this->event->job->resolveName(),
                    'Job body' => $this->event->job->getRawBody(),
                    'Exception' => $this->event->exception->getTraceAsString(),
                ]);
            });
    }

    public function toMsTeams(): MsTeamsMessage
    {
        $content = sprintf('## Job class : %s
> Exception message: %s
Job body: %s
    ```php
        %s
    ```
        ',
            $this->event->exception->getMessage(),
            $this->event->job->resolveName(),
            $this->event->job->getRawBody(),
            $this->event->exception->getTraceAsString()
        );

        return MsTeamsMessage::create()
            ->title('A job failed at '.config('app.url'))
            ->content($content);
    }

    public function throttleDecayMinutes(): int
    {
        return config('throttled-failed-jobs.throttle_decay');
    }

    public function throttleKeyId()
    {
        if ($this->getEvent()->exception instanceof \Exception) {
            return Str::kebab($this->getEvent()->exception->getMessage());
        }

        // fall back throttle key, use the notification name...
        return static::class;
    }
}