error-forge 0.9.7

A comprehensive Rust error management framework with async support, error recovery patterns, and resilience features for building robust, fault-tolerant applications with rich error handling, formatting, and tracing capabilities.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use error_forge::{registry::register_error_code, AppError, ForgeError};

#[test]
fn test_error_with_code() {
    let error = AppError::config("Invalid configuration").with_code("CONFIG-001");

    assert_eq!(
        error.to_string(),
        "[CONFIG-001] ⚙️ Configuration Error: Invalid configuration"
    );
    assert_eq!(error.kind(), "Config"); // Original error properties preserved
}

#[test]
fn test_register_and_retrieve_code() {
    // Register a new error code with metadata
    let _ = register_error_code(
        "TEST-001",
        "Test error code",
        Some("https://docs.example.com/errors/TEST-001"),
        true,
    );

    // Use the registered error code
    let error = AppError::network("Connection timeout", None).with_code("TEST-001");

    // Verify the code is correctly associated
    assert!(error.to_string().starts_with("[TEST-001]"));

    // The registry information should be used for certain properties
    assert!(error.is_retryable()); // Specified in the registry
}

#[test]
fn test_error_code_chaining() {
    // We can chain error codes with other error enhancements
    let error = AppError::filesystem("Permission denied", None)
        .with_status(403)
        .with_code("PERM-001")
        .with_fatal(true);

    assert!(error.to_string().contains("[PERM-001]"));
    assert!(error.is_fatal());
    assert_eq!(error.status_code(), 403);
}

#[test]
fn test_duplicate_registration() {
    // First registration should succeed
    let result1 = register_error_code("UNIQUE-001", "First registration", None::<String>, false);

    // Second registration with same code should fail
    let result2 = register_error_code("UNIQUE-001", "Second registration", None::<String>, true);

    assert!(result1.is_ok());
    assert!(result2.is_err());
    assert!(result2.unwrap_err().contains("already registered"));
}

#[test]
fn test_error_code_in_dev_message() {
    // Register with documentation URL
    let _ = register_error_code(
        "DOC-001",
        "Error with documentation",
        Some("https://example.com/docs/errors/DOC-001"),
        false,
    );

    let error = AppError::config("Missing required field").with_code("DOC-001");

    // The dev message should include the documentation URL
    let dev_message = error.dev_message();
    assert!(dev_message.contains("[DOC-001]"));
    assert!(dev_message.contains("https://example.com/docs/errors/DOC-001"));
}

#[test]
fn test_coded_error_instance_overrides() {
    let _ = register_error_code(
        "OVERRIDE-001",
        "Retryable registry code",
        None::<String>,
        true,
    );

    let error = AppError::network("Connection timeout", None)
        .with_code("OVERRIDE-001")
        .with_retryable(false)
        .with_status(429)
        .with_fatal(true);

    assert!(!error.is_retryable());
    assert_eq!(error.status_code(), 429);
    assert!(error.is_fatal());
}