AbstractConnection - Code Metrics - Inspection of "Merge pull request #100 from Nekland/feature/webso..." - Nekland/Woketo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e26ab3...1dd3f4 )

by Maxime

created 2017-07-25 21:38 UTC

AbstractConnection A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	6
dl	0
loc	145
ccs	0
cts	41
cp	0
rs	10
c	0
b	0
f	0

9 Methods

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

<?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\Frame;
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, LoopInterface $loop, 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;
        $this->loop = $loop;
    }

    /**
     * Behavior on new raw data received.
     *
     * @param string $data
     */
    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.
}
        }
    }

    /**
     * @param string $data
     * @return void
     */
    protected abstract function processHandshake(string $data);


    /**
     * @param string $data
     * @return void
     */
    protected abstract function processMessage(string $data);


    /**
     * May return ip or hostname
     *
     * @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;
    }

    /**
     * Close the connection with normal close.
     */
    public function close()
    {
        $this->messageProcessor->close($this->stream);
    }

    /**
     * @param string|Frame  $frame
     * @param int           $opCode
     * @throws \Nekland\Woketo\Exception\RuntimeException
     */
    public abstract function write($frame, int $opCode = Frame::OP_TEXT);

}


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\Frame;
18			use Nekland\Woketo\Rfc6455\Handshake\HandshakeInterface;
19			use Nekland\Woketo\Rfc6455\Message;
20			use Nekland\Woketo\Rfc6455\MessageProcessor;
21			use Nekland\Woketo\Utils\SimpleLogger;
22			use Psr\Log\LoggerAwareTrait;
23			use Psr\Log\LoggerInterface;
24			use React\EventLoop\LoopInterface;
25			use React\EventLoop\Timer\TimerInterface;
26			use React\Socket\Connection;
27
28			abstract class AbstractConnection
29			{
30			/**
31			* 5 seconds
32			*/
33			const DEFAULT_TIMEOUT = 5;
34
35			use LoggerAwareTrait;
36
37			/**
38			* @var Connection
39			*/
40			protected $stream;
41
42			/**
43			* @var MessageProcessor
44			*/
45			protected $messageProcessor;
46
47			/**
48			* @var \Nekland\Woketo\Rfc6455\Handshake\ServerHandshake\|\Nekland\Woketo\Rfc6455\Handshake\ClientHandshake
49			*/
50			protected $handshake;
51
52			/**
53			* @var bool
54			*/
55			protected $handshakeDone;
56
57			/**
58			* @var string
59			*/
60			protected $uri;
61
62			/**
63			* @var MessageHandlerInterface\|\Closure
64			*/
65			protected $handler;
66
67			/**
68			* @var TimerInterface
69			*/
70			protected $timeout;
71
72			/**
73			* @var Message
74			*/
75			protected $currentMessage;
76
77			/**
78			* @var LoopInterface
79			*/
80			protected $loop;
81
82			public function __construct(MessageProcessor $messageProcessor, LoopInterface $loop, HandshakeInterface $handshake = null)
83			{
84			$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...
85			$this->messageProcessor = $messageProcessor;
86			$this->loop = $loop;
87			}
88
89			/**
90			* Behavior on new raw data received.
91			*
92			* @param string $data
93			*/
94			protected function onMessage(string $data)
95			{
96			try {
97			if (!$this->handshakeDone) {
98			$this->processHandshake($data);
99			} else {
100			$this->processMessage($data);
101			}
102
103			return;
104			} catch (WebsocketException $e) {
105			$this->messageProcessor->close($this->stream);
106			$this->getLogger()->notice('Connection to ' . $this->getIp() . ' closed with error : ' . $e->getMessage());
107			$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...
108			}
109			}
110
111			/**
112			* @param string $data
113			* @return void
114			*/
115			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...
116
117			/**
118			* @param string $data
119			* @return void
120			*/
121			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...
122
123			/**
124			* May return ip or hostname
125			*
126			* @return string
127			*/
128			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...
129
130			/**
131			* @return \Psr\Log\LoggerInterface
132			*/
133			public function getLogger()
134			{
135			return $this->logger ?: $this->logger = new SimpleLogger();
136			}
137
138			/**
139			* @return MessageHandlerInterface
140			* @throws NoHandlerException
141			*/
142			protected function getHandler() : MessageHandlerInterface
143			{
144			if ($this->handler instanceof \Closure) {
145			$handler = $this->handler;
146			$handler = $handler($this->uri, $this);
147
148			if (null === $handler) {
149			throw new NoHandlerException(sprintf('No handler for request URI %s.', $this->uri));
150			}
151
152			$this->handler = $handler;
153			}
154
155			return $this->handler;
156			}
157
158			/**
159			* Close the connection with normal close.
160			*/
161			public function close()
162			{
163			$this->messageProcessor->close($this->stream);
164			}
165
166			/**
167			* @param string\|Frame $frame
168			* @param int $opCode
169			* @throws \Nekland\Woketo\Exception\RuntimeException
170			*/
171			public abstract function write($frame, int $opCode = Frame::OP_TEXT);
			0 ignored issues – show Coding Style introduced 2017-07-04 06:19 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
172			}
173

Nekland / Woketo

Push — master ( e26ab3...1dd3f4 )

AbstractConnection A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like