这是indexloc提供的服务，不要输入任何密码
Skip to content

fix: use error logger in Rust turborepo #3253

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.

Sign up for GitHub

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 4 commits into from
Jan 12, 2023
Merged

fix: use error logger in Rust turborepo #3253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32e6968
use error logger in rust shim
chris-olszewski Jan 10, 2023
515aa96
fix stutter and no arg help text
chris-olszewski Jan 11, 2023
6fbfcbd
Merge remote-tracking branch 'origin/main' into chrisolszewski/turbo-…
chris-olszewski Jan 11, 2023
644eb64
Merge branch 'main' into chrisolszewski/turbo-676-audit-shim-log-usage
tknickman Jan 12, 2023
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
6 changes: 4 additions & 2 deletions cli/integration_tests/bad_flag.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,24 @@ Setup

Bad flag should print misuse text
$ ${TURBO} --bad-flag
error: Found argument '--bad-flag' which wasn't expected, or isn't valid in this context
ERROR Found argument '--bad-flag' which wasn't expected, or isn't valid in this context

If you tried to supply '--bad-flag' as a value rather than a flag, use '-- --bad-flag'

Usage: turbo [OPTIONS] [COMMAND]

For more information try '--help'

[1]

Bad flag with an implied run command should display run flags
$ ${TURBO} build --bad-flag
error: Found argument '--bad-flag' which wasn't expected, or isn't valid in this context
ERROR Found argument '--bad-flag' which wasn't expected, or isn't valid in this context

If you tried to supply '--bad-flag' as a value rather than a flag, use '-- --bad-flag'

Usage: turbo <--cache-dir <CACHE_DIR>|--cache-workers <CACHE_WORKERS>|--concurrency <CONCURRENCY>|--continue|--dry-run [<DRY_RUN>]|--single-package|--filter <FILTER>|--force|--global-deps <GLOBAL_DEPS>|--graph [<GRAPH>]|--ignore <IGNORE>|--include-dependencies|--no-cache|--no-daemon|--no-deps|--output-logs <OUTPUT_LOGS>|--only|--parallel|--profile <PROFILE>|--remote-only|--scope <SCOPE>|--since <SINCE>|TASKS|PASS_THROUGH_ARGS>

For more information try '--help'

[1]
3 changes: 2 additions & 1 deletion cli/integration_tests/basic_monorepo/verbosity.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,10 @@ Verbosity level 2

Make sure users can only use one verbosity flag
$ ${TURBO} build -v --verbosity=1
error: The argument '-v...' cannot be used with '--verbosity <COUNT>'
ERROR The argument '-v...' cannot be used with '--verbosity <COUNT>'

Usage: turbo [OPTIONS] [COMMAND]

For more information try '--help'

[1]
20 changes: 19 additions & 1 deletion crates/turborepo-lib/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use std::{env, io, mem, path::PathBuf, process};
use anyhow::{anyhow, Result};
use clap::{ArgAction, CommandFactory, Parser, Subcommand, ValueEnum};
use clap_complete::{generate, Shell};
use log::error;
use serde::Serialize;

use crate::{
Expand Down Expand Up @@ -150,10 +151,27 @@ impl Args {
pub fn new() -> Result<Self> {
let mut clap_args = match Args::try_parse() {
Ok(args) => args,
Err(e) if e.use_stderr() => {
// Don't use error logger when displaying help text
Err(e)
if matches!(
e.kind(),
clap::error::ErrorKind::DisplayHelpOnMissingArgumentOrSubcommand
) =>
{
let _ = e.print();
process::exit(1);
}
Err(e) if e.use_stderr() => {
let err_str = e.to_string();
// A cleaner solution would be to implement our own clap::error::ErrorFormatter
// but that would require copying the default formatter just to remove this
// line: https://docs.rs/clap/latest/src/clap/error/format.rs.html#100
error!(
"{}",
err_str.strip_prefix("error: ").unwrap_or(err_str.as_str())
);
process::exit(1);
}
// If the clap error shouldn't be printed to stderr it indicates help text
Err(e) => {
let _ = e.print();
Expand Down
11 changes: 9 additions & 2 deletions crates/turborepo-lib/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ mod package_manager;
mod shim;

use anyhow::Result;
use log::error;

pub use crate::cli::Args;
use crate::package_manager::PackageManager;
Expand All @@ -23,6 +24,12 @@ pub fn get_version() -> &'static str {
.0
}

pub fn main() -> Result<Payload> {
shim::run()
pub fn main() -> Payload {
match shim::run() {
Ok(payload) => payload,
Err(err) => {
error!("{}", err.to_string());
Payload::Rust(Err(err))
}
}
}
2 changes: 1 addition & 1 deletion crates/turborepo/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ fn run_go_binary(args: Args) -> Result<i32> {
// This function should not expanded. Please add any logic to
// `turborepo_lib::main` instead
fn main() -> Result<()> {
let exit_code = match turborepo_lib::main()? {
let exit_code = match turborepo_lib::main() {
Payload::Rust(res) => res.unwrap_or(1),
Payload::Go(state) => run_go_binary(*state)?,
};
Expand Down