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>
46 lines
1.4 KiB
Swift
46 lines
1.4 KiB
Swift
import FluentKit
|
|
import Foundation
|
|
|
|
/// A FluentKit model of a single `example_records` row.
|
|
///
|
|
/// This is reference scaffolding: it demonstrates the model → migration → repository pattern the rest of
|
|
/// the package is built around, and is what the tests exercise. Replace it with the first real domain model
|
|
/// (paired with its own migration and repository) once one is defined.
|
|
///
|
|
/// FluentKit models are mutable reference types whose property wrappers are not `Sendable`; the model never
|
|
/// crosses a concurrency boundary (repositories map it to a `Sendable` snapshot before returning), so the
|
|
/// conformance is declared `@unchecked Sendable`.
|
|
final class ExampleRecord: Model, @unchecked Sendable {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The name of the backing table.
|
|
static let schema = "example_records"
|
|
|
|
/// The row's primary key, assigned on first save.
|
|
@ID(key: .id)
|
|
var id: UUID?
|
|
|
|
/// The row's name column.
|
|
@Field(key: "name")
|
|
var name: String
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Creates an empty record, as required by FluentKit to hydrate query results.
|
|
init() {}
|
|
|
|
/// Creates a record with the given values.
|
|
/// - Parameters:
|
|
/// - id: the primary key, or `nil` to have one assigned on save.
|
|
/// - name: the value of the name column.
|
|
init(
|
|
id: UUID? = nil,
|
|
name: String
|
|
) {
|
|
self.id = id
|
|
self.name = name
|
|
}
|
|
|
|
}
|