Manager::connectToPeers() - Code Metrics - Inspection of "Merge pull request #33 from tokenly/closeemitter" - Bit-Wasp/bitcoin-p2p-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1c3099...b9c07c )

by thomas

created 2015-12-10 04:26 UTC

Manager::connectToPeers() A

↳ Parent: Manager

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	4
Bugs	1	Features	1

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

<?php

namespace BitWasp\Bitcoin\Networking\Peer;

use BitWasp\Bitcoin\Networking\Structure\NetworkAddressInterface;
use Evenement\EventEmitter;
use React\Promise\Deferred;

class Manager extends EventEmitter
{
    /**
     * @var Factory
     */
    private $peerFactory;

    /**
     * @var bool|false
     */
    private $requestRelay;

    /**
     * @var Peer[]
     */
    private $outPeers = [];

    /**
     * @var Peer[]
     */
    private $inPeers = [];

    /**
     * @var int
     */
    private $nOutPeers = 0;

    /**
     * @var int
     */
    private $nInPeers = 0;

    /**
     * @param Factory $factory
     * @param bool|false $requestRelay
     */
    public function __construct(Factory $factory, $requestRelay = false)
    {
        $this->peerFactory = $factory;
        $this->requestRelay = $requestRelay;
    }

    /**
     * Store the newly connected peer, and trigger a new connection if they go away.
     *
     * @param Peer $peer
     * @return Peer
     */
    public function registerOutboundPeer(Peer $peer)
    {
        $next = $this->nOutPeers++;
        $peer->on('close', function ($peer) use ($next) {
            $this->emit('disconnect', [$peer]);
            unset($this->outPeers[$next]);
        });

        $this->outPeers[$next] = $peer;
        $this->emit('outbound', [$peer]);
        return $peer;
    }

    /**
     * @param Peer $peer
     */
    public function registerInboundPeer(Peer $peer)
    {
        $next = $this->nInPeers++;
        $this->inPeers[$next] = $peer;
        $peer->on('close', function () use ($next) {
            unset($this->inPeers[$next]);
        });
        $this->emit('inbound', [$peer]);
    }

    /**
     * @param Listener $listener
     * @return $this
     */
    public function registerListener(Listener $listener)
    {
        $listener->on('connection', function (Peer $peer) {
            $this->registerInboundPeer($peer);
        });

        return $this;
    }

    /**
     * @param Recorder $recorder
     */
    public function registerRecorder(Recorder $recorder)
    {
        $this->on('outbound', function (Peer $peer) use ($recorder) {
            $recorder->save($peer->getRemoteAddr());
        });
    }

    /**
     * @param PacketHandler $packetHandler
     */
    public function registerHandler(PacketHandler $packetHandler)
    {
        $attach = function ($connectionType) use ($packetHandler) {
            return function (Peer $peer) use ($connectionType, $packetHandler) {
                $packetHandler->emit($connectionType, [$peer]);
            };
        };

        $this->on('inbound', $attach('inbound'));
        $this->on('outbound', $attach('outbound'));
    }

    /**
     * @param NetworkAddressInterface $address
     * @return \React\Promise\Promise|\React\Promise\PromiseInterface
     * @throws \Exception
     */
    public function connect(NetworkAddressInterface $address)
    {
        $peer = $this->peerFactory->getPeer();
        if ($this->requestRelay) {
            $peer->requestRelay();
        }

        $deferred = new Deferred();
        $peer
            ->connect($this->peerFactory->getConnector(), $address)
            ->then(
                function ($peer) use ($deferred) {
                    $deferred->resolve($peer);
                },
                function () use ($deferred) {
                    $deferred->reject();
                }
            );

        return $deferred->promise();
    }

    /**
     * @param Locator $locator
     * @return \React\Promise\ExtendedPromiseInterface|\React\Promise\Promise|static
     */
    public function connectNextPeer(Locator $locator)
    {
        $deferred = new Deferred();

        // Otherwise, rely on the Locator.
        try {
            $deferred->resolve($locator->popAddress());
        } catch (\Exception $e) {
            $locator->queryDnsSeeds()->then(
                function () use ($deferred, $locator) {
                    $deferred->resolve($locator->popAddress());
                }
            );
        }

        return $deferred
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.
    }
}
            ->promise()
            ->then(
                function (NetworkAddressInterface $address) {
                    return $this->connect($address)->then(
                        function (Peer $peer) {
                            $this->registerOutboundPeer($peer);
                            return $peer;
                        }
                    );
                }
            )
            ->otherwise(function () use ($locator) {
                return $this->connectNextPeer($locator);
            });
    }

    /**
     * Create $n connections to clients available in the PeerLocator
     * @param int $n
     *
     * @param Locator $locator
     * @param $n
     * @return null|\React\Promise\FulfilledPromise|\React\Promise\Promise|\React\Promise\PromiseInterface|\React\Promise\RejectedPromise|static
     */
    public function connectToPeers(Locator $locator, $n)
    {
        $peers = [];
        for ($i = 0; $i < $n; $i++) {
            $peers[$i] = $this->connectNextPeer($locator);
        }

        return \React\Promise\all($peers);
    }
}


1		<?php
2
3		namespace BitWasp\Bitcoin\Networking\Peer;
4
5		use BitWasp\Bitcoin\Networking\Structure\NetworkAddressInterface;
6		use Evenement\EventEmitter;
7		use React\Promise\Deferred;
8
9		class Manager extends EventEmitter
10		{
11		/**
12		* @var Factory
13		*/
14		private $peerFactory;
15
16		/**
17		* @var bool\|false
18		*/
19		private $requestRelay;
20
21		/**
22		* @var Peer[]
23		*/
24		private $outPeers = [];
25
26		/**
27		* @var Peer[]
28		*/
29		private $inPeers = [];
30
31		/**
32		* @var int
33		*/
34		private $nOutPeers = 0;
35
36		/**
37		* @var int
38		*/
39		private $nInPeers = 0;
40
41		/**
42		* @param Factory $factory
43		* @param bool\|false $requestRelay
44		*/
45	12	public function __construct(Factory $factory, $requestRelay = false)
46		{
47	12	$this->peerFactory = $factory;
48	12	$this->requestRelay = $requestRelay;
49	12	}
50
51		/**
52		* Store the newly connected peer, and trigger a new connection if they go away.
53		*
54		* @param Peer $peer
55		* @return Peer
56		*/
57	6	public function registerOutboundPeer(Peer $peer)
58		{
59	6	$next = $this->nOutPeers++;
60		$peer->on('close', function ($peer) use ($next) {
61	3	$this->emit('disconnect', [$peer]);
62	3	unset($this->outPeers[$next]);
63	6	});
64
65	6	$this->outPeers[$next] = $peer;
66	6	$this->emit('outbound', [$peer]);
67	6	return $peer;
68		}
69
70		/**
71		* @param Peer $peer
72		*/
73	3	public function registerInboundPeer(Peer $peer)
74		{
75	3	$next = $this->nInPeers++;
76	3	$this->inPeers[$next] = $peer;
77		$peer->on('close', function () use ($next) {
78		unset($this->inPeers[$next]);
79	3	});
80	3	$this->emit('inbound', [$peer]);
81	3	}
82
83		/**
84		* @param Listener $listener
85		* @return $this
86		*/
87	3	public function registerListener(Listener $listener)
88		{
89		$listener->on('connection', function (Peer $peer) {
90	3	$this->registerInboundPeer($peer);
91	3	});
92
93	3	return $this;
94		}
95
96		/**
97		* @param Recorder $recorder
98		*/
99		public function registerRecorder(Recorder $recorder)
100		{
101		$this->on('outbound', function (Peer $peer) use ($recorder) {
102		$recorder->save($peer->getRemoteAddr());
103		});
104		}
105
106		/**
107		* @param PacketHandler $packetHandler
108		*/
109		public function registerHandler(PacketHandler $packetHandler)
110		{
111		$attach = function ($connectionType) use ($packetHandler) {
112		return function (Peer $peer) use ($connectionType, $packetHandler) {
113		$packetHandler->emit($connectionType, [$peer]);
114		};
115		};
116
117		$this->on('inbound', $attach('inbound'));
118		$this->on('outbound', $attach('outbound'));
119		}
120
121		/**
122		* @param NetworkAddressInterface $address
123		* @return \React\Promise\Promise\|\React\Promise\PromiseInterface
124		* @throws \Exception
125		*/
126	6	public function connect(NetworkAddressInterface $address)
127		{
128	6	$peer = $this->peerFactory->getPeer();
129	6	if ($this->requestRelay) {
130	3	$peer->requestRelay();
131	3	}
132
133	6	$deferred = new Deferred();
134		$peer
135	6	->connect($this->peerFactory->getConnector(), $address)
136	6	->then(
137		function ($peer) use ($deferred) {
138	6	$deferred->resolve($peer);
139	6	},
140		function () use ($deferred) {
141	3	$deferred->reject();
142	3	}
143	6	);
144
145	6	return $deferred->promise();
146		}
147
148		/**
149		* @param Locator $locator
150		* @return \React\Promise\ExtendedPromiseInterface\|\React\Promise\Promise\|static
151		*/
152	6	public function connectNextPeer(Locator $locator)
153		{
154	6	$deferred = new Deferred();
155
156		// Otherwise, rely on the Locator.
157		try {
158	6	$deferred->resolve($locator->popAddress());
159	6	} catch (\Exception $e) {
160	1	$locator->queryDnsSeeds()->then(
161		function () use ($deferred, $locator) {
162	1	$deferred->resolve($locator->popAddress());
163	1	}
164	1	);
165		}
166
167		return $deferred
		0 ignored issues – show Bug introduced 2015-11-30 23:16 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...
168	6	->promise()
169	6	->then(
170		function (NetworkAddressInterface $address) {
171	6	return $this->connect($address)->then(
172		function (Peer $peer) {
173	6	$this->registerOutboundPeer($peer);
174	6	return $peer;
175		}
176	6	);
177		}
178	6	)
179	6	->otherwise(function () use ($locator) {
180	3	return $this->connectNextPeer($locator);
181	6	});
182		}
183
184		/**
185		* Create $n connections to clients available in the PeerLocator
186		* @param int $n
187		*
188		* @param Locator $locator
189		* @param $n
190		* @return null\|\React\Promise\FulfilledPromise\|\React\Promise\Promise\|\React\Promise\PromiseInterface\|\React\Promise\RejectedPromise\|static
191		*/
192	3	public function connectToPeers(Locator $locator, $n)
193		{
194	3	$peers = [];
195	3	for ($i = 0; $i < $n; $i++) {
196	3	$peers[$i] = $this->connectNextPeer($locator);
197	3	}
198
199	3	return \React\Promise\all($peers);
200		}
201		}
202

Bit-Wasp / bitcoin-p2p-php

Push — master ( 1c3099...b9c07c )

Manager::connectToPeers() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like