feat(vm): compressing identical traces when displaying the stacktrace of an error

Author: SuperFola

include/Ark/TypeChecker.hpp

@@ -17,6 +17,7 @@
 #include <ostream>
 #include <sstream>
 
+#include <Ark/Exceptions.hpp>
 #include <Ark/VM/Value.hpp>
 
 namespace Ark::types

src/arkreactor/VM/VM.cpp

@@ -1661,27 +1661,44 @@ namespace Ark
             fmt::println(os, "");
         }
 
-        if (const uint16_t original_frame_count = context.fc; original_frame_count > 1)
+        if (context.fc > 1)
         {
             // display call stack trace
             const ScopeView old_scope = context.locals.back();
 
+            std::string previous_trace;
+            std::size_t displayed_traces = 0;
+            std::size_t consecutive_similar_traces = 0;
+
             while (context.fc != 0)
             {
                 const auto maybe_call_loc = findSourceLocation(context.ip, context.pp);
                 const auto loc_as_text = maybe_call_loc ? fmt::format(" ({}:{})", m_state.m_filenames[maybe_call_loc->filename_id], maybe_call_loc->line + 1) : "";
 
-                fmt::print(os, "[{}] ", fmt::styled(context.fc, colorize ? fmt::fg(fmt::color::cyan) : fmt::text_style()));
                 if (context.pp != 0)
                 {
                     const uint16_t id = findNearestVariableIdWithValue(
                         Value(static_cast<PageAddr_t>(context.pp)),
                         context);
+                    const auto func_name = (id < m_state.m_symbols.size()) ? m_state.m_symbols[id] : "???";
 
-                    if (id < m_state.m_symbols.size())
-                        fmt::println(os, "In function `{}'{}", fmt::styled(m_state.m_symbols[id], colorize ? fmt::fg(fmt::color::green) : fmt::text_style()), loc_as_text);
-                    else  // should never happen
-                        fmt::println(os, "In function `{}'{}", fmt::styled("???", colorize ? fmt::fg(fmt::color::gold) : fmt::text_style()), loc_as_text);
+                    if (func_name + loc_as_text != previous_trace)
+                    {
+                        fmt::println(
+                            os,
+                            "[{:4}] In function `{}'{}",
+                            fmt::styled(context.fc, colorize ? fmt::fg(fmt::color::cyan) : fmt::text_style()),
+                            fmt::styled(func_name, colorize ? fmt::fg(fmt::color::green) : fmt::text_style()),
+                            loc_as_text);
+                        previous_trace = func_name + loc_as_text;
+                        ++displayed_traces;
+                        consecutive_similar_traces = 0;
+                    }
+                    else if (consecutive_similar_traces == 0)
+                    {
+                        fmt::println("{0:^{1}}", "...", 21 + func_name.size() + loc_as_text.size());
+                        ++consecutive_similar_traces;
+                    }
 
                     Value* ip;
                     do
@@ -1695,11 +1712,11 @@ namespace Ark
                 }
                 else
                 {
-                    fmt::println(os, "In global scope{}", loc_as_text);
+                    fmt::println(os, "[{:4}] In global scope{}", fmt::styled(context.fc, colorize ? fmt::fg(fmt::color::cyan) : fmt::text_style()), loc_as_text);
                     break;
                 }
 
-                if (original_frame_count - context.fc > 7)
+                if (displayed_traces > 7)
                 {
                     fmt::println(os, "...");
                     break;

tests/unittests/resources/DiagnosticsSuite/runtime/not_enough_args.expected

@@ -6,8 +6,8 @@ In file tests/unittests/resources/DiagnosticsSuite/runtime/not_enough_args.ark
     2 | (foo 1)
     3 |
 
-[2] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/not_enough_args.ark:1)
-[1] In global scope (tests/unittests/resources/DiagnosticsSuite/runtime/not_enough_args.ark:2)
+[   2] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/not_enough_args.ark:1)
+[   1] In global scope (tests/unittests/resources/DiagnosticsSuite/runtime/not_enough_args.ark:2)
 
 Current scope variables values:
 foo = Function @ 1

tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.expected

@@ -9,14 +9,7 @@ In file tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark
     5 | }))
 
 [2047] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2046] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2045] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2044] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2043] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2042] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2041] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-[2040] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:3)
-...
+[   1] In global scope (tests/unittests/resources/DiagnosticsSuite/runtime/recursion_depth.ark:7)
 
 Current scope variables values:
 foo = Function @ 1

tests/unittests/resources/DiagnosticsSuite/runtime/too_many_args.expected

@@ -6,8 +6,8 @@ In file tests/unittests/resources/DiagnosticsSuite/runtime/too_many_args.ark
     2 | (foo 1 2 3)
     3 |
 
-[2] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/too_many_args.ark:1)
-[1] In global scope (tests/unittests/resources/DiagnosticsSuite/runtime/too_many_args.ark:2)
+[   2] In function `foo' (tests/unittests/resources/DiagnosticsSuite/runtime/too_many_args.ark:1)
+[   1] In global scope (tests/unittests/resources/DiagnosticsSuite/runtime/too_many_args.ark:2)
 
 Current scope variables values:
 foo = Function @ 1