fix(upgrade): add sleep to allow event to flush before panic (backport #3234) #3244
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.
Which issue(s) this PR fixes:
Issue longhorn/longhorn#9569
What this PR does / why we need it:
Add a sleep after Run() before panicking to let the queued event get flushed. We thought that eventBroadcaster.Shutdown() would take care of that, and it did in some testing, but there is still a race and it does not work reliably. QA found that while testing the feature and I did reproduce it - see the note in longhorn/longhorn#9569 (comment)
Special notes for your reviewer:
This is the simplest fix. We could do something more complicated, like calling Watch() on the events and waiting for it to appear, but there is no need to speed up the exit as soon as possible. The upgrade will not go forward anyway. The important thing is to guarantee the event can be found so the problem can be corrected.
Additional documentation or context
This is an automatic backport of pull request #3234 done by [Mergify](https://mergify.com).