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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::{
cell::RefCell,
fmt,
path::{Path, PathBuf},
rc::Rc,
};
use qlog::{
streamer::QlogStreamer, CommonFields, Configuration, TraceSeq, VantagePoint, VantagePointType,
};
use crate::Role;
#[allow(clippy::module_name_repetitions)]
#[derive(Debug, Clone, Default)]
pub struct NeqoQlog {
inner: Rc<RefCell<Option<NeqoQlogShared>>>,
}
pub struct NeqoQlogShared {
qlog_path: PathBuf,
streamer: QlogStreamer,
}
impl NeqoQlog {
/// Create an enabled `NeqoQlog` configuration.
///
/// # Errors
///
/// Will return `qlog::Error` if cannot write to the new log.
pub fn enabled(
mut streamer: QlogStreamer,
qlog_path: impl AsRef<Path>,
) -> Result<Self, qlog::Error> {
streamer.start_log()?;
Ok(Self {
inner: Rc::new(RefCell::new(Some(NeqoQlogShared {
streamer,
qlog_path: qlog_path.as_ref().to_owned(),
}))),
})
}
#[must_use]
pub fn inner(&self) -> Rc<RefCell<Option<NeqoQlogShared>>> {
Rc::clone(&self.inner)
}
/// Create a disabled `NeqoQlog` configuration.
#[must_use]
pub fn disabled() -> Self {
Self::default()
}
/// If logging enabled, closure may generate an event to be logged.
pub fn add_event<F>(&mut self, f: F)
where
F: FnOnce() -> Option<qlog::events::Event>,
{
self.add_event_with_stream(|s| {
if let Some(evt) = f() {
s.add_event(evt)?;
}
Ok(())
});
}
/// If logging enabled, closure may generate an event to be logged.
pub fn add_event_data<F>(&mut self, f: F)
where
F: FnOnce() -> Option<qlog::events::EventData>,
{
self.add_event_with_stream(|s| {
if let Some(ev_data) = f() {
s.add_event_data_now(ev_data)?;
}
Ok(())
});
}
/// If logging enabled, closure is given the Qlog stream to write events and
/// frames to.
pub fn add_event_with_stream<F>(&mut self, f: F)
where
F: FnOnce(&mut QlogStreamer) -> Result<(), qlog::Error>,
{
if let Some(inner) = self.inner.borrow_mut().as_mut() {
if let Err(e) = f(&mut inner.streamer) {
crate::do_log!(
::log::Level::Error,
"Qlog event generation failed with error {}; closing qlog.",
e
);
*self.inner.borrow_mut() = None;
}
}
}
}
impl fmt::Debug for NeqoQlogShared {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "NeqoQlog writing to {}", self.qlog_path.display())
}
}
impl Drop for NeqoQlogShared {
fn drop(&mut self) {
if let Err(e) = self.streamer.finish_log() {
crate::do_log!(::log::Level::Error, "Error dropping NeqoQlog: {}", e);
}
}
}
#[must_use]
pub fn new_trace(role: Role) -> qlog::TraceSeq {
TraceSeq {
vantage_point: VantagePoint {
name: Some(format!("neqo-{role}")),
ty: match role {
Role::Client => VantagePointType::Client,
Role::Server => VantagePointType::Server,
},
flow: None,
},
title: Some(format!("neqo-{role} trace")),
description: Some("Example qlog trace description".to_string()),
configuration: Some(Configuration {
time_offset: Some(0.0),
original_uris: None,
}),
common_fields: Some(CommonFields {
group_id: None,
protocol_type: None,
reference_time: {
// It is better to allow this than deal with a conversion from i64 to f64.
// We can't do the obvious two-step conversion with f64::from(i32::try_from(...)),
// because that overflows earlier than is ideal. This should be fine for a while.
#[allow(clippy::cast_precision_loss)]
Some(time::OffsetDateTime::now_utc().unix_timestamp() as f64)
},
time_format: Some("relative".to_string()),
}),
}
}
#[cfg(test)]
mod test {
use qlog::events::Event;
use test_fixture::EXPECTED_LOG_HEADER;
const EV_DATA: qlog::events::EventData =
qlog::events::EventData::SpinBitUpdated(qlog::events::connectivity::SpinBitUpdated {
state: true,
});
const EXPECTED_LOG_EVENT: &str = concat!(
"\u{1e}",
r#"{"time":0.0,"name":"connectivity:spin_bit_updated","data":{"state":true}}"#,
"\n"
);
#[test]
fn new_neqo_qlog() {
let (_log, contents) = test_fixture::new_neqo_qlog();
assert_eq!(contents.to_string(), EXPECTED_LOG_HEADER);
}
#[test]
fn add_event() {
let (mut log, contents) = test_fixture::new_neqo_qlog();
log.add_event(|| Some(Event::with_time(1.1, EV_DATA)));
assert_eq!(
contents.to_string(),
format!(
"{EXPECTED_LOG_HEADER}{e}",
e = EXPECTED_LOG_EVENT.replace("\"time\":0.0,", "\"time\":1.1,")
)
);
}
}
|
