javier
847058d642
This PR contains the work done to provide optimizations to the current service, such as a health-check endpoint, pre-renders static HTML pages, and hardens the error page's CSP. To provide further details about the work: * Added the `HealthController` controller serving GET `/health` with a static JSON payload. * Added the `CachedHTMLResponse` response, which renders a static HTMLDocument to bytes once and reuses them per request (no Content-Length, so responses stay compressible). * Integrated the response into the `RootController` and the `NotFoundMiddleware` middleware to avoid re-rendering on hot paths. * Added a `RouterMethods.addRoutes(_:)` extension and switched the router in App+build to use it. * Moved the inline style from the `ErrorPage` page into a dedicated style file so the CSP needs no inline-style escape hatch. * Fixed the `IndexPage` page path inconsistencies. * Written the `README` file. Reviewed-on: rock-n-code/loud-amsterdam#9 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
76 lines
1.8 KiB
Swift
76 lines
1.8 KiB
Swift
import Hummingbird
|
|
|
|
/// Serves the website's root routes.
|
|
///
|
|
/// The controller exposes its routes as a `RouteCollection` so they can be added to a router
|
|
/// (or a sub-group) by the application that composes it:
|
|
///
|
|
/// ```swift
|
|
/// router.addRoutes(RootController<AppRequestContext>().routes)
|
|
/// ```
|
|
///
|
|
/// - Note: `Context` is the request context the routes are resolved against, and must match the
|
|
/// context of the router the routes are added to.
|
|
public struct RootController<Context: RequestContext>: Sendable {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The landing page, rendered once at initialization and reused for every request.
|
|
private let cache: CachedHTMLResponse
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Creates a root controller.
|
|
public init() {
|
|
self.cache = .init(IndexPage())
|
|
}
|
|
|
|
// MARK: Computed
|
|
|
|
/// The routes served by the controller.
|
|
///
|
|
/// Serves a `GET` request for the root path (`/`) by rendering the ``IndexPage``.
|
|
public var routes: RouteCollection<Context> {
|
|
let routes = RouteCollection(context: Context.self)
|
|
|
|
routes.get(
|
|
.Root.index,
|
|
use: index
|
|
)
|
|
|
|
return routes
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
private extension RootController {
|
|
|
|
// MARK: Methods
|
|
|
|
/// Handles a request for the landing page.
|
|
/// - Parameters:
|
|
/// - request: the incoming request.
|
|
/// - context: the context the request is resolved against.
|
|
/// - Returns: the cached ``IndexPage`` response.
|
|
@Sendable
|
|
func index(
|
|
request: Request,
|
|
context: some RequestContext
|
|
) -> Response {
|
|
cache.response()
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - Constants
|
|
|
|
private extension RouterPath {
|
|
/// A namespace for the ``RootController`` route paths.
|
|
enum Root {
|
|
/// The path of the landing page.
|
|
static let index: RouterPath = "/"
|
|
}
|
|
}
|