fix(logger): make MockLogger lock the buffer implicitly #14428
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.
This has been ported from a similar change in Pebble:
The explicit logging feature was implemented in snapd in commit 16c3680b78d, but this requires a developer to know when another goroutine might be using the logger, and using
WithLoggerLock()
explicitly. In addition, asWithLoggerLock()
acquires the global logger lock, trying to log from the callback ofWithLoggerLock()
might result in a deadlock (but the testing code right now isn't doing this, of course).Instead of requiring explicit locking, this change makes it so that
Write()
,String()
andReset()
access to thebytes.Buffer
is mutex-protected.As
logger.MockLogger()
is only used in unit test code, locking an otherwise uncontested mutex forWrite()
should hopefully not cause any noticeable slowdown, while making it impossible to accidentally use the mock logger in a thread-unsafe way.