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

Static file serving support for the Website service (#3)

Browse Source 
This PR contains the work done to support the static files serving for the **Website** service, and also included the essential boilerplate assets from the **HTML5 boilerplate** project.

To provide further details about the work done:

* Serving: Added the `FileMiddleware` middlewqare to the router; `path`, `server name`, and `log level` now read from config with defaults.
* Library: Added the `StaticFile` enumeration with a `contentType` property, plus typed config-key/value constants and the `Configuration` dependency on WebsiteCore.
* Assets: Added the **HTML5 boilerplate** (HTML, CSS, JS, icons, manifest, robots) to the *Resources/Static* folder.
* Docker: Stage the Resources directory as read-only.
* Tests: Added a test plan, and a shared Xcode scheme.

Reviewed-on: rock-n-code/loud-amsterdam#3
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-27 10:59:32 +00:00
committed by javier
parent 08b210e7c6
commit 7542bc595f
25 changed files with 973 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Services/Website/Sources/App/App+build.swift
+41 -14
View File
@@ -1,24 +1,37 @@
import Configuration
import Hummingbird
import Logging
import WebsiteCore
/// Build application
/// - Parameter reader: configuration reader
/// Builds the website application.
///
/// Reads the log level, server name, and static files location from the configuration,
/// 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 {
let logLevel = reader.string(
forKey: "log.level",
forKey: .Log.level,
as: Logger.Level.self,
default: .info
)
let serverName = reader.string(
forKey: "http.serverName",
default: "LoudWebsite"
forKey: .HTTP.serverName,
default: .Server.name
)
let staticFilesPath = reader.string(
forKey: .Path.staticFiles,
default: .Path.staticResources
)
return Application(
router: try router(),
router: router(
staticFilesPath: staticFilesPath,
logLevel: logLevel
),
configuration: ApplicationConfiguration(
reader: reader.scoped(to: "http")
),
@@ -34,7 +47,11 @@ func application(
// Request context used by application
private typealias AppRequestContext = BasicRequestContext
/// Build logger
/// Builds the application's logger.
/// - Parameters:
/// - serverName: the label applied to the logger.
/// - logLevel: the minimum level the logger emits.
/// - Returns: the configured logger.
private func logger(
serverName: String,
logLevel: Logger.Level
@@ -46,16 +63,26 @@ private func logger(
return logger
}
/// Build router
private func router() throws -> Router<AppRequestContext> {
/// Builds the application's router.
///
/// Registers the request-logging middleware and the static file middleware that serves
/// the contents of `staticFilesPath`.
/// - Parameters:
/// - staticFilesPath: the folder, relative to the working directory, the static files are served from.
/// - logLevel: the level the request-logging middleware logs at.
/// - Returns: the configured router.
private func router(
staticFilesPath: String,
logLevel: Logger.Level
) -> Router<AppRequestContext> {
let router = Router(context: AppRequestContext.self)
router.addMiddleware {
LogRequestsMiddleware(.info)
}
router.get("/") { _, _ in
return "Hello!"
LogRequestsMiddleware(logLevel)
FileMiddleware(
staticFilesPath,
searchForIndexHtml: false
)
}
return router
Services/Website/Sources/App/App.swift
+1 -1
View File
@@ -14,7 +14,7 @@ struct App {
allowMissing: true
),
InMemoryProvider(values: [
"http.serverName": "LoudWebsite"
.HTTP.serverName: .HTTP.serverName
]),
]
)
Services/Website/Sources/Library/Internal/Enumerations/StaticFile.swift
+166
View File
@@ -0,0 +1,166 @@
import Foundation
/// A static file shipped with the website service.
///
/// Each case identifies a file stored under the static files root (the `Resources/Static`
/// directory) and served by Hummingbird's `FileMiddleware` middleware.
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.
case siteWebmanifest
/// The `css/style.css` stylesheet.
case styleCSS
}
// MARK: - Enumerations
extension StaticFile {
/// A file extension used by a ``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.
case png
/// A Windows icon image.
case ico
/// A Scalable Vector Graphics image.
case svg
/// A plain text file.
case txt
/// A web application manifest file.
case webmanifest
}
}
// MARK: - Extensions
extension StaticFile {
// MARK: Computed
/// The file's content type.
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"
case .svg: "image/svg+xml"
case .txt: "text/plain"
case .webmanifest: "application/manifest+json"
}
}
/// The file's extension.
var fileExtension: Extension {
switch self {
case .styleCSS: .css
case .appJS: .js
case .errorHTML,
.indexHTML: .html
case .faviconICO: .ico
case .iconPNG: .png
case .iconSVG: .svg
case .robotsTXT: .txt
case .siteWebmanifest: .webmanifest
}
}
/// The file's name, without extension.
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"
}
}
/// The path relative to the static files root (e.g. `"css/style.css"`).
///
/// 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
)
return subdirectory
.map { .init(
format: Constant.Format.path,
$0,
file
)} ?? file
}
// MARK: Methods
/// Resolves the file's path against the given base directory.
///
/// - Parameter basePath: the directory the static files are served from.
/// - Returns: the path to the file, relative to the `basePath` path.
public func path(
relativeTo basePath: String
) -> String {
guard !basePath.isEmpty else {
return relativePath
}
return .init(
format: Constant.Format.path,
basePath,
relativePath
)
}
}
// MARK: - Helpers
private extension StaticFile {
// MARK: Computed
/// The sub-directory within the static root that holds the file, if any.
var subdirectory: String? {
switch self {
case .appJS: "js"
case .styleCSS: "css"
default: nil
}
}
}
// MARK: - Constants
private enum Constant {
enum Format {
static let file = "%@.%@"
static let path = "%@/%@"
}
}
Services/Website/Sources/Library/Library.swift
-2
View File
@@ -1,2 +0,0 @@
Services/Website/Sources/Library/Public/Extensions/AbsoluteConfigKey+Constants.swift
+23
View File
@@ -0,0 +1,23 @@
import Configuration
extension AbsoluteConfigKey {
/// A namespace for the HTTP server configuration keys, as absolute keys.
public enum HTTP {
/// The absolute configuration key for the host the server binds to.
public static let host: AbsoluteConfigKey = .init(.HTTP.host)
/// The absolute configuration key for the port the server listens on.
public static let port: AbsoluteConfigKey = .init(.HTTP.port)
/// The absolute configuration key for the server's name.
public static let serverName: AbsoluteConfigKey = .init(.HTTP.serverName)
}
/// A namespace for the logging configuration keys, as absolute keys.
public enum Log {
/// The absolute configuration key for the minimum log level.
public static let level: AbsoluteConfigKey = .init(.Log.level)
}
/// A namespace for the path configuration keys, as absolute keys.
public enum Path {
/// The absolute configuration key for the directory the static files are served from.
public static let staticFiles: AbsoluteConfigKey = .init(.Path.staticFiles)
}
}
Services/Website/Sources/Library/Public/Extensions/ConfigKey+Constants.swift
+23
View File
@@ -0,0 +1,23 @@
import Configuration
extension ConfigKey {
/// A namespace for the HTTP server configuration keys.
public enum HTTP {
/// The configuration key for the host the server binds to.
public static let host: ConfigKey = "http.host"
/// The configuration key for the port the server listens on.
public static let port: ConfigKey = "http.port"
/// The configuration key for the server's name.
public static let serverName: ConfigKey = "http.serverName"
}
/// A namespace for the logging configuration keys.
public enum Log {
/// The configuration key for the minimum log level.
public static let level: ConfigKey = "log.level"
}
/// A namespace for the path configuration keys.
public enum Path {
/// The configuration key for the directory the static files are served from.
public static let staticFiles: ConfigKey = "path.staticFiles"
}
}
Services/Website/Sources/Library/Public/Extensions/ConfigValue+Constants.swift
+18
View File
@@ -0,0 +1,18 @@
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/Extensions/String+Constants.swift
+12
View File
@@ -0,0 +1,12 @@
extension String {
/// A namespace for well-known path string constants.
public enum Path {
/// The directory, relative to the working directory, that the website's static files are served from.
public static let staticResources = "Resources/Static"
}
/// A namespace for the server string constants.
public enum Server {
/// The website server's name.
public static let name = "LoudWebsite"
}
}