reinhardt-core 0.1.0

Core components for Reinhardt framework
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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
//! Compression support for parsers
//!
//! Provides transparent decompression of request bodies with gzip, brotli, or deflate encoding.

use super::parser::{ParseResult, ParsedData, Parser};
use crate::exception::Error;
use async_trait::async_trait;
use brotli::Decompressor;
use bytes::Bytes;
use flate2::read::{DeflateDecoder, GzDecoder};
use http::HeaderMap;
use std::io::Read;
use std::sync::Arc;

/// Supported compression algorithms
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CompressionEncoding {
	/// Gzip compression (Content-Encoding: gzip)
	Gzip,
	/// Brotli compression (Content-Encoding: br)
	Brotli,
	/// Deflate compression (Content-Encoding: deflate)
	Deflate,
}

impl CompressionEncoding {
	/// Parse compression encoding from Content-Encoding header
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_core::parsers::compressed::CompressionEncoding;
	///
	/// assert_eq!(
	///     CompressionEncoding::from_header("gzip"),
	///     Some(CompressionEncoding::Gzip)
	/// );
	/// assert_eq!(
	///     CompressionEncoding::from_header("br"),
	///     Some(CompressionEncoding::Brotli)
	/// );
	/// assert_eq!(
	///     CompressionEncoding::from_header("deflate"),
	///     Some(CompressionEncoding::Deflate)
	/// );
	/// assert_eq!(CompressionEncoding::from_header("unknown"), None);
	/// ```
	pub fn from_header(encoding: &str) -> Option<Self> {
		match encoding.to_lowercase().as_str() {
			"gzip" => Some(Self::Gzip),
			"br" => Some(Self::Brotli),
			"deflate" => Some(Self::Deflate),
			_ => None,
		}
	}

	/// Default maximum decompressed output size (100 MB)
	const DEFAULT_MAX_OUTPUT_SIZE: u64 = 100 * 1024 * 1024;

	/// Decompress data using this encoding with a size limit to prevent
	/// decompression bomb attacks.
	fn decompress(&self, data: &[u8]) -> ParseResult<Vec<u8>> {
		self.decompress_with_limit(data, Self::DEFAULT_MAX_OUTPUT_SIZE)
	}

	/// Decompress data with an explicit output size limit.
	fn decompress_with_limit(&self, data: &[u8], max_output_size: u64) -> ParseResult<Vec<u8>> {
		match self {
			Self::Gzip => {
				let decoder = GzDecoder::new(data);
				let mut limited = decoder.take(max_output_size);
				let mut decompressed = Vec::new();
				limited
					.read_to_end(&mut decompressed)
					.map_err(|e| Error::ParseError(format!("Gzip decompression error: {}", e)))?;
				Ok(decompressed)
			}
			Self::Brotli => {
				let decoder = Decompressor::new(data, 4096);
				let mut limited = decoder.take(max_output_size);
				let mut decompressed = Vec::new();
				limited
					.read_to_end(&mut decompressed)
					.map_err(|e| Error::ParseError(format!("Brotli decompression error: {}", e)))?;
				Ok(decompressed)
			}
			Self::Deflate => {
				let decoder = DeflateDecoder::new(data);
				let mut limited = decoder.take(max_output_size);
				let mut decompressed = Vec::new();
				limited.read_to_end(&mut decompressed).map_err(|e| {
					Error::ParseError(format!("Deflate decompression error: {}", e))
				})?;
				Ok(decompressed)
			}
		}
	}
}

/// Wrapper parser that handles compressed request bodies
///
/// # Examples
///
/// ```
/// use reinhardt_core::parsers::compressed::CompressedParser;
/// use reinhardt_core::parsers::json::JSONParser;
/// use std::sync::Arc;
///
/// let json_parser = JSONParser::new();
/// let compressed_parser = CompressedParser::new(Arc::new(json_parser));
/// ```
pub struct CompressedParser {
	inner: Arc<dyn Parser>,
}

impl CompressedParser {
	/// Create a new CompressedParser wrapping an existing parser.
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_core::parsers::compressed::CompressedParser;
	/// use reinhardt_core::parsers::json::JSONParser;
	/// use std::sync::Arc;
	///
	/// let json_parser = JSONParser::new();
	/// let parser = CompressedParser::new(Arc::new(json_parser));
	/// ```
	pub fn new(inner: Arc<dyn Parser>) -> Self {
		Self { inner }
	}

	/// Decompress body if Content-Encoding header is present
	///
	/// This method provides explicit decompression control when the Content-Encoding
	/// header value is available from the request context.
	///
	/// # Arguments
	///
	/// * `content_encoding` - Optional Content-Encoding header value (e.g., "gzip", "br", "deflate")
	/// * `body` - Request body bytes (potentially compressed)
	///
	/// # Returns
	///
	/// Returns decompressed body if Content-Encoding is recognized, otherwise returns the original body.
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_core::parsers::compressed::CompressedParser;
	/// use reinhardt_core::parsers::json::JSONParser;
	/// use bytes::Bytes;
	/// use std::sync::Arc;
	/// use flate2::write::GzEncoder;
	/// use flate2::Compression;
	/// use std::io::Write;
	///
	/// // Create sample JSON data
	/// let json_data = b"{\"test\":\"data\"}";
	///
	/// // Compress with gzip
	/// let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
	/// encoder.write_all(json_data).unwrap();
	/// let compressed = encoder.finish().unwrap();
	///
	/// // Decompress using CompressedParser
	/// let parser = CompressedParser::new(Arc::new(JSONParser::new()));
	/// let body = Bytes::from(compressed);
	/// let decompressed = parser.decompress_if_needed(Some("gzip"), body).unwrap();
	///
	/// // Verify decompression succeeded
	/// assert_eq!(decompressed.as_ref(), json_data);
	/// ```
	pub fn decompress_if_needed(
		&self,
		content_encoding: Option<&str>,
		body: Bytes,
	) -> ParseResult<Bytes> {
		if let Some(encoding_str) = content_encoding
			&& let Some(encoding) = CompressionEncoding::from_header(encoding_str)
		{
			let decompressed = encoding.decompress(&body)?;
			return Ok(Bytes::from(decompressed));
		}
		Ok(body)
	}
}

#[async_trait]
impl Parser for CompressedParser {
	fn media_types(&self) -> Vec<String> {
		self.inner.media_types()
	}

	async fn parse(
		&self,
		content_type: Option<&str>,
		body: Bytes,
		headers: &HeaderMap,
	) -> ParseResult<ParsedData> {
		// Extract Content-Encoding from headers
		let encoding = headers
			.get("content-encoding")
			.and_then(|v| v.to_str().ok())
			.unwrap_or("identity");

		// Decompress based on Content-Encoding header
		let decompressed = match encoding {
			"gzip" => CompressionEncoding::Gzip
				.decompress(&body)
				.map(Bytes::from)?,
			"deflate" => CompressionEncoding::Deflate
				.decompress(&body)
				.map(Bytes::from)?,
			"br" => CompressionEncoding::Brotli
				.decompress(&body)
				.map(Bytes::from)?,
			// "identity" or any other unknown encoding - return body as-is
			_ => body,
		};

		// Parse decompressed data
		self.inner.parse(content_type, decompressed, headers).await
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::parsers::json::JSONParser;
	use flate2::Compression;
	use flate2::write::{DeflateEncoder, GzEncoder};
	use std::io::Write;

	#[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("br"),
			Some(CompressionEncoding::Brotli)
		);
		assert_eq!(
			CompressionEncoding::from_header("deflate"),
			Some(CompressionEncoding::Deflate)
		);
		assert_eq!(CompressionEncoding::from_header("unknown"), None);
	}

	#[tokio::test]
	async fn test_compressed_parser_gzip() {
		use http::HeaderMap;

		let json_data = r#"{"name":"John","age":30}"#;

		// Compress with gzip
		let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
		encoder.write_all(json_data.as_bytes()).unwrap();
		let compressed = encoder.finish().unwrap();

		// Create headers with Content-Encoding
		let mut headers = HeaderMap::new();
		headers.insert("content-encoding", "gzip".parse().unwrap());

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.parse(Some("application/json"), Bytes::from(compressed), &headers)
			.await
			.unwrap();

		match result {
			ParsedData::Json(value) => {
				assert_eq!(value["name"], "John");
				assert_eq!(value["age"], 30);
			}
			_ => panic!("Expected JSON data"),
		}
	}

	#[tokio::test]
	async fn test_compressed_parser_deflate() {
		use http::HeaderMap;

		let json_data = r#"{"name":"Alice","city":"NYC"}"#;

		// Compress with deflate
		let mut encoder = DeflateEncoder::new(Vec::new(), Compression::default());
		encoder.write_all(json_data.as_bytes()).unwrap();
		let compressed = encoder.finish().unwrap();

		// Create headers with Content-Encoding
		let mut headers = HeaderMap::new();
		headers.insert("content-encoding", "deflate".parse().unwrap());

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.parse(Some("application/json"), Bytes::from(compressed), &headers)
			.await
			.unwrap();

		match result {
			ParsedData::Json(value) => {
				assert_eq!(value["name"], "Alice");
				assert_eq!(value["city"], "NYC");
			}
			_ => panic!("Expected JSON data"),
		}
	}

	#[tokio::test]
	async fn test_compressed_parser_brotli() {
		use http::HeaderMap;

		let json_data = r#"{"product":"widget","price":19.99}"#;

		// Compress with brotli
		let mut compressed = Vec::new();
		{
			let mut encoder = brotli::CompressorWriter::new(
				&mut compressed,
				4096,
				11, // quality
				22, // lg_window_size
			);
			encoder.write_all(json_data.as_bytes()).unwrap();
		}

		// Create headers with Content-Encoding
		let mut headers = HeaderMap::new();
		headers.insert("content-encoding", "br".parse().unwrap());

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.parse(Some("application/json"), Bytes::from(compressed), &headers)
			.await
			.unwrap();

		match result {
			ParsedData::Json(value) => {
				assert_eq!(value["product"], "widget");
				assert_eq!(value["price"], 19.99);
			}
			_ => panic!("Expected JSON data"),
		}
	}

	#[tokio::test]
	async fn test_compressed_parser_uncompressed() {
		use http::HeaderMap;

		let json_data = r#"{"uncompressed":true}"#;

		// No Content-Encoding header (identity)
		let headers = HeaderMap::new();

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.parse(Some("application/json"), Bytes::from(json_data), &headers)
			.await
			.unwrap();

		match result {
			ParsedData::Json(value) => {
				assert!(value["uncompressed"].as_bool().unwrap());
			}
			_ => panic!("Expected JSON data"),
		}
	}

	#[test]
	fn test_compressed_parser_media_types() {
		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let media_types = parser.media_types();

		assert!(media_types.contains(&"application/json".to_string()));
	}

	#[tokio::test]
	async fn test_gzip_decompression() {
		let original = b"Hello, World!";

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

		let decompressed = CompressionEncoding::Gzip.decompress(&compressed).unwrap();

		assert_eq!(decompressed, original);
	}

	#[tokio::test]
	async fn test_deflate_decompression() {
		let original = b"Test data for deflate";

		let mut encoder = DeflateEncoder::new(Vec::new(), Compression::default());
		encoder.write_all(original).unwrap();
		let compressed = encoder.finish().unwrap();

		let decompressed = CompressionEncoding::Deflate
			.decompress(&compressed)
			.unwrap();

		assert_eq!(decompressed, original);
	}

	#[tokio::test]
	async fn test_brotli_decompression() {
		let original = b"Brotli compressed content";

		let mut compressed = Vec::new();
		{
			let mut encoder = brotli::CompressorWriter::new(&mut compressed, 4096, 11, 22);
			encoder.write_all(original).unwrap();
		}

		let decompressed = CompressionEncoding::Brotli.decompress(&compressed).unwrap();

		assert_eq!(decompressed, original);
	}

	#[tokio::test]
	async fn test_invalid_gzip_data() {
		let invalid_data = b"not gzip data";
		let result = CompressionEncoding::Gzip.decompress(invalid_data);
		assert!(result.is_err());
	}

	#[tokio::test]
	async fn test_invalid_brotli_data() {
		let invalid_data = b"not brotli data";
		let result = CompressionEncoding::Brotli.decompress(invalid_data);
		assert!(result.is_err());
	}

	#[test]
	fn test_decompress_if_needed_gzip() {
		let original = b"Hello, World!";

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

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.decompress_if_needed(Some("gzip"), Bytes::from(compressed))
			.unwrap();

		assert_eq!(result.as_ref(), original);
	}

	#[test]
	fn test_decompress_if_needed_deflate() {
		let original = b"Test data for deflate";

		// Compress with deflate
		let mut encoder = DeflateEncoder::new(Vec::new(), Compression::default());
		encoder.write_all(original).unwrap();
		let compressed = encoder.finish().unwrap();

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.decompress_if_needed(Some("deflate"), Bytes::from(compressed))
			.unwrap();

		assert_eq!(result.as_ref(), original);
	}

	#[test]
	fn test_decompress_if_needed_brotli() {
		let original = b"Brotli compressed content";

		// Compress with brotli
		let mut compressed = Vec::new();
		{
			let mut encoder = brotli::CompressorWriter::new(&mut compressed, 4096, 11, 22);
			encoder.write_all(original).unwrap();
		}

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.decompress_if_needed(Some("br"), Bytes::from(compressed))
			.unwrap();

		assert_eq!(result.as_ref(), original);
	}

	#[test]
	fn test_decompress_if_needed_no_encoding() {
		let original = b"Uncompressed data";

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.decompress_if_needed(None, Bytes::from(original.as_slice()))
			.unwrap();

		assert_eq!(result.as_ref(), original);
	}

	#[test]
	fn test_decompress_if_needed_unknown_encoding() {
		let original = b"Unknown encoding";

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));
		let result = parser
			.decompress_if_needed(Some("unknown"), Bytes::from(original.as_slice()))
			.unwrap();

		// Should return original data unchanged
		assert_eq!(result.as_ref(), original);
	}

	#[test]
	fn test_decompress_if_needed_case_insensitive() {
		let original = b"Case test";

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

		let parser = CompressedParser::new(Arc::new(JSONParser::new()));

		// Test with uppercase
		let result = parser
			.decompress_if_needed(Some("GZIP"), Bytes::from(compressed.clone()))
			.unwrap();
		assert_eq!(result.as_ref(), original);

		// Test with mixed case
		let result = parser
			.decompress_if_needed(Some("GzIp"), Bytes::from(compressed))
			.unwrap();
		assert_eq!(result.as_ref(), original);
	}
}