Set OutputStream.delegate to nil in HTTPBodyOutputStreamBridge.deinit#46
Merged
simonjbeaumont merged 1 commit intoapple:mainfrom Jan 16, 2024
Conversation
When running the cancellation tests in a loop, very occasionally there would be a crash with the following backtrace: ``` ``` This seems to indicate that the output stream is trying to access its delegate. However, when running with debug logging enabled I can see that the delegate has already been deinitialized. This is likely a result of the delegate itself owning the stream and setting the stream delegate to `self`, which IIUC is an established pattern. This presents a race in teardown. This patch sets the output stream delegate to `nil` in the delegate `deinit`. With this patch, the failing test passes when run an order of magnitude more times than were required to reliably reproduce the crash without the patch.
czechboy0
approved these changes
Jan 16, 2024
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
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.
Motivation
When running the cancellation tests in a loop, very occasionally there would be a crash with the following backtrace:
This seems to indicate that the output stream is trying to access its delegate. However, when running with debug logging enabled I can see that the delegate has already been deinitialized.
This is likely a result of the delegate itself owning the stream and setting the stream delegate to
self, which IIUC is an established pattern. This presents a race in teardown.Modifications
This patch sets the output stream delegate to
nilin the delegatedeinit.Result
No attempts to call the delegate will happen after it is has been deinitailzed.
Test Plan
With this patch, the failing test passes when run an order of magnitude more times than were required to reliably reproduce the crash without the patch.