Merge pull request #176 from metosin/clojure.tools.logging

Clojure.tools.logging

Author: ikitommi

CHANGELOG.md

@@ -1,8 +1,9 @@
 ## 0.24.1-SNAPSHOT
 
-* Fixes [#159](https://github.com/metosin/compojure-api/issues/159)
-* allow any swagger data to be overriden either via swagger-docs or via middlewares, fixes 
-  [#170](https://github.com/metosin/compojure-api/issues/170).
+* `clojure.tools.logging` is used with default uncaugt exception handling if it's found
+on the classpath. Fixes [#172](https://github.com/metosin/compojure-api/issues/172).
+* Both `api` and `defapi` produce identical swagger-docs. Fixes [#159](https://github.com/metosin/compojure-api/issues/159)
+* allow any swagger data to be overriden at runtime either via swagger-docs or via middlewares. Fixes [#170](https://github.com/metosin/compojure-api/issues/170).
 
 ```clojure
 [prismatic/plumbing "0.5.2] is available but we use "0.5.1"

project.clj

@@ -43,14 +43,15 @@
                           :reload-paths ["src" "examples/src"]}
                    :source-paths ["examples/src" "examples/dev-src"]
                    :main examples.server}
+             :logging {:dependencies [[org.clojure/tools.logging "0.3.1"]]}
              :1.8 {:dependencies [[org.clojure/clojure "1.8.0-RC2"]]}}
   :eastwood {:namespaces [:source-paths]
              :add-linters [:unused-namespaces]}
   :codeina {:sources ["src"]
             :target "gh-pages/doc"
             :src-dir-uri "http://github.com/metosin/compojure-api/blob/master/"
             :src-linenum-anchor-prefix "L"}
-  :aliases {"all" ["with-profile" "dev:dev,1.8"]
+  :aliases {"all" ["with-profile" "dev:dev,logging:dev,1.8"]
             "start-thingie" ["run"]
             "aot-uberjar" ["with-profile" "uberjar" "do" "clean," "ring" "uberjar"]
             "test-ancient" ["midje"]

src/compojure/api/exception.clj

@@ -1,6 +1,7 @@
 (ns compojure.api.exception
   (:require [ring.util.http-response :refer [internal-server-error bad-request]]
             [clojure.walk :refer [postwalk]]
+            [compojure.api.impl.logging :as logging]
             [schema.utils :as su])
   (:import [schema.utils ValidationError NamedError]
            [com.fasterxml.jackson.core JsonParseException]
@@ -11,12 +12,12 @@
 ;;
 
 (defn safe-handler
-  "Prints stacktrace to console and returns safe error response.
+  "Writes :error to log with the exception message & stacktrace.
 
    Error response only contains class of the Exception so that it won't accidentally
    expose secret details."
   [^Exception e _ _]
-  (.printStackTrace e)
+  (logging/log! :error e (.getMessage e))
   (internal-server-error {:type "unknown-exception"
                           :class (.getName (.getClass e))}))
 

src/compojure/api/impl/logging.clj

@@ -0,0 +1,22 @@
+(ns ^:no-doc compojure.api.impl.logging
+  "Internal Compojure-api logging utility"
+  (:require [clojure.string :as str]))
+
+;; Cursive-users
+(declare log!)
+
+;; use c.t.l logging if available, default to console logging
+(if (find-ns 'clojure.tools.logging)
+  (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 x))
+        (log level (into [x] more))))))

test/compojure/api/middleware_test.clj

@@ -3,7 +3,21 @@
             [midje.sweet :refer :all]
             [ring.util.http-response :refer [ok]]
             [ring.util.http-status :as status]
-            ring.util.test))
+            ring.util.test)
+  (:import [java.io PrintStream ByteArrayOutputStream]))
+
+(defmacro without-err
+  "Evaluates exprs in a context in which *err* is bound to a fresh
+  StringWriter.  Returns the string created by any nested printing
+  calls."
+  [& body]
+  `(let [s# (PrintStream. (ByteArrayOutputStream.))
+         err# (System/err)]
+     (System/setErr s#)
+     (try
+       ~@body
+       (finally
+         (System/setErr err#)))))
 
 (facts serializable?
   (tabular
@@ -25,14 +39,14 @@
     (ring.util.test/string-input-stream "foobar") false false))
 
 (facts "wrap-exceptions"
-  (let [exception (proxy [RuntimeException] [] (printStackTrace []))
-        exception-class (.getName (.getClass exception))
-        failure (fn [_] (throw exception))
-        success (fn [_] (ok "SUCCESS"))
-        request irrelevant]
+  (with-out-str
+    (without-err
+      (let [exception (RuntimeException. "kosh")
+            exception-class (.getName (.getClass exception))
+            failure (fn [_] (throw exception))]
 
-    (fact "converts exceptions into safe internal server errors"
-      ((wrap-exceptions failure (:handlers (:exceptions api-middleware-defaults))) request)
-      => (contains {:status status/internal-server-error
-                    :body (contains {:class exception-class
-                                     :type "unknown-exception"})}))))
+        (fact "converts exceptions into safe internal server errors"
+          ((wrap-exceptions failure (:handlers (:exceptions api-middleware-defaults))) ..request..)
+          => (contains {:status status/internal-server-error
+                        :body (contains {:class exception-class
+                                         :type "unknown-exception"})}))))))