-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
feat: turbo info
command for debugging
#9368
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -22,8 +22,8 @@ use turborepo_ui::{ColorConfig, GREY}; | |||||||||||
use crate::{ | ||||||||||||
cli::error::print_potential_tasks, | ||||||||||||
commands::{ | ||||||||||||
bin, config, daemon, generate, link, login, logout, ls, prune, query, run, scan, telemetry, | ||||||||||||
unlink, CommandBase, | ||||||||||||
bin, config, daemon, generate, info, link, login, logout, ls, prune, query, run, scan, | ||||||||||||
telemetry, unlink, CommandBase, | ||||||||||||
}, | ||||||||||||
get_version, | ||||||||||||
run::watch::WatchClient, | ||||||||||||
|
@@ -475,9 +475,7 @@ impl Args { | |||||||||||
} | ||||||||||||
} | ||||||||||||
|
||||||||||||
/// Defines the subcommands for CLI. NOTE: If we change the commands in Go, | ||||||||||||
/// we must change these as well to avoid accidentally passing the | ||||||||||||
/// --single-package flag into non-build commands. | ||||||||||||
/// Defines the subcommands for CLI | ||||||||||||
#[derive(Subcommand, Clone, Debug, PartialEq)] | ||||||||||||
pub enum Command { | ||||||||||||
/// Get the path to the Turbo binary | ||||||||||||
|
@@ -570,6 +568,8 @@ pub enum Command { | |||||||||||
#[clap(long)] | ||||||||||||
invalidate: bool, | ||||||||||||
}, | ||||||||||||
/// Print debugging information | ||||||||||||
Info, | ||||||||||||
/// Prepare a subset of your monorepo. | ||||||||||||
Prune { | ||||||||||||
#[clap(hide = true, long)] | ||||||||||||
|
@@ -1214,6 +1214,18 @@ pub async fn run( | |||||||||||
generate::run(tag, command, &args, child_event)?; | ||||||||||||
Ok(0) | ||||||||||||
} | ||||||||||||
Command::Info => { | ||||||||||||
CommandEventBuilder::new("info") | ||||||||||||
.with_parent(&root_telemetry) | ||||||||||||
.track_call(); | ||||||||||||
let base = CommandBase::new(cli_args.clone(), repo_root, version, color_config); | ||||||||||||
|
||||||||||||
match info::run(base).await { | ||||||||||||
Ok(()) => {} | ||||||||||||
Err(_e) => panic!("`info` command failed."), | ||||||||||||
} | ||||||||||||
Comment on lines
+1223
to
+1226
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 generally want to avoid You can use
Suggested change
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. Oh I recommended panic here because the previous message was to open a GitHub Issue and panic includes that advice |
||||||||||||
Ok(0) | ||||||||||||
} | ||||||||||||
Command::Telemetry { command } => { | ||||||||||||
let event = CommandEventBuilder::new("telemetry").with_parent(&root_telemetry); | ||||||||||||
event.track_call(); | ||||||||||||
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,93 @@ | ||||||||||||||||||||||||||
use std::{env, io}; | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
use sysinfo::{System, SystemExt}; | ||||||||||||||||||||||||||
use thiserror::Error; | ||||||||||||||||||||||||||
use turborepo_repository::{package_json::PackageJson, package_manager::PackageManager}; | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
use super::CommandBase; | ||||||||||||||||||||||||||
use crate::{DaemonConnector, DaemonConnectorError}; | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
#[derive(Debug, Error)] | ||||||||||||||||||||||||||
pub enum Error { | ||||||||||||||||||||||||||
#[error("could not get path to turbo binary: {0}")] | ||||||||||||||||||||||||||
NoCurrentExe(#[from] io::Error), | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
pub async fn run(base: CommandBase) -> Result<(), Error> { | ||||||||||||||||||||||||||
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. ITG (non blocking follow up): Separate the data from the display logic to make this more unit-test friendly and support additional output formats like JSON. Something like:
And then have |
||||||||||||||||||||||||||
let system = System::new_all(); | ||||||||||||||||||||||||||
let connector = DaemonConnector::new(false, false, &base.repo_root); | ||||||||||||||||||||||||||
let daemon_status = match connector.connect().await { | ||||||||||||||||||||||||||
Ok(_status) => "Running", | ||||||||||||||||||||||||||
Err(DaemonConnectorError::NotRunning) => "Not running", | ||||||||||||||||||||||||||
Err(_e) => "Error getting status", | ||||||||||||||||||||||||||
}; | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
let package_manager = match PackageJson::load(&base.repo_root.join_component("package.json")) { | ||||||||||||||||||||||||||
Ok(package_json) => { | ||||||||||||||||||||||||||
match PackageManager::read_or_detect_package_manager(&package_json, &base.repo_root) { | ||||||||||||||||||||||||||
Ok(pm) => pm.to_string(), | ||||||||||||||||||||||||||
Err(_) => "Not found".to_owned(), | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
Err(_) => "Not found".to_owned(), | ||||||||||||||||||||||||||
}; | ||||||||||||||||||||||||||
Comment on lines
+25
to
+33
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. Just some Rust code golf. I'd recommend manually committing this because Rustfmt will probably disagree with this formatting
Suggested change
|
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
println!("CLI:"); | ||||||||||||||||||||||||||
println!(" Version: {}", base.version); | ||||||||||||||||||||||||||
println!( | ||||||||||||||||||||||||||
" Location: {}", | ||||||||||||||||||||||||||
std::env::current_exe()?.to_string_lossy() | ||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||
println!(" Daemon status: {}", daemon_status); | ||||||||||||||||||||||||||
println!(" Package manager: {}", package_manager); | ||||||||||||||||||||||||||
println!(); | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
println!("Platform:"); | ||||||||||||||||||||||||||
println!(" Architecture: {}", std::env::consts::ARCH); | ||||||||||||||||||||||||||
println!(" Operating system: {}", std::env::consts::OS); | ||||||||||||||||||||||||||
println!( | ||||||||||||||||||||||||||
" Available memory (MB): {}", | ||||||||||||||||||||||||||
system.available_memory() / 1024 / 1024 | ||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||
println!(" Available CPU cores: {}", num_cpus::get()); | ||||||||||||||||||||||||||
println!(); | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
println!("Environment:"); | ||||||||||||||||||||||||||
println!(" CI: {:#?}", turborepo_ci::Vendor::get_name()); | ||||||||||||||||||||||||||
println!( | ||||||||||||||||||||||||||
" Terminal (TERM): {}", | ||||||||||||||||||||||||||
env::var("TERM").unwrap_or_else(|_| "unknown".to_owned()) | ||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
println!( | ||||||||||||||||||||||||||
" Terminal program (TERM_PROGRAM): {}", | ||||||||||||||||||||||||||
env::var("TERM_PROGRAM").unwrap_or_else(|_| "unknown".to_owned()) | ||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||
println!( | ||||||||||||||||||||||||||
" Terminal program version (TERM_PROGRAM_VERSION): {}", | ||||||||||||||||||||||||||
env::var("TERM_PROGRAM_VERSION").unwrap_or_else(|_| "unknown".to_owned()) | ||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||
println!( | ||||||||||||||||||||||||||
" Shell (SHELL): {}", | ||||||||||||||||||||||||||
env::var("SHELL").unwrap_or_else(|_| "unknown".to_owned()) | ||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||
println!(" stdin: {}", turborepo_ci::is_ci()); | ||||||||||||||||||||||||||
println!(); | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
println!("Turborepo System Environment Variables:"); | ||||||||||||||||||||||||||
for (key, value) in env::vars() { | ||||||||||||||||||||||||||
// Don't print sensitive information | ||||||||||||||||||||||||||
if key == "TURBO_TEAM" | ||||||||||||||||||||||||||
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.
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. Maybe we should make this opt-in instead of opt-out? |
||||||||||||||||||||||||||
|| key == "TURBO_TEAMID" | ||||||||||||||||||||||||||
|| key == "TURBO_TOKEN" | ||||||||||||||||||||||||||
|| key == "TURBO_API" | ||||||||||||||||||||||||||
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. If we're considering |
||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||
continue; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
if key.starts_with("TURBO_") { | ||||||||||||||||||||||||||
println!(" {}: {}", key, value); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Ok(()) | ||||||||||||||||||||||||||
} |
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.
Unrelated, but saw it mentioning Go so ✂️