apollo-router 2.14.0-rc.2

A configurable, high-performance routing runtime for Apollo Federation 🚀
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

//! HTTP response builder utilities for diagnostics plugin
//!
//! This module provides utilities to build consistent HTTP responses
//! with standardized headers and error handling.

use axum::body::Body;
use http::Response;
use http::StatusCode;
use http::header;
use serde::Serialize;

use super::DiagnosticsError;
use super::DiagnosticsResult;

/// Cache control settings for different types of responses
#[derive(Debug, Clone)]
pub(super) enum CacheControl {
    /// No cache headers for dynamic content
    NoCache,
}

impl CacheControl {
    /// Get the cache-control header value
    fn header_value(&self) -> &'static str {
        match self {
            Self::NoCache => "no-cache, no-store, must-revalidate",
        }
    }

    /// Get additional cache-related headers for no-cache responses
    fn additional_headers(&self) -> Vec<(&'static str, &'static str)> {
        match self {
            Self::NoCache => vec![("pragma", "no-cache"), ("expires", "0")],
        }
    }
}

/// Builder for creating standardized HTTP responses
pub(super) struct ResponseBuilder;

impl ResponseBuilder {
    /// Create a JSON response with standard headers
    pub(super) fn json_response<T: Serialize>(
        status: StatusCode,
        data: &T,
        cache_control: CacheControl,
    ) -> DiagnosticsResult<Response<Body>> {
        let body_bytes = serde_json::to_vec(data).map_err(DiagnosticsError::Json)?;

        let mut response_builder = Response::builder()
            .status(status)
            .header(header::CONTENT_TYPE, "application/json")
            .header(header::CACHE_CONTROL, cache_control.header_value());

        // Add additional cache headers if needed
        for (name, value) in cache_control.additional_headers() {
            response_builder = response_builder.header(name, value);
        }

        response_builder
            .body(Body::from(body_bytes))
            .map_err(DiagnosticsError::Http)
    }

    /// Create a binary response for file downloads
    pub(super) fn binary_response(
        status: StatusCode,
        content_type: &str,
        body_bytes: Vec<u8>,
        filename: Option<&str>,
        cache_control: CacheControl,
    ) -> DiagnosticsResult<Response<Body>> {
        let mut response_builder = Response::builder()
            .status(status)
            .header(header::CONTENT_TYPE, content_type)
            .header(header::CONTENT_LENGTH, body_bytes.len().to_string())
            .header(header::CACHE_CONTROL, cache_control.header_value());

        // Add content-disposition header if filename is provided
        if let Some(filename) = filename {
            response_builder = response_builder.header(
                header::CONTENT_DISPOSITION,
                format!("attachment; filename=\"{}\"", filename),
            );
        }

        // Add additional cache headers if needed
        for (name, value) in cache_control.additional_headers() {
            response_builder = response_builder.header(name, value);
        }

        response_builder
            .body(Body::from(body_bytes))
            .map_err(DiagnosticsError::Http)
    }
}

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

    use super::*;

    #[tokio::test]
    async fn test_json_response_ok_status() {
        let data = json!({"status": "ok", "message": "test"});

        let response =
            ResponseBuilder::json_response(StatusCode::OK, &data, CacheControl::NoCache).unwrap();

        assert_eq!(response.status(), StatusCode::OK);
        assert_eq!(
            response.headers().get(header::CONTENT_TYPE).unwrap(),
            "application/json"
        );
        assert_eq!(
            response.headers().get(header::CACHE_CONTROL).unwrap(),
            "no-cache, no-store, must-revalidate"
        );
        assert_eq!(response.headers().get("pragma").unwrap(), "no-cache");
        assert_eq!(response.headers().get("expires").unwrap(), "0");
    }

    #[tokio::test]
    async fn test_json_response_body_content() {
        let data = json!({"key": "value", "number": 42});

        let response =
            ResponseBuilder::json_response(StatusCode::OK, &data, CacheControl::NoCache).unwrap();

        let body_bytes = response.into_body().collect().await.unwrap().to_bytes();
        let body_json: serde_json::Value = serde_json::from_slice(&body_bytes).unwrap();

        assert_eq!(body_json["key"], "value");
        assert_eq!(body_json["number"], 42);
    }

    #[tokio::test]
    async fn test_binary_response_with_filename() {
        let data = b"binary data content".to_vec();

        let response = ResponseBuilder::binary_response(
            StatusCode::OK,
            "application/octet-stream",
            data.clone(),
            Some("test.bin"),
            CacheControl::NoCache,
        )
        .unwrap();

        assert_eq!(response.status(), StatusCode::OK);
        assert_eq!(
            response.headers().get(header::CONTENT_TYPE).unwrap(),
            "application/octet-stream"
        );
        assert_eq!(
            response.headers().get(header::CONTENT_LENGTH).unwrap(),
            &data.len().to_string()
        );
        assert_eq!(
            response.headers().get(header::CONTENT_DISPOSITION).unwrap(),
            "attachment; filename=\"test.bin\""
        );
    }

    #[tokio::test]
    async fn test_binary_response_without_filename() {
        let data = b"some data".to_vec();

        let response = ResponseBuilder::binary_response(
            StatusCode::OK,
            "application/octet-stream",
            data.clone(),
            None,
            CacheControl::NoCache,
        )
        .unwrap();

        assert_eq!(response.status(), StatusCode::OK);
        assert!(
            response
                .headers()
                .get(header::CONTENT_DISPOSITION)
                .is_none(),
            "Content-Disposition header should not be present when filename is None"
        );
    }

    #[tokio::test]
    async fn test_binary_response_body_content() {
        let original_data = b"This is binary content with \x00 null bytes".to_vec();

        let response = ResponseBuilder::binary_response(
            StatusCode::OK,
            "application/octet-stream",
            original_data.clone(),
            Some("test.bin"),
            CacheControl::NoCache,
        )
        .unwrap();

        let body_bytes = response.into_body().collect().await.unwrap().to_bytes();

        assert_eq!(
            body_bytes.as_ref(),
            original_data.as_slice(),
            "Response body should exactly match input data"
        );
    }

    #[tokio::test]
    async fn test_binary_response_empty_data() {
        let data = Vec::new();

        let response = ResponseBuilder::binary_response(
            StatusCode::OK,
            "application/octet-stream",
            data,
            Some("empty.bin"),
            CacheControl::NoCache,
        )
        .unwrap();

        assert_eq!(response.headers().get(header::CONTENT_LENGTH).unwrap(), "0");

        let body_bytes = response.into_body().collect().await.unwrap().to_bytes();
        assert!(body_bytes.is_empty());
    }
}