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>
74 lines
4.3 KiB
Swift
74 lines
4.3 KiB
Swift
import Configuration
|
|
|
|
extension ConfigKey {
|
|
/// A namespace for the static files cache configuration keys.
|
|
public enum Cache {
|
|
/// The configuration key for the max-age, in seconds, applied to text-based static files (CSS, JavaScript, plain text).
|
|
public static let maxAgeText: ConfigKey = "cache.maxAge.text"
|
|
/// The configuration key for the max-age, in seconds, applied to image static files (ICO, PNG, SVG).
|
|
public static let maxAgeImage: ConfigKey = "cache.maxAge.image"
|
|
/// The configuration key for the max-age, in seconds, applied to all other static files (e.g. the web manifest).
|
|
public static let maxAgeDefault: ConfigKey = "cache.maxAge.default"
|
|
}
|
|
/// A namespace for the response compression configuration keys.
|
|
public enum Compression {
|
|
/// The configuration key for the minimum response body size, in bytes, before compression is applied.
|
|
public static let minResponseSize: ConfigKey = "compression.minimumResponseSize"
|
|
}
|
|
/// A namespace for the persistence configuration keys.
|
|
public enum Database {
|
|
/// The configuration key selecting migrate-and-exit mode (run migrations, then exit) instead of serving.
|
|
public static let migrate: ConfigKey = "database.migrate"
|
|
/// The configuration key for the persistence driver (`inMemory` or `mysql`).
|
|
public static let driver: ConfigKey = "database.driver"
|
|
/// The configuration key for the MySQL/MariaDB host.
|
|
public static let host: ConfigKey = "database.host"
|
|
/// The configuration key for the MySQL/MariaDB port.
|
|
public static let port: ConfigKey = "database.port"
|
|
/// The configuration key for the database name.
|
|
public static let name: ConfigKey = "database.name"
|
|
/// The configuration key for the database username.
|
|
public static let username: ConfigKey = "database.username"
|
|
/// The configuration key for the database password.
|
|
public static let password: ConfigKey = "database.password"
|
|
/// The configuration key for the TLS posture used when connecting (`off`, `prefer`, or `require`).
|
|
public static let tls: ConfigKey = "database.tls"
|
|
/// The configuration key for the maximum pooled connections per event loop.
|
|
public static let poolMaxPerEventLoop: ConfigKey = "database.pool.maxPerEventLoop"
|
|
}
|
|
/// A namespace for the HTTP server configuration keys.
|
|
public enum HTTP {
|
|
/// The configuration key for the host the server binds to.
|
|
public static let host: ConfigKey = "http.host"
|
|
/// The configuration key for the port the server listens on.
|
|
public static let port: ConfigKey = "http.port"
|
|
/// The configuration key for the server's name.
|
|
public static let serverName: ConfigKey = "http.serverName"
|
|
}
|
|
/// A namespace for the logging configuration keys.
|
|
public enum Log {
|
|
/// The configuration key for the minimum log level.
|
|
public static let level: ConfigKey = "log.level"
|
|
}
|
|
/// A namespace for the path configuration keys.
|
|
public enum Path {
|
|
/// The configuration key for the directory the static files are served from.
|
|
public static let staticFiles: ConfigKey = "path.staticFiles"
|
|
}
|
|
/// A namespace for the security headers configuration keys.
|
|
public enum Security {
|
|
/// The configuration key for the `Content-Security-Policy` header value.
|
|
public static let contentSecurityPolicy: ConfigKey = "security.contentSecurityPolicy"
|
|
/// The configuration key for the `X-Content-Type-Options` header value.
|
|
public static let contentTypeOptions: ConfigKey = "security.contentTypeOptions"
|
|
/// The configuration key for the `X-Frame-Options` header value.
|
|
public static let frameOptions: ConfigKey = "security.frameOptions"
|
|
/// The configuration key for the `Referrer-Policy` header value.
|
|
public static let referrerPolicy: ConfigKey = "security.referrerPolicy"
|
|
/// The configuration key for the `Permissions-Policy` header value.
|
|
public static let permissionsPolicy: ConfigKey = "security.permissionsPolicy"
|
|
/// The configuration key for the `Strict-Transport-Security` header value (omitted when unset).
|
|
public static let strictTransportSecurity: ConfigKey = "security.strictTransportSecurity"
|
|
}
|
|
}
|