Adjustments to the Localization package dependency (#11)
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>
This commit is contained in:
@@ -1,10 +0,0 @@
|
||||
import HTTPTypes
|
||||
|
||||
extension HTTPField.Name {
|
||||
/// The `Permissions-Policy` field name (not provided as a standard `HTTPField.Name`).
|
||||
static let permissionsPolicy = Self("Permissions-Policy")!
|
||||
/// The `Referrer-Policy` field name (not provided as a standard `HTTPField.Name`).
|
||||
static let referrerPolicy = Self("Referrer-Policy")!
|
||||
/// The `X-Frame-Options` field name (not provided as a standard `HTTPField.Name`).
|
||||
static let frameOptions = Self("X-Frame-Options")!
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
import Foundation
|
||||
import Localization
|
||||
|
||||
/// Negotiates the best supported language for a request from its `Accept-Language` header.
|
||||
///
|
||||
/// Bound to the module's catalog languages via ``LanguageList``, an instance is invoked like a
|
||||
/// function — through ``callAsFunction(forAcceptLanguage:)`` — to resolve a header value to a
|
||||
/// supported language identifier, falling back to the default language.
|
||||
struct NegotiateLanguage {
|
||||
|
||||
// MARK: Properties
|
||||
|
||||
/// The supported languages and default language, derived from the module's String Catalog.
|
||||
private let list: LanguageList
|
||||
|
||||
// MARK: Initializers
|
||||
|
||||
/// Creates a language negotiator backed by the module's String Catalog.
|
||||
init() {
|
||||
self.list = .init(bundle: .module)
|
||||
}
|
||||
|
||||
// MARK: Methods
|
||||
|
||||
/// Picks the best supported language for the given `Accept-Language` header value.
|
||||
///
|
||||
/// Invoked by calling the instance directly, for example `negotiate(forAcceptLanguage: header)`.
|
||||
/// The header is split into its language tags (dropping any `q` weights), then matched against
|
||||
/// the supported languages with `Bundle.preferredLocalizations(from:forPreferences:)`. When the
|
||||
/// header is absent or matches nothing, the default language is returned.
|
||||
/// - Parameter acceptLanguage: the raw `Accept-Language` header value, if any.
|
||||
/// - Returns: the identifier of the supported language to serve.
|
||||
func callAsFunction(
|
||||
forAcceptLanguage acceptLanguage: String?
|
||||
) -> String {
|
||||
guard let acceptLanguage else {
|
||||
return list.default
|
||||
}
|
||||
|
||||
let tags = tags(from: acceptLanguage)
|
||||
|
||||
guard !tags.isEmpty else {
|
||||
return list.default
|
||||
}
|
||||
|
||||
let preferred = Bundle.preferredLocalizations(
|
||||
from: list.all,
|
||||
forPreferences: tags
|
||||
)
|
||||
|
||||
return preferred.first
|
||||
?? list.default
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// MARK: - Helpers
|
||||
|
||||
private extension NegotiateLanguage {
|
||||
|
||||
// MARK: Methods
|
||||
|
||||
/// Extracts the ordered language tags from an `Accept-Language` header value.
|
||||
///
|
||||
/// Each comma-separated entry is reduced to its language tag by dropping the `;q=` weight, and
|
||||
/// blank entries are removed. The original order is kept, which mirrors descending preference
|
||||
/// closely enough for `preferredLocalizations(from:forPreferences:)` to resolve correctly.
|
||||
/// - Parameter acceptLanguage: the raw `Accept-Language` header value.
|
||||
/// - Returns: the ordered, weight-stripped language tags.
|
||||
func tags(
|
||||
from acceptLanguage: String
|
||||
) -> [String] {
|
||||
acceptLanguage
|
||||
.split(separator: ",")
|
||||
.map { entry in
|
||||
entry
|
||||
.split(separator: ";")
|
||||
.first
|
||||
.map(String.init)?
|
||||
.trimmingCharacters(in: .whitespaces) ?? ""
|
||||
}
|
||||
.filter { !$0.isEmpty }
|
||||
}
|
||||
|
||||
}
|
||||
@@ -10,7 +10,7 @@ import NIOCore
|
||||
/// pages whose markup never changes between requests, such as the landing page and the not-found
|
||||
/// page, avoiding a per-request Elementary render on hot paths.
|
||||
///
|
||||
/// ``LocalizedHTMLResponses`` builds on this type, caching one instance per supported language.
|
||||
/// ``LocalizedHTMLCollectionResponse`` builds on this type, caching one instance per supported language.
|
||||
///
|
||||
/// The body is written as an unsized stream (no `Content-Length`), mirroring `HTMLResponse`, so the
|
||||
/// response-compression middleware downstream treats it exactly as it would a freshly rendered page.
|
||||
|
||||
Reference in New Issue
Block a user