luciano/telemere
1
0
Fork 0
mirror of https://github.com/taoensso/telemere.git synced 2026-02-16 08:15:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[new] Prevent common signal opts errors

Browse source
This commit is contained in:
Peter Taoussanis 2024-04-11 09:50:56 +02:00
parent 3d66cad4e6
commit 37b400ff18
2 changed files with 40 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -470,27 +470,44 @@
[context defaults main-key extra-key arg-order args] [context defaults main-key extra-key arg-order args]
(enc/cond (enc/cond
:let [num-args (count args)] :let [context-name (str "`" (name context) "`")
num-args (count args)
bad-args!
(fn [msg data]
(throw
(ex-info (str "Invalid " context-name " args: " msg)
(conj
{:context context
:args args}
data))))]
(not (#{1 2} num-args)) (not (#{1 2} num-args))
(throw (bad-args! (str "wrong number of args (" num-args ")")
(ex-info (str "Wrong number of args (" num-args ") passed to: " context) {:actual num-args, :expected #{1 2}})
{:context context
:num-args {:actual num-args, :expected #{1 2}}
:args args}))
:let [[main-val extra-val-or-opts] :let [[main-arg extra-arg]
(case arg-order (case arg-order
:dsc args, ; [main ...] :dsc args ; [main ...]
:asc (reverse args) ; [... main] :asc (reverse args) ; [... main]
(enc/unexpected-arg! (enc/unexpected-arg!
arg-order))] arg-order))
(if (or (= num-args 1) (map? extra-val-or-opts)) extra-arg? (= num-args 2)
(let [opts extra-val-or-opts] (merge defaults {main-key main-val} opts)) extra-opts? (and extra-arg? (map? extra-arg))]
(let [extra-val extra-val-or-opts] (merge defaults {main-key main-val, extra-key extra-val}))))))
(comment (signal-opts `signal! {:level :info} :id :level :dsc [::my-id {:level :warn}])) :do
(cond
(map? main-arg)
(bad-args! "single map arg is USUALLY a mistake, so isn't allowed. Please use 2 arg call if this is intentional." {})
(and extra-opts? (contains? extra-arg main-key))
(bad-args! (str "given opts should not contain `" main-key "`.") {}))
extra-opts? (merge defaults {main-key main-arg} extra-arg)
extra-arg? (merge defaults {main-key main-arg, extra-key extra-arg})
:else (merge defaults {main-key main-arg}))))
(comment (signal-opts `foo! {:level :info} :id :level :dsc [::my-id {:level :warn}]))
#?(:clj #?(:clj
(defn signal-catch-opts (defn signal-catch-opts

17
test/taoensso/telemere_tests.cljc
View file

@ -438,17 +438,20 @@
(deftest _common-signals (deftest _common-signals
[#?(:clj [#?(:clj
(testing "signal-opts" (testing "signal-opts"
[(is (= (impl/signal-opts `signal! {:level :info} :id :level :dsc [::my-id ]) {:level :info, :id ::my-id})) [(is (= (impl/signal-opts `foo! {:level :info} :id :level :dsc [::my-id ]) {:level :info, :id ::my-id}))
(is (= (impl/signal-opts `signal! {:level :info} :id :level :dsc [::my-id :warn ]) {:level :warn, :id ::my-id})) (is (= (impl/signal-opts `foo! {:level :info} :id :level :dsc [::my-id :warn ]) {:level :warn, :id ::my-id}))
(is (= (impl/signal-opts `signal! {:level :info} :id :level :dsc [::my-id {:level :warn}]) {:level :warn, :id ::my-id})) (is (= (impl/signal-opts `foo! {:level :info} :id :level :dsc [::my-id {:level :warn}]) {:level :warn, :id ::my-id}))
(is (= (impl/signal-opts `signal! {:level :info} :id :level :asc [ ::my-id]) {:level :info, :id ::my-id})) (is (= (impl/signal-opts `foo! {:level :info} :id :level :asc [ ::my-id]) {:level :info, :id ::my-id}))
(is (= (impl/signal-opts `signal! {:level :info} :id :level :asc [:warn ::my-id]) {:level :warn, :id ::my-id})) (is (= (impl/signal-opts `foo! {:level :info} :id :level :asc [:warn ::my-id]) {:level :warn, :id ::my-id}))
(is (= (impl/signal-opts `signal! {:level :info} :id :level :asc [{:level :warn} ::my-id]) {:level :warn, :id ::my-id})) (is (= (impl/signal-opts `foo! {:level :info} :id :level :asc [{:level :warn} ::my-id]) {:level :warn, :id ::my-id}))
(is (= (impl/signal-catch-opts {:id :main-id, :location {:ns "ns"}, :catch->error true}) [{:id :main-id, :location {:ns "ns"}} {:location {:ns "ns"}, :id :main-id}])) (is (= (impl/signal-catch-opts {:id :main-id, :location {:ns "ns"}, :catch->error true}) [{:id :main-id, :location {:ns "ns"}} {:location {:ns "ns"}, :id :main-id}]))
(is (= (impl/signal-catch-opts {:id :main-id, :location {:ns "ns"}, :catch->error :error-id}) [{:id :main-id, :location {:ns "ns"}} {:location {:ns "ns"}, :id :error-id}])) (is (= (impl/signal-catch-opts {:id :main-id, :location {:ns "ns"}, :catch->error :error-id}) [{:id :main-id, :location {:ns "ns"}} {:location {:ns "ns"}, :id :error-id}]))
(is (= (impl/signal-catch-opts {:id :main-id, :location {:ns "ns"}, :catch->error {:id :error-id}}) [{:id :main-id, :location {:ns "ns"}} {:location {:ns "ns"}, :id :error-id}]))])) (is (= (impl/signal-catch-opts {:id :main-id, :location {:ns "ns"}, :catch->error {:id :error-id}}) [{:id :main-id, :location {:ns "ns"}} {:location {:ns "ns"}, :id :error-id}]))
(is (throws? :ex-info "Invalid `foo!` args: single map arg is USUALLY a mistake" (impl/signal-opts `foo! {:level :info} :id :level :dsc [{:msg "msg"}])))
(is (throws? :ex-info "Invalid `foo!` args: given opts should not contain `:id`" (impl/signal-opts `foo! {:level :info} :id :level :dsc [:my-id1 {:id ::my-id2}])))]))
(testing "event!" ; id + ?level => allowed? (testing "event!" ; id + ?level => allowed?
[(let [[[rv] [sv]] (with-sigs (tel/event! :id1 ))] [(is (= rv true)) (is (sm? sv {:kind :event, :line :submap/ex, :level :info, :id :id1}))]) [(let [[[rv] [sv]] (with-sigs (tel/event! :id1 ))] [(is (= rv true)) (is (sm? sv {:kind :event, :line :submap/ex, :level :info, :id :id1}))])