hyperledger-labs / fabric-smart-client / 35695599976

91%

Build Type

push

github

Committed by web-flow

Commit Message

fix(logging): report an unparseable caller name instead of panicking (#1844)

GetPackageName parses the caller's function name on the assumption that
it looks like github.com/org/repo/pkg.Func -- everything up to the first
dot after the last slash. strings.LastIndex returns -1 when there is no
slash, and the following slice expression panics.

Names from a module path always carry a slash, so nothing in production
reaches this: every caller arrives through the chain the function's
runtime.Caller(4) depth assumes. A caller at any other depth can resolve
frame 4 to a standard-library function, whose name has no slash.

Both cases now return the error the signature already provides for, as
the two existing failure modes do.

With the panic gone, GetLogger and GetLoggerWithReplacements are
testable: calling them directly from a test finds no fourth frame and
reports it, while MustGetLogger adds a frame of its own, so from a test
the name resolves and the registered replacements are applied. This
replaces the TestMustGetLogger comment that described #1841 as an
unfixed, separately tracked bug.

The package is now at 97.8%. The two new branches are not reachable from
a test -- no test can put a slash-less name at frame 4 -- so they stay
uncovered.

Fixes #1841

Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>

Coverage Stats

4 of 6 new or added lines in 1 file covered. (66.67%)

10 existing lines in 4 files now uncovered.

27499 of 31961 relevant lines covered (86.04%)

2319.21 hits per line