longer timeout to read wsh version (2FA prompts) #1776
Conversation
WalkthroughThe pull request introduces modifications across multiple files in the remote connection and utility packages. The primary focus is on enhancing timeout handling mechanisms for reading version lines and improving context-based timeout management. A new utility function The changes affect connection-related methods in both SSH and WSL connection implementations, adjusting timeout durations for reading version lines. In the SSH connection controller, the timeout is now dynamically derived from the context, with a maximum of 30 seconds. The WSL connection implementation extends its version line reading timeout from 2 to 5 seconds. Additionally, a logging enhancement is introduced in the These modifications aim to improve timeout handling and provide more flexible connection management across different remote connection scenarios. ✨ Finishing Touches
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: 0
🧹 Nitpick comments (1)
pkg/wslconn/wslconn.go (1)
289-289: Consider using TimeoutFromContext for consistency.While increasing the timeout from 2s to 5s helps with 2FA prompts, consider using the new
TimeoutFromContextfunction for consistent timeout handling across the codebase, similar to the implementation inconncontroller.go.- versionLine, err := utilfn.ReadLineWithTimeout(linesChan, 5*time.Second) + versionLine, err := utilfn.ReadLineWithTimeout(linesChan, utilfn.TimeoutFromContext(ctx, 5*time.Second))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pkg/remote/conncontroller/conncontroller.go(1 hunks)pkg/remote/connutil.go(2 hunks)pkg/util/utilfn/utilfn.go(2 hunks)pkg/wslconn/wslconn.go(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Analyze (go)
- GitHub Check: Build for TestDriver.ai
🔇 Additional comments (5)
pkg/remote/connutil.go (2)
18-18: LGTM!The time package is required for the new timeout logging functionality.
99-102: LGTM! Enhanced logging for timeout debugging.The added logging helps in debugging timeout-related issues during WSH binary transfer, particularly useful when 2FA prompts are involved.
pkg/util/utilfn/utilfn.go (2)
8-8: LGTM!The context package is required for the new TimeoutFromContext function.
1017-1023: LGTM! Well-designed timeout utility function.The TimeoutFromContext function provides a clean abstraction for handling context-based timeouts with a fallback to default timeout. This promotes consistent timeout handling across the codebase.
pkg/remote/conncontroller/conncontroller.go (1)
312-312: LGTM! Improved timeout handling for 2FA scenarios.The change from a fixed 2s timeout to a dynamic context-based timeout with a 30s default is a good improvement that should better handle 2FA prompts. Using
TimeoutFromContextallows for flexible timeout management based on the parent context.Let's verify the impact of this timeout change on the codebase:
✅ Verification successful
Different timeouts are justified for WSL vs SSH connections
The different timeout values are intentional and correct:
- WSL connections (wslconn.go) use shorter timeouts (5s/3s) as they are local connections
- SSH connections (conncontroller.go) use longer timeouts (30s) to handle remote authentication including 2FA
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check for other fixed timeouts in version line reading echo "Checking for other fixed timeouts in version line reading..." rg -A 2 "ReadLineWithTimeout.*time\." --glob '!pkg/remote/conncontroller/conncontroller.go'Length of output: 789
Script:
#!/bin/bash # Check for 2FA related code in wslconn.go echo "Checking for 2FA related code in wslconn.go..." rg -B 2 -A 2 "2[Ff][Aa]|[Tt]wo.?[Ff]actor" pkg/wslconn/wslconn.go # Check for authentication related imports and functions echo "Checking for auth related code in wslconn.go..." ast-grep --pattern 'func $$$Auth$$$($$$) $$$'Length of output: 323
Script:
#!/bin/bash # Check how wslconn is used echo "Checking wslconn usage..." rg -B 2 -A 2 "wslconn" --type go --glob '!pkg/wslconn/**' # Check the relationship between conncontroller and wslconn echo "Checking imports..." rg -l "wslconn|conncontroller" --type go | xargs rg "import \("Length of output: 8207
No description provided.