Returning the wrong type on trace/capture fn causes mulog to silently stop recording logs and traces

[2food]

Hi,

I often use trace with :capture identity like this:

(µ/trace :foo {:pairs   {:info :blabla}
               :capture identity}
    (do-stuff))

Which is nice, because you get whatever the result of the body was in the trace log.
However, I just discovered that if the body returns a single value, rather than a map (or coll). The trace silently fails to log anything. So this:

(µ/trace :foo {:pairs   {:info :blabla}
               :capture identity}
    (do (stuff)
        :single-thing))

Will not log anything. And, additionally, any logs nested inside the trace will also fail. So this:

(µ/trace :foo {:pairs   {:info :blabla}
               :capture identity}
    (do (µ/log :bar)
        :single-thing))

Does not log anything, and does not throw an error either. Even if the `µ/log' happens deeper down in the call-stack of the body.

I think this behavior is quite unfortunate. If returning a non-map value in the capture function is invalid, it should throw an error, or log one, or maybe write the log without the captured value, or something else. But failing silently is not good.

Of course, the simple workaround would be to always wrap the returned value in a map, like this:

(µ/trace :foo {:pairs   {:info :blabla}
               :capture (fn [r] {:result r})}
    (do (µ/log :bar)
        :single-thing))

And I see that the doc for µ/trace does specify that the capture fn should return a map, but people don't always read the docs 😄 And even when they do, mistakes still happen.

[BrunoBonacci]

Hi @2food

thanks for reporting this, and apologies for the delay. I was traveling when you submitted this issue and I missed it on my return.

Please note that the API for capture clearly states that it should return a map

https://cljdoc.org/d/com.brunobonacci/mulog/0.9.0/api/com.brunobonacci.mulog#capture-evaluation-result

The capture function is a function which takes one argument, the result of the evaluation and returns a map of key-value
pairs which need to be added to the trace.

So I consider this a misuse of the API.

However, I will investigate the nested missing logs and maybe add a more explicit error.

[BrunoBonacci]

Fix released with mulog-v0.10.0

in case the :capture function return a value that is not a map (or nil) the following error keys will be added to the trace.

{ ,,,
  :mulog/capture :error,
  :mulog/capture-message  "Invalid type returned, :capture fn must return a map!",
  ,,,
}