protonemedia / laravel-api-health

src/Checkers/Executor.php

<?php

namespace ProtoneMedia\ApiHealth\Checkers;

use ProtoneMedia\ApiHealth\Checkers\Checker;
use ProtoneMedia\ApiHealth\Checkers\CheckerHasFailed;
use ProtoneMedia\ApiHealth\Storage\CheckerState;

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

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

    /**
     * The caught exception if the checker fails.
     *
     * @var \ProtoneMedia\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 \ProtoneMedia\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 \ProtoneMedia\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
    {
        $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 \ProtoneMedia\ApiHealth\Checkers\Checker
     */
    public function getChecker(): Checker
    {
        return $this->checker;
    }

    /**
     * Returns the caught exception.
     *
     * @return \ProtoneMedia\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);

Are you sure the usage of $this->state->addFailedTimestamp($this->exception) targeting ProtoneMedia\ApiHealth\Storage\CheckerState::addFailedTimestamp() seems to always return null.

        }

        $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()) {

The method retryJob() does not exist on ProtoneMedia\ApiHealth\Checkers\Checker. It seems like you code against a sub-type of ProtoneMedia\ApiHealth\Checkers\Checker such as ProtoneMedia\ApiHealth\Checkers\AbstractChecker.

            return $this->state->addRetryTimestamp();

Are you sure the usage of $this->state->addRetryTimestamp() targeting ProtoneMedia\ApiHealth\Storage\CheckerState::addRetryTimestamp() seems to always return null.

        }

        $job = new $jobClass($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);
        }
    }
}