PostgreSQLDatabaseConfig.swift

import Foundation
import NIOOpenSSL

/// Config options for a `PostgreSQLConnection`
public struct PostgreSQLDatabaseConfig {
    /// Creates a `PostgreSQLDatabaseConfig` with default settings.
    public static func `default`() -> PostgreSQLDatabaseConfig {
        return .init(hostname: "localhost", port: 5432, username: "postgres")
    }

    /// Destination hostname.
    public let hostname: String

    /// Destination port.
    public let port: Int

    /// Username to authenticate.
    public let username: String
    
    /// Optional database name to use during authentication.
    /// Defaults to the username.
    public let database: String?
    
    /// Optional password to use for authentication.
    public let password: String?
    
    /// Optional TLSConfiguration. Set this if your PostgreSQL server requires an SSL connection
    /// For paid Heroku Postgres plans, set this to `.forClient(certificateVerification: .none)`
    public let tlsConfiguration: TLSConfiguration?
    
    /// Creates a new `PostgreSQLDatabaseConfig`.
    public init(hostname: String, port: Int = 5432, username: String, database: String? = nil, password: String? = nil, tlsConfiguration: TLSConfiguration? = nil) {
        self.hostname = hostname
        self.port = port
        self.username = username
        self.database = database
        self.password = password
        self.tlsConfiguration = tlsConfiguration
    }

    /// Creates a `PostgreSQLDatabaseConfig` frome a connection string.
    public init(url urlString: String, tlsConfiguration: TLSConfiguration? = nil) throws {
        guard let url = URL(string: urlString),
            let hostname = url.host,
            let port = url.port,
            let username = url.user,
            url.path.count > 0
        else {
            throw PostgreSQLError(
                identifier: "Bad Connection String",
                reason: "Host could not be parsed",
                possibleCauses: ["Foundation URL is unable to parse the provided connection string"],
                suggestedFixes: ["Check the connection string being passed"],
                source: .capture()
            )
        }
        self.hostname = hostname
        self.port = port
        self.username = username
        let database = url.path
        if database.hasPrefix("/") {
            self.database = database.dropFirst().description
        } else {
            self.database = database
        }
        self.password = url.password
        self.tlsConfiguration = tlsConfiguration
    }
}