[Lock] Pedantic improvements for lock

greg0ire · fabpot · commit dc568c0ba116 · 2019-01-01T18:28:50.000+01:00
diff --git a/src/Symfony/Component/Lock/StoreInterface.php b/src/Symfony/Component/Lock/StoreInterface.php
@@ -43,7 +43,7 @@ public function waitAndSave(Key $key);
      *
      * If the store does not support this feature it should throw a NotSupportedException.
      *
-     * @param float $ttl amount of second to keep the lock in the store
+     * @param float $ttl amount of seconds to keep the lock in the store
      *
      * @throws LockConflictedException
      * @throws NotSupportedException
diff --git a/src/Symfony/Component/Lock/Tests/Store/BlockingStoreTestTrait.php b/src/Symfony/Component/Lock/Tests/Store/BlockingStoreTestTrait.php
@@ -36,7 +36,7 @@ abstract protected function getStore();
      */
     public function testBlockingLocks()
     {
-        // Amount a microsecond used to order async actions
+        // Amount of microseconds we should wait without slowing things down too much
         $clockDelay = 50000;
 
         if (\PHP_VERSION_ID < 50600 || \defined('HHVM_VERSION_ID')) {
diff --git a/src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php b/src/Symfony/Component/Lock/Tests/Store/ExpiringStoreTestTrait.php
@@ -20,7 +20,9 @@
 trait ExpiringStoreTestTrait
 {
     /**
-     * Amount a microsecond used to order async actions.
+     * Amount of microseconds used as a delay to test expiration. Should be
+     * small enough not to slow the test suite too much, and high enough not to
+     * fail because of race conditions.
      *
      * @return int
      */
@@ -34,7 +36,7 @@ abstract protected function getStore();
     /**
      * Tests the store automatically delete the key when it expire.
      *
-     * This test is time sensible: the $clockDelay could be adjust.
+     * This test is time-sensitive: the $clockDelay could be adjusted.
      */
     public function testExpiration()
     {
@@ -71,14 +73,13 @@ public function testAbortAfterExpiration()
     /**
      * Tests the refresh can push the limits to the expiration.
      *
-     * This test is time sensible: the $clockDelay could be adjust.
+     * This test is time-sensitive: the $clockDelay could be adjusted.
      */
     public function testRefreshLock()
     {
-        // Amount a microsecond used to order async actions
+        // Amount of microseconds we should wait without slowing things down too much
         $clockDelay = $this->getClockDelay();
 
-        // Amount a microsecond used to order async actions
         $key = new Key(uniqid(__METHOD__, true));
 
         /** @var StoreInterface $store */

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function waitAndSave(Key $key);`
`43`	`43`	`*`
`44`	`44`	`* If the store does not support this feature it should throw a NotSupportedException.`
`45`	`45`	`*`
`46`		`- * @param float $ttl amount of second to keep the lock in the store`
	`46`	`+ * @param float $ttl amount of seconds to keep the lock in the store`
`47`	`47`	`*`
`48`	`48`	`* @throws LockConflictedException`
`49`	`49`	`* @throws NotSupportedException`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ abstract protected function getStore();`
`36`	`36`	`*/`
`37`	`37`	`public function testBlockingLocks()`
`38`	`38`	`{`
`39`		`- // Amount a microsecond used to order async actions`
	`39`	`+ // Amount of microseconds we should wait without slowing things down too much`
`40`	`40`	`$clockDelay = 50000;`
`41`	`41`
`42`	`42`	`if (\PHP_VERSION_ID < 50600 \|\| \defined('HHVM_VERSION_ID')) {`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@`
`20`	`20`	`trait ExpiringStoreTestTrait`
`21`	`21`	`{`
`22`	`22`	`/**`
`23`		`- * Amount a microsecond used to order async actions.`
	`23`	`+ * Amount of microseconds used as a delay to test expiration. Should be`
	`24`	`+ * small enough not to slow the test suite too much, and high enough not to`
	`25`	`+ * fail because of race conditions.`
`24`	`26`	`*`
`25`	`27`	`* @return int`
`26`	`28`	`*/`
`@@ -34,7 +36,7 @@ abstract protected function getStore();`
`34`	`36`	`/**`
`35`	`37`	`* Tests the store automatically delete the key when it expire.`
`36`	`38`	`*`
`37`		`- * This test is time sensible: the $clockDelay could be adjust.`
	`39`	`+ * This test is time-sensitive: the $clockDelay could be adjusted.`
`38`	`40`	`*/`
`39`	`41`	`public function testExpiration()`
`40`	`42`	`{`
`@@ -71,14 +73,13 @@ public function testAbortAfterExpiration()`
`71`	`73`	`/**`
`72`	`74`	`* Tests the refresh can push the limits to the expiration.`
`73`	`75`	`*`
`74`		`- * This test is time sensible: the $clockDelay could be adjust.`
	`76`	`+ * This test is time-sensitive: the $clockDelay could be adjusted.`
`75`	`77`	`*/`
`76`	`78`	`public function testRefreshLock()`
`77`	`79`	`{`
`78`		`- // Amount a microsecond used to order async actions`
	`80`	`+ // Amount of microseconds we should wait without slowing things down too much`
`79`	`81`	`$clockDelay = $this->getClockDelay();`
`80`	`82`
`81`		`- // Amount a microsecond used to order async actions`
`82`	`83`	`$key = new Key(uniqid(__METHOD__, true));`
`83`	`84`
`84`	`85`	`/** @var StoreInterface $store */`