Skip to content

Update zaptest.Logger to use t.Helper() #1512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bts-bastion wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update zaptest.Logger to use t.Helper() #1512

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
666e489
Update zaptest.Logger to use t.Helper()
bts-bastion Oct 2, 2025
4edb9d1
Update zaptest.Logger to use t.Helper()
bts-bastion Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions zaptest/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ package zaptest

import (
"bytes"
"testing"

"go.uber.org/zap"
"go.uber.org/zap/zapcore"
Expand Down Expand Up @@ -137,6 +138,7 @@ func (w TestingWriter) WithMarkFailed(v bool) TestingWriter {

// Write writes bytes from p to the underlying testing.TB.
func (w TestingWriter) Write(p []byte) (n int, err error) {
w.IsHelper()
n = len(p)

// Strip trailing newline because t.Log always adds one.
Expand All @@ -155,3 +157,9 @@ func (w TestingWriter) Write(p []byte) (n int, err error) {
func (w TestingWriter) Sync() error {
return nil
}

func (w TestingWriter) IsHelper() {
Copy link
Copy Markdown
Collaborator

@prashantv prashantv Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of issues with this:

  • This method doesn't need to be exported
  • Calling tb.Helper() from inside of this method probably won't do anything for the caller Write method which I thought was the point. Can you include output verifying that this works as expected before/after this change.

if tb, ok := w.t.(testing.TB); ok {
tb.Helper()
}
}