Connection::getLogger() - 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

Connection::getLogger() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?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\Server;

use Nekland\Woketo\Core\AbstractConnection;
use Nekland\Woketo\Exception\NoHandlerException;
use Nekland\Woketo\Exception\RuntimeException;
use Nekland\Woketo\Exception\WebsocketException;
use Nekland\Woketo\Http\Request;
use Nekland\Woketo\Http\Response;
use Nekland\Woketo\Rfc6455\Frame;
use Nekland\Woketo\Rfc6455\MessageProcessor;
use Nekland\Woketo\Rfc6455\Handshake\ServerHandshake;
use React\EventLoop\LoopInterface;
use React\Socket\ConnectionInterface;

class Connection extends AbstractConnection
{
    public function __construct(
        ConnectionInterface $socketStream,
        \Closure $messageHandler,
        LoopInterface $loop,
        MessageProcessor $messageProcessor,
        ServerHandshake $handshake = null
    ) {
        parent::__construct($messageProcessor, $loop, $handshake ?: new ServerHandshake);
        $this->stream = $socketStream;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->initListeners();
        $this->handler = $messageHandler;
    }

    private function initListeners()
    {
        $this->stream->on('data', function ($data) {
            $this->processData($data);
        });
        $this->stream->on('error', function ($data) {
            $this->error($data);
        });
    }

    private function processData($data)
    {
        try {
            if (!$this->handshakeDone) {
                $this->processHandshake($data);
            } else {
                $this->processMessage($data);
            }

            return;
        } catch (WebsocketException $e) {
            $this->messageProcessor->close($this->stream);
            $this->logger->notice('Connection to ' . $this->getIp() . ' closed with error : ' . $e->getMessage());
            $this->getHandler()->onError($e, $this);
        } catch (NoHandlerException $e) {
            $this->getLogger()->info(sprintf('No handler found for uri %s. Connection closed.', $this->uri));
            $this->close();
        }
    }

    /**
     * This method build a message and buffer data in case of incomplete data.
     *
     * @param string $data
     */
    protected function processMessage(string $data)
    {
        // It may be a timeout going (we were waiting for data), let's clear it.
        if ($this->timeout !== null) {
            $this->timeout->cancel();
            $this->timeout = null;
        }

        foreach ($this->messageProcessor->onData($data, $this->stream, $this->currentMessage) as $message) {
            $this->currentMessage = $message;
            if ($this->currentMessage->isComplete()) {
                // Sending the message through the woketo API.
                switch($this->currentMessage->getOpcode()) {
                    case Frame::OP_TEXT:
                        $this->getHandler()->onMessage($this->currentMessage->getContent(), $this);
                        break;
                    case Frame::OP_BINARY:
                        $this->getHandler()->onBinary($this->currentMessage->getContent(), $this);
                        break;
                }
                $this->currentMessage = null;

            } else {
                // We wait for more data so we start a timeout.
                $this->timeout = $this->loop->addTimer(Connection::DEFAULT_TIMEOUT, function () {
                    $this->logger->notice('Connection to ' . $this->getIp() . ' timed out.');
                    $this->messageProcessor->timeout($this->stream);
                });
            }
        }
    }

    public function write($frame, int $opCode = Frame::OP_TEXT)
    {
        try {
            $this->messageProcessor->write($frame, $this->stream, $opCode);
        } catch (WebsocketException $e) {
            throw new RuntimeException($e);
        }
    }

    /**
     * @param mixed $data
     */
    protected function error($data)
    {
        $message = "A connectivity error occurred: " . $data;
        $this->logger->error($message);
        $this->getHandler()->onError(new WebsocketException($message), $this);
    }

    /**
     * If it's a new client, we need to make some special actions named the handshake.
     *
     * @param string $data
     */
    protected function processHandshake(string $data)
    {
        if ($this->handshakeDone) {
            return;
        }

        $request = Request::create($data);
        $this->handshake->verify($request);
        $this->uri = $request->getUri();
        $response = Response::createSwitchProtocolResponse();
        $this->handshake->sign($response, $this->handshake->extractKeyFromRequest($request));
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.
}
        $response->send($this->stream);

        $this->handshakeDone = true;
        $this->getHandler()->onConnection($this);
    }

    /**
     * @return string
     */
    public function getIp()
    {
        return $this->stream->getRemoteAddress();
    }
}


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\Server;
13
14			use Nekland\Woketo\Core\AbstractConnection;
15			use Nekland\Woketo\Exception\NoHandlerException;
16			use Nekland\Woketo\Exception\RuntimeException;
17			use Nekland\Woketo\Exception\WebsocketException;
18			use Nekland\Woketo\Http\Request;
19			use Nekland\Woketo\Http\Response;
20			use Nekland\Woketo\Rfc6455\Frame;
21			use Nekland\Woketo\Rfc6455\MessageProcessor;
22			use Nekland\Woketo\Rfc6455\Handshake\ServerHandshake;
23			use React\EventLoop\LoopInterface;
24			use React\Socket\ConnectionInterface;
25
26			class Connection extends AbstractConnection
27			{
28			public function __construct(
29			ConnectionInterface $socketStream,
30			\Closure $messageHandler,
31			LoopInterface $loop,
32			MessageProcessor $messageProcessor,
33			ServerHandshake $handshake = null
34			) {
35			parent::__construct($messageProcessor, $loop, $handshake ?: new ServerHandshake);
36			$this->stream = $socketStream;
			0 ignored issues – show Documentation Bug introduced 2017-01-06 22:26 UTC by Report Bug Copy Issue Report `$socketStream` is of type `object<React\Socket\ConnectionInterface>`, but the property `$stream` was declared to be of type `object<React\Socket\Connection>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` 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 given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
37			$this->initListeners();
38			$this->handler = $messageHandler;
39			}
40
41			private function initListeners()
42			{
43			$this->stream->on('data', function ($data) {
44			$this->processData($data);
45			});
46			$this->stream->on('error', function ($data) {
47			$this->error($data);
48			});
49			}
50
51			private function processData($data)
52			{
53			try {
54			if (!$this->handshakeDone) {
55			$this->processHandshake($data);
56			} else {
57			$this->processMessage($data);
58			}
59
60			return;
61			} catch (WebsocketException $e) {
62			$this->messageProcessor->close($this->stream);
63			$this->logger->notice('Connection to ' . $this->getIp() . ' closed with error : ' . $e->getMessage());
64			$this->getHandler()->onError($e, $this);
65			} catch (NoHandlerException $e) {
66			$this->getLogger()->info(sprintf('No handler found for uri %s. Connection closed.', $this->uri));
67			$this->close();
68			}
69			}
70
71			/**
72			* This method build a message and buffer data in case of incomplete data.
73			*
74			* @param string $data
75			*/
76			protected function processMessage(string $data)
77			{
78			// It may be a timeout going (we were waiting for data), let's clear it.
79			if ($this->timeout !== null) {
80			$this->timeout->cancel();
81			$this->timeout = null;
82			}
83
84			foreach ($this->messageProcessor->onData($data, $this->stream, $this->currentMessage) as $message) {
85			$this->currentMessage = $message;
86			if ($this->currentMessage->isComplete()) {
87			// Sending the message through the woketo API.
88			switch($this->currentMessage->getOpcode()) {
89			case Frame::OP_TEXT:
90			$this->getHandler()->onMessage($this->currentMessage->getContent(), $this);
91			break;
92			case Frame::OP_BINARY:
93			$this->getHandler()->onBinary($this->currentMessage->getContent(), $this);
94			break;
95			}
96			$this->currentMessage = null;
97
98			} else {
99			// We wait for more data so we start a timeout.
100			$this->timeout = $this->loop->addTimer(Connection::DEFAULT_TIMEOUT, function () {
101			$this->logger->notice('Connection to ' . $this->getIp() . ' timed out.');
102			$this->messageProcessor->timeout($this->stream);
103			});
104			}
105			}
106			}
107
108			public function write($frame, int $opCode = Frame::OP_TEXT)
109			{
110			try {
111			$this->messageProcessor->write($frame, $this->stream, $opCode);
112			} catch (WebsocketException $e) {
113			throw new RuntimeException($e);
114			}
115			}
116
117			/**
118			* @param mixed $data
119			*/
120			protected function error($data)
121			{
122			$message = "A connectivity error occurred: " . $data;
123			$this->logger->error($message);
124			$this->getHandler()->onError(new WebsocketException($message), $this);
125			}
126
127			/**
128			* If it's a new client, we need to make some special actions named the handshake.
129			*
130			* @param string $data
131			*/
132			protected function processHandshake(string $data)
133			{
134			if ($this->handshakeDone) {
135			return;
136			}
137
138			$request = Request::create($data);
139			$this->handshake->verify($request);
140			$this->uri = $request->getUri();
141			$response = Response::createSwitchProtocolResponse();
142			$this->handshake->sign($response, $this->handshake->extractKeyFromRequest($request));
			0 ignored issues – show Bug introduced 2017-02-19 18:54 UTC by Report Bug Copy Issue Report The method `extractKeyFromRequest` does only exist in `Nekland\Woketo\Rfc6455\Handshake\ServerHandshake`, but not in `Nekland\Woketo\Rfc6455\Handshake\ClientHandshake`. 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...
143			$response->send($this->stream);
144
145			$this->handshakeDone = true;
146			$this->getHandler()->onConnection($this);
147			}
148
149			/**
150			* @return string
151			*/
152			public function getIp()
153			{
154			return $this->stream->getRemoteAddress();
155			}
156			}
157

Nekland / Woketo

Push — master ( e26ab3...1dd3f4 )

Connection::getLogger() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like