Identify the stack frames leading up to the deprecated function

terjesb · Jun 5, 2024 · 231dc42 · 231dc42
1 parent ad9b121
commit 231dc42
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 5 deletions.
diff --git a/common/src/io/pedestal/internal.clj b/common/src/io/pedestal/internal.clj
@@ -14,7 +14,8 @@
   (:require [clojure.edn :as edn]
             [clojure.java.io :as io]
             [clojure.string :as string]
-            [clj-commons.ansi :refer [perr]]))
+            [clj-commons.ansi :refer [perr]]
+            [clj-commons.format.exceptions :as e]))
 
 (defn vec-conj
   [v value]
@@ -34,9 +35,9 @@
     (nil? val) nil
 
     (string? val)
-    (let [slashx (string/index-of val "/")
-          ns-str (when slashx
-                   (subs val 0 slashx))
+    (let [slashx     (string/index-of val "/")
+          ns-str     (when slashx
+                       (subs val 0 slashx))
           symbol-str (if slashx
                        (subs val (inc slashx))
                        val)]
@@ -89,6 +90,27 @@
        (when default-var-name
          (resolver nil nil default-var-name)))))
 
+(defn- truncate-to
+  [limit coll]
+  (let [n (count coll)]
+    (if (<= n limit)
+      coll
+      (drop (- n limit) coll))))
+
+(defn- call-stack
+  [t limit]
+  (let [elements (->> (e/expand-stack-trace t)
+                      (drop-while #(string/starts-with? (:name %) "io.pedestal.internal/")))
+        names    (->> (#'e/transform-stack-trace-elements
+                        elements nil)
+                      (remove :omitted)
+                      (map #'e/format-stack-frame)
+                      (map :name)
+                      distinct
+                      reverse
+                      (truncate-to limit))]
+    (interpose " -> " names)))
+
 (def *deprecations (atom #{}))
 
 (defn deprecation-warning
@@ -99,7 +121,10 @@
       [:yellow
        [:bold "WARNING: "]
        label
-       " is deprecated and may be removed in a future release"])))
+       " is deprecated and may be removed in a future release"]
+
+      "\nCall stack: ... "
+      (call-stack (RuntimeException.) 4))))
 
 (defmacro deprecated
   [label & body]
@@ -111,3 +136,6 @@
   []
   (swap! *deprecations empty))
 
+(comment
+
+  (reset-deprecations))
diff --git a/tests/dev/playground.clj b/tests/dev/playground.clj
@@ -15,6 +15,7 @@
             [io.pedestal.http :as http]
             [io.pedestal.http.route :as route]
             [io.pedestal.tracing :as tel]
+            [io.pedestal.internal :as i]
             [net.lewisship.trace :refer [trace]]
             [clojure.core.async :refer [go <! timeout]]
             [io.pedestal.tracing :as t])
@@ -94,10 +95,18 @@
     :not-running))
 
 
+(defn deprecated-fn
+  []
+  (i/deprecated (random-uuid))
+  :done)
+
 (comment
   (start)
   (stop)
 
+  (deprecated-fn)
+  (i/reset-deprecations)
+
 
   (m/increment-counter ::hit-rate nil)
   (m/advance-counter ::request-time {:path "/api"} 47)