Spatie\ServerMonitor\Models\Check

Complexity

Total Complexity

28

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	12

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	host()	0	4	1
A	scopeHealthy()	0	4	1
A	scopeUnhealthy()	0	4	1
A	getAttribute()	0	10	2
A	shouldRun()	0	14	3
A	getDefinition()	0	12	3
A	getProcess()	0	10	2
A	getProcessCommand()	0	13	2
A	getTarget()	0	10	2
A	succeeded()	0	12	1
A	warn()	0	13	1
A	failed()	0	13	1
A	scopeEnabled()	0	4	1
A	handleFinishedProcess()	0	14	2
A	scheduleNextRun()	0	9	1
A	hasStatus()	0	4	1
A	shouldFireRestoredEvent()	0	8	2
A	storeProcessOutput()	0	11	1

<?php

namespace Spatie\ServerMonitor\Models;

use Carbon\Carbon;
use Symfony\Component\Process\Process;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Spatie\ServerMonitor\Events\CheckFailed;
use Spatie\ServerMonitor\Events\CheckWarning;
use Spatie\ServerMonitor\Events\CheckRestored;
use Spatie\ServerMonitor\Events\CheckSucceeded;
use Spatie\ServerMonitor\Helpers\ConsoleOutput;
use Spatie\ServerMonitor\Models\Enums\CheckStatus;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Spatie\ServerMonitor\CheckDefinitions\CheckDefinition;
use Spatie\ServerMonitor\Models\Presenters\CheckPresenter;
use Spatie\ServerMonitor\Exceptions\InvalidCheckDefinition;
use Spatie\ServerMonitor\Models\Concerns\HasCustomProperties;

class Check extends Model
{
    use CheckPresenter, HasCustomProperties;

    public $guarded = [];

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

    public $dates = [
        'checked_at', 'next_check_at',
    ];

    public function host(): BelongsTo
    {
        return $this->belongsTo(Host::class);
    }

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

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

    public function getAttribute($key)
    {
        if (array_key_exists($key, $this->attributes)) {
            return parent::getAttribute($key);
        }

        $properties = json_decode($this->attributes['custom_properties'], true);

        return array_get($properties, $key, parent::getAttribute($key));
    }

    public function shouldRun(): bool
    {
        if (! $this->enabled) {

The property enabled does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            return false;
        }

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

The property checked_at does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            return true;
        }

        return $this->checked_at

The property checked_at does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            ->addMinutes($this->next_check_in_minutes)

The property next_check_in_minutes does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            ->isPast();
    }

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

The property type does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            throw InvalidCheckDefinition::unknownCheckType($this);
        }

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

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

    public function getProcess(): Process
    {
        static $processes = [];

        if (! isset($processes[$this->id])) {

The property id does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            $processes[$this->id] = new Process($this->getProcessCommand());

The property id does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        return $processes[$this->id];

The property id does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getProcessCommand(): string
    {
        $delimiter = 'EOF-LARAVEL-SERVER-MONITOR';

        $definition = $this->getDefinition();

        $portArgument = empty($this->host->port) ? '' : "-p {$this->host->port}";

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        return "ssh {$this->getTarget()} {$portArgument} 'bash -se <<$delimiter".PHP_EOL
            .'set -e'.PHP_EOL
            .$definition->getCommand().PHP_EOL
            .$delimiter."'";
    }

    protected function getTarget(): string
    {
        $target = $this->host->name;

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        if ($this->host->ssh_user) {

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            $target = $this->host->ssh_user.'@'.$target;

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        return $target;
    }

    public function succeeded(string $message = '')
    {
        $this->status = CheckStatus::SUCCESS;

The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->message = $message;

The property message does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->save();

        event(new CheckSucceeded($this));
        ConsoleOutput::info($this->host->name.": check `{$this->type}` succeeded");

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

The property type does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        return $this;
    }

    public function warn(string $warningMessage = '')
    {
        $this->status = CheckStatus::WARNING;

The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->message = $warningMessage;

The property message does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->save();

        event(new CheckWarning($this));

        ConsoleOutput::info($this->host->name.": check `{$this->type}` issued warning");

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

The property type does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        return $this;
    }

    public function failed(string $failureReason = '')
    {
        $this->status = CheckStatus::FAILED;

The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->message = $failureReason;

The property message does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->save();

        event(new CheckFailed($this));

        ConsoleOutput::error($this->host->name.": check `{$this->type}` failed");

The property host does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

The property type does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

        return $this;
    }

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

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

The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

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

        $this->scheduleNextRun();

        if ($this->shouldFireRestoredEvent($originalStatus, $this->status)) {

The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

            event(new CheckRestored($this));
        }

        return $this;
    }

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

The property checked_at does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->next_check_in_minutes = $this->getDefinition()->performNextRunInMinutes();

The property next_check_in_minutes does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->save();

        return $this;
    }

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

The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __get, maybe consider adding a @property annotation.

    }

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

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

    public function storeProcessOutput(Process $process)
    {
        $this->process_output = [

The property process_output does not exist on object<Spatie\ServerMonitor\Models\Check>. Since you implemented __set, maybe consider adding a @property annotation.

            'output' => $process->getOutput(),
            'error_output' => $process->getErrorOutput(),
            'exit_code' => $process->getExitCode(),
            'exit_code_text' => $process->getExitCodeText(),
        ];

        $this->save();
    }
}