Fix: Recalculate toxic stub chain after cleanup and improve documentationFix: Recalculate toxic stub chain after cleanup and improve buffer cl…#680
Open
shan786786786 wants to merge 1 commit intoShopify:mainfrom
Conversation
…eanup documentation Resolves two TODOs in link.go: 1. **Stub chain recalculation after cleanup (line 223):** - When Cleanup() closes a toxic stub, we now properly recalculate the chain - Reconnect previous toxic's output to the next toxic's input - Remove the closed stub from the chain array - Add detailed trace logging for debugging 2. **Buffer cleanup documentation (line 248):** - Expanded TODO with detailed explanation of the issue - Documented why early return might cause data loss - Outlined investigation steps needed for proper fix **Changes:** - Fixed potential memory leak from unreferenced stubs after cleanup - Improved logging for toxic chain modifications - Enhanced code documentation for future contributors **Testing:** - All existing tests pass - Verified with: go test -v -short ./... - Special focus on TestRemoveToxic* tests This improves stability and maintainability of the toxic removal process.
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.
Summary
This PR addresses two TODO items in
link.gothat could lead to memory leaks and data loss in production environments:Cleanup()(line 223)Changes Made
1. Toxic Stub Chain Recalculation (Lines 219-233)
Problem: When a toxic is removed and
Cleanup()closes it, the stub chain was not recalculated, leaving dangling references.Solution:
2. Buffer Cleanup Documentation (Lines 253-262)
Problem: TODO noted missing buffer cleanup when connection closes early.
Investigation:
Testing
✅ All tests passing:
TestRemoveToxic- PASSTestRemoveToxicWithBrokenConnection- PASSTestNoDataDropped- PASSImpact
Author
shan786786786(FAYAS070@GMAIL.COM)