Disable Wsh on Remotes where the Domain Socket Listener Fails #1542
Conversation
This moves the domain socket listener call to an area of the code where it is allowed to fail once before attempting to run without wsh as a backup.
WalkthroughThe changes in the Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (1)
pkg/remote/conncontroller/conncontroller.go (1)
543-553: Enhance error handling and messagingThe error handling could be improved for better clarity and maintainability:
- Store specific error messages for domain socket and conn server failures
- Simplify the error condition check
dsErr := conn.OpenDomainSocketListener() var csErr error if dsErr != nil { - log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), err) + log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), dsErr) } else { csErr = conn.StartConnServer() if csErr != nil { log.Printf("error: unable to start conn server for %s: %v\n", conn.GetName(), csErr) } } - if dsErr != nil || csErr != nil { + if failed := dsErr != nil || csErr != nil; failed { log.Print("attempting to run with nowsh instead") conn.WithLock(func() { - conn.WshError = csErr.Error() + if dsErr != nil { + conn.WshError = fmt.Sprintf("domain socket error: %v", dsErr) + } else { + conn.WshError = fmt.Sprintf("connection server error: %v", csErr) + } }) conn.WshEnabled.Store(false) }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pkg/remote/conncontroller/conncontroller.go(1 hunks)
🔇 Additional comments (1)
pkg/remote/conncontroller/conncontroller.go (1)
543-553: Verify error handling aligns with PR objectives
The changes align with the PR objectives by allowing the system to fall back to running without wsh when the domain socket listener fails. This enhances the robustness of the connection setup process.
Let's verify the error handling behavior:
✅ Verification successful
Let me gather more context about the error handling patterns in the codebase.
Based on the gathered context, I can now generate the final response:
Error handling for domain socket listener aligns with fallback strategy
The error handling implementation correctly follows the system's fallback strategy:
- When domain socket listener fails (
dsErr), it logs the error and attempts to continue - If connection server fails (
csErr), it properly setsWshErrorand disables WSH viaWshEnabled.Store(false) - The system maintains a consistent pattern of falling back to non-WSH mode when encountering errors, as evidenced by similar patterns elsewhere in the codebase
- Error states are properly tracked using atomic operations and thread-safe mechanisms
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for consistent error handling patterns in similar scenarios
# Look for similar fallback patterns in the codebase
rg -A 5 "attempting to run with nowsh instead"
# Check for other domain socket listener error handling
ast-grep --pattern 'OpenDomainSocketListener($$$)'
Length of output: 960
Script:
#!/bin/bash
# Check the broader context of the error handling in conncontroller.go
rg -B 5 -A 10 "OpenDomainSocketListener\(\)" pkg/remote/conncontroller/conncontroller.go
# Look for WshEnabled and WshError usage patterns
rg "WshEnabled|WshError" pkg/remote/conncontroller/conncontroller.go
# Check for any other domain socket related error handling
rg -A 3 "domain socket" pkg/remote/conncontroller/conncontroller.go
Length of output: 2447
| dsErr := conn.OpenDomainSocketListener() | ||
| var csErr error | ||
| if dsErr != nil { | ||
| log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), err) |
There was a problem hiding this comment.
Fix incorrect error variable in log message
The log message uses the wrong error variable. It should use dsErr instead of err.
- log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), err)
+ log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), dsErr)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), err) | |
| log.Printf("error: unable to open domain socket listener for %s: %v\n", conn.GetName(), dsErr) |
A recent change meant that if certain operations for setting up wsh failed, a fallback would be employed to launch the terminal without the wsh connection. This adds the domain socket listener to the list of things that are allowed to fail before retrying without wsh instead of failing outright.
Summary by CodeRabbit
New Features
Bug Fixes