Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

[Lock] Expose an expiringDate and isExpired method in Lock #22543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[Lock] Expose an expiringDate and isExpired method in Lock #22543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d69adc
Expose an expiringDate and isExpired method in Lock
jderusse Apr 26, 2017
566f35e
Replace reduceExpiringDate by reduceLifetime
jderusse Aug 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions 26 src/Symfony/Component/Lock/Key.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
final class Key
{
private $resource;
private $expiringDate;
private $state = array();

/**
Expand Down Expand Up @@ -70,4 +71,29 @@ public function getState($stateKey)
{
return $this->state[$stateKey];
}

/**
* @param float $ttl The expiration delay of locks in seconds.
*/
public function reduceLifetime($ttl)
{
$newExpiringDate = \DateTimeImmutable::createFromFormat('U.u', (string) (microtime(true) + $ttl));

if (null === $this->expiringDate || $newExpiringDate < $this->expiringDate) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if it really is expected behaviour that the method silently ignores any argument if it is no smaller than the existing expiration date.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it's not an issue if a store ask for a TTL greater than the current one.

$this->expiringDate = $newExpiringDate;
}
}

public function resetExpiringDate()
{
$this->expiringDate = null;
}

/**
* @return \DateTimeImmutable
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\DateTimeImmutable|null

*/
public function getExpiringDate()
{
return $this->expiringDate;
}
}
18 changes: 18 additions & 0 deletions 18 src/Symfony/Component/Lock/Lock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public function refresh()
}

try {
$this->key->resetExpiringDate();
$this->store->putOffExpiration($this->key, $this->ttl);
$this->logger->info('Expiration defined for "{resource}" lock for "{ttl}" seconds.', array('resource' => $this->key, 'ttl' => $this->ttl));
} catch (LockConflictedException $e) {
Expand Down Expand Up @@ -120,4 +121,21 @@ public function release()
throw new LockReleasingException(sprintf('Failed to release the "%s" lock.', $this->key));
}
}

/**
* @return bool
*/
public function isExpired()
{
if (null === $expireDate = $this->key->getExpiringDate()) {
return false;
}

return $expireDate <= new \DateTime();
}

public function getExpiringDate()
{
return $this->key->getExpiringDate();
}
}
2 changes: 2 additions & 0 deletions 2 src/Symfony/Component/Lock/Store/MemcachedStore.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public function save(Key $key)
{
$token = $this->getToken($key);

$key->reduceLifetime($this->initialTtl);
if ($this->memcached->add((string) $key, $token, (int) ceil($this->initialTtl))) {
return;
}
Expand Down Expand Up @@ -87,6 +88,7 @@ public function putOffExpiration(Key $key, $ttl)

list($value, $cas) = $this->getValueAndCas($key);

$key->reduceLifetime($ttl);
// Could happens when we ask a putOff after a timeout but in luck nobody steal the lock
if (\Memcached::RES_NOTFOUND === $this->memcached->getResultCode()) {
if ($this->memcached->add((string) $key, $token, $ttl)) {
Expand Down
8 changes: 4 additions & 4 deletions 8 src/Symfony/Component/Lock/Store/RedisStore.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ public function save(Key $key)
end
';

$expire = (int) ceil($this->initialTtl * 1000);
if (!$this->evaluate($script, (string) $key, array($this->getToken($key), $expire))) {
$key->reduceLifetime($this->initialTtl);
if (!$this->evaluate($script, (string) $key, array($this->getToken($key), (int) ceil($this->initialTtl * 1000)))) {
throw new LockConflictedException();
}
}
Expand All @@ -81,8 +81,8 @@ public function putOffExpiration(Key $key, $ttl)
end
';

$expire = (int) ceil($ttl * 1000);
if (!$this->evaluate($script, (string) $key, array($this->getToken($key), $expire))) {
$key->reduceLifetime($ttl);
if (!$this->evaluate($script, (string) $key, array($this->getToken($key), (int) ceil($ttl * 1000)))) {
throw new LockConflictedException();
}
}
Expand Down
30 changes: 30 additions & 0 deletions 30 src/Symfony/Component/Lock/Tests/LockTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,34 @@ public function testReleaseThrowsExceptionIfNotWellDeleted()

$lock->release();
}

/**
* @dataProvider provideExpiredDates
*/
public function testExpiration($ttls, $expected)
{
$key = new Key(uniqid(__METHOD__, true));
$store = $this->getMockBuilder(StoreInterface::class)->getMock();
$lock = new Lock($key, $store, 10);

foreach ($ttls as $ttl) {
if (null === $ttl) {
$key->resetExpiringDate();
} else {
$key->reduceLifetime($ttl);
}
}
$this->assertSame($expected, $lock->isExpired());
}

public function provideExpiredDates()
{
yield array(array(-1.0), true);
yield array(array(1, -1.0), true);
yield array(array(-1.0, 1), true);

yield array(array(), false);
yield array(array(1), false);
yield array(array(-1.0, null), false);
}
}
7 changes: 5 additions & 2 deletions 7 src/Symfony/Component/Lock/Tests/Store/AbstractStoreTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,17 @@ public function testSaveWithDifferentResources()
$store->save($key1);
$this->assertTrue($store->exists($key1));
$this->assertFalse($store->exists($key2));
$store->save($key2);

$store->save($key2);
$this->assertTrue($store->exists($key1));
$this->assertTrue($store->exists($key2));

$store->delete($key1);
$this->assertFalse($store->exists($key1));
$this->assertTrue($store->exists($key2));

$store->delete($key2);
$this->assertFalse($store->exists($key1));
$this->assertFalse($store->exists($key2));
}

Expand All @@ -74,7 +77,7 @@ public function testSaveWithDifferentKeysOnSameResources()

try {
$store->save($key2);
throw new \Exception('The store shouldn\'t save the second key');
$this->fail('The store shouldn\'t save the second key');
} catch (LockConflictedException $e) {
}

Expand Down
12 changes: 12 additions & 0 deletions 12 src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,16 @@ public function testRefreshLock()
usleep(2.1 * $clockDelay);
$this->assertFalse($store->exists($key));
}

public function testSetExpiration()
{
$key = new Key(uniqid(__METHOD__, true));

/** @var StoreInterface $store */
$store = $this->getStore();

$store->save($key);
$store->putOffExpiration($key, 1);
$this->assertNotNull($key->getExpiringDate());
}
}
Morty Proxy This is a proxified and sanitized view of the page, visit original site.