-
Notifications
You must be signed in to change notification settings - Fork 489
feat(transport): add which_command for cross-platform executable resolution #774
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
Open
kakarot-dev
wants to merge
1
commit into
modelcontextprotocol:main
Choose a base branch
from
kakarot-dev:feat/which-command
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+53
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -233,6 +233,54 @@ impl ConfigureCommandExt for tokio::process::Command { | |||||
| } | ||||||
| } | ||||||
|
|
||||||
| /// Resolve the absolute path to an executable using the system `PATH`, | ||||||
| /// then return a [`tokio::process::Command`] pointing at it. | ||||||
| /// | ||||||
| /// This is especially useful on Windows where `.cmd` / `.exe` shim scripts | ||||||
| /// (e.g. `npx.cmd`) are not reliably found by [`tokio::process::Command`] | ||||||
| /// without a fully-qualified path. | ||||||
| /// | ||||||
| /// # Example | ||||||
| /// ```rust,no_run | ||||||
| /// use rmcp::transport::child_process::{which_command, ConfigureCommandExt}; | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are re-exported.
Suggested change
|
||||||
| /// | ||||||
| /// # fn example() -> std::io::Result<()> { | ||||||
| /// let cmd = which_command("npx")? | ||||||
| /// .configure(|cmd| { | ||||||
| /// cmd.arg("-y").arg("@modelcontextprotocol/server-everything"); | ||||||
| /// }); | ||||||
| /// # Ok(()) | ||||||
| /// # } | ||||||
| /// ``` | ||||||
| pub fn which_command( | ||||||
| name: impl AsRef<std::ffi::OsStr>, | ||||||
| ) -> std::io::Result<tokio::process::Command> { | ||||||
| let resolved = which::which(name.as_ref()) | ||||||
| .map_err(|e| std::io::Error::new(std::io::ErrorKind::NotFound, e))?; | ||||||
| Ok(tokio::process::Command::new(resolved)) | ||||||
| } | ||||||
|
|
||||||
| #[cfg(test)] | ||||||
| mod tests_which { | ||||||
| #[test] | ||||||
| fn which_command_resolves_known_binary() { | ||||||
| // `ls` exists on every Unix system, `cmd` on Windows | ||||||
| #[cfg(unix)] | ||||||
| let result = super::which_command("ls"); | ||||||
| #[cfg(windows)] | ||||||
| let result = super::which_command("cmd"); | ||||||
|
|
||||||
| assert!(result.is_ok()); | ||||||
| } | ||||||
|
|
||||||
| #[test] | ||||||
| fn which_command_fails_for_nonexistent() { | ||||||
| let result = super::which_command("this_binary_definitely_does_not_exist_12345"); | ||||||
| assert!(result.is_err()); | ||||||
| assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::NotFound); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| #[cfg(unix)] | ||||||
| #[cfg(test)] | ||||||
| mod tests { | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
whichcrate is now included for everyone usingtransport-child-process, even on Linux and macOS whereCommand::newalready resolvesPATHcorrectly. Since this is a library crate, it might be a good idea to make it a separate feature flag so users can opt in explicitly.