relay_event_schema/processor/
traits.rs

1// This module only defines traits, every parameter is used by definition
2#![allow(unused_variables)]
3
4use std::fmt::Debug;
5
6use relay_protocol::{FromValue, IntoValue, Meta};
7
8use crate::processor::{process_value, ProcessingState, ValueType};
9
10/// Used to indicate how to handle an annotated value in a callback.
11#[must_use = "This `ProcessingAction` must be handled by `Annotated::apply`"]
12#[derive(Copy, Clone, Debug, PartialEq, Eq, thiserror::Error)]
13pub enum ProcessingAction {
14    /// Discards the value entirely.
15    #[error("value should be hard-deleted (unreachable, should not surface as error!)")]
16    DeleteValueHard,
17
18    /// Discards the value and moves it into meta's `original_value`.
19    #[error("value should be hard-deleted (unreachable, should not surface as error!)")]
20    DeleteValueSoft,
21
22    /// The event is invalid (needs to bubble up)
23    #[error("invalid transaction event: {0}")]
24    InvalidTransaction(&'static str),
25}
26
27/// The result of running a processor on a value implementing `ProcessValue`.
28pub type ProcessingResult = Result<(), ProcessingAction>;
29
30macro_rules! process_method {
31    ($name: ident, $ty:ident $(::$path:ident)*) => {
32        process_method!($name, $ty $(::$path)* <>);
33    };
34
35    ($name: ident, $ty:ident $(::$path:ident)* < $($param:ident),* > $(, $param_req_key:ident : $param_req_trait:path)*) => {
36        #[inline]
37        fn $name<$($param),*>(
38            &mut self,
39            value: &mut $ty $(::$path)* <$($param),*>,
40            meta: &mut Meta,
41            state: &ProcessingState<'_>,
42        ) -> ProcessingResult
43        where
44            $($param: ProcessValue),*
45            $(, $param_req_key : $param_req_trait)*
46        {
47            value.process_child_values(self, state)?;
48            Ok(())
49        }
50    };
51}
52
53/// A trait for processing processable values.
54pub trait Processor: Sized {
55    #[inline]
56    fn before_process<T: ProcessValue>(
57        &mut self,
58        value: Option<&T>,
59        meta: &mut Meta,
60        state: &ProcessingState<'_>,
61    ) -> ProcessingResult {
62        Ok(())
63    }
64
65    #[inline]
66    fn after_process<T: ProcessValue>(
67        &mut self,
68        value: Option<&T>,
69        meta: &mut Meta,
70        state: &ProcessingState<'_>,
71    ) -> ProcessingResult {
72        Ok(())
73    }
74
75    process_method!(process_string, String);
76    process_method!(process_u64, u64);
77    process_method!(process_i64, i64);
78    process_method!(process_f64, f64);
79    process_method!(process_bool, bool);
80
81    process_method!(process_value, relay_protocol::Value);
82    process_method!(process_array, relay_protocol::Array<T>);
83    process_method!(process_object, relay_protocol::Object<T>);
84
85    process_method!(
86        process_pairlist,
87        crate::protocol::PairList<T>,
88        T: crate::protocol::AsPair
89    );
90    process_method!(process_values, crate::protocol::Values<T>);
91    process_method!(process_timestamp, crate::protocol::Timestamp);
92
93    process_method!(process_event, crate::protocol::Event);
94    process_method!(process_replay, crate::protocol::Replay);
95    process_method!(process_exception, crate::protocol::Exception);
96    process_method!(process_raw_stacktrace, crate::protocol::RawStacktrace);
97    process_method!(process_stacktrace, crate::protocol::Stacktrace);
98    process_method!(process_frame, crate::protocol::Frame);
99    process_method!(process_request, crate::protocol::Request);
100    process_method!(process_user, crate::protocol::User);
101    process_method!(process_client_sdk_info, crate::protocol::ClientSdkInfo);
102    process_method!(process_debug_meta, crate::protocol::DebugMeta);
103    process_method!(process_debug_image, crate::protocol::DebugImage);
104    process_method!(process_geo, crate::protocol::Geo);
105    process_method!(process_logentry, crate::protocol::LogEntry);
106    process_method!(process_thread, crate::protocol::Thread);
107    process_method!(process_context, crate::protocol::Context);
108    process_method!(process_breadcrumb, crate::protocol::Breadcrumb);
109    process_method!(process_template_info, crate::protocol::TemplateInfo);
110    process_method!(process_header_name, crate::protocol::HeaderName);
111    process_method!(process_ourlog, crate::protocol::OurLog);
112    process_method!(process_span, crate::protocol::Span);
113    process_method!(process_trace_context, crate::protocol::TraceContext);
114    process_method!(process_native_image_path, crate::protocol::NativeImagePath);
115    process_method!(process_contexts, crate::protocol::Contexts);
116
117    fn process_other(
118        &mut self,
119        other: &mut relay_protocol::Object<relay_protocol::Value>,
120        state: &ProcessingState<'_>,
121    ) -> ProcessingResult {
122        for (key, value) in other {
123            process_value(
124                value,
125                self,
126                &state.enter_borrowed(
127                    key.as_str(),
128                    state.inner_attrs(),
129                    ValueType::for_field(value),
130                ),
131            )?;
132        }
133
134        Ok(())
135    }
136}
137
138#[doc(inline)]
139pub use enumset::{enum_set, EnumSet};
140
141/// A recursively processable value.
142pub trait ProcessValue: FromValue + IntoValue + Debug + Clone {
143    /// Returns the type of the value.
144    #[inline]
145    fn value_type(&self) -> EnumSet<ValueType> {
146        EnumSet::empty()
147    }
148
149    /// Executes a processor on this value.
150    #[inline]
151    fn process_value<P>(
152        &mut self,
153        meta: &mut Meta,
154        processor: &mut P,
155        state: &ProcessingState<'_>,
156    ) -> ProcessingResult
157    where
158        P: Processor,
159    {
160        self.process_child_values(processor, state)
161    }
162
163    /// Recurses into children of this value.
164    #[inline]
165    fn process_child_values<P>(
166        &mut self,
167        processor: &mut P,
168        state: &ProcessingState<'_>,
169    ) -> ProcessingResult
170    where
171        P: Processor,
172    {
173        Ok(())
174    }
175}
176
177pub use relay_event_derive::ProcessValue;
relay_event_schema/processor/traits.rs

relay_event_schema/processor/
traits.rs
