Use lifetime instead of ExpiringDate

jderusse · jderusse · commit b9de71b9dd75 · 2017-09-03T12:23:47.000+02:00
diff --git a/src/Symfony/Component/Lock/Key.php b/src/Symfony/Component/Lock/Key.php
@@ -72,6 +72,11 @@ public function getState($stateKey)
         return $this->state[$stateKey];
     }
 
+    public function resetLifetime()
+    {
+        $this->expiringTime = null;
+    }
+
     /**
      * @param float $ttl The expiration delay of locks in seconds.
      */
@@ -84,17 +89,14 @@ public function reduceLifetime($ttl)
         }
     }
 
-    public function resetExpiringDate()
-    {
-        $this->expiringTime = null;
-    }
-
     /**
-     * @return \DateTimeImmutable
+     * Returns the remaining lifetime.
+     *
+     * @return float|null Remaining lifetime in seconds. Null when the key won't expire.
      */
-    public function getExpiringDate()
+    public function getRemainingLifetime()
     {
-        return \DateTimeImmutable::createFromFormat('U.u', (string) $this->expiringTime);
+        return null === $this->expiringTime ? null : $this->expiringTime - microtime(true);
     }
 
     /**
diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -94,7 +94,7 @@ public function refresh()
         }
 
         try {
-            $this->key->resetExpiringDate();
+            $this->key->resetLifetime();
             $this->store->putOffExpiration($this->key, $this->ttl);
 
             if ($this->key->isExpired()) {
@@ -140,8 +140,13 @@ public function isExpired()
         return $this->key->isExpired();
     }
 
-    public function getExpiringDate()
+    /**
+     * Returns the remaining lifetime.
+     *
+     * @return float|null Remaining lifetime in seconds. Null when the lock won't expire.
+     */
+    public function getRemainingLifetime()
     {
-        return $this->key->getExpiringDate();
+        return $this->key->getRemainingLifetime();
     }
 }
diff --git a/src/Symfony/Component/Lock/Tests/LockTest.php b/src/Symfony/Component/Lock/Tests/LockTest.php
@@ -165,7 +165,7 @@ public function testExpiration($ttls, $expected)
 
         foreach ($ttls as $ttl) {
             if (null === $ttl) {
-                $key->resetExpiringDate();
+                $key->resetLifetime();
             } else {
                 $key->reduceLifetime($ttl);
             }
diff --git a/src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php b/src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php
@@ -101,6 +101,7 @@ public function testSetExpiration()
 
         $store->save($key);
         $store->putOffExpiration($key, 1);
-        $this->assertNotNull($key->getExpiringDate());
+        $this->assertGreaterThanOrEqual(0, $key->getRemainingLifetime());
+        $this->assertLessThanOrEqual(1, $key->getRemainingLifetime());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ public function refresh()`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`try {`
`97`		`- $this->key->resetExpiringDate();`
	`97`	`+ $this->key->resetLifetime();`
`98`	`98`	`$this->store->putOffExpiration($this->key, $this->ttl);`
`99`	`99`
`100`	`100`	`if ($this->key->isExpired()) {`
`@@ -140,8 +140,13 @@ public function isExpired()`
`140`	`140`	`return $this->key->isExpired();`
`141`	`141`	`}`
`142`	`142`
`143`		`- public function getExpiringDate()`
	`143`	`+ /**`
	`144`	`+ * Returns the remaining lifetime.`
	`145`	`+ *`
	`146`	`+ * @return float\|null Remaining lifetime in seconds. Null when the lock won't expire.`
	`147`	`+ */`
	`148`	`+ public function getRemainingLifetime()`
`144`	`149`	`{`
`145`		`- return $this->key->getExpiringDate();`
	`150`	`+ return $this->key->getRemainingLifetime();`
`146`	`151`	`}`
`147`	`152`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ public function testExpiration($ttls, $expected)`
`165`	`165`
`166`	`166`	`foreach ($ttls as $ttl) {`
`167`	`167`	`if (null === $ttl) {`
`168`		`- $key->resetExpiringDate();`
	`168`	`+ $key->resetLifetime();`
`169`	`169`	`} else {`
`170`	`170`	`$key->reduceLifetime($ttl);`
`171`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,7 @@ public function testSetExpiration()`
`101`	`101`
`102`	`102`	`$store->save($key);`
`103`	`103`	`$store->putOffExpiration($key, 1);`
`104`		`- $this->assertNotNull($key->getExpiringDate());`
	`104`	`+ $this->assertGreaterThanOrEqual(0, $key->getRemainingLifetime());`
	`105`	`+ $this->assertLessThanOrEqual(1, $key->getRemainingLifetime());`
`105`	`106`	`}`
`106`	`107`	`}`