javier
f5f14eb97c
This PR contains the work done to add a `NotFoundMiddleware` middleware to the Website service so requests matching neither a route nor a static file return a custom 404.html page with a 404 Not Found status. Also enables index.html fallback so the landing page is served at the site root. To provider further details about the work done: * NotFoundMiddleware — intercepts the `.notFound` error from the `FileMiddleware` middleware and serves the preloaded error page with the correct content type; all other errors propagate. Falls back to a minimal body if the file is missing. * Router — wires the `NotFoundMiddleware` middleware ahead of the `FileMiddleware` and enables searchForIndexHtml. * Package — adds the **Hummingbird** product to the Library target. * Tooling — sets a custom working directory in the Xcode scheme; removes the unused `pkg-deps` target from the `Makefile` file. Reviewed-on: rock-n-code/loud-amsterdam#4 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
92 lines
2.6 KiB
Swift
92 lines
2.6 KiB
Swift
import Configuration
|
|
import Hummingbird
|
|
import Logging
|
|
import WebsiteCore
|
|
|
|
/// 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,
|
|
as: Logger.Level.self,
|
|
default: .info
|
|
)
|
|
let serverName = reader.string(
|
|
forKey: .HTTP.serverName,
|
|
default: .Server.name
|
|
)
|
|
let staticFilesPath = reader.string(
|
|
forKey: .Path.staticFiles,
|
|
default: .Path.staticResources
|
|
)
|
|
|
|
return Application(
|
|
router: router(
|
|
staticFilesPath: staticFilesPath,
|
|
logLevel: logLevel
|
|
),
|
|
configuration: ApplicationConfiguration(
|
|
reader: reader.scoped(to: "http")
|
|
),
|
|
logger: logger(
|
|
serverName: serverName,
|
|
logLevel: logLevel
|
|
)
|
|
)
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
// Request context used by application
|
|
private typealias AppRequestContext = BasicRequestContext
|
|
|
|
/// 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
|
|
) -> Logger {
|
|
var logger = Logger(label: serverName)
|
|
|
|
logger.logLevel = logLevel
|
|
|
|
return 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).
|
|
/// - 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(logLevel)
|
|
NotFoundMiddleware(staticFilesPath)
|
|
FileMiddleware(
|
|
staticFilesPath,
|
|
searchForIndexHtml: true
|
|
)
|
|
}
|
|
|
|
return router
|
|
}
|