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/Tests/App/AppTests.swift
+21 -37
View File
@@ -27,21 +27,16 @@ struct AppTests {
@Test
func `landing page to be served at root`() async throws {
let file: StaticFile = .indexHTML
let app = try await application(
reader: reader(
staticFilesPath: staticFilesPath
)
)
try await app.test(.router) { client in
try await client.execute(
uri: "/",
method: .get
) { response in
let body = String(buffer: response.body)
#expect(response.status == .ok)
#expect(response.headers[.contentType] == file.contentType)
#expect(response.body == data(of: file))
#expect(response.headers[.contentType]?.hasPrefix("text/html") == true)
#expect(body.contains("Hello world!"))
}
}
}
@@ -50,12 +45,6 @@ struct AppTests {
func `static files to be served`(
staticFile file: StaticFile
) async throws {
let app = try await application(
reader: reader(
staticFilesPath: staticFilesPath
)
)
try await app.test(.router) { client in
try await client.execute(
uri: "/\(file.relativePath)",
@@ -69,21 +58,16 @@ struct AppTests {
@Test
func `error page to be served when not found`() async throws {
let file: StaticFile = .errorHTML
let app = try await application(
reader: reader(
staticFilesPath: staticFilesPath
)
)
try await app.test(.router) { client in
try await client.execute(
uri: "/this-path-does-not-exist",
method: .get
) { response in
let body = String(buffer: response.body)
#expect(response.status == .notFound)
#expect(response.headers[.contentType] == file.contentType)
#expect(response.body == data(of: file))
#expect(response.headers[.contentType]?.hasPrefix("text/html") == true)
#expect(body.contains("Page Not Found"))
}
}
}
@@ -94,28 +78,28 @@ struct AppTests {
private extension AppTests {
// MARK: Methods
// MARK: Computed
func data(
of file: StaticFile
) -> ByteBuffer {
let url = URL(fileURLWithPath: file.path(relativeTo: staticFilesPath))
guard let data = try? Data(contentsOf: url) else {
return ByteBuffer()
var app: some ApplicationProtocol {
get async {
await application(
reader: reader(
staticFilesPath: staticFilesPath
)
)
}
return ByteBuffer(bytes: data)
}
// MARK: Methods
func reader(
staticFilesPath: String
) -> ConfigReader {
ConfigReader(providers: [
InMemoryProvider(values: [
.HTTP.host: .HTTP.host,
.HTTP.port: .HTTP.port,
.Log.level: .Log.level,
.HTTP.host: "127.0.0.1",
.HTTP.port: "0",
.Log.level: "trace",
.Path.staticFiles: .init(stringLiteral: staticFilesPath),
])
])
Services/Website/Tests/Library/Cases/Internal/Enumerations/StaticFileTests.swift
+1 -9
View File
@@ -82,7 +82,7 @@ struct StaticFileTests {
@Test
func `all cases`() {
#expect(File.allCases.count == 9)
#expect(File.allCases.count == 7)
}
}
@@ -95,44 +95,36 @@ private extension StaticFileTests {
static let contentTypes: [String] = [
"text/javascript",
"text/html",
"image/vnd.microsoft.icon",
"image/png",
"image/svg+xml",
"text/html",
"text/plain",
"application/manifest+json",
"text/css"
]
static let fileExtensions: [FileExtension] = [
.js,
.html,
.ico,
.png,
.svg,
.html,
.txt,
.webmanifest,
.css
]
static let fileNames: [String] = [
"app",
"404",
"favicon",
"icon",
"icon",
"index",
"robots",
"site",
"style"
]
static let relativePaths: [String] = [
"js/app.js",
"404.html",
"favicon.ico",
"icon.png",
"icon.svg",
"index.html",
"robots.txt",
"site.webmanifest",
"css/style.css"
Services/Website/Tests/Library/Cases/Internal/Pages/ErrorPageTests.swift
+20
View File
@@ -0,0 +1,20 @@
import Elementary
import Testing
@testable import WebsiteCore
@Suite("ErrorPage page")
struct ErrorPageTests {
// MARK: Functional tests
@Test
func `renders its markup`() {
let html = ErrorPage().render()
#expect(html.contains("<!DOCTYPE html>"))
#expect(html.contains("Page Not Found"))
#expect(html.contains("does not exist"))
}
}
Services/Website/Tests/Library/Cases/Internal/Pages/IndexPageTests.swift
+21
View File
@@ -0,0 +1,21 @@
import Elementary
import Testing
@testable import WebsiteCore
@Suite("IndexPage page")
struct IndexPageTests {
// MARK: Functional tests
@Test
func `renders its markup`() {
let html = IndexPage().render()
#expect(html.contains("<!DOCTYPE html>"))
#expect(html.contains("Hello world!"))
#expect(html.contains("css/style.css"))
#expect(html.contains("js/app.js"))
}
}
Services/Website/Tests/Library/Cases/Public/Controllers/RootControllerTests.swift
+39
View File
@@ -0,0 +1,39 @@
import Hummingbird
import HummingbirdTesting
import NIOCore
import Testing
@testable import WebsiteCore
@Suite("RootController controller")
struct RootControllerTests {
// MARK: Constants
private let app: Application = .init(router: {
let router = Router()
router.addRoutes(RootController<BasicRequestContext>().routes)
return router
}())
// MARK: Functional tests
@Test
func `serves the landing page at the root path`() async throws {
try await app.test(.router) { client in
try await client.execute(
uri: "/",
method: .get
) { response in
let body = String(buffer: response.body)
#expect(response.status == .ok)
#expect(response.headers[.contentType] == "text/html; charset=utf-8")
#expect(body.contains("Hello world!"))
}
}
}
}
Services/Website/Tests/Library/Cases/Public/Middlewares/NotFoundMiddlewareTests.swift
+77
View File
@@ -0,0 +1,77 @@
import Hummingbird
import HummingbirdTesting
import NIOCore
import Testing
@testable import WebsiteCore
@Suite("NotFoundMiddleware middleware")
struct NotFoundMiddlewareTests {
// MARK: Constants
private let app: Application = .init(router: {
let router = Router()
router.addMiddleware {
NotFoundMiddleware()
}
router.get("hello") { _, _ in
"Hello!"
}
router.get("boom") { _, _ -> String in
throw HTTPError(.badRequest)
}
return router
}())
// MARK: Functional tests
@Test
func `renders the error page for an unmatched request`() async throws {
try await app.test(.router) { client in
try await client.execute(
uri: "/this-path-does-not-exist",
method: .get
) { response in
let body = String(buffer: response.body)
#expect(response.status == .notFound)
#expect(response.headers[.contentType] == "text/html; charset=utf-8")
#expect(body.contains("Page Not Found"))
}
}
}
@Test
func `passes a matched response through untouched`() async throws {
try await app.test(.router) { client in
try await client.execute(
uri: "/hello",
method: .get
) { response in
#expect(response.status == .ok)
#expect(response.body == ByteBuffer(string: "Hello!"))
}
}
}
@Test
func `rethrows a non-not-found error unchanged`() async throws {
try await app.test(.router) { client in
try await client.execute(
uri: "/boom",
method: .get
) { response in
let body = String(buffer: response.body)
#expect(response.status == .badRequest)
#expect(!body.contains("Page Not Found"))
}
}
}
}