luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-19 17:21:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

top-level :request coercion & stuff

Browse source
This commit is contained in:
Tommi Reiman 2023-05-28 16:49:08 +03:00
parent 93a4246682
commit b1404ada6d
11 changed files with 180 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
doc/ring/coercion.md
View file

@ -157,21 +157,21 @@ You can also specify request and response body schemas per content-type. The syn
```clj ```clj
(def app (def app
(ring/ring-handler (ring/ring-handler
(ring/router (ring/router
["/api" ["/api"
["/example" {:post {:coercion reitit.coercion.schema/coercion ["/example" {:post {:coercion reitit.coercion.schema/coercion
:parameters {:request {:content {"application/json" {:y s/Int} :request {:content {"application/json" {:y s/Int}
"application/edn" {:z s/Int}} "application/edn" {:z s/Int}}
;; default if no content-type matches: ;; default if no content-type matches:
:body {:yy s/Int}}} :body {:yy s/Int}}
:responses {200 {:content {"application/json" {:w s/Int} :responses {200 {:content {"application/json" {:w s/Int}
"application/edn" {:x s/Int}} "application/edn" {:x s/Int}}
;; default if no content-type matches: ;; default if no content-type matches:
:body {:ww s/Int}} :body {:ww s/Int}}
:handler ...}}]] :handler ...}}}]]
{:data {:middleware [rrc/coerce-exceptions-middleware {:data {:middleware [rrc/coerce-exceptions-middleware
rrc/coerce-request-middleware rrc/coerce-request-middleware
rrc/coerce-response-middleware]}}))) rrc/coerce-response-middleware]}})))
``` ```
## Pretty printing spec errors ## Pretty printing spec errors

100
modules/reitit-core/src/reitit/coercion.cljc
View file

@ -37,7 +37,6 @@
(def ^:no-doc default-parameter-coercion (def ^:no-doc default-parameter-coercion
{:query (->ParameterCoercion :query-params :string true true) {:query (->ParameterCoercion :query-params :string true true)
:body (->ParameterCoercion :body-params :body false false) :body (->ParameterCoercion :body-params :body false false)
:request (->ParameterCoercion :body-params :request false false)
:form (->ParameterCoercion :form-params :string true true) :form (->ParameterCoercion :form-params :string true true)
:header (->ParameterCoercion :headers :string true true) :header (->ParameterCoercion :headers :string true true)
:path (->ParameterCoercion :path-params :string true true) :path (->ParameterCoercion :path-params :string true true)
@ -83,34 +82,45 @@
value) value)
;; TODO: support faster key walking, walk/keywordize-keys is quite slow... ;; TODO: support faster key walking, walk/keywordize-keys is quite slow...
(defn request-coercer [coercion type model {::keys [extract-request-format parameter-coercion serialize-failed-result] (defn request-coercer [coercion type model {::keys [extract-request-format parameter-coercion serialize-failed-result skip]
:or {extract-request-format extract-request-format-default :or {extract-request-format extract-request-format-default
parameter-coercion default-parameter-coercion}}] parameter-coercion default-parameter-coercion
skip #{}}}]
(if coercion (if coercion
(if-let [{:keys [keywordize? open? in style]} (parameter-coercion type)] (when-let [{:keys [keywordize? open? in style]} (parameter-coercion type)]
(let [transform (comp (if keywordize? walk/keywordize-keys identity) in) (when-not (skip style)
->open (if open? #(-open-model coercion %) identity) (let [transform (comp (if keywordize? walk/keywordize-keys identity) in)
format-schema-pairs (if (= :request style) ->open (if open? #(-open-model coercion %) identity)
(conj (:content model) [:default {:schema (:body model)}]) coercer (-request-coercer coercion style (->open model))]
[[:default {:schema model}]]) (when coercer
format->coercer (some->> (for [[format {:keys [schema]}] format-schema-pairs (fn [request]
:when schema (let [value (transform request)
:let [type (case style :request :body style)]] format (extract-request-format request)
[format (-request-coercer coercion type (->open schema))]) result (coercer value format)]
(filter second) (if (error? result)
(seq) (request-coercion-failed! result coercion value in request serialize-failed-result)
(into {}))] result)))))))))
(when format->coercer
(fn [request] (defn content-request-coercer [coercion {:keys [content body]} {::keys [extract-request-format serialize-failed-result]
(let [value (transform request) :or {extract-request-format extract-request-format-default}}]
format (extract-request-format request) (when coercion
coercer (or (format->coercer format) (let [in :body-params
(format->coercer :default) format->coercer (some->> (concat (when body
-identity-coercer) [[:default (-request-coercer coercion :body body)]])
result (coercer value format)] (for [[format {:keys [schema]}] content, :when schema]
(if (error? result) [format (-request-coercer coercion :body schema)]))
(request-coercion-failed! result coercion value in request serialize-failed-result) (filter second) (seq) (into (array-map)))]
result)))))))) (when format->coercer
(fn [request]
(let [value (in request)
format (extract-request-format request)
coercer (or (format->coercer format)
(format->coercer :default)
-identity-coercer)
result (coercer value format)]
(if (error? result)
(request-coercion-failed! result coercion value in request serialize-failed-result)
result)))))))
(defn extract-response-format-default [request _] (defn extract-response-format-default [request _]
(-> request :muuntaja/response :format)) (-> request :muuntaja/response :format))
@ -118,18 +128,18 @@
(defn response-coercer [coercion {:keys [content body]} {:keys [extract-response-format serialize-failed-result] (defn response-coercer [coercion {:keys [content body]} {:keys [extract-response-format serialize-failed-result]
:or {extract-response-format extract-response-format-default}}] :or {extract-response-format extract-response-format-default}}]
(if coercion (if coercion
(let [per-format-coercers (some->> (for [[format {:keys [schema]}] content (let [format->coercer (some->> (concat (when body
:when schema] [[:default (-response-coercer coercion body)]])
[format (-response-coercer coercion schema)]) (for [[format {:keys [schema]}] content, :when schema]
(filter second) [format (-response-coercer coercion schema)]))
(seq) (filter second) (seq) (into (array-map)))]
(into {})) (when format->coercer
default (when body (-response-coercer coercion body))]
(when (or per-format-coercers default)
(fn [request response] (fn [request response]
(let [format (extract-response-format request response) (let [format (extract-response-format request response)
value (:body response) value (:body response)
coercer (get per-format-coercers format (or default -identity-coercer)) coercer (or (format->coercer format)
(format->coercer :default)
-identity-coercer)
result (coercer value format)] result (coercer value format)]
(if (error? result) (if (error? result)
(response-coercion-failed! result coercion value request response serialize-failed-result) (response-coercion-failed! result coercion value request response serialize-failed-result)
@ -153,10 +163,15 @@
(impl/fast-assoc response :body (coercer request response)) (impl/fast-assoc response :body (coercer request response))
response))) response)))
(defn request-coercers [coercion parameters opts] (defn request-coercers
(some->> (for [[k v] parameters, :when v] ([coercion parameters opts]
[k (request-coercer coercion k v opts)]) (some->> (for [[k v] parameters, :when v]
(filter second) (seq) (into {}))) [k (request-coercer coercion k v opts)])
(filter second) (seq) (into {})))
([coercion parameters request opts]
(let [crc (when request (some->> (content-request-coercer coercion request opts) (array-map :request)))
rcs (request-coercers coercion parameters (cond-> opts request (assoc ::skip #{:body})))]
(if (and crc rcs) (into crc (vec rcs)) (or crc rcs)))))
(defn response-coercers [coercion responses opts] (defn response-coercers [coercion responses opts]
(some->> (for [[status model] responses] (some->> (for [[status model] responses]
@ -170,8 +185,8 @@
;; api-docs ;; api-docs
;; ;;
(defn -warn-unsupported-coercions [{:keys [parameters responses] :as _data}] (defn -warn-unsupported-coercions [{:keys [request responses] :as _data}]
(when (:request parameters) (when request
(println "WARNING [reitit.coercion]: swagger apidocs don't support :request coercion")) (println "WARNING [reitit.coercion]: swagger apidocs don't support :request coercion"))
(when (some :content (vals responses)) (when (some :content (vals responses))
(println "WARNING [reitit.coercion]: swagger apidocs don't support :responses :content coercion"))) (println "WARNING [reitit.coercion]: swagger apidocs don't support :responses :content coercion")))
@ -197,7 +212,6 @@
(into {})))) (into {}))))
(-get-apidocs coercion specification)))))) (-get-apidocs coercion specification))))))
;; ;;
;; integration ;; integration
;; ;;

6
modules/reitit-http/src/reitit/http/coercion.cljc
View file

@ -10,15 +10,15 @@
[] []
{:name ::coerce-request {:name ::coerce-request
:spec ::rs/parameters :spec ::rs/parameters
:compile (fn [{:keys [coercion parameters]} opts] :compile (fn [{:keys [coercion parameters request]} opts]
(cond (cond
;; no coercion, skip ;; no coercion, skip
(not coercion) nil (not coercion) nil
;; just coercion, don't mount ;; just coercion, don't mount
(not parameters) {} (not (or parameters request)) {}
;; mount ;; mount
:else :else
(if-let [coercers (coercion/request-coercers coercion parameters opts)] (if-let [coercers (coercion/request-coercers coercion parameters request opts)]
{:enter (fn [ctx] {:enter (fn [ctx]
(let [request (:request ctx) (let [request (:request ctx)
coerced (coercion/coerce-request coercers request) coerced (coercion/coerce-request coercers request)

4
modules/reitit-malli/src/reitit/coercion/malli.cljc
View file

@ -134,8 +134,8 @@
:options nil}) :options nil})
(defn -get-apidocs-openapi (defn -get-apidocs-openapi
[_ {:keys [parameters responses content-types] :or {content-types ["application/json"]}} options] [_ {:keys [request parameters responses content-types] :or {content-types ["application/json"]}} options]
(let [{:keys [body request multipart]} parameters (let [{:keys [body multipart]} parameters
parameters (dissoc parameters :request :body :multipart) parameters (dissoc parameters :request :body :multipart)
->schema-object (fn [schema opts] ->schema-object (fn [schema opts]
(let [current-opts (merge options opts)] (let [current-opts (merge options opts)]

18
modules/reitit-ring/src/reitit/ring.cljc
View file

@ -32,17 +32,23 @@
(defn -update-paths [f] (defn -update-paths [f]
(let [not-request? #(not= :request %) (let [not-request? #(not= :request %)
http-method? #(contains? http-methods %)] http-method? #(contains? http-methods %)]
[;; default parameters and responses [;; default parameters
[[:parameters not-request?] f] [[:parameters not-request?] f]
[[http-method? :parameters not-request?] f] [[http-method? :parameters not-request?] f]
;; default responses
[[:responses any? :body] f] [[:responses any? :body] f]
[[http-method? :responses any? :body] f] [[http-method? :responses any? :body] f]
;; openapi3 parameters and responses ;; openapi3 request
[[:parameters :request :content any? :schema] f] [[:request :content any? :schema] f]
[[http-method? :parameters :request :content any? :schema] f] [[http-method? :request :content any? :schema] f]
[[:parameters :request :body] f]
[[http-method? :parameters :request :body] f] ;; openapi3 LEGACY body
[[:request :body] f]
[[http-method? :request :body] f]
;; openapi3 responses
[[:responses any? :content any? :schema] f] [[:responses any? :content any? :schema] f]
[[http-method? :responses any? :content any? :schema] f]])) [[http-method? :responses any? :content any? :schema] f]]))

6
modules/reitit-ring/src/reitit/ring/coercion.cljc
View file

@ -24,15 +24,15 @@
and :parameters from route data, otherwise does not mount." and :parameters from route data, otherwise does not mount."
{:name ::coerce-request {:name ::coerce-request
:spec ::rs/parameters :spec ::rs/parameters
:compile (fn [{:keys [coercion parameters]} opts] :compile (fn [{:keys [coercion parameters request]} opts]
(cond (cond
;; no coercion, skip ;; no coercion, skip
(not coercion) nil (not coercion) nil
;; just coercion, don't mount ;; just coercion, don't mount
(not parameters) {} (not (or parameters request)) {}
;; mount ;; mount
:else :else
(if-let [coercers (coercion/request-coercers coercion parameters opts)] (if-let [coercers (coercion/request-coercers coercion parameters request opts)]
(fn [handler] (fn [handler]
(fn (fn
([request] ([request]

8
modules/reitit-schema/src/reitit/coercion/schema.cljc
View file

@ -47,7 +47,7 @@
(reify coercion/Coercion (reify coercion/Coercion
(-get-name [_] :schema) (-get-name [_] :schema)
(-get-options [_] opts) (-get-options [_] opts)
(-get-apidocs [_ specification {:keys [parameters responses content-types] (-get-apidocs [_ specification {:keys [request parameters responses content-types]
:or {content-types ["application/json"]}}] :or {content-types ["application/json"]}}]
;; TODO: this looks identical to spec, refactor when schema is done. ;; TODO: this looks identical to spec, refactor when schema is done.
(case specification (case specification
@ -67,12 +67,12 @@
(when (:body parameters) (when (:body parameters)
{:requestBody (openapi/openapi-spec {:requestBody (openapi/openapi-spec
{::openapi/content (zipmap content-types (repeat (:body parameters)))})}) {::openapi/content (zipmap content-types (repeat (:body parameters)))})})
(when (:request parameters) (when request
{:requestBody (openapi/openapi-spec {:requestBody (openapi/openapi-spec
{::openapi/content (merge {::openapi/content (merge
(when-let [default (get-in parameters [:request :body])] (when-let [default (:body request)]
(zipmap content-types (repeat default))) (zipmap content-types (repeat default)))
(->> (for [[content-type {:keys [schema]}] (:content (:request parameters))] (->> (for [[content-type {:keys [schema]}] (:content request)]
[content-type schema]) [content-type schema])
(into {})))})}) (into {})))})})
(when (:multipart parameters) (when (:multipart parameters)

8
modules/reitit-spec/src/reitit/coercion/spec.cljc
View file

@ -88,7 +88,7 @@
(reify coercion/Coercion (reify coercion/Coercion
(-get-name [_] :spec) (-get-name [_] :spec)
(-get-options [_] opts) (-get-options [_] opts)
(-get-apidocs [this specification {:keys [parameters responses content-types] (-get-apidocs [this specification {:keys [request parameters responses content-types]
:or {content-types ["application/json"]}}] :or {content-types ["application/json"]}}]
(case specification (case specification
:swagger (swagger/swagger-spec :swagger (swagger/swagger-spec
@ -108,12 +108,12 @@
(when (:body parameters) (when (:body parameters)
{:requestBody (openapi/openapi-spec {:requestBody (openapi/openapi-spec
{::openapi/content (zipmap content-types (repeat (:body parameters)))})}) {::openapi/content (zipmap content-types (repeat (:body parameters)))})})
(when (:request parameters) (when request
{:requestBody (openapi/openapi-spec {:requestBody (openapi/openapi-spec
{::openapi/content (merge {::openapi/content (merge
(when-let [default (get-in parameters [:request :body])] (when-let [default (:body request)]
(zipmap content-types (repeat default))) (zipmap content-types (repeat default)))
(->> (for [[content-type {:keys [schema]}] (:content (:request parameters))] (->> (for [[content-type {:keys [schema]}] (:content request)]
[content-type schema]) [content-type schema])
(into {})))})}) (into {})))})})
(when (:multipart parameters) (when (:multipart parameters)

31
test/cljc/reitit/openapi_test.clj
View file

@ -457,8 +457,8 @@
[["/examples" [["/examples"
{:post {:decription "examples" {:post {:decription "examples"
:coercion @coercion :coercion @coercion
:parameters {:query (->schema :q) :request {:body (->schema :b)}
:request {:body (->schema :b)}} :parameters {:query (->schema :q)}
:responses {200 {:description "success" :responses {200 {:description "success"
:body (->schema :ok)}} :body (->schema :ok)}}
:openapi {:requestBody :openapi {:requestBody
@ -573,8 +573,8 @@
[["/parameters" [["/parameters"
{:post {:description "parameters" {:post {:description "parameters"
:coercion coercion :coercion coercion
:parameters {:request {:content {"application/json" {:schema (->schema :b)} :request {:content {"application/json" {:schema (->schema :b)}
"application/edn" {:schema (->schema :c)}}}} "application/edn" {:schema (->schema :c)}}}
:responses {200 {:description "success" :responses {200 {:description "success"
:content {"application/json" {:schema (->schema :ok)} :content {"application/json" {:schema (->schema :ok)}
"application/edn" {:schema (->schema :edn)}}}} "application/edn" {:schema (->schema :edn)}}}}
@ -664,8 +664,8 @@
{:post {:description "parameters" {:post {:description "parameters"
:coercion coercion :coercion coercion
:content-types [content-type] ;; TODO should this be under :openapi ? :content-types [content-type] ;; TODO should this be under :openapi ?
:parameters {:request {:content {"application/transit" {:schema (->schema :transit)}} :request {:content {"application/transit" {:schema (->schema :transit)}}
:body (->schema :default)}} :body (->schema :default)}
:responses {200 {:description "success" :responses {200 {:description "success"
:content {"application/transit" {:schema (->schema :transit)}} :content {"application/transit" {:schema (->schema :transit)}}
:body (->schema :default)}} :body (->schema :default)}}
@ -705,16 +705,15 @@
[["/parameters" [["/parameters"
{:post {:description "parameters" {:post {:description "parameters"
:coercion malli/coercion :coercion malli/coercion
:parameters {:request :request {:body
{:body [:schema
[:schema {:registry {"friend" [:map
{:registry {"friend" [:map [:age int?]
[:age int?] [:pet [:ref "pet"]]]
[:pet [:ref "pet"]]] "pet" [:map
"pet" [:map [:name :string]
[:name :string] [:friends [:vector [:ref "friend"]]]]}}
[:friends [:vector [:ref "friend"]]]]}} "friend"]}
"friend"]}}
:handler (fn [req] :handler (fn [req]
{:status 200 {:status 200
:body (-> req :parameters :request)})}}] :body (-> req :parameters :request)})}}]

111
test/cljc/reitit/ring_coercion_test.cljc
View file

@ -606,53 +606,70 @@
{:request any? :response (clojure.spec.alpha/spec #{:end})} {:request any? :response (clojure.spec.alpha/spec #{:end})}
{:request any? :response (clojure.spec.alpha/spec #{:default})}]]] {:request any? :response (clojure.spec.alpha/spec #{:default})}]]]
(testing (str coercion) (testing (str coercion)
(let [app (ring/ring-handler (doseq [app [(ring/ring-handler
(ring/router (ring/router
["/foo" {:post {:parameters {:request {:content {"application/json" {:schema json-request} ["/foo" {:post {:request {:content {"application/json" {:schema json-request}
"application/edn" {:schema edn-request}} "application/edn" {:schema edn-request}}
:body default-request}} :body default-request}
:responses {200 {:content {"application/json" {:schema json-response} :responses {200 {:content {"application/json" {:schema json-response}
"application/edn" {:schema edn-response}} "application/edn" {:schema edn-response}}
:body default-response}} :body default-response}}
:handler (fn [req] :handler (fn [req]
{:status 200 {:status 200
:body (-> req :parameters :request)})}}] :body (-> req :parameters :request)})}}]
{:validate reitit.ring.spec/validate {:validate reitit.ring.spec/validate
:data {:middleware [rrc/coerce-request-middleware :data {:middleware [rrc/coerce-request-middleware
rrc/coerce-response-middleware] rrc/coerce-response-middleware]
:coercion coercion}})) :coercion coercion}}))
call (fn [request] (ring/ring-handler
(try (ring/router
(app request) ["/foo" {:post {:request {:content {"application/json" {:schema json-request}
(catch ExceptionInfo e "application/edn" {:schema edn-request}
(select-keys (ex-data e) [:type :in])))) :default {:schema default-request}}
request (fn [request-format response-format body] :body json-request} ;; not applied as :default exists
{:request-method :post :responses {200 {:content {"application/json" {:schema json-response}
:uri "/foo" "application/edn" {:schema edn-response}
:muuntaja/request {:format request-format} :default {:schema default-response}}
:muuntaja/response {:format response-format} :body json-response}} ;; not applied as :default exists
:body-params body})] :handler (fn [req]
(testing "succesful call" {:status 200
(is (= {:status 200 :body {:request :json, :response :json}} :body (-> req :parameters :request)})}}]
(call (request "application/json" "application/json" {:request :json :response :json})))) {:validate reitit.ring.spec/validate
(is (= {:status 200 :body {:request :edn, :response :json}} :data {:middleware [rrc/coerce-request-middleware
(call (request "application/edn" "application/json" {:request :edn :response :json})))) rrc/coerce-response-middleware]
(is (= {:status 200 :body {:request :default, :response :default}} :coercion coercion}}))]]
(call (request "application/transit" "application/transit" {:request :default :response :default}))))) (let [call (fn [request]
(testing "request validation fails" (try
(is (= {:type :reitit.coercion/request-coercion :in [:request :body-params]} (app request)
(call (request "application/edn" "application/json" {:request :json :response :json})))) (catch ExceptionInfo e
(is (= {:type :reitit.coercion/request-coercion :in [:request :body-params]} (select-keys (ex-data e) [:type :in]))))
(call (request "application/json" "application/json" {:request :edn :response :json})))) request (fn [request-format response-format body]
(is (= {:type :reitit.coercion/request-coercion :in [:request :body-params]} {:request-method :post
(call (request "application/transit" "application/json" {:request :edn :response :json}))))) :uri "/foo"
(testing "response validation fails" :muuntaja/request {:format request-format}
(is (= {:type :reitit.coercion/response-coercion :in [:response :body]} :muuntaja/response {:format response-format}
(call (request "application/json" "application/json" {:request :json :response :edn})))) :body-params body})]
(is (= {:type :reitit.coercion/response-coercion :in [:response :body]} (testing "succesful call"
(call (request "application/json" "application/edn" {:request :json :response :json})))) (is (= {:status 200 :body {:request :json, :response :json}}
(is (= {:type :reitit.coercion/response-coercion :in [:response :body]} (call (request "application/json" "application/json" {:request :json :response :json}))))
(call (request "application/json" "application/transit" {:request :json :response :json}))))))))) (is (= {:status 200 :body {:request :edn, :response :json}}
(call (request "application/edn" "application/json" {:request :edn :response :json}))))
(is (= {:status 200 :body {:request :default, :response :default}}
(call (request "application/transit" "application/transit" {:request :default :response :default})))))
(testing "request validation fails"
(is (= {:type :reitit.coercion/request-coercion :in [:request :body-params]}
(call (request "application/edn" "application/json" {:request :json :response :json}))))
(is (= {:type :reitit.coercion/request-coercion :in [:request :body-params]}
(call (request "application/json" "application/json" {:request :edn :response :json}))))
(is (= {:type :reitit.coercion/request-coercion :in [:request :body-params]}
(call (request "application/transit" "application/json" {:request :edn :response :json})))))
(testing "response validation fails"
(is (= {:type :reitit.coercion/response-coercion :in [:response :body]}
(call (request "application/json" "application/json" {:request :json :response :edn}))))
(is (= {:type :reitit.coercion/response-coercion :in [:response :body]}
(call (request "application/json" "application/edn" {:request :json :response :json}))))
(is (= {:type :reitit.coercion/response-coercion :in [:response :body]}
(call (request "application/json" "application/transit" {:request :json :response :json}))))))))))
#?(:clj #?(:clj

2
test/cljc/reitit/swagger_test.clj
View file

@ -401,7 +401,7 @@
(ring/router (ring/router
[["/parameters" [["/parameters"
{:post {:coercion spec/coercion {:post {:coercion spec/coercion
:parameters {:request {:content {"application/json" {:x string?}}}} :request {:content {"application/json" {:x string?}}}
:handler identity}}] :handler identity}}]
["/swagger.json" ["/swagger.json"
{:get {:no-doc true {:get {:no-doc true