error-stack 0.7.0

#![cfg(not(miri))] // debug formatting does not utilize any unsafe code
#![cfg_attr(nightly, feature(error_generic_member_access))]
#![allow(clippy::std_instead_of_core)]
mod common;

use common::*;
use error_stack::{
    Report,
    fmt::{Charset, ColorMode},
};
use insta::assert_snapshot;
#[cfg(feature = "spantrace")]
use tracing_error::ErrorLayer;
#[cfg(feature = "spantrace")]
use tracing_subscriber::layer::SubscriberExt as _;

#[cfg(feature = "spantrace")]
fn setup_tracing() {
    static ONCE: std::sync::Once = std::sync::Once::new();
    ONCE.call_once(|| {
        tracing::subscriber::set_global_default(
            tracing_subscriber::Registry::default().with(ErrorLayer::default()),
        )
        .expect("Could not set tracing subscriber");
    });
}

#[cfg(not(feature = "spantrace"))]
const fn setup_tracing() {}

#[cfg(not(feature = "backtrace"))]
fn setup_backtrace() {
    std::env::set_var("RUST_LIB_BACKTRACE", "0");
}

#[cfg(feature = "backtrace")]
fn setup_backtrace() {
    std::env::set_var("RUST_LIB_BACKTRACE", "1");
}

fn setup_color() {
    Report::set_color_mode(ColorMode::None);
}

fn setup() {
    setup_tracing();
    setup_backtrace();
    setup_color();
    Report::set_charset(Charset::Utf8);
}

fn snap_suffix() -> String {
    #[cfg_attr(
        not(any(feature = "backtrace", feature = "spantrace")),
        expect(unused_mut)
    )]
    let mut suffix: Vec<&'static str> = vec![];

    #[cfg(feature = "spantrace")]
    {
        suffix.push("spantrace");
    }

    #[cfg(feature = "backtrace")]
    if supports_backtrace() {
        suffix.push("backtrace");
    }

    suffix.join("-")
}

/// Overwrite to create spantraces when necessary.
#[cfg(feature = "spantrace")]
pub fn create_report() -> Report<RootError> {
    #[tracing::instrument]
    fn func_b() -> Result<(), Report<RootError>> {
        create_error()
    }

    #[tracing::instrument]
    fn func_a() -> Result<(), Report<RootError>> {
        func_b()
    }

    capture_error(func_a)
}

fn prepare(suffix: bool) -> impl Drop {
    setup();

    let mut settings = insta::Settings::clone_current();
    if suffix {
        settings.set_snapshot_suffix(snap_suffix());
    }

    settings.add_filter(
        r"backtrace no\. (\d+)\n(?:  .*\n)*  .*",
        "backtrace no. $1\n  [redacted]",
    );
    settings.add_filter(
        r"span trace No\. (\d+)\n(?:  .*\n)*  .*",
        "span trace No. $1\n  [redacted]",
    );
    settings.add_filter(
        r"backtrace with( (\d+) frames)? \((\d+)\)",
        "backtrace ($3)",
    );

    settings.bind_to_scope()
}

/// Generate the `Report` for:
///
/// ```text
///                    P 1
///                     │
///                     ▼
///                    P 2
///                     │
///                     ▼
///                    C 1
///                     │
///                     ▼
///                ┌───P 3───┐
///                │         │
///                ▼         ▼
///               P 4       P 5
///                │         │
///                ▼         ▼
///               C 2      C 10
///                │         │
///                ▼         ▼
///               P 6       P 7
///                │         │
///                ▼         ▼
///          root error 1   C 3
///                          │
///                          ▼
///                         P 8
///                          │
///                          ▼
///       ┌─────────────────P 9─────────────────┬─────────────┐
///       │                  │                  │             │
///       │                  │                  │             │
///       ▼                  ▼                  ▼             ▼
///      C 4               P 16               P 11          P 12
///       │                  │                  │             │
///       ▼                  ▼                  ▼             ▼
/// root error 2       ┌───P 10───┐            C 9           C 6
///                    │          │             │             │
///                    ▼          ▼             ▼             ▼
///                  P 13       P 14      root error 5       C 7
///                    │          │                           │
///                    ▼          ▼                           ▼
///                   C 8       P 15                    root error 6
///                    │          │
///                    ▼          ▼
///              root error 3    C 5
///                               │
///                               ▼
///                         root error 4
/// ```
///
/// Legend: `P = Printable`, `C = Context`.
fn create_sources_nested() -> Report<ContextA> {
    let r4 = create_report()
        .change_context(ContextA(5))
        .attach("15")
        .attach("14");

    let r6 = create_report()
        .change_context(ContextA(7))
        .change_context(ContextA(6))
        .attach("12");

    let r5 = create_report().change_context(ContextA(9)).attach("11");

    let mut r3 = create_report()
        .change_context(ContextA(8))
        .attach("13")
        .expand();

    r3.push(r4);
    let r3 = r3.attach("10").attach("16");

    let mut r2 = create_report().change_context(ContextA(4)).expand();

    r2.append(r3);
    r2.push(r5);
    r2.push(r6);

    let r2 = r2
        .attach("9")
        .attach("8")
        .change_context(ContextA(3))
        .attach("7")
        .change_context(ContextA(10))
        .attach("5");

    let mut r1 = create_report()
        .attach("6")
        .change_context(ContextA(2))
        .attach("4")
        .expand();

    r1.push(r2);

    r1.attach("3")
        .change_context(ContextA(1))
        .attach("2")
        .attach("1")
}

/// This is the main test, to test all different parts at once,
/// and demonstrates that the rendering algorithm works at arbitrary depth.
#[test]
fn sources_nested() {
    let _guard = prepare(true);

    let report = create_sources_nested();

    assert_snapshot!(format!("{report:?}"));
}

#[test]
fn sources_nested_alternate() {
    let _guard = prepare(true);

    let report = create_sources_nested();

    assert_snapshot!(format!("{report:#?}"));
}

mod full {
    #![cfg(all(feature = "backtrace", feature = "spantrace"))]
    //! Why so many cfg guards?
    //! What was found during initial development of the feature was,
    //! that a complete test of all tests with snapshots on every possible feature combination
    //! was infeasible, as this would lead to *a lot* of different snapshots.
    //!
    //! Changes in snapshots (this includes adding or removing lines in the test code) results in 9
    //! different snapshots, which *all* basically test the same permutation:
    //! * Does glyph/non-glyph output look nice?
    //! * Does rendering work?
    //! * Do the builtin hooks (`Backtrace` and `SpanTrace`) work?
    //!
    //! Does any combination of those work together?
    //! Therefore most of them are redundant, this means that we can cut down on the amount of
    //! snapshots that are generated. This does *not* impact speed, but makes it easier to look
    //! through all snapshots, which means that instead of 118 new snapshots once a code line
    //! changes, one just needs to look over < 30, which is a lot more manageable.
    //!
    //! There are still some big snapshot tests, which are used evaluate all of the above.

    #[cfg(nightly)]
    use core::error::Request;
    use std::{
        error::Error,
        fmt::{Display, Formatter},
        panic::Location,
    };

    use super::*;

    #[test]
    fn linear() {
        let _guard = prepare(false);

        let report = create_report()
            .attach(PrintableA(0))
            .attach_opaque(AttachmentA)
            .attach_opaque(AttachmentB)
            .change_context(ContextA(0))
            .attach(PrintableB(0))
            .attach_opaque(AttachmentB)
            .change_context(ContextB(0))
            .attach("printable C");

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn linear_ext() {
        let _guard = prepare(false);

        let report = create_report()
            .attach(PrintableA(0))
            .attach_opaque(AttachmentA)
            .attach_opaque(AttachmentB)
            .change_context(ContextA(0))
            .attach(PrintableB(0))
            .attach_opaque(AttachmentB)
            .change_context(ContextB(0))
            .attach("printable C");

        assert_snapshot!(format!("{report:#?}"));
    }

    #[derive(Debug)]
    struct ContextC;

    impl Display for ContextC {
        fn fmt(&self, fmt: &mut Formatter<'_>) -> core::fmt::Result {
            fmt.write_str("A multiline\ncontext that might have\na bit more info")
        }
    }

    impl Error for ContextC {}

    #[test]
    fn multiline_context() {
        let _guard = prepare(false);

        let report = Report::new(ContextC)
            .change_context(ContextC)
            .attach(PrintableB(0))
            .attach_opaque(AttachmentB)
            .change_context(ContextB(0))
            .attach("printable C");

        assert_snapshot!(format!("{report:#?}"));
    }

    #[test]
    fn multiline() {
        let _guard = prepare(false);

        let report = create_report()
            .attach("A multiline\nattachment\nthat might have some\nadditional info")
            .attach("A multiline\nattachment\nthat might have some\nadditional info");

        assert_snapshot!(format!("{report:#?}"));
    }

    /// Generate the `Debug` for:
    ///
    /// ```text
    ///         [A] B
    ///            |
    ///         [C] A
    ///            |
    ///         [A] A
    ///      /     |    \
    ///  [P] A  [P] B  [P] B
    ///    |       |      |
    ///   Root   Root    Root
    /// ```
    ///
    /// This should demonstrate that we're able to generate with multiple groups at the same time.
    #[test]
    fn sources() {
        let _guard = prepare(false);

        let mut root1 = create_report().attach(PrintableA(1)).expand();
        let root2 = create_report().attach(PrintableB(2));
        let root3 = create_report().attach(PrintableB(3));

        root1.push(root2);
        root1.push(root3);

        let report = root1
            .attach_opaque(AttachmentA(1))
            .change_context(ContextA(2))
            .attach_opaque(AttachmentB(2));

        assert_snapshot!(format!("{report:?}"));
    }

    /// Generate the `Debug` for:
    ///
    /// ```text
    ///         [A] B
    ///            |
    ///         [C] A
    ///            |
    ///         [A] A
    ///           /  \
    ///       [P] A  [A] A
    ///         |       |   \
    ///        Root  [P] B  [P] B
    ///                 |      |
    ///               Root    Root
    /// ```
    ///
    /// and should demonstrate that "transparent" groups, groups which do not have a change in
    /// context, are still handled gracefully.
    #[test]
    fn sources_transparent() {
        let _guard = prepare(false);

        let report = {
            let mut report = create_report().attach(PrintableA(1)).expand();

            report.append({
                let mut report = create_report().attach(PrintableB(2)).expand();

                report.push(create_report().attach(PrintableB(3)));

                report.attach(PrintableA(4))
            });

            report
                .attach_opaque(AttachmentA(1))
                .change_context(ContextA(2))
                .attach_opaque(AttachmentB(2))
        };

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn complex() {
        let _guard = prepare(false);

        let mut report = create_report().attach(PrintableA(0)).expand();
        report.append({
            let mut report = create_report().attach(PrintableB(1)).expand();

            report.push(
                create_report()
                    .attach_opaque(AttachmentB(0))
                    .attach_opaque(AttachmentA(1))
                    .attach(PrintableB(1)),
            );

            report.attach_opaque(AttachmentA(2)).attach("Test")
        });

        // force the generation of a tree node
        let report = report.change_context(ContextA(2)).attach(PrintableA(2));

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook() {
        let _guard = prepare(false);

        let report = create_report().attach_opaque(2_u32);

        Report::install_debug_hook::<u32>(|_, context| {
            context.push_body("unsigned 32bit integer");
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook_context() {
        let _guard = prepare(false);

        let report = create_report().attach_opaque(2_u32);

        Report::install_debug_hook::<u32>(|_, context| {
            let idx = context.increment_counter();
            context.push_body(format!("unsigned 32bit integer (No. {idx})"));
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook_for_context() {
        let _guard = prepare(false);

        let report = create_report().attach_opaque(2_u32);

        Report::install_debug_hook::<RootError>(|_, _| {
            // This should not be displayed as `RootError` is only used as `Context`, never as
            // attachment.
            unreachable!("A context should never be used as hook");
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook_multiple() {
        let _guard = prepare(false);

        let report = create_report().attach_opaque(1_u32).attach_opaque(2_u64);

        Report::install_debug_hook::<u32>(|_, context| {
            context.push_body("unsigned 32bit integer");
        });
        Report::install_debug_hook::<u64>(|_, context| {
            context.push_body("unsigned 64bit integer");
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook_decr() {
        let _guard = prepare(false);

        let report = create_report() //
            .attach_opaque(1_u32)
            .attach_opaque(2_u32)
            .attach_opaque(3_u32);

        Report::install_debug_hook::<u32>(|_, context| {
            let idx = context.decrement_counter();
            context.push_body(idx.to_string());
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook_incr() {
        let _guard = prepare(false);

        let report = create_report() //
            .attach_opaque(1_u32)
            .attach_opaque(2_u32)
            .attach_opaque(3_u32);

        Report::install_debug_hook::<u32>(|_, context| {
            let idx = context.increment_counter();
            context.push_body(idx.to_string());
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn hook_alternate() {
        let _guard = prepare(false);

        let report = create_report().attach_opaque(2_u64);

        Report::install_debug_hook::<u64>(|_, context| {
            if context.alternate() {
                context.push_appendix("Snippet");
            }

            context.push_body("Empty");
        });

        assert_snapshot!("norm", format!("{report:?}"));

        assert_snapshot!("alt", format!("{report:#?}"));
    }

    #[test]
    fn hook_location() {
        let _guard = prepare(false);

        let report = create_report();

        Report::install_debug_hook::<Location<'static>>(|_, _| {});

        assert_snapshot!(format!("{report:?}"));
    }

    #[cfg(nightly)]
    #[derive(Debug)]
    struct ContextD {
        code: usize,
        reason: &'static str,
    }

    #[cfg(nightly)]
    impl Display for ContextD {
        fn fmt(&self, fmt: &mut Formatter<'_>) -> core::fmt::Result {
            fmt.write_str("context D")
        }
    }

    #[cfg(nightly)]
    impl Error for ContextD {
        fn provide<'a>(&'a self, request: &mut Request<'a>) {
            request.provide_ref(&self.code);
            request.provide_ref(&self.reason);
        }
    }

    #[test]
    #[cfg(nightly)]
    fn hook_provider() {
        let _guard = prepare(false);

        let report = create_report().change_context(ContextD {
            code: 420,
            reason: "Invalid User Input",
        });

        Report::install_debug_hook::<usize>(|value, context| {
            context.push_body(format!("usize: {value}"));
        });
        Report::install_debug_hook::<&'static str>(|value, context| {
            context.push_body(format!("&'static str: {value}"));
        });

        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn charset_ascii() {
        let _guard = prepare(false);

        Report::set_charset(Charset::Ascii);

        let report = create_report();
        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn color_mode_emphasis() {
        let _guard = prepare(false);

        Report::set_color_mode(ColorMode::Emphasis);

        let report = create_report();
        assert_snapshot!(format!("{report:?}"));
    }

    #[test]
    fn color_mode_color() {
        let _guard = prepare(false);

        Report::set_color_mode(ColorMode::Color);

        let report = create_report();
        assert_snapshot!(format!("{report:?}"));
    }
}