penpot/backend/src/app/http/content_negotiation.clj
Andrey Antukh 4dccd254b6 Negotiate transit/JSON payload format on SSE endpoints
SSE endpoints always encoded event payloads in transit, ignoring
request content negotiation.

Extract the response format negotiation (Accept header and _fmt
query param) into a shared app.http.content-negotiation helper and
use it from both the response formatting middleware and the SSE
response builder. SSE event payloads are now encoded as transit
(default) or plain JSON depending on the request, while the
text/event-stream transport remains unchanged.

On the frontend, stream requests now accept a :response-format
:json option that switches the Accept header and decodes each
event with the plain JSON decoder.

AI-assisted-by: glm-5.3-flash
2026-08-28 07:23:58 +00:00

59 lines
1.8 KiB
Clojure

;; This Source Code Form is subject to the terms of the Mozilla Public
;; License, v. 2.0. If a copy of the MPL was not distributed with this
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
;;
;; Copyright (c) KALEIDOS SUBSIDIARY SL
(ns app.http.content-negotiation
"Content format negotiation helpers shared between the regular
response formatting middleware and the SSE streaming endpoints.
The negotiated format affects only the encoding of the response
payload; the transport (regular http body or `text/event-stream`)
is not affected."
(:require
[app.common.json :as json]
[app.util.pointer-map :as pmap]
[cuerdas.core :as str]
[yetti.request :as yreq]))
(defn- format-from-params
[{:keys [query-params]}]
(and (= "json" (get query-params :_fmt))
:json))
(defn negotiate-format
"Determine the response payload format for the request. Returns
`:json` or `:transit`.
The `:_fmt=json` query parameter takes precedence over the
`Accept` header; when no explicit signal is present, transit is
the default."
[request]
(or (format-from-params request)
(let [accept (yreq/get-header request "accept")]
(cond
(or (= accept "application/transit+json")
(str/includes? accept "application/transit+json"))
:transit
(or (= accept "application/json")
(str/includes? accept "application/json"))
:json
:else
:transit))))
(defn write-json-value
[_ val]
(if (pmap/pointer-map? val)
[(pmap/get-id val) (meta val)]
val))
(defn json-encode-str
"Encode value as a JSON string using the same conventions as the
regular JSON API responses: camelCase keys, keywords/UUIDs and
instants serialized as plain JSON scalars."
[v]
(json/encode v :key-fn json/write-camel-key :value-fn write-json-value))