//! Lazy runtime installer for the CLI binary that build.rs embedded in this //! crate (gated on the `bundled-cli` cargo feature, which is in the default //! feature set). //! //! build.rs downloads the platform's `copilot-{platform}.{tar.gz,zip}` //! archive from GitHub Releases, SHA-256 verifies it against the version //! pinned in `bundled_cli_version.txt`, and embeds the **raw archive bytes** //! into the consumer's compiled artifact via `include_bytes!()`. Extraction //! to a real on-disk path is deferred until the first call to //! [`path`] / [`install_at`] — at which point the bytes are part of the //! consumer's signed binary and trusted, so no further hashing is done. #[cfg(has_bundled_cli)] use std::fs; #[cfg(all(has_bundled_cli, not(windows)))] use std::io::Read; #[cfg(has_bundled_cli)] use std::io::{self, Write}; use std::path::{Path, PathBuf}; use std::sync::OnceLock; #[cfg(has_bundled_cli)] use tracing::{info, warn}; // When the `bundled-cli` cargo feature is enabled and the target platform is // supported, build.rs generates `bundled_cli.rs` exposing the raw archive // bytes plus the version + binary-name constants the runtime install path // consumes. #[cfg(has_bundled_cli)] mod build_time { include!(concat!(env!("OUT_DIR"), "/bundled_cli.rs")); } static INSTALLED_PATH: OnceLock> = OnceLock::new(); /// Returns the path to the installed CLI binary, lazily extracting the /// embedded archive on first call. /// /// On first call this extracts the embedded archive to /// `/github-copilot-sdk-{version}/copilot[.exe]` and /// returns the resulting path. The cache dir comes from /// [`dirs::cache_dir()`] — `%LOCALAPPDATA%` on Windows, /// `~/Library/Caches/` on macOS, `$XDG_CACHE_HOME` (or `~/.cache/`) on /// Linux. Subsequent calls return the cached result. The extraction /// is skipped when the target file already exists — the per-version /// install directory and the assumption that the consumer's binary is /// trusted mean no further hashing is needed. /// /// Returns `None` if no CLI was embedded at build time. pub(crate) fn path() -> Option { INSTALLED_PATH .get_or_init(|| { #[cfg(has_bundled_cli)] { let dir = default_install_dir(build_time::CLI_VERSION); match install(&dir, build_time::CLI_ARCHIVE) { Ok(path) => { info!(path = %path.display(), version = build_time::CLI_VERSION, "embedded CLI installed"); return Some(path); } Err(e) => { warn!(error = %e, "embedded CLI installation failed"); } } } None }) .clone() } /// Install the embedded CLI binary into the given directory instead of the /// default `/github-copilot-sdk-{version}/` location /// (see [`path`] for the per-platform mapping). /// /// Idempotent: skips extraction if the target binary already exists. /// Returns `None` when the SDK was built without a bundled CLI. #[allow(dead_code)] // Used by resolve.rs when ClientOptions::bundled_cli_extract_dir is set. pub(crate) fn install_at(extract_dir: &Path) -> Option { #[cfg(has_bundled_cli)] { match install(extract_dir, build_time::CLI_ARCHIVE) { Ok(path) => { info!(path = %path.display(), version = build_time::CLI_VERSION, "embedded CLI installed"); return Some(path); } Err(e) => { warn!(error = %e, "embedded CLI installation failed"); } } } #[cfg(not(has_bundled_cli))] { let _ = extract_dir; } None } #[cfg(has_bundled_cli)] fn default_install_dir(version: &str) -> PathBuf { let cache = dirs::cache_dir().unwrap_or_else(std::env::temp_dir); if version.is_empty() { cache.join("github-copilot-sdk") } else { cache.join(format!("github-copilot-sdk-{}", sanitize_version(version))) } } #[cfg(has_bundled_cli)] fn install(install_dir: &Path, archive: &[u8]) -> Result { let verbose = std::env::var("COPILOT_CLI_INSTALL_VERBOSE").ok().as_deref() == Some("1"); fs::create_dir_all(install_dir).map_err(EmbeddedCliError::CreateDir)?; let final_path = install_dir.join(build_time::CLI_BINARY_NAME); // Per-version install dir means a present file at this path is the // binary we want — no need to hash-verify the bytes are unchanged. if final_path.is_file() { if verbose { eprintln!("embedded CLI already installed at {}", final_path.display()); } return Ok(final_path); } let start = std::time::Instant::now(); let bytes = extract_binary(archive, build_time::CLI_BINARY_NAME)?; write_binary(&final_path, &bytes)?; if verbose { eprintln!( "embedded CLI extracted to {} in {:?}", final_path.display(), start.elapsed() ); } Ok(final_path) } #[cfg(all(has_bundled_cli, not(windows)))] fn extract_binary(archive: &[u8], binary_name: &str) -> Result, EmbeddedCliError> { let gz = flate2::read::GzDecoder::new(archive); let mut tar = tar::Archive::new(gz); for entry in tar.entries().map_err(EmbeddedCliError::Archive)? { let mut entry = entry.map_err(EmbeddedCliError::Archive)?; let path = entry.path().map_err(EmbeddedCliError::Archive)?; let name = path.to_string_lossy(); if name == binary_name || name.ends_with(&format!("/{binary_name}")) { let mut bytes = Vec::with_capacity(entry.size() as usize); entry .read_to_end(&mut bytes) .map_err(EmbeddedCliError::Archive)?; return Ok(bytes); } } Err(EmbeddedCliError::BinaryNotFoundInArchive) } #[cfg(all(has_bundled_cli, windows))] fn extract_binary(archive: &[u8], binary_name: &str) -> Result, EmbeddedCliError> { let cursor = std::io::Cursor::new(archive); let mut zip = zip::ZipArchive::new(cursor).map_err(EmbeddedCliError::Zip)?; for i in 0..zip.len() { let mut entry = zip.by_index(i).map_err(EmbeddedCliError::Zip)?; let name = entry.name().to_string(); if name == binary_name || name.ends_with(&format!("/{binary_name}")) { let mut bytes = Vec::with_capacity(entry.size() as usize); std::io::copy(&mut entry, &mut bytes).map_err(EmbeddedCliError::Io)?; return Ok(bytes); } } Err(EmbeddedCliError::BinaryNotFoundInArchive) } #[cfg(has_bundled_cli)] fn sanitize_version(version: &str) -> String { version .chars() .map(|c| match c { 'a'..='z' | 'A'..='Z' | '0'..='9' | '.' | '-' | '_' => c, _ => '_', }) .collect() } #[cfg(has_bundled_cli)] fn write_binary(path: &Path, data: &[u8]) -> Result<(), EmbeddedCliError> { let mut file = fs::OpenOptions::new() .write(true) .create(true) .truncate(true) .open(path) .map_err(EmbeddedCliError::Io)?; file.write_all(data).map_err(EmbeddedCliError::Io)?; #[cfg(unix)] { use std::os::unix::fs::PermissionsExt; fs::set_permissions(path, fs::Permissions::from_mode(0o755)) .map_err(EmbeddedCliError::Io)?; } Ok(()) } #[cfg(has_bundled_cli)] #[derive(Debug, thiserror::Error)] #[allow(dead_code)] enum EmbeddedCliError { #[error("failed to create install directory: {0}")] CreateDir(io::Error), #[cfg(not(windows))] #[error("failed to read archive entry: {0}")] Archive(io::Error), #[cfg(windows)] #[error("failed to read zip archive: {0}")] Zip(zip::result::ZipError), #[error("CLI binary not found in embedded archive")] BinaryNotFoundInArchive, #[error("I/O error: {0}")] Io(io::Error), }