camel_component_log/
lib.rs

1//! Log component for rust-camel — routes exchange body and headers to the
2//! `tracing` subsystem at a configurable log level, primarily for debugging.
3//!
4//! Main types: `LogComponent`, `LogEndpoint`, `LogProducer`, `LogLevel`.
5
6use std::future::Future;
7use std::pin::Pin;
8use std::str::FromStr;
9use std::sync::Arc;
10use std::sync::atomic::{AtomicUsize, Ordering};
11use std::task::{Context, Poll};
12
13use tower::Service;
14use tracing::{debug, error, info, trace, warn};
15
16use camel_component_api::UriConfig;
17use camel_component_api::parse_uri;
18use camel_component_api::{BoxProcessor, CamelError, Exchange};
19use camel_component_api::{
20    Component, ComponentMetadata, Consumer, Endpoint, ProducerContext, RuntimeObservability,
21};
22
23// ---------------------------------------------------------------------------
24// LogLevel
25// ---------------------------------------------------------------------------
26
27/// Log level for the log component.
28#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
29pub enum LogLevel {
30    Trace,
31    Debug,
32    #[default]
33    Info,
34    Warn,
35    Error,
36}
37
38impl FromStr for LogLevel {
39    type Err = String;
40
41    fn from_str(s: &str) -> Result<Self, Self::Err> {
42        parse_log_level(s).map_err(|e| e.to_string())
43    }
44}
45
46fn parse_log_level(s: &str) -> Result<LogLevel, CamelError> {
47    match s.to_uppercase().as_str() {
48        "TRACE" => Ok(LogLevel::Trace),
49        "DEBUG" => Ok(LogLevel::Debug),
50        "INFO" => Ok(LogLevel::Info),
51        "WARN" | "WARNING" => Ok(LogLevel::Warn),
52        "ERROR" => Ok(LogLevel::Error),
53        _ => Err(CamelError::Config(format!(
54            "unknown log level: '{}'. Valid: TRACE, DEBUG, INFO, WARN, ERROR",
55            s
56        ))),
57    }
58}
59
60// ---------------------------------------------------------------------------
61// LogConfig
62// ---------------------------------------------------------------------------
63
64/// Configuration parsed from a log URI.
65///
66/// Format: `log:category?level=info&showHeaders=true&showBody=true&logMask=false&showStreamInfo=false&groupSize=10`
67#[derive(Debug, Clone, UriConfig)]
68#[uri_scheme = "log"]
69#[uri_config(
70    skip_impl,
71    metadata(
72        scheme = "log",
73        description = "Logs exchanges at a configurable level",
74        producer
75    ),
76    crate = "camel_component_api"
77)]
78pub struct LogConfig {
79    /// Log category (the path portion of the URI).
80    pub category: String,
81    /// Log level. Default: Info.
82    #[uri_param(
83        kind = "enum:TRACE,DEBUG,INFO,WARN,ERROR",
84        default = "INFO",
85        desc = "Log level"
86    )]
87    pub level: LogLevel,
88    /// Whether to include headers in the log output.
89    #[uri_param(
90        name = "showHeaders",
91        default = "false",
92        desc = "Include headers in log output"
93    )]
94    pub show_headers: bool,
95    /// Whether to include the body in the log output.
96    #[uri_param(
97        name = "showBody",
98        default = "true",
99        desc = "Include body in log output"
100    )]
101    pub show_body: bool,
102    /// Maximum number of characters for the body in log output.
103    /// Bodies longer than this are truncated. `None` means no limit.
104    #[uri_param(
105        name = "maxChars",
106        desc = "Truncate body to N characters. Omit for no limit"
107    )]
108    pub max_chars: Option<usize>,
109    /// When true, redact sensitive headers and body in log output.
110    /// Headers matching `/(?i)(password|secret|token|key|auth|credential)/` → `[REDACTED]`.
111    /// Body → `[Body redacted by logMask]`.
112    #[uri_param(
113        name = "logMask",
114        default = "false",
115        desc = "Redact sensitive headers and body"
116    )]
117    pub log_mask: bool,
118    /// When true, show stream origin metadata. When false (default), show `[Stream]`.
119    #[uri_param(
120        name = "showStreamInfo",
121        default = "false",
122        desc = "Show stream origin info"
123    )]
124    pub show_stream_info: bool,
125    /// When set, only emit a log every `n` exchanges (group logging).
126    /// The log message includes the exchange count.
127    #[uri_param(
128        name = "groupSize",
129        desc = "Emit log every N exchanges for group logging"
130    )]
131    pub group_size: Option<usize>,
132}
133
134impl UriConfig for LogConfig {
135    fn scheme() -> &'static str {
136        "log"
137    }
138
139    fn from_uri(uri: &str) -> Result<Self, CamelError> {
140        let parts = parse_uri(uri)?;
141        Self::from_components(parts)
142    }
143
144    fn from_components(parts: camel_component_api::UriComponents) -> Result<Self, CamelError> {
145        if parts.scheme != Self::scheme() {
146            return Err(CamelError::InvalidUri(format!(
147                "expected scheme '{}' but got '{}'",
148                Self::scheme(),
149                parts.scheme
150            )));
151        }
152
153        let level = match parts.params.get("level") {
154            Some(raw) => parse_log_level(raw)?,
155            None => LogLevel::Info,
156        };
157
158        let show_headers = match parts.params.get("showHeaders") {
159            Some(raw) => raw.parse::<bool>().map_err(|_| {
160                CamelError::InvalidUri(format!("invalid boolean value for showHeaders: {raw}"))
161            })?,
162            None => false,
163        };
164
165        let show_body = match parts.params.get("showBody") {
166            Some(raw) => raw.parse::<bool>().map_err(|_| {
167                CamelError::InvalidUri(format!("invalid boolean value for showBody: {raw}"))
168            })?,
169            None => true,
170        };
171
172        let max_chars = match parts.params.get("maxChars") {
173            Some(raw) => Some(raw.parse::<usize>().map_err(|_| {
174                CamelError::InvalidUri(format!("invalid integer value for maxChars: {raw}"))
175            })?),
176            None => None,
177        };
178
179        let log_mask = match parts.params.get("logMask") {
180            Some(raw) => raw.parse::<bool>().map_err(|_| {
181                CamelError::InvalidUri(format!("invalid boolean value for logMask: {raw}"))
182            })?,
183            None => false,
184        };
185
186        let show_stream_info = match parts.params.get("showStreamInfo") {
187            Some(raw) => raw.parse::<bool>().map_err(|_| {
188                CamelError::InvalidUri(format!("invalid boolean value for showStreamInfo: {raw}"))
189            })?,
190            None => false,
191        };
192
193        let group_size = match parts.params.get("groupSize") {
194            Some(raw) => Some(raw.parse::<usize>().map_err(|_| {
195                CamelError::InvalidUri(format!("invalid integer value for groupSize: {raw}"))
196            })?),
197            None => None,
198        };
199
200        Ok(Self {
201            category: parts.path,
202            level,
203            show_headers,
204            show_body,
205            max_chars,
206            log_mask,
207            show_stream_info,
208            group_size,
209        })
210    }
211}
212
213// ---------------------------------------------------------------------------
214// LogComponent
215// ---------------------------------------------------------------------------
216
217/// The Log component logs exchange information using `tracing`.
218pub struct LogComponent;
219
220impl LogComponent {
221    pub fn new() -> Self {
222        Self
223    }
224}
225
226impl Default for LogComponent {
227    fn default() -> Self {
228        Self::new()
229    }
230}
231
232impl Component for LogComponent {
233    fn scheme(&self) -> &str {
234        "log"
235    }
236
237    fn metadata(&self) -> ComponentMetadata {
238        LogConfig::metadata()
239    }
240
241    fn create_endpoint(
242        &self,
243        uri: &str,
244        _ctx: &dyn camel_component_api::ComponentContext,
245    ) -> Result<Box<dyn Endpoint>, CamelError> {
246        let config = LogConfig::from_uri(uri)?;
247        Ok(Box::new(LogEndpoint {
248            uri: uri.to_string(),
249            config,
250        }))
251    }
252}
253
254// ---------------------------------------------------------------------------
255// LogEndpoint
256// ---------------------------------------------------------------------------
257
258struct LogEndpoint {
259    uri: String,
260    config: LogConfig,
261}
262
263impl Endpoint for LogEndpoint {
264    fn uri(&self) -> &str {
265        &self.uri
266    }
267
268    fn create_consumer(
269        &self,
270        _rt: Arc<dyn RuntimeObservability>,
271    ) -> Result<Box<dyn Consumer>, CamelError> {
272        Err(CamelError::EndpointCreationFailed(
273            "log endpoint does not support consumers".to_string(),
274        ))
275    }
276
277    fn create_producer(
278        &self,
279        _rt: Arc<dyn RuntimeObservability>,
280        _ctx: &ProducerContext,
281    ) -> Result<BoxProcessor, CamelError> {
282        Ok(BoxProcessor::new(LogProducer::new(self.config.clone())))
283    }
284}
285
286// ---------------------------------------------------------------------------
287// LogProducer
288// ---------------------------------------------------------------------------
289
290#[derive(Clone)]
291struct LogProducer {
292    config: LogConfig,
293    exchange_count: Arc<AtomicUsize>,
294}
295
296impl LogProducer {
297    fn new(config: LogConfig) -> Self {
298        Self {
299            config,
300            exchange_count: Arc::new(AtomicUsize::new(0)),
301        }
302    }
303
304    /// Returns true if the header key matches sensitive patterns.
305    fn is_sensitive_header(key: &str) -> bool {
306        let lower = key.to_lowercase();
307        let sensitive_keywords = [
308            "password",
309            "passwd",
310            "secret",
311            "token",
312            "apikey",
313            "api-key",
314            "api_key",
315            "authorization",
316            "auth",
317            "credential",
318            "private",
319            "signature",
320        ];
321        sensitive_keywords.iter().any(|kw| {
322            lower == *kw
323                || lower.ends_with(&format!("-{kw}"))
324                || lower.ends_with(&format!("_{kw}"))
325                || lower.starts_with(&format!("{kw}-"))
326                || lower.starts_with(&format!("{kw}_"))
327        })
328    }
329
330    fn format_exchange(&self, exchange: &Exchange, count: usize) -> String {
331        let mut parts = Vec::new();
332
333        if self.config.show_body {
334            let body_str = if self.config.log_mask {
335                "[Body redacted by logMask]".to_string()
336            } else {
337                match &exchange.input.body {
338                    camel_component_api::Body::Empty => "[empty]".to_string(),
339                    camel_component_api::Body::Text(s) => s.clone(),
340                    camel_component_api::Body::Json(v) => v.to_string(),
341                    camel_component_api::Body::Xml(s) => s.clone(),
342                    camel_component_api::Body::Bytes(b) => format!("[{} bytes]", b.len()),
343                    camel_component_api::Body::Stream(s) => {
344                        if self.config.show_stream_info {
345                            format!("[Stream: origin={:?}]", s.metadata.origin)
346                        } else {
347                            "[Stream]".to_string()
348                        }
349                    }
350                    // Future body variants render as an opaque placeholder.
351                    _ => "[unsupported body type]".to_string(),
352                }
353            };
354
355            let body_str = if let Some(limit) = self.config.max_chars {
356                body_str.chars().take(limit).collect()
357            } else {
358                body_str
359            };
360
361            parts.push(format!("Body: {body_str}"));
362        }
363
364        if self.config.show_headers && !exchange.input.headers.is_empty() {
365            let headers: Vec<String> = exchange
366                .input
367                .headers
368                .iter()
369                .map(|(k, v)| {
370                    if self.config.log_mask && Self::is_sensitive_header(k) {
371                        format!("{k}=[REDACTED]")
372                    } else {
373                        format!("{k}={v}")
374                    }
375                })
376                .collect();
377            parts.push(format!("Headers: {{{}}}", headers.join(", ")));
378        }
379
380        if parts.is_empty() {
381            format!("[{}] Exchange received", self.config.category)
382        } else if self.config.group_size.is_some() {
383            format!(
384                "[{}] Group of {count}: {}",
385                self.config.category,
386                parts.join(" | ")
387            )
388        } else {
389            format!("[{}] {}", self.config.category, parts.join(" | "))
390        }
391    }
392}
393
394impl Service<Exchange> for LogProducer {
395    type Response = Exchange;
396    type Error = CamelError;
397    type Future = Pin<Box<dyn Future<Output = Result<Exchange, CamelError>> + Send>>;
398
399    fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
400        Poll::Ready(Ok(()))
401    }
402
403    fn call(&mut self, exchange: Exchange) -> Self::Future {
404        let count = self.exchange_count.fetch_add(1, Ordering::Relaxed) + 1;
405
406        // Group logging: only emit every group_size exchanges
407        if !Self::should_emit(count, self.config.group_size) {
408            return Box::pin(async move { Ok(exchange) });
409        }
410
411        let msg = self.format_exchange(&exchange, count);
412        let level = self.config.level;
413
414        Box::pin(async move {
415            match level {
416                LogLevel::Trace => trace!("{msg}"),
417                LogLevel::Debug => debug!("{msg}"),
418                LogLevel::Info => info!("{msg}"),
419                LogLevel::Warn => warn!("{msg}"),
420                LogLevel::Error => error!("{msg}"),
421            }
422
423            Ok(exchange)
424        })
425    }
426}
427
428impl LogProducer {
429    /// Decide whether the `count`-th exchange should emit a log line.
430    /// Without grouping every exchange emits; with grouping only multiples of
431    /// `group_size` emit (counts in between pass through silently). Extracted
432    /// from `call()` so the gating is unit-testable (rc-h0bv).
433    fn should_emit(count: usize, group_size: Option<usize>) -> bool {
434        match group_size {
435            None => true,
436            Some(gs) => count.is_multiple_of(gs),
437        }
438    }
439}
440
441// ---------------------------------------------------------------------------
442// Tests
443// ---------------------------------------------------------------------------
444
445#[cfg(test)]
446mod tests {
447    use camel_component_api::test_support::PanicRuntimeObservability;
448    fn rt() -> std::sync::Arc<dyn camel_component_api::RuntimeObservability> {
449        std::sync::Arc::new(PanicRuntimeObservability)
450    }
451    use super::*;
452    use camel_component_api::Body;
453    use camel_component_api::Message;
454    use camel_component_api::NoOpComponentContext;
455    use tower::ServiceExt;
456
457    fn test_producer_ctx() -> ProducerContext {
458        ProducerContext::new()
459    }
460
461    #[test]
462    fn test_log_config_defaults() {
463        let config = LogConfig::from_uri("log:myCategory").unwrap();
464        assert_eq!(config.category, "myCategory");
465        assert_eq!(config.level, LogLevel::Info);
466        assert!(!config.show_headers);
467        assert!(config.show_body);
468    }
469
470    #[test]
471    fn test_log_config_with_params() {
472        let config =
473            LogConfig::from_uri("log:app?level=debug&showHeaders=true&showBody=false").unwrap();
474        assert_eq!(config.category, "app");
475        assert_eq!(config.level, LogLevel::Debug);
476        assert!(config.show_headers);
477        assert!(!config.show_body);
478    }
479
480    #[test]
481    fn test_log_config_wrong_scheme() {
482        let result = LogConfig::from_uri("timer:tick");
483        assert!(result.is_err());
484    }
485
486    #[test]
487    fn test_log_component_scheme() {
488        let component = LogComponent::new();
489        assert_eq!(component.scheme(), "log");
490    }
491
492    #[test]
493    fn test_log_component_default() {
494        let component = LogComponent;
495        assert_eq!(component.scheme(), "log");
496    }
497
498    #[test]
499    fn test_log_level_from_str_variants() {
500        assert_eq!("trace".parse::<LogLevel>().unwrap(), LogLevel::Trace);
501        assert_eq!("DEBUG".parse::<LogLevel>().unwrap(), LogLevel::Debug);
502        assert_eq!("Info".parse::<LogLevel>().unwrap(), LogLevel::Info);
503        assert_eq!("warning".parse::<LogLevel>().unwrap(), LogLevel::Warn);
504        assert_eq!("error".parse::<LogLevel>().unwrap(), LogLevel::Error);
505    }
506
507    #[test]
508    fn test_log_level_from_str_invalid() {
509        let err = "nope".parse::<LogLevel>().unwrap_err();
510        assert_eq!(
511            err,
512            "Configuration error: unknown log level: 'nope'. Valid: TRACE, DEBUG, INFO, WARN, ERROR"
513        );
514    }
515
516    #[test]
517    fn test_log_config_invalid_level_rejected() {
518        let err = LogConfig::from_uri("log:test?level=invalid").unwrap_err();
519        assert!(
520            err.to_string()
521                .contains("unknown log level: 'invalid'. Valid: TRACE, DEBUG, INFO, WARN, ERROR")
522        );
523    }
524
525    #[test]
526    fn test_valid_log_levels_accepted() {
527        assert!(parse_log_level("DEBUG").is_ok());
528        assert!(parse_log_level("info").is_ok());
529        assert!(parse_log_level("WARN").is_ok());
530        assert!(parse_log_level("WARNING").is_ok());
531    }
532
533    #[test]
534    fn test_invalid_log_level_rejected() {
535        assert!(parse_log_level("VERBOSE").is_err());
536        assert!(parse_log_level("").is_err());
537        assert!(parse_log_level("log").is_err());
538    }
539
540    #[test]
541    fn test_log_endpoint_uri() {
542        let component = LogComponent::new();
543        let endpoint = component
544            .create_endpoint("log:uri-check", &NoOpComponentContext)
545            .unwrap();
546        assert_eq!(endpoint.uri(), "log:uri-check");
547    }
548
549    #[test]
550    fn test_log_endpoint_no_consumer() {
551        let component = LogComponent::new();
552        let endpoint = component
553            .create_endpoint("log:info", &NoOpComponentContext)
554            .unwrap();
555        assert!(endpoint.create_consumer(rt()).is_err());
556    }
557
558    #[test]
559    fn test_log_endpoint_creates_producer() {
560        let ctx = test_producer_ctx();
561        let component = LogComponent::new();
562        let endpoint = component
563            .create_endpoint("log:info", &NoOpComponentContext)
564            .unwrap();
565        assert!(endpoint.create_producer(rt(), &ctx).is_ok());
566    }
567
568    #[tokio::test]
569    async fn test_log_producer_processes_exchange() {
570        let ctx = test_producer_ctx();
571        let component = LogComponent::new();
572        let endpoint = component
573            .create_endpoint("log:test?showHeaders=true", &NoOpComponentContext)
574            .unwrap();
575        let producer = endpoint.create_producer(rt(), &ctx).unwrap();
576
577        let mut exchange = Exchange::new(Message::new("hello world"));
578        exchange
579            .input
580            .set_header("source", serde_json::Value::String("test".into()));
581
582        let result = producer.oneshot(exchange).await.unwrap();
583        // Log producer passes exchange through unchanged
584        assert_eq!(result.input.body.as_text(), Some("hello world"));
585    }
586
587    #[test]
588    fn test_format_exchange_without_body_or_headers() {
589        let producer = LogProducer::new(LogConfig {
590            category: "cat".to_string(),
591            level: LogLevel::Info,
592            show_headers: false,
593            show_body: false,
594            max_chars: None,
595            log_mask: false,
596            show_stream_info: false,
597            group_size: None,
598        });
599        let exchange = Exchange::new(Message::new("ignored"));
600        let formatted = producer.format_exchange(&exchange, 1);
601        assert_eq!(formatted, "[cat] Exchange received");
602    }
603
604    #[test]
605    fn test_format_exchange_body_variants() {
606        let base = LogProducer::new(LogConfig {
607            category: "cat".to_string(),
608            level: LogLevel::Info,
609            show_headers: false,
610            show_body: true,
611            max_chars: None,
612            log_mask: false,
613            show_stream_info: true,
614            group_size: None,
615        });
616
617        let empty = Exchange::new(Message::default());
618        assert!(base.format_exchange(&empty, 1).contains("Body: [empty]"));
619
620        let mut json_msg = Message::new("");
621        json_msg.body = Body::Json(serde_json::json!({"k":"v"}));
622        let json_ex = Exchange::new(json_msg);
623        assert!(
624            base.format_exchange(&json_ex, 2)
625                .contains("Body: {\"k\":\"v\"}")
626        );
627
628        let mut xml_msg = Message::new("");
629        xml_msg.body = Body::Xml("<a/>".to_string());
630        let xml_ex = Exchange::new(xml_msg);
631        assert!(base.format_exchange(&xml_ex, 3).contains("Body: <a/>"));
632
633        let mut bytes_msg = Message::new("");
634        bytes_msg.body = Body::Bytes(b"abc".to_vec().into());
635        let bytes_ex = Exchange::new(bytes_msg);
636        assert!(
637            base.format_exchange(&bytes_ex, 4)
638                .contains("Body: [3 bytes]")
639        );
640    }
641
642    #[test]
643    fn test_log_truncates_large_body() {
644        let producer = LogProducer::new(LogConfig {
645            category: "trunc".to_string(),
646            level: LogLevel::Info,
647            show_headers: false,
648            show_body: true,
649            max_chars: Some(10),
650            log_mask: false,
651            show_stream_info: false,
652            group_size: None,
653        });
654
655        let long_body = "a".repeat(100);
656        let exchange = Exchange::new(Message::new(long_body));
657        let formatted = producer.format_exchange(&exchange, 1);
658
659        // Extract the body part from "[trunc] Body: ..."
660        let body_part = formatted.split_once("Body: ").unwrap().1;
661        assert!(
662            body_part.chars().count() <= 10,
663            "expected body <= 10 chars, got {} chars: {body_part:?}",
664            body_part.chars().count()
665        );
666    }
667
668    #[test]
669    fn test_log_truncates_multibyte_body() {
670        let producer = LogProducer::new(LogConfig {
671            category: "mb".to_string(),
672            level: LogLevel::Info,
673            show_headers: false,
674            show_body: true,
675            max_chars: Some(3),
676            log_mask: false,
677            show_stream_info: false,
678            group_size: None,
679        });
680
681        let exchange = Exchange::new(Message::new("日本語测试"));
682        let formatted = producer.format_exchange(&exchange, 1);
683
684        let body_part = formatted.split_once("Body: ").unwrap().1;
685        assert_eq!(
686            body_part.chars().count(),
687            3,
688            "expected 3 chars, got {}: {body_part:?}",
689            body_part.chars().count()
690        );
691        // body_part is &str (from split_once), so UTF-8 validity is guaranteed
692        // by the type — no runtime check needed.
693    }
694
695    #[test]
696    fn test_log_truncates_multibyte_no_panic() {
697        let producer = LogProducer::new(LogConfig {
698            category: "cafe".to_string(),
699            level: LogLevel::Info,
700            show_headers: false,
701            show_body: true,
702            max_chars: Some(4),
703            log_mask: false,
704            show_stream_info: false,
705            group_size: None,
706        });
707
708        let exchange = Exchange::new(Message::new("café"));
709        let formatted = producer.format_exchange(&exchange, 1);
710
711        let body_part = formatted.split_once("Body: ").unwrap().1;
712        assert_eq!(
713            body_part.chars().count(),
714            4,
715            "expected 4 chars, got {}: {body_part:?}",
716            body_part.chars().count()
717        );
718    }
719
720    #[test]
721    fn test_log_no_truncation_when_max_chars_unset() {
722        let producer = LogProducer::new(LogConfig {
723            category: "notrunc".to_string(),
724            level: LogLevel::Info,
725            show_headers: false,
726            show_body: true,
727            max_chars: None,
728            log_mask: false,
729            show_stream_info: false,
730            group_size: None,
731        });
732
733        let long_body = "b".repeat(200);
734        let exchange = Exchange::new(Message::new(long_body));
735        let formatted = producer.format_exchange(&exchange, 1);
736
737        let body_part = formatted.split_once("Body: ").unwrap().1;
738        assert_eq!(body_part.len(), 200);
739    }
740
741    #[test]
742    fn test_log_config_max_chars_param() {
743        let config = LogConfig::from_uri("log:test?maxChars=50").unwrap();
744        assert_eq!(config.max_chars, Some(50));
745    }
746
747    #[test]
748    fn test_log_config_max_chars_default_unset() {
749        let config = LogConfig::from_uri("log:test").unwrap();
750        assert_eq!(config.max_chars, None);
751    }
752
753    // --- LOG-007: logMask tests ---
754
755    #[test]
756    fn test_log_config_log_mask_param() {
757        let config = LogConfig::from_uri("log:test?logMask=true").unwrap();
758        assert!(config.log_mask);
759    }
760
761    #[test]
762    fn test_log_config_log_mask_default_false() {
763        let config = LogConfig::from_uri("log:test").unwrap();
764        assert!(!config.log_mask);
765    }
766
767    #[test]
768    fn test_log_mask_redacts_sensitive_headers() {
769        let producer = LogProducer::new(LogConfig {
770            category: "cat".to_string(),
771            level: LogLevel::Info,
772            show_headers: true,
773            show_body: false,
774            max_chars: None,
775            log_mask: true,
776            show_stream_info: false,
777            group_size: None,
778        });
779
780        let mut exchange = Exchange::new(Message::new("body"));
781        exchange.input.set_header(
782            "X-Auth-Token",
783            serde_json::Value::String("secret123".into()),
784        );
785        exchange
786            .input
787            .set_header("password", serde_json::Value::String("hunter2".into()));
788        exchange
789            .input
790            .set_header("ApiKey", serde_json::Value::String("abc".into()));
791        exchange
792            .input
793            .set_header("normal-header", serde_json::Value::String("visible".into()));
794        exchange.input.set_header(
795            "user-credential",
796            serde_json::Value::String("sensitive".into()),
797        );
798        exchange
799            .input
800            .set_header("secret-value", serde_json::Value::String("hidden".into()));
801
802        let formatted = producer.format_exchange(&exchange, 1);
803        assert!(
804            formatted.contains("X-Auth-Token=[REDACTED]"),
805            "auth header must be redacted: {formatted}"
806        );
807        assert!(
808            formatted.contains("password=[REDACTED]"),
809            "password header must be redacted: {formatted}"
810        );
811        assert!(
812            formatted.contains("ApiKey=[REDACTED]"),
813            "key header must be redacted: {formatted}"
814        );
815        assert!(
816            formatted.contains("normal-header=\"visible\""),
817            "normal header must be visible: {formatted}"
818        );
819        assert!(
820            formatted.contains("user-credential=[REDACTED]"),
821            "credential header must be redacted: {formatted}"
822        );
823        assert!(
824            formatted.contains("secret-value=[REDACTED]"),
825            "secret header must be redacted: {formatted}"
826        );
827    }
828
829    #[test]
830    fn test_log_mask_redacts_body() {
831        let producer = LogProducer::new(LogConfig {
832            category: "cat".to_string(),
833            level: LogLevel::Info,
834            show_headers: false,
835            show_body: true,
836            max_chars: None,
837            log_mask: true,
838            show_stream_info: false,
839            group_size: None,
840        });
841
842        let exchange = Exchange::new(Message::new("sensitive body content"));
843        let formatted = producer.format_exchange(&exchange, 1);
844        assert!(
845            formatted.contains("[Body redacted by logMask]"),
846            "body must be redacted: {formatted}"
847        );
848        assert!(
849            !formatted.contains("sensitive body content"),
850            "body content must not appear: {formatted}"
851        );
852    }
853
854    #[test]
855    fn test_log_mask_off_shows_data() {
856        let producer = LogProducer::new(LogConfig {
857            category: "cat".to_string(),
858            level: LogLevel::Info,
859            show_headers: true,
860            show_body: true,
861            max_chars: None,
862            log_mask: false,
863            show_stream_info: false,
864            group_size: None,
865        });
866
867        let mut exchange = Exchange::new(Message::new("visible body"));
868        exchange
869            .input
870            .set_header("password", serde_json::Value::String("hunter2".into()));
871
872        let formatted = producer.format_exchange(&exchange, 1);
873        assert!(
874            formatted.contains("visible body"),
875            "body must be visible when mask off: {formatted}"
876        );
877        assert!(
878            formatted.contains("hunter2"),
879            "header value must be visible when mask off: {formatted}"
880        );
881    }
882
883    // --- LOG-002: showStreamInfo tests ---
884
885    #[test]
886    fn test_log_stream_show_info() {
887        // show_stream_info = false → just [Stream]
888        let producer_no_info = LogProducer::new(LogConfig {
889            category: "cat".to_string(),
890            level: LogLevel::Info,
891            show_headers: false,
892            show_body: true,
893            max_chars: None,
894            log_mask: false,
895            show_stream_info: false,
896            group_size: None,
897        });
898
899        let mut msg = Message::new("");
900        msg.body = Body::Stream(camel_component_api::StreamBody {
901            stream: std::sync::Arc::new(tokio::sync::Mutex::new(None)),
902            metadata: camel_component_api::StreamMetadata {
903                origin: Some("file:///data/test.txt".to_string()),
904                ..Default::default()
905            },
906        });
907        let exchange = Exchange::new(msg);
908        let formatted = producer_no_info.format_exchange(&exchange, 1);
909        assert!(
910            formatted.contains("Body: [Stream]"),
911            "must show [Stream] when show_stream_info=false: {formatted}"
912        );
913
914        // show_stream_info = true → [Stream: origin=...]
915        let producer_with_info = LogProducer::new(LogConfig {
916            category: "cat".to_string(),
917            level: LogLevel::Info,
918            show_headers: false,
919            show_body: true,
920            max_chars: None,
921            log_mask: false,
922            show_stream_info: true,
923            group_size: None,
924        });
925
926        let formatted = producer_with_info.format_exchange(&exchange, 1);
927        assert!(
928            formatted.contains("Body: [Stream: origin=Some(\"file:///data/test.txt\")]"),
929            "must show origin when show_stream_info=true: {formatted}"
930        );
931    }
932
933    // --- LOG-008: groupSize tests ---
934
935    #[test]
936    fn test_log_group_size() {
937        let producer = LogProducer::new(LogConfig {
938            category: "cat".to_string(),
939            level: LogLevel::Info,
940            show_headers: false,
941            show_body: true,
942            max_chars: None,
943            log_mask: false,
944            show_stream_info: false,
945            group_size: Some(3),
946        });
947
948        // Count 1 and 2 should not trigger logging, count 3 should
949        let ex1 = Exchange::new(Message::new("first"));
950        let formatted1 = producer.format_exchange(&ex1, 3);
951        assert!(
952            formatted1.contains("Group of 3:"),
953            "group_size=3 must include count: {formatted1}"
954        );
955        assert!(
956            formatted1.contains("Body: first"),
957            "group log must include body: {formatted1}"
958        );
959    }
960
961    #[test]
962    fn test_group_size_gating_skips_non_multiples() {
963        // group_size=3: counts 1,2,4,5 are skipped; 3 and 6 emit. Exercises the
964        // `call()` early-return path that the format_exchange-only test misses.
965        assert!(!LogProducer::should_emit(1, Some(3)));
966        assert!(!LogProducer::should_emit(2, Some(3)));
967        assert!(LogProducer::should_emit(3, Some(3)));
968        assert!(!LogProducer::should_emit(4, Some(3)));
969        assert!(!LogProducer::should_emit(5, Some(3)));
970        assert!(LogProducer::should_emit(6, Some(3)));
971    }
972
973    #[test]
974    fn test_group_size_gating_none_emits_all() {
975        assert!(LogProducer::should_emit(1, None));
976        assert!(LogProducer::should_emit(100, None));
977    }
978
979    #[test]
980    fn test_log_config_group_size_param() {
981        let config = LogConfig::from_uri("log:test?groupSize=10").unwrap();
982        assert_eq!(config.group_size, Some(10));
983    }
984
985    #[test]
986    fn test_log_config_group_size_default_unset() {
987        let config = LogConfig::from_uri("log:test").unwrap();
988        assert_eq!(config.group_size, None);
989    }
990
991    #[test]
992    fn test_log_config_show_stream_info_param() {
993        let config = LogConfig::from_uri("log:test?showStreamInfo=true").unwrap();
994        assert!(config.show_stream_info);
995    }
996
997    #[test]
998    fn test_log_config_show_stream_info_default_false() {
999        let config = LogConfig::from_uri("log:test").unwrap();
1000        assert!(!config.show_stream_info);
1001    }
1002}
camel_component_log/lib.rs

camel_component_log/
lib.rs
