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

Add ZDOTDIR after JWT token for WSL commands #1546

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Add ZDOTDIR after JWT token for WSL commands #1546

merged 1 commit into from
Dec 17, 2024

Conversation

esimkowitz
Copy link
Member

@esimkowitz esimkowitz commented Dec 17, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced support for Zsh shell integration with specific environment variable settings.
  • Bug Fixes

    • Improved error handling for JWT token retrieval.
  • Documentation

    • Clarified logging statements related to detected shell types.

Copy link

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request introduces modifications to the pkg/shellexec/shellexec.go file, specifically enhancing the shell process initialization logic. The changes focus on improving Zsh shell integration by adding a conditional block that sets the ZDOTDIR environment variable when a Zsh shell is detected. This modification ensures proper configuration of the Zsh integration directory during shell process startup, while maintaining the existing error handling and command construction mechanisms.

Changes

File Change Summary
pkg/shellexec/shellexec.go - Added conditional Zsh shell detection
- Introduced ZDOTDIR environment variable setting for Zsh
- Refined logging statements for shell type detection

Poem

🐰 A Zsh Shell Hop, A Rabbit's Delight! 🐰

In code's green warren, a new path takes flight,
Zsh config dancing with environmental might,
ZDOTDIR whispers, a configuration so bright,
Our shell now leaps with newfound insight,
A CodeRabbit's magic, making systems just right!

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.


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

@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/shellexec/shellexec.go (1)

Line range hint 484-488: Consider more precise shell detection

The current implementation using strings.Contains might have edge cases with similarly named shells. Consider using more precise matching:

func isZshShell(shellPath string) bool {
    shellBase := filepath.Base(shellPath)
-   return strings.Contains(shellBase, "zsh")
+   // Match exact names or common variants
+   return shellBase == "zsh" || shellBase == "zsh-static" || strings.HasPrefix(shellBase, "zsh-")
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f5305cc and f7d8862.

📒 Files selected for processing (1)
  • pkg/shellexec/shellexec.go (1 hunks)
🔇 Additional comments (2)
pkg/shellexec/shellexec.go (2)

Line range hint 397-399: LGTM! Consistent implementation with WSL shell handling

The ZDOTDIR setting follows the same pattern as the WSL implementation, maintaining consistency across different shell environments.


216-219: Verify path handling for WSL environments

While the ZDOTDIR setting is correctly placed after the JWT token, we should ensure proper handling of paths containing spaces in WSL environments.

Let's verify the path handling in similar WSL commands:

✅ Verification successful

Based on the gathered evidence, I can now provide a final response:

ZDOTDIR path handling is secure in WSL environment

The implementation is safe for paths with spaces because:

  1. WSL's GetHomeDir properly handles path retrieval using echo "$HOME" with proper quoting
  2. The ZDOTDIR environment variable is set using fmt.Sprintf with proper quoting: ZDOTDIR="%s/.waveterm/%s"
  3. The path construction follows the same pattern used throughout the codebase for other shell integrations
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for similar path handling patterns in WSL commands
rg -A 2 'wsl\.exe.*--.*homeDir.*"' 

# Search for existing ZDOTDIR usage patterns
rg 'ZDOTDIR.*=.*".*"'

Length of output: 337


Script:

#!/bin/bash
# Let's check how WSL paths are handled in the codebase
rg -A 5 'wsl\.exe.*--.*' 

# Check how homeDir is processed before being used in WSL context
ast-grep --pattern 'homeDir := $$$'

Length of output: 321


Script:

#!/bin/bash
# Let's check how WSL's GetHomeDir handles path processing
ast-grep --pattern 'func GetHomeDir($$$) {
  $$$
}'

# Check for any path escaping or sanitization utilities
rg -A 3 'func.*Path|func.*Escape'

Length of output: 14965


Script:

#!/bin/bash
# Let's check the WSL GetHomeDir implementation and path handling
ast-grep --pattern 'func (client *Distro) WslCommand($$$) string'

# Check how homeDir is used in WSL context
rg -A 5 'wsl\.GetHomeDir'

Length of output: 411


Script:

#!/bin/bash
# Let's check the implementation of wsl.GetHomeDir
rg -A 10 'func GetHomeDir.*Context.*Distro'

# Check for any WSL-specific path transformations
rg -A 5 'wsl.*path|path.*wsl' -i

Length of output: 3532

@sawka sawka merged commit 799aecd into main Dec 17, 2024
7 of 8 checks passed
@sawka sawka deleted the evan/wsl-zsh branch December 17, 2024 21:00
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.

2 participants