feat(forge): backtraces (#11547)

* basic backtrace impl

* cleanup + remove frame kind

* nit

* cleanup

* nit

* display backtrace after traces

* move backtrace extraction

* fix inversion

* tests

* remove unused fields and args

* nit

* nit

* cleanup: extract_backtrace

* fix: don't set incorrect source location if we're unable to locate it

* don't collect creation source map

* use typed Path instead of String

* unify the HashMap keyed by artifact id

* mv source maps collection from multi_runner

* more cleanup

* feat: collect sources by build_id to work across fresh and cached compiler runs

* add mixed compilation test

* fork tests

* clippy

* feat: detect internal library calls using ast

* test_library_backtrace

* feat: detect external libraries

* cleanup: consolidate logic in the Backtrace type

* collect and store libs once not per source + add offset in SourceLocation to identify multiple contract / libs accurately

* lazy source data collection

* cleanup

* resolve labels using known_contracts

* fmt

* feat: BacktraceBuilder

* consolidate in backtrace builder

* don't clone library sources

* remove source_data from Backtrace

* fix breaking tests

* nit

* nit

* unify source and lib collection

* use parsed_libraries

* nit

* cleanup

* docs nits

* fix

* nit

* nit

* remove: contract_by_address from runner

* nit

* TraceMode::Debug for steps tracing when -vvv

* rm redundant clone

* rm unused deployed_bytecode from TestContract

* rm redundant verbosity from mcr

* nit

* nit

* fix tests

* don't enable ast

* minify json test fixture

* fix test svg

* ignore windows

* fix

* ignore win msg

* win fix, Forge fmt new backtraces tests

* defer source data collection + collect only required sources

* rm artifact_ids from BacktraceBuilder

* rm ast from SourceData

* avoid source data cloning

* defer BacktraceBuilder instatiation only in case of failure + pass required fields from config

* nit

* fix: oom due to TraceMode::Debug being set on verbosity >= 3

* fix backtrace tests - removal of internal lib detection

* fix

* fix: can_run_test_with_json_output_verbose

* fix: ext tests by setting verbosity for forge-std and sablier

* verbosity

* minify

* fix

* fix(backtraces): reduce TraceMode level + don't hold sources in memory + avoid cloning  (#11648)

* defer source data collection + collect only required sources

* rm artifact_ids from BacktraceBuilder

* rm ast from SourceData

* avoid source data cloning

* defer BacktraceBuilder instatiation only in case of failure + pass required fields from config

* nit

* fix: oom due to TraceMode::Debug being set on verbosity >= 3

* fix backtrace tests - removal of internal lib detection

* fix

* fix: can_run_test_with_json_output_verbose

* fix: ext tests by setting verbosity for forge-std and sablier

* verbosity

* minify

* fix

* check for silent and verbosity outside iter + use with_capacity

* flattened - use filter_map outside

* rm unused solidity file

* make fns private + push to frames directly

* nit

* cleanup extract_frames

* cleanup retrieving names from trace.decoded

* format nit

* nit

Co-authored-by: DaniPopes <[email protected]>

* use output.artifact_ids to chain cached and compiled

* format nits

* feat: disable detecting source location on via-ir

* cleanup collect_source_data - rm redundant sorting

* rm redundant loop and ptr comparios in from_traces

* rm redundant prefix stripping

* fix

* unify resolving addresses for artifacts

* nits + move format to Display

* don't check linked libs if artifact already found

* internalize extract_frames + make BacktraceFrame private

* move to evm::traces

* init backtrace builder outside loop

* use memchr_iter

* maintain source_cache in builder to avoid collect sources on multiple failures + pass SourceData by reference

* cache by build_id in BacktraceBuilder to fetch sources for a build_id only once

* non_exhaustive Backtrace

* feat(traces): new TraceMode::Steps - enabled on -vvv

* nits

* fix: can_run_test_with_json_output_verbose

---------

Co-authored-by: grandizzy <[email protected]>
Co-authored-by: grandizzy <[email protected]>
Co-authored-by: DaniPopes <[email protected]>

Author: 3 people

Cargo.lock

@@ -320,6 +320,7 @@ itertools = "0.14"
 jsonpath_lib = "0.3"
 k256 = "0.13"
 mesc = "0.3"
+memchr = "2.7"
 num-format = "0.4"
 parking_lot = "0.12"
 proptest = "1.7.0"

Cargo.toml

@@ -51,7 +51,7 @@ eyre.workspace = true
 itertools.workspace = true
 jsonpath_lib.workspace = true
 k256.workspace = true
-memchr = "2.7"
+memchr.workspace = true
 p256 = "0.13"
 ecdsa = "0.16"
 rand.workspace = true

crates/cheatcodes/Cargo.toml

@@ -27,7 +27,7 @@ use foundry_evm_core::{
     constants::{CALLER, CHEATCODE_ADDRESS, HARDHAT_CONSOLE_ADDRESS, TEST_CONTRACT_ADDRESS},
     utils::get_blob_base_fee_update_fraction_by_spec_id,
 };
-use foundry_evm_traces::StackSnapshotType;
+use foundry_evm_traces::TraceMode;
 use itertools::Itertools;
 use rand::Rng;
 use revm::{
@@ -1055,13 +1055,8 @@ impl Cheatcode for startDebugTraceRecordingCall {
             original_tracer_config: *tracer.config(),
         };
 
-        // turn on tracer configuration for recording
-        tracer.update_config(|config| {
-            config
-                .set_steps(true)
-                .set_memory_snapshots(true)
-                .set_stack_snapshots(StackSnapshotType::Full)
-        });
+        // turn on tracer debug configuration for recording
+        *tracer.config_mut() = TraceMode::Debug.into_config().expect("cannot be None");
 
         // track where the recording starts
         if let Some(last_node) = tracer.traces().nodes().last() {

crates/cheatcodes/src/evm.rs

@@ -43,6 +43,8 @@ tempfile.workspace = true
 rayon.workspace = true
 solar.workspace = true
 revm.workspace = true
+yansi.workspace = true
+memchr.workspace = true
 
 [dev-dependencies]
 tempfile.workspace = true