rock-n-code/ccn
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Activity

Optimizations for the Website service (#9)

Browse Source 
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>
This commit is contained in:
javier
2026-06-28 14:18:04 +00:00
committed by javier
parent 6b6389cb0f
commit 847058d642
16 changed files with 508 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Services/Website/Sources/App/App+build.swift
+6 -2
View File
@@ -155,7 +155,8 @@ private func logger(
/// responses larger than `minimumResponseSizeToCompress` when the client advertises support, the
/// not-found middleware that serves the error page, and the static file middleware that serves the
/// contents of `staticFilesPath` (tagging responses with the given `cacheControl` directives), then
/// adds the `RootController` routes that render the landing page.
/// adds the `RootController` routes that render the landing page and the `HealthController` routes
/// that serve the health check.
///
/// The security-headers middleware sits just inside request logging so it covers every response that
/// reaches a client — the landing page, the compressed responses, the rendered error page, and the
@@ -191,7 +192,10 @@ private func router(
)
}
router.addRoutes(RootController<AppRequestContext>().routes)
router.addRoutes {
RootController<AppRequestContext>().routes
HealthController<AppRequestContext>().routes
}
return router
}
Services/Website/Sources/Library/Internal/Enumerations/StaticFile.swift
+8 -3
View File
@@ -5,6 +5,8 @@
enum StaticFile: CaseIterable, Sendable {
/// The `js/app.js` script.
case appJS
/// The `css/error.css` stylesheet for the not-found page.
case errorCSS
/// The `favicon.ico` icon.
case faviconICO
/// The `icon.png` icon.
@@ -63,7 +65,8 @@ extension StaticFile {
/// The file's extension.
var fileExtension: Extension {
switch self {
case .styleCSS: .css
case .errorCSS,
.styleCSS: .css
case .appJS: .js
case .faviconICO: .ico
case .iconPNG: .png
@@ -77,6 +80,7 @@ extension StaticFile {
var fileName: String {
switch self {
case .appJS: "app"
case .errorCSS: "error"
case .faviconICO: "favicon"
case .iconPNG,
.iconSVG: "icon"
@@ -102,7 +106,7 @@ extension StaticFile {
///
/// - Parameter basePath: the directory the static files are served from.
/// - Returns: the path to the file, relative to the `basePath` path.
public func path(
func path(
relativeTo basePath: String
) -> String {
guard !basePath.isEmpty else {
@@ -124,7 +128,8 @@ private extension StaticFile {
var subdirectory: String? {
switch self {
case .appJS: "js"
case .styleCSS: "css"
case .errorCSS,
.styleCSS: "css"
default: nil
}
}
Services/Website/Sources/Library/Internal/Pages/ErrorPage.swift
+5 -51
View File
@@ -11,14 +11,17 @@ struct ErrorPage: HTMLDocument, Sendable {
p { "Sorry, but the page you were trying to view does not exist." }
}
/// The metadata and inline styles placed in the document head.
/// The metadata and stylesheet link placed in the document head.
var head: some HTML {
meta(.charset(.utf8))
meta(
.name(.viewport),
.content("width=device-width, initial-scale=1")
)
style { Self.styles }
link(
.rel(.stylesheet),
.href("/css/error.css")
)
}
/// The document language.
@@ -28,52 +31,3 @@ struct ErrorPage: HTMLDocument, Sendable {
var title: String { "Page Not Found" }
}
// MARK: - Constants
private extension ErrorPage {
/// The inline CSS applied to the page.
static let styles = """
* {
line-height: 1.2;
margin: 0;
}
html {
color: #888;
display: table;
font-family: sans-serif;
height: 100%;
text-align: center;
width: 100%;
}
body {
display: table-cell;
vertical-align: middle;
margin: 2em auto;
}
h1 {
color: #555;
font-size: 2em;
font-weight: 400;
}
p {
margin: 0 auto;
width: 280px;
}
@media only screen and (max-width: 280px) {
body, p {
width: 95%;
}
h1 {
font-size: 1.5em;
margin: 0 0 0.3em;
}
}
"""
}
Services/Website/Sources/Library/Internal/Pages/IndexPage.swift
+7 -5
View File
@@ -8,7 +8,7 @@ struct IndexPage: HTMLDocument, Sendable {
/// The page's content.
var body: some HTML {
p { "Hello world! This is HTML5 Boilerplate." }
script(.src("js/app.js")) {}
script(.src("/js/app.js")) {}
}
/// The metadata, stylesheet, icon, and manifest links placed in the document head.
@@ -20,7 +20,7 @@ struct IndexPage: HTMLDocument, Sendable {
)
link(
.rel(.stylesheet),
.href("css/style.css")
.href("/css/style.css")
)
link(
.rel(.icon),
@@ -40,11 +40,11 @@ struct IndexPage: HTMLDocument, Sendable {
)
link(
.rel("apple-touch-icon"),
.href("icon.png")
.href("/icon.png")
)
link(
.rel("manifest"),
.href("site.webmanifest")
.href("/site.webmanifest")
)
meta(
.name("theme-color"),
@@ -58,6 +58,8 @@ struct IndexPage: HTMLDocument, Sendable {
}
/// The document title.
var title: String { "" }
var title: String {
"Index page"
}
}
Services/Website/Sources/Library/Internal/Responses/CachedHTMLResponse.swift
+54
View File
@@ -0,0 +1,54 @@
import Elementary
import Hummingbird
import NIOCore
/// A pre-rendered HTTP response for a fully static HTML page.
///
/// The document is rendered to bytes once, at initialization, and every ``response()`` reuses those
/// bytes instead of re-rendering. This suits pages whose markup never changes between requests — the
/// landing page and the not-found page — avoiding a per-request Elementary render on hot paths.
///
/// The body is written as an unsized stream (no `Content-Length`), mirroring `HTMLResponse`, so the
/// response-compression middleware downstream treats it exactly as it would a freshly rendered page.
struct CachedHTMLResponse: Sendable {
// MARK: Properties
/// The status applied to every response.
private let status: HTTPResponse.Status
/// The page rendered to bytes once.
private let buffer: ByteBuffer
// MARK: Initializers
/// Renders the given document to bytes once.
/// - Parameters:
/// - status: the status applied to every response. Defaults to `.ok`.
/// - document: the static HTML document to render and cache.
init(
status: HTTPResponse.Status = .ok,
_ document: some HTMLDocument
) {
self.status = status
self.buffer = ByteBuffer(string: document.render())
}
// MARK: Methods
/// Builds a response from the cached, pre-rendered bytes.
///
/// Mirrors the `text/html; charset=utf-8` content type `HTMLResponse` produces, and leaves the
/// `Content-Length` unset so small pages remain eligible for compression.
/// - Returns: the response carrying the cached HTML body.
func response() -> Response {
Response(
status: status,
headers: [.contentType: "text/html; charset=utf-8"],
body: .init { [buffer] writer in
try await writer.write(buffer)
try await writer.finish(nil)
}
)
}
}
Services/Website/Sources/Library/Public/Controllers/HealthController.swift
+83
View File
@@ -0,0 +1,83 @@
import Hummingbird
import NIOCore
/// Serves the website's health-check route.
///
/// 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(HealthController<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 HealthController<Context: RequestContext>: Sendable {
// MARK: Properties
/// The JSON payload returned for every health check.
private let payload: String
// MARK: Initializers
/// Creates a health controller.
public init() {
self.payload = #"{"status":"ok"}"#
}
// MARK: Computed
/// The routes served by the controller.
///
/// Serves a `GET` request for the health path (`/health`) with a static JSON status payload.
public var routes: RouteCollection<Context> {
let routes = RouteCollection(context: Context.self)
routes.get(
.Health.check,
use: check
)
return routes
}
}
// MARK: - Helpers
private extension HealthController {
// MARK: Methods
/// Handles a request for the health check.
///
/// Returns a constant JSON body built directly per request — the payload is a tiny literal with no
/// rendering step, so there is nothing to pre-render or cache.
/// - Parameters:
/// - request: the incoming request.
/// - context: the context the request is resolved against.
/// - Returns: a `200 OK` response carrying the static JSON status payload.
@Sendable
func check(
request: Request,
context: some RequestContext
) -> Response {
Response(
status: .ok,
headers: [.contentType: "application/json"],
body: .init(byteBuffer: .init(string: payload))
)
}
}
// MARK: - Constants
private extension RouterPath {
/// A namespace for the ``HealthController`` route paths.
enum Health {
/// The path of the health-check endpoint.
static let check: RouterPath = "/health"
}
}
Services/Website/Sources/Library/Public/Controllers/RootController.swift
+16 -12
View File
@@ -1,5 +1,4 @@
import Hummingbird
import HummingbirdElementary
/// Serves the website's root routes.
///
@@ -12,14 +11,21 @@ import HummingbirdElementary
///
/// - 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{
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() {}
public init() {
self.cache = .init(IndexPage())
}
// MARK: Properties
// MARK: Computed
/// The routes served by the controller.
///
@@ -40,29 +46,27 @@ public struct RootController<Context: RequestContext> : Sendable{
// 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: an HTML response that renders the ``IndexPage``.
/// - Returns: the cached ``IndexPage`` response.
@Sendable
func index(
request: Request,
context: some RequestContext
) -> HTMLResponse {
.init {
IndexPage()
}
) -> Response {
cache.response()
}
}
// MARK: - Constants
extension RouterPath {
private extension RouterPath {
/// A namespace for the ``RootController`` route paths.
enum Root {
/// The path of the landing page.
Services/Website/Sources/Library/Public/Extensions/RouterMethods+RouteCollections.swift
+80
View File
@@ -0,0 +1,80 @@
import Hummingbird
/// A result builder that collects ``RouteCollection`` values into a stack.
///
/// Mirrors the `MiddlewareFixedTypeBuilder` Hummingbird uses for `addMiddleware`, letting route
/// collections be listed declaratively rather than added one statement at a time.
@resultBuilder
public enum RouteCollectionBuilder<Context: RequestContext> {
public static func buildExpression(
_ collection: RouteCollection<Context>
) -> [RouteCollection<Context>] {
[collection]
}
public static func buildBlock(
_ collections: [RouteCollection<Context>]...
) -> [RouteCollection<Context>] {
collections.flatMap { $0 }
}
public static func buildOptional(
_ collections: [RouteCollection<Context>]?
) -> [RouteCollection<Context>] {
collections ?? []
}
public static func buildEither(
first collections: [RouteCollection<Context>]
) -> [RouteCollection<Context>] {
collections
}
public static func buildEither(
second collections: [RouteCollection<Context>]
) -> [RouteCollection<Context>] {
collections
}
public static func buildArray(
_ collections: [[RouteCollection<Context>]]
) -> [RouteCollection<Context>] {
collections.flatMap { $0 }
}
}
// MARK: - Helpers
public extension RouterMethods {
// MARK: Methods
/// Adds route collections to the router using the ``RouteCollectionBuilder`` result builder.
///
/// Mirrors `addMiddleware`, letting controllers be listed declaratively:
///
/// ```swift
/// router.addRoutes {
/// RootController<AppRequestContext>().routes
/// HealthController<AppRequestContext>().routes
/// }
/// ```
///
/// Each collection is added at the router's root, exactly as a sequence of
/// `addRoutes(_:)` calls would.
/// - Parameter build: the route-collection stack result builder.
/// - Returns: the router, so calls can be chained.
@discardableResult
func addRoutes(
@RouteCollectionBuilder<Context> _ build: () -> [RouteCollection<Context>]
) -> Self {
for collection in build() {
addRoutes(collection)
}
return self
}
}
Services/Website/Sources/Library/Public/Extensions/String+Constants.swift
+5 -4
View File
@@ -11,10 +11,11 @@ extension String {
public enum Security {
/// The default `Content-Security-Policy`.
///
/// Restricts every resource to the site's own origin. `style-src` additionally allows
/// `'unsafe-inline'` because ``ErrorPage`` ships an inline `<style>` block; remove it once
/// the error page's styles move to an external stylesheet.
public static let contentSecurityPolicy = "default-src 'self'; style-src 'self' 'unsafe-inline'; object-src 'none'; base-uri 'self'; frame-ancestors 'none'"
/// Restricts every resource to the site's own origin (`default-src 'self'`), blocks plugins
/// (`object-src 'none'`), pins the document base URL (`base-uri 'self'`), and forbids framing
/// (`frame-ancestors 'none'`). Both pages link external stylesheets, so no inline-style
/// exception is required.
public static let contentSecurityPolicy = "default-src 'self'; object-src 'none'; base-uri 'self'; frame-ancestors 'none'"
/// The default `X-Content-Type-Options` (disables MIME sniffing).
public static let contentTypeOptions = "nosniff"
/// The default `X-Frame-Options` (forbids framing the page).
Services/Website/Sources/Library/Public/Middlewares/NotFoundMiddleware.swift
+14 -13
View File
@@ -1,6 +1,4 @@
import Elementary
import Hummingbird
import HummingbirdElementary
/// Serves a custom error page for requests that match neither a route nor a static file.
///
@@ -9,10 +7,20 @@ import HummingbirdElementary
/// ``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() {}
public init() {
self.cache = .init(
status: .notFound,
ErrorPage()
)
}
}
@@ -39,7 +47,8 @@ extension NotFoundMiddleware: RouterMiddleware {
) async throws -> Response {
do {
return try await next(request, context)
} catch let error {
}
catch let error {
guard
let responseError = error as? any HTTPResponseError,
responseError.status == .notFound
@@ -47,15 +56,7 @@ extension NotFoundMiddleware: RouterMiddleware {
throw error
}
return HTMLResponse(
status: .notFound
) {
ErrorPage()
}
.response(
from: request,
context: context
)
return cache.response()
}
}