Make Database name optional in Socket Dsn (#652)

cebe · web-flow · commit c64276f6cd3b · 2023-04-05T04:56:33.000-04:00
diff --git a/src/Connection/AbstractDsnSocket.php b/src/Connection/AbstractDsnSocket.php
@@ -22,14 +22,18 @@ abstract class AbstractDsnSocket implements DsnInterface, Stringable
     public function __construct(
         private string $driver,
         private string $unixSocket,
-        private string $databaseName,
+        private string|null $databaseName = null,
         private array $options = []
     ) {
     }
 
     public function asString(): string
     {
-        $dsn = "$this->driver:" . "unix_socket=$this->unixSocket" . ';' . "dbname=$this->databaseName";
+        $dsn = "$this->driver:" . "unix_socket=$this->unixSocket";
+
+        if ($this->databaseName !== null && $this->databaseName !== '') {
+            $dsn .= ';' . "dbname=$this->databaseName";
+        }
 
         $parts = [];
 
@@ -53,9 +57,9 @@ public function __toString(): string
     }
 
     /**
-     * @return string The database name to connect to.
+     * @return string|null The database name to connect to.
      */
-    public function getDatabaseName(): string
+    public function getDatabaseName(): string|null
     {
         return $this->databaseName;
     }
diff --git a/tests/Db/Connection/DsnSocketTest.php b/tests/Db/Connection/DsnSocketTest.php
@@ -31,6 +31,21 @@ public function testGetDatabaseName(): void
         $this->assertSame('yiitest', $dsn->getDatabaseName());
     }
 
+    public function testGetDsnWithoutDatabaseName(): void
+    {
+        $dsn = new DsnSocket('mysql', '/var/run/mysqld/mysqld.sock', '', ['charset' => 'utf8']);
+
+        $this->assertSame('mysql:unix_socket=/var/run/mysqld/mysqld.sock;charset=utf8', $dsn->asString());
+        $this->assertSame('mysql:unix_socket=/var/run/mysqld/mysqld.sock;charset=utf8', $dsn->__toString());
+        $this->assertEmpty($dsn->getDatabaseName());
+
+        $dsn = new DsnSocket('mysql', '/var/run/mysqld/mysqld.sock', null, ['charset' => 'utf8']);
+
+        $this->assertSame('mysql:unix_socket=/var/run/mysqld/mysqld.sock;charset=utf8', $dsn->asString());
+        $this->assertSame('mysql:unix_socket=/var/run/mysqld/mysqld.sock;charset=utf8', $dsn->__toString());
+        $this->assertNull($dsn->getDatabaseName());
+    }
+
     public function testGetDriver(): void
     {
         $dsn = new DsnSocket('mysql', '/var/run/mysqld/mysqld.sock', 'yiitest', ['charset' => 'utf8']);
diff --git a/tests/Db/Connection/DsnTest.php b/tests/Db/Connection/DsnTest.php
@@ -53,6 +53,13 @@ public function testGetDsnWithoutDatabaseName(): void
 
         $this->assertSame('mysql:host=localhost;port=3306;charset=utf8', $dsn->asString());
         $this->assertSame('mysql:host=localhost;port=3306;charset=utf8', $dsn->__toString());
+        $this->assertEmpty($dsn->getDatabaseName());
+
+        $dsn = new Dsn('mysql', 'localhost', null, '3306', ['charset' => 'utf8']);
+
+        $this->assertSame('mysql:host=localhost;port=3306;charset=utf8', $dsn->asString());
+        $this->assertSame('mysql:host=localhost;port=3306;charset=utf8', $dsn->__toString());
+        $this->assertNull($dsn->getDatabaseName());
     }
 
     public function testGetHost(): void

Original file line number	Diff line number	Diff line change
`@@ -22,14 +22,18 @@ abstract class AbstractDsnSocket implements DsnInterface, Stringable`
`22`	`22`	`public function __construct(`
`23`	`23`	`private string $driver,`
`24`	`24`	`private string $unixSocket,`
`25`		`- private string $databaseName,`
	`25`	`+ private string\|null $databaseName = null,`
`26`	`26`	`private array $options = []`
`27`	`27`	`) {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public function asString(): string`
`31`	`31`	`{`
`32`		`- $dsn = "$this->driver:" . "unix_socket=$this->unixSocket" . ';' . "dbname=$this->databaseName";`
	`32`	`+ $dsn = "$this->driver:" . "unix_socket=$this->unixSocket";`
	`33`	`+`
	`34`	`+ if ($this->databaseName !== null && $this->databaseName !== '') {`
	`35`	`+ $dsn .= ';' . "dbname=$this->databaseName";`
	`36`	`+ }`
`33`	`37`
`34`	`38`	`$parts = [];`
`35`	`39`
`@@ -53,9 +57,9 @@ public function __toString(): string`
`53`	`57`	`}`
`54`	`58`
`55`	`59`	`/**`
`56`		`- * @return string The database name to connect to.`
	`60`	`+ * @return string\|null The database name to connect to.`
`57`	`61`	`*/`
`58`		`- public function getDatabaseName(): string`
	`62`	`+ public function getDatabaseName(): string\|null`
`59`	`63`	`{`
`60`	`64`	`return $this->databaseName;`
`61`	`65`	`}`