[new] Add shared signal API

Author: ptaoussanis

src/taoensso/tufte.cljc

@@ -26,14 +26,16 @@
     to programmatic monitoring."
 
   {:author "Peter Taoussanis (@ptaoussanis)"}
-
+  (:refer-clojure :exclude [newline])
   (:require
-   [taoensso.truss        :as truss]
-   [taoensso.encore       :as enc]
-   [taoensso.encore.stats :as stats]
-   [taoensso.tufte.impl   :as impl #?@(:cljs [:refer [PStats HandlerVal]])])
-
-  #?(:clj  (:import [taoensso.tufte.impl PStats HandlerVal]))
+   [taoensso.truss          :as truss]
+   [taoensso.encore         :as enc]
+   [taoensso.encore.stats   :as stats]
+   [taoensso.encore.signals :as sigs]
+   [taoensso.tufte.impl     :as impl
+    #?@(:cljs [:refer [PStats HandlerVal PSignal WrappedPSignal]])])
+
+  #?(:clj  (:import [taoensso.tufte.impl PStats HandlerVal PSignal WrappedPSignal]))
   #?(:cljs (:require-macros [taoensso.tufte :refer [profiled]])))
 
 (comment
@@ -42,6 +44,55 @@
 
 (enc/assert-min-encore-version [3 142 0])
 
+;;;; Shared signal API
+
+(declare ; Needed to avoid `clj-kondo` "Unresolved var" warnings
+  level-aliases
+  help:filters help:handler help:handler-dispatch-options
+  get-filters get-min-levels get-handlers get-handlers-stats
+
+  #?(:clj without-filters)
+  set-kind-filter! #?(:clj with-kind-filter)
+  set-ns-filter!   #?(:clj with-ns-filter)
+  set-id-filter!   #?(:clj with-id-filter)
+  set-min-level!   #?(:clj with-min-level)
+
+  #?(:clj with-handler) #?(:clj with-handler+)
+  add-handler! remove-handler! stop-handlers!
+
+  ^:dynamic *ctx* set-ctx! #?(:clj with-ctx) #?(:clj with-ctx+)
+  ^:dynamic *xfn* set-xfn! #?(:clj with-xfn) #?(:clj with-xfn+))
+
+(sigs/def-api
+  {:sf-arity 3
+   :ct-call-filter   impl/ct-call-filter
+   :*rt-call-filter* impl/*rt-call-filter*
+   :*sig-handlers*   impl/*sig-handlers*
+   :lib-dispatch-opts
+   (assoc sigs/default-handler-dispatch-opts
+     :convey-bindings? false ; Handled manually
+     )})
+
+;;;; Aliases
+
+(enc/defaliases
+  ;; Encore
+  #?(:clj enc/set-var-root!)
+  #?(:clj enc/update-var-root!)
+  #?(:clj enc/get-env)
+  #?(:clj enc/call-on-shutdown!)
+  enc/chance
+  enc/rate-limiter
+  enc/newline
+  sigs/comp-xfn
+  sigs/default-handler-dispatch-opts
+  #?(:clj truss/keep-callsite))
+
+;;;; Help
+
+(def help:signal-content       "TODO")
+(def help:environmental-config "TODO")
+
 ;;;; Level filtering
 ;; Terminology note: we distinguish between call/form and min levels to ensure
 ;; that it's always possible to set min-level > any call-level to disable profiling.

src/taoensso/tufte/impl.cljc

@@ -13,7 +13,8 @@
    [clojure.string  :as str]
    [taoensso.truss  :as truss]
    [taoensso.encore :as enc]
-   [taoensso.encore.stats :as stats])
+   [taoensso.encore.stats   :as stats]
+   [taoensso.encore.signals :as sigs])
 
   #?(:cljs
      (:require-macros
@@ -638,6 +639,60 @@
          (map (fn [id] (str id sep (format-pstats (get m id) format-pstats-opts))))
          sorted-profiling-ids)))))
 
+;;;; Profiling Signals
+;; - Filtering relevant for `profiled`, `profile`
+;; - Handlers  relevant for `profiled` only
+
+(enc/defonce ^:dynamic *sig-handlers* "?[<wrapped-handler-fn>]" nil)
+
+(defrecord PSignal
+  ;; Based on `taoensso.telemere.impl/Signal`
+  [schema inst, ns coords, id level, #?@(:clj [host thread]),
+   sample ctx data, body-val, pstats format-pstats-fn]
+
+  Object (toString [this] (str "taoensso.tufte.PSignal" (enc/pr-edn* (into {} this)))))
+
+;; Verbose constructors for readability + to support extra keys
+(do     (enc/def-print-impl [x PSignal] (str "#taoensso.tufte.PSignal"      (enc/pr-edn* (into {} x)))))
+#?(:clj (enc/def-print-dup  [x PSignal] (str "#taoensso.tufte.impl.PSignal" (enc/pr-edn* (into {} x)))))
+
+(defn psignal? #?(:cljs {:tag 'boolean}) [x] (instance? PSignal x))
+
+(defrecord WrappedPSignal [ns id level signal-value_]
+  sigs/ISignalHandling
+  (allow-signal? [_ spec-filter] (spec-filter ns id level))
+  (signal-debug  [_] {:ns ns, :id id, :level level})
+  (signal-value  [_ handler-sample-rate]
+    (sigs/signal-with-combined-sample-rate handler-sample-rate
+      (force signal-value_))))
+
+#?(:clj
+   (let [base      (enc/get-env {:as :edn} [:taoensso.tufte/ct-filters<.platform><.edn>])
+         ns-filter (enc/get-env {:as :edn} [:taoensso.tufte/ct-ns-filter<.platform><.edn> :taoensso.tufte/ns-pattern])
+         id-filter (enc/get-env {:as :edn} [:taoensso.tufte/ct-id-filter<.platform><.edn>])
+         min-level (enc/get-env {:as :edn} [:taoensso.tufte/ct-min-level<.platform><.edn> :taoensso.tufte/min-level])]
+
+     (enc/defonce ct-call-filter
+       "`SpecFilter` used for compile-time elision, or nil."
+       (sigs/spec-filter
+         {:ns-filter (or ns-filter (get base :ns-filter))
+          :id-filter (or id-filter (get base :id-filter))
+          :min-level (or min-level (get base :min-level))}))))
+
+(let [base      (enc/get-env {:as :edn} [:taoensso.tufte/rt-filters<.platform><.edn>])
+      ns-filter (enc/get-env {:as :edn} [:taoensso.tufte/rt-ns-filter<.platform><.edn>])
+      id-filter (enc/get-env {:as :edn} [:taoensso.tufte/rt-id-filter<.platform><.edn>])
+      min-level (enc/get-env {:as :edn} [:taoensso.tufte/rt-min-level<.platform><.edn>])]
+
+  (enc/defonce ^:dynamic *rt-call-filter*
+    "`SpecFilter` used for runtime filtering, or nil."
+    (sigs/spec-filter
+      {:ns-filter (or ns-filter (get base :ns-filter))
+       :id-filter (or id-filter (get base :id-filter))
+       :min-level (or min-level (get base :min-level))})))
+
+(comment (enc/get-env {:as :edn, :return :explain} :taoensso.tufte/rt-filters<.platform><.edn>))
+
 ;;;; Handlers
 
 (defrecord HandlerVal [ns-str level ?id ?data pstats pstats-str_ ?file ?line]
@@ -647,8 +702,6 @@
 (do     (enc/def-print-impl [x HandlerVal] (str "#taoensso.tufte.HandlerVal"      (enc/pr-edn* (into {} x)))))
 #?(:clj (enc/def-print-dup  [x HandlerVal] (str "#taoensso.tufte.impl.HandlerVal" (enc/pr-edn* (into {} x)))))
 
-(defn handler-val? #?(:cljs {:tag 'boolean}) [x] (instance? HandlerVal x))
-
 (enc/defonce handlers_ "{<hid> <handler-fn>}" (atom nil))
 
 #?(:clj

test/taoensso/tufte_tests.cljc

@@ -377,11 +377,11 @@
          (is (every? #(= nested-reference @%) (doall (repeatedly 100 (fn [] (future (Thread/sleep 10) (nested-profiled true  false)))))) "(dynamic (local   ...))")]))])
 
 (deftest printing
-  [#?(:clj (is (impl/handler-val? (read-string (binding [*print-dup* true] (pr-str        (impl/map->HandlerVal {})))))))
-   #?(:clj (is (impl/handler-val? (read-string (binding [*print-dup* true] (pr-str (assoc (impl/map->HandlerVal {}) :k :v)))))))
-   (is (enc/str-starts-with?                   (binding [*print-dup* true]    (str (assoc (impl/map->HandlerVal {}) :k :v))) "taoensso.tufte.HandlerVal{"))
-   (is (enc/str-starts-with?                                               (pr-str (assoc (impl/map->HandlerVal {}) :k :v)) "#taoensso.tufte.HandlerVal{"))
-   (is (enc/str-starts-with?                                                  (str (assoc (impl/map->HandlerVal {}) :k :v))  "taoensso.tufte.HandlerVal{"))])
+  [#?(:clj (is (impl/psignal? (read-string (binding [*print-dup* true] (pr-str        (impl/map->PSignal {})))))))
+   #?(:clj (is (impl/psignal? (read-string (binding [*print-dup* true] (pr-str (assoc (impl/map->PSignal {}) :k :v)))))))
+   (is (enc/str-starts-with?               (binding [*print-dup* true]    (str (assoc (impl/map->PSignal {}) :k :v))) "taoensso.tufte.PSignal{"))
+   (is (enc/str-starts-with?                                           (pr-str (assoc (impl/map->PSignal {}) :k :v)) "#taoensso.tufte.PSignal{"))
+   (is (enc/str-starts-with?                                              (str (assoc (impl/map->PSignal {}) :k :v))  "taoensso.tufte.PSignal{"))])
 
 (deftest advanced
   (testing "Advanced"