🐛 Fix a race in the delegating logger #1339
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
k8s-ci-robot added the cncf-cla: yes 
| [APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman The full list of commands accepted by this bot can be found here. The pull request process is described here Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot added approved 
For as long as the delegating loggers Fullfill wasn't called, it holds a loggerPromise and that loggerPromise holds the same delegating logger. Calls to With{Name,Field} and FullFill of such a loggerPromise and delegatingLogger pair have to be serialized, because the former accesses the actual logger and promise, while the latter sets and unsets them. Furthermore, a call to With{Name,Field} of such a pair returns a new pair that is attached to the parent pair by making the original promise keep a reference to the new promise. Because of that, the aforementioned serialization has to happen recursively for each pair. 
alvaroaleman force-pushed the wtf-lograce branch from 1b540b3 to 2aaa357 Compare 
| /retest |
1 similar comment
| /retest |
| Wow great find! /lgtm |
k8s-ci-robot added the lgtm This was referenced Mar 9, 2021
This was referenced Mar 15, 2021
Closed
Closed
This was referenced Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
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.
For as long as the delegating loggers Fullfill wasn't called, it holds a
loggerPromise and that loggerPromise holds the same delegating logger.
Calls to With{Name,Field} and FullFill of such a loggerPromise and
delegatingLogger pair have to be serialized, because the former accesses
the actual logger and promise, while the latter sets and unsets them.
Furthermore, a call to With{Name,Field} of such a pair returns a new
pair that is attached to the parent pair by making the original promise
keep a reference to the new promise. Because of that, the aforementioned
serialization has to happen recursively for each pair.
#1309 made this race more visible, because the defaulting of the logger controller-runtime does in the background might race with users code getting a logger (Potentially indirectly by constructing a controller).
Surprisingly, I only managed to reproduce this on tests that import controller-runtime when they take 30 seconds or more. I didn't expect the race detector to take
Sleepinto account, but apparently it does.Fixes #1337
/assign @vincepri @joelanford