Add frame count to WithIndirectCaller.

go-nacelle · Oct 7, 2019 · 1f42b92 · 1f42b92
1 parent e96cc14
commit 1f42b92
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ Sometimes it is useful to define helper functions that logs messages for you in
 
 ```go
 func logForMe(message string) {
-    parentLogger.WithIndirectCaller().Log(message)
+    parentLogger.WithIndirectCaller(1).Log(message)
 }
 
 logForMe("foobar")

diff --git a/base_logger_mock_test.go b/base_logger_mock_test.go
diff --git a/caller_test.go b/caller_test.go
@@ -131,7 +131,7 @@ func (s *CallerSuite) testAdapter(init func(*Config) (Logger, error)) {
 		logger, err := init(&Config{LogLevel: "info", LogEncoding: "json"})
 		Expect(err).To(BeNil())
 		// Push caller stack out once for each indirection
-		indirectLogger := logger.WithIndirectCaller().WithIndirectCaller().WithIndirectCaller()
+		indirectLogger := logger.WithIndirectCaller(3)
 
 		log3 := func(message string) { indirectLogger.Info(message) }
 		log2 := func(message string) { log3(message) }

diff --git a/logger.go b/logger.go
@@ -2,7 +2,7 @@ package log
 
 type (
 	Logger interface {
-		WithIndirectCaller() Logger
+		WithIndirectCaller(frames int) Logger
 		WithFields(LogFields) Logger
 		LogWithFields(LogLevel, LogFields, string, ...interface{})
 		Sync() error

diff --git a/mocks/logger.go b/mocks/logger.go
diff --git a/shim.go b/shim.go
@@ -33,8 +33,12 @@ func adaptReplayShim(shim *replayShim) ReplayLogger {
 	return &replayShimAdapter{adaptShim(shim), shim}
 }
 
-func (sa *shimAdapter) WithIndirectCaller() Logger {
-	return &shimAdapter{shim: sa.shim, depth: sa.depth + 1}
+func (sa *shimAdapter) WithIndirectCaller(frames int) Logger {
+	if frames <= 0 {
+		panic("WithIndirectCaller called with invalid frame count")
+	}
+
+	return &shimAdapter{shim: sa.shim, depth: sa.depth + frames}
 }
 
 func (sa *shimAdapter) WithFields(fields LogFields) Logger {