SupportsUptimeCheck::shouldLookForStringOnResponse() - Code Metrics - Inspection of "fix casing" - spatie/laravel-uptime-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1fef8...30b3b8 )

by Freek

created 2016-11-22 08:40 UTC

ponse() A

↳ Parent: SupportsUptimeCheck::uptimeRequestSucceeded()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?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) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return false;
        }

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

$x = new MyClass();
$x->foo = true;
            return true;
        }

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

        if (is_null($this->uptime_last_check_date)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return true;
        }

        return $this->uptime_last_check_date->diffInMinutes() >= $this->uptime_check_interval_in_minutes;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    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 = '';
class MyClass { }

$x = new MyClass();
$x->foo = true;

        $wasFailing = ! is_null($this->uptime_check_failed_event_fired_on_date);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $lastStatusChangeDate = $this->uptime_status_last_change_date ? clone $this->uptime_status_last_change_date : null;


        $this->uptime_check_times_failed_in_a_row = 0;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->uptime_last_check_date = Carbon::now();
        $this->uptime_check_failed_event_fired_on_date = null;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

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

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            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();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if ($this->shouldFireUptimeCheckFailedEvent()) {
            $this->uptime_check_failed_event_fired_on_date = Carbon::now();
            $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            $updatedMonitor = $this->fresh();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            $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;
    }
}


1			<?php
2
3			namespace Spatie\UptimeMonitor\Models\Traits;
4
5			use Psr\Http\Message\ResponseInterface;
6			use Spatie\UptimeMonitor\Events\UptimeCheckFailed;
7			use Carbon\Carbon;
8			use Spatie\UptimeMonitor\Events\UptimeCheckRecovered;
9			use Spatie\UptimeMonitor\Events\UptimeCheckSucceeded;
10			use Spatie\UptimeMonitor\Helpers\Period;
11			use Spatie\UptimeMonitor\Helpers\UptimeResponseCheckers\LookForStringChecker;
12			use Spatie\UptimeMonitor\Helpers\UptimeResponseCheckers\UptimeResponseChecker;
13			use Spatie\UptimeMonitor\Models\Monitor;
14			use Spatie\UptimeMonitor\Models\Enums\UptimeStatus;
15
16			trait SupportsUptimeCheck
17			{
18			public static function bootSupportsUptimeCheck()
19			{
20			static::saving(function (Monitor $monitor) {
21			if (is_null($monitor->uptime_status_last_change_date)) {
22			$monitor->uptime_status_last_change_date = Carbon::now();
23
24			return;
25			}
26
27			if ($monitor->getOriginal('uptime_status') != $monitor->uptime_status) {
28			$monitor->uptime_status_last_change_date = Carbon::now();
29			}
30			});
31			}
32
33			public function shouldCheckUptime() : bool
34			{
35			if (! $this->uptime_check_enabled) {
			0 ignored issues – show Bug introduced 2016-11-17 22:49 UTC by Report Bug Copy Issue Report The property `uptime_check_enabled` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
36			return false;
37			}
38
39			if ($this->uptime_status == UptimeStatus::NOT_YET_CHECKED) {
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report The property `uptime_status` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
40			return true;
41			}
42
43			if ($this->uptime_status == UptimeStatus::DOWN) {
44			return true;
45			}
46
47			if (is_null($this->uptime_last_check_date)) {
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report The property `uptime_last_check_date` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
48			return true;
49			}
50
51			return $this->uptime_last_check_date->diffInMinutes() >= $this->uptime_check_interval_in_minutes;
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report The property `uptime_check_interval_in_minutes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
52			}
53
54			public function uptimeRequestSucceeded(ResponseInterface $response)
55			{
56			$uptimeResponseChecker = app(UptimeResponseChecker::class);
57
58			if (! $uptimeResponseChecker->isValidResponse($response, $this)) {
59			$this->uptimeCheckFailed($uptimeResponseChecker->getFailureReason($response, $this));
60
61			return;
62			}
63
64			$this->uptimeCheckSucceeded();
65			}
66
67			public function uptimeRequestFailed(string $reason)
68			{
69			$this->uptimeCheckFailed($reason);
70			}
71
72			public function uptimeCheckSucceeded()
73			{
74			$this->uptime_status = UptimeStatus::UP;
75			$this->uptime_check_failure_reason = '';
			0 ignored issues – show Bug introduced 2016-11-18 04:03 UTC by Report Bug Copy Issue Report The property `uptime_check_failure_reason` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
76
77			$wasFailing = ! is_null($this->uptime_check_failed_event_fired_on_date);
			0 ignored issues – show Bug introduced 2016-11-18 04:05 UTC by Report Bug Copy Issue Report The property `uptime_check_failed_event_fired_on_date` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
78			$lastStatusChangeDate = $this->uptime_status_last_change_date ? clone $this->uptime_status_last_change_date : null;
			0 ignored issues – show Bug introduced 2016-11-18 18:22 UTC by Report Bug Copy Issue Report The property `uptime_status_last_change_date` does not seem to exist. Did you mean `uptime_status`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
79
80			$this->uptime_check_times_failed_in_a_row = 0;
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report The property `uptime_check_times_failed_in_a_row` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
81			$this->uptime_last_check_date = Carbon::now();
82			$this->uptime_check_failed_event_fired_on_date = null;
83			$this->save();
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report It seems like `save()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
84
85			if ($wasFailing) {
86			$downtimePeriod = new Period($lastStatusChangeDate, $this->uptime_last_check_date);
			0 ignored issues – show Documentation introduced 2016-11-21 21:39 UTC by Report Bug Copy Issue Report `$lastStatusChangeDate` is of type `object\|null`, but the function expects a `object<Carbon\Carbon>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
87
88			event(new UptimeCheckRecovered($this, $downtimePeriod));
89
90			return;
91			}
92
93			event(new UptimeCheckSucceeded($this));
94			}
95
96			public function uptimeCheckFailed(string $reason)
97			{
98			$this->uptime_status = UptimeStatus::DOWN;
99			$this->uptime_check_times_failed_in_a_row++;
100			$this->uptime_last_check_date = Carbon::now();
101			$this->uptime_check_failure_reason = $reason;
102			$this->save();
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report It seems like `save()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
103
104			if ($this->shouldFireUptimeCheckFailedEvent()) {
105			$this->uptime_check_failed_event_fired_on_date = Carbon::now();
106			$this->save();
			0 ignored issues – show Bug introduced 2016-11-15 23:15 UTC by Report Bug Copy Issue Report It seems like `save()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
107
108			$updatedMonitor = $this->fresh();
			0 ignored issues – show Bug introduced 2016-11-22 08:46 UTC by Report Bug Copy Issue Report It seems like `fresh()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
109
110			$downtimePeriod = new Period($updatedMonitor->uptime_status_last_change_date, $this->uptime_last_check_date);
111
112			event(new UptimeCheckFailed($this, $downtimePeriod));
113			}
114			}
115
116			protected function shouldFireUptimeCheckFailedEvent(): bool
117			{
118			if ($this->uptime_check_times_failed_in_a_row === config('laravel-uptime-monitor.uptime_check.fire_monitor_failed_event_after_consecutive_failures')) {
119			return true;
120			}
121
122			if (is_null($this->uptime_check_failed_event_fired_on_date)) {
123			return false;
124			}
125
126			if (config('laravel-uptime-monitor.notifications.resend_uptime_check_failed_notification_every_minutes') === 0) {
127			return false;
128			}
129
130			if ($this->uptime_check_failed_event_fired_on_date->diffInMinutes() >= config('laravel-uptime-monitor.notifications.resend_uptime_check_failed_notification_every_minutes')) {
131			return true;
132			}
133
134			return false;
135			}
136			}
137

spatie / laravel-uptime-monitor

GitHub Access Token became invalid

Push — master ( a1fef8...30b3b8 )

ponse() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like