WIP [HttpFoundation] Add RedisSessionHandler

dkarlovi · dkarlovi · commit 35931bdc5843 · 2017-11-01T18:54:48.000+01:00
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/RedisSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/RedisSessionHandler.php
@@ -41,26 +41,25 @@ class RedisSessionHandler extends AbstractSessionHandler
 
     /**
      * List of available options:
-     *  * prefix: The prefix to use for the Redis keys in order to avoid collision
-     *  * expiretime: The time to live in seconds.
+     *  * prefix: The prefix to use for the keys in order to avoid collision
+     *  * expiretime: The time to live in seconds. Defaults to 1 day.
      *
-     * @param \Redis $redis   A \Redis instance
-     * @param array  $options An associative array of Redis options
+     * @param \Redis     $redis   A \Redis instance
+     * @param null|array $options An associative array of options
      *
      * @throws \InvalidArgumentException When unsupported options are passed
      */
-    public function __construct(\Redis $redis, array $options = null)
+    public function __construct(\Redis $redis, ?array $options = null)
     {
         $this->redis = $redis;
+        $options = (array) $options;
 
         if ($diff = array_diff(array_keys($options), array('prefix', 'expiretime'))) {
-            throw new \InvalidArgumentException(sprintf(
-                'The following options are not supported "%s"', implode(', ', $diff)
-            ));
+            throw new \InvalidArgumentException(sprintf('The following options are not supported "%s"', implode(', ', $diff)));
         }
 
         $this->ttl = isset($options['expiretime']) ? (int) $options['expiretime'] : 86400;
-        $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'sf2s';
+        $this->prefix = $options['prefix'] ?? 'sf_s';
     }
 
     /**
@@ -76,18 +75,17 @@ protected function doRead($sessionId)
      */
     protected function doWrite($sessionId, $data)
     {
-        return $this->redis->set($this->prefix.$sessionId, $data, $this->ttl);
+        return $this->redis->setEx($this->prefix.$sessionId, $this->ttl, $data);
     }
 
     /**
      * {@inheritdoc}
      */
     protected function doDestroy($sessionId)
     {
-        // number of deleted items
-        $count = $this->redis->del($this->prefix.$sessionId);
+        $this->redis->delete($this->prefix.$sessionId);
 
-        return 1 === $count;
+        return true;
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Handler/RedisSessionHandlerTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Handler/RedisSessionHandlerTest.php
@@ -29,7 +29,7 @@ class RedisSessionHandlerTest extends TestCase
     protected $storage;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|\Redis $redis
+     * @var \PHPUnit_Framework_MockObject_MockObject|\Redis
      */
     protected $redis;
 
@@ -76,8 +76,8 @@ public function testWriteSession()
     {
         $this->redis
             ->expects($this->once())
-            ->method('set')
-            ->with(self::PREFIX.'id', 'data', self::TTL)
+            ->method('setEx')
+            ->with(self::PREFIX.'id', self::TTL, 'data')
             ->will($this->returnValue(true))
         ;
 
@@ -88,7 +88,7 @@ public function testDestroySession()
     {
         $this->redis
             ->expects($this->once())
-            ->method('del')
+            ->method('delete')
             ->with(self::PREFIX.'id')
             ->will($this->returnValue(1))
         ;

Original file line number	Diff line number	Diff line change
`@@ -41,26 +41,25 @@ class RedisSessionHandler extends AbstractSessionHandler`
`41`	`41`
`42`	`42`	`/**`
`43`	`43`	`* List of available options:`
`44`		`- * * prefix: The prefix to use for the Redis keys in order to avoid collision`
`45`		`- * * expiretime: The time to live in seconds.`
	`44`	`+ * * prefix: The prefix to use for the keys in order to avoid collision`
	`45`	`+ * * expiretime: The time to live in seconds. Defaults to 1 day.`
`46`	`46`	`*`
`47`		`- * @param \Redis $redis A \Redis instance`
`48`		`- * @param array $options An associative array of Redis options`
	`47`	`+ * @param \Redis $redis A \Redis instance`
	`48`	`+ * @param null\|array $options An associative array of options`
`49`	`49`	`*`
`50`	`50`	`* @throws \InvalidArgumentException When unsupported options are passed`
`51`	`51`	`*/`
`52`		`- public function __construct(\Redis $redis, array $options = null)`
	`52`	`+ public function __construct(\Redis $redis, ?array $options = null)`
`53`	`53`	`{`
`54`	`54`	`$this->redis = $redis;`
	`55`	`+ $options = (array) $options;`
`55`	`56`
`56`	`57`	`if ($diff = array_diff(array_keys($options), array('prefix', 'expiretime'))) {`
`57`		`- throw new \InvalidArgumentException(sprintf(`
`58`		`- 'The following options are not supported "%s"', implode(', ', $diff)`
`59`		`- ));`
	`58`	`+ throw new \InvalidArgumentException(sprintf('The following options are not supported "%s"', implode(', ', $diff)));`
`60`	`59`	`}`
`61`	`60`
`62`	`61`	`$this->ttl = isset($options['expiretime']) ? (int) $options['expiretime'] : 86400;`
`63`		`- $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'sf2s';`
	`62`	`+ $this->prefix = $options['prefix'] ?? 'sf_s';`
`64`	`63`	`}`
`65`	`64`
`66`	`65`	`/**`
`@@ -76,18 +75,17 @@ protected function doRead($sessionId)`
`76`	`75`	`*/`
`77`	`76`	`protected function doWrite($sessionId, $data)`
`78`	`77`	`{`
`79`		`- return $this->redis->set($this->prefix.$sessionId, $data, $this->ttl);`
	`78`	`+ return $this->redis->setEx($this->prefix.$sessionId, $this->ttl, $data);`
`80`	`79`	`}`
`81`	`80`
`82`	`81`	`/**`
`83`	`82`	`* {@inheritdoc}`
`84`	`83`	`*/`
`85`	`84`	`protected function doDestroy($sessionId)`
`86`	`85`	`{`
`87`		`- // number of deleted items`
`88`		`- $count = $this->redis->del($this->prefix.$sessionId);`
	`86`	`+ $this->redis->delete($this->prefix.$sessionId);`
`89`	`87`
`90`		`- return 1 === $count;`
	`88`	`+ return true;`
`91`	`89`	`}`
`92`	`90`
`93`	`91`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class RedisSessionHandlerTest extends TestCase`
`29`	`29`	`protected $storage;`
`30`	`30`
`31`	`31`	`/**`
`32`		`- * @var \PHPUnit_Framework_MockObject_MockObject\|\Redis $redis`
	`32`	`+ * @var \PHPUnit_Framework_MockObject_MockObject\|\Redis`
`33`	`33`	`*/`
`34`	`34`	`protected $redis;`
`35`	`35`
`@@ -76,8 +76,8 @@ public function testWriteSession()`
`76`	`76`	`{`
`77`	`77`	`$this->redis`
`78`	`78`	`->expects($this->once())`
`79`		`- ->method('set')`
`80`		`- ->with(self::PREFIX.'id', 'data', self::TTL)`
	`79`	`+ ->method('setEx')`
	`80`	`+ ->with(self::PREFIX.'id', self::TTL, 'data')`
`81`	`81`	`->will($this->returnValue(true))`
`82`	`82`	`;`
`83`	`83`
`@@ -88,7 +88,7 @@ public function testDestroySession()`
`88`	`88`	`{`
`89`	`89`	`$this->redis`
`90`	`90`	`->expects($this->once())`
`91`		`- ->method('del')`
	`91`	`+ ->method('delete')`
`92`	`92`	`->with(self::PREFIX.'id')`
`93`	`93`	`->will($this->returnValue(1))`
`94`	`94`	`;`