Removed the semaphore size from the key

lyrixx · lyrixx · commit 68e21aae48e2 · 2020-03-19T18:28:19.000+01:00
diff --git a/src/Symfony/Component/Semaphore/Key.php b/src/Symfony/Component/Semaphore/Key.php
@@ -47,7 +47,7 @@ public function __construct(string $resource, int $limit, int $weight = 1)
 
     public function __toString(): string
     {
-        return $this->resource.':'.$this->limit;
+        return $this->resource;
     }
 
     public function getLimit(): int
diff --git a/src/Symfony/Component/Semaphore/SemaphoreFactory.php b/src/Symfony/Component/Semaphore/SemaphoreFactory.php
@@ -39,14 +39,12 @@ public function __construct(PersistingStoreInterface $store)
     /**
      * Creates a semaphore for the given resource.
      *
-     * @param string     $resource    The semaphore name
-     * @param int        $limit       The semaphore limit
      * @param float|null $ttlInSecond Maximum expected semaphore duration in seconds
      * @param bool       $autoRelease Whether to automatically release the semaphore or not when the semaphore instance is destroyed
      */
-    public function createSemaphore(string $resource, int $limit, ?float $ttlInSecond = 300.0, bool $autoRelease = true): SemaphoreInterface
+    public function createSemaphore(string $resource, int $limit, int $weight = 1, ?float $ttlInSecond = 300.0, bool $autoRelease = true): SemaphoreInterface
     {
-        $semaphore = new Semaphore(new Key($resource, $limit), $this->store, $ttlInSecond, $autoRelease);
+        $semaphore = new Semaphore(new Key($resource, $limit, $weight), $this->store, $ttlInSecond, $autoRelease);
         $semaphore->setLogger($this->logger);
 
         return $semaphore;
diff --git a/src/Symfony/Component/Semaphore/Store/RedisStore.php b/src/Symfony/Component/Semaphore/Store/RedisStore.php
@@ -37,7 +37,7 @@ class RedisStore implements PersistingStoreInterface
     public function __construct($redisClient)
     {
         if (!$redisClient instanceof \Redis && !$redisClient instanceof \RedisArray && !$redisClient instanceof \RedisCluster && !$redisClient instanceof \Predis\ClientInterface && !$redisClient instanceof RedisProxy) {
-            throw new InvalidArgumentException(sprintf('%s() expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, %s given', __METHOD__, \is_object($redisClient) ? \get_class($redisClient) : \gettype($redisClient)));
+            throw new InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, \is_object($redisClient) ? \get_class($redisClient) : \gettype($redisClient)));
         }
 
         $this->redis = $redisClient;
@@ -125,7 +125,7 @@ private function evaluate(string $script, string $resource, array $args)
             return $this->redis->eval(...array_merge([$script, 1, $resource], $args));
         }
 
-        throw new InvalidArgumentException(sprintf('%s() expects being initialized with a Redis, RedisArray, RedisCluster or Predis\ClientInterface, %s given', __METHOD__, \is_object($this->redis) ? \get_class($this->redis) : \gettype($this->redis)));
+        throw new InvalidArgumentException(sprintf('"%s()" expects being initialized with a Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, \is_object($this->redis) ? \get_class($this->redis) : \gettype($this->redis)));
     }
 
     private function getUniqueToken(Key $key): string
diff --git a/src/Symfony/Component/Semaphore/Store/StoreFactory.php b/src/Symfony/Component/Semaphore/Store/StoreFactory.php
@@ -35,7 +35,7 @@ class StoreFactory
     public static function createStore($connection)
     {
         if (!\is_string($connection) && !\is_object($connection)) {
-            throw new \TypeError(sprintf('Argument 1 passed to %s() must be a string or a connection object, %s given.', __METHOD__, \gettype($connection)));
+            throw new \TypeError(sprintf('Argument 1 passed to "%s()" must be a string or a connection object, "%s" given.', __METHOD__, \gettype($connection)));
         }
 
         switch (true) {
@@ -48,7 +48,7 @@ public static function createStore($connection)
                 return new RedisStore($connection);
 
             case !\is_string($connection):
-                throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', \get_class($connection)));
+                throw new InvalidArgumentException(sprintf('Unsupported Connection: "%s".', \get_class($connection)));
             case 0 === strpos($connection, 'redis://'):
             case 0 === strpos($connection, 'rediss://'):
                 if (!class_exists(AbstractAdapter::class)) {
@@ -59,6 +59,6 @@ public static function createStore($connection)
                 return new RedisStore($connection);
         }
 
-        throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', $connection));
+        throw new InvalidArgumentException(sprintf('Unsupported Connection: "%s".', $connection));
     }
 }
diff --git a/src/Symfony/Component/Semaphore/Tests/SemaphoreTest.php b/src/Symfony/Component/Semaphore/Tests/SemaphoreTest.php
@@ -73,7 +73,7 @@ public function testAcquireThrowException()
         ;
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Failed to acquire the "key:1" semaphore.');
+        $this->expectExceptionMessage('Failed to acquire the "key" semaphore.');
 
         $semaphore->acquire();
     }
@@ -124,7 +124,7 @@ public function testRefreshWhenItFails()
         ;
 
         $this->expectException(SemaphoreExpiredException::class);
-        $this->expectExceptionMessage('The semaphore "key:1" has expired: message.');
+        $this->expectExceptionMessage('The semaphore "key" has expired: message.');
 
         $semaphore->refresh();
     }
@@ -143,7 +143,7 @@ public function testRefreshWhenItFailsHard()
         ;
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Failed to define an expiration for the "key:1" semaphore.');
+        $this->expectExceptionMessage('Failed to define an expiration for the "key" semaphore.');
 
         $semaphore->refresh();
     }
@@ -177,7 +177,7 @@ public function testReleaseWhenItFails()
         ;
 
         $this->expectException(SemaphoreReleasingException::class);
-        $this->expectExceptionMessage('The semaphore "key:1" could not be released: message.');
+        $this->expectExceptionMessage('The semaphore "key" could not be released: message.');
 
         $semaphore->release();
     }
@@ -196,7 +196,7 @@ public function testReleaseWhenItFailsHard()
         ;
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Failed to release the "key:1" semaphore.');
+        $this->expectExceptionMessage('Failed to release the "key" semaphore.');
 
         $semaphore->release();
     }

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function __construct(string $resource, int $limit, int $weight = 1)`
`47`	`47`
`48`	`48`	`public function __toString(): string`
`49`	`49`	`{`
`50`		`- return $this->resource.':'.$this->limit;`
	`50`	`+ return $this->resource;`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`public function getLimit(): int`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class RedisStore implements PersistingStoreInterface`
`37`	`37`	`public function __construct($redisClient)`
`38`	`38`	`{`
`39`	`39`	`if (!$redisClient instanceof \Redis && !$redisClient instanceof \RedisArray && !$redisClient instanceof \RedisCluster && !$redisClient instanceof \Predis\ClientInterface && !$redisClient instanceof RedisProxy) {`
`40`		`- throw new InvalidArgumentException(sprintf('%s() expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, %s given', __METHOD__, \is_object($redisClient) ? \get_class($redisClient) : \gettype($redisClient)));`
	`40`	`+ throw new InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, \is_object($redisClient) ? \get_class($redisClient) : \gettype($redisClient)));`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`$this->redis = $redisClient;`
`@@ -125,7 +125,7 @@ private function evaluate(string $script, string $resource, array $args)`
`125`	`125`	`return $this->redis->eval(...array_merge([$script, 1, $resource], $args));`
`126`	`126`	`}`
`127`	`127`
`128`		`- throw new InvalidArgumentException(sprintf('%s() expects being initialized with a Redis, RedisArray, RedisCluster or Predis\ClientInterface, %s given', __METHOD__, \is_object($this->redis) ? \get_class($this->redis) : \gettype($this->redis)));`
	`128`	`+ throw new InvalidArgumentException(sprintf('"%s()" expects being initialized with a Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, \is_object($this->redis) ? \get_class($this->redis) : \gettype($this->redis)));`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`private function getUniqueToken(Key $key): string`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class StoreFactory`
`35`	`35`	`public static function createStore($connection)`
`36`	`36`	`{`
`37`	`37`	`if (!\is_string($connection) && !\is_object($connection)) {`
`38`		`- throw new \TypeError(sprintf('Argument 1 passed to %s() must be a string or a connection object, %s given.', __METHOD__, \gettype($connection)));`
	`38`	`+ throw new \TypeError(sprintf('Argument 1 passed to "%s()" must be a string or a connection object, "%s" given.', __METHOD__, \gettype($connection)));`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`switch (true) {`
`@@ -48,7 +48,7 @@ public static function createStore($connection)`
`48`	`48`	`return new RedisStore($connection);`
`49`	`49`
`50`	`50`	`case !\is_string($connection):`
`51`		`- throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', \get_class($connection)));`
	`51`	`+ throw new InvalidArgumentException(sprintf('Unsupported Connection: "%s".', \get_class($connection)));`
`52`	`52`	`case 0 === strpos($connection, 'redis://'):`
`53`	`53`	`case 0 === strpos($connection, 'rediss://'):`
`54`	`54`	`if (!class_exists(AbstractAdapter::class)) {`
`@@ -59,6 +59,6 @@ public static function createStore($connection)`
`59`	`59`	`return new RedisStore($connection);`
`60`	`60`	`}`
`61`	`61`
`62`		`- throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', $connection));`
	`62`	`+ throw new InvalidArgumentException(sprintf('Unsupported Connection: "%s".', $connection));`
`63`	`63`	`}`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function testAcquireThrowException()`
`73`	`73`	`;`
`74`	`74`
`75`	`75`	`$this->expectException(RuntimeException::class);`
`76`		`- $this->expectExceptionMessage('Failed to acquire the "key:1" semaphore.');`
	`76`	`+ $this->expectExceptionMessage('Failed to acquire the "key" semaphore.');`
`77`	`77`
`78`	`78`	`$semaphore->acquire();`
`79`	`79`	`}`
`@@ -124,7 +124,7 @@ public function testRefreshWhenItFails()`
`124`	`124`	`;`
`125`	`125`
`126`	`126`	`$this->expectException(SemaphoreExpiredException::class);`
`127`		`- $this->expectExceptionMessage('The semaphore "key:1" has expired: message.');`
	`127`	`+ $this->expectExceptionMessage('The semaphore "key" has expired: message.');`
`128`	`128`
`129`	`129`	`$semaphore->refresh();`
`130`	`130`	`}`
`@@ -143,7 +143,7 @@ public function testRefreshWhenItFailsHard()`
`143`	`143`	`;`
`144`	`144`
`145`	`145`	`$this->expectException(RuntimeException::class);`
`146`		`- $this->expectExceptionMessage('Failed to define an expiration for the "key:1" semaphore.');`
	`146`	`+ $this->expectExceptionMessage('Failed to define an expiration for the "key" semaphore.');`
`147`	`147`
`148`	`148`	`$semaphore->refresh();`
`149`	`149`	`}`
`@@ -177,7 +177,7 @@ public function testReleaseWhenItFails()`
`177`	`177`	`;`
`178`	`178`
`179`	`179`	`$this->expectException(SemaphoreReleasingException::class);`
`180`		`- $this->expectExceptionMessage('The semaphore "key:1" could not be released: message.');`
	`180`	`+ $this->expectExceptionMessage('The semaphore "key" could not be released: message.');`
`181`	`181`
`182`	`182`	`$semaphore->release();`
`183`	`183`	`}`
`@@ -196,7 +196,7 @@ public function testReleaseWhenItFailsHard()`
`196`	`196`	`;`
`197`	`197`
`198`	`198`	`$this->expectException(RuntimeException::class);`
`199`		`- $this->expectExceptionMessage('Failed to release the "key:1" semaphore.');`
	`199`	`+ $this->expectExceptionMessage('Failed to release the "key" semaphore.');`
`200`	`200`
`201`	`201`	`$semaphore->release();`
`202`	`202`	`}`