[Lock] add an InvalidTTLException to be more accurate

Simperfit · Simperfit · commit 5a1a9044cd6b · 2019-06-26T08:54:33.000+02:00
diff --git a/src/Symfony/Component/Lock/CHANGELOG.md b/src/Symfony/Component/Lock/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * added InvalidTTLException
+ 
 4.2.0
 -----
 
diff --git a/src/Symfony/Component/Lock/Exception/InvalidTTLException.php b/src/Symfony/Component/Lock/Exception/InvalidTTLException.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Exception;
+
+/**
+ * @author Amrouche Hamza <hamza.simperfit@gmail.com>
+ */
+class InvalidTTLException extends InvalidArgumentException implements ExceptionInterface
+{
+}
diff --git a/src/Symfony/Component/Lock/Store/MemcachedStore.php b/src/Symfony/Component/Lock/Store/MemcachedStore.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Lock\Store;
 
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
+use Symfony\Component\Lock\Exception\InvalidTTLException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\StoreInterface;
@@ -79,7 +80,7 @@ public function waitAndSave(Key $key)
     public function putOffExpiration(Key $key, $ttl)
     {
         if ($ttl < 1) {
-            throw new InvalidArgumentException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));
+            throw new InvalidTTLException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));
         }
 
         // Interface defines a float value but Store required an integer.
diff --git a/src/Symfony/Component/Lock/Store/PdoStore.php b/src/Symfony/Component/Lock/Store/PdoStore.php
@@ -15,6 +15,7 @@
 use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Schema\Schema;
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
+use Symfony\Component\Lock\Exception\InvalidTTLException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Exception\NotSupportedException;
 use Symfony\Component\Lock\Key;
@@ -80,7 +81,7 @@ public function __construct($connOrDsn, array $options = [], float $gcProbabilit
             throw new InvalidArgumentException(sprintf('"%s" requires gcProbability between 0 and 1, "%f" given.', __METHOD__, $gcProbability));
         }
         if ($initialTtl < 1) {
-            throw new InvalidArgumentException(sprintf('%s() expects a strictly positive TTL, "%d" given.', __METHOD__, $initialTtl));
+            throw new InvalidTTLException(sprintf('%s() expects a strictly positive TTL, "%d" given.', __METHOD__, $initialTtl));
         }
 
         if ($connOrDsn instanceof \PDO) {
@@ -153,7 +154,7 @@ public function waitAndSave(Key $key)
     public function putOffExpiration(Key $key, $ttl)
     {
         if ($ttl < 1) {
-            throw new InvalidArgumentException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));
+            throw new InvalidTTLException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));
         }
 
         $key->reduceLifetime($ttl);
diff --git a/src/Symfony/Component/Lock/Store/RedisStore.php b/src/Symfony/Component/Lock/Store/RedisStore.php
@@ -14,6 +14,7 @@
 use Symfony\Component\Cache\Traits\RedisClusterProxy;
 use Symfony\Component\Cache\Traits\RedisProxy;
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
+use Symfony\Component\Lock\Exception\InvalidTTLException;
 use Symfony\Component\Lock\Exception\LockConflictedException;
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\StoreInterface;
@@ -41,7 +42,7 @@ public function __construct($redisClient, float $initialTtl = 300.0)
         }
 
         if ($initialTtl <= 0) {
-            throw new InvalidArgumentException(sprintf('%s() expects a strictly positive TTL. Got %d.', __METHOD__, $initialTtl));
+            throw new InvalidTTLException(sprintf('%s() expects a strictly positive TTL. Got %d.', __METHOD__, $initialTtl));
         }
 
         $this->redis = $redisClient;
diff --git a/src/Symfony/Component/Lock/Tests/Store/MemcachedStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/MemcachedStoreTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Lock\Tests\Store;
 
+use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\Store\MemcachedStore;
 
 /**
@@ -57,4 +58,13 @@ public function testAbortAfterExpiration()
     {
         $this->markTestSkipped('Memcached expects a TTL greater than 1 sec. Simulating a slow network is too hard');
     }
+
+    /**
+     * @expectedException \Symfony\Component\Lock\Exception\InvalidTTLException
+     */
+    public function testInvalidTTL()
+    {
+        $store = $this->getStore();
+        $store->putOffExpiration(new Key('toto'), 0.1);
+    }
 }
diff --git a/src/Symfony/Component/Lock/Tests/Store/PdoStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/PdoStoreTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Lock\Tests\Store;
 
+use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\Store\PdoStore;
 
 /**
@@ -57,4 +58,22 @@ public function testAbortAfterExpiration()
     {
         $this->markTestSkipped('Pdo expects a TTL greater than 1 sec. Simulating a slow network is too hard');
     }
+
+    /**
+     * @expectedException \Symfony\Component\Lock\Exception\InvalidTTLException
+     */
+    public function testInvalidTTL()
+    {
+        $store = $this->getStore();
+        $store->putOffExpiration(new Key('toto'), 0.1);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Lock\Exception\InvalidTTLException
+     */
+    public function testInvalidTTLConstruct()
+    {
+        return new PdoStore('sqlite:'.self::$dbFile, [], 0.1, 0.1);
+
+    }
 }
diff --git a/src/Symfony/Component/Lock/Tests/Store/RedisStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/RedisStoreTest.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Lock\Tests\Store;
 
+use Symfony\Component\Lock\Store\RedisStore;
+
 /**
  * @author Jérémy Derussé <jeremy@derusse.com>
  *
@@ -33,4 +35,12 @@ protected function getRedisConnection()
 
         return $redis;
     }
+
+    /**
+     * @expectedException \Symfony\Component\Lock\Exception\InvalidTTLException
+     */
+    public function testInvalidTTL()
+    {
+        new RedisStore($this->getRedisConnection(), -1);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Lock\Store;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Lock\Exception\InvalidArgumentException;`
	`15`	`+use Symfony\Component\Lock\Exception\InvalidTTLException;`
`15`	`16`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
`16`	`17`	`use Symfony\Component\Lock\Key;`
`17`	`18`	`use Symfony\Component\Lock\StoreInterface;`
`@@ -79,7 +80,7 @@ public function waitAndSave(Key $key)`
`79`	`80`	`public function putOffExpiration(Key $key, $ttl)`
`80`	`81`	`{`
`81`	`82`	`if ($ttl < 1) {`
`82`		`- throw new InvalidArgumentException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));`
	`83`	`+ throw new InvalidTTLException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`// Interface defines a float value but Store required an integer.`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`use Doctrine\DBAL\DBALException;`
`16`	`16`	`use Doctrine\DBAL\Schema\Schema;`
`17`	`17`	`use Symfony\Component\Lock\Exception\InvalidArgumentException;`
	`18`	`+use Symfony\Component\Lock\Exception\InvalidTTLException;`
`18`	`19`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
`19`	`20`	`use Symfony\Component\Lock\Exception\NotSupportedException;`
`20`	`21`	`use Symfony\Component\Lock\Key;`
`@@ -80,7 +81,7 @@ public function __construct($connOrDsn, array $options = [], float $gcProbabilit`
`80`	`81`	`throw new InvalidArgumentException(sprintf('"%s" requires gcProbability between 0 and 1, "%f" given.', __METHOD__, $gcProbability));`
`81`	`82`	`}`
`82`	`83`	`if ($initialTtl < 1) {`
`83`		`- throw new InvalidArgumentException(sprintf('%s() expects a strictly positive TTL, "%d" given.', __METHOD__, $initialTtl));`
	`84`	`+ throw new InvalidTTLException(sprintf('%s() expects a strictly positive TTL, "%d" given.', __METHOD__, $initialTtl));`
`84`	`85`	`}`
`85`	`86`
`86`	`87`	`if ($connOrDsn instanceof \PDO) {`
`@@ -153,7 +154,7 @@ public function waitAndSave(Key $key)`
`153`	`154`	`public function putOffExpiration(Key $key, $ttl)`
`154`	`155`	`{`
`155`	`156`	`if ($ttl < 1) {`
`156`		`- throw new InvalidArgumentException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));`
	`157`	`+ throw new InvalidTTLException(sprintf('%s() expects a TTL greater or equals to 1 second. Got %s.', __METHOD__, $ttl));`
`157`	`158`	`}`
`158`	`159`
`159`	`160`	`$key->reduceLifetime($ttl);`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Symfony\Component\Cache\Traits\RedisClusterProxy;`
`15`	`15`	`use Symfony\Component\Cache\Traits\RedisProxy;`
`16`	`16`	`use Symfony\Component\Lock\Exception\InvalidArgumentException;`
	`17`	`+use Symfony\Component\Lock\Exception\InvalidTTLException;`
`17`	`18`	`use Symfony\Component\Lock\Exception\LockConflictedException;`
`18`	`19`	`use Symfony\Component\Lock\Key;`
`19`	`20`	`use Symfony\Component\Lock\StoreInterface;`
`@@ -41,7 +42,7 @@ public function __construct($redisClient, float $initialTtl = 300.0)`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`if ($initialTtl <= 0) {`
`44`		`- throw new InvalidArgumentException(sprintf('%s() expects a strictly positive TTL. Got %d.', __METHOD__, $initialTtl));`
	`45`	`+ throw new InvalidTTLException(sprintf('%s() expects a strictly positive TTL. Got %d.', __METHOD__, $initialTtl));`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`$this->redis = $redisClient;`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Lock\Tests\Store;`
`13`	`13`
	`14`	`+use Symfony\Component\Lock\Key;`
`14`	`15`	`use Symfony\Component\Lock\Store\MemcachedStore;`
`15`	`16`
`16`	`17`	`/**`
`@@ -57,4 +58,13 @@ public function testAbortAfterExpiration()`
`57`	`58`	`{`
`58`	`59`	`$this->markTestSkipped('Memcached expects a TTL greater than 1 sec. Simulating a slow network is too hard');`
`59`	`60`	`}`
	`61`	`+`
	`62`	`+ /**`
	`63`	`+ * @expectedException \Symfony\Component\Lock\Exception\InvalidTTLException`
	`64`	`+ */`
	`65`	`+ public function testInvalidTTL()`
	`66`	`+ {`
	`67`	`+ $store = $this->getStore();`
	`68`	`+ $store->putOffExpiration(new Key('toto'), 0.1);`
	`69`	`+ }`
`60`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Lock\Tests\Store;`
`13`	`13`
	`14`	`+use Symfony\Component\Lock\Store\RedisStore;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* @author Jérémy Derussé <jeremy@derusse.com>`
`16`	`18`	`*`
`@@ -33,4 +35,12 @@ protected function getRedisConnection()`
`33`	`35`
`34`	`36`	`return $redis;`
`35`	`37`	`}`
	`38`	`+`
	`39`	`+ /**`
	`40`	`+ * @expectedException \Symfony\Component\Lock\Exception\InvalidTTLException`
	`41`	`+ */`
	`42`	`+ public function testInvalidTTL()`
	`43`	`+ {`
	`44`	`+ new RedisStore($this->getRedisConnection(), -1);`
	`45`	`+ }`
`36`	`46`	`}`