-
Notifications
You must be signed in to change notification settings - Fork 23
Validate R_HOME path early and surface env discovery failures #999
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
|
|
@@ -10,6 +10,8 @@ use std::path::PathBuf; | |
| use std::process::Command; | ||
| use std::process::Output; | ||
|
|
||
| use anyhow::anyhow; | ||
|
|
||
| use crate::sys::command::COMMAND_R_NAMES; | ||
|
|
||
| /// Execute a `Command` for R, trying multiple names for the R executable | ||
|
|
@@ -41,28 +43,49 @@ where | |
| } | ||
|
|
||
| /// Use this before calling `r_command()` to ensure that `R_HOME` is set consistently | ||
| pub fn r_home_setup() -> PathBuf { | ||
| match std::env::var("R_HOME") { | ||
| pub fn r_home_setup() -> anyhow::Result<PathBuf> { | ||
| // Determine candidate path and the string form to set (we will overwrite | ||
| // R_HOME in the environment after validation, even if it was already set). | ||
| let home = match std::env::var("R_HOME") { | ||
| Ok(home) => { | ||
| // Get `R_HOME` from env var, typically set by Positron / CI / kernel specification | ||
| PathBuf::from(home) | ||
| home.clone() | ||
| }, | ||
|
|
||
| Err(_) => { | ||
| // Get `R_HOME` from `PATH`, via `R` | ||
| let Ok(result) = r_command_from_path(|command| { | ||
| let result = r_command_from_path(|command| { | ||
| command.arg("RHOME"); | ||
| }) else { | ||
| panic!("Can't find R or `R_HOME`"); | ||
| }; | ||
| }) | ||
| .map_err(|err| anyhow!("Can't find R or `R_HOME`: {err}"))?; | ||
|
|
||
| let r_home = String::from_utf8(result.stdout).unwrap(); | ||
| let r_home = r_home.trim(); | ||
| let home = String::from_utf8(result.stdout) | ||
| .map_err(|err| anyhow!("Invalid UTF-8 from R RHOME output: {err}"))?; | ||
| home.trim().to_string() | ||
| }, | ||
| }; | ||
|
|
||
| let path = PathBuf::from(home.clone()); | ||
| match path.try_exists() { | ||
| Ok(true) => { | ||
| // Ensure `R_HOME` is set in the environment after validation. From | ||
| // now on, `r_command()` can be used to run exactly the same R as is | ||
| // running in Ark. | ||
| unsafe { std::env::set_var("R_HOME", &home) }; | ||
|
|
||
| // Check that `R` can be called | ||
|
Contributor
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. We're now also checking that R can be called |
||
| r_command(|command| { | ||
| command.arg("RHOME"); | ||
| }) | ||
| .map_err(|err| anyhow!("Can't run R: {err}"))?; | ||
|
|
||
| // Now set `R_HOME`. From now on, `r_command()` can be used to | ||
| // run exactly the same R as is running in Ark. | ||
| unsafe { std::env::set_var("R_HOME", r_home) }; | ||
| PathBuf::from(r_home) | ||
| Ok(path) | ||
| }, | ||
| Ok(false) => Err(anyhow!( | ||
| "The `R_HOME` path '{}' does not exist.", | ||
| path.display() | ||
| )), | ||
| Err(err) => Err(anyhow!("Can't check if `R_HOME` path exists: {err}")), | ||
| } | ||
| } | ||
|
|
||
|
|
||
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.
So IIUC all this does is handle the error path of
r_command()better, rather than just ignoring it. That seems nice