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

HTML rendering support for the Website service (#5)

Browse Source 
This PR contains the work done to replace the use of static _HTML_ files with type-safe HTML rendered server-side via **Elementary** through **Hummingbird**.

To provide further details about the work done:

* Added the **Elementary** dependencies.
* Added the `IndexPage` and `ErrorPage` pages, ported from the old HTML boilerplate; removed the static files.
* Added the `RootController` controller serving GET / using the `IndexPage` page, wired into the router.
* Reworked the `NotFoundMiddleware` middleare to render `ErrorPage` page directly; non-notFound errors still propagate.
* the `FileMiddleware` middleware no longer searches for any static `index.html` file.
* Simplified the `StaticFile` enumeration, dropped unused constants and now-unnecessary throws.

Reviewed-on: rock-n-code/loud-amsterdam#5
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 05:07:19 +00:00
committed by javier
parent f5f14eb97c
commit a621ada0bf
17 changed files with 460 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Services/Website/Sources/App/App+build.swift
+8 -10
View File
@@ -9,10 +9,9 @@ import WebsiteCore
/// then assembles the router, server configuration, and logger.
/// - Parameter reader: the configuration reader the values are read from.
/// - Returns: the configured application, ready to run as a service.
/// - Throws: an error if the router fails to build.
func application(
reader: ConfigReader
) async throws -> some ApplicationProtocol {
) async -> some ApplicationProtocol {
let logLevel = reader.string(
forKey: .Log.level,
as: Logger.Level.self,
@@ -65,9 +64,9 @@ private func logger(
/// Builds the application's router.
///
/// Registers, in order, the request-logging middleware, the not-found middleware that serves
/// the error page, and the static file middleware that serves the contents of `staticFilesPath`
/// (falling back to `index.html` for directory requests).
/// Registers the request-logging middleware, the not-found middleware that serves the error
/// page, and the static file middleware that serves the contents of `staticFilesPath`, then
/// adds the `RootController` routes that render the landing page.
/// - Parameters:
/// - staticFilesPath: the folder, relative to the working directory, the static files are served from.
/// - logLevel: the level the request-logging middleware logs at.
@@ -80,12 +79,11 @@ private func router(
router.addMiddleware {
LogRequestsMiddleware(logLevel)
NotFoundMiddleware(staticFilesPath)
FileMiddleware(
staticFilesPath,
searchForIndexHtml: true
)
NotFoundMiddleware()
FileMiddleware(staticFilesPath)
}
router.addRoutes(RootController<AppRequestContext>().routes)
return router
}
Services/Website/Sources/App/App.swift
+1 -1
View File
@@ -19,7 +19,7 @@ struct App {
]
)
let app = try await application(
let app = await application(
reader: reader
)
Services/Website/Sources/Library/Internal/Enumerations/StaticFile.swift
+4 -38
View File
@@ -1,5 +1,3 @@
import Foundation
/// A static file shipped with the website service.
///
/// Each case identifies a file stored under the static files root (the `Resources/Static`
@@ -7,16 +5,12 @@ import Foundation
enum StaticFile: CaseIterable, Sendable {
/// The `js/app.js` script.
case appJS
/// The `404.html` error page.
case errorHTML
/// The `favicon.ico` icon.
case faviconICO
/// The `icon.png` icon.
case iconPNG
/// The `icon.svg` icon.
case iconSVG
/// The `index.html` landing page.
case indexHTML
/// The `robots.txt` crawler directives.
case robotsTXT
/// The `site.webmanifest` web application manifest.
@@ -32,8 +26,6 @@ extension StaticFile {
enum Extension: String, Sendable {
/// A Cascading Style Sheets file.
case css
/// A HyperText Markup Language file.
case html
/// A JavaScript file.
case js
/// A Portable Network Graphics image.
@@ -59,7 +51,6 @@ extension StaticFile {
var contentType: String {
switch fileExtension {
case .css: "text/css"
case .html: "text/html"
case .js: "text/javascript"
case .png: "image/png"
case .ico: "image/vnd.microsoft.icon"
@@ -74,8 +65,6 @@ extension StaticFile {
switch self {
case .styleCSS: .css
case .appJS: .js
case .errorHTML,
.indexHTML: .html
case .faviconICO: .ico
case .iconPNG: .png
case .iconSVG: .svg
@@ -88,11 +77,9 @@ extension StaticFile {
var fileName: String {
switch self {
case .appJS: "app"
case .errorHTML: "404"
case .faviconICO: "favicon"
case .iconPNG,
.iconSVG: "icon"
case .indexHTML: "index"
case .robotsTXT: "robots"
case .siteWebmanifest: "site"
case .styleCSS: "style"
@@ -103,18 +90,10 @@ extension StaticFile {
///
/// This also matches the URL path the file is served at by `FileMiddleware`.
var relativePath: String {
let file = String(
format: Constant.Format.file,
fileName,
fileExtension.rawValue
)
let file = "\(fileName).\(fileExtension.rawValue)"
return subdirectory
.map { .init(
format: Constant.Format.path,
$0,
file
)} ?? file
.map { "\($0)/\(file)" } ?? file
}
// MARK: Methods
@@ -129,12 +108,8 @@ extension StaticFile {
guard !basePath.isEmpty else {
return relativePath
}
return .init(
format: Constant.Format.path,
basePath,
relativePath
)
return "\(basePath)/\(relativePath)"
}
}
@@ -155,12 +130,3 @@ private extension StaticFile {
}
}
// MARK: - Constants
private enum Constant {
enum Format {
static let file = "%@.%@"
static let path = "%@/%@"
}
}
Services/Website/Sources/Library/Internal/Pages/ErrorPage.swift
+79
View File
@@ -0,0 +1,79 @@
import Elementary
/// The HTML page rendered for a not-found response.
struct ErrorPage: HTMLDocument, Sendable {
// MARK: Document
/// The page's content.
var body: some HTML {
h1 { "Page Not Found" }
p { "Sorry, but the page you were trying to view does not exist." }
}
/// The metadata and inline styles 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 }
}
/// The document language.
var lang: String { "en" }
/// The document title.
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
+63
View File
@@ -0,0 +1,63 @@
import Elementary
/// The website's landing page.
struct IndexPage: HTMLDocument, Sendable {
// MARK: Document
/// The page's content.
var body: some HTML {
p { "Hello world! This is HTML5 Boilerplate." }
script(.src("js/app.js")) {}
}
/// The metadata, stylesheet, icon, and manifest links placed in the document head.
var head: some HTML {
meta(.charset(.utf8))
meta(
.name(.viewport),
.content("width=device-width, initial-scale=1")
)
link(
.rel(.stylesheet),
.href("css/style.css")
)
link(
.rel(.icon),
.href("/favicon.ico"),
.custom(
name: "sizes",
value: "any"
)
)
link(
.rel(.icon),
.href("/icon.svg"),
.custom(
name: "type",
value: "image/svg+xml"
)
)
link(
.rel("apple-touch-icon"),
.href("icon.png")
)
link(
.rel("manifest"),
.href("site.webmanifest")
)
meta(
.name("theme-color"),
.content("#fafafa")
)
}
/// The document language.
var lang: String {
"en"
}
/// The document title.
var title: String { "" }
}
Services/Website/Sources/Library/Public/Controllers/RootController.swift
+71
View File
@@ -0,0 +1,71 @@
import Hummingbird
import HummingbirdElementary
/// 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: Initializers
/// Creates a root controller.
public init() {}
// MARK: Properties
/// 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: an HTML response that renders the ``IndexPage``.
@Sendable
func index(
request: Request,
context: some RequestContext
) -> HTMLResponse {
.init {
IndexPage()
}
}
}
// MARK: - Constants
extension RouterPath {
/// A namespace for the ``RootController`` route paths.
enum Root {
/// The path of the landing page.
static let index: RouterPath = "/"
}
}
Services/Website/Sources/Library/Public/Extensions/ConfigValue+Constants.swift
-9
View File
@@ -3,16 +3,7 @@ import Configuration
extension ConfigValue {
/// A namespace for the HTTP server's default configuration values.
public enum HTTP {
/// The default host the server binds to.
public static let host: ConfigValue = .init(stringLiteral: "127.0.0.1")
/// The default port the server listens on.
public static let port: ConfigValue = .init(stringLiteral: "0")
/// The default server name.
public static let serverName: ConfigValue = .init(stringLiteral: .Server.name)
}
/// A namespace for the logging default configuration values.
enum Log {
/// The default minimum log level.
public static let level: ConfigValue = .init(stringLiteral: "trace")
}
}
Services/Website/Sources/Library/Public/Middlewares/NotFoundMiddleware.swift
+27 -45
View File
@@ -1,46 +1,19 @@
import Foundation
import Elementary
import Hummingbird
import NIOCore
import HummingbirdElementary
/// 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 preloaded
/// error page and a `404 Not Found` status.
/// 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 body of the error page served on a not-found response.
private let page: ByteBuffer
// MARK: Initializers
/// Creates a middleware that serves the error page (`404.html`) from the static files folder.
///
/// The page is read once, at construction. A minimal fallback body is used when the file is
/// missing.
/// - Parameter staticFilesPath: the folder, relative to the working directory, the static files are served from.
public init(
_ staticFilesPath: String
) {
let path = StaticFile.errorHTML.path(relativeTo: staticFilesPath)
if let data = try? Data(contentsOf: URL(fileURLWithPath: path)) {
self.init(page: .init(bytes: data))
} else {
self.init(page: .init(string: "404 Not Found"))
}
}
/// Creates a middleware that serves the given error page on a not-found response.
/// - Parameter page: the body of the error page.
init(
page: ByteBuffer
) {
self.page = page
}
/// Creates a not-found middleware.
public init() {}
}
// MARK: - RouterMiddleware
@@ -49,6 +22,16 @@ 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,
@@ -57,7 +40,6 @@ extension NotFoundMiddleware: RouterMiddleware {
do {
return try await next(request, context)
} catch let error {
// Only intercept "not found"; let every other error propagate.
guard
let responseError = error as? any HTTPResponseError,
responseError.status == .notFound
@@ -65,14 +47,14 @@ extension NotFoundMiddleware: RouterMiddleware {
throw error
}
var headers = HTTPFields()
headers[.contentType] = StaticFile.errorHTML.contentType
return Response(
status: .notFound,
headers: headers,
body: .init(byteBuffer: page)
return HTMLResponse(
status: .notFound
) {
ErrorPage()
}
.response(
from: request,
context: context
)
}
}