Updated the Localized HTML Collection response in the Infrastructure package to make Vary: Accept-Language opt-in for localized responses.

This commit is contained in:
2026-09-04 14:39:43 +02:00
parent f0086ee461
commit 0b3ef2890e
4 changed files with 27 additions and 11 deletions
@@ -7,8 +7,12 @@ import Localization
/// A per-language collection of pre-rendered HTML responses.
///
/// At initialization it renders the document once for each language the bundle's ``LanguageList`` reports and caches the bytes, mirroring
/// ``CachedHTMLResponse``'s render-once model but keyed by language. Each cached response carries a `Content-Language` header and
/// `Vary: Accept-Language`, so shared caches key on the negotiated language instead of serving one language to everyone.
/// ``CachedHTMLResponse``'s render-once model but keyed by language. Each cached response carries a `Content-Language` header naming the
/// language it was rendered in.
///
/// `Vary: Accept-Language` is the caller's to declare, since only the caller knows how it picks the language: a responder that negotiates the
/// header sets it, so shared caches key on the language rather than serving one to everyone; a responder that pins the language by route does
/// not, since the header would announce a negotiation that never happens.
public struct LocalizedHTMLCollectionResponse: Sendable {
// MARK: Properties
@@ -25,21 +29,27 @@ public struct LocalizedHTMLCollectionResponse: Sendable {
/// - Parameters:
/// - bundle: the bundle whose String Catalog names the languages the document is rendered for.
/// - status: the status applied to every response. Defaults to `.ok`.
/// - variesOnAcceptLanguage: whether the responses declare `Vary: Accept-Language`. Defaults to `false`; a responder that
/// negotiates the header passes `true`.
/// - document: builds the document to render for a given locale.
public init<Document: HTMLDocument>(
bundle: Bundle,
status: HTTPResponse.Status = .ok,
variesOnAcceptLanguage: Bool = false,
document: (Locale) -> Document
) {
self.list = .init(bundle: bundle)
self.responses = list.all
.reduce(into: [:]) { responses, language in
var headers: HTTPFields = [.contentLanguage: language]
if variesOnAcceptLanguage {
headers[.vary] = "Accept-Language"
}
responses[language] = CachedHTMLResponse(
status: status,
additionalHeaders: [
.contentLanguage: language,
.vary: "Accept-Language",
],
additionalHeaders: headers,
document: document(.init(
identifier: language
))