AbstractConnection - Code Metrics - Inspection of "Woketo Client" - Nekland/Woketo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#100)

by Maxime

created 2017-07-02 21:29 UTC

AbstractConnection A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	9
lcom	1
cbo	6
dl	0
loc	113
ccs	0
cts	36
cp	0
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	onMessage()	16	3
	processHandshake()	1	?
	processMessage()	1	?
	getIp()	1	?
A	getLogger()	4	2
A	getHandler()	15	3

<?php

/**
 * This file is a part of Woketo package.
 *
 * (c) Nekland <[email protected]>
 *
 * For the full license, take a look to the LICENSE file
 * on the root directory of this project
 */

namespace Nekland\Woketo\Core;

use Nekland\Woketo\Exception\NoHandlerException;
use Nekland\Woketo\Exception\WebsocketException;
use Nekland\Woketo\Message\MessageHandlerInterface;
use Nekland\Woketo\Rfc6455\Handshake\HandshakeInterface;
use Nekland\Woketo\Rfc6455\Message;
use Nekland\Woketo\Rfc6455\MessageProcessor;
use Nekland\Woketo\Utils\SimpleLogger;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerInterface;
use React\EventLoop\LoopInterface;
use React\EventLoop\Timer\TimerInterface;
use React\Socket\Connection;

abstract class AbstractConnection
{
    /**
     * 5 seconds
     */
    const DEFAULT_TIMEOUT = 5;

    use LoggerAwareTrait;

    /**
     * @var Connection
     */
    protected $stream;

    /**
     * @var MessageProcessor
     */
    protected $messageProcessor;

    /**
     * @var \Nekland\Woketo\Rfc6455\Handshake\ServerHandshake|\Nekland\Woketo\Rfc6455\Handshake\ClientHandshake
     */
    protected $handshake;

    /**
     * @var bool
     */
    protected $handshakeDone;

    /**
     * @var string
     */
    protected $uri;

    /**
     * @var MessageHandlerInterface|\Closure
     */
    protected $handler;

    /**
     * @var TimerInterface
     */
    protected $timeout;

    /**
     * @var Message
     */
    protected $currentMessage;

    /**
     * @var LoopInterface
     */
    protected $loop;

    public function __construct(MessageProcessor $messageProcessor, HandshakeInterface $handshake = null)
    {
        $this->handshake = $handshake;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->messageProcessor = $messageProcessor;
    }

    protected function onMessage(string $data)
    {
        try {
            if (!$this->handshakeDone) {
                $this->processHandshake($data);
            } else {
                $this->processMessage($data);
            }

            return;
        } catch (WebsocketException $e) {
            $this->messageProcessor->close($this->stream);
            $this->getLogger()->notice('Connection to ' . $this->getIp() . ' closed with error : ' . $e->getMessage());
            $this->handler->onError($e, $this);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }
    }

    protected abstract function processHandshake(string $data);

    protected abstract function processMessage(string $data);


    /**
     * @return string
     */
    public abstract function getIp();


    /**
     * @return \Psr\Log\LoggerInterface
     */
    public function getLogger()
    {
        return $this->logger ?: $this->logger = new SimpleLogger();
    }

    /**
     * @return MessageHandlerInterface
     * @throws NoHandlerException
     */
    protected function getHandler() : MessageHandlerInterface
    {
        if ($this->handler instanceof \Closure) {
            $handler = $this->handler;
            $handler = $handler($this->uri, $this);

            if (null === $handler) {
                throw new NoHandlerException(sprintf('No handler for request URI %s.', $this->uri));
            }

            $this->handler = $handler;
        }

        return $this->handler;
    }
}


1			<?php
2
3			/**
4			* This file is a part of Woketo package.
5			*
6			* (c) Nekland <[email protected]>
7			*
8			* For the full license, take a look to the LICENSE file
9			* on the root directory of this project
10			*/
11
12			namespace Nekland\Woketo\Core;
13
14			use Nekland\Woketo\Exception\NoHandlerException;
15			use Nekland\Woketo\Exception\WebsocketException;
16			use Nekland\Woketo\Message\MessageHandlerInterface;
17			use Nekland\Woketo\Rfc6455\Handshake\HandshakeInterface;
18			use Nekland\Woketo\Rfc6455\Message;
19			use Nekland\Woketo\Rfc6455\MessageProcessor;
20			use Nekland\Woketo\Utils\SimpleLogger;
21			use Psr\Log\LoggerAwareTrait;
22			use Psr\Log\LoggerInterface;
23			use React\EventLoop\LoopInterface;
24			use React\EventLoop\Timer\TimerInterface;
25			use React\Socket\Connection;
26
27			abstract class AbstractConnection
28			{
29			/**
30			* 5 seconds
31			*/
32			const DEFAULT_TIMEOUT = 5;
33
34			use LoggerAwareTrait;
35
36			/**
37			* @var Connection
38			*/
39			protected $stream;
40
41			/**
42			* @var MessageProcessor
43			*/
44			protected $messageProcessor;
45
46			/**
47			* @var \Nekland\Woketo\Rfc6455\Handshake\ServerHandshake\|\Nekland\Woketo\Rfc6455\Handshake\ClientHandshake
48			*/
49			protected $handshake;
50
51			/**
52			* @var bool
53			*/
54			protected $handshakeDone;
55
56			/**
57			* @var string
58			*/
59			protected $uri;
60
61			/**
62			* @var MessageHandlerInterface\|\Closure
63			*/
64			protected $handler;
65
66			/**
67			* @var TimerInterface
68			*/
69			protected $timeout;
70
71			/**
72			* @var Message
73			*/
74			protected $currentMessage;
75
76			/**
77			* @var LoopInterface
78			*/
79			protected $loop;
80
81			public function __construct(MessageProcessor $messageProcessor, HandshakeInterface $handshake = null)
82			{
83			$this->handshake = $handshake;
			0 ignored issues – show Documentation Bug introduced 2017-02-19 18:54 UTC by Report Bug Copy Issue Report It seems like `$handshake` can also be of type `object<Nekland\Woketo\Rf...ake\HandshakeInterface>`. However, the property `$handshake` is declared as type `object<Nekland\Woketo\Rf...dshake\ClientHandshake>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
84			$this->messageProcessor = $messageProcessor;
85			}
86
87			protected function onMessage(string $data)
88			{
89			try {
90			if (!$this->handshakeDone) {
91			$this->processHandshake($data);
92			} else {
93			$this->processMessage($data);
94			}
95
96			return;
97			} catch (WebsocketException $e) {
98			$this->messageProcessor->close($this->stream);
99			$this->getLogger()->notice('Connection to ' . $this->getIp() . ' closed with error : ' . $e->getMessage());
100			$this->handler->onError($e, $this);
			0 ignored issues – show Bug introduced 2017-02-06 21:29 UTC by Report Bug Copy Issue Report The method `onError` does only exist in `Nekland\Woketo\Message\MessageHandlerInterface`, but not in `Closure`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
101			}
102			}
103
104			protected abstract function processHandshake(string $data);
			0 ignored issues – show Coding Style introduced 2017-01-06 22:26 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
105			protected abstract function processMessage(string $data);
			0 ignored issues – show Coding Style introduced 2017-01-06 22:26 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
106
107			/**
108			* @return string
109			*/
110			public abstract function getIp();
			0 ignored issues – show Coding Style introduced 2017-06-05 18:20 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
111
112			/**
113			* @return \Psr\Log\LoggerInterface
114			*/
115			public function getLogger()
116			{
117			return $this->logger ?: $this->logger = new SimpleLogger();
118			}
119
120			/**
121			* @return MessageHandlerInterface
122			* @throws NoHandlerException
123			*/
124			protected function getHandler() : MessageHandlerInterface
125			{
126			if ($this->handler instanceof \Closure) {
127			$handler = $this->handler;
128			$handler = $handler($this->uri, $this);
129
130			if (null === $handler) {
131			throw new NoHandlerException(sprintf('No handler for request URI %s.', $this->uri));
132			}
133
134			$this->handler = $handler;
135			}
136
137			return $this->handler;
138			}
139			}
140

Nekland / Woketo

Pull Request — master (#100)

AbstractConnection A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like