Skip to content

Make Diagnostic easy/convinient to attach by using macro and avoiding map_err #15796

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 3 commits into from
Apr 24, 2025
Merged

Make Diagnostic easy/convinient to attach by using macro and avoiding map_err #15796

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa76c85
First Step
logan-keede Apr 21, 2025
c09797e
Final Step?
logan-keede Apr 21, 2025
0ce1fa4
Homogenisation
logan-keede Apr 21, 2025
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
42 changes: 30 additions & 12 deletions datafusion/common/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,23 +759,33 @@ macro_rules! make_error {
/// Macro wraps `$ERR` to add backtrace feature
#[macro_export]
macro_rules! $NAME_DF_ERR {
($d($d args:expr),*) => {
$crate::DataFusionError::$ERR(
($d($d args:expr),* $d(; diag = $d DIAG:expr)?) => {{
let err =$crate::DataFusionError::$ERR(
::std::format!(
"{}{}",
::std::format!($d($d args),*),
$crate::DataFusionError::get_back_trace(),
).into()
)
);
$d (
let err = err.with_diagnostic($d DIAG);
)?
err
}
}
}

/// Macro wraps Err(`$ERR`) to add backtrace feature
#[macro_export]
macro_rules! $NAME_ERR {
($d($d args:expr),*) => {
Err($crate::[<_ $NAME_DF_ERR>]!($d($d args),*))
}
($d($d args:expr),* $d(; diag = $d DIAG:expr)?) => {{
let err = $crate::[<_ $NAME_DF_ERR>]!($d($d args),*);
$d (
let err = err.with_diagnostic($d DIAG);
)?
Err(err)

}}
}


Expand Down Expand Up @@ -816,17 +826,25 @@ make_error!(resources_err, resources_datafusion_err, ResourcesExhausted);
// Exposes a macro to create `DataFusionError::SQL` with optional backtrace
#[macro_export]
macro_rules! sql_datafusion_err {
($ERR:expr) => {
DataFusionError::SQL($ERR, Some(DataFusionError::get_back_trace()))
};
($ERR:expr $(, $DIAG:expr)?) => {{
let err = DataFusionError::SQL($ERR, Some(DataFusionError::get_back_trace()));
$(
let err = err.with_diagnostic($DIAG);
)?
err
}};
}

// Exposes a macro to create `Err(DataFusionError::SQL)` with optional backtrace
#[macro_export]
macro_rules! sql_err {
($ERR:expr) => {
Err(datafusion_common::sql_datafusion_err!($ERR))
};
($ERR:expr $(, $DIAG:expr)?) => {{
let err = datafusion_common::sql_datafusion_err!($ERR);
$(
let err = err.with_diagnostic($DIAG);
)?
Err(err)
}};
}

// Exposes a macro to create `DataFusionError::ArrowError` with optional backtrace
Expand Down
17 changes: 6 additions & 11 deletions datafusion/sql/src/expr/function.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,17 +408,12 @@ impl<S: ContextProvider> SqlToRel<'_, S> {
if let Some(suggested_func_name) =
suggest_valid_function(&name, is_function_window, self.context_provider)
{
plan_err!("Invalid function '{name}'.\nDid you mean '{suggested_func_name}'?")
.map_err(|e| {
let span = Span::try_from_sqlparser_span(sql_parser_span);
let mut diagnostic =
Diagnostic::new_error(format!("Invalid function '{name}'"), span);
diagnostic.add_note(
format!("Possible function '{}'", suggested_func_name),
None,
);
e.with_diagnostic(diagnostic)
})
let span = Span::try_from_sqlparser_span(sql_parser_span);
let mut diagnostic =
Diagnostic::new_error(format!("Invalid function '{name}'"), span);
diagnostic
.add_note(format!("Possible function '{}'", suggested_func_name), None);
plan_err!("Invalid function '{name}'.\nDid you mean '{suggested_func_name}'?"; diag=diagnostic)
Copy link
Contributor Author

@logan-keede logan-keede Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to use ; which is a bit weird, but works, is this acceptable @comphead?

Copy link
Contributor

@comphead comphead Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that would be not very obvious it is true.

} else {
internal_err!("No functions registered with this context.")
}
Expand Down
34 changes: 17 additions & 17 deletions datafusion/sql/src/parser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,14 @@ use std::fmt;

// Use `Parser::expected` instead, if possible
macro_rules! parser_err {
($MSG:expr) => {
Err(ParserError::ParserError($MSG.to_string()))
};
($MSG:expr $(, $DIAG:expr)?) => {{

let err = DataFusionError::from(ParserError::ParserError($MSG.to_string()));
$(
let err = err.with_diagnostic($DIAG);
)?
Err(err)
}};
}

fn parse_file_type(s: &str) -> Result<String, DataFusionError> {
Expand Down Expand Up @@ -448,20 +453,15 @@ impl<'a> DFParser<'a> {
found: TokenWithSpan,
) -> Result<T, DataFusionError> {
let sql_parser_span = found.span;
parser_err!(format!(
"Expected: {expected}, found: {found}{}",
found.span.start
))
.map_err(|e| {
let e = DataFusionError::from(e);
let span = Span::try_from_sqlparser_span(sql_parser_span);
let diagnostic = Diagnostic::new_error(
format!("Expected: {expected}, found: {found}{}", found.span.start),
span,
);

e.with_diagnostic(diagnostic)
})
let span = Span::try_from_sqlparser_span(sql_parser_span);
let diagnostic = Diagnostic::new_error(
format!("Expected: {expected}, found: {found}{}", found.span.start),
span,
);
parser_err!(
format!("Expected: {expected}, found: {found}{}", found.span.start),
diagnostic
)
}

/// Parse a new expression
Expand Down