Spatie\ServerMonitor\Models\Check

Complexity

Total Complexity

17

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	host()	0	4	1
A	scopeHealthy()	0	4	1
A	scopeUnhealthy()	0	4	1
A	scopeEnabled()	0	4	1
A	shouldRun()	0	14	3
A	getDefinition()	0	12	3
A	handleFinishedProcess()	0	14	2
A	shouldFireRestoredEvent()	0	8	2
A	scheduleNextRun()	0	9	1
A	hasStatus()	0	4	1
A	storeProcessOutput()	0	11	1

<?php

namespace Spatie\ServerMonitor\Models;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Spatie\ServerMonitor\CheckDefinitions\CheckDefinition;
use Spatie\ServerMonitor\Events\CheckRestored;
use Spatie\ServerMonitor\Exceptions\InvalidCheckDefinition;
use Spatie\ServerMonitor\Models\Concerns\HandlesCheckResult;
use Spatie\ServerMonitor\Models\Concerns\HasCustomProperties;
use Spatie\ServerMonitor\Models\Concerns\HasProcess;
use Spatie\ServerMonitor\Models\Concerns\ThrottlesFailingNotifications;
use Spatie\ServerMonitor\Models\Enums\CheckStatus;
use Spatie\ServerMonitor\Models\Presenters\CheckPresenter;
use Symfony\Component\Process\Process;

class Check extends Model
{
    use CheckPresenter,
        HasCustomProperties,
        ThrottlesFailingNotifications,
        HasProcess,
        HandlesCheckResult;

    public $guarded = [];

    public $casts = [
        'custom_properties' => 'array',
        'last_run_output' => 'array',
    ];

    public $dates = [
        'last_ran_at', 'next_check_at', 'started_throttling_failing_notifications_at',
    ];

    public function host(): BelongsTo
    {
        return $this->belongsTo(config('server-monitor.host_model', Host::class));
    }

    public function scopeHealthy($query)
    {
        return $query->where('status', CheckStatus::SUCCESS);
    }

    public function scopeUnhealthy($query)
    {
        return $query->where('status', '!=', CheckStatus::SUCCESS);
    }

    public function scopeEnabled(Builder $query)
    {
        $query->where('enabled', 1);
    }

    public function shouldRun(): bool
    {
        if (! $this->enabled) {
            return false;
        }

        if (is_null($this->last_ran_at)) {
            return true;
        }

        return ! $this->last_ran_at
            ->addMinutes($this->next_run_in_minutes)
            ->isFuture();
    }

    public function getDefinition(): CheckDefinition
    {
        if (! $definitionClass = config("server-monitor.checks.{$this->type}")) {
            throw InvalidCheckDefinition::unknownCheckType($this);
        }

        if (! class_exists($definitionClass)) {
            throw InvalidCheckDefinition::definitionClassDoesNotExist($this, $definitionClass);
        }

        return app($definitionClass)->setCheck($this);
    }

    public function handleFinishedProcess()
    {
        $originalStatus = $this->status;

        $this->getDefinition()->determineResult($this->getProcess());

        $this->scheduleNextRun();

        if ($this->shouldFireRestoredEvent($originalStatus, $this->status)) {
            event(new CheckRestored($this));
        }

        return $this;
    }

    protected function shouldFireRestoredEvent(?string $originalStatus, ?string $newStatus)
    {
        if (! in_array($originalStatus, [CheckStatus::FAILED, CheckStatus::WARNING])) {
            return false;
        }

        return $newStatus === CheckStatus::SUCCESS;
    }

    protected function scheduleNextRun()
    {
        $this->last_ran_at = Carbon::now();

        $this->next_run_in_minutes = $this->getDefinition()->performNextRunInMinutes();
        $this->save();

        return $this;
    }

    public function hasStatus(string $status): bool
    {
        return $this->status === $status;
    }

    public function storeProcessOutput(Process $process)
    {
        $this->last_run_output = [
            'output' => $process->getOutput(),
            'error_output' => $process->getErrorOutput(),
            'exit_code' => $process->getExitCode(),
            'exit_code_text' => $process->getExitCodeText(),
        ];

        $this->save();
    }
}