Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Newest first. `Unreleased` is what is on `main` and not yet tagged.

## Unreleased

### Desktop startup repairs stale Bun and finds Docker credential helpers

If a Bun executable is already on PATH but is not the pinned runtime OpenBot supports, Desktop now
leaves that user installation untouched and uses OpenBot's verified runtime instead. When Docker is
resolved from its installed location but the GUI process PATH cannot see the credential helper beside
it, child Docker commands now include Docker's own directory without changing the person's Docker
credential configuration or OpenBot's managed Compose-provider precedence.

### Desktop refuses to replace the key of a retained database

A reinstall can remove the deployment folder's local markers while Docker or Podman keeps the
Expand Down
150 changes: 143 additions & 7 deletions desktop/src-tauri/src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -221,11 +221,8 @@ impl Address {
/// because that file belongs to whoever else may have configured it.
pub fn command(&self) -> Command {
let (binary, arguments) = self.parts();
let mut command = command(binary);
let mut command = command_at(self.engine, &binary);
command.args(arguments);
if let Some(dir) = tools_dir() {
command.env("PATH", path_with(dir));
}
command
}

Expand Down Expand Up @@ -329,9 +326,49 @@ fn tools_dir() -> Option<&'static PathBuf> {

/// A command that runs this engine's binary, wherever it actually is.
pub fn tool(engine: Engine) -> Command {
let mut built = command(program(engine).unwrap_or_else(|| PathBuf::from(engine.binary())));
if let Some(dir) = tools_dir() {
built.env("PATH", path_with(dir));
command_at(
engine,
&program(engine).unwrap_or_else(|| PathBuf::from(engine.binary())),
)
}

fn command_at(engine: Engine, binary: &Path) -> Command {
let mut built = command(binary);
let mut path = tools_dir()
.map(|dir| path_with(dir))
.or_else(|| std::env::var_os("PATH"));

if engine == Engine::Docker && binary.is_absolute() {
// Desktop may resolve Docker from an installation directory even when the GUI process PATH
// cannot find Docker's configured credential helper. Keep the person's existing helper
// preference and OpenBot's Compose-provider precedence; only make Docker's own directory
// discoverable to the child.
let resolved = std::fs::canonicalize(binary).ok();
for directory in [binary.parent(), resolved.as_deref().and_then(Path::parent)]
.into_iter()
.flatten()
{
let existing: Vec<_> = path
.as_deref()
.map(std::env::split_paths)
.into_iter()
.flatten()
.collect();
if existing.iter().any(|entry| entry == directory) {
continue;
}
if let Ok(expanded) = std::env::join_paths(
existing
.into_iter()
.chain(std::iter::once(directory.to_path_buf())),
) {
path = Some(expanded);
}
}
}

if let Some(path) = path {
built.env("PATH", path);
}
built
}
Expand Down Expand Up @@ -528,6 +565,105 @@ fn socket_override(engine: Engine) -> Option<String> {
mod tests {
use super::*;

#[test]
fn docker_credential_helper_is_found_beside_resolved_cli_without_changing_config() {
if crate::test_support::isolated_process(
"engine::tests::docker_credential_helper_is_found_beside_resolved_cli_without_changing_config",
) {
return;
}
let root = crate::test_support::temp_root("docker credential helper path");
let bin = root.join("Docker application/bin");
std::fs::create_dir_all(&bin).unwrap();
let source = root.join("fixture.rs");
let docker = bin.join(format!("docker{}", std::env::consts::EXE_SUFFIX));
let helper = bin.join(format!(
"docker-credential-desktop{}",
std::env::consts::EXE_SUFFIX
));
std::fs::write(
&source,
r#"
fn main() {
if std::env::current_exe().unwrap().file_stem().unwrap() == "docker-credential-desktop" {
println!("configured helper used");
return;
}
let filename = format!("docker-credential-desktop{}", std::env::consts::EXE_SUFFIX);
let path = std::env::split_paths(&std::env::var_os("PATH").unwrap_or_default())
.map(|directory| directory.join(&filename))
.find(|path| path.is_file());
let Some(path) = path else {
eprintln!("docker-credential-desktop: executable file not found in PATH");
std::process::exit(41);
};
let output = std::process::Command::new(path).arg("get").output().unwrap();
assert!(output.status.success());
print!("{}", String::from_utf8(output.stdout).unwrap());
}
"#,
)
.unwrap();
crate::test_support::compile_fixture(&source, &docker);
std::fs::copy(&docker, &helper).unwrap();
let config = root.join("config.json");
let original = br#"{"credsStore":"desktop","credHelpers":{"private.example":"custom"}}"#;
std::fs::write(&config, original).unwrap();
std::env::set_var("PATH", root.join("gui-path-without-docker"));
let output = command_at(Engine::Docker, &docker)
.env("DOCKER_CONFIG", &root)
.output()
.unwrap();
assert!(
output.status.success(),
"{}",
String::from_utf8_lossy(&output.stderr)
);
assert_eq!(output.stdout, b"configured helper used\n");
assert_eq!(std::fs::read(config).unwrap(), original);
std::fs::remove_dir_all(root).unwrap();
}

#[cfg(unix)]
#[test]
fn docker_symlink_adds_target_helpers_after_inherited_paths_and_managed_compose() {
if crate::test_support::isolated_process(
"engine::tests::docker_symlink_adds_target_helpers_after_inherited_paths_and_managed_compose",
) {
return;
}
let root = crate::test_support::temp_root("docker symlink helper path");
let target = root.join("Docker.app/Contents/Resources/bin");
let links = root.join("usr/local/bin");
for directory in [&target, &links] {
std::fs::create_dir_all(directory).unwrap();
}
std::fs::write(target.join("docker"), "fixture").unwrap();
std::os::unix::fs::symlink(target.join("docker"), links.join("docker")).unwrap();
let inherited = root.join("custom-helpers");
let managed = root.join("managed-compose");
std::env::set_var("PATH", &inherited);
tools_live_in(managed.clone());
let command = command_at(Engine::Docker, &links.join("docker"));
let path = command
.get_envs()
.find(|(key, _)| *key == "PATH")
.unwrap()
.1
.unwrap();
let directories: Vec<_> = std::env::split_paths(path).collect();
assert_eq!(
directories,
[
managed,
inherited,
links,
std::fs::canonicalize(target).unwrap()
]
);
std::fs::remove_dir_all(root).unwrap();
}

#[test]
fn runtime_selectors_keep_the_existing_status_wire_shape() {
let mut address = Address::new(Engine::Docker, None);
Expand Down
45 changes: 41 additions & 4 deletions desktop/src-tauri/src/install.rs
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ fn ensure_bun_with(
install: impl FnOnce() -> Result<PathBuf, Problem>,
) -> Result<PathBuf, Problem> {
match existing {
Some(path) => Ok(path),
None => install(),
Some(path) if verify_bun(&path).is_ok() => Ok(path),
_ => install(),
}
}

Expand Down Expand Up @@ -344,7 +344,6 @@ fn extract_bun(archive: &Path, target: &Path, entry: &str) -> Result<(), Problem
Ok(())
}

#[cfg(any(windows, target_os = "macos"))]
fn verify_bun(binary: &Path) -> Result<(), Problem> {
let output = crate::quiet::command(binary)
.arg("--version")
Expand Down Expand Up @@ -962,13 +961,51 @@ mod tests {
let _ = std::fs::remove_dir_all(dir);
}

fn runtime_version_fixture(root: &Path, version: &str) -> PathBuf {
std::fs::create_dir_all(root).unwrap();
let source = root.join("runtime.rs");
std::fs::write(
&source,
format!(
"fn main() {{ assert_eq!(std::env::args().nth(1).as_deref(), Some(\"--version\")); println!({version:?}); }}"
),
)
.unwrap();
let binary = root.join(format!("bun{}", std::env::consts::EXE_SUFFIX));
crate::test_support::compile_fixture(&source, &binary);
binary
}

#[test]
fn an_existing_bun_does_not_trigger_installation() {
let existing = PathBuf::from("existing user runtime/bun.exe");
let root = temp_root("existing-pinned-bun");
let existing = runtime_version_fixture(&root, BUN);
assert_eq!(
ensure_bun_with(Some(existing.clone()), || panic!("already installed")).unwrap(),
existing
);
std::fs::remove_dir_all(root).unwrap();
}

#[test]
fn unsupported_existing_bun_acquires_pinned_runtime_without_changing_user_binary() {
let root = temp_root("unsupported-existing-bun");
let existing = runtime_version_fixture(&root.join("user"), "1.2.15");
let pinned = runtime_version_fixture(&root.join("openbot"), BUN);
let before = std::fs::read(&existing).unwrap();

let chosen = ensure_bun_with(Some(existing.clone()), || Ok(pinned.clone())).unwrap();

assert_eq!(
chosen, pinned,
"an incompatible user runtime must not be selected"
);
assert_eq!(
std::fs::read(existing).unwrap(),
before,
"the user's runtime is untouched"
);
std::fs::remove_dir_all(root).unwrap();
}

#[test]
Expand Down
Loading