Add Option to Ignore SSH Config File

[oneirocosm]

This provides a new configuration option that will turn off the ssh config parsing. It also removes the flag required to override the ssh config values with internal json values

[coderabbitai]

Walkthrough

The pull request introduces changes to the SSH connection configuration handling across multiple files. The modifications primarily focus on altering how connection keywords are managed, specifically by removing the conn:overrideconfig property and introducing a new conn:ignoresshconfig property.

The changes span three key files: frontend/types/gotypes.d.ts, pkg/remote/sshclient.go, and pkg/wshrpc/wshrpctypes.go. In gotypes.d.ts, the ConnKeywords type is updated to reflect the removal of the conn:overrideconfig property and the addition of the conn:ignoresshconfig property. In sshclient.go, the ConnectToClient function is significantly modified to implement a new mechanism for retrieving SSH configuration keywords, including the addition of the findSshDefaults function for providing default SSH parameters. The wshrpctypes.go file also reflects the structural changes in the ConnKeywords struct, aligning with the updated configuration options.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f3ed7a and 3b7aaaf.

📒 Files selected for processing (1)

• pkg/remote/sshclient.go (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (go)
• GitHub Check: Build for TestDriver.ai

🔇 Additional comments (2)

pkg/remote/sshclient.go (2)

738-738: LGTM! Clean and maintainable merging logic.

The merging order correctly maintains the precedence: ssh config -> internal config -> flag keywords -> parsed keywords.

---

702-724: LGTM! Implementation aligns with the PR objective.

The changes correctly implement the option to ignore SSH config file by:

1. Checking for ConnIgnoreSshConfig flag
2. Using appropriate functions based on the flag
3. Maintaining consistent error handling

Let's verify that the ConnIgnoreSshConfig flag is properly defined in the types:

✅ Verification successful

Verification successful: ConnIgnoreSshConfig field is properly defined and consistent

The field is correctly defined as an optional boolean in both Go and TypeScript types with matching JSON tags, ensuring proper serialization and type safety across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify ConnIgnoreSshConfig field definition

# Check the field definition in Go types
rg -A 2 'ConnIgnoreSshConfig.*bool.*json:"conn:ignoresshconfig'

# Check the field definition in TypeScript types
rg -A 2 '"conn:ignoresshconfig"'

Length of output: 504

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

pkg/remote/sshclient.go (1)

923-946: Refactor findSshDefaults to eliminate code duplication

The findSshDefaults function duplicates logic from findSshConfigKeywords, such as setting default values for SSH keywords. Consider refactoring these functions to extract common logic into shared helper functions to improve maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2155ec3 and fe0a699.

📒 Files selected for processing (3)

• frontend/types/gotypes.d.ts (1 hunks)
• pkg/remote/sshclient.go (3 hunks)
• pkg/wshrpc/wshrpctypes.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (go)
• GitHub Check: Build for TestDriver.ai

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

pkg/remote/sshclient.go (1)

715-716: Enhance error messages with additional context

Consider adding more context to error messages to aid in troubleshooting. For example, in:

err = fmt.Errorf("cannot determine default config keywords: %w", err)

Include the host pattern or other relevant details:

-	err = fmt.Errorf("cannot determine default config keywords: %w", err)
+	err = fmt.Errorf("cannot determine default config keywords for host %s: %w", opts.SSHHost, err)

This provides clearer information about where and why the error occurred.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df7123d and 7f3ed7a.

📒 Files selected for processing (3)

• frontend/types/gotypes.d.ts (1 hunks)
• pkg/remote/sshclient.go (3 hunks)
• pkg/wshrpc/wshrpctypes.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• frontend/types/gotypes.d.ts
• pkg/wshrpc/wshrpctypes.go

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Build for TestDriver.ai
• GitHub Check: Analyze (go)

🔇 Additional comments (1)

pkg/remote/sshclient.go (1)

711-711: Ensure correct JSON tag and consistent usage of ConnIgnoreSshConfig

Verify that the ConnIgnoreSshConfig field in the wshrpc.ConnKeywords struct has the correct JSON tag (e.g., json:"conn:ignoresshconfig,omitempty") and that all references to this field are consistent and correctly spelled across the codebase. This ensures that configuration parsing and serialization work as intended.