SessionMonitor::getSessionInfo() - Code Metrics - Inspection of "Develop" - tidal/WampWatch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Timo

created 2016-07-11 01:35 UTC

SessionMonitor::getSessionInfo() A

↳ Parent: SessionMonitor

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
c	4
b	1
f	1
dl	0
loc	12
rs	9.4285
cc	1
eloc	7
nc	1
nop	2

<?php

namespace Tidal\WampWatch;

/*
 * Copyright 2015 Timo.
 *
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 */

use Evenement\EventEmitterInterface;
use Tidal\WampWatch\ClientSessionInterface as ClientSession;


/**
 * Description of SessionMonitor.
 *
 * @author Timo
 */
class SessionMonitor implements MonitorInterface, EventEmitterInterface
{
    use
        MonitorTrait {
            start as doStart;
            stop as doStop;
        }

    const SESSION_JOIN_TOPIC = 'wamp.session.on_join';
    const SESSION_LEAVE_TOPIC = 'wamp.session.on_leave';
    const SESSION_COUNT_TOPIC = 'wamp.session.count';
    const SESSION_LIST_TOPIC = 'wamp.session.list';
    const SESSION_INFO_TOPIC = 'wamp.session.get';


    protected $sessionIds = [];


    /**
     * Constructor.
     *
     * @param ClientSession $session
     */
    public function __construct(ClientSession $session)
    {
        $this->setClientSession($session);
    }

    /**
     * Start the monitor.
     *
     * @return bool
     */
    public function start()
    {
        $this->once('list', function () {
            $this->doStart();
        });
        $this->startSubscriptions();
        $this->retrieveSessionIds();

        return true;
    }

    /**
     * Stop the monitor.
     * Returns boolean wether the monitor could be started.
     *
     * @return bool
     */
    public function stop()
    {
        $this->stopSubscriptions();
        $this->doStop();

        return true;
    }

    /**
     * Retrieves the session-info for given sessionId
     * and populates it in via given callback
     *
     * @param          $sessionId
     * @param callable $callback
     * @return mixed
     */
    public function getSessionInfo($sessionId, callable $callback)
    {
        return $this->session->call(self::SESSION_INFO_TOPIC, [$sessionId])->then(
            function ($res) use ($callback) {
                $this->emit('info', [$res[0]]);
                $callback($res[0]);
            },
            function ($error) {
                $this->emit('error', [$error]);
            }
        );
    }

    /**
     * Retrieves the Ids of the sessions currently
     * registered on the wamp-router in the monitor's realm
     * and populates the data via given callback,
     *
     * @param callable $callback
     * @return mixed
     */
    public function getSessionIds(callable $callback)
    {
        if (!count($this->sessionIds)) {
            $this->retrieveSessionIds($callback);
        } else {
            $callback($this->sessionIds);
        }
    }

    /**
     * Initializes the subscription to the meta-events
     */
    protected function startSubscriptions()
    {
        $this->session->subscribe(self::SESSION_JOIN_TOPIC, function ($res) {

            $sessionInfo = $res[0];
            $sessionId = $sessionInfo->session;
            if ((array_search($sessionId, $this->sessionIds)) === false) {
                $this->sessionIds[] = $sessionId;
                $this->emit('join', [$sessionInfo]);
            }
        });
        $this->session->subscribe(self::SESSION_LEAVE_TOPIC, function ($res) {

            // @bug : wamp.session.on_leave is bugged as of crossbar.io 0.11.0
            // will provide sessionID when Browser closes/reloads,
            // but not when calling connection.close();
            $sessionId = $res[0];
            if (($key = array_search($sessionId, $this->sessionIds)) !== false) {
                unset($this->sessionIds[$key]);
                $this->emit('leave', [$sessionId]);
            }
        });
    }

    /**
     * Unsubscribes from the meta-events.
     */
    protected function stopSubscriptions()
    {
        Util::unsubscribe($this->session, self::SESSION_JOIN_TOPIC);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        Util::unsubscribe($this->session, self::SESSION_LEAVE_TOPIC);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Retrieves the list of current sessionIds on the router.
     *
     * @param callable|null $callback
     */
    protected function retrieveSessionIds(callable $callback = null)
    {
        $this->session->call(self::SESSION_LIST_TOPIC, [])->then(
            function ($res) use ($callback) {
                // remove our own sessionID from the tracked sessions
                $sessionIds = $this->removeOwnSessionId($res[0]);
                $this->setList($sessionIds);
                $this->emit('list', [$this->getList()]);
                if($callback !== null){
                    $callback($this->sessionIds);
                }
            },
            function ($error) {
                $this->emit('error', [$error]);
            }
        );
    }


    protected function setList($list)
    {
        $this->sessionIds = $list;
    }

    protected function getList()
    {
        return $this->sessionIds;
    }

    /**
     * remove the sessionID of the Monitor from the list
     * @param array $sessionsIds
     * @return mixed
     */
    protected function removeOwnSessionId(array $sessionsIds)
    {
        $key = array_search($this->session->getSessionId(), $sessionsIds);
        if($key >= 0){
            unset($sessionsIds[$key]);
        }

        return $sessionsIds;
    }
}


1		<?php
2
3		namespace Tidal\WampWatch;
4
5		/*
6		* Copyright 2015 Timo.
7		*
8		* For the full copyright and license information, please view the LICENSE file
9		* that was distributed with this source code.
10		*/
11
12		use Evenement\EventEmitterInterface;
13		use Tidal\WampWatch\ClientSessionInterface as ClientSession;
14
15
16		/**
17		* Description of SessionMonitor.
18		*
19		* @author Timo
20		*/
21		class SessionMonitor implements MonitorInterface, EventEmitterInterface
22		{
23		use
24		MonitorTrait {
25		start as doStart;
26		stop as doStop;
27		}
28
29		const SESSION_JOIN_TOPIC = 'wamp.session.on_join';
30		const SESSION_LEAVE_TOPIC = 'wamp.session.on_leave';
31		const SESSION_COUNT_TOPIC = 'wamp.session.count';
32		const SESSION_LIST_TOPIC = 'wamp.session.list';
33		const SESSION_INFO_TOPIC = 'wamp.session.get';
34
35
36		protected $sessionIds = [];
37
38
39		/**
40		* Constructor.
41		*
42		* @param ClientSession $session
43		*/
44		public function __construct(ClientSession $session)
45		{
46		$this->setClientSession($session);
47		}
48
49		/**
50		* Start the monitor.
51		*
52		* @return bool
53		*/
54		public function start()
55		{
56		$this->once('list', function () {
57		$this->doStart();
58		});
59		$this->startSubscriptions();
60		$this->retrieveSessionIds();
61
62		return true;
63		}
64
65		/**
66		* Stop the monitor.
67		* Returns boolean wether the monitor could be started.
68		*
69		* @return bool
70		*/
71		public function stop()
72		{
73		$this->stopSubscriptions();
74		$this->doStop();
75
76		return true;
77		}
78
79		/**
80		* Retrieves the session-info for given sessionId
81		* and populates it in via given callback
82		*
83		* @param $sessionId
84		* @param callable $callback
85		* @return mixed
86		*/
87		public function getSessionInfo($sessionId, callable $callback)
88		{
89		return $this->session->call(self::SESSION_INFO_TOPIC, [$sessionId])->then(
90		function ($res) use ($callback) {
91		$this->emit('info', [$res[0]]);
92		$callback($res[0]);
93		},
94		function ($error) {
95		$this->emit('error', [$error]);
96		}
97		);
98		}
99
100		/**
101		* Retrieves the Ids of the sessions currently
102		* registered on the wamp-router in the monitor's realm
103		* and populates the data via given callback,
104		*
105		* @param callable $callback
106		* @return mixed
107		*/
108		public function getSessionIds(callable $callback)
109		{
110		if (!count($this->sessionIds)) {
111		$this->retrieveSessionIds($callback);
112		} else {
113		$callback($this->sessionIds);
114		}
115		}
116
117		/**
118		* Initializes the subscription to the meta-events
119		*/
120		protected function startSubscriptions()
121		{
122	View Code Duplication	$this->session->subscribe(self::SESSION_JOIN_TOPIC, function ($res) {
		0 ignored issues – show Duplication introduced 2016-06-28 17:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123		$sessionInfo = $res[0];
124		$sessionId = $sessionInfo->session;
125		if ((array_search($sessionId, $this->sessionIds)) === false) {
126		$this->sessionIds[] = $sessionId;
127		$this->emit('join', [$sessionInfo]);
128		}
129		});
130	View Code Duplication	$this->session->subscribe(self::SESSION_LEAVE_TOPIC, function ($res) {
		0 ignored issues – show Duplication introduced 2016-06-28 17:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
131		// @bug : wamp.session.on_leave is bugged as of crossbar.io 0.11.0
132		// will provide sessionID when Browser closes/reloads,
133		// but not when calling connection.close();
134		$sessionId = $res[0];
135		if (($key = array_search($sessionId, $this->sessionIds)) !== false) {
136		unset($this->sessionIds[$key]);
137		$this->emit('leave', [$sessionId]);
138		}
139		});
140		}
141
142		/**
143		* Unsubscribes from the meta-events.
144		*/
145		protected function stopSubscriptions()
146		{
147		Util::unsubscribe($this->session, self::SESSION_JOIN_TOPIC);
		0 ignored issues – show Documentation introduced 2016-07-11 01:42 UTC by Report Bug Copy Issue Report `$this->session` is of type `object<Tidal\WampWatch\ClientSessionInterface>`, but the function expects a `object<Thruway\ClientSession>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-07-11 01:42 UTC by Report Bug Copy Issue Report The call to `Util::unsubscribe()` has too many arguments starting with `self::SESSION_JOIN_TOPIC`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
148		Util::unsubscribe($this->session, self::SESSION_LEAVE_TOPIC);
		0 ignored issues – show Documentation introduced 2016-07-11 01:42 UTC by Report Bug Copy Issue Report `$this->session` is of type `object<Tidal\WampWatch\ClientSessionInterface>`, but the function expects a `object<Thruway\ClientSession>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-07-11 01:42 UTC by Report Bug Copy Issue Report The call to `Util::unsubscribe()` has too many arguments starting with `self::SESSION_LEAVE_TOPIC`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
149		}
150
151		/**
152		* Retrieves the list of current sessionIds on the router.
153		*
154		* @param callable\|null $callback
155		*/
156		protected function retrieveSessionIds(callable $callback = null)
157		{
158		$this->session->call(self::SESSION_LIST_TOPIC, [])->then(
159		function ($res) use ($callback) {
160		// remove our own sessionID from the tracked sessions
161		$sessionIds = $this->removeOwnSessionId($res[0]);
162		$this->setList($sessionIds);
163		$this->emit('list', [$this->getList()]);
164		if($callback !== null){
165		$callback($this->sessionIds);
166		}
167		},
168		function ($error) {
169		$this->emit('error', [$error]);
170		}
171		);
172		}
173
174
175		protected function setList($list)
176		{
177		$this->sessionIds = $list;
178		}
179
180		protected function getList()
181		{
182		return $this->sessionIds;
183		}
184
185		/**
186		* remove the sessionID of the Monitor from the list
187		* @param array $sessionsIds
188		* @return mixed
189		*/
190		protected function removeOwnSessionId(array $sessionsIds)
191		{
192		$key = array_search($this->session->getSessionId(), $sessionsIds);
193		if($key >= 0){
194		unset($sessionsIds[$key]);
195		}
196
197		return $sessionsIds;
198		}
199		}
200

tidal / WampWatch

Pull Request — master (#6)

SessionMonitor::getSessionInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like