Add dsn support

symfony · rtek · Apr 9, 2022 · Apr 9, 2022 · Apr 10, 2022 · Apr 11, 2022
commit 6954fc646b659ca29e4b6ee25bc5e620436d76a0
@@ -1,6 +1,6 @@
 CHANGELOG
 =========
-6.1
+6.2
 ---
 * Add `MysqlStore` based on MySQL `GET_LOCK()` functionality


@@ -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))');
 return self::$storeRegistry[$namespace] ?? self::$storeRegistry[$namespace] = new InMemoryStore(); 
 return self::$storeRegistry[$namespace] ?? self::$storeRegistry[$namespace] = new InMemoryStore(); 
        $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));
+        }
+    }
 }
@@ -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]);
+    }
 }