Add backtrace validation (#3655)

Related #3272

commit-id:93440e6c

---

**Stack**:
- #3656
- #3655 ⬅


⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do
not merge manually using the UI - doing so may have unexpected results.*

Author: ksew1

crates/forge-runner/src/backtrace/data.rs

@@ -12,7 +12,6 @@ use cairo_lang_sierra::program::StatementIdx;
 use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
 use cairo_lang_starknet_classes::contract_class::ContractClass;
 use cheatnet::runtime_extensions::forge_runtime_extension::contracts_data::ContractsData;
-use indoc::indoc;
 use itertools::Itertools;
 use rayon::iter::IntoParallelIterator;
 use rayon::iter::ParallelIterator;
@@ -96,22 +95,11 @@ impl ContractBacktraceData {
             .context("debug info not found")?;
 
         let VersionedCoverageAnnotations::V1(coverage_annotations) =
-            VersionedCoverageAnnotations::try_from_debug_info(sierra_debug_info).context(indoc! {
-                "perhaps the contract was compiled without the following entry in Scarb.toml under [profile.dev.cairo]:
-                unstable-add-statements-code-locations-debug-info = true
-
-                or scarb version is less than 2.8.0
-                "
-            })?;
+            VersionedCoverageAnnotations::try_from_debug_info(sierra_debug_info)
+                .expect("this should not fail, as we are doing validation in the `can_backtrace_be_generated` function");
 
         let VersionedProfilerAnnotations::V1(profiler_annotations) =
-            VersionedProfilerAnnotations::try_from_debug_info(sierra_debug_info).context(indoc! {
-                "perhaps the contract was compiled without the following entry in Scarb.toml under [profile.dev.cairo]:
-                unstable-add-statements-functions-debug-info = true
-
-                or scarb version is less than 2.8.0
-                "
-            })?;
+            VersionedProfilerAnnotations::try_from_debug_info(sierra_debug_info).expect("this should not fail, as we are doing validation in the `can_backtrace_be_generated` function");
 
         // Not optimal, but USC doesn't produce debug info for the contract class
         let (_, debug_info) = CasmContractClass::from_contract_class_with_debug_info(

crates/forge/src/profile_validation/backtrace.rs

@@ -0,0 +1,51 @@
+use crate::profile_validation::{check_cairo_profile_entries, get_manifest};
+use anyhow::ensure;
+use indoc::formatdoc;
+use scarb_metadata::Metadata;
+use semver::Version;
+
+/// Checks if backtrace can be generated based on scarb version and profile settings extracted from the provided [`Metadata`].
+pub fn check_backtrace_compatibility(scarb_metadata: &Metadata) -> anyhow::Result<()> {
+    check_scarb_version(scarb_metadata)?;
+    check_profile(scarb_metadata)?;
+    Ok(())
+}
+
+/// Checks if the scarb version from the provided [`Metadata`] is greater than or equal to the minimal required version.
+fn check_scarb_version(scarb_metadata: &Metadata) -> anyhow::Result<()> {
+    const MINIMAL_SCARB_VERSION: Version = Version::new(2, 8, 0);
+    ensure!(
+        scarb_metadata.app_version_info.version >= MINIMAL_SCARB_VERSION,
+        "Backtrace generation requires scarb version >= {MINIMAL_SCARB_VERSION}",
+    );
+    Ok(())
+}
+
+/// Checks if the runtime profile settings in the provided from [`Metadata`] contain the required entries for backtrace generation.
+fn check_profile(scarb_metadata: &Metadata) -> anyhow::Result<()> {
+    const BACKTRACE_REQUIRED_ENTRIES: &[(&str, &str)] = &[
+        ("unstable-add-statements-functions-debug-info", "true"),
+        ("unstable-add-statements-code-locations-debug-info", "true"),
+    ];
+
+    let manifest = get_manifest(scarb_metadata)?;
+
+    let has_needed_entries =
+        check_cairo_profile_entries(&manifest, scarb_metadata, BACKTRACE_REQUIRED_ENTRIES);
+
+    ensure!(
+        has_needed_entries,
+        formatdoc! {
+            "Scarb.toml must have the following Cairo compiler configuration to run backtrace:
+
+            [profile.{profile}.cairo]
+            unstable-add-statements-functions-debug-info = true
+            unstable-add-statements-code-locations-debug-info = true
+            ... other entries ...
+            ",
+            profile = scarb_metadata.current_profile
+        },
+    );
+
+    Ok(())
+}

crates/forge/src/profile_validation/mod.rs

@@ -1,7 +1,10 @@
+mod backtrace;
 mod coverage;
 
 use crate::TestArgs;
+use crate::profile_validation::backtrace::check_backtrace_compatibility;
 use crate::profile_validation::coverage::check_coverage_compatibility;
+use forge_runner::backtrace::is_backtrace_enabled;
 use scarb_metadata::Metadata;
 use std::fs;
 use toml_edit::{DocumentMut, Table};
@@ -14,6 +17,9 @@ pub fn check_profile_compatibility(
     if test_args.coverage {
         check_coverage_compatibility(scarb_metadata)?;
     }
+    if is_backtrace_enabled() {
+        check_backtrace_compatibility(scarb_metadata)?;
+    }
     Ok(())
 }
 

crates/forge/tests/e2e/backtrace.rs

@@ -160,12 +160,12 @@ fn test_wrong_scarb_toml_configuration() {
     assert_stdout_contains(
         output,
         indoc! {
-           "Failure data:
-            Got an exception while executing a hint: Requested contract address 0x0000000000000000000000000000000000000000000000000000000000000123 is not deployed.
-            failed to create backtrace: perhaps the contract was compiled without the following entry in Scarb.toml under [profile.dev.cairo]:
-            unstable-add-statements-code-locations-debug-info = true
+           "[ERROR] Scarb.toml must have the following Cairo compiler configuration to run backtrace:
 
-            or scarb version is less than 2.8.0"
+            [profile.dev.cairo]
+            unstable-add-statements-functions-debug-info = true
+            unstable-add-statements-code-locations-debug-info = true
+            ... other entries ..."
         },
     );
 }