Config: Move database DSN-related functionality to "pkg/dsn" #47 photoprism#5285

Signed-off-by: Michael Mayer <[email protected]>

Author: lastzero

internal/commands/cluster_register_http_test.go

@@ -15,6 +15,7 @@ import (
 	cfg "github.com/photoprism/photoprism/internal/config"
 	"github.com/photoprism/photoprism/internal/photoprism/get"
 	"github.com/photoprism/photoprism/internal/service/cluster"
+	"github.com/photoprism/photoprism/pkg/dsn"
 )
 
 func TestClusterRegister_HTTPHappyPath(t *testing.T) {
@@ -66,8 +67,8 @@ func TestClusterRegister_HTTPHappyPath(t *testing.T) {
 	assert.Equal(t, "pp-node-02", gjson.Get(out, "Node.Name").String())
 	assert.Equal(t, cluster.ExampleClientSecret, gjson.Get(out, "Secrets.ClientSecret").String())
 	assert.Equal(t, "pwd", gjson.Get(out, "Database.Password").String())
-	dsn := gjson.Get(out, "Database.DSN").String()
-	parsed := cfg.NewDSN(dsn)
+	dbDsn := gjson.Get(out, "Database.DSN").String()
+	parsed := dsn.Parse(dbDsn)
 	assert.Equal(t, "user", parsed.User)
 	assert.Equal(t, "pwd", parsed.Password)
 	assert.Equal(t, "tcp", parsed.Net)
@@ -238,8 +239,8 @@ func TestClusterNodesRotate_HTTPJson(t *testing.T) {
 	assert.Equal(t, "pp-node-04", gjson.Get(out, "Node.Name").String())
 	assert.Equal(t, secret, gjson.Get(out, "Secrets.ClientSecret").String())
 	assert.Equal(t, "pwd3", gjson.Get(out, "Database.Password").String())
-	dsn := gjson.Get(out, "Database.DSN").String()
-	parsed := cfg.NewDSN(dsn)
+	dbDsn := gjson.Get(out, "Database.DSN").String()
+	parsed := dsn.Parse(dbDsn)
 	assert.Equal(t, "user", parsed.User)
 	assert.Equal(t, "pwd3", parsed.Password)
 	assert.Equal(t, "tcp", parsed.Net)
@@ -304,8 +305,8 @@ func TestClusterNodesRotate_DBOnly_JSON(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, "pp-node-05", gjson.Get(out, "Node.Name").String())
 	assert.Equal(t, "pwd4", gjson.Get(out, "Database.Password").String())
-	dsn := gjson.Get(out, "Database.DSN").String()
-	parsed := cfg.NewDSN(dsn)
+	dbDsn := gjson.Get(out, "Database.DSN").String()
+	parsed := dsn.Parse(dbDsn)
 	assert.Equal(t, "pp_user", parsed.User)
 	assert.Equal(t, "pwd4", parsed.Password)
 	assert.Equal(t, "tcp", parsed.Net)
@@ -627,8 +628,8 @@ func TestClusterRegister_RotateDatabase_JSON(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, "pp-node-07", gjson.Get(out, "Node.Name").String())
 	assert.Equal(t, "pwd7", gjson.Get(out, "Database.Password").String())
-	dsn := gjson.Get(out, "Database.DSN").String()
-	parsed := cfg.NewDSN(dsn)
+	dbDsn := gjson.Get(out, "Database.DSN").String()
+	parsed := dsn.Parse(dbDsn)
 	assert.Equal(t, "pp_user", parsed.User)
 	assert.Equal(t, "pwd7", parsed.Password)
 	assert.Equal(t, "tcp", parsed.Net)

internal/config/config_db.go

@@ -21,33 +21,20 @@ import (
 	"github.com/photoprism/photoprism/internal/mutex"
 	"github.com/photoprism/photoprism/internal/service/cluster"
 	"github.com/photoprism/photoprism/pkg/clean"
+	"github.com/photoprism/photoprism/pkg/dsn"
 	"github.com/photoprism/photoprism/pkg/txt"
 )
 
 // SQL Databases.
 // TODO: PostgreSQL support requires upgrading GORM, so generic column data types can be used.
 const (
 	Auto     = "auto"
-	MySQL    = "mysql"
-	MariaDB  = "mariadb"
-	Postgres = "postgres"
-	SQLite3  = "sqlite3"
+	MySQL    = dsn.DriverMySQL
+	MariaDB  = dsn.DriverMariaDB
+	Postgres = dsn.DriverPostgres
+	SQLite3  = dsn.DriverSQLite3
 )
 
-// SQLite default DSNs.
-const (
-	SQLiteTestDB    = ".test.db"
-	SQLiteMemoryDSN = ":memory:"
-)
-
-// DatabaseDSNParams maps required DSN parameters by driver type.
-var DatabaseDSNParams = Values{
-	MySQL:    "charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true",
-	MariaDB:  "charset=utf8mb4,utf8&collation=utf8mb4_unicode_ci&parseTime=true",
-	Postgres: "sslmode=disable TimeZone=UTC",
-	SQLite3:  "_busy_timeout=5000",
-}
-
 // DatabaseDriver returns the database driver name.
 func (c *Config) DatabaseDriver() string {
 	c.normalizeDatabaseDSN()
@@ -145,7 +132,7 @@ func (c *Config) DatabaseDSN() string {
 				c.DatabasePassword(),
 				databaseServer,
 				c.DatabaseName(),
-				DatabaseDSNParams[MySQL],
+				dsn.Params[dsn.DriverMySQL],
 				c.DatabaseTimeout(),
 			)
 		case Postgres:
@@ -157,10 +144,10 @@ func (c *Config) DatabaseDSN() string {
 				c.DatabaseHost(),
 				c.DatabasePort(),
 				c.DatabaseTimeout(),
-				DatabaseDSNParams[Postgres],
+				dsn.Params[dsn.DriverPostgres],
 			)
 		case SQLite3:
-			return filepath.Join(c.StoragePath(), fmt.Sprintf("index.db?%s", DatabaseDSNParams[SQLite3]))
+			return filepath.Join(c.StoragePath(), fmt.Sprintf("index.db?%s", dsn.Params[dsn.DriverSQLite3]))
 		default:
 			log.Errorf("config: empty database dsn")
 			return ""
@@ -172,7 +159,7 @@ func (c *Config) DatabaseDSN() string {
 		c.options.DatabaseDSN = fmt.Sprintf(
 			"%s?%s&timeout=%ds",
 			c.options.DatabaseDSN,
-			DatabaseDSNParams[MySQL],
+			dsn.Params[dsn.DriverMySQL],
 			c.DatabaseTimeout())
 	}
 
@@ -209,7 +196,7 @@ func (c *Config) ParseDatabaseDSN() {
 		return
 	}
 
-	d := NewDSN(c.options.DatabaseDSN)
+	d := dsn.Parse(c.options.DatabaseDSN)
 
 	c.options.DatabaseName = d.Name
 	c.options.DatabaseServer = d.Server
@@ -244,8 +231,8 @@ func (c *Config) DatabaseHost() string {
 		return ""
 	}
 
-	dsn := NewDSN(c.DatabaseDSN())
-	return dsn.Host()
+	d := dsn.Parse(c.DatabaseDSN())
+	return d.Host()
 }
 
 // DatabasePort the database server port.
@@ -256,8 +243,8 @@ func (c *Config) DatabasePort() int {
 		return 0
 	}
 
-	dsn := NewDSN(c.DatabaseDSN())
-	return dsn.Port()
+	d := dsn.Parse(c.DatabaseDSN())
+	return d.Port()
 }
 
 // DatabasePortString the database server port as string.