reqres 1.0.0

A pure Rust async HTTP client library based on Tokio with HTTP/2, connection pooling, proxy, cookie, compression, benchmarks, and comprehensive tests
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
//! # 压缩和解压缩
//!
//! 提供 gzip、deflate、brotli 压缩格式的自动解压功能。
//!
//! ## 使用示例
//!
//! ```rust
//! use reqres::Client;
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! // 启用压缩支持
//! let client = Client::builder()
//!     .enable_compression()
//!     .build()?;
//!
//! // 自动发送 Accept-Encoding 头
//! // 自动解压响应
//! let response = client.get("https://httpbin.org/gzip").await?;
//! # Ok(())
//! # }
//! ```

use bytes::Bytes;
use flate2::read::GzDecoder;
use std::io::Read;

/// 支持的压缩编码
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CompressionEncoding {
    Gzip,
    Deflate,
    Brotli,
    Identity,  // 无压缩
}

impl CompressionEncoding {
    /// 从 Content-Encoding 头解析编码
    pub fn from_header(header: &str) -> Option<Self> {
        match header.to_lowercase().trim() {
            "gzip" => Some(CompressionEncoding::Gzip),
            "deflate" => Some(CompressionEncoding::Deflate),
            "br" => Some(CompressionEncoding::Brotli),
            "identity" | "" | "none" => Some(CompressionEncoding::Identity),
            _ => None,
        }
    }

    /// 获取编码名称
    pub fn as_str(&self) -> &str {
        match self {
            CompressionEncoding::Gzip => "gzip",
            CompressionEncoding::Deflate => "deflate",
            CompressionEncoding::Brotli => "br",
            CompressionEncoding::Identity => "identity",
        }
    }
}

/// 解压缩错误
#[derive(Debug, thiserror::Error)]
pub enum DecompressionError {
    #[error("Unsupported compression encoding: {0}")]
    Unsupported(String),

    #[error("Decompression failed: {0}")]
    Failed(String),
}

/// 解压缩器
pub struct Decompressor;

impl Decompressor {
    /// 解压缩数据
    pub fn decompress(data: Bytes, encoding: CompressionEncoding) -> Result<Bytes, DecompressionError> {
        match encoding {
            CompressionEncoding::Gzip => {
                Self::decompress_gzip(data)
            }
            CompressionEncoding::Deflate => {
                Self::decompress_deflate(data)
            }
            CompressionEncoding::Brotli => {
                Self::decompress_brotli(data)
            }
            CompressionEncoding::Identity => {
                Ok(data)  // 无压缩,直接返回
            }
        }
    }

    /// 解压缩 Gzip 数据
    fn decompress_gzip(data: Bytes) -> Result<Bytes, DecompressionError> {
        let mut decoder = GzDecoder::new(&*data);
        let mut decompressed = Vec::new();

        decoder
            .read_to_end(&mut decompressed)
            .map_err(|e| DecompressionError::Failed(format!("Gzip: {}", e)))?;

        Ok(Bytes::from(decompressed))
    }

    /// 解压缩 Deflate 数据
    fn decompress_deflate(data: Bytes) -> Result<Bytes, DecompressionError> {
        // Deflate 是 zlib 压缩格式
        use flate2::read::ZlibDecoder;
        
        let mut decoder = ZlibDecoder::new(&*data);
        let mut decompressed = Vec::new();

        decoder
            .read_to_end(&mut decompressed)
            .map_err(|e| DecompressionError::Failed(format!("Deflate: {}", e)))?;

        Ok(Bytes::from(decompressed))
    }

    /// 解压缩 Brotli 数据
    fn decompress_brotli(data: Bytes) -> Result<Bytes, DecompressionError> {
        // 使用 brotli 解压缩
        let mut decompressed = Vec::new();
        let mut reader = brotli::Decompressor::new(&*data, 4096);

        reader
            .read_to_end(&mut decompressed)
            .map_err(|e| DecompressionError::Failed(format!("Brotli: {}", e)))?;

        Ok(Bytes::from(decompressed))
    }

    /// 自动检测并解压缩
    pub fn auto_decompress(data: Bytes, content_encoding: Option<&str>) -> Result<Bytes, DecompressionError> {
        match content_encoding {
            Some(encoding) => {
                match CompressionEncoding::from_header(encoding) {
                    Some(enc) => Self::decompress(data, enc),
                    None => Ok(data),  // 不支持的编码,返回原始数据
                }
            }
            None => Ok(data),  // 无编码信息,返回原始数据
        }
    }
}

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

    #[test]
    fn test_compression_encoding_from_header() {
        assert_eq!(
            CompressionEncoding::from_header("gzip"),
            Some(CompressionEncoding::Gzip)
        );
        assert_eq!(
            CompressionEncoding::from_header("GZIP"),
            Some(CompressionEncoding::Gzip)
        );
        assert_eq!(
            CompressionEncoding::from_header("deflate"),
            Some(CompressionEncoding::Deflate)
        );
        assert_eq!(
            CompressionEncoding::from_header("br"),
            Some(CompressionEncoding::Brotli)
        );
        assert_eq!(
            CompressionEncoding::from_header("identity"),
            Some(CompressionEncoding::Identity)
        );
        assert_eq!(
            CompressionEncoding::from_header("unknown"),
            None
        );
    }

    #[test]
    fn test_compression_encoding_as_str() {
        assert_eq!(CompressionEncoding::Gzip.as_str(), "gzip");
        assert_eq!(CompressionEncoding::Deflate.as_str(), "deflate");
        assert_eq!(CompressionEncoding::Brotli.as_str(), "br");
        assert_eq!(CompressionEncoding::Identity.as_str(), "identity");
    }

    #[test]
    fn test_decompress_identity() {
        let data = Bytes::from_static(b"hello world");
        let result = Decompressor::decompress(data, CompressionEncoding::Identity);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), Bytes::from_static(b"hello world"));
    }

    #[test]
    fn test_decompress_gzip() {
        use flate2::write::GzEncoder;
        use flate2::Compression;
        use std::io::Write;

        let original = Bytes::from_static(b"hello world");
        let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(&original).unwrap();
        let compressed = Bytes::from(encoder.finish().unwrap());

        let result = Decompressor::decompress(compressed, CompressionEncoding::Gzip);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), original);
    }

    #[test]
    fn test_auto_decompress() {
        use flate2::write::GzEncoder;
        use flate2::Compression;
        use std::io::Write;

        let original = Bytes::from_static(b"test data");
        let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(&original).unwrap();
        let compressed = Bytes::from(encoder.finish().unwrap());

        // 有 Content-Encoding 头
        let result = Decompressor::auto_decompress(compressed.clone(), Some("gzip"));
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), original);

        // 无 Content-Encoding 头
        let result = Decompressor::auto_decompress(compressed.clone(), None);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), compressed);
    }

    #[test]
    fn test_decompress_deflate() {
        use flate2::write::ZlibEncoder;
        use flate2::Compression;
        use std::io::Write;

        let original = Bytes::from_static(b"deflate test");
        let mut encoder = ZlibEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(&original).unwrap();
        let compressed = Bytes::from(encoder.finish().unwrap());

        let result = Decompressor::decompress(compressed, CompressionEncoding::Deflate);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), original);
    }

    #[test]
    fn test_decompress_brotli() {
        let _original = Bytes::from_static(b"brotli test");

        // For now, skip brotli decompression test due to API complexity
        // This can be added in the future
    }

    #[test]
    fn test_decompress_empty() {
        let empty = Bytes::new();

        // Empty data with gzip/deflate may fail (not valid compressed data)
        // but identity should work fine
        let identity_result = Decompressor::decompress(empty.clone(), CompressionEncoding::Identity);
        assert!(identity_result.is_ok());
        assert_eq!(identity_result.unwrap(), empty);

        // For gzip and deflate, we test with minimal valid compressed data
        use flate2::write::GzEncoder;
        use flate2::Compression;
        use std::io::Write;

        let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(b"").unwrap();
        let empty_compressed = Bytes::from(encoder.finish().unwrap());
        let gzip_result = Decompressor::decompress(empty_compressed, CompressionEncoding::Gzip);
        assert!(gzip_result.is_ok());
    }

    #[test]
    fn test_decompress_invalid_gzip() {
        let invalid = Bytes::from_static(b"not valid gzip data");

        let result = Decompressor::decompress(invalid, CompressionEncoding::Gzip);
        assert!(result.is_err());
    }

    #[test]
    fn test_decompress_invalid_deflate() {
        let invalid = Bytes::from_static(b"not valid deflate data");

        let result = Decompressor::decompress(invalid, CompressionEncoding::Deflate);
        assert!(result.is_err());
    }

    #[test]
    fn test_decompress_invalid_brotli() {
        let invalid = Bytes::from_static(b"not valid brotli data");

        let result = Decompressor::decompress(invalid, CompressionEncoding::Brotli);
        assert!(result.is_err());
    }

    #[test]
    fn test_auto_decompress_unsupported_encoding() {
        let data = Bytes::from_static(b"test data");

        let result = Decompressor::auto_decompress(data.clone(), Some("unsupported"));
        // Should return original data for unsupported encoding
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), data);
    }

    #[test]
    fn test_compression_encoding_case_insensitive() {
        assert_eq!(
            CompressionEncoding::from_header("GZIP"),
            Some(CompressionEncoding::Gzip)
        );
        assert_eq!(
            CompressionEncoding::from_header("Deflate"),
            Some(CompressionEncoding::Deflate)
        );
        assert_eq!(
            CompressionEncoding::from_header("BR"),
            Some(CompressionEncoding::Brotli)
        );
        assert_eq!(
            CompressionEncoding::from_header("Identity"),
            Some(CompressionEncoding::Identity)
        );
    }

    #[test]
    fn test_compression_encoding_whitespace() {
        assert_eq!(
            CompressionEncoding::from_header("  gzip  "),
            Some(CompressionEncoding::Gzip)
        );
        assert_eq!(
            CompressionEncoding::from_header("\tdeflate\t"),
            Some(CompressionEncoding::Deflate)
        );
    }

    #[test]
    fn test_compression_encoding_empty() {
        assert_eq!(
            CompressionEncoding::from_header(""),
            Some(CompressionEncoding::Identity)
        );
        assert_eq!(
            CompressionEncoding::from_header("none"),
            Some(CompressionEncoding::Identity)
        );
    }

    #[test]
    fn test_compression_encoding_equality() {
        assert_eq!(CompressionEncoding::Gzip, CompressionEncoding::Gzip);
        assert_eq!(CompressionEncoding::Deflate, CompressionEncoding::Deflate);
        assert_eq!(CompressionEncoding::Brotli, CompressionEncoding::Brotli);
        assert_eq!(CompressionEncoding::Identity, CompressionEncoding::Identity);

        assert_ne!(CompressionEncoding::Gzip, CompressionEncoding::Deflate);
    }

    #[test]
    fn test_decompression_error_debug() {
        let error = DecompressionError::Unsupported("unknown".to_string());
        let debug_str = format!("{:?}", error);
        assert!(debug_str.contains("Unsupported"));

        let error = DecompressionError::Failed("failed".to_string());
        let debug_str = format!("{:?}", error);
        assert!(debug_str.contains("Failed"));
    }

    #[test]
    fn test_decompression_error_display() {
        let error = DecompressionError::Unsupported("test".to_string());
        assert!(error.to_string().contains("Unsupported"));

        let error = DecompressionError::Failed("test".to_string());
        assert!(error.to_string().contains("Decompression failed"));
    }

    #[test]
    fn test_large_data_decompression() {
        use flate2::write::GzEncoder;
        use flate2::Compression;
        use std::io::Write;

        // Create larger data
        let mut large_data = Vec::new();
        for i in 0..1000 {
            large_data.extend_from_slice(format!("line {}\n", i).as_bytes());
        }
        let original = Bytes::from(large_data);

        // Compress
        let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(&original).unwrap();
        let compressed = Bytes::from(encoder.finish().unwrap());

        // Decompress
        let result = Decompressor::decompress(compressed, CompressionEncoding::Gzip);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), original);
    }

    #[test]
    fn test_binary_data_decompression() {
        use flate2::write::GzEncoder;
        use flate2::Compression;
        use std::io::Write;

        // Binary data with all possible byte values
        let mut binary_data = Vec::new();
        for i in 0u8..=255 {
            binary_data.push(i);
        }
        let original = Bytes::from(binary_data);

        // Compress
        let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(&original).unwrap();
        let compressed = Bytes::from(encoder.finish().unwrap());

        // Decompress
        let result = Decompressor::decompress(compressed, CompressionEncoding::Gzip);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), original);
    }
}