From bebacc475cc9458eba4595901046dc2ff78189a1 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Sat, 23 Mar 2024 23:56:05 +0100 Subject: [PATCH] Always print addErrorContext traces --- src/libexpr/primops.cc | 2 +- src/libutil/error.cc | 38 ++++++++++++------- src/libutil/error.hh | 9 ++++- tests/functional/lang.sh | 10 ++++- .../eval-fail-addErrorContext-example.err.exp | 38 +++++++++++++++++++ .../eval-fail-addErrorContext-example.flags | 1 + .../eval-fail-addErrorContext-example.nix | 9 +++++ 7 files changed, 90 insertions(+), 17 deletions(-) create mode 100644 tests/functional/lang/eval-fail-addErrorContext-example.err.exp create mode 100644 tests/functional/lang/eval-fail-addErrorContext-example.flags create mode 100644 tests/functional/lang/eval-fail-addErrorContext-example.nix diff --git a/src/libexpr/primops.cc b/src/libexpr/primops.cc index d0fcfd194..8a188e0c4 100644 --- a/src/libexpr/primops.cc +++ b/src/libexpr/primops.cc @@ -826,7 +826,7 @@ static void prim_addErrorContext(EvalState & state, const PosIdx pos, Value * * auto message = state.coerceToString(pos, *args[0], context, "while evaluating the error message passed to builtins.addErrorContext", false, false).toOwned(); - e.addTrace(nullptr, HintFmt(message)); + e.addTrace(nullptr, HintFmt(message), TraceKind::Custom); throw; } } diff --git a/src/libutil/error.cc b/src/libutil/error.cc index d1e864a1a..fa7dadb27 100644 --- a/src/libutil/error.cc +++ b/src/libutil/error.cc @@ -11,9 +11,9 @@ namespace nix { -void BaseError::addTrace(std::shared_ptr && e, HintFmt hint) +void BaseError::addTrace(std::shared_ptr && e, HintFmt hint, TraceKind kind) { - err.traces.push_front(Trace { .pos = std::move(e), .hint = hint }); + err.traces.push_front(Trace { .pos = std::move(e), .hint = hint, .kind = kind }); } void throwExceptionSelfCheck(){ @@ -379,29 +379,39 @@ std::ostream & showErrorInfo(std::ostream & out, const ErrorInfo & einfo, bool s // A consecutive sequence of stack traces that are all in `tracesSeen`. std::vector skippedTraces; size_t count = 0; + bool truncate = false; for (const auto & trace : einfo.traces) { if (trace.hint.str().empty()) continue; if (!showTrace && count > 3) { - oss << "\n" << ANSI_WARNING "(stack trace truncated; use '--show-trace' to show the full trace)" ANSI_NORMAL << "\n"; - break; + truncate = true; } - if (tracesSeen.count(trace)) { - skippedTraces.push_back(trace); - continue; + if (!truncate || trace.kind == TraceKind::Custom) { + + if (tracesSeen.count(trace)) { + skippedTraces.push_back(trace); + continue; + } + + tracesSeen.insert(trace); + + printSkippedTracesMaybe(oss, ellipsisIndent, count, skippedTraces, tracesSeen); + + count++; + + printTrace(oss, ellipsisIndent, count, trace); } - tracesSeen.insert(trace); - - printSkippedTracesMaybe(oss, ellipsisIndent, count, skippedTraces, tracesSeen); - - count++; - - printTrace(oss, ellipsisIndent, count, trace); } + printSkippedTracesMaybe(oss, ellipsisIndent, count, skippedTraces, tracesSeen); + + if (truncate) { + oss << "\n" << ANSI_WARNING "(stack trace truncated; use '--show-trace' to show the full, detailed trace)" ANSI_NORMAL << "\n"; + } + oss << "\n" << prefix; } diff --git a/src/libutil/error.hh b/src/libutil/error.hh index 89f5ad021..6701a75b3 100644 --- a/src/libutil/error.hh +++ b/src/libutil/error.hh @@ -61,9 +61,16 @@ void printCodeLines(std::ostream & out, const Pos & errPos, const LinesOfCode & loc); +enum struct TraceKind { + Other, + /** Produced by builtins.addErrorContext. Always printed. */ + Custom, +}; + struct Trace { std::shared_ptr pos; HintFmt hint; + TraceKind kind = TraceKind::Other; }; inline bool operator<(const Trace& lhs, const Trace& rhs); @@ -161,7 +168,7 @@ public: addTrace(std::move(e), HintFmt(std::string(fs), args...)); } - void addTrace(std::shared_ptr && e, HintFmt hint); + void addTrace(std::shared_ptr && e, HintFmt hint, TraceKind kind = TraceKind::Other); bool hasTrace() const { return !err.traces.empty(); } diff --git a/tests/functional/lang.sh b/tests/functional/lang.sh index 12df32c87..e35795a7a 100755 --- a/tests/functional/lang.sh +++ b/tests/functional/lang.sh @@ -68,8 +68,16 @@ done for i in lang/eval-fail-*.nix; do echo "evaluating $i (should fail)"; i=$(basename "$i" .nix) + flags="$( + if [[ -e "lang/$i.flags" ]]; then + sed -e 's/#.*//' < "lang/$i.flags" + else + # note that show-trace is also set by init.sh + echo "--eval --strict --show-trace" + fi + )" if - expectStderr 1 nix-instantiate --eval --strict --show-trace "lang/$i.nix" \ + expectStderr 1 nix-instantiate $flags "lang/$i.nix" \ | sed "s!$(pwd)!/pwd!g" > "lang/$i.err" then diffAndAccept "$i" err err.exp diff --git a/tests/functional/lang/eval-fail-addErrorContext-example.err.exp b/tests/functional/lang/eval-fail-addErrorContext-example.err.exp new file mode 100644 index 000000000..3d390cd37 --- /dev/null +++ b/tests/functional/lang/eval-fail-addErrorContext-example.err.exp @@ -0,0 +1,38 @@ +error: + … while calling the 'addErrorContext' builtin + at /pwd/lang/eval-fail-addErrorContext-example.nix:6:7: + 5| else + 6| builtins.addErrorContext + | ^ + 7| "while counting down; n = ${toString n}" + + … while counting down; n = 10 + + … while calling the 'addErrorContext' builtin + at /pwd/lang/eval-fail-addErrorContext-example.nix:6:7: + 5| else + 6| builtins.addErrorContext + | ^ + 7| "while counting down; n = ${toString n}" + + … while counting down; n = 9 + + … while counting down; n = 8 + + … while counting down; n = 7 + + … while counting down; n = 6 + + … while counting down; n = 5 + + … while counting down; n = 4 + + … while counting down; n = 3 + + … while counting down; n = 2 + + … while counting down; n = 1 + + (stack trace truncated; use '--show-trace' to show the full, detailed trace) + + error: kaboom diff --git a/tests/functional/lang/eval-fail-addErrorContext-example.flags b/tests/functional/lang/eval-fail-addErrorContext-example.flags new file mode 100644 index 000000000..9b1f6458f --- /dev/null +++ b/tests/functional/lang/eval-fail-addErrorContext-example.flags @@ -0,0 +1 @@ +--eval --strict --no-show-trace diff --git a/tests/functional/lang/eval-fail-addErrorContext-example.nix b/tests/functional/lang/eval-fail-addErrorContext-example.nix new file mode 100644 index 000000000..996b24688 --- /dev/null +++ b/tests/functional/lang/eval-fail-addErrorContext-example.nix @@ -0,0 +1,9 @@ +let + countDown = n: + if n == 0 + then throw "kaboom" + else + builtins.addErrorContext + "while counting down; n = ${toString n}" + ("x" + countDown (n - 1)); +in countDown 10