This PR contains the work done to refactor the _Localization_ package and tidy the project a little bit. To provider further details about the work: * The `Negotiate` function was moved to the _Localization_ package. * The `WebsiteRequestContext` context no longer resolves a default language at creation; it starts empty and relies on the `LocalizationMiddleware` middleware to fill it in. * Fixed the local dependency path to Packages/Localization for the **Website** package as it only resolved inside the Xcode workspace before, breaking swift build, the Makefile, and the Docker build). * Updated the `README` file to document language negotiation, the GET /health route, and the full middleware chain; doc comments across the moved/renamed types were brought back in sync with the code. Reviewed-on: rock-n-code/loud-amsterdam#11 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
57 lines
1.8 KiB
Swift
57 lines
1.8 KiB
Swift
import HTTPTypes
|
|
import Hummingbird
|
|
import Localization
|
|
|
|
/// Resolves the visitor's preferred language and records it on the request context.
|
|
///
|
|
/// Placed ahead of the localized responders in the middleware chain, it reads the request's
|
|
/// `Accept-Language` header, negotiates the best supported match (falling back to the default
|
|
/// language), and stores it on the context's ``LocalizedRequestContext/language``.
|
|
///
|
|
/// The request is otherwise passed through untouched — the URL and routing are not affected — so
|
|
/// each page is served at its existing path and varies its content by header.
|
|
public struct LocalizationMiddleware<Context: LocalizedRequestContext> {
|
|
|
|
// MARK: Properties
|
|
|
|
/// Negotiates the request's language from its `Accept-Language` header.
|
|
private let negotiate: Negotiate
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Creates a localization middleware that negotiates against the module's String Catalog languages.
|
|
public init() {
|
|
self.negotiate = .init(bundle: .module)
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - RouterMiddleware
|
|
|
|
extension LocalizationMiddleware: RouterMiddleware {
|
|
|
|
// MARK: Functions
|
|
|
|
/// Negotiates the request's language and records it on the context before passing it down.
|
|
/// - 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.
|
|
/// - Throws: any error thrown downstream.
|
|
public func handle(
|
|
_ request: Request,
|
|
context: Context,
|
|
next: (Request, Context) async throws -> Response
|
|
) async throws -> Response {
|
|
var context = context
|
|
|
|
context.language = negotiate(
|
|
acceptLanguage: request.headers[.acceptLanguage]
|
|
)
|
|
|
|
return try await next(request, context)
|
|
}
|
|
|
|
}
|