Better key naming when possible

sylfabre · sylfabre · commit e1901e5cdebc · 2025-05-23T22:38:03.000+02:00
Use plain text for key name when they are short enough.
It helps to understand where inserted locks come from when looking at the database.
diff --git a/src/Symfony/Component/Lock/CHANGELOG.md b/src/Symfony/Component/Lock/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add support for `valkey:` / `valkeys:` schemes
+ * Use plain text (vs hash) for short key names with database stores
 
 7.2
 ---
diff --git a/src/Symfony/Component/Lock/Store/DatabaseTableTrait.php b/src/Symfony/Component/Lock/Store/DatabaseTableTrait.php
@@ -48,8 +48,12 @@ private function init(array $options, float $gcProbability, int $initialTtl): vo
     /**
      * Returns a hashed version of the key.
      */
-    private function getHashedKey(Key $key): string
+    private function getKeyName(Key $key): string
     {
+        $keyAsString = (string) $key;
+        if (strlen($keyAsString) <= 64) {
+            return $keyAsString;
+        }
         return hash('sha256', (string) $key);
     }
 
diff --git a/src/Symfony/Component/Lock/Store/DoctrineDbalStore.php b/src/Symfony/Component/Lock/Store/DoctrineDbalStore.php
@@ -102,7 +102,7 @@ public function save(Key $key): void
 
         try {
             $this->conn->executeStatement($sql, [
-                $this->getHashedKey($key),
+                $this->getKeyName($key),
                 $this->getUniqueToken($key),
             ], [
                 ParameterType::STRING,
@@ -115,7 +115,7 @@ public function save(Key $key): void
 
             try {
                 $this->conn->executeStatement($sql, [
-                    $this->getHashedKey($key),
+                    $this->getKeyName($key),
                     $this->getUniqueToken($key),
                 ], [
                     ParameterType::STRING,
@@ -147,7 +147,7 @@ public function putOffExpiration(Key $key, $ttl): void
         $result = $this->conn->executeQuery($sql, [
             $ttl,
             $uniqueToken,
-            $this->getHashedKey($key),
+            $this->getKeyName($key),
             $uniqueToken,
         ], [
             ParameterType::INTEGER,
@@ -167,7 +167,7 @@ public function putOffExpiration(Key $key, $ttl): void
     public function delete(Key $key): void
     {
         $this->conn->delete($this->table, [
-            $this->idCol => $this->getHashedKey($key),
+            $this->idCol => $this->getKeyName($key),
             $this->tokenCol => $this->getUniqueToken($key),
         ]);
     }
@@ -176,7 +176,7 @@ public function exists(Key $key): bool
     {
         $sql = "SELECT 1 FROM $this->table WHERE $this->idCol = ? AND $this->tokenCol = ? AND $this->expirationCol > {$this->getCurrentTimestampStatement()}";
         $result = $this->conn->fetchOne($sql, [
-            $this->getHashedKey($key),
+            $this->getKeyName($key),
             $this->getUniqueToken($key),
         ], [
             ParameterType::STRING,
diff --git a/src/Symfony/Component/Lock/Store/PdoStore.php b/src/Symfony/Component/Lock/Store/PdoStore.php
@@ -98,7 +98,7 @@ public function save(Key $key): void
             $stmt = $conn->prepare($sql);
         }
 
-        $stmt->bindValue(':id', $this->getHashedKey($key));
+        $stmt->bindValue(':id', $this->getKeyName($key));
         $stmt->bindValue(':token', $this->getUniqueToken($key));
 
         try {
@@ -134,7 +134,7 @@ public function putOffExpiration(Key $key, float $ttl): void
         $stmt = $this->getConnection()->prepare($sql);
 
         $uniqueToken = $this->getUniqueToken($key);
-        $stmt->bindValue(':id', $this->getHashedKey($key));
+        $stmt->bindValue(':id', $this->getKeyName($key));
         $stmt->bindValue(':token1', $uniqueToken);
         $stmt->bindValue(':token2', $uniqueToken);
         $result = $stmt->execute();
@@ -152,7 +152,7 @@ public function delete(Key $key): void
         $sql = "DELETE FROM $this->table WHERE $this->idCol = :id AND $this->tokenCol = :token";
         $stmt = $this->getConnection()->prepare($sql);
 
-        $stmt->bindValue(':id', $this->getHashedKey($key));
+        $stmt->bindValue(':id', $this->getKeyName($key));
         $stmt->bindValue(':token', $this->getUniqueToken($key));
         $stmt->execute();
     }
@@ -162,7 +162,7 @@ public function exists(Key $key): bool
         $sql = "SELECT 1 FROM $this->table WHERE $this->idCol = :id AND $this->tokenCol = :token AND $this->expirationCol > {$this->getCurrentTimestampStatement()}";
         $stmt = $this->getConnection()->prepare($sql);
 
-        $stmt->bindValue(':id', $this->getHashedKey($key));
+        $stmt->bindValue(':id', $this->getKeyName($key));
         $stmt->bindValue(':token', $this->getUniqueToken($key));
         $result = $stmt->execute();
 

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,12 @@ private function init(array $options, float $gcProbability, int $initialTtl): vo`
`48`	`48`	`/**`
`49`	`49`	`* Returns a hashed version of the key.`
`50`	`50`	`*/`
`51`		`- private function getHashedKey(Key $key): string`
	`51`	`+ private function getKeyName(Key $key): string`
`52`	`52`	`{`
	`53`	`+ $keyAsString = (string) $key;`
	`54`	`+ if (strlen($keyAsString) <= 64) {`
	`55`	`+ return $keyAsString;`
	`56`	`+ }`
`53`	`57`	`return hash('sha256', (string) $key);`
`54`	`58`	`}`
`55`	`59`