Add dsn support

rtek · rtek · commit 6954fc646b65 · 2022-04-10T20:54:55.000-04:00
diff --git a/src/Symfony/Component/Lock/CHANGELOG.md b/src/Symfony/Component/Lock/CHANGELOG.md
@@ -1,6 +1,6 @@
 CHANGELOG
 =========
-6.1
+6.2
 ---
 * Add `MysqlStore` based on MySQL `GET_LOCK()` functionality
 
diff --git a/src/Symfony/Component/Lock/Store/MysqlStore.php b/src/Symfony/Component/Lock/Store/MysqlStore.php
@@ -23,19 +23,25 @@
  */
 class MysqlStore implements PersistingStoreInterface
 {
-    private \PDO $conn;
+    private ?\PDO $conn;
 
-    public function __construct(\PDO $conn)
-    {
-        if ('mysql' !== $driver = $conn->getAttribute(\PDO::ATTR_DRIVER_NAME)) {
-            throw new InvalidArgumentException(sprintf('The adapter "%s" does not support the "%s" driver.', __CLASS__, $driver));
-        }
+    private ?string $dsn;
+
+    private array $options;
 
-        if (\PDO::ERRMODE_EXCEPTION !== $conn->getAttribute(\PDO::ATTR_ERRMODE)) {
-            throw new InvalidArgumentException(sprintf('"%s" requires PDO error mode attribute be set to throw Exceptions (i.e. $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION)).', __METHOD__));
+    public function __construct(\PDO|string $connOrDsn, array $options = [])
+    {
+        if ($connOrDsn instanceof \PDO) {
+            $this->conn = $connOrDsn;
+            $this->assertMysqlDriver();
+            if (\PDO::ERRMODE_EXCEPTION !== $this->conn->getAttribute(\PDO::ATTR_ERRMODE)) {
+                throw new InvalidArgumentException(sprintf('"%s" requires PDO error mode attribute be set to throw Exceptions (i.e. $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION)).', __METHOD__));
+            }
+        } else {
+            $this->dsn = $connOrDsn;
         }
 
-        $this->conn = $conn;
+        $this->options = $options;
     }
 
     public function save(Key $key): void
@@ -44,11 +50,9 @@ public function save(Key $key): void
             return;
         }
 
-        // todo ? check that mysql > 5.7.3
-
         // mysql limits lock name length to 64 chars
         $name = (string) $key;
-        $name = \strlen($name) > 64 ? hash('sha256', $name) : $name;
+        $name = \strlen($name) > 64 ? hash('xxh128', $name) : $name;
 
         $stmt = $this->conn->prepare('SELECT IF(IS_USED_LOCK(:name) = CONNECTION_ID(), -1, GET_LOCK(:name, 0))');
         $stmt->bindValue(':name', $name, \PDO::PARAM_STR);
@@ -103,4 +107,27 @@ public function exists(Key $key): bool
 
         return 1 === $stmt->fetchColumn();
     }
+
+    private function getConnection(): \PDO
+    {
+        if (!$this->conn) {
+            $this->conn = new \PDO(
+                $this->dsn,
+                $this->options['db_username'] ?? null,
+                $this->options['db_password'] ?? null,
+                $this->options['db_connection_options'] ?? null
+            );
+            $this->conn->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
+            $this->assertMysqlDriver();
+        }
+
+        return $this->conn;
+    }
+
+    private function assertMysqlDriver(): void
+    {
+        if ('mysql' !== $driver = $this->conn->getAttribute(\PDO::ATTR_DRIVER_NAME)) {
+            throw new InvalidArgumentException(sprintf('The adapter "%s" does not support the "%s" driver.', __CLASS__, $driver));
+        }
+    }
 }
diff --git a/src/Symfony/Component/Lock/Tests/Store/MysqlStoreTest.php b/src/Symfony/Component/Lock/Tests/Store/MysqlStoreTest.php
@@ -10,7 +10,7 @@
 
 class MysqlStoreTest extends AbstractStoreTest
 {
-    protected function getPdo(): \PDO
+    protected function getEnv(): array
     {
         if (!$host = getenv('MYSQL_HOST')) {
             $this->markTestSkipped('Missing MYSQL_HOST env variable');
@@ -24,6 +24,13 @@ protected function getPdo(): \PDO
             $this->markTestSkipped('Missing MYSQL_PASSWORD env variable');
         }
 
+        return [$host, $user, $pass];
+    }
+
+    protected function getPdo(): \PDO
+    {
+        [$host, $user, $pass] = $this->getEnv();
+
         return new \PDO('mysql:host='.$host, $user, $pass);
     }
 
@@ -73,4 +80,12 @@ public function testOtherConflictException()
             $this->assertStringContainsString('acquired by other', $e->getMessage());
         }
     }
+
+    public function testDsnConstructor()
+    {
+        $this->expectNotToPerformAssertions();
+
+        [$host, $user, $pass] = $this->getEnv();
+        new MysqlStore("mysql:$host", ['db_username' => $user, 'db_password' => $pass]);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`
`11`	`11`	`class MysqlStoreTest extends AbstractStoreTest`
`12`	`12`	`{`
`13`		`- protected function getPdo(): \PDO`
	`13`	`+ protected function getEnv(): array`
`14`	`14`	`{`
`15`	`15`	`if (!$host = getenv('MYSQL_HOST')) {`
`16`	`16`	`$this->markTestSkipped('Missing MYSQL_HOST env variable');`
`@@ -24,6 +24,13 @@ protected function getPdo(): \PDO`
`24`	`24`	`$this->markTestSkipped('Missing MYSQL_PASSWORD env variable');`
`25`	`25`	`}`
`26`	`26`
	`27`	`+ return [$host, $user, $pass];`
	`28`	`+ }`
	`29`	`+`
	`30`	`+ protected function getPdo(): \PDO`
	`31`	`+ {`
	`32`	`+ [$host, $user, $pass] = $this->getEnv();`
	`33`	`+`
`27`	`34`	`return new \PDO('mysql:host='.$host, $user, $pass);`
`28`	`35`	`}`
`29`	`36`
`@@ -73,4 +80,12 @@ public function testOtherConflictException()`
`73`	`80`	`$this->assertStringContainsString('acquired by other', $e->getMessage());`
`74`	`81`	`}`
`75`	`82`	`}`
	`83`	`+`
	`84`	`+ public function testDsnConstructor()`
	`85`	`+ {`
	`86`	`+ $this->expectNotToPerformAssertions();`
	`87`	`+`
	`88`	`+ [$host, $user, $pass] = $this->getEnv();`
	`89`	`+ new MysqlStore("mysql:$host", ['db_username' => $user, 'db_password' => $pass]);`
	`90`	`+ }`
`76`	`91`	`}`