fix: prevent data race when Kill() is called shortly after Run()#1699
Open
kimjune01 wants to merge 1 commit into
Open
fix: prevent data race when Kill() is called shortly after Run()#1699kimjune01 wants to merge 1 commit into
kimjune01 wants to merge 1 commit into
Conversation
Kill() now cancels the context instead of calling shutdown() directly. This eliminates data races on handlers, cancelReader, and renderer that occur when shutdown() reads these fields while Run() writes them during initialization. Run() detects the cancelled context, exits the event loop, and calls shutdown() from the same goroutine that initialized the fields. An early context check in Run() avoids unnecessary terminal initialization when Kill() was called first. Fixes charmbracelet#1689
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Kill()now callscancel()instead ofshutdown()directly, preventing data races onhandlers,cancelReader, andrendererwhenshutdown()reads fields thatRun()is still initializingRun()checksctx.Err()before terminal initialization, so callingKill()beforeRun()finishes returnsErrProgramKilledcleanlyTestKillDuringStartupRace(100 iterations of Kill-during-Run) to cover the fixFixes #1689
Test plan
go test -race -v ./...passes, includingTestKillDuringStartupRacechannelHandlers.shutdown()on zero-value is safe (no-op)