graphile_worker_queries 0.1.1

Database query helpers for graphile_worker
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

pub(crate) use functions::current_trace_info;

#[cfg(any(
    all(feature = "opentelemetry_0_30", feature = "opentelemetry_0_31"),
    all(feature = "opentelemetry_0_30", feature = "opentelemetry_0_32"),
    all(feature = "opentelemetry_0_31", feature = "opentelemetry_0_32")
))]
compile_error!(
    "Only one OpenTelemetry compatibility feature can be enabled at a time: \
     opentelemetry_0_30, opentelemetry_0_31, or opentelemetry_0_32"
);

#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
pub(crate) struct TraceInfo {
    pub(crate) flags: u8,
    pub(crate) trace_id: String,
    pub(crate) span_id: String,
}

pub(crate) fn add_tracing_info_with_trace(payload: &mut serde_json::Value, trace_info: &TraceInfo) {
    match payload {
        serde_json::Value::Object(payload) => {
            payload.insert("_trace".into(), serde_json::json!(trace_info));
        }
        serde_json::Value::Array(items) => {
            for item in items {
                if item.is_object() {
                    add_tracing_info_with_trace(item, trace_info);
                }
            }
        }
        _ => {}
    }
}

#[cfg(not(any(
    feature = "opentelemetry_0_30",
    feature = "opentelemetry_0_31",
    feature = "opentelemetry_0_32"
)))]
mod functions {
    use super::TraceInfo;

    pub(crate) fn current_trace_info() -> Option<TraceInfo> {
        None
    }
}

#[cfg(any(
    feature = "opentelemetry_0_30",
    feature = "opentelemetry_0_31",
    feature = "opentelemetry_0_32"
))]
mod functions {
    #[cfg(feature = "opentelemetry_0_30")]
    use opentelemetry_30 as opentelemetry;
    #[cfg(all(not(feature = "opentelemetry_0_30"), feature = "opentelemetry_0_32"))]
    use opentelemetry_32 as opentelemetry;
    #[cfg(feature = "opentelemetry_0_30")]
    use tracing_opentelemetry_30 as tracing_opentelemetry;
    #[cfg(all(not(feature = "opentelemetry_0_30"), feature = "opentelemetry_0_32"))]
    use tracing_opentelemetry_32 as tracing_opentelemetry;

    use opentelemetry::trace::TraceContextExt;
    use tracing::Span;
    use tracing_opentelemetry::OpenTelemetrySpanExt;

    use super::TraceInfo;

    pub(crate) fn current_trace_info() -> Option<TraceInfo> {
        let context = Span::current().context();
        let span = context.span();
        let span_context = span.span_context();
        if !span_context.is_valid() {
            return None;
        }

        Some(TraceInfo {
            flags: span_context.trace_flags().to_u8(),
            trace_id: span_context.trace_id().to_string(),
            span_id: span_context.span_id().to_string(),
        })
    }
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use super::{add_tracing_info_with_trace, TraceInfo};

    fn trace_info() -> TraceInfo {
        TraceInfo {
            flags: 1,
            trace_id: "4bf92f3577b34da6a3ce929d0e0e4736".to_string(),
            span_id: "00f067aa0ba902b7".to_string(),
        }
    }

    #[test]
    fn adds_trace_to_object_payload() {
        let trace_info = trace_info();
        let mut payload = json!({ "value": 1 });

        add_tracing_info_with_trace(&mut payload, &trace_info);

        assert_eq!(payload["_trace"], json!(trace_info));
    }

    #[test]
    fn overwrites_existing_trace_payload() {
        let trace_info = trace_info();
        let mut payload = json!({
            "value": 1,
            "_trace": {
                "flags": 0,
                "trace_id": "old",
                "span_id": "old"
            }
        });

        add_tracing_info_with_trace(&mut payload, &trace_info);

        assert_eq!(payload["_trace"], json!(trace_info));
    }

    #[test]
    fn adds_trace_to_object_array_items_only() {
        let trace_info = trace_info();
        let mut payload = json!([
            { "value": 1 },
            "skip",
            null,
            { "value": 2 }
        ]);

        add_tracing_info_with_trace(&mut payload, &trace_info);

        assert_eq!(payload[0]["_trace"], json!(trace_info));
        assert!(payload[1].get("_trace").is_none());
        assert!(payload[2].get("_trace").is_none());
        assert_eq!(payload[3]["_trace"], json!(trace_info));
    }

    #[test]
    fn leaves_scalar_payload_unchanged() {
        let trace_info = trace_info();
        let mut payload = json!("value");

        add_tracing_info_with_trace(&mut payload, &trace_info);

        assert_eq!(payload, json!("value"));
    }
}