[skip ci]

metosin · May 14, 2024 · ce54553 · ce54553
1 parent a8cf4d6
commit ce54553
Show file tree

Hide file tree

Showing 14 changed files with 1,551 additions and 486 deletions.
diff --git a/CONTRIBUTING.md → .github/CONTRIBUTING.md b/CONTRIBUTING.md → .github/CONTRIBUTING.md
diff --git a/project.clj b/project.clj
@@ -1,61 +1,70 @@
-(defproject metosin/compojure-api "1.1.15-SNAPSHOT"
+(defproject metosin/compojure-api "2.0.0-alpha34-SNAPSHOT"
   :description "Compojure Api"
   :url "https://github.com/metosin/compojure-api"
   :license {:name "Eclipse Public License"
             :url "http://www.eclipse.org/legal/epl-v10.html"
             :distribution :repo
             :comments "same as Clojure"}
-  :scm {:name "git"
-        :url "https://github.com/metosin/compojure-api"}
-  :dependencies [[prismatic/plumbing "0.6.0"]
-                 [cheshire "5.13.0"]
-                 [compojure "1.6.1"]
-                 [prismatic/schema "1.1.12"]
-                 [org.tobereplaced/lettercase "1.0.0"]
-                 [frankiesardo/linked "1.3.0"]
-                 [ring-middleware-format "0.7.4"]
+  :dependencies [[prismatic/schema "1.1.12"]
+                 [prismatic/plumbing "0.5.5"]
+                 [ikitommi/linked "1.3.1-alpha1"] ;; waiting for the original
+                 [metosin/muuntaja "0.6.6"]
+                 [com.fasterxml.jackson.datatype/jackson-datatype-joda "2.10.1"]
+                 [ring/ring-core "1.8.0"]
+                 [compojure "1.6.1" ]
+                 [metosin/spec-tools "0.10.6"]
                  [metosin/ring-http-response "0.9.1"]
+                 [metosin/ring-swagger-ui "3.24.3"]
                  [metosin/ring-swagger "1.0.0"]
-                 [metosin/ring-swagger-ui "2.2.10"]]
+
+                 ;; Fix dependency conflicts
+                 [clj-time "0.15.2"]
+                 [joda-time "2.10.5"]
+                 [riddley "0.2.0"]]
+  :pedantic? :abort
   :profiles {:uberjar {:aot :all
                        :ring {:handler examples.thingie/app}
                        :source-paths ["examples/thingie/src"]
                        :dependencies [[org.clojure/clojure "1.9.0"]
                                       [http-kit "2.3.0"]
                                       [reloaded.repl "0.2.4"]
                                       [com.stuartsierra/component "0.4.0"]]}
-             :dev {:jvm-opts ["-Dcompojure.api.core.allow-dangerous-middleware=true"]
-                   :repl-options {:init-ns user}
-                   :plugins [[lein-clojars "0.9.1"]
-                             [lein-midje "3.2.1"]
-                             [lein-ring "0.12.0"]
+             :dev {:plugins [[lein-clojars "0.9.1"]
+                             [lein-ring "0.12.5"]
                              [funcool/codeina "0.5.0"]]
                    :dependencies [[org.clojure/clojure "1.9.0"]
-                                  ;; bump
-                                  [fipp "0.6.26"]
-                                  [metosin/spec-tools "0.10.6"]
-                                  [metosin/muuntaja "0.6.6"]
-                                  [metosin/jsonista "0.2.5"]
-                                  [com.fasterxml.jackson.datatype/jackson-datatype-joda "2.10.1"]
-                                  [slingshot "0.12.2"]
-                                  [peridot "0.5.1"]
-                                  [javax.servlet/servlet-api "2.5"]
-                                  [midje "1.9.9"]
+                                  [org.clojure/core.unify "0.6.0"]
+                                  [org.clojure/core.async "0.6.532"]
+                                  [javax.servlet/javax.servlet-api "4.0.1"]
+                                  [peridot "0.5.2"]
                                   [com.stuartsierra/component "0.4.0"]
+                                  [expound "0.8.2"]
+                                  [metosin/jsonista "0.2.5"]
                                   [reloaded.repl "0.2.4"]
+                                  [metosin/muuntaja-msgpack "0.6.6"]
+                                  [metosin/muuntaja-yaml "0.6.6"]
+                                  [org.immutant/immutant "2.1.10"]
                                   [http-kit "2.3.0"]
                                   [criterium "0.4.5"]]
+                   :jvm-opts ["-Dcompojure.api.meta.static-context-coach={:default :assert :verbose true}"]
+                   :test-paths ["test19"]
                    :ring {:handler examples.thingie/app
                           :reload-paths ["src" "examples/thingie/src"]}
                    :source-paths ["examples/thingie/src" "examples/thingie/dev-src"]
                    :main examples.server}
              :perf {:jvm-opts ^:replace ["-server"
                                          "-Xmx4096m"
                                          "-Dclojure.compiler.direct-linking=true"]}
-             :logging {:dependencies [[org.clojure/tools.logging "0.5.0"]]}
+             :logging {:dependencies [[org.clojure/tools.logging "0.5.0"]
+                                      [org.slf4j/jcl-over-slf4j "1.7.30"]
+                                      [org.slf4j/jul-to-slf4j "1.7.30"]
+                                      [org.slf4j/log4j-over-slf4j "1.7.30"]
+                                      [ch.qos.logback/logback-classic "1.2.3" ]]}
              :1.10 {:dependencies [[org.clojure/clojure "1.10.1"]]}
              :1.11 {:dependencies [[org.clojure/clojure "1.11.3"]]}
-             :1.12 {:dependencies [[org.clojure/clojure "1.12.0-alpha11"]]}}
+             :1.12 {:dependencies [[org.clojure/clojure "1.12.0-alpha11"]]}
+             :async {:jvm-opts ["-Dcompojure-api.test.async=true"]
+                     :dependencies [[manifold "0.1.8" :exclusions [org.clojure/tools.logging]]]}}
   :eastwood {:namespaces [:source-paths]
              :add-linters [:unused-namespaces]}
   :codeina {:sources ["src"]
@@ -79,10 +88,10 @@
                   ["change" "version" "leiningen.release/bump-version"]
                   ["vcs" "commit"]
                   ["vcs" "push"]]
-  :aliases {"all" ["with-profile" "dev:dev,logging:dev,1.10:dev,1.11:dev,1.12"]
+  :aliases {"all" ["with-profile" "dev:dev,async:dev,1.10:dev,1.11:dev,1.12"]
             "start-thingie" ["run"]
             "aot-uberjar" ["with-profile" "uberjar" "do" "clean," "ring" "uberjar"]
-            "test-ancient" ["midje"]
+            "test-ancient" ["test"]
             "perf" ["with-profile" "default,dev,perf"]
             "deploy!" ^{:doc "Recompile sources, then deploy if tests succeed."}
-            ["do" ["clean"] ["midje"] ["deploy" "clojars"]]})
+            ["do" ["clean"] ["test"] ["deploy" "clojars"]]})
diff --git a/src/compojure/api/api.clj b/src/compojure/api/api.clj
@@ -1,16 +1,17 @@
 (ns compojure.api.api
   (:require [compojure.api.core :as c]
             [compojure.api.swagger :as swagger]
-            [compojure.api.middleware :as middleware]
+            [compojure.api.middleware :as mw]
+            [compojure.api.request :as request]
             [compojure.api.routes :as routes]
             [compojure.api.common :as common]
-            [compojure.api.coerce :as coerce]
+            [compojure.api.request :as request]
             [ring.swagger.common :as rsc]
             [ring.swagger.middleware :as rsm]))
 
 (def api-defaults
   (merge
-    middleware/api-middleware-defaults
+    mw/api-middleware-defaults
     {:api {:invalid-routes-fn routes/log-invalid-child-routes
            :disable-api-middleware? false}
      :swagger {:ui nil, :spec nil}}))
@@ -23,8 +24,7 @@
   options map as the first parameter:
 
       (api
-        {:formats [:json-kw :edn :transit-msgpack :transit-json]
-         :exceptions {:handlers {:compojure.api.exception/default my-logging-handler}}
+        {:exceptions {:handlers {:compojure.api.exception/default my-logging-handler}}
          :api {:invalid-routes-fn (constantly nil)}
          :swagger {:spec \"/swagger.json\"
                    :ui \"/api-docs\"
@@ -47,30 +47,55 @@
 
   ### api-middleware options
 
+  See `compojure.api.middleware/api-middleware` for more available options.
+
   " (:doc (meta #'compojure.api.middleware/api-middleware)))}
   api
   [& body]
   (let [[options handlers] (common/extract-parameters body false)
+        _ (assert (not (contains? options :format))
+                  (str "ERROR: Option [:format] is not used with 2.* version.\n"
+                       "Compojure-api uses now Muuntaja insted of ring-middleware-format,\n"
+                       "the new formatting options for it should be under [:formats]. See\n"
+                       "[[api-middleware]] documentation for more details.\n"))
+        _ (when (and (not (:formatter options))
+                     (not (contains? options :formats))
+                     (not (System/getProperty "compojure.api.middleware.global-default-formatter")))
+            (throw (ex-info (str "ERROR: Please set `:formatter :muuntaja` in the options map of `api`.\n"
+                                 "e.g., (api {:formatter :muuntaja} routes...)\n"
+                                 "To prepare for backwards compatibility with compojure-api 1.x, the formatting library must be\n"
+                                 "explicitly chosen if not configured by `:format` (ring-middleware-format) or \n"
+                                 "`:formats` (muuntaja). Once 2.x is stable, the default will be `:formatter :ring-middleware-format`.\n"
+                                 "To globally override the formatter, use -Dcompojure.api.middleware.global-default-formatter=:muuntaja")
+                            {})))
         options (rsc/deep-merge api-defaults options)
         handler (apply c/routes (concat [(swagger/swagger-routes (:swagger options))] handlers))
-        routes (routes/get-routes handler (:api options))
+        partial-api-route (routes/map->Route
+                            {:childs [handler]
+                             :info {:coercion (:coercion options)}})
+        routes (routes/get-routes partial-api-route (:api options))
         paths (-> routes routes/ring-swagger-paths swagger/transform-operations)
         lookup (routes/route-lookup-table routes)
         swagger-data (get-in options [:swagger :data])
         enable-api-middleware? (not (get-in options [:api :disable-api-middleware?]))
-        api-handler (cond-> handler
-                            swagger-data (rsm/wrap-swagger-data swagger-data)
-                            enable-api-middleware? (middleware/api-middleware
-                                                     (dissoc options :api :swagger))
-                            true (middleware/wrap-options
-                                   {:paths paths
-                                    :coercer (coerce/memoized-coercer)
-                                    :lookup lookup}))]
-    (routes/create nil nil {} [handler] api-handler)))
+        api-middleware-options (dissoc (mw/api-middleware-options (assoc (dissoc options :api :swagger) ::via-api true))
+                                       ::mw/api-middleware-defaults)
+        api-handler (-> handler
+                        (cond-> swagger-data (rsm/wrap-swagger-data swagger-data))
+                        (cond-> enable-api-middleware? (mw/api-middleware
+                                                         api-middleware-options))
+                        (mw/wrap-inject-data
+                          {::request/paths paths
+                           ::request/lookup lookup}))]
+    (assoc partial-api-route :handler api-handler)))
 
 (defmacro
-  ^{:doc (str
-  "Defines an api.
+  ^{:superseded-by "api" 
+    :deprecated "2.0.0"
+    :doc (str
+  "Deprecated: please use (def name (api ...body..))
+  
+  Defines an api.
 
   API middleware options:
 

diff --git a/src/compojure/api/coerce.clj b/src/compojure/api/coerce.clj
@@ -1,3 +1,4 @@
+;; 1.1.x
 (ns compojure.api.coerce
   (:require [schema.coerce :as sc]
             [compojure.api.middleware :as mw]

diff --git a/src/compojure/api/core.clj b/src/compojure/api/core.clj
@@ -54,16 +54,16 @@
    :deprecated "1.1.14"
    :superseded-by "route-middleware"}
   [middleware & body]
-  (when (not= "true" (System/getProperty "compojure.api.core.suppress-middleware-warning"))
-    (println (str "compojure.api.core.middleware is deprecated because of security issues. "
-                  "Please use route-middleware instead. middleware will be disabled in a future release."
-                  "Set -dcompojure.api.core.suppress-middleware-warning=true to suppress this warning.")))
+  (assert (= "true" (System/getProperty "compojure.api.core.allow-dangerous-middleware"))
+          (str "compojure.api.core.middleware is deprecated because of security issues. "
+               "Please use route-middleware instead. "
+               "Set compojure.api.core.allow-dangerous-middleware=true to keep using middleware."))
   `(let [body# (routes ~@body)
          wrap-mw# (mw/compose-middleware ~middleware)]
      (routes/create nil nil {} [body#] (wrap-mw# body#))))
 
 (defn route-middleware
-  "Wraps routes with given middleware using thread-first macro."
+  "Wraps routes with given middlewares using thread-first macro."
   {:style/indent 1
    :supercedes "middleware"}
   [middleware & body]
@@ -76,11 +76,11 @@
 
 (defmacro context {:style/indent 2} [& args] (meta/restructure nil args {:context? true :&form &form :&env &env}))
 
-(defmacro GET     {:style/indent 2} [& args] (meta/restructure :get     args nil))
-(defmacro ANY     {:style/indent 2} [& args] (meta/restructure nil      args nil))
-(defmacro HEAD    {:style/indent 2} [& args] (meta/restructure :head    args nil))
-(defmacro PATCH   {:style/indent 2} [& args] (meta/restructure :patch   args nil))
-(defmacro DELETE  {:style/indent 2} [& args] (meta/restructure :delete  args nil))
+(defmacro GET {:style/indent 2} [& args] (meta/restructure :get args nil))
+(defmacro ANY {:style/indent 2} [& args] (meta/restructure nil args nil))
+(defmacro HEAD {:style/indent 2} [& args] (meta/restructure :head args nil))
+(defmacro PATCH {:style/indent 2} [& args] (meta/restructure :patch args nil))
+(defmacro DELETE {:style/indent 2} [& args] (meta/restructure :delete args nil))
 (defmacro OPTIONS {:style/indent 2} [& args] (meta/restructure :options args nil))
-(defmacro POST    {:style/indent 2} [& args] (meta/restructure :post    args nil))
-(defmacro PUT     {:style/indent 2} [& args] (meta/restructure :put     args nil))
+(defmacro POST {:style/indent 2} [& args] (meta/restructure :post args nil))
+(defmacro PUT {:style/indent 2} [& args] (meta/restructure :put args nil))
diff --git a/src/compojure/api/exception.clj b/src/compojure/api/exception.clj
@@ -2,10 +2,8 @@
   (:require [ring.util.http-response :as response]
             [clojure.walk :as walk]
             [compojure.api.impl.logging :as logging]
-            [schema.utils :as su])
-  (:import [schema.utils ValidationError NamedError]
-           [com.fasterxml.jackson.core JsonParseException]
-           [org.yaml.snakeyaml.parser ParserException]))
+            [compojure.api.coercion.core :as cc]
+            [compojure.api.coercion.schema]))
 
 ;;
 ;; Default exception handlers
@@ -21,42 +19,62 @@
   (response/internal-server-error {:type "unknown-exception"
                                    :class (.getName (.getClass e))}))
 
-(defn stringify-error
-  "Stringifies symbols and validation errors in Schema error, keeping the structure intact."
-  [error]
-  (walk/postwalk
-    (fn [x]
-      (cond
-        (instance? ValidationError x) (str (su/validation-error-explain x))
-        (instance? NamedError x) (str (su/named-error-explain x))
-        :else x))
-    error))
-
+;; TODO: coercion should handle how to publish data
 (defn response-validation-handler
-  "Creates error response based on Schema error."
+  "Creates error response based on a response error. The following keys are available:
+
+    :type            type of the exception (::response-validation)
+    :coercion        coercion instance used
+    :in              location of the value ([:response :body])
+    :schema          schema to be validated against
+    :error           schema error
+    :request         raw request
+    :response        raw response"
   [e data req]
-  (response/internal-server-error {:errors (stringify-error (su/error-val data))}))
+  (response/internal-server-error
+    (-> data
+        (dissoc :request :response)
+        (update :coercion cc/get-name)
+        (assoc :value (-> data :response :body))
+        (->> (cc/encode-error (:coercion data))))))
 
+;; TODO: coercion should handle how to publish data
 (defn request-validation-handler
-  "Creates error response based on Schema error."
+  "Creates error response based on Schema error. The following keys are available:
+
+    :type            type of the exception (::request-validation)
+    :coercion        coercion instance used
+    :value           value that was validated
+    :in              location of the value (e.g. [:request :query-params])
+    :schema          schema to be validated against
+    :error           schema error
+    :request         raw request"
   [e data req]
-  (response/bad-request {:errors (stringify-error (su/error-val data))}))
+  (response/bad-request
+    (-> data
+        (dissoc :request)
+        (update :coercion cc/get-name)
+        (->> (cc/encode-error (:coercion data))))))
+
+(defn http-response-handler
+  "reads response from ex-data :response"
+  [_ {:keys [response]} _]
+  response)
 
 (defn schema-error-handler
   "Creates error response based on Schema error."
   [e data req]
-  ; FIXME: Why error is not wrapped to ErrorContainer here?
-  (response/bad-request {:errors (stringify-error (:error data))}))
+  (response/bad-request
+    {:errors (compojure.api.coercion.schema/stringify (:error data))}))
 
 (defn request-parsing-handler
   [^Exception ex data req]
-  (let [cause (.getCause ex)]
-    (response/bad-request {:type (cond
-                                   (instance? JsonParseException cause) "json-parse-exception"
-                                   (instance? ParserException cause) "yaml-parse-exception"
-                                   :else "parse-exception")
-                           :message (.getMessage cause)})))
-
+  (let [cause (.getCause ex)
+        original (.getCause cause)]
+    (response/bad-request
+      (merge (select-keys data [:type :format :charset])
+             (if original {:original (.getMessage original)})
+             {:message (.getMessage cause)}))))
 ;;
 ;; Logging
 ;;
@@ -75,5 +93,6 @@
 ;; Mappings from other Exception types to our base types
 ;;
 
-(def legacy-exception-types
-  {:ring.swagger.schema/validation ::request-validation})
+(def mapped-exception-types
+  {:ring.swagger.schema/validation ::request-validation
+   :muuntaja/decode ::request-parsing})
diff --git a/src/compojure/api/impl/logging.clj b/src/compojure/api/impl/logging.clj
@@ -6,17 +6,18 @@
 (declare log!)
 
 ;; use c.t.l logging if available, default to console logging
-(if (find-ns 'clojure.tools.logging)
+(try
   (eval
     `(do
        (require 'clojure.tools.logging)
        (defmacro ~'log! [& ~'args]
-         `(do
-            (clojure.tools.logging/log ~@~'args)))))
-  (let [log (fn [level more] (println (.toUpperCase (name level)) (str/join " " more)))]
-    (defn log! [level x & more]
-      (if (instance? Throwable x)
-        (do
-          (log level more)
-          (.printStackTrace ^Throwable x))
-        (log level (into [x] more))))))
+         `(clojure.tools.logging/log ~@~'args))))
+  (catch Exception _
+    (let [log (fn [level more] (println (.toUpperCase (name level)) (str/join " " more)))]
+      (defn log! [level x & more]
+        (if (instance? Throwable x)
+          (do
+            (log level more)
+            (.printStackTrace ^Throwable x))
+          (log level (into [x] more))))
+      (log! :warn "clojure.tools.logging not found on classpath, compojure.api logging to console."))))