fix(sdk): tolerate closed tunnel writers - #1099
Open
G4614 wants to merge 7 commits into
Open
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe Node and Python SDKs centralize stream cleanup. Their ChangesSDK shutdown handling
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
G4614
force-pushed
the
g4614/fix-idempotent-tunnel-close
branch
from
July 31, 2026 03:38
1108ec7 to
fe56bad
Compare
G4614
marked this pull request as ready for review
July 31, 2026 03:42
📦 BoxLite review — looks good ·
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@sdks/node/src/network.rs`:
- Around line 126-134: Document both public close contracts: in
sdks/node/src/network.rs:126-134, update the public close API documentation to
state that NotConnected is treated as successful while other shutdown errors
fail; in sdks/python/src/network.rs:156-164, document the same shutdown behavior
and that reader cleanup completes successfully.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: fec5af33-df29-47d6-934c-18af2a1fb9fa
📒 Files selected for processing (2)
sdks/node/src/network.rssdks/python/src/network.rs
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@sdks/python/src/network.rs`:
- Around line 21-27: Update the shutdown flow around stream.shutdown().await to
store its result instead of returning immediately for non-NotConnected errors,
always execute reader.lock().await.take() after the writer is removed, then
return the stored shutdown result while preserving the existing NotConnected
handling.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 2a1294cf-a8d0-4be2-9288-e4d13473283f
📒 Files selected for processing (2)
sdks/node/src/network.rssdks/python/src/network.rs
🚧 Files skipped from review as they are similar to previous changes (1)
- sdks/node/src/network.rs
![boxlite-agent[bot]](https://avatars.githubusercontent.com/in/4244458?s=60&v=4){kind=small}
Comment on lines
+19
to
+28
| let mut writer = writer.lock().await; | ||
| if let Some(mut stream) = writer.take() { | ||
| match stream.shutdown().await { | ||
| Ok(()) => {} | ||
| Err(error) if error.kind() == std::io::ErrorKind::NotConnected => {} | ||
| Err(error) => return Err(error), | ||
| } | ||
| } | ||
| reader.lock().await.take(); | ||
| Ok(()) |
There was a problem hiding this comment.
🛑 Node close_streams leaks reader on shutdown error
return Err(error) at line 24 exits before reader.lock().await.take() at line 27 runs, so a non-NotConnected shutdown error leaves the reader un-cleared, unlike python's just-fixed version (a3e637d) of the identical function
Suggested change
| let mut writer = writer.lock().await; | |
| if let Some(mut stream) = writer.take() { | |
| match stream.shutdown().await { | |
| Ok(()) => {} | |
| Err(error) if error.kind() == std::io::ErrorKind::NotConnected => {} | |
| Err(error) => return Err(error), | |
| } | |
| } | |
| reader.lock().await.take(); | |
| Ok(()) | |
| async fn close_streams( | |
| reader: &tokio::sync::Mutex<Option<ConnectionReader>>, | |
| writer: &tokio::sync::Mutex<Option<ConnectionWriter>>, | |
| ) -> std::io::Result<()> { | |
| let mut writer = writer.lock().await; | |
| let shutdown_result = if let Some(mut stream) = writer.take() { | |
| match stream.shutdown().await { | |
| Ok(()) => Ok(()), | |
| Err(error) if error.kind() == std::io::ErrorKind::NotConnected => Ok(()), | |
| Err(error) => Err(error), | |
| } | |
| } else { | |
| Ok(()) | |
| }; | |
| reader.lock().await.take(); | |
| shutdown_result | |
| } |
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.
Treat an already disconnected tunnel writer as successfully closed in the Python and Node SDKs.
Test plan:
Summary by CodeRabbit