diagweave 0.1.0

Core runtime and macros re-export for diagweave error algebra and report diagweaveing.
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

#[path = "json/attachment.rs"]
mod attachment;
#[path = "json/helpers.rs"]
mod helpers;
#[path = "json/report.rs"]
mod report;
#[cfg(feature = "trace")]
#[path = "json/trace.rs"]
mod trace;

use core::error::Error;
use core::fmt::{self, Formatter, Write};

use crate::report::{Report, SeverityState};

use super::REPORT_JSON_SCHEMA_VERSION;
use super::ReportRenderOptions;

pub(super) use super::filtered_frames;
pub(super) use helpers::{
    close_array, close_object, write_array_item_prefix, write_error_code, write_indent,
    write_json_display, write_json_string, write_object_field,
};
pub(super) fn write_json_report<E, State>(
    report: &Report<E, State>,
    options: ReportRenderOptions,
    f: &mut Formatter<'_>,
) -> fmt::Result
where
    E: Error,
    State: SeverityState,
{
    let pretty = options.json_pretty;
    let mut first = true;
    let section_flags = calc_section_flags(report);

    f.write_char('{')?;
    write_object_field(f, pretty, 0, &mut first, "schema_version", |f| {
        write_json_string(f, REPORT_JSON_SCHEMA_VERSION)
    })?;
    write_object_field(f, pretty, 0, &mut first, "error", |f| {
        report::write_error_object(f, pretty, 1, report.inner())
    })?;
    if options.show_governance_section
        && (options.show_empty_sections || section_flags.has_metadata)
    {
        write_object_field(f, pretty, 0, &mut first, "metadata", |f| {
            report::write_metadata_object(f, pretty, 1, report)
        })?;
    }
    if (options.show_stack_trace_section || options.show_cause_chains_section)
        && (options.show_empty_sections || section_flags.has_diag_bag)
    {
        write_object_field(f, pretty, 0, &mut first, "diagnostic_bag", |f| {
            report::write_diag_bag(f, pretty, 1, report, options)
        })?;
    }
    #[cfg(feature = "trace")]
    if options.show_trace_section && (options.show_empty_sections || !report.trace().is_empty()) {
        write_object_field(f, pretty, 0, &mut first, "trace", |f| {
            report::write_trace_object(f, pretty, 1, report, options)
        })?;
    }
    #[cfg(not(feature = "trace"))]
    if options.show_trace_section && options.show_empty_sections {
        write_object_field(f, pretty, 0, &mut first, "trace", |f| f.write_str("{}"))?;
    }
    if options.show_context_section && (options.show_empty_sections || section_flags.has_context) {
        write_object_field(f, pretty, 0, &mut first, "context", |f| {
            attachment::write_context_object(f, pretty, 1, report)
        })?;
    }
    if options.show_context_section && (options.show_empty_sections || section_flags.has_system) {
        write_object_field(f, pretty, 0, &mut first, "system", |f| {
            attachment::write_system_object(f, pretty, 1, report)
        })?;
    }
    if options.show_attachments_section
        && (options.show_empty_sections || section_flags.has_attachments)
    {
        write_object_field(f, pretty, 0, &mut first, "attachments", |f| {
            attachment::write_attachments_array(f, pretty, 1, report)
        })?;
    }

    if pretty && !first {
        f.write_char('\n')?;
        write_indent(f, 0)?;
    }
    f.write_char('}')
}

struct JsonSectionFlags {
    has_metadata: bool,
    has_context: bool,
    has_system: bool,
    has_attachments: bool,
    has_diag_bag: bool,
}

fn calc_section_flags<E, State>(report: &Report<E, State>) -> JsonSectionFlags
where
    E: Error,
    State: SeverityState,
{
    let metadata = report.metadata();
    let has_metadata = metadata.error_code().is_some()
        || report.severity().is_some()
        || metadata.category().is_some()
        || metadata.retryable().is_some();
    let has_context = !report.context().is_empty();
    let has_system = !report.system().is_empty();
    let has_attachments = !report.attachments().is_empty();
    let has_diag_bag = has_stack_trace(report)
        || has_display_causes(report)
        || has_origin_source_errors(report)
        || has_diag_source_errors(report);
    JsonSectionFlags {
        has_metadata,
        has_context,
        has_system,
        has_attachments,
        has_diag_bag,
    }
}

fn has_stack_trace<E, State>(report: &Report<E, State>) -> bool
where
    E: Error,
    State: SeverityState,
{
    report.stack_trace().is_some()
}

fn has_display_causes<E, State>(report: &Report<E, State>) -> bool
where
    E: Error,
    State: SeverityState,
{
    report.display_causes_chain().is_some()
}

fn has_origin_source_errors<E, State>(report: &Report<E, State>) -> bool
where
    E: Error,
    State: SeverityState,
{
    report.origin_src_err_chain().is_some() || report.inner().source().is_some()
}

fn has_diag_source_errors<E, State>(report: &Report<E, State>) -> bool
where
    E: Error,
    State: SeverityState,
{
    report.diag_src_err_chain().is_some()
}