Skip to content
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.

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

internal/testlog: fix log output from sub-loggers #31539

Merged
merged 7 commits into from
Apr 10, 2025

Conversation

jwasinger
Copy link
Contributor

When we instantiate a sub-logger via go-ethereum/internal/testlog/logger.With, we copy the reference to the bufHandler from the parent logger. However, internally, go-ethereum/internal/testlog/logger.With calls log/slog/Logger.With which creates a new handler instance (via internal/bufHandler.WithAttrs).

This PR modifies sub-logger instantiation to use the newly-instantiated handler, instead of copying the reference from the parent instance. The type cast from slog.Handler to *bufHandler in internal/testlog/Logger.With is safe here because a internal/testlog/Logger can only be instantiated with a *bufHandler as the underlying handler type.

Note, that I've also removed a pre-existing method that broke the above assumption. However, this method is not used in our codebase.

I'm not sure if the assumption holds for forks of geth (e.g. optimism has modified the testlogger somewhat allowing test loggers to accept arbitrary handler types), but it seems okay to break API compatibility given that this is in the internal package.

closes #31533

@jwasinger
Copy link
Contributor Author

jwasinger commented Apr 1, 2025

I also would like to modify the example unit test that I copied from the issue to be table-driven, but there doesn't appear to be a way to capture the testlog.T log output from a subtest in the parent test.

@jwasinger jwasinger force-pushed the testlog-fix-sublogger-output branch from 4b0e46f to f464eb4 Compare April 3, 2025 08:24
@fjl fjl merged commit f64aa6e into ethereum:master Apr 10, 2025
3 of 4 checks passed
@fjl fjl added this to the 1.15.8 milestone Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

testlog: sub-logger output is lost
2 participants