cloudevents/binding/actix/
server_response.rs

1use crate::binding::http_0_2::{Builder, Serializer};
2use crate::message::{BinaryDeserializer, Result};
3use crate::Event;
4use actix_web::http::StatusCode;
5use actix_web::{HttpRequest, HttpResponse, HttpResponseBuilder};
6use http_0_2 as http;
7
8impl Builder<HttpResponse> for HttpResponseBuilder {
9    fn header(&mut self, key: &str, value: http::header::HeaderValue) {
10        self.insert_header((key, value));
11    }
12    fn body(&mut self, bytes: Vec<u8>) -> Result<HttpResponse> {
13        Ok(HttpResponseBuilder::body(self, bytes))
14    }
15    fn finish(&mut self) -> Result<HttpResponse> {
16        Ok(HttpResponseBuilder::finish(self))
17    }
18}
19
20/// Method to fill an [`HttpResponseBuilder`] with an [`Event`].
21pub fn event_to_response<T: Builder<HttpResponse> + 'static>(
22    event: Event,
23    response: T,
24) -> std::result::Result<HttpResponse, actix_web::error::Error> {
25    BinaryDeserializer::deserialize_binary(event, Serializer::new(response))
26        .map_err(actix_web::error::ErrorBadRequest)
27}
28
29/// So that an actix-web handler may return an Event
30impl actix_web::Responder for Event {
31    type Body = actix_web::body::BoxBody;
32    fn respond_to(self, _: &HttpRequest) -> HttpResponse {
33        HttpResponse::build(StatusCode::OK).event(self).unwrap()
34    }
35}
36
37/// Extension Trait for [`HttpResponseBuilder`] which acts as a wrapper for the function [`event_to_response()`].
38///
39/// This trait is sealed and cannot be implemented for types outside of this crate.
40pub trait HttpResponseBuilderExt: private::Sealed {
41    /// Fill this [`HttpResponseBuilder`] with an [`Event`].
42    fn event(self, event: Event) -> std::result::Result<HttpResponse, actix_web::Error>;
43}
44
45impl HttpResponseBuilderExt for HttpResponseBuilder {
46    fn event(self, event: Event) -> std::result::Result<HttpResponse, actix_web::Error> {
47        event_to_response(event, self)
48    }
49}
50
51// Sealing the HttpResponseBuilderExt
52mod private {
53    pub trait Sealed {}
54    impl Sealed for actix_web::HttpResponseBuilder {}
55}
56
57#[cfg(test)]
58mod tests {
59    use super::*;
60
61    use crate::test::fixtures;
62    use actix_web::http::StatusCode;
63    use actix_web::test;
64
65    #[actix_rt::test]
66    async fn test_response() {
67        let input = fixtures::v10::minimal_string_extension();
68
69        let resp = HttpResponseBuilder::new(StatusCode::OK)
70            .event(input)
71            .unwrap();
72
73        assert_eq!(
74            resp.headers()
75                .get("ce-specversion")
76                .unwrap()
77                .to_str()
78                .unwrap(),
79            "1.0"
80        );
81        assert_eq!(
82            resp.headers().get("ce-id").unwrap().to_str().unwrap(),
83            "0001"
84        );
85        assert_eq!(
86            resp.headers().get("ce-type").unwrap().to_str().unwrap(),
87            "test_event.test_application"
88        );
89        assert_eq!(
90            resp.headers().get("ce-source").unwrap().to_str().unwrap(),
91            "http://localhost/"
92        );
93        assert_eq!(
94            resp.headers().get("ce-someint").unwrap().to_str().unwrap(),
95            "10"
96        );
97    }
98
99    #[actix_rt::test]
100    async fn test_response_with_full_data() {
101        let input = fixtures::v10::full_binary_json_data_string_extension();
102
103        let resp = HttpResponseBuilder::new(StatusCode::OK)
104            .event(input)
105            .unwrap();
106
107        assert_eq!(
108            resp.headers()
109                .get("ce-specversion")
110                .unwrap()
111                .to_str()
112                .unwrap(),
113            "1.0"
114        );
115        assert_eq!(
116            resp.headers().get("ce-id").unwrap().to_str().unwrap(),
117            "0001"
118        );
119        assert_eq!(
120            resp.headers().get("ce-type").unwrap().to_str().unwrap(),
121            "test_event.test_application"
122        );
123        assert_eq!(
124            resp.headers().get("ce-source").unwrap().to_str().unwrap(),
125            "http://localhost/"
126        );
127        assert_eq!(
128            resp.headers()
129                .get("content-type")
130                .unwrap()
131                .to_str()
132                .unwrap(),
133            "application/json"
134        );
135        assert_eq!(
136            resp.headers().get("ce-int_ex").unwrap().to_str().unwrap(),
137            "10"
138        );
139
140        let sr = test::TestRequest::default().to_srv_response(resp);
141        assert_eq!(fixtures::json_data_binary(), test::read_body(sr).await);
142    }
143}