rename middleware defaults with -v2 suffix

Author: frenchy64

CHANGELOG.md

@@ -1,16 +1,11 @@
 See also: [compojure-api 1.1.x changelog](./CHANGELOG-1.1.x.md)
 
-## Next
+## 2.0.0-alpha34-SNAPSHOT
 * Lazily load spec and schema coercion
 * bump spec-tools to 0.10.6
   * notable changes: swagger `:name` defaults to `"body"` instead of `""` ([diff](https://github.com/metosin/spec-tools/compare/0.10.2...0.10.3))
-
-## 2.0.0-alpha34-SNAPSHOT
-* **BREAKING CHANGE**: `:formatter :muuntaja` sometimes required for `api{-middleware}` options
-  * to prepare for 1.x compatibility, :muuntaja must be explicitly configured
-  * Migration instructions: run your program and fix the error messages, which will provide specific instructions.
-  * to circumvent this change, set `-Dcompojure.api.middleware.global-default-formatter=:muuntaja`
-  * stable 2.x will default `:formatter` to `:ring-middleware-format`
+* **BREAKING**: removed `api-defaults` vars
+  * add `-v2` suffix to vars
 
 ## 2.0.0-alpha33 (2024-04-30)
 * Throw an error on malformed `:{body,query,headers}`, in particular if anything other than 2 elements was provided

src/compojure/api/api.clj

@@ -9,9 +9,16 @@
             [ring.swagger.common :as rsc]
             [ring.swagger.middleware :as rsm]))
 
-(def api-defaults
+(def api-defaults-v1
   (merge
-    mw/api-middleware-defaults
+    mw/api-middleware-defaults-v1
+    {:api {:invalid-routes-fn routes/log-invalid-child-routes
+           :disable-api-middleware? false}
+     :swagger {:ui nil, :spec nil}}))
+
+(def api-defaults-v2
+  (merge
+    mw/api-middleware-defaults-v2
     {:api {:invalid-routes-fn routes/log-invalid-child-routes
            :disable-api-middleware? false}
      :swagger {:ui nil, :spec nil}}))
@@ -58,17 +65,9 @@
                        "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)
+        options (if (:format options)
+                  (assert nil ":format")
+                  (rsc/deep-merge api-defaults-v2 options))
         handler (apply c/routes (concat [(swagger/swagger-routes (:swagger options))] handlers))
         partial-api-route (routes/map->Route
                             {:childs [handler]
@@ -78,8 +77,8 @@
         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-middleware-options (dissoc (mw/api-middleware-options (assoc (dissoc options :api :swagger) ::via-api true))
-                                       ::mw/api-middleware-defaults)
+        api-middleware-options ((if (:format options) mw/api-middleware-options-v1 mw/api-middleware-options-v2)
+                                (dissoc options :api :swagger))
         api-handler (-> handler
                         (cond-> swagger-data (rsm/wrap-swagger-data swagger-data))
                         (cond-> enable-api-middleware? (mw/api-middleware

src/compojure/api/middleware.clj

@@ -187,6 +187,30 @@
        (map middleware-fn)
        (apply comp identity)))
 
+;;
+;; ring-middleware-format stuff
+;;
+
+(def ^:private default-mime-types
+  {:json "application/json"
+   :json-kw "application/json"
+   :edn "application/edn"
+   :clojure "application/clojure"
+   :yaml "application/x-yaml"
+   :yaml-kw "application/x-yaml"
+   :yaml-in-html "text/html"
+   :transit-json "application/transit+json"
+   :transit-msgpack "application/transit+msgpack"})
+
+(defn mime-types
+  [format]
+  (get default-mime-types format
+       (some-> format :content-type)))
+
+(def ^:private response-only-mimes #{:clojure :yaml-in-html})
+
+(defn ->mime-types [formats] (keep mime-types formats))
+
 ;;
 ;; swagger-data
 ;;
@@ -216,9 +240,20 @@
 ;; Api Middleware
 ;;
 
-(def api-middleware-defaults
-  {::api-middleware-defaults true
-   :formats ::default
+(def api-middleware-defaults-v1
+  {:format {:formats [:json-kw :yaml-kw :edn :transit-json :transit-msgpack]
+            :params-opts {}
+            :response-opts {}}
+   :exceptions {:handlers {:ring.util.http-response/response ex/http-response-handler
+                           ::ex/request-validation ex/request-validation-handler
+                           ::ex/request-parsing ex/request-parsing-handler
+                           ::ex/response-validation ex/response-validation-handler
+                           ::ex/default ex/safe-handler}}
+   :coercion (constantly default-coercion-matchers)
+   :ring-swagger nil})
+
+(def api-middleware-defaults-v2
+  {:formats ::default
    :exceptions {:handlers {:ring.util.http-response/response ex/http-response-handler
                            ::ex/request-validation ex/request-validation-handler
                            ::ex/request-parsing ex/request-parsing-handler
@@ -228,8 +263,11 @@
    :coercion coercion/default-coercion
    :ring-swagger nil})
 
-(defn api-middleware-options [options]
-  (rsc/deep-merge api-middleware-defaults options))
+(defn api-middleware-options-v1 [options]
+  (rsc/deep-merge api-middleware-defaults-v1 options))
+
+(defn api-middleware-options-v2 [options]
+  (rsc/deep-merge api-middleware-defaults-v2 options))
 
 ;; TODO: test all options! (https://github.com/metosin/compojure-api/issues/137)
 (defn api-middleware
@@ -256,15 +294,6 @@
 
   ### Options
 
-  - **:formatter**                 either :ring-middleware-format or :muuntaja.
-                                   During 2.x pre-releases, this will be a required key, unless
-                                   :formats is provided, which is equivalent to setting to :muuntaja.
-                                   Stable 2.x releases will default to :ring-middleware-format if
-                                   not provided or :format is set, unless :formats is provided,
-                                   which is equivalent to setting to :muuntaja.
-                                   Stable 2.x will print a deprecation warning if implicitly
-                                   or explicitly set to :ring-middleware-format.
-
   - **:exceptions**                for *compojure.api.middleware/wrap-exceptions* (nil to unmount it)
       - **:handlers**                Map of error handlers for different exception types, type refers to `:type` key in ExceptionInfo data.
 
@@ -286,42 +315,11 @@
                                    :components restructuring. (If you are using api,
                                    you might want to take look at using wrap-components
                                    middleware manually.). Defaults to nil (middleware not mounted)."
-  ([handler]
-   (throw (ex-info (str "ERROR: Please set `:formatter :muuntaja` in the options map of `api-middleware.\n"
-                        "e.g., (api-middleware <handler> {:formatter :muuntaja})\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`.")
-                   {}))
-   (api-middleware handler api-middleware-defaults))
+  ([handler] (api-middleware handler api-middleware-defaults-v2))
   ([handler options]
-   (when (and (::api-middleware-defaults options)
-              (not (:formatter options))
-              (not (System/getProperty "compojure.api.middleware.global-default-formatter")))
-     (throw (ex-info (str "ERROR: Please set `:formatter :muuntaja` in the options map of `api-middleware.\n"
-                          "e.g., (api-middleware <handler> {:formatter :muuntaja})\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 default formatter, use -Dcompojure.api.middleware.global-default-formatter=:muuntaja")
-                     {})))
-   (let [formatter (or (:formatter options)
-                       (when (or (contains? options :formats)
-                                 (= (System/getProperty "compojure.api.middleware.global-default-formatter")
-                                    ":muuntaja"))
-                         :muuntaja)
-                       (throw (ex-info (str "ERROR: Please set `:formatter :muuntaja` in the options map of `api-middleware.\n"
-                                            "e.g., (api-middleware <handler> {:formatter :muuntaja})\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 default formatter, use -Dcompojure.api.middleware.global-default-formatter=:muuntaja")
-                                       {}))
-                       ;; TODO 2.x stable
-                       :ring-middleware-format)
-         _ (assert (= :muuntaja formatter)
-                   (str "Invalid :formatter: " (pr-str formatter) ". Must be :muuntaja."))
-         options (api-middleware-options options)
+   (let [options (if (:format options)
+                   (assert (not (:format options)))
+                   (api-middleware-options-v2 options))
          {:keys [exceptions components formats middleware ring-swagger coercion]} options
          muuntaja (create-muuntaja formats)]
 

test/compojure/api/coercion/schema_coercion_test.clj

@@ -150,8 +150,7 @@
 
 (deftest apis-test
   (let [app (api
-              {:formatter :muuntaja
-               :swagger {:spec "/swagger.json"}
+              {:swagger {:spec "/swagger.json"}
                :coercion :schema}
 
               (POST "/body" []

test/compojure/api/coercion_test.clj

@@ -31,11 +31,11 @@
                                       :default {:schema {:value s/Int}}}
                           (ok {:value (or value "123")}))]
       (testing "200"
-        (is-has-body {:value "123"} (get* (api {:formatter :muuntaja} r-200) "/"))
-        (is-fails-with 500 (get* (api {:formatter :muuntaja} r-200) "/" {:value 123})))
+        (is-has-body {:value "123"} (get* (api {} r-200) "/"))
+        (is-fails-with 500 (get* (api {} r-200) "/" {:value 123})))
 
       (testing "exception data"
-        (let [ex (get* (api {:formatter :muuntaja} r-200) "/" {:value 123})]
+        (let [ex (get* (api {} r-200) "/" {:value 123})]
           (is (= 500 (first ex)))
           (is (= {:type "compojure.api.exception/response-validation"
                   :coercion "schema",
@@ -46,12 +46,12 @@
                  (select-keys (second ex) [:type :coercion :in :value :schema :errors])))))
 
       (testing ":default"
-        (is-has-body {:value "123"} (get* (api {:formatter :muuntaja} r-default) "/"))
-        (is-fails-with 500 (get* (api {:formatter :muuntaja} r-default) "/" {:value 123})))
+        (is-has-body {:value "123"} (get* (api {} r-default) "/"))
+        (is-fails-with 500 (get* (api {} r-default) "/" {:value 123})))
 
       (testing ":default"
-        (is-has-body {:value "123"} (get* (api {:formatter :muuntaja} r-200-default) "/"))
-        (is-fails-with 500 (get* (api {:formatter :muuntaja} r-200-default) "/" {:value 123})))))
+        (is-has-body {:value "123"} (get* (api {} r-200-default) "/"))
+        (is-fails-with 500 (get* (api {} r-200-default) "/" {:value 123})))))
 
   (testing "custom coercion"
 
@@ -62,23 +62,21 @@
 
         (testing "by default, applies response coercion"
           (let [app (api
-                      {:formatter :muuntaja}
+                      {}
                       ping-route)]
             (is-fails-with 500 (get* app "/ping"))))
 
         (testing "response-coercion can be disabled"
           (testing "separately"
             (let [app (api
-                        {:formatter :muuntaja
-                         :coercion (cs/create-coercion (dissoc cs/default-options :response))}
+                        {:coercion (cs/create-coercion (dissoc cs/default-options :response))}
                         ping-route)]
               (let [[status body] (get* app "/ping")]
                 (is (= 200 status))
                 (is (= {:pong 123} body)))))
           (testing "all coercion"
             (let [app (api
-                        {:formatter :muuntaja
-                         :coercion nil}
+                        {:coercion nil}
                         ping-route)]
               (let [[status body] (get* app "/ping")]
                 (is (= 200 status))
@@ -88,14 +86,14 @@
           (binding [*async?* true]
             (testing "successful"
               (let [app (api
-                          {:formatter :muuntaja}
+                          {}
                           (GET "/async" []
                                :return s/Str
                                (a/go (ok "abc"))))]
                 (is-has-body "abc" (get* app "/async"))))
             (testing "failing"
               (let [app (api
-                          {:formatter :muuntaja}
+                          {}
                           (GET "/async" []
                                :return s/Int
                                (a/go (ok "foo"))))]
@@ -108,7 +106,7 @@
 
         (testing "by default, applies body coercion (to set)"
           (let [app (api
-                      {:formatter :muuntaja}
+                      {}
                       beer-route)]
             (let [[status body] (post* app "/beer" (json-string {:beers ["ipa" "apa" "ipa"]}))]
               (is (= 200 status))
@@ -117,15 +115,13 @@
         (testing "body-coercion can be disabled"
           (let [no-body-coercion (cs/create-coercion (dissoc cs/default-options :body))
                 app (api
-                      {:formatter :muuntaja
-                       :coercion no-body-coercion}
+                      {:coercion no-body-coercion}
                       beer-route)]
             (let [[status body] (post* app "/beer" (json-string {:beers ["ipa" "apa" "ipa"]}))]
               (is (= 200 status))
               (is (= {:beers ["ipa" "apa" "ipa"]} body))))
           (let [app (api
-                      {:formatter :muuntaja
-                       :coercion nil}
+                      {:coercion nil}
                       beer-route)]
             (let [[status body] (post* app "/beer" (json-string {:beers ["ipa" "apa" "ipa"]}))]
               (is (= 200 status))
@@ -134,8 +130,7 @@
         (testing "body-coercion can be changed"
           (let [nop-body-coercion (cs/create-coercion (assoc cs/default-options :body {:default (constantly nil)}))
                 app (api
-                      {:formatter :muuntaja
-                       :coercion nop-body-coercion}
+                      {:coercion nop-body-coercion}
                       beer-route)]
             (is-fails-with 400 (post* app "/beer" (json-string {:beers ["ipa" "apa" "ipa"]})))))))
 
@@ -146,7 +141,7 @@
 
         (testing "by default, applies query coercion (string->int)"
           (let [app (api
-                      {:formatter :muuntaja}
+                      {}
                       query-route)]
             (let [[status body] (get* app "/query" {:i 10})]
               (is (= 200 status))
@@ -155,8 +150,7 @@
         (testing "query-coercion can be disabled"
           (let [no-query-coercion (cs/create-coercion (dissoc cs/default-options :string))
                 app (api
-                      {:formatter :muuntaja
-                       :coercion no-query-coercion}
+                      {:coercion no-query-coercion}
                       query-route)]
             (let [[status body] (get* app "/query" {:i 10})]
               (is (= 200 status))
@@ -165,14 +159,13 @@
         (testing "query-coercion can be changed"
           (let [nop-query-coercion (cs/create-coercion (assoc cs/default-options :string {:default (constantly nil)}))
                 app (api
-                      {:formatter :muuntaja
-                       :coercion nop-query-coercion}
+                      {:coercion nop-query-coercion}
                       query-route)]
             (is-fails-with 400 (get* app "/query" {:i 10}))))))
 
     (testing "route-specific coercion"
       (let [app (api
-                  {:formatter :muuntaja}
+                  {}
                   (GET "/default" []
                     :query-params [i :- s/Int]
                     (ok {:i i}))