luciano/telemere
1
0
Fork 0
mirror of https://github.com/taoensso/telemere.git synced 2025-12-31 23:18:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[mod] Rename signal field: :run-value -> :run-val

Browse source
This commit is contained in:
Peter Taoussanis 2024-03-14 12:26:58 +01:00
parent 25ed34f022
commit d13e4da5b9
5 changed files with 24 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
resources/signal-docstrings/signal-content.txt
View file

@ -16,7 +16,7 @@ Default keys:
`:error` - Arb user-level platform ?error [2] given to signal call
`:run-form` - Unevaluated ?form given to signal call as `:run`
`:run-value` - Successful return ?val of `:run` ?form
`:run-val` - Successful return ?val of `:run` ?form
`:run-nsecs` - ?int nanosecs runtime of `:run` ?form
`:end-instant` - Platform ?instant [1] when `:run` ?form completed

2
resources/signal-docstrings/spy!.txt
View file

@ -10,7 +10,7 @@ registered handlers for processing (writing to console/disk/db, etc.).
Examples:
(spy! (+ 1 2)) ; %> {:kind :trace, :level :info, :run-form '(+ 1 2),
; :run-value 3, :parent {:keys [id uid]}
; :run-val 3, :run-nsecs <int>, :parent {:keys [id uid]}
; :msg "(+ 1 2) => 3" ...}
(spy! ::my-id (+ 1 2)) ; %> {... :id ::my-id ...}
(spy!

2
resources/signal-docstrings/trace!.txt
View file

@ -10,7 +10,7 @@ registered handlers for processing (writing to console/disk/db, etc.).
Examples:
(trace! (+ 1 2)) ; %> {:kind :trace, :level :info, :run-form '(+ 1 2),
; :run-value 3, :parent {:keys [id uid]} ...
; :run-val 3, :run-nsecs <int>, :parent {:keys [id uid]} ...
; :msg "(+ 1 2) => 3" ...}
(trace! ::my-id (+ 1 2)) ; %> {... :id ::my-id ...}
(trace!

10
src/taoensso/telemere/impl.cljc
View file

@ -196,7 +196,7 @@
[^long schema-version instant uid,
location ns line column file,
sample-rate, kind id level, ctx parent,
data msg_ error run-form run-value,
data msg_ error run-form run-val,
end-instant run-nsecs])
(deftype #_defrecord WrappedSignal
@ -337,18 +337,18 @@
#?(:clj (.plusNanos ^java.time.Instant instant run-nsecs)
:cljs (js/Date. (+ (.getTime instant) (/ run-nsecs 1e6))))
run-error (.-error run-result)
run-value (.-value run-result)
run-err (.-error run-result)
run-val (.-value run-result)
msg_
(if (enc/identical-kw? msg_ ::spy)
(delay (str run-form " => " (or run-error run-value)))
(delay (str run-form " => " (or run-err run-val)))
msg_)]
(Signal. 1 instant uid,
location ns line column file,
sample-rate, kind id level, ctx parent,
data msg_,
run-error run-form run-value,
run-err run-form run-val,
end-instant run-nsecs))
(Signal. 1 instant uid,

32
test/taoensso/telemere_tests.cljc
View file

@ -67,14 +67,14 @@
(let [[rv1 [sv1]] (ws (sig! {:level :info }))
[rv2 [sv2]] (ws (sig! {:level :info, :run (+ 1 2)}))]
[(is (= rv1 true)) (is (sm? sv1 {:ns "taoensso.telemere-tests", :level :info, :run-form nil, :run-value nil, :run-nsecs nil}))
(is (= rv2 3)) (is (sm? sv2 {:ns "taoensso.telemere-tests", :level :info, :run-form '(+ 1 2), :run-value 3, :run-nsecs (enc/pred nat-int?)}))])
[(is (= rv1 true)) (is (sm? sv1 {:ns "taoensso.telemere-tests", :level :info, :run-form nil, :run-val nil, :run-nsecs nil}))
(is (= rv2 3)) (is (sm? sv2 {:ns "taoensso.telemere-tests", :level :info, :run-form '(+ 1 2), :run-val 3, :run-nsecs (enc/pred nat-int?)}))])
(testing "Nested signals"
(let [[[inner-rv [inner-sv]] [outer-sv]] (ws (sig! {:level :info, :run (ws (sig! {:level :warn, :run "inner-run"}))}))]
[(is (= inner-rv "inner-run"))
(is (sm? inner-sv {:level :warn, :run-value "inner-run"}))
(is (sm? outer-sv {:level :info :run-value [inner-rv [inner-sv]]}))]))
(is (sm? inner-sv {:level :warn, :run-val "inner-run"}))
(is (sm? outer-sv {:level :info :run-val [inner-rv [inner-sv]]}))]))
(testing "Instants"
(let [[_ [sv1]] (ws (sig! {:level :info }))
@ -343,30 +343,30 @@
(testing "Auto call id, uid"
(let [[_ [sv]] (ws (sig! {:level :info, :parent {:id :id0, :uid :uid0}, :run impl/*trace-parent*, :data impl/*trace-parent*}))]
[(is (sm? sv {:parent {:id :id0, :uid :uid0}}))
(is (sm? sv {:run-value {:id nil, :uid (get sv :uid ::nx)}}) "`*trace-parent*` visible to run-form, bound to call's auto {:keys [id uid]}")
(is (sm? sv {:data nil}) "`*trace-parent*` not visible to data-form ")]))
[(is (sm? sv {:parent {:id :id0, :uid :uid0}}))
(is (sm? sv {:run-val {:id nil, :uid (get sv :uid ::nx)}}) "`*trace-parent*` visible to run-form, bound to call's auto {:keys [id uid]}")
(is (sm? sv {:data nil}) "`*trace-parent*` not visible to data-form ")]))
(testing "Manual call id, uid"
(let [[_ [sv]] (ws (sig! {:level :info, :parent {:id :id0, :uid :uid0}, :id :id1, :uid :uid1, :run impl/*trace-parent*, :data impl/*trace-parent*}))]
[(is (sm? sv {:parent {:id :id0, :uid :uid0}}))
(is (sm? sv {:run-value {:id :id1, :uid :uid1}}) "`*trace-parent*` visible to run-form, bound to call's auto {:keys [id uid]}")
(is (sm? sv {:data nil}) "`*trace-parent*` not visible to data-form ")]))
[(is (sm? sv {:parent {:id :id0, :uid :uid0}}))
(is (sm? sv {:run-val {:id :id1, :uid :uid1}}) "`*trace-parent*` visible to run-form, bound to call's auto {:keys [id uid]}")
(is (sm? sv {:data nil}) "`*trace-parent*` not visible to data-form ")]))
(testing "Tracing can be disabled via call opt"
(let [[_ [sv]] (ws (sig! {:level :info, :parent {:id :id0, :uid :uid0}, :id :id1, :uid :uid1, :run impl/*trace-parent*, :data impl/*trace-parent*, :trace? false}))]
[(is (sm? sv {:parent {:id :id0, :uid :uid0}}))
(is (sm? sv {:run-value nil}))]))
[(is (sm? sv {:parent {:id :id0, :uid :uid0}}))
(is (sm? sv {:run-val nil}))]))
(testing "Signal nesting"
(let [[[inner-rv [inner-sv]] [outer-sv]]
(ws (sig! { :level :info, :id :id1, :uid :uid1,
:run (ws (sig! {:level :info, :id :id2, :uid :uid2, :run impl/*trace-parent*}))}))]
[(is (sm? outer-sv {:id :id1, :uid :uid1, :parent nil}))
(is (sm? inner-rv {:id :id2, :uid :uid2}))
(is (sm? inner-sv {:parent {:id :id1, :uid :uid1}}))
(is (sm? inner-sv {:run-value {:id :id2, :uid :uid2}}))]))]))
[(is (sm? outer-sv {:id :id1, :uid :uid1, :parent nil}))
(is (sm? inner-rv {:id :id2, :uid :uid2}))
(is (sm? inner-sv {:parent {:id :id1, :uid :uid1}}))
(is (sm? inner-sv {:run-val {:id :id2, :uid :uid2}}))]))]))
(deftest _sampling
;; Capture combined (call * handler) sample rate in Signal when possible