internal/testlog: fix log output from sub-loggers #31539
Merged
+81
−16
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When we instantiate a sub-logger via
go-ethereum/internal/testlog/logger.With
, we copy the reference to thebufHandler
from the parent logger. However, internally,go-ethereum/internal/testlog/logger.With
callslog/slog/Logger.With
which creates a new handler instance (viainternal/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
ininternal/testlog/Logger.With
is safe here because ainternal/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