apollo-errors 0.6.0

Structured error handling with automatic format conversion
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Tests for HTML format output (to_html)

mod common;

use apollo_errors::Error as ErrorTrait;
use common::{ErrorWithFields, ErrorWithHelp, SimpleError};
use insta::assert_snapshot;

#[test]
fn test_simple_error_html() {
    let error = SimpleError::Simple;
    let html = error.to_html();
    assert_snapshot!(html, @r#"
    <div class="error">
    <h3 class="error-code">errors::simple</h3>
    <p class="error-message">Something went wrong</p>

    </div>
    "#);
}

#[test]
fn test_error_with_help_html() {
    let error = ErrorWithHelp::ConfigError;
    let html = error.to_html();
    assert_snapshot!(html, @r#"
    <div class="error">
    <h3 class="error-code">config::error</h3>
    <p class="error-message">Configuration error</p>
    <p class="error-help">Check your configuration file</p>
    </div>
    "#);
}

#[test]
fn test_error_with_single_extension_field_html() {
    let error = ErrorWithFields::MissingConfig {
        expected_path: "/etc/app/config.yaml".to_string(),
    };
    let html = error.to_html();
    assert_snapshot!(html, @r###"
    <div class="error">
    <h3 class="error-code">config::missing</h3>
    <p class="error-message">Missing configuration</p>

    <div class="error-extensions">
    <div class="error-field"><span class="field-name">expected_path:</span> <span class="field-value">/etc/app/config.yaml</span></div>
    </div>
    </div>
    "###);
}

#[test]
fn test_error_with_multiple_extension_fields_html() {
    let error = ErrorWithFields::InvalidPort {
        port: 8080,
        config_file: "/etc/server.conf".to_string(),
    };
    let html = error.to_html();
    assert_snapshot!(html, @r###"
    <div class="error">
    <h3 class="error-code">config::invalid_port</h3>
    <p class="error-message">Invalid port</p>

    <div class="error-extensions">
    <div class="error-field"><span class="field-name">port:</span> <span class="field-value">8080</span></div>
    <div class="error-field"><span class="field-name">config_file:</span> <span class="field-value">/etc/server.conf</span></div>
    </div>
    </div>
    "###);
}

#[test]
fn test_error_with_numeric_extension_html() {
    let error = ErrorWithFields::InvalidPort {
        port: 65535,
        config_file: "/app/settings.toml".to_string(),
    };
    let html = error.to_html();
    assert_snapshot!(html, @r###"
    <div class="error">
    <h3 class="error-code">config::invalid_port</h3>
    <p class="error-message">Invalid port</p>

    <div class="error-extensions">
    <div class="error-field"><span class="field-name">port:</span> <span class="field-value">65535</span></div>
    <div class="error-field"><span class="field-name">config_file:</span> <span class="field-value">/app/settings.toml</span></div>
    </div>
    </div>
    "###);
}

#[test]
fn test_html_escapes_dangerous_characters() {
    // Test that HTML special characters in extension fields are escaped
    let error = ErrorWithFields::MissingConfig {
        expected_path: "<script>alert('xss')</script>".to_string(),
    };
    let html = error.to_html();
    // The path should be escaped, not rendered as a script tag
    assert!(html.contains("&lt;script&gt;alert(&#x27;xss&#x27;)&lt;/script&gt;"));
    assert!(!html.contains("<script>"));
}

#[test]
fn test_html_escapes_ampersand_and_quotes() {
    let error = ErrorWithFields::MissingConfig {
        expected_path: "path with & and \"quotes\"".to_string(),
    };
    let html = error.to_html();
    assert!(html.contains("path with &amp; and &quot;quotes&quot;"));
    assert!(!html.contains("path with & and"));
}

#[test]
fn test_html_with_interpolated_message() {
    use common::ConfigStructError;

    let error = ConfigStructError {
        port: 8080,
        config_path: "/etc/config.toml".to_string(),
    };
    let html = error.to_html();
    // Verify the message contains the interpolated port value
    assert!(
        html.contains("Configuration error: invalid port 8080"),
        "HTML message should contain interpolated port value, got: {}",
        html
    );
}