Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: more robust processor checks #1656

Merged
merged 1 commit into from
Dec 31, 2024
Merged

fix: more robust processor checks #1656

merged 1 commit into from
Dec 31, 2024

Conversation

oneirocosm
Copy link
Member

This ensures invalid architectures cannot have wsh installed. This includes validating the output of uname -m and PROCESSOR_ARCHITECTURE

This ensures invalid architectures cannot have wsh installed.
Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Walkthrough

The pull request introduces changes across multiple files related to handling SSH command outputs and architecture detection. The primary modifications involve updating the methods GetClientOs and GetClientArch in both pkg/remote/connutil.go and pkg/wsl/wsl-util.go to use CombinedOutput() instead of Output(), which allows capturing both standard output and standard error.

A new utility function FilterValidArch is added to pkg/util/utilfn/utilfn.go, which standardizes and validates architecture strings. This function helps normalize architecture names like "x86_64", "x64", and "arm64" to consistent representations. The changes aim to improve error handling and provide a more robust method for detecting and processing system architectures across different environments.

The modifications introduce a new import for the utilfn package and update the command execution and architecture detection logic to leverage the new utility function for more consistent results.

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pkg/util/utilfn/utilfn.go (1)

967-984: Consider additional 32-bit architectures.
This function validates known 64-bit patterns but omits potential 32-bit (e.g. i386) or arm variants. If you intentionally restrict to x64 and arm64, this is fine. Otherwise, consider broader coverage or user feedback on failure.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a1f26ba and e852631.

📒 Files selected for processing (3)
  • pkg/remote/connutil.go (3 hunks)
  • pkg/util/utilfn/utilfn.go (1 hunks)
  • pkg/wsl/wsl-util.go (3 hunks)
🔇 Additional comments (10)
pkg/remote/connutil.go (5)

19-19: New utility import looks good.
The addition of this import for utilfn is clear and will support the new architecture filtering functionality.


149-149: Capturing both stdout & stderr is a good improvement.
Switching to CombinedOutput ensures better context for diagnosing errors and parsing command results.


188-190: Architecture detection updated with error handling.
Using CombinedOutput plus utilfn.FilterValidArch will improve the robustness of architecture validation on Unix.


198-200: Consistent architecture checking for Windows CMD.
Filtering the architecture string after confirming it is not a literal environment variable leads to more robust checks.


208-210: PowerShell architecture detection is consolidated as well.
The same pattern of capturing combined output and validating ensures consistent architecture handling. Great job.

pkg/wsl/wsl-util.go (5)

20-20: New import for architecture filtering.
Using utilfn will streamline validation logic here.


100-100: Use of CombinedOutput improves OS detection logs.
This matches the updated approach: capturing stderr can help diagnose issues.


129-129: Leveraging FilterValidArch effectively.
This ensures your uname -m output is normalized and validated.


133-135: CombinedOutput usage for Windows CMD environment variable.
Retaining the guard against literal placeholders ensures accurate architecture detection.


139-141: PowerShell architecture handling is similarly reinforced.
Aligning this with the same robust checks is consistent and reliable.

@oneirocosm oneirocosm merged commit 2590ad0 into main Dec 31, 2024
8 checks passed
@oneirocosm oneirocosm deleted the sylvie/ssh-uname-fix branch December 31, 2024 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant