javier
dc6b22e648
This PR contains the work done to introduce a _Fluent_-based persistence layer for the Website service, selectable at runtime alongside the existing in-memory default, plus the local dev tooling and docs to support it. To provide further details about the work: * Persistence package * The `Driver` and `TLS` enumerations * The `Configuration` type * The `Service` factory that builds the service * `PrepareDB` for migrations registration * The `Probe` for readiness checks. * App integration * Builds the driver, registers migrations, and attaches `Fluent` to the service lifecycle so it starts/stops with the HTTP server. * Migrate-on-boot is gated to the in-memory backend; MySQL/MariaDB is migrated out of band via --database-migrate so shared databases never race on startup. * The `ConfigReader+Properties` extension maps database.* config keys onto the driver. * Library * Added database configuration constants. * The `HealthController` controller gains a readiness probe: `GET /health/ready` checks whether the database is reachable, separate from the existing liveness check. * Others * Updated the `docker-compose` files to support a database service behind a database profile, and hardened for local development * New database targets on the `Makefile` file and overall documentation updated * Updated the `.env.local`, `Dockerfile`, and `README` files to document the persistence workflow, config keys, and local DB commands Reviewed-on: rock-n-code/loud-amsterdam#13 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
50 lines
1.7 KiB
Swift
50 lines
1.7 KiB
Swift
import HummingbirdFluent
|
|
import SQLKit
|
|
|
|
/// A readiness probe reporting whether the database behind a `Fluent` service is reachable.
|
|
///
|
|
/// Built once around the application's `Fluent` service and called as a function whenever a fresh
|
|
/// answer is needed — typically from a readiness endpoint: `let ready = await probe()`.
|
|
public struct Probe: Sendable {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The `Fluent` service whose default database is probed.
|
|
private let fluent: Fluent
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Creates a probe for the default database of the given `Fluent` service.
|
|
/// - Parameter fluent: the `Fluent` service whose default database is probed.
|
|
public init(
|
|
fluent: Fluent
|
|
) {
|
|
self.fluent = fluent
|
|
}
|
|
|
|
// MARK: Methods
|
|
|
|
/// Reports whether the database behind the `Fluent` service is reachable.
|
|
///
|
|
/// Runs a trivial `SELECT 1` against the default database — the cheapest statement both the MySQL/MariaDB
|
|
/// and SQLite backends understand — so a readiness check does not depend on any particular schema or model.
|
|
/// Any failure (connection refused, authentication error, pool exhausted) is reported as not reachable
|
|
/// rather than thrown, so callers can map it straight onto a readiness response. A default database that
|
|
/// is not an SQL database is likewise reported as not reachable.
|
|
/// - Returns: `true` when the database answers the probe, `false` otherwise.
|
|
public func callAsFunction() async -> Bool {
|
|
guard let database = fluent.db() as? any SQLDatabase else {
|
|
return false
|
|
}
|
|
|
|
do {
|
|
try await database.raw("SELECT 1").run()
|
|
|
|
return true
|
|
} catch {
|
|
return false
|
|
}
|
|
|
|
}
|
|
}
|