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>
64 lines
1.9 KiB
Swift
64 lines
1.9 KiB
Swift
import Hummingbird
|
|
|
|
/// Serves a custom error page for requests that match neither a route nor a static file.
|
|
///
|
|
/// Placed ahead of `FileMiddleware` in the middleware chain, it catches the `.notFound` error
|
|
/// that bubbles up when no file exists for the requested path and responds with the rendered
|
|
/// ``ErrorPage`` and a `404 Not Found` status.
|
|
public struct NotFoundMiddleware<Context: RequestContext> {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The error page, rendered once at initialization and reused for every not-found response.
|
|
private let cache: CachedHTMLResponse
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Creates a not-found middleware.
|
|
public init() {
|
|
self.cache = .init(
|
|
status: .notFound,
|
|
ErrorPage()
|
|
)
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - RouterMiddleware
|
|
|
|
extension NotFoundMiddleware: RouterMiddleware {
|
|
|
|
// MARK: Functions
|
|
|
|
/// Passes the request down the chain, rendering the error page if it results in a not-found
|
|
/// response.
|
|
///
|
|
/// Any error other than `.notFound` is rethrown unchanged.
|
|
/// - Parameters:
|
|
/// - request: the incoming request.
|
|
/// - context: the context the request is resolved against.
|
|
/// - next: the next responder in the middleware chain.
|
|
/// - Returns: the downstream response, or the rendered ``ErrorPage`` with a `404 Not Found` status.
|
|
/// - Throws: any non-not-found error thrown downstream.
|
|
public func handle(
|
|
_ request: Request,
|
|
context: Context,
|
|
next: (Request, Context) async throws -> Response
|
|
) async throws -> Response {
|
|
do {
|
|
return try await next(request, context)
|
|
}
|
|
catch let error {
|
|
guard
|
|
let responseError = error as? any HTTPResponseError,
|
|
responseError.status == .notFound
|
|
else {
|
|
throw error
|
|
}
|
|
|
|
return cache.response()
|
|
}
|
|
}
|
|
|
|
}
|