camel-api 0.5.7

Core traits and interfaces for rust-camel
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
use crate::body::Body;
use crate::error::CamelError;
use bytes::Bytes;
use quick_xml::Reader;

/// Target type for body conversion.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BodyType {
    Text,
    Json,
    Bytes,
    Xml,
    Empty,
}

/// Validate that a string is well-formed XML.
///
/// Requirements:
/// - Must not be empty or whitespace-only.
/// - Must contain at least one root element (not just a prolog/declaration).
/// - Must not contain multiple root elements.
/// - Must be parseable by quick_xml without errors.
fn validate_xml(s: &str) -> Result<(), CamelError> {
    if s.trim().is_empty() {
        return Err(CamelError::TypeConversionFailed(
            "invalid XML: document is empty".to_string(),
        ));
    }

    let mut reader = Reader::from_str(s);
    let mut buf = Vec::new();
    let mut root_element_count: u32 = 0;
    let mut depth: u32 = 0;

    loop {
        match reader.read_event_into(&mut buf) {
            Ok(quick_xml::events::Event::Eof) => break,
            Ok(quick_xml::events::Event::Start(_)) => {
                depth += 1;
                if depth == 1 {
                    root_element_count += 1;
                    if root_element_count > 1 {
                        return Err(CamelError::TypeConversionFailed(
                            "invalid XML: document has multiple root elements".to_string(),
                        ));
                    }
                }
                buf.clear();
            }
            Ok(quick_xml::events::Event::End(_)) => {
                depth = depth.saturating_sub(1);
                buf.clear();
            }
            Ok(quick_xml::events::Event::Empty(_)) => {
                if depth == 0 {
                    root_element_count += 1;
                    if root_element_count > 1 {
                        return Err(CamelError::TypeConversionFailed(
                            "invalid XML: document has multiple root elements".to_string(),
                        ));
                    }
                }
                buf.clear();
            }
            Ok(_) => buf.clear(),
            Err(e) => {
                return Err(CamelError::TypeConversionFailed(format!(
                    "invalid XML: {e}"
                )));
            }
        }
    }

    if root_element_count == 0 {
        return Err(CamelError::TypeConversionFailed(
            "invalid XML: document has no root element".to_string(),
        ));
    }

    Ok(())
}

/// Convert a `Body` to the target `BodyType`.
///
/// `Body::Stream` is always an error — materialize with `into_bytes()` first.
/// Returns `CamelError::TypeConversionFailed` on any incompatible conversion.
pub fn convert(body: Body, target: BodyType) -> Result<Body, CamelError> {
    match (body, target) {
        // noop: same variant
        (b @ Body::Text(_), BodyType::Text) => Ok(b),
        (b @ Body::Json(_), BodyType::Json) => Ok(b),
        (b @ Body::Bytes(_), BodyType::Bytes) => Ok(b),
        (b @ Body::Xml(_), BodyType::Xml) => Ok(b),
        (Body::Empty, BodyType::Empty) => Ok(Body::Empty),

        // Text conversions
        (Body::Text(s), BodyType::Json) => {
            let v = serde_json::from_str(&s).map_err(|e| {
                CamelError::TypeConversionFailed(format!("cannot convert Body::Text to Json: {e}"))
            })?;
            Ok(Body::Json(v))
        }
        (Body::Text(s), BodyType::Bytes) => Ok(Body::Bytes(Bytes::from(s.into_bytes()))),
        (Body::Text(s), BodyType::Xml) => {
            validate_xml(&s)?;
            Ok(Body::Xml(s))
        }
        (Body::Text(_), BodyType::Empty) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Text to Empty".to_string(),
        )),

        // Json conversions
        (Body::Json(serde_json::Value::String(s)), BodyType::Text) => Ok(Body::Text(s)),
        (Body::Json(v), BodyType::Text) => Ok(Body::Text(v.to_string())),
        (Body::Json(v), BodyType::Bytes) => {
            let b = serde_json::to_vec(&v).map_err(|e| {
                CamelError::TypeConversionFailed(format!("cannot convert Body::Json to Bytes: {e}"))
            })?;
            Ok(Body::Bytes(Bytes::from(b)))
        }
        (Body::Json(_), BodyType::Xml) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Json to Xml: JSON to XML conversion is not supported".to_string(),
        )),
        (Body::Json(_), BodyType::Empty) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Json to Empty".to_string(),
        )),

        // Bytes conversions
        (Body::Bytes(b), BodyType::Text) => {
            let s = String::from_utf8(b.to_vec()).map_err(|e| {
                CamelError::TypeConversionFailed(format!(
                    "cannot convert Body::Bytes to Text: invalid UTF-8 sequence: {e}"
                ))
            })?;
            Ok(Body::Text(s))
        }
        (Body::Bytes(b), BodyType::Json) => {
            let s = String::from_utf8(b.to_vec()).map_err(|e| {
                CamelError::TypeConversionFailed(format!(
                    "cannot convert Body::Bytes to Json (UTF-8 error): {e}"
                ))
            })?;
            let v = serde_json::from_str(&s).map_err(|e| {
                CamelError::TypeConversionFailed(format!("cannot convert Body::Bytes to Json: {e}"))
            })?;
            Ok(Body::Json(v))
        }
        (Body::Bytes(b), BodyType::Xml) => {
            let s = String::from_utf8(b.to_vec()).map_err(|e| {
                CamelError::TypeConversionFailed(format!(
                    "cannot convert Body::Bytes to Xml (UTF-8 error): {e}"
                ))
            })?;
            validate_xml(&s)?;
            Ok(Body::Xml(s))
        }
        (Body::Bytes(_), BodyType::Empty) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Bytes to Empty".to_string(),
        )),

        // Xml conversions
        (Body::Xml(s), BodyType::Text) => Ok(Body::Text(s)),
        (Body::Xml(s), BodyType::Bytes) => Ok(Body::Bytes(Bytes::from(s.into_bytes()))),
        (Body::Xml(_), BodyType::Json) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Xml to Json: XML to JSON conversion is not supported".to_string(),
        )),
        (Body::Xml(_), BodyType::Empty) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Xml to Empty".to_string(),
        )),

        // Empty conversions
        (Body::Empty, BodyType::Text) => Err(CamelError::TypeConversionFailed(
            "cannot convert Empty body to Text".to_string(),
        )),
        (Body::Empty, BodyType::Json) => Err(CamelError::TypeConversionFailed(
            "cannot convert Empty body to Json".to_string(),
        )),
        (Body::Empty, BodyType::Bytes) => Err(CamelError::TypeConversionFailed(
            "cannot convert Empty body to Bytes".to_string(),
        )),
        (Body::Empty, BodyType::Xml) => Err(CamelError::TypeConversionFailed(
            "cannot convert Empty body to Xml".to_string(),
        )),

        // Stream: always fails
        (Body::Stream(_), _) => Err(CamelError::TypeConversionFailed(
            "cannot convert Body::Stream: materialize first with into_bytes()".to_string(),
        )),
    }
}

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

    #[test]
    fn text_to_json_valid() {
        let body = Body::Text(r#"{"a":1}"#.to_string());
        let result = convert(body, BodyType::Json).unwrap();
        assert_eq!(result, Body::Json(json!({"a": 1})));
    }

    #[test]
    fn text_to_json_invalid() {
        let body = Body::Text("not json".to_string());
        let result = convert(body, BodyType::Json);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn json_to_text() {
        let body = Body::Json(json!({"a": 1}));
        let result = convert(body, BodyType::Text).unwrap();
        match result {
            Body::Text(s) => assert!(s.contains("\"a\"")),
            _ => panic!("expected Body::Text"),
        }
    }

    #[test]
    fn json_to_bytes() {
        let body = Body::Json(json!({"x": 2}));
        let result = convert(body, BodyType::Bytes).unwrap();
        assert!(matches!(result, Body::Bytes(_)));
    }

    #[test]
    fn bytes_to_text_valid() {
        let body = Body::Bytes(Bytes::from_static(b"hello"));
        let result = convert(body, BodyType::Text).unwrap();
        assert_eq!(result, Body::Text("hello".to_string()));
    }

    #[test]
    fn bytes_to_text_invalid_utf8() {
        let body = Body::Bytes(Bytes::from_static(&[0xFF, 0xFE]));
        let result = convert(body, BodyType::Text);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn text_to_bytes() {
        let body = Body::Text("hi".to_string());
        let result = convert(body, BodyType::Bytes).unwrap();
        assert_eq!(result, Body::Bytes(Bytes::from_static(b"hi")));
    }

    #[test]
    fn empty_to_text_fails() {
        let result = convert(Body::Empty, BodyType::Text);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn empty_to_empty_noop() {
        let result = convert(Body::Empty, BodyType::Empty).unwrap();
        assert!(matches!(result, Body::Empty));
    }

    #[test]
    fn noop_same_type_text() {
        let body = Body::Text("x".to_string());
        let result = convert(body, BodyType::Text).unwrap();
        assert!(matches!(result, Body::Text(_)));
    }

    #[test]
    fn noop_same_type_json() {
        let body = Body::Json(json!(1));
        let result = convert(body, BodyType::Json).unwrap();
        assert!(matches!(result, Body::Json(_)));
    }

    #[test]
    fn noop_same_type_bytes() {
        let body = Body::Bytes(Bytes::from_static(b"x"));
        let result = convert(body, BodyType::Bytes).unwrap();
        assert!(matches!(result, Body::Bytes(_)));
    }

    #[test]
    fn stream_to_any_fails() {
        use crate::body::{StreamBody, StreamMetadata};
        use futures::stream;
        use std::sync::Arc;
        use tokio::sync::Mutex;

        let stream = stream::iter(vec![Ok(Bytes::from_static(b"data"))]);
        let body = Body::Stream(StreamBody {
            stream: Arc::new(Mutex::new(Some(Box::pin(stream)))),
            metadata: StreamMetadata::default(),
        });
        let result = convert(body, BodyType::Text);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn bytes_to_json_valid() {
        let body = Body::Bytes(Bytes::from_static(b"{\"k\":1}"));
        let result = convert(body, BodyType::Json).unwrap();
        assert!(matches!(result, Body::Json(_)));
    }

    #[test]
    fn bytes_to_json_invalid_utf8() {
        let body = Body::Bytes(Bytes::from_static(&[0xFF, 0xFE]));
        let result = convert(body, BodyType::Json);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn to_empty_always_fails() {
        assert!(matches!(
            convert(Body::Text("x".into()), BodyType::Empty),
            Err(CamelError::TypeConversionFailed(_))
        ));
        assert!(matches!(
            convert(Body::Json(serde_json::json!(1)), BodyType::Empty),
            Err(CamelError::TypeConversionFailed(_))
        ));
        assert!(matches!(
            convert(Body::Bytes(Bytes::from_static(b"x")), BodyType::Empty),
            Err(CamelError::TypeConversionFailed(_))
        ));
    }

    // =============================================================================
    // XML Conversion Tests
    // =============================================================================

    #[test]
    fn noop_same_type_xml() {
        let body = Body::Xml("<root/>".to_string());
        let result = convert(body, BodyType::Xml).unwrap();
        assert!(matches!(result, Body::Xml(_)));
    }

    #[test]
    fn test_text_to_xml() {
        let xml = r#"<root><child>value</child></root>"#;
        let body = Body::Text(xml.to_string());
        let result = convert(body, BodyType::Xml).unwrap();
        match result {
            Body::Xml(s) => assert_eq!(s, xml),
            _ => panic!("expected Body::Xml"),
        }
    }

    #[test]
    fn test_xml_to_text() {
        let xml = r#"<root><child>value</child></root>"#;
        let body = Body::Xml(xml.to_string());
        let result = convert(body, BodyType::Text).unwrap();
        match result {
            Body::Text(s) => assert_eq!(s, xml),
            _ => panic!("expected Body::Text"),
        }
    }

    #[test]
    fn test_bytes_to_xml() {
        let xml = r#"<root><child>value</child></root>"#;
        let body = Body::Bytes(Bytes::from(xml.as_bytes()));
        let result = convert(body, BodyType::Xml).unwrap();
        match result {
            Body::Xml(s) => assert_eq!(s, xml),
            _ => panic!("expected Body::Xml"),
        }
    }

    #[test]
    fn test_xml_to_bytes() {
        let xml = r#"<root><child>value</child></root>"#;
        let body = Body::Xml(xml.to_string());
        let result = convert(body, BodyType::Bytes).unwrap();
        match result {
            Body::Bytes(b) => assert_eq!(b.as_ref(), xml.as_bytes()),
            _ => panic!("expected Body::Bytes"),
        }
    }

    #[test]
    fn test_invalid_xml_rejected() {
        let invalid_xml = "not valid xml <unclosed";
        let body = Body::Text(invalid_xml.to_string());
        let result = convert(body, BodyType::Xml);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn test_json_to_xml_unsupported() {
        let body = Body::Json(json!({"key": "value"}));
        let result = convert(body, BodyType::Xml);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
        if let Err(CamelError::TypeConversionFailed(msg)) = result {
            assert!(
                msg.contains("not supported"),
                "error message should mention 'not supported', got: {}",
                msg
            );
        }
    }

    #[test]
    fn test_xml_to_json_unsupported() {
        let body = Body::Xml("<root/>".to_string());
        let result = convert(body, BodyType::Json);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
        if let Err(CamelError::TypeConversionFailed(msg)) = result {
            assert!(
                msg.contains("not supported"),
                "error message should mention 'not supported', got: {}",
                msg
            );
        }
    }

    #[test]
    fn test_empty_to_xml_fails() {
        let result = convert(Body::Empty, BodyType::Xml);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn test_xml_to_empty_fails() {
        let body = Body::Xml("<root/>".to_string());
        let result = convert(body, BodyType::Empty);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn test_bytes_to_xml_invalid_utf8() {
        let body = Body::Bytes(Bytes::from_static(&[0xFF, 0xFE]));
        let result = convert(body, BodyType::Xml);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    #[test]
    fn test_bytes_to_xml_invalid_xml() {
        let invalid = b"valid utf-8 but <invalid xml";
        let body = Body::Bytes(Bytes::from_static(invalid));
        let result = convert(body, BodyType::Xml);
        assert!(matches!(result, Err(CamelError::TypeConversionFailed(_))));
    }

    // =============================================================================
    // XML Validation Edge Case Tests
    // =============================================================================

    #[test]
    fn test_empty_string_rejected_as_xml() {
        let body = Body::Text("".to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            matches!(result, Err(CamelError::TypeConversionFailed(_))),
            "empty string should be rejected as XML"
        );
    }

    #[test]
    fn test_whitespace_only_rejected_as_xml() {
        let body = Body::Text("   \n\t  ".to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            matches!(result, Err(CamelError::TypeConversionFailed(_))),
            "whitespace-only string should be rejected as XML"
        );
    }

    #[test]
    fn test_prolog_only_rejected_as_xml() {
        // XML declaration without any root element
        let body = Body::Text(r#"<?xml version="1.0" encoding="UTF-8"?>"#.to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            matches!(result, Err(CamelError::TypeConversionFailed(_))),
            "XML prolog without root element should be rejected"
        );
    }

    #[test]
    fn test_multiple_root_elements_rejected() {
        let body = Body::Text("<root1/><root2/>".to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            matches!(result, Err(CamelError::TypeConversionFailed(_))),
            "XML with multiple root elements should be rejected"
        );
    }

    #[test]
    fn test_multiple_root_elements_with_children_rejected() {
        let body = Body::Text("<a><b/></a><c/>".to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            matches!(result, Err(CamelError::TypeConversionFailed(_))),
            "XML with multiple root elements (one with children) should be rejected"
        );
    }

    #[test]
    fn test_valid_xml_with_prolog_accepted() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?><root><child>value</child></root>"#;
        let body = Body::Text(xml.to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            result.is_ok(),
            "XML with prolog and root element should be accepted"
        );
    }

    #[test]
    fn test_self_closing_root_accepted() {
        let body = Body::Text("<root/>".to_string());
        let result = convert(body, BodyType::Xml);
        assert!(
            result.is_ok(),
            "self-closing root element should be accepted"
        );
    }
}