Yabot::onMessage() - Code Metrics - Inspection of "connection logging" - nopolabs/yabot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 10426d...42f289 )

by Dan

created 2017-09-18 22:11 UTC

Yabot::onMessage() A

↳ Parent: Yabot

Complexity

Conditions	3
Paths	4

Size

Total Lines	23
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	9.0856
c	0
b	0
f	0
cc	3
eloc	15
nc	4
nop	1

<?php

namespace Nopolabs\Yabot;

use DateTime;
use Exception;
use Nopolabs\Yabot\Helpers\ConfigTrait;
use Nopolabs\Yabot\Helpers\LogTrait;
use Nopolabs\Yabot\Helpers\LoopTrait;
use Nopolabs\Yabot\Helpers\SlackTrait;
use Nopolabs\Yabot\Message\MessageFactory;
use Nopolabs\Yabot\Plugin\PluginInterface;
use Nopolabs\Yabot\Plugin\PluginManager;
use Nopolabs\Yabot\Slack\Client;
use Psr\Log\LoggerInterface;
use React\EventLoop\LoopInterface;
use React\EventLoop\Timer\TimerInterface;
use React\Promise\Timer;
use Slack\Payload;
use Slack\User;
use Throwable;

class Yabot
{
    use LogTrait;
    use LoopTrait;
    use SlackTrait;
    use ConfigTrait;

    /** @var MessageFactory */
    private $messageFactory;

    /** @var PluginManager */
    private $pluginManager;

    /** @var string */
    private $messageLog;

    /** @var TimerInterface */
    private $monitor;

    /** @var bool */
    private $pong;

    public function __construct(
        LoggerInterface $logger,
        LoopInterface $eventLoop,
        Client $slackClient,
        MessageFactory $messageFactory,
        PluginManager $pluginManager,
        array $config = []
    ) {
        $this->setLog($logger);
        $this->setLoop($eventLoop);
        $this->setSlack($slackClient);
        $this->setConfig($config);
        $this->messageFactory = $messageFactory;
        $this->pluginManager = $pluginManager;
        $this->messageLog = null;
    }

    public function getMessageLog()
    {
        return $this->messageLog;
    }

    public function setMessageLog(string $messageLog = null)
    {
        $this->messageLog = $messageLog ?? null;
    }

    public function init(array $plugins)
    {
        foreach ($plugins as $pluginId => $plugin) {
            /** @var PluginInterface $plugin */

            $this->info("loading $pluginId");

            try {
                $this->pluginManager->loadPlugin($pluginId, $plugin);
            } catch (Exception $e) {
                $this->warning("Unhandled Exception while loading $pluginId: ".$e->getMessage());
                $this->warning($e->getTraceAsString());
            }
        }
    }

    public function run()
    {
        $slack = $this->getSlack();

        $slack->init();

        $this->getLog()->info('Connecting...');

        Timer\timeout($slack->connect(), 30, $this->getLoop())
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->then(function () {
                $this->getLog()->info('Connected.');
                $this->connected();
            })
            ->otherwise(function (Timer\TimeoutException $error) {
                $this->getLog()->error($error->getMessage());
                $this->getLog()->error('Connection failed, shutting down.');
                $this->shutDown();
            })
            ->otherwise(function ($error) {

                $this->getLog()->error('Connection failed, shutting down.');
                $this->shutDown();
            });

        $this->addMemoryReporting();

        $this->getLoop()->run();
    }

    public function shutDown()
    {
        $this->getLog()->error('Shutting down...');

        $this->getSlack()->disconnect();
        $this->getLoop()->stop();
    }

    public function reconnect()
    {
        $this->getLog()->error('Reconnecting...');

        if ($this->monitor) {
            $this->loop->cancelTimer($this->monitor);
        }

        $this->getSlack()->reconnect()->then(
            function () {
                $this->getLog()->info('Reconnected');
                $this->monitor = $this->startConnectionMonitor();
            },
            function () {
                $this->getLog()->error('Reconnect failed, shutting down.');
                $this->shutDown();
            }
        );
    }

    public function connected()
    {
        $slack = $this->getSlack();

        $slack->update(function(User $authedUser) {
            $this->pluginManager->setAuthedUser($authedUser);
        });

        $slack->onEvent('message', [$this, 'onMessage']);
        $slack->onEvent('team_join', [$this, 'onTeamJoin']);

        $this->monitor = $this->startConnectionMonitor();
    }

    public function onMessage(Payload $payload)
    {
        $data = $payload->getData();

        $this->debug('Received message', $data);

        try {
            $this->logMessage($data);
            $message = $this->messageFactory->create($data);
        } catch (Throwable $throwable) {
            $errmsg = $throwable->getMessage()."\n"
                .$throwable->getTraceAsString()."\n"
                ."Payload data: ".json_encode($data);
            $this->warning($errmsg);
            return;
        }

        if ($message->isSelf()) {
            return;
        }

        $this->pluginManager->dispatchMessage($message);
    }

    public function onTeamJoin(Payload $payload)

    {
        $this->getSlack()->updateUsers();
    }

    public function getHelp() : string
    {
        return implode("\n", $this->pluginManager->getHelp());
    }

    public function getStatus() : string
    {
        $statuses = $this->pluginManager->getStatuses();

        array_unshift($statuses, $this->getFormattedMemoryUsage());

        return implode("\n", $statuses);
    }

    protected function addMemoryReporting()
    {
        $now = new DateTime();
        $then = new DateTime('+1 hour');
        $then->setTime($then->format('H'), 0, 0);
        $delay = $then->getTimestamp() - $now->getTimestamp();

        $this->addTimer($delay, function() {
            $this->info($this->getFormattedMemoryUsage());
            $this->addPeriodicTimer(3600, function() {
                $this->info($this->getFormattedMemoryUsage());
            });
        });
    }

    protected function getFormattedMemoryUsage() : string
    {
        $memory = memory_get_usage() / 1024;
        $formatted = number_format($memory, 3).'K';
        return "Current memory usage: {$formatted}";
    }

    protected function logMessage($data)
    {
        if ($this->messageLog !== null) {
            file_put_contents($this->messageLog, json_encode($data) . "\n", FILE_APPEND);
        }
    }

    /**
     * @return TimerInterface|null
     */
    protected function startConnectionMonitor()
    {
        if ($interval = $this->get('connection_monitor.interval')) {

            $this->getLog()->info("Monitoring websocket connection every $interval seconds.");
            $this->notify("Monitoring websocket connection every $interval seconds.");

            $this->ping();

            return $this->loop->addPeriodicTimer($interval, function () {
                $this->checkPong();
                $this->ping();
            });
        }
    }

    protected function checkPong()
    {
        if (!$this->pong) {
            $this->getLog()->error('No pong.');

            $failureStrategy = $this->get('connection_monitor.failure_strategy', 'reconnect');

            if ($failureStrategy === 'reconnect') {
                $this->reconnect();
                return;
            }

            if ($failureStrategy !== 'shutdown') {
                $this->getLog()->error("Unknown connection_monitor.failure_strategy '$failureStrategy'");
            }

            $this->shutDown();
        }
    }

    protected function ping()
    {
        $this->pong = false;

        $this->getSlack()->ping()
            ->then(
                function (Payload $payload) {
                    $this->getLog()->info($payload->toJson());
                    $this->pong = true;
                }
            );
    }

    protected function notify(string $message)
    {
        if ($user = $this->get('notify.user')) {
            $this->getSlack()->directMessage($message, $user);
        }
    }
}


1			<?php
2
3			namespace Nopolabs\Yabot;
4
5			use DateTime;
6			use Exception;
7			use Nopolabs\Yabot\Helpers\ConfigTrait;
8			use Nopolabs\Yabot\Helpers\LogTrait;
9			use Nopolabs\Yabot\Helpers\LoopTrait;
10			use Nopolabs\Yabot\Helpers\SlackTrait;
11			use Nopolabs\Yabot\Message\MessageFactory;
12			use Nopolabs\Yabot\Plugin\PluginInterface;
13			use Nopolabs\Yabot\Plugin\PluginManager;
14			use Nopolabs\Yabot\Slack\Client;
15			use Psr\Log\LoggerInterface;
16			use React\EventLoop\LoopInterface;
17			use React\EventLoop\Timer\TimerInterface;
18			use React\Promise\Timer;
19			use Slack\Payload;
20			use Slack\User;
21			use Throwable;
22
23			class Yabot
24			{
25			use LogTrait;
26			use LoopTrait;
27			use SlackTrait;
28			use ConfigTrait;
29
30			/** @var MessageFactory */
31			private $messageFactory;
32
33			/** @var PluginManager */
34			private $pluginManager;
35
36			/** @var string */
37			private $messageLog;
38
39			/** @var TimerInterface */
40			private $monitor;
41
42			/** @var bool */
43			private $pong;
44
45			public function __construct(
46			LoggerInterface $logger,
47			LoopInterface $eventLoop,
48			Client $slackClient,
49			MessageFactory $messageFactory,
50			PluginManager $pluginManager,
51			array $config = []
52			) {
53			$this->setLog($logger);
54			$this->setLoop($eventLoop);
55			$this->setSlack($slackClient);
56			$this->setConfig($config);
57			$this->messageFactory = $messageFactory;
58			$this->pluginManager = $pluginManager;
59			$this->messageLog = null;
60			}
61
62			public function getMessageLog()
63			{
64			return $this->messageLog;
65			}
66
67			public function setMessageLog(string $messageLog = null)
68			{
69			$this->messageLog = $messageLog ?? null;
70			}
71
72			public function init(array $plugins)
73			{
74			foreach ($plugins as $pluginId => $plugin) {
75			/** @var PluginInterface $plugin */
76
77			$this->info("loading $pluginId");
78
79			try {
80			$this->pluginManager->loadPlugin($pluginId, $plugin);
81			} catch (Exception $e) {
82			$this->warning("Unhandled Exception while loading $pluginId: ".$e->getMessage());
83			$this->warning($e->getTraceAsString());
84			}
85			}
86			}
87
88			public function run()
89			{
90			$slack = $this->getSlack();
91
92			$slack->init();
93
94			$this->getLog()->info('Connecting...');
95
96			Timer\timeout($slack->connect(), 30, $this->getLoop())
			0 ignored issues – show Bug introduced 2017-09-18 21:51 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Promise\PromiseInterface` as the method `otherwise()` does only exist in the following implementations of said interface: `React\Promise\FulfilledPromise`, `React\Promise\LazyPromise`, `React\Promise\Promise`, `React\Promise\RejectedPromise`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
97			->then(function () {
98			$this->getLog()->info('Connected.');
99			$this->connected();
100			})
101			->otherwise(function (Timer\TimeoutException $error) {
102			$this->getLog()->error($error->getMessage());
103			$this->getLog()->error('Connection failed, shutting down.');
104			$this->shutDown();
105			})
106			->otherwise(function ($error) {
			0 ignored issues – show Unused Code introduced 2017-09-18 21:51 UTC by Report Bug Copy Issue Report The parameter `$error` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
107			$this->getLog()->error('Connection failed, shutting down.');
108			$this->shutDown();
109			});
110
111			$this->addMemoryReporting();
112
113			$this->getLoop()->run();
114			}
115
116			public function shutDown()
117			{
118			$this->getLog()->error('Shutting down...');
119
120			$this->getSlack()->disconnect();
121			$this->getLoop()->stop();
122			}
123
124			public function reconnect()
125			{
126			$this->getLog()->error('Reconnecting...');
127
128			if ($this->monitor) {
129			$this->loop->cancelTimer($this->monitor);
130			}
131
132			$this->getSlack()->reconnect()->then(
133			function () {
134			$this->getLog()->info('Reconnected');
135			$this->monitor = $this->startConnectionMonitor();
136			},
137			function () {
138			$this->getLog()->error('Reconnect failed, shutting down.');
139			$this->shutDown();
140			}
141			);
142			}
143
144			public function connected()
145			{
146			$slack = $this->getSlack();
147
148			$slack->update(function(User $authedUser) {
149			$this->pluginManager->setAuthedUser($authedUser);
150			});
151
152			$slack->onEvent('message', [$this, 'onMessage']);
153			$slack->onEvent('team_join', [$this, 'onTeamJoin']);
154
155			$this->monitor = $this->startConnectionMonitor();
156			}
157
158			public function onMessage(Payload $payload)
159			{
160			$data = $payload->getData();
161
162			$this->debug('Received message', $data);
163
164			try {
165			$this->logMessage($data);
166			$message = $this->messageFactory->create($data);
167			} catch (Throwable $throwable) {
168			$errmsg = $throwable->getMessage()."\n"
169			.$throwable->getTraceAsString()."\n"
170			."Payload data: ".json_encode($data);
171			$this->warning($errmsg);
172			return;
173			}
174
175			if ($message->isSelf()) {
176			return;
177			}
178
179			$this->pluginManager->dispatchMessage($message);
180			}
181
182			public function onTeamJoin(Payload $payload)
			0 ignored issues – show Unused Code introduced 2017-08-01 16:09 UTC by Report Bug Copy Issue Report The parameter `$payload` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
183			{
184			$this->getSlack()->updateUsers();
185			}
186
187			public function getHelp() : string
188			{
189			return implode("\n", $this->pluginManager->getHelp());
190			}
191
192			public function getStatus() : string
193			{
194			$statuses = $this->pluginManager->getStatuses();
195
196			array_unshift($statuses, $this->getFormattedMemoryUsage());
197
198			return implode("\n", $statuses);
199			}
200
201			protected function addMemoryReporting()
202			{
203			$now = new DateTime();
204			$then = new DateTime('+1 hour');
205			$then->setTime($then->format('H'), 0, 0);
206			$delay = $then->getTimestamp() - $now->getTimestamp();
207
208			$this->addTimer($delay, function() {
209			$this->info($this->getFormattedMemoryUsage());
210			$this->addPeriodicTimer(3600, function() {
211			$this->info($this->getFormattedMemoryUsage());
212			});
213			});
214			}
215
216			protected function getFormattedMemoryUsage() : string
217			{
218			$memory = memory_get_usage() / 1024;
219			$formatted = number_format($memory, 3).'K';
220			return "Current memory usage: {$formatted}";
221			}
222
223			protected function logMessage($data)
224			{
225			if ($this->messageLog !== null) {
226			file_put_contents($this->messageLog, json_encode($data) . "\n", FILE_APPEND);
227			}
228			}
229
230			/**
231			* @return TimerInterface\|null
232			*/
233			protected function startConnectionMonitor()
234			{
235			if ($interval = $this->get('connection_monitor.interval')) {
236
237			$this->getLog()->info("Monitoring websocket connection every $interval seconds.");
238			$this->notify("Monitoring websocket connection every $interval seconds.");
239
240			$this->ping();
241
242			return $this->loop->addPeriodicTimer($interval, function () {
243			$this->checkPong();
244			$this->ping();
245			});
246			}
247			}
248
249			protected function checkPong()
250			{
251			if (!$this->pong) {
252			$this->getLog()->error('No pong.');
253
254			$failureStrategy = $this->get('connection_monitor.failure_strategy', 'reconnect');
255
256			if ($failureStrategy === 'reconnect') {
257			$this->reconnect();
258			return;
259			}
260
261			if ($failureStrategy !== 'shutdown') {
262			$this->getLog()->error("Unknown connection_monitor.failure_strategy '$failureStrategy'");
263			}
264
265			$this->shutDown();
266			}
267			}
268
269			protected function ping()
270			{
271			$this->pong = false;
272
273			$this->getSlack()->ping()
274			->then(
275			function (Payload $payload) {
276			$this->getLog()->info($payload->toJson());
277			$this->pong = true;
278			}
279			);
280			}
281
282			protected function notify(string $message)
283			{
284			if ($user = $this->get('notify.user')) {
285			$this->getSlack()->directMessage($message, $user);
286			}
287			}
288			}
289

nopolabs / yabot

Push — master ( 10426d...42f289 )

Yabot::onMessage() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like