metosin / compojure-api

Sweet web apis with Compojure & Swagger
http://metosin.github.io/compojure-api/doc/
Eclipse Public License 1.0
1.11k stars 149 forks source link

Automatically push `context` parameters into endpoints when safe #463

Open frenchy64 opened 4 months ago

frenchy64 commented 4 months ago

Presents more opportunities to infer static contexts.

(context "/foo" []
  :path-params [id :- s/Str]
  (PATCH "/" []
    (ok id))
  (GET "/" []
    (ok id)))

=>

(context "/foo" []
  (PATCH "/" []
    :path-params [id :- s/Str]
    (ok id))
  (GET "/" []
    :path-params [id :- s/Str]
    (ok id)))

typed.clj.analyzer would be useful here as we both need to infer where locals occur and also do partial macroexpansion.

ikitommi commented 4 months ago

Great idea!

frenchy64 commented 3 months ago

If a context would be inferred as dynamic, we can push the context into each body form. Then we can proceed to handle individual cases, but the advantage is it automatically handles hybrid static/dynamic contexts. The inner contexts that are static will be inferred as static, ditto dynamic.

  (let [f (fn [] (GET "/bar" [] "body just for doc and coercion"))]
    (context "/foo" []
             :body [body s/Str]
             (GET "/bar" [] body)
             (f)))
  =>
  (let [f (fn [] (GET "/bar" [] "body just for doc and coercion"))]
    (vector
      (context "/foo" []
               :body [body s/Str]
               (GET "/bar" [] body))
      (context "/foo" []
               :body [body s/Str]
               (f))))
  =>
  (let [f (fn [] (GET "/bar" [] "body just for doc and coercion"))]
    (vector
      (context "/foo" []
               (GET "/bar" []
                    :body [body s/Str]
                    body))
      (context "/foo" []
               (-> (f)
                   (update :handler (let [g (partial coercion/coerce-request! s/Str :body-params :body true false)]
                                      #(comp % g)))
                   (update-in [:info :public :parameters :body] #(or % s/Str))))))
frenchy64 commented 3 months ago

Another insight is that if all :lets and :letks bindings are never used in the body, we can treat it like a static context. This is because the bindings are just side effects, and as long as we update the handler with the side effect and any :info needed, it's equivalent.

This is a useful observation if the context body calls a function. If the function doesn't get passed the body, then we can just update the route after it's been evaluated.

(let [f (fn [] (GET "/bar" [] "body just for doc and coercion"))]
  (context "/foo" []
           :body [body s/Str]
           (f)))
=>
(let [f (fn [] (GET "/bar" [] "body just for doc and coercion"))]
  (context "/foo" []
           (-> (f)
               ...for each route...
               (update :handler (let [g (partial coercion/coerce-request! s/Str :body-params :body true false)]
                                  #(comp % g)))
               (update-in [:info :public :parameters :body] #(or % s/Str)))))