Spatie\UptimeMonitor\Models\Traits\SupportsUptimeCheck

Complexity

Total Complexity

21

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	uptimeRequestFailed()	0	4	1
A	uptimeCheckSucceeded()	0	23	3
A	bootSupportsUptimeCheck()	0	14	3
B	shouldCheckUptime()	0	20	5
A	uptimeRequestSucceeded()	0	12	2
A	uptimeCheckFailed()	0	19	2
B	shouldFireUptimeCheckFailedEvent()	0	20	5

<?php

namespace Spatie\UptimeMonitor\Models\Traits;

use Psr\Http\Message\ResponseInterface;
use Spatie\UptimeMonitor\Events\UptimeCheckFailed;
use Carbon\Carbon;
use Spatie\UptimeMonitor\Events\UptimeCheckRecovered;
use Spatie\UptimeMonitor\Events\UptimeCheckSucceeded;
use Spatie\UptimeMonitor\Helpers\Period;
use Spatie\UptimeMonitor\Helpers\UptimeResponseCheckers\LookForStringChecker;
use Spatie\UptimeMonitor\Helpers\UptimeResponseCheckers\UptimeResponseChecker;
use Spatie\UptimeMonitor\Models\Monitor;
use Spatie\UptimeMonitor\Models\Enums\UptimeStatus;

trait SupportsUptimeCheck
{
    public static function bootSupportsUptimeCheck()
    {
        static::saving(function (Monitor $monitor) {
            if (is_null($monitor->uptime_status_last_change_date)) {
                $monitor->uptime_status_last_change_date = Carbon::now();

                return;
            }

            if ($monitor->getOriginal('uptime_status') != $monitor->uptime_status) {
                $monitor->uptime_status_last_change_date = Carbon::now();
            }
        });
    }

    public function shouldCheckUptime() : bool
    {
        if (! $this->uptime_check_enabled) {

The property uptime_check_enabled does not exist. Did you maybe forget to declare it?

            return false;
        }

        if ($this->uptime_status == UptimeStatus::NOT_YET_CHECKED) {

The property uptime_status does not exist. Did you maybe forget to declare it?

            return true;
        }

        if ($this->uptime_status == UptimeStatus::DOWN) {
            return true;
        }

        if (is_null($this->uptime_last_check_date)) {

The property uptime_last_check_date does not exist. Did you maybe forget to declare it?

            return true;
        }

        return $this->uptime_last_check_date->diffInMinutes() >= $this->uptime_check_interval_in_minutes;

The property uptime_check_interval_in_minutes does not exist. Did you maybe forget to declare it?

    }

    public function uptimeRequestSucceeded(ResponseInterface $response)
    {
        $uptimeResponseChecker = app(UptimeResponseChecker::class);

        if (! $uptimeResponseChecker->isValidResponse($response, $this)) {
            $this->uptimeCheckFailed($uptimeResponseChecker->getFailureReason($response, $this));

            return;
        }

        $this->uptimeCheckSucceeded();
    }

    public function uptimeRequestFailed(string $reason)
    {
        $this->uptimeCheckFailed($reason);
    }

    public function uptimeCheckSucceeded()
    {
        $this->uptime_status = UptimeStatus::UP;
        $this->uptime_check_failure_reason = '';

The property uptime_check_failure_reason does not exist. Did you maybe forget to declare it?

        $wasFailing = ! is_null($this->uptime_check_failed_event_fired_on_date);

The property uptime_check_failed_event_fired_on_date does not exist. Did you maybe forget to declare it?

        $lastStatusChangeDate = $this->uptime_status_last_change_date ? clone $this->uptime_status_last_change_date : null;

The property uptime_status_last_change_date does not seem to exist. Did you mean uptime_status?

        $this->uptime_check_times_failed_in_a_row = 0;

The property uptime_check_times_failed_in_a_row does not exist. Did you maybe forget to declare it?

        $this->uptime_last_check_date = Carbon::now();
        $this->uptime_check_failed_event_fired_on_date = null;
        $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if ($wasFailing) {
            $downtimePeriod = new Period($lastStatusChangeDate, $this->uptime_last_check_date);

$lastStatusChangeDate is of type object|null, but the function expects a object<Carbon\Carbon>.

            event(new UptimeCheckRecovered($this, $downtimePeriod));

            return;
        }

        event(new UptimeCheckSucceeded($this));
    }

    public function uptimeCheckFailed(string $reason)
    {
        $this->uptime_status = UptimeStatus::DOWN;
        $this->uptime_check_times_failed_in_a_row++;
        $this->uptime_last_check_date = Carbon::now();
        $this->uptime_check_failure_reason = $reason;
        $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if ($this->shouldFireUptimeCheckFailedEvent()) {
            $this->uptime_check_failed_event_fired_on_date = Carbon::now();
            $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $updatedMonitor = $this->fresh();

It seems like fresh() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $downtimePeriod = new Period($updatedMonitor->uptime_status_last_change_date, $this->uptime_last_check_date);

            event(new UptimeCheckFailed($this, $downtimePeriod));
        }
    }

    protected function shouldFireUptimeCheckFailedEvent(): bool
    {
        if ($this->uptime_check_times_failed_in_a_row === config('laravel-uptime-monitor.uptime_check.fire_monitor_failed_event_after_consecutive_failures')) {
            return true;
        }

        if (is_null($this->uptime_check_failed_event_fired_on_date)) {
            return false;
        }

        if (config('laravel-uptime-monitor.notifications.resend_uptime_check_failed_notification_every_minutes') === 0) {
            return false;
        }

        if ($this->uptime_check_failed_event_fired_on_date->diffInMinutes() >= config('laravel-uptime-monitor.notifications.resend_uptime_check_failed_notification_every_minutes')) {
            return true;
        }

        return false;
    }
}