SessionMiddleware::__invoke() - Code Metrics - Inspection of "Session controll (begin, end, regenerate)" - WyriHaximus/reactphp-http-middleware-session - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Cees-Jan

created 2018-01-27 23:39 UTC

SessionMiddleware::__invoke() A

↳ Parent: SessionMiddleware

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	12
cts	12
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	11
nc	1
nop	2
crap	1

<?php declare(strict_types=1);

namespace WyriHaximus\React\Http\Middleware;

use HansOtt\PSR7Cookies\RequestCookies;
use HansOtt\PSR7Cookies\SetCookie;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use React\Cache\CacheInterface;
use React\Promise\PromiseInterface;
use Throwable;
use WyriHaximus\React\Http\Middleware\SessionId\RandomBytes;
use function React\Promise\resolve;

final class SessionMiddleware
{
    const ATTRIBUTE_NAME = 'wyrihaximus.react.http.middleware.session';

    /**
     * @var string
     */
    private $cookieName = '';

    /**
     * @var CacheInterface
     */
    private $cache;

    /**
     * @var array
     */
    private $cookieParams = [];

    /**
     * @var SessionIdInterface
     */
    private $sessionId;

    /**
     * @param string         $cookieName
     * @param CacheInterface $cache
     * @param array          $cookieParams
     */
    public function __construct(
        string $cookieName,
        CacheInterface $cache,
        array $cookieParams = [],
        SessionIdInterface $sessionId = null
    ) {
        $this->cookieName = $cookieName;
        $this->cache = $cache;
        $this->cookieParams = $cookieParams;

        if ($sessionId === null) {
            $sessionId = new RandomBytes();
        }
        $this->sessionId = $sessionId;
    }

    public function __invoke(ServerRequestInterface $request, callable $next)
    {
        return $this->fetchSessionFromRequest($request)->then(function (Session $session) use ($next, $request) {
            $requestSessionId = $session->getId();
            $request = $request->withAttribute(self::ATTRIBUTE_NAME, $session);
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)

            return resolve(
                $next($request)
            )->then(function (ResponseInterface $response) use ($session, $requestSessionId) {
                $this->updateCache($session->getId(), $requestSessionId, $session->getContents());

                $cookie = new SetCookie($this->cookieName, $session->getId(), ...$this->cookieParams);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $response = $cookie->addToResponse($response);

                return $response;
            });
        });
    }

    private function fetchSessionFromRequest(ServerRequestInterface $request): PromiseInterface
    {
        $id = '';
        $cookies = RequestCookies::createFromRequest($request);

        try {
            if (!$cookies->has($this->cookieName)) {
                return resolve(new Session($id, [], $this->sessionId));
            }

            $id = $cookies->get($this->cookieName)->getValue();

            return $this->fetchSessionDataFromCache($id)->then(function (array $sessionData) use ($id) {
                return new Session($id, $sessionData, $this->sessionId);
            });
        } catch (Throwable $et) {
            // Do nothing, only a not found will be thrown so generating our own id now
        }

        return resolve(new Session($id, [], $this->sessionId));
    }

    private function fetchSessionDataFromCache(string $id): PromiseInterface
    {
        return $this->cache->get($id)->otherwise(function () {
            return resolve([]);
        });
    }

    private function updateCache(string $currentSessionId, string $requestSessionId, array $contents)
    {
        if ($currentSessionId !== '') {
            return $this->cache->set($currentSessionId, $contents);
        }

        if ($currentSessionId === '' && $requestSessionId !== '') {
            return $this->cache->remove($requestSessionId);
        }
    }
}


GitHub Access Token became invalid

Pull Request — master (#2)

SessionMiddleware::__invoke() A

Complexity

Size

Duplication

Code Coverage

Importance

Change not visible in outer-scope

Change visible in outer-scope

1		<?php declare(strict_types=1);
2
3		namespace WyriHaximus\React\Http\Middleware;
4
5		use HansOtt\PSR7Cookies\RequestCookies;
6		use HansOtt\PSR7Cookies\SetCookie;
7		use Psr\Http\Message\ResponseInterface;
8		use Psr\Http\Message\ServerRequestInterface;
9		use React\Cache\CacheInterface;
10		use React\Promise\PromiseInterface;
11		use Throwable;
12		use WyriHaximus\React\Http\Middleware\SessionId\RandomBytes;
13		use function React\Promise\resolve;
14
15		final class SessionMiddleware
16		{
17		const ATTRIBUTE_NAME = 'wyrihaximus.react.http.middleware.session';
18
19		/**
20		* @var string
21		*/
22		private $cookieName = '';
23
24		/**
25		* @var CacheInterface
26		*/
27		private $cache;
28
29		/**
30		* @var array
31		*/
32		private $cookieParams = [];
33
34		/**
35		* @var SessionIdInterface
36		*/
37		private $sessionId;
38
39		/**
40		* @param string $cookieName
41		* @param CacheInterface $cache
42		* @param array $cookieParams
43		*/
44	12	public function __construct(
45		string $cookieName,
46		CacheInterface $cache,
47		array $cookieParams = [],
48		SessionIdInterface $sessionId = null
49		) {
50	12	$this->cookieName = $cookieName;
51	12	$this->cache = $cache;
52	12	$this->cookieParams = $cookieParams;
53
54	12	if ($sessionId === null) {
55	12	$sessionId = new RandomBytes();
56		}
57	12	$this->sessionId = $sessionId;
58	12	}
59
60		public function __invoke(ServerRequestInterface $request, callable $next)
61		{
62	12	return $this->fetchSessionFromRequest($request)->then(function (Session $session) use ($next, $request) {
63	12	$requestSessionId = $session->getId();
64	12	$request = $request->withAttribute(self::ATTRIBUTE_NAME, $session);
		0 ignored issues – show Bug introduced 2018-01-22 09:17 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$request`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
65
66	12	return resolve(
67	12	$next($request)
68	12	)->then(function (ResponseInterface $response) use ($session, $requestSessionId) {
69	12	$this->updateCache($session->getId(), $requestSessionId, $session->getContents());
70
71	12	$cookie = new SetCookie($this->cookieName, $session->getId(), ...$this->cookieParams);
		0 ignored issues – show Documentation introduced 2018-01-27 20:27 UTC by Report Bug Copy Issue Report `$this->cookieParams` is of type `array`, but the function expects a `integer`. 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...
72	12	$response = $cookie->addToResponse($response);
73
74	12	return $response;
75	12	});
76	12	});
77		}
78
79	12	private function fetchSessionFromRequest(ServerRequestInterface $request): PromiseInterface
80		{
81	12	$id = '';
82	12	$cookies = RequestCookies::createFromRequest($request);
83
84		try {
85	12	if (!$cookies->has($this->cookieName)) {
86	10	return resolve(new Session($id, [], $this->sessionId));
87		}
88
89	2	$id = $cookies->get($this->cookieName)->getValue();
90
91	2	return $this->fetchSessionDataFromCache($id)->then(function (array $sessionData) use ($id) {
92	2	return new Session($id, $sessionData, $this->sessionId);
93	2	});
94		} catch (Throwable $et) {
95		// Do nothing, only a not found will be thrown so generating our own id now
96		}
97
98		return resolve(new Session($id, [], $this->sessionId));
99		}
100
101		private function fetchSessionDataFromCache(string $id): PromiseInterface
102		{
103	2	return $this->cache->get($id)->otherwise(function () {
104	2	return resolve([]);
105	2	});
106		}
107
108	12	private function updateCache(string $currentSessionId, string $requestSessionId, array $contents)
109		{
110	12	if ($currentSessionId !== '') {
111	2	return $this->cache->set($currentSessionId, $contents);
112		}
113
114	10	if ($currentSessionId === '' && $requestSessionId !== '') {
115	1	return $this->cache->remove($requestSessionId);
116		}
117	9	}
118		}
119

WyriHaximus / reactphp-http-middleware-session

GitHub Access Token became invalid

Pull Request — master (#2)

SessionMiddleware::__invoke() A

Complexity

Size

Duplication

Code Coverage

Importance

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like