PollClientsTask::failClient() - Code Metrics - BiffBangPow/silverstripe-monitoring-server - Measure and Improve Code Quality continuously with Scrutinizer

PollClientsTask::failClient() A
last analyzed 2023-08-17 09:55 UTC

↳ Parent: PollClientsTask

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	11
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	13
rs	9.9

<?php

namespace BiffBangPow\SSMonitor\Server\Task;

use BiffBangPow\SSMonitor\Server\Helper\ClientHelper;
use BiffBangPow\SSMonitor\Server\Helper\CommsHelper;
use BiffBangPow\SSMonitor\Server\Helper\EncryptionHelper;
use BiffBangPow\SSMonitor\Server\Model\Client;
use Psr\Log\LoggerInterface;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Environment;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\FieldType\DBDatetime;
use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJobService;


class PollClientsTask extends AbstractQueuedJob
{
    use Configurable;
    use Extensible;

    /**
     * @config
     * @var int
     */
    private static $requeue_delay = 180;


    public function __construct()
    {

    }

    public function getTitle()
    {
        return "BBP Monitoring - Collect data";
    }

    public function process()
    {
        $helper = new CommsHelper();
        $res = $helper->process();

        if (is_array($res)) {
            $this->updateClients($res);
        } else {
            $this->addMessage($res);
        }

        $this->isComplete = true;
        $this->addMessage('Done');
    }

    /**
     * @param array $res
     * @return string
     */
    private function updateClients($res)
    {
        foreach ($res as $clientData) {
            $clientID = $clientData['client'];
            $httpStatus = $clientData['status'];
            $body = $clientData['body'];

            if ((is_int($httpStatus)) && ($httpStatus < 300)) {
                //We have a response
                $this->updateClientData($clientID, $body);
            } else if ((is_int($httpStatus)) && ($httpStatus < 500)) {
                //404 error - log it and fail it
                $this->failClient(
                    $clientID,
                    _t(__CLASS__ . '.40xerror', 'The client failed to respond.  Please ensure the client module is installed and the API keys are set up correctly')
                );
            } else {
                $this->failClient(
                    $clientID,
                    _t(__CLASS__ . '.50xerror', 'The client failed to respond. Please check it is online and configured properly.')
                );
            }
        }
    }


    private function updateClientData($clientID, $data)
    {
        $client = Client::getByUUID($clientID);
        $clientHelper = new ClientHelper($client);
        if ($client) {

            $clientSecret = $clientHelper->getEncryptionSecret();
            $clientSalt = $clientHelper->getEncryptionSalt();

            $encHelper = new EncryptionHelper($clientSecret, $clientSalt);
            $clientData = $encHelper->decrypt($data);

            if (!$clientData) {
                $this->failClient($clientID, "Error decrypting response data");
                return;
            }

            $clientDataArray = unserialize($clientData);

            if ((!isset($clientDataArray['clientid'])) || ($clientDataArray['clientid'] !== $clientID)) {
                $this->failClient($clientID, "UUID from client either not set, or incorrect");
                return;
            }

            $client->update([
                'LastFetch' => DBDatetime::now()->format('y-MM-dd HH:mm:ss'),
                'ErrorMessage' => '',
                'FetchError' => false,
                'ClientData' => $data,
                'Notified' => false
            ]);
            $client->write();
            $this->extend('OnAfterClientUpdate', $client);
            return;

        } else {
            $this->failClient($clientID, 'Unknown UUID');
            return;
        }
        $this->failClient($clientID, 'An unknown error occurred');
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }


    /**
     * @param string $clientID
     * @return void
     * @throws \SilverStripe\ORM\ValidationException
     */
    private function failClient(string $clientID, $message)
    {
        $client = Client::getByUUID($clientID);
        if ($client) {

            $client->FetchError = true;
            $client->ErrorMessage = $message;
            $client->write();
            $clientMessage = 'Client: ' . $clientID . ' (' . $client->Title . ') ' . ' : ' . $message;
            $this->addMessage($clientMessage);
            $this->notifySlack($client, $clientMessage);
            $this->extend('OnAfterClientFail', $clientID);
        } else {
            $this->addMessage('Cannot find client with ID ' . $clientID);
        }
    }

    /**
     * @param Client $client
     * @param $message
     * @return void
     * @throws \Psr\Container\NotFoundExceptionInterface
     */
    private function notifySlack($client, $message = null)
    {
        $webhook = Environment::getEnv('SLACK_WEBHOOK');
        $channel = Environment::getEnv('SLACK_CHANNEL');
        if ($channel && $webhook && $client->Notified == 0) {
            Injector::inst()->get(LoggerInterface::class . '.SlackLogger')
                ->error($message);
            $client->update([
                'Notified' => true
            ]);
            $client->write();
        }
    }

    public function afterComplete()
    {
        $requeue_delay = $this->config()->get('requeue_delay');
        Injector::inst()->get(LoggerInterface::class)->info("Client job finished.  Requeuing in " . $requeue_delay . " seconds");

        $newJob = new PollClientsTask();
        if ($requeue_delay > 0) {
            singleton(QueuedJobService::class)
                ->queueJob(
                    $newJob,
                    date(
                        'Y-m-d H:i:s',
                        strtotime('+' . $requeue_delay . ' seconds')
                    )
                );
        } else {
            singleton(QueuedJobService::class)->queueJob($newJob);
        }

        parent::afterComplete();
    }

}


1			<?php
2
3			namespace BiffBangPow\SSMonitor\Server\Task;
4
5			use BiffBangPow\SSMonitor\Server\Helper\ClientHelper;
6			use BiffBangPow\SSMonitor\Server\Helper\CommsHelper;
7			use BiffBangPow\SSMonitor\Server\Helper\EncryptionHelper;
8			use BiffBangPow\SSMonitor\Server\Model\Client;
9			use Psr\Log\LoggerInterface;
10			use SilverStripe\Core\Config\Configurable;
11			use SilverStripe\Core\Environment;
12			use SilverStripe\Core\Extensible;
13			use SilverStripe\Core\Injector\Injector;
14			use SilverStripe\ORM\FieldType\DBDatetime;
15			use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
16			use Symbiote\QueuedJobs\Services\QueuedJobService;
17
18
19			class PollClientsTask extends AbstractQueuedJob
20			{
21			use Configurable;
22			use Extensible;
23
24			/**
25			* @config
26			* @var int
27			*/
28			private static $requeue_delay = 180;
			0 ignored issues – show introduced 2023-07-20 10:43 UTC by Report Bug Copy Issue Report The private property `$requeue_delay` is not used, and could be removed. Loading history...
29
30			public function __construct()
31			{
32
33			}
34
35			public function getTitle()
36			{
37			return "BBP Monitoring - Collect data";
38			}
39
40			public function process()
41			{
42			$helper = new CommsHelper();
43			$res = $helper->process();
44
45			if (is_array($res)) {
46			$this->updateClients($res);
47			} else {
48			$this->addMessage($res);
49			}
50
51			$this->isComplete = true;
52			$this->addMessage('Done');
53			}
54
55			/**
56			* @param array $res
57			* @return string
58			*/
59			private function updateClients($res)
60			{
61			foreach ($res as $clientData) {
62			$clientID = $clientData['client'];
63			$httpStatus = $clientData['status'];
64			$body = $clientData['body'];
65
66			if ((is_int($httpStatus)) && ($httpStatus < 300)) {
67			//We have a response
68			$this->updateClientData($clientID, $body);
69			} else if ((is_int($httpStatus)) && ($httpStatus < 500)) {
70			//404 error - log it and fail it
71			$this->failClient(
72			$clientID,
73			_t(__CLASS__ . '.40xerror', 'The client failed to respond. Please ensure the client module is installed and the API keys are set up correctly')
74			);
75			} else {
76			$this->failClient(
77			$clientID,
78			_t(__CLASS__ . '.50xerror', 'The client failed to respond. Please check it is online and configured properly.')
79			);
80			}
81			}
82			}
83
84
85			private function updateClientData($clientID, $data)
86			{
87			$client = Client::getByUUID($clientID);
88			$clientHelper = new ClientHelper($client);
89			if ($client) {
			0 ignored issues – show introduced 2023-07-20 10:43 UTC by Report Bug Copy Issue Report `$client` is of type `BiffBangPow\SSMonitor\Server\Model\Client`, thus it always evaluated to `true`. Loading history...
90			$clientSecret = $clientHelper->getEncryptionSecret();
91			$clientSalt = $clientHelper->getEncryptionSalt();
92
93			$encHelper = new EncryptionHelper($clientSecret, $clientSalt);
94			$clientData = $encHelper->decrypt($data);
95
96			if (!$clientData) {
97			$this->failClient($clientID, "Error decrypting response data");
98			return;
99			}
100
101			$clientDataArray = unserialize($clientData);
102
103			if ((!isset($clientDataArray['clientid'])) \|\| ($clientDataArray['clientid'] !== $clientID)) {
104			$this->failClient($clientID, "UUID from client either not set, or incorrect");
105			return;
106			}
107
108			$client->update([
109			'LastFetch' => DBDatetime::now()->format('y-MM-dd HH:mm:ss'),
110			'ErrorMessage' => '',
111			'FetchError' => false,
112			'ClientData' => $data,
113			'Notified' => false
114			]);
115			$client->write();
116			$this->extend('OnAfterClientUpdate', $client);
117			return;
118
119			} else {
120			$this->failClient($clientID, 'Unknown UUID');
121			return;
122			}
123			$this->failClient($clientID, 'An unknown error occurred');
			0 ignored issues – show Unused Code introduced 2023-07-20 10:43 UTC by Report Bug Copy Issue Report `$this->failClient($clien...nknown error occurred')` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
124			}
125
126
127			/**
128			* @param string $clientID
129			* @return void
130			* @throws \SilverStripe\ORM\ValidationException
131			*/
132			private function failClient(string $clientID, $message)
133			{
134			$client = Client::getByUUID($clientID);
135			if ($client) {
			0 ignored issues – show introduced 2023-07-20 10:43 UTC by Report Bug Copy Issue Report `$client` is of type `BiffBangPow\SSMonitor\Server\Model\Client`, thus it always evaluated to `true`. Loading history...
136			$client->FetchError = true;
137			$client->ErrorMessage = $message;
138			$client->write();
139			$clientMessage = 'Client: ' . $clientID . ' (' . $client->Title . ') ' . ' : ' . $message;
140			$this->addMessage($clientMessage);
141			$this->notifySlack($client, $clientMessage);
142			$this->extend('OnAfterClientFail', $clientID);
143			} else {
144			$this->addMessage('Cannot find client with ID ' . $clientID);
145			}
146			}
147
148			/**
149			* @param Client $client
150			* @param $message
151			* @return void
152			* @throws \Psr\Container\NotFoundExceptionInterface
153			*/
154			private function notifySlack($client, $message = null)
155			{
156			$webhook = Environment::getEnv('SLACK_WEBHOOK');
157			$channel = Environment::getEnv('SLACK_CHANNEL');
158			if ($channel && $webhook && $client->Notified == 0) {
159			Injector::inst()->get(LoggerInterface::class . '.SlackLogger')
160			->error($message);
161			$client->update([
162			'Notified' => true
163			]);
164			$client->write();
165			}
166			}
167
168			public function afterComplete()
169			{
170			$requeue_delay = $this->config()->get('requeue_delay');
171			Injector::inst()->get(LoggerInterface::class)->info("Client job finished. Requeuing in " . $requeue_delay . " seconds");
172
173			$newJob = new PollClientsTask();
174			if ($requeue_delay > 0) {
175			singleton(QueuedJobService::class)
176			->queueJob(
177			$newJob,
178			date(
179			'Y-m-d H:i:s',
180			strtotime('+' . $requeue_delay . ' seconds')
181			)
182			);
183			} else {
184			singleton(QueuedJobService::class)->queueJob($newJob);
185			}
186
187			parent::afterComplete();
188			}
189
190			}
191

BiffBangPow / silverstripe-monitoring-server

PollClientsTask::failClient() A last analyzed 2023-08-17 09:55 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PollClientsTask::failClient() A
last analyzed 2023-08-17 09:55 UTC