prima_bridge 0.30.0

A library to implement the bridge pattern
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
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383

use std::time::Duration;

use async_trait::async_trait;
use reqwest::header::{HeaderMap, HeaderName, HeaderValue};
use reqwest::multipart::Form;
use reqwest::{Method, Url};
use serde::Serialize;
use tracing::Instrument;
use uuid::Uuid;

pub use body::{Body, GraphQLBody, MultipartFile, MultipartFormFileField};
pub use request_type::{GraphQLMultipart, GraphQLRequest, Request, RestMultipart, RestRequest};

use crate::errors::{PrimaBridgeError, PrimaBridgeResult};
use crate::sealed::Sealed;
use crate::{BridgeClient, BridgeImpl, PrimaRequestBuilder, PrimaRequestBuilderInner, Response};

mod body;
mod request_type;

#[cfg(all(feature = "grpc", feature = "_any_otel_version"))]
pub mod grpc;
#[cfg(feature = "_any_otel_version")]
mod otel;

#[cfg(feature = "tracing_opentelemetry")]
use otel::otel_crates::tracing_opentelemetry::OpenTelemetrySpanExt;

pub enum RequestType {
    Rest,
    #[allow(clippy::upper_case_acronyms)]
    GraphQL,
}

#[derive(Default)]
pub enum DeliverableRequestBody {
    #[default]
    Empty,
    RawBody(Body),
    Multipart(Form),
}

/// Represents a request that is ready to be delivered to the server.
#[async_trait]
pub trait DeliverableRequest<'a>: Sized + Sealed + 'a {
    type Client: BridgeClient;

    /// sets the raw body for the request
    /// it will get delivered in the request as is.
    fn raw_body(self, body: impl Into<Body>) -> Self;

    /// sets a serializable body for the request
    fn json_body<B: Serialize>(self, body: &B) -> PrimaBridgeResult<Self>;

    /// sets request method. Defaults to GET.
    fn method(self, method: Method) -> Self;

    /// sets the destination path (relative to the url defined in the bridge) for the request
    fn to(self, path: &'a str) -> Self;

    /// ignore the status code, and parse the results even if the response has a wrong status code.
    /// This is useful when you are dealing with an api that return errors with a not 2XX status codes.
    fn ignore_status_code(self) -> Self;

    /// set request timeout
    fn set_timeout(self, timeout: Duration) -> Self;

    /// get request timeout
    fn get_timeout(&self) -> Duration;

    /// adds a new header to the request. If the header is already present, it gets overwritten.
    fn with_custom_header(mut self, name: HeaderName, value: HeaderValue) -> Self {
        self.get_custom_headers_mut().insert(name, value);
        self
    }

    /// adds a new set of headers to the request. Any header already present gets overwritten.
    fn with_custom_headers(mut self, headers: Vec<(HeaderName, HeaderValue)>) -> Self {
        self.get_custom_headers_mut().extend(headers);
        self
    }

    /// add a custom query string parameter
    fn with_query_pair(mut self, name: &'a str, value: &'a str) -> Self {
        self.get_query_pairs_mut().push((name, value));
        self
    }

    /// add a list of custom query string parameters
    fn with_query_pairs(mut self, pairs: Vec<(&'a str, &'a str)>) -> Self {
        self.get_query_pairs_mut().extend(pairs);
        self
    }

    /// returns a unique id for the request
    fn get_id(&self) -> Uuid;

    #[doc(hidden)]
    fn get_bridge(&self) -> &BridgeImpl<Self::Client>;

    #[doc(hidden)]
    fn get_path(&self) -> Option<&str>;

    #[doc(hidden)]
    fn endpoint(&self) -> Url;

    #[doc(hidden)]
    fn get_query_pairs(&self) -> &[(&'a str, &'a str)];

    #[doc(hidden)]
    fn get_query_pairs_mut(&mut self) -> &mut Vec<(&'a str, &'a str)>;

    #[doc(hidden)]
    fn get_ignore_status_code(&self) -> bool;

    #[doc(hidden)]
    fn get_method(&self) -> Method;

    #[doc(hidden)]
    fn get_custom_headers(&self) -> &HeaderMap;

    #[doc(hidden)]
    fn get_custom_headers_mut(&mut self) -> &mut HeaderMap;

    #[cfg(feature = "auth0")]
    #[doc(hidden)]
    fn get_auth0(&self) -> &Option<crate::auth0::RefreshingToken>;

    #[cfg(feature = "auth0")]
    #[doc(hidden)]
    fn get_auth0_headers(&self) -> HeaderMap {
        match self.get_auth0().as_ref().map(|auth0| auth0.token()) {
            None => HeaderMap::new(),
            Some(token) => {
                let mut header_map: HeaderMap = HeaderMap::new();
                let header_value: HeaderValue = HeaderValue::from_str(token.to_bearer().as_str())
                    // This shouldn't happen. Token must be writeable and shouldn't contain invalid characters (eg. \n)
                    .expect("Failed to create bearer header");

                header_map.append(reqwest::header::AUTHORIZATION, header_value);
                header_map
            }
        }
    }

    fn get_all_headers(&self) -> HeaderMap {
        let mut additional_headers = self.get_custom_headers().clone();
        #[cfg(feature = "_any_otel_version")]
        additional_headers.extend(self.tracing_headers());
        #[cfg(feature = "auth0")]
        additional_headers.extend(self.get_auth0_headers());
        additional_headers
    }

    #[doc(hidden)]
    fn get_request_type(&self) -> RequestType;

    #[doc(hidden)]
    fn into_body(self) -> PrimaBridgeResult<DeliverableRequestBody>;

    /// Returns the request body as a slice of bytes.
    ///
    /// This will return `None` in the following cases:
    ///
    /// - The request does not have a body
    /// - The request body is multipart form data
    /// - The request body is a stream (eg. a file) and therefore not in memory
    fn get_body(&self) -> Option<&[u8]>;

    async fn send(self) -> PrimaBridgeResult<Response> {
        let request_id = self.get_id();
        let url = self.get_url();
        let method = self.get_method();

        let client_span = tracing::info_span!(
            "prima_bridge.http.client",
            "otel.kind" = "client",
            "otel.name" = %method.as_str(),
            "http.request.method" = %method.as_str(),
            "server.address" = %url.host().map(|h| h.to_string()).unwrap_or_default(),
            "server.port" = %url.port_or_known_default().map(|p| p.to_string()).unwrap_or_default(),
            "url.full" = %strip_url_credentials(&url),
            "url.scheme" = %url.scheme(),
            request_id = %request_id
        );

        #[cfg(feature = "_any_otel_version")]
        let headers = client_span.in_scope(|| self.get_all_headers());

        #[cfg(not(feature = "_any_otel_version"))]
        let headers = self.get_all_headers();

        #[cfg(feature = "tracing_opentelemetry")]
        client_span.set_status(otel::otel_crates::opentelemetry::trace::Status::Unset);

        let request_builder = self
            .get_bridge()
            .inner_client
            .request(method, url.clone())
            .timeout(self.get_timeout())
            .header(HeaderName::from_static("x-request-id"), &request_id.to_string())
            .headers(headers);

        let result = self.send_request(request_builder).instrument(client_span.clone()).await;

        #[cfg(feature = "tracing_opentelemetry")]
        if let Err(ref reason) = result {
            client_span.set_status(otel::otel_crates::opentelemetry::trace::Status::Error {
                description: reason.to_string().into(),
            });
        }

        result
    }

    async fn send_request<T>(self, request: PrimaRequestBuilder<T>) -> PrimaBridgeResult<Response>
    where
        T: PrimaRequestBuilderInner,
    {
        let request_id = self.get_id();
        let url = self.get_url();
        let ignore_status_code = self.get_ignore_status_code();
        let request_type = self.get_request_type();

        let response = match self.into_body()? {
            DeliverableRequestBody::Empty => request,
            DeliverableRequestBody::RawBody(body) => request.body(body.inner),
            DeliverableRequestBody::Multipart(form) => request.multipart(form),
        }
        .send()
        .await?;

        let status_code = response.status();
        let span = tracing::Span::current();

        span.record("http.response.status_code", status_code.as_u16());

        // 4xx or 5xx range
        #[cfg(feature = "tracing_opentelemetry")]
        if status_code.is_client_error() || status_code.is_server_error() {
            // Don’t set the span status description if the reason can be inferred from http.response.status_code
            span.set_status(otel::otel_crates::opentelemetry::trace::Status::Error { description: "".into() });
        }

        if !ignore_status_code && !status_code.is_success() {
            return Err(PrimaBridgeError::WrongStatusCode(url.clone(), status_code));
        }

        let response_headers = response.headers().clone();
        let raw_body = response.bytes().await.map(|b| b.to_vec());
        let body = raw_body.map_err(|e| PrimaBridgeError::HttpError {
            source: e,
            url: url.clone(),
        })?;

        match request_type {
            RequestType::Rest => Ok(Response::rest(
                url.clone(),
                body,
                status_code,
                response_headers,
                request_id,
            )),
            RequestType::GraphQL => Ok(Response::graphql(
                url.clone(),
                body,
                status_code,
                response_headers,
                request_id,
            )),
        }
    }

    fn get_url(&self) -> Url {
        let mut final_endpoint = self.endpoint();
        let path = self.get_path();
        let endpoint = match path {
            Some(path) => {
                let ep = self.endpoint();

                let mut parts: Vec<&str> = ep
                    .path_segments()
                    .map_or_else(Vec::new, |ps| ps.collect())
                    .into_iter()
                    .filter(|p| p != &"")
                    .collect();
                parts.push(path);
                final_endpoint.set_path(&parts.join("/"));
                final_endpoint
            }
            _ => final_endpoint,
        };

        self.get_query_pairs().iter().fold(endpoint, |mut url, (name, value)| {
            url.query_pairs_mut().append_pair(name, value);
            url
        })
    }

    #[cfg(feature = "_any_otel_version")]
    fn tracing_headers(&self) -> HeaderMap {
        use std::collections::HashMap;

        let mut tracing_headers: HashMap<String, String> = HashMap::new();
        otel::inject_context(&mut tracing_headers);

        tracing_headers
            .iter()
            .flat_map(|(name, value)| {
                let header_name = HeaderName::from_bytes(name.as_bytes());
                let header_value = HeaderValue::from_bytes(value.as_bytes());
                match (header_name, header_value) {
                    (Ok(valid_header_name), Ok(valid_header_value)) => {
                        vec![(valid_header_name, valid_header_value)]
                    }
                    _ => vec![],
                }
            })
            .collect()
    }

    #[cfg(not(feature = "_any_otel_version"))]
    fn tracing_headers(&self) -> Vec<(HeaderName, HeaderValue)> {
        vec![]
    }
}

fn strip_url_credentials(url: &reqwest::Url) -> String {
    if url.username().is_empty() && url.password().is_none() {
        return url.as_str().to_owned();
    }

    let mut redacted = url.clone();

    let _ = redacted.set_username("");
    let _ = redacted.set_password(None);

    redacted.to_string()
}

#[cfg(test)]
mod tests {
    use super::*;
    use reqwest::Url;

    #[test]
    fn preserves_url_without_credentials() {
        let url = Url::parse("https://example.com?xx=yy#123").unwrap();

        assert_eq!(strip_url_credentials(&url), "https://example.com/?xx=yy#123");
    }

    #[test]
    fn strips_username_and_password() {
        let url = Url::parse("https://myuser:secret@example.com?xx=yy#123").unwrap();

        assert_eq!(strip_url_credentials(&url), "https://example.com/?xx=yy#123");
    }

    #[test]
    fn strips_username_without_password() {
        let url = Url::parse("https://myuser@example.com/api/v1/users").unwrap();

        assert_eq!(strip_url_credentials(&url), "https://example.com/api/v1/users");
    }

    #[test]
    fn preserves_port_path_query_and_fragment() {
        let url = Url::parse("https://user:pass@example.com:8443/api/test?q=1#frag").unwrap();

        assert_eq!(
            strip_url_credentials(&url),
            "https://example.com:8443/api/test?q=1#frag"
        );
    }

    #[test]
    fn handles_special_characters_in_credentials() {
        let url = Url::parse("https://user%40mail.com:p%40ss@example.com/path").unwrap();

        assert_eq!(strip_url_credentials(&url), "https://example.com/path");
    }
}