bug #38661 [RateLimiter] Fix delete method of the cache storage (GregOriol, Nyholm)

Nyholm · Nyholm · commit 76c22fab021c · 2020-10-22T19:09:06.000+02:00
This PR was merged into the 5.x branch. Discussion ---------- [RateLimiter] Fix delete method of the cache storage | Q | A | ------------- | --- | Branch? | 5.2 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | None | License | MIT This PR fixes a small issue with RateLimiter's cache storage and the delete method: all getItems are called with a sha1 of the id, but not the one for delete, which makes it miss the deletion. Commits ------- b61d9d1 minor 88c1e24 Added a test fb540bb Fix delete method on RateLimiter's cache storage
diff --git a/src/Symfony/Component/RateLimiter/Storage/CacheStorage.php b/src/Symfony/Component/RateLimiter/Storage/CacheStorage.php
@@ -52,6 +52,6 @@ public function fetch(string $limiterStateId): ?LimiterStateInterface
 
     public function delete(string $limiterStateId): void
     {
-        $this->pool->deleteItem($limiterStateId);
+        $this->pool->deleteItem(sha1($limiterStateId));
     }
 }
diff --git a/src/Symfony/Component/RateLimiter/Tests/Storage/CacheStorageTest.php b/src/Symfony/Component/RateLimiter/Tests/Storage/CacheStorageTest.php
@@ -76,4 +76,11 @@ public function testFetchNonExistingState()
 
         $this->assertNull($this->storage->fetch('test'));
     }
+
+    public function testDelete()
+    {
+        $this->pool->expects($this->once())->method('deleteItem')->with(sha1('test'))->willReturn(true);
+
+        $this->storage->delete('test');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,6 @@ public function fetch(string $limiterStateId): ?LimiterStateInterface`
`52`	`52`
`53`	`53`	`public function delete(string $limiterStateId): void`
`54`	`54`	`{`
`55`		`- $this->pool->deleteItem($limiterStateId);`
	`55`	`+ $this->pool->deleteItem(sha1($limiterStateId));`
`56`	`56`	`}`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,4 +76,11 @@ public function testFetchNonExistingState()`
`76`	`76`
`77`	`77`	`$this->assertNull($this->storage->fetch('test'));`
`78`	`78`	`}`
	`79`	`+`
	`80`	`+ public function testDelete()`
	`81`	`+ {`
	`82`	`+ $this->pool->expects($this->once())->method('deleteItem')->with(sha1('test'))->willReturn(true);`
	`83`	`+`
	`84`	`+ $this->storage->delete('test');`
	`85`	`+ }`
`79`	`86`	`}`