SessionMiddleware::fetchSessionDataFromCache() - Code Metrics - Inspection of "react/cache 0.5" - WyriHaximus/reactphp-http-middleware-session - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Cees-Jan

created 2018-09-02 20:55 UTC

SessionMiddleware::fetchSessionDataFromCache() A

↳ Parent: SessionMiddleware

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0987

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	7
cts	9
cp	0.7778
rs	9.7333
c	0
b	0
f	0
cc	3
nc	2
nop	1
crap	3.0987

<?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';

    const DEFAULT_COOKIE_PARAMS = [
        0,
        '',
        '',
        false,
        false,
    ];

    /**
     * @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
     * @param SessionIdInterface|null $sessionId
     */
    public function __construct(
        string $cookieName,
        CacheInterface $cache,
        array $cookieParams = [],
        SessionIdInterface $sessionId = null
    ) {
        $this->cookieName = $cookieName;
        $this->cache = $cache;
        $this->cookieParams = array_replace(self::DEFAULT_COOKIE_PARAMS, $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) {
            $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) {
                return $this->updateCache($session)->then(function () use ($response) {
                    return $response;
                });
            })->then(function ($response) use ($session) {
                $cookie = $this->getCookie($session);
                $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
    {
        if ($id === '') {
            return resolve([]);
        }

        return $this->cache->get($id)->then(function ($result) {
            if ($result === null) {
                return resolve([]);
            }

            return $result;
        }, function () {
            return resolve([]);
        });
    }

    private function updateCache(Session $session): PromiseInterface
    {
        foreach ($session->getOldIds() as $oldId) {
            $this->cache->delete($oldId);
        }

        if ($session->isActive()) {
            return resolve($this->cache->set($session->getId(), $session->getContents()));
        }

        return resolve();
    }

    private function getCookie(Session $session): SetCookie
    {
        $cookieParams = $this->cookieParams;

        if ($session->isActive()) {
            // Only set time when expires is set in the future
            if ($cookieParams[0] > 0) {
                $cookieParams[0] += time();
            }

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

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        unset($cookieParams[0]);

        return SetCookie::thatDeletesCookie($this->cookieName, ...$cookieParams);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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


GitHub Access Token became invalid

Pull Request — master (#5)

SessionMiddleware::fetchSessionDataFromCache() 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		const DEFAULT_COOKIE_PARAMS = [
20		0,
21		'',
22		'',
23		false,
24		false,
25		];
26
27		/**
28		* @var string
29		*/
30		private $cookieName;
31
32		/**
33		* @var CacheInterface
34		*/
35		private $cache;
36
37		/**
38		* @var array
39		*/
40		private $cookieParams;
41
42		/**
43		* @var SessionIdInterface
44		*/
45		private $sessionId;
46
47		/**
48		* @param string $cookieName
49		* @param CacheInterface $cache
50		* @param array $cookieParams
51		* @param SessionIdInterface\|null $sessionId
52		*/
53	12	public function __construct(
54		string $cookieName,
55		CacheInterface $cache,
56		array $cookieParams = [],
57		SessionIdInterface $sessionId = null
58		) {
59	12	$this->cookieName = $cookieName;
60	12	$this->cache = $cache;
61	12	$this->cookieParams = array_replace(self::DEFAULT_COOKIE_PARAMS, $cookieParams);
62
63	12	if ($sessionId === null) {
64	12	$sessionId = new RandomBytes();
65		}
66	12	$this->sessionId = $sessionId;
67	12	}
68
69		public function __invoke(ServerRequestInterface $request, callable $next)
70		{
71	12	return $this->fetchSessionFromRequest($request)->then(function (Session $session) use ($next, $request) {
72	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...
73
74	12	return resolve(
75	12	$next($request)
76		)->then(function (ResponseInterface $response) use ($session) {
77	12	return $this->updateCache($session)->then(function () use ($response) {
78	12	return $response;
79	12	});
80		})->then(function ($response) use ($session) {
81	12	$cookie = $this->getCookie($session);
82	12	$response = $cookie->addToResponse($response);
83
84	12	return $response;
85	12	});
86	12	});
87		}
88
89	12	private function fetchSessionFromRequest(ServerRequestInterface $request): PromiseInterface
90		{
91	12	$id = '';
92	12	$cookies = RequestCookies::createFromRequest($request);
93
94		try {
95	12	if (!$cookies->has($this->cookieName)) {
96	10	return resolve(new Session($id, [], $this->sessionId));
97		}
98	2	$id = $cookies->get($this->cookieName)->getValue();
99
100	2	return $this->fetchSessionDataFromCache($id)->then(function (array $sessionData) use ($id) {
101	2	return new Session($id, $sessionData, $this->sessionId);
102	2	});
103		} catch (Throwable $et) {
104		// Do nothing, only a not found will be thrown so generating our own id now
105		}
106
107		return resolve(new Session($id, [], $this->sessionId));
108		}
109
110	2	private function fetchSessionDataFromCache(string $id): PromiseInterface
111		{
112	2	if ($id === '') {
113		return resolve([]);
114		}
115
116	2	return $this->cache->get($id)->then(function ($result) {
117	2	if ($result === null) {
118	1	return resolve([]);
119		}
120
121	1	return $result;
122		}, function () {
123		return resolve([]);
124	2	});
125		}
126
127	12	private function updateCache(Session $session): PromiseInterface
128		{
129	12	foreach ($session->getOldIds() as $oldId) {
130	1	$this->cache->delete($oldId);
131		}
132
133	12	if ($session->isActive()) {
134	10	return resolve($this->cache->set($session->getId(), $session->getContents()));
135		}
136
137	2	return resolve();
138		}
139
140	12	private function getCookie(Session $session): SetCookie
141		{
142	12	$cookieParams = $this->cookieParams;
143
144	12	if ($session->isActive()) {
145		// Only set time when expires is set in the future
146	10	if ($cookieParams[0] > 0) {
147	8	$cookieParams[0] += time();
148		}
149
150	10	return new SetCookie($this->cookieName, $session->getId(), ...$cookieParams);
		0 ignored issues – show Documentation introduced 2018-01-28 18:54 UTC by Report Bug Copy Issue Report `$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...
151		}
152	2	unset($cookieParams[0]);
153
154	2	return SetCookie::thatDeletesCookie($this->cookieName, ...$cookieParams);
		0 ignored issues – show Documentation introduced 2018-01-28 18:54 UTC by Report Bug Copy Issue Report `$cookieParams` is of type `array`, but the function expects a `string`. 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...
155		}
156		}
157

WyriHaximus / reactphp-http-middleware-session

GitHub Access Token became invalid

Pull Request — master (#5)

SessionMiddleware::fetchSessionDataFromCache() 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