feature #34405 [HttpFoundation] Added possibility to configure expiration time in redis session handler (mantulo)

fabpot · fabpot · commit 2b05b71999b9 · 2019-11-17T11:00:25.000+01:00
This PR was squashed before being merged into the 4.4 branch (closes #34405). Discussion ---------- [HttpFoundation] Added possibility to configure expiration time in redis session handler | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a Add possibility to manually configure expiration time in redis session handler. Commits ------- 4a9d947 [HttpFoundation] Added possibility to configure expiration time in redis session handler
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/RedisSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/RedisSessionHandler.php
@@ -30,9 +30,15 @@ class RedisSessionHandler extends AbstractSessionHandler
      */
     private $prefix;
 
+    /**
+     * @var int Time to live in seconds
+     */
+    private $ttl;
+
     /**
      * List of available options:
-     *  * prefix: The prefix to use for the keys in order to avoid collision on the Redis server.
+     *  * prefix: The prefix to use for the keys in order to avoid collision on the Redis server
+     *  * ttl: The time to live in seconds.
      *
      * @param \Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface|RedisProxy|RedisClusterProxy $redis
      *
@@ -51,12 +57,13 @@ public function __construct($redis, array $options = [])
             throw new \InvalidArgumentException(sprintf('%s() expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, %s given', __METHOD__, \is_object($redis) ? \get_class($redis) : \gettype($redis)));
         }
 
-        if ($diff = array_diff(array_keys($options), ['prefix'])) {
+        if ($diff = array_diff(array_keys($options), ['prefix', 'ttl'])) {
             throw new \InvalidArgumentException(sprintf('The following options are not supported "%s"', implode(', ', $diff)));
         }
 
         $this->redis = $redis;
         $this->prefix = $options['prefix'] ?? 'sf_s';
+        $this->ttl = $options['ttl'] ?? (int) ini_get('session.gc_maxlifetime');
     }
 
     /**
@@ -72,7 +79,7 @@ protected function doRead($sessionId): string
      */
     protected function doWrite($sessionId, $data): bool
     {
-        $result = $this->redis->setEx($this->prefix.$sessionId, (int) ini_get('session.gc_maxlifetime'), $data);
+        $result = $this->redis->setEx($this->prefix.$sessionId, $this->ttl, $data);
 
         return $result && !$result instanceof ErrorInterface;
     }
@@ -108,6 +115,6 @@ public function gc($maxlifetime): bool
      */
     public function updateTimestamp($sessionId, $data)
     {
-        return (bool) $this->redis->expire($this->prefix.$sessionId, (int) ini_get('session.gc_maxlifetime'));
+        return (bool) $this->redis->expire($this->prefix.$sessionId, $this->ttl);
     }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Handler/AbstractRedisSessionHandlerTestCase.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Handler/AbstractRedisSessionHandlerTestCase.php
@@ -139,7 +139,37 @@ public function getOptionFixtures(): array
     {
         return [
             [['prefix' => 'session'], true],
+            [['ttl' => 1000], true],
+            [['prefix' => 'sfs', 'ttl' => 1000], true],
             [['prefix' => 'sfs', 'foo' => 'bar'], false],
+            [['ttl' => 'sfs', 'foo' => 'bar'], false],
+        ];
+    }
+
+    /**
+     * @dataProvider getTtlFixtures
+     */
+    public function testUseTtlOption(int $ttl)
+    {
+        $options = [
+            'prefix' => self::PREFIX,
+            'ttl' => $ttl,
+        ];
+
+        $handler = new RedisSessionHandler($this->redisClient, $options);
+        $handler->write('id', 'data');
+        $redisTtl = $this->redisClient->ttl(self::PREFIX.'id');
+
+        $this->assertLessThan($redisTtl, $ttl - 5);
+        $this->assertGreaterThan($redisTtl, $ttl + 5);
+    }
+
+    public function getTtlFixtures(): array
+    {
+        return [
+            ['ttl' => 5000],
+            ['ttl' => 120],
+            ['ttl' => 60],
         ];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,15 @@ class RedisSessionHandler extends AbstractSessionHandler`
`30`	`30`	`*/`
`31`	`31`	`private $prefix;`
`32`	`32`
	`33`	`+ /**`
	`34`	`+ * @var int Time to live in seconds`
	`35`	`+ */`
	`36`	`+ private $ttl;`
	`37`	`+`
`33`	`38`	`/**`
`34`	`39`	`* List of available options:`
`35`		`- * * prefix: The prefix to use for the keys in order to avoid collision on the Redis server.`
	`40`	`+ * * prefix: The prefix to use for the keys in order to avoid collision on the Redis server`
	`41`	`+ * * ttl: The time to live in seconds.`
`36`	`42`	`*`
`37`	`43`	`* @param \Redis\|\RedisArray\|\RedisCluster\|\Predis\ClientInterface\|RedisProxy\|RedisClusterProxy $redis`
`38`	`44`	`*`
`@@ -51,12 +57,13 @@ public function __construct($redis, array $options = [])`
`51`	`57`	`throw new \InvalidArgumentException(sprintf('%s() expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, %s given', __METHOD__, \is_object($redis) ? \get_class($redis) : \gettype($redis)));`
`52`	`58`	`}`
`53`	`59`
`54`		`- if ($diff = array_diff(array_keys($options), ['prefix'])) {`
	`60`	`+ if ($diff = array_diff(array_keys($options), ['prefix', 'ttl'])) {`
`55`	`61`	`throw new \InvalidArgumentException(sprintf('The following options are not supported "%s"', implode(', ', $diff)));`
`56`	`62`	`}`
`57`	`63`
`58`	`64`	`$this->redis = $redis;`
`59`	`65`	`$this->prefix = $options['prefix'] ?? 'sf_s';`
	`66`	`+ $this->ttl = $options['ttl'] ?? (int) ini_get('session.gc_maxlifetime');`
`60`	`67`	`}`
`61`	`68`
`62`	`69`	`/**`
`@@ -72,7 +79,7 @@ protected function doRead($sessionId): string`
`72`	`79`	`*/`
`73`	`80`	`protected function doWrite($sessionId, $data): bool`
`74`	`81`	`{`
`75`		`- $result = $this->redis->setEx($this->prefix.$sessionId, (int) ini_get('session.gc_maxlifetime'), $data);`
	`82`	`+ $result = $this->redis->setEx($this->prefix.$sessionId, $this->ttl, $data);`
`76`	`83`
`77`	`84`	`return $result && !$result instanceof ErrorInterface;`
`78`	`85`	`}`
`@@ -108,6 +115,6 @@ public function gc($maxlifetime): bool`
`108`	`115`	`*/`
`109`	`116`	`public function updateTimestamp($sessionId, $data)`
`110`	`117`	`{`
`111`		`- return (bool) $this->redis->expire($this->prefix.$sessionId, (int) ini_get('session.gc_maxlifetime'));`
	`118`	`+ return (bool) $this->redis->expire($this->prefix.$sessionId, $this->ttl);`
`112`	`119`	`}`
`113`	`120`	`}`