lints: uncovered patterns of format_error

[BugenZhao]

Tracks uncovered patterns of format_error lints after its introduction in #13750.

Resolved

• Error formatting on anyhow::Error

  • Example:

    risingwave/src/meta/src/manager/sink_coordination/coordinator_worker.rs

    Line 112 in bcd79a8

    error!("failed to wait for all writers: {:?}", e);

  • Reason: anyhow::Error does not implement std::error::Error.
  • Fix: feat(lints): lint format_error on anyhow::Error #15158

• Formatting on Report when constructing anyhow::Error

  • Example:

    risingwave/src/stream/src/task/barrier_manager.rs

    Lines 166 to 172 in 3398990

    	.map_err(|join_error| {
    	anyhow!(
    	"failed to join creating actors futures: {:?}",
    	join_error.as_report()
    	)
    	.into()
    	})

  • Reason: In most cases, Report is good. But there's no reason to do this if we're originally to construct an anyhow::Error. Should cover this as well.
  • Fix: feat(lints): lint on formatting Report in anyhow construction #15457

Unresolved

• Expanded from macros with macro arguments ($foo) nearby.
  • Example:

    risingwave/src/connector/src/parser/mysql.rs

    Line 37 in 495ed83

    tracing::error!("parse column `{}` fail: {} ({} suppressed)", $name, err, sc);

  • Reason: false positive of has_span_from_proc_macro

    risingwave/lints/src/utils/format_args_collector.rs

    Lines 42 to 47 in 495ed83

    	impl EarlyLintPass for FormatArgsCollector {
    	fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
    	if let ExprKind::FormatArgs(args) = &expr.kind {
    	if has_span_from_proc_macro(cx, args) {
    	return;
    	}

  • Fix: not sure

[github-actions]

This issue has been open for 60 days with no activity. Could you please update the status? Feel free to continue discussion or close as not planned.