Improve DSN handling + Url Parsing

Author: peterfox

README.md

@@ -48,6 +48,12 @@ You need to add the connection type to the database config:
 ]
 ```
 
+You can also use URLs.
+
+```dotenv
+DATABASE_URL=cockroachdb://<username>:<password>@<host>:<port>/<database>?sslmode=verify-full
+```
+
 ## Usage
 
 To enable set `DB_CONNECTION=crdb` in your .env.
@@ -72,10 +78,9 @@ At current if you try to create a Fulltext index using the Schema builder or try
 method of the Query builder a `YlsIdeas\CockroachDb\Exceptions\FeatureNotSupportedException` exception will be thrown.
 
 ### Serverless Support
-Cockroach Serverless requires you to add an `options` parameter to the connection string.
-Laravel doesn't provide this out of the box, so, it's being implemented as an extra `cluster` parameter in the database config. Just pass the cluster identification from CockroachDB Serverless.
-
-Sample config snippet:
+Cockroach Serverless requires you to provide a cluster with connection.
+Laravel doesn't provide this out of the box, so, it's being implemented as an extra `cluster` parameter in the 
+database config. Just pass the cluster identification from CockroachDB Serverless.
 
 ```php
 'crdb' => [
@@ -95,6 +100,12 @@ Sample config snippet:
 ]
 ```
 
+You may also use a URL in the following format.
+
+```dotenv
+DATABASE_URL=cockroachdb://<username>:<password>@<host>:<port>/<database>?sslmode=verify-full&cluster=<cluster>
+```
+
 ## Testing
 
 The tests try to closely follow the same functionality of the grammar provided by Laravel

src/CockroachDbConnector.php

@@ -8,21 +8,15 @@
 class CockroachDbConnector extends PostgresConnector implements ConnectorInterface
 {
     /**
-     * Usually the normal PostgresConnector would suffice for Cockroach,
-     * but Cockroach Serverless Clusters need an extra parameter `options`.
+     * When using CockroachDB serverless it's possible to apply a namespace to the name of the database
+     * which then allows for the service to recognise which cluster is being used.
      */
-    protected function getDsn(array $config)
+    protected function getDsn(array $config): string
     {
-        return $this->addClusterOptions(parent::getDsn($config), $config);
-    }
-
-    protected function addClusterOptions(string $dsn, array $config)
-    {
-        if (isset($config['cluster']) && ! empty($config['cluster'])) {
-            $clusterNameEscaped = addslashes($config['cluster']);
-            $dsn .= ";options='--cluster={$clusterNameEscaped}'";
+        if (($config['cluster'] ?? false) && $config['cluster'] != '') {
+            $config['database'] = implode('.', [$config['cluster'], $config['database']]);
         }
 
-        return $dsn;
+        return parent::getDsn($config);
     }
 }

src/CockroachDbServiceProvider.php

@@ -3,17 +3,25 @@
 namespace YlsIdeas\CockroachDb;
 
 use Illuminate\Database\Connection;
+use Illuminate\Database\DatabaseManager;
+use Illuminate\Support\ConfigurationUrlParser;
 use Illuminate\Support\ServiceProvider;
 
 class CockroachDbServiceProvider extends ServiceProvider
 {
     public function register()
     {
-        Connection::resolverFor('crdb', function ($connection, $database, $prefix, $config) {
-            $connector = new CockroachDbConnector();
-            $connection = $connector->connect($config);
+        $this->app->extend(DatabaseManager::class, function (DatabaseManager $manager) {
+            ConfigurationUrlParser::addDriverAlias('cockroachdb', 'crdb');
 
-            return new CockroachDbConnection($connection, $database, $prefix, $config);
+            Connection::resolverFor('crdb', function ($connection, $database, $prefix, $config) {
+                $connector = new CockroachDbConnector();
+                $connection = $connector->connect($config);
+
+                return new CockroachDbConnection($connection, $database, $prefix, $config);
+            });
+
+            return $manager;
         });
     }
 }

tests/Database/ConfigurationUrlParserTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace YlsIdeas\CockroachDb\Tests\Database;
+
+use Illuminate\Support\ConfigurationUrlParser;
+use PHPUnit\Framework\TestCase;
+
+class ConfigurationUrlParserTest extends TestCase
+{
+    public function test_configuration_url_parser_can_parse_cockroach_db_urls()
+    {
+        ConfigurationUrlParser::addDriverAlias('cockroachdb', 'crdb');
+
+        $parser = new ConfigurationUrlParser();
+
+        $config = $parser->parseConfiguration([
+            'url' => 'cockroachdb://username:[email protected]:26257/defaultdb?sslmode=verify-full&cluster=my-cluster-123',
+        ]);
+
+        $this->assertSame([
+            'driver' => 'crdb',
+            'database' => 'defaultdb',
+            'host' => 'hostname.example.com',
+            'port' => 26257,
+            'username' => 'username',
+            'password' => 'password',
+            'sslmode' => 'verify-full',
+            'cluster' => 'my-cluster-123',
+        ], $config);
+    }
+}

tests/Database/DatabaseCockroachDbConnectorTest.php

@@ -20,7 +20,7 @@ public function test_dsn_params_with_cluster()
             ],
         );
 
-        $this->assertStringContainsString("options='--cluster=cluster-1234'", $dsnConfig);
+        $this->assertStringContainsString("dbname='cluster-1234.defaultdb'", $dsnConfig);
     }
 
     public function test_dsn_params_without_cluster()
@@ -36,13 +36,13 @@ public function test_dsn_params_without_cluster()
             ],
         );
 
-        $this->assertStringNotContainsString("options=", $dsnConfig);
+        $this->assertStringContainsString("dbname='defaultdb'", $dsnConfig);
     }
 
     protected function getConnector()
     {
         return new class () extends CockroachDbConnector {
-            public function exposeGetDsnMethod(array $config)
+            public function exposeGetDsnMethod(array $config): string
             {
                 return $this->getDsn($config);
             }