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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
use std::cell::RefCell;
use std::io::IsTerminal;
use std::sync::Arc;

use opentelemetry::trace::TracerProvider as _;
use tracing_subscriber::EnvFilter;

/// Errors that can occur during telemetry initialization.
#[derive(Debug, thiserror::Error, miette::Diagnostic)]
pub enum Error {
    #[error("invalid log filter")]
    Filter(#[from] tracing_subscriber::filter::FromEnvError),

    #[error(transparent)]
    Secret(#[from] crate::secret::Error),
}

pub type Result<T> = std::result::Result<T, Error>;

/// Sentry configuration extracted from the global config.
#[derive(serde::Deserialize, Debug, Clone)]
pub struct SentryConfig {
    pub dsn: crate::secret::SecretString,
}

use tracing_subscriber::Layer;
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::util::SubscriberInitExt;

thread_local! {
    static MIETTE_RENDER: RefCell<Option<String>> = const { RefCell::new(None) };
}

type RenderFn = Box<dyn (Fn(&(dyn std::error::Error + 'static)) -> Option<String>) + Send + Sync>;

/// A [`tracing_subscriber::Layer`] that intercepts `record_error` calls,
/// renders the error as a naratable miette diagnostic, and stashes the
/// result in a thread-local for [`before_send`] to attach to the Sentry event.
///
/// Register concrete error types with [`MietteLayer::with_type`]. The layer
/// walks the full source chain at each registered type, so transparent wrapper
/// errors don't need separate registration — registering the outermost type is
/// sufficient when it carries `#[diagnostic(transparent)]`.
///
/// # Sentry data scrubbing
///
/// The rendering arrives in Sentry as `extra["diagnostic"]`. For most
/// errors this is fine, but the miette `NarratableReportHandler` renders
/// source snippets inline: if a CI pipeline error references a
/// `(secret …)` call in `ci.fnl`, Sentry's data-scrubber replaces the
/// entire value with `"[Filtered]"`. Errors without source spans (e.g.
/// mirror push failures) are unaffected. A fuller fix would move the
/// rendering into the exception value or send it as an attachment.
///
/// # Layer ordering
///
/// Register this layer **before** `sentry_tracing::layer()` in the `.with()`
/// chain. `tracing_subscriber::Layered::on_event` dispatches inner-first, so
/// the layer added earlier fires first — and this layer must set the
/// thread-local before sentry-tracing's `on_event` calls `capture_event`
/// (which invokes `before_send` synchronously).
///
/// ```ignore
/// tracing_subscriber::registry()
///     .with(miette_layer)              // fires first — sets thread-local
///     .with(sentry_tracing::layer())   // fires next — capture_event reads it
///     .with(fmt_layer)
///     .with(filter)
///     .init();
/// ```
pub struct MietteLayer {
    renderers: Arc<Vec<RenderFn>>,
}

impl Default for MietteLayer {
    fn default() -> Self {
        Self::new()
    }
}

impl MietteLayer {
    pub fn new() -> Self {
        Self {
            renderers: Arc::new(Vec::new()),
        }
    }

    /// Register a concrete error type for miette rendering.
    ///
    /// When an error field is recorded via `record_error`, the layer tries
    /// `downcast_ref::<T>` at each level of the source chain. The first match
    /// is rendered with [`miette::NarratableReportHandler`] and stashed in the
    /// thread-local for [`before_send`] to attach.
    pub fn with_type<T>(mut self) -> Self
    where
        T: miette::Diagnostic + 'static,
    {
        Arc::get_mut(&mut self.renderers)
            .expect("no other Arc refs at construction time")
            .push(Box::new(|err: &(dyn std::error::Error + 'static)| {
                let mut cur: Option<&(dyn std::error::Error + 'static)> = Some(err);
                while let Some(e) = cur {
                    if let Some(diag) = e.downcast_ref::<T>() {
                        let mut buf = String::new();
                        if miette::NarratableReportHandler::new()
                            .render_report(&mut buf, diag)
                            .is_ok()
                            && !buf.trim().is_empty()
                        {
                            return Some(buf);
                        }
                    }
                    cur = e.source();
                }
                None
            }));
        self
    }

    fn try_render(&self, err: &(dyn std::error::Error + 'static)) -> Option<String> {
        self.renderers.iter().find_map(|r| r(err))
    }
}

struct ErrorVisitor<'a> {
    layer: &'a MietteLayer,
}

impl tracing::field::Visit for ErrorVisitor<'_> {
    fn record_error(
        &mut self,
        _field: &tracing::field::Field,
        value: &(dyn std::error::Error + 'static),
    ) {
        if let Some(rendered) = self.layer.try_render(value) {
            MIETTE_RENDER.with(|cell| *cell.borrow_mut() = Some(rendered));
        }
    }

    fn record_debug(&mut self, _: &tracing::field::Field, _: &dyn std::fmt::Debug) {}
}

impl<S: tracing::Subscriber> tracing_subscriber::Layer<S> for MietteLayer {
    fn on_event(
        &self,
        event: &tracing::Event<'_>,
        _ctx: tracing_subscriber::layer::Context<'_, S>,
    ) {
        // Clear stale data first — handles the case where a previous error
        // was not captured by Sentry (e.g. a WARN that becomes a breadcrumb
        // rather than an event, so before_send never fires to clear it).
        MIETTE_RENDER.with(|cell| *cell.borrow_mut() = None);

        if *event.metadata().level() > tracing::Level::WARN {
            return;
        }

        let mut visitor = ErrorVisitor { layer: self };
        event.record(&mut visitor);
    }
}

/// Sentry `before_send` hook: reads the thread-local miette rendering and
/// attaches it to `extra["diagnostic"]` before the event is sent.
///
/// Install at Sentry init time:
///
/// ```ignore
/// sentry::init((dsn, sentry::ClientOptions {
///     before_send: Some(std::sync::Arc::new(quire_telemetry::before_send)),
///     ..Default::default()
/// }));
/// ```
///
/// The hook consumes the thread-local so each event gets at most one attachment
/// and stale data from un-captured events is cleaned up automatically.
pub fn before_send(
    mut event: sentry::protocol::Event<'static>,
) -> Option<sentry::protocol::Event<'static>> {
    if let Some(rendered) = MIETTE_RENDER.with(|cell| cell.borrow_mut().take()) {
        event
            .extra
            .insert("diagnostic".into(), serde_json::Value::String(rendered));
    }
    Some(event)
}

/// How the stderr fmt layer formats events.
pub enum FmtMode {
    /// Human-readable text on stderr.
    Plain,
    /// Plain text when stderr is a TTY, JSON otherwise — so a console user
    /// gets a readable stream while a log collector capturing the pipe gets
    /// structured output.
    AutoJson,
}

/// Common Sentry [`ClientOptions`] with the [`before_send`] hook pre-wired
/// to attach miette renderings.
///
/// [`ClientOptions`]: sentry::ClientOptions
pub fn sentry_client_options(release: &'static str) -> sentry::ClientOptions {
    sentry::ClientOptions {
        release: Some(release.into()),
        before_send: Some(std::sync::Arc::new(before_send)),
        ..Default::default()
    }
}

/// Returned by `init_telemetry`; shuts down both tracing and Sentry on drop.
///
/// Field order matters: `provider` is dropped first (flushing OTEL spans
/// through the Sentry client), then `sentry` is dropped (flushing events
/// to the Sentry server).
#[allow(dead_code)]
pub struct TelemetryGuard {
    provider: opentelemetry_sdk::trace::SdkTracerProvider,
    sentry: Option<sentry::ClientInitGuard>,
}

/// Initialize both tracing and Sentry.
///
/// Sets up the global tracing subscriber (OTEL + stderr fmt) and, if a
/// Sentry config is provided, initializes the Sentry client.
pub fn init_telemetry(
    miette_layer: MietteLayer,
    fmt_mode: FmtMode,
    sentry_config: Option<&SentryConfig>,
    release: &'static str,
) -> Result<TelemetryGuard> {
    // Build the tracing subscriber first (same as init_tracing).
    let filter = EnvFilter::builder().with_env_var("QUIRE_LOG").from_env()?;
    let provider = opentelemetry_sdk::trace::SdkTracerProvider::builder()
        .with_span_processor(sentry_opentelemetry::SentrySpanProcessor::new())
        .build();
    let tracer = provider.tracer("quire");

    let layer = tracing_subscriber::fmt::layer().with_writer(std::io::stderr);
    let fmt_layer = match fmt_mode {
        FmtMode::Plain => layer.boxed(),
        FmtMode::AutoJson => {
            if std::io::stderr().is_terminal() {
                layer.boxed()
            } else {
                layer.json().boxed()
            }
        }
    };

    opentelemetry::global::set_text_map_propagator(
        opentelemetry_sdk::propagation::TraceContextPropagator::new(),
    );
    opentelemetry::global::set_tracer_provider(provider.clone());

    tracing_subscriber::registry()
        .with(miette_layer)
        .with(sentry_tracing::layer())
        .with(tracing_opentelemetry::layer().with_tracer(tracer))
        .with(fmt_layer)
        .with(filter)
        .init();

    let sentry = match sentry_config {
        Some(config) => {
            let dsn = config.dsn.reveal()?;
            Some(sentry::init((dsn, sentry_client_options(release))))
        }
        None => None,
    };

    Ok(TelemetryGuard { provider, sentry })
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Mutex;

    #[derive(Debug, thiserror::Error, miette::Diagnostic)]
    #[error("outer message")]
    struct TestDiag {
        #[help]
        help: String,
    }

    /// Reads the thread-local in its `on_event` to simulate what
    /// sentry-tracing's layer does (capture_event → before_send reads the
    /// thread-local). Lets us verify that MietteLayer fires *before* this
    /// layer in the chain.
    struct CaptureLayer {
        seen: Arc<Mutex<Option<String>>>,
    }

    impl<S: tracing::Subscriber> tracing_subscriber::Layer<S> for CaptureLayer {
        fn on_event(
            &self,
            _event: &tracing::Event<'_>,
            _ctx: tracing_subscriber::layer::Context<'_, S>,
        ) {
            MIETTE_RENDER.with(|cell| {
                if let Some(v) = cell.borrow().as_ref() {
                    *self.seen.lock().unwrap() = Some(v.clone());
                }
            });
        }
    }

    /// Regression test: tracing_subscriber dispatches `on_event` inner-first,
    /// so the layer registered *earlier* via `.with()` fires first. The
    /// MietteLayer must be registered before `sentry_tracing::layer()` so its
    /// thread-local is populated by the time sentry-tracing's `on_event`
    /// calls `capture_event` (and thus `before_send`).
    #[test]
    fn miette_layer_fires_before_downstream_layers() {
        let seen = Arc::new(Mutex::new(None));
        let capture = CaptureLayer { seen: seen.clone() };
        let miette = MietteLayer::new().with_type::<TestDiag>();

        let subscriber = tracing_subscriber::registry().with(miette).with(capture);

        tracing::subscriber::with_default(subscriber, || {
            let err = TestDiag {
                help: "try again".into(),
            };
            tracing::error!(error = &err as &(dyn std::error::Error + 'static), "failed",);
        });

        let rendered = seen
            .lock()
            .unwrap()
            .clone()
            .expect("downstream layer should have observed the rendered diagnostic");
        assert!(
            rendered.contains("outer message"),
            "rendering should include the diagnostic message: {rendered}"
        );
    }
}