Executor::configureRetryJobDefaults() - Code Metrics - Inspection of "Refactor" - protonemedia/laravel-api-health - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b06f55...54bd50 )

by Pascal

created 2018-07-31 15:25 UTC

Executor::configureRetryJobDefaults() A

↳ Parent: Executor

Complexity

Conditions	4
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	4
nc	8
nop	2

<?php

namespace Pbmedia\ApiHealth\Checkers;

use Illuminate\Notifications\Notification;
use Illuminate\Queue\Events\JobProcessing;
use Illuminate\Support\Facades\Queue;
use Pbmedia\ApiHealth\Checkers\Checker;
use Pbmedia\ApiHealth\Checkers\CheckerHasFailed;
use Pbmedia\ApiHealth\Storage\CheckerState;

class Executor
{
    /**
     * The checker.
     *
     * @var \Pbmedia\ApiHealth\Checkers\Checker
     */
    private $checker;

    /**
     * The state of the checker.
     *
     * @var \Pbmedia\ApiHealth\Storage\CheckerState
     */
    private $state;

    /**
     * The caught exception if the checker fails.
     *
     * @var \Pbmedia\ApiHealth\Checkers\CheckerHasFailed
     */
    private $exception;

    /**
     * Boolean wether the checker has failed of not.
     *
     * @var bool
     */
    private $failed;

    /**
     * Creates an instance with the given checker
     *
     * @param \Pbmedia\ApiHealth\Checkers\Checker $checker
     */
    public function __construct(Checker $checker)
    {
        $this->checker = $checker;
        $this->state   = new CheckerState($checker);
    }

    /**
     * Shortcut for creating an instance for a checker class.
     *
     * @param  string $checkerClass
     * @return \Pbmedia\ApiHealth\Checkers\Executor
     */
    public static function make(string $checkerClass)
    {
        return new static($checkerClass::create());
    }

    /**
     * Returns a boolean wether the checker passes.
     *
     * @return bool
     */
    public function passes(): bool
    {
        if (is_null($this->failed)) {
            $this->handle();
        }

        return !$this->failed;
    }

    /**
     * Returns a boolean wether the checker fails.
     *
     * @return bool
     */
    public function fails(): bool
    {
        return !$this->passes();
    }

    /**
     * Returns the checker.
     *
     * @return \Pbmedia\ApiHealth\Checkers\Checker
     */
    public function getChecker(): Checker
    {
        return $this->checker;
    }

    /**
     * Returns the caught exception.
     *
     * @return \Pbmedia\ApiHealth\Checkers\CheckerHasFailed
     */
    public function getException(): CheckerHasFailed
    {
        return $this->exception;
    }

    /**
     * Runs the checker, stores the state and lets events take
     * care of sending the notifications.
     *
     * @return $this
     */
    public function handle()
    {
        $this->failed = false;

        try {
            $this->checker->run();
            $this->state->setToPassing();
        } catch (CheckerHasFailed $exception) {
            if ($this->state->retryIsAllowed()) {
                $this->handleAllowedRetry();
            } else {
                $this->exception = $exception;
                $this->failed    = true;
                $this->handleFailedChecker();
            }
        }

        return $this;
    }

    /**
     * Handler for whenever the checker fails. Stores the state or adds a timestamp
     * to the state if the checker previously failed.
     *
     * @return null
     */
    private function handleFailedChecker()
    {
        if ($this->state->exists() && $this->state->isFailing()) {
            return $this->state->addFailedTimestamp($this->exception);
        }

        $this->state->setToFailed($this->exception);
    }

    /**
     * Adds a retry timestamp to the state of checker or dispaches
     * the retry job.
     *
     * @return null
     */
    private function handleAllowedRetry()
    {
        if (!$this->state->exists()) {
            $this->state->setToPassing();
        }

        if (!$jobClass = $this->checker->retryJob()) {
            return $this->state->addRetryTimestamp();
        }

        $this->addCallbackBeforeRetryCheckerJob($jobClass);

        $job = new $jobClass(get_class($this->checker));

        $this->configureRetryJobDefaults($job, config('api-health.retries.job'));

        if (method_exists($this->checker, 'withRetryJob')) {
            $this->checker->withRetryJob($job);
        }

        dispatch($job);
    }

    /**
     * Sets the default connection, delay and queue
     * on the retry job.
     *
     * @param  mixed $job
     * @param  array  $config
     */
    private function configureRetryJobDefaults($job, array $config)
    {
        if ($connection = $config['connection'] ?? null) {
            $job->onConnection($connection);
        }

        if ($delay = $config['delay'] ?? null) {
            $job->delay($delay);
        }

        if ($queue = $config['queue'] ?? null) {
            $job->onQueue($queue);
        }
    }

    /**
     * Adds a callback before the retry job is executed which
     * will add a retry timestamp on the checker's state.
     *
     * @param string $job
     */
    private function addCallbackBeforeRetryCheckerJob(string $job)
    {
        Queue::before(function (JobProcessing $event) use ($job) {
            $resolvedName = $event->job->resolveName();

            $checkerClass = unserialize(
                $event->job->payload()['data']['command']
            )->checkerClass;

            if ($resolvedName === $job && $checkerClass === get_class($this->checker)) {
                $this->state->addRetryTimestamp();
            }
        });
    }
}


1			<?php
2
3			namespace Pbmedia\ApiHealth\Checkers;
4
5			use Illuminate\Notifications\Notification;
6			use Illuminate\Queue\Events\JobProcessing;
7			use Illuminate\Support\Facades\Queue;
8			use Pbmedia\ApiHealth\Checkers\Checker;
9			use Pbmedia\ApiHealth\Checkers\CheckerHasFailed;
10			use Pbmedia\ApiHealth\Storage\CheckerState;
11
12			class Executor
13			{
14			/**
15			* The checker.
16			*
17			* @var \Pbmedia\ApiHealth\Checkers\Checker
18			*/
19			private $checker;
20
21			/**
22			* The state of the checker.
23			*
24			* @var \Pbmedia\ApiHealth\Storage\CheckerState
25			*/
26			private $state;
27
28			/**
29			* The caught exception if the checker fails.
30			*
31			* @var \Pbmedia\ApiHealth\Checkers\CheckerHasFailed
32			*/
33			private $exception;
34
35			/**
36			* Boolean wether the checker has failed of not.
37			*
38			* @var bool
39			*/
40			private $failed;
41
42			/**
43			* Creates an instance with the given checker
44			*
45			* @param \Pbmedia\ApiHealth\Checkers\Checker $checker
46			*/
47			public function __construct(Checker $checker)
48			{
49			$this->checker = $checker;
50			$this->state = new CheckerState($checker);
51			}
52
53			/**
54			* Shortcut for creating an instance for a checker class.
55			*
56			* @param string $checkerClass
57			* @return \Pbmedia\ApiHealth\Checkers\Executor
58			*/
59			public static function make(string $checkerClass)
60			{
61			return new static($checkerClass::create());
62			}
63
64			/**
65			* Returns a boolean wether the checker passes.
66			*
67			* @return bool
68			*/
69			public function passes(): bool
70			{
71			if (is_null($this->failed)) {
72			$this->handle();
73			}
74
75			return !$this->failed;
76			}
77
78			/**
79			* Returns a boolean wether the checker fails.
80			*
81			* @return bool
82			*/
83			public function fails(): bool
84			{
85			return !$this->passes();
86			}
87
88			/**
89			* Returns the checker.
90			*
91			* @return \Pbmedia\ApiHealth\Checkers\Checker
92			*/
93			public function getChecker(): Checker
94			{
95			return $this->checker;
96			}
97
98			/**
99			* Returns the caught exception.
100			*
101			* @return \Pbmedia\ApiHealth\Checkers\CheckerHasFailed
102			*/
103			public function getException(): CheckerHasFailed
104			{
105			return $this->exception;
106			}
107
108			/**
109			* Runs the checker, stores the state and lets events take
110			* care of sending the notifications.
111			*
112			* @return $this
113			*/
114			public function handle()
115			{
116			$this->failed = false;
117
118			try {
119			$this->checker->run();
120			$this->state->setToPassing();
121			} catch (CheckerHasFailed $exception) {
122			if ($this->state->retryIsAllowed()) {
123			$this->handleAllowedRetry();
124			} else {
125			$this->exception = $exception;
126			$this->failed = true;
127			$this->handleFailedChecker();
128			}
129			}
130
131			return $this;
132			}
133
134			/**
135			* Handler for whenever the checker fails. Stores the state or adds a timestamp
136			* to the state if the checker previously failed.
137			*
138			* @return null
139			*/
140			private function handleFailedChecker()
141			{
142			if ($this->state->exists() && $this->state->isFailing()) {
143			return $this->state->addFailedTimestamp($this->exception);
144			}
145
146			$this->state->setToFailed($this->exception);
147			}
148
149			/**
150			* Adds a retry timestamp to the state of checker or dispaches
151			* the retry job.
152			*
153			* @return null
154			*/
155			private function handleAllowedRetry()
156			{
157			if (!$this->state->exists()) {
158			$this->state->setToPassing();
159			}
160
161			if (!$jobClass = $this->checker->retryJob()) {
162			return $this->state->addRetryTimestamp();
163			}
164
165			$this->addCallbackBeforeRetryCheckerJob($jobClass);
166
167			$job = new $jobClass(get_class($this->checker));
168
169			$this->configureRetryJobDefaults($job, config('api-health.retries.job'));
170
171			if (method_exists($this->checker, 'withRetryJob')) {
172			$this->checker->withRetryJob($job);
173			}
174
175			dispatch($job);
176			}
177
178			/**
179			* Sets the default connection, delay and queue
180			* on the retry job.
181			*
182			* @param mixed $job
183			* @param array $config
184			*/
185			private function configureRetryJobDefaults($job, array $config)
186			{
187			if ($connection = $config['connection'] ?? null) {
188			$job->onConnection($connection);
189			}
190
191			if ($delay = $config['delay'] ?? null) {
192			$job->delay($delay);
193			}
194
195			if ($queue = $config['queue'] ?? null) {
196			$job->onQueue($queue);
197			}
198			}
199
200			/**
201			* Adds a callback before the retry job is executed which
202			* will add a retry timestamp on the checker's state.
203			*
204			* @param string $job
205			*/
206			private function addCallbackBeforeRetryCheckerJob(string $job)
207			{
208			Queue::before(function (JobProcessing $event) use ($job) {
209			$resolvedName = $event->job->resolveName();
210
211			$checkerClass = unserialize(
212			$event->job->payload()['data']['command']
213			)->checkerClass;
214
215			if ($resolvedName === $job && $checkerClass === get_class($this->checker)) {
216			$this->state->addRetryTimestamp();
217			}
218			});
219			}
220			}
221

protonemedia / laravel-api-health

GitHub Access Token became invalid

Push — master ( b06f55...54bd50 )

Executor::configureRetryJobDefaults() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like