camel-component-jms 0.5.8

JMS component for rust-camel via Java bridge
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
use std::path::PathBuf;

use crate::{BRIDGE_VERSION, BrokerType};

/// Per-endpoint connection overrides parsed from the URI query string.
/// These are resolved at `create_endpoint()` time and never reach producer/consumer.
#[derive(Default, Clone)]
pub struct JmsUriOverrides {
    pub broker_url: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
}

impl std::fmt::Debug for JmsUriOverrides {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("JmsUriOverrides")
            .field("broker_url", &self.broker_url)
            .field("username", &self.username)
            .field(
                "password",
                &self.password.as_ref().map(|_| "[REDACTED]".to_string()),
            )
            .finish()
    }
}

pub fn default_bridge_cache_dir() -> PathBuf {
    camel_bridge::download::default_cache_dir()
}

#[derive(Debug, Clone, PartialEq)]
pub enum DestinationType {
    Queue,
    Topic,
}

#[derive(Debug, Clone)]
pub struct JmsEndpointConfig {
    pub destination_type: DestinationType,
    pub destination_name: String,
    /// Connection overrides from URI query string. Resolved in create_endpoint(),
    /// not used by producer or consumer directly.
    pub(crate) uri_overrides: JmsUriOverrides,
}

impl JmsEndpointConfig {
    pub fn from_uri(uri: &str) -> Result<Self, camel_component_api::CamelError> {
        // 1. Strip known scheme prefix
        let (scheme, rest) = if let Some(r) = uri.strip_prefix("jms:") {
            ("jms", r)
        } else if let Some(r) = uri.strip_prefix("activemq:") {
            ("activemq", r)
        } else if let Some(r) = uri.strip_prefix("artemis:") {
            ("artemis", r)
        } else {
            return Err(camel_component_api::CamelError::ProcessorError(format!(
                "expected scheme 'jms', 'activemq', or 'artemis', got: {uri}"
            )));
        };

        // 2. Split query string
        let (path, query) = rest.split_once('?').unwrap_or((rest, ""));

        // 3. Parse destination type and name
        let (destination_type, destination_name) =
            if let Some((dtype_str, name)) = path.split_once(':') {
                // explicit type prefix: queue:name or topic:name
                if name.is_empty() {
                    return Err(camel_component_api::CamelError::ProcessorError(
                        "destination name cannot be empty".to_string(),
                    ));
                }
                let dtype = match dtype_str.to_lowercase().as_str() {
                    "queue" => DestinationType::Queue,
                    "topic" => DestinationType::Topic,
                    other => {
                        return Err(camel_component_api::CamelError::ProcessorError(format!(
                            "JMS destination type must be 'queue' or 'topic', got: {other}"
                        )));
                    }
                };
                (dtype, name.to_string())
            } else {
                // no colon in path — shorthand form (only allowed for activemq: and artemis:)
                if scheme == "jms" {
                    return Err(camel_component_api::CamelError::ProcessorError(
                        "JMS URI must be jms:queue:name or jms:topic:name".to_string(),
                    ));
                }
                if path.is_empty() {
                    return Err(camel_component_api::CamelError::ProcessorError(
                        "destination name cannot be empty".to_string(),
                    ));
                }
                (DestinationType::Queue, path.to_string())
            };

        // 4. Parse query params
        let uri_overrides = parse_uri_overrides(query);

        Ok(Self {
            destination_type,
            destination_name,
            uri_overrides,
        })
    }

    pub fn destination(&self) -> String {
        let prefix = match self.destination_type {
            DestinationType::Queue => "queue",
            DestinationType::Topic => "topic",
        };
        format!("{prefix}:{}", self.destination_name)
    }
}

fn parse_uri_overrides(query: &str) -> JmsUriOverrides {
    let mut overrides = JmsUriOverrides::default();
    if query.is_empty() {
        return overrides;
    }
    for pair in query.split('&') {
        if let Some((key, value)) = pair.split_once('=') {
            if value.is_empty() {
                continue; // empty value = no override
            }
            match key {
                "brokerUrl" => overrides.broker_url = Some(value.to_string()),
                "username" => overrides.username = Some(value.to_string()),
                "password" => overrides.password = Some(value.to_string()),
                _ => {} // unknown params silently ignored
            }
        }
    }
    overrides
}

#[derive(Clone)]
pub struct JmsConfig {
    pub broker_url: String,
    pub broker_type: BrokerType,
    pub username: Option<String>,
    pub password: Option<String>,
    pub bridge_version: String,
    pub bridge_cache_dir: PathBuf,
    pub bridge_start_timeout_ms: u64,
    pub broker_reconnect_interval_ms: u64,
}

impl std::fmt::Debug for JmsConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("JmsConfig")
            .field("broker_url", &self.broker_url)
            .field("broker_type", &self.broker_type)
            .field("username", &self.username)
            .field(
                "password",
                &self.password.as_ref().map(|_| "[REDACTED]".to_string()),
            )
            .field("bridge_version", &self.bridge_version)
            .field("bridge_cache_dir", &self.bridge_cache_dir)
            .field("bridge_start_timeout_ms", &self.bridge_start_timeout_ms)
            .field(
                "broker_reconnect_interval_ms",
                &self.broker_reconnect_interval_ms,
            )
            .finish()
    }
}

impl Default for JmsConfig {
    fn default() -> Self {
        Self {
            broker_url: "tcp://localhost:61616".to_string(),
            broker_type: BrokerType::ActiveMq,
            username: None,
            password: None,
            bridge_version: BRIDGE_VERSION.to_string(),
            bridge_cache_dir: default_bridge_cache_dir(),
            bridge_start_timeout_ms: 30_000,
            broker_reconnect_interval_ms: 5_000,
        }
    }
}

impl JmsConfig {
    /// Merge URI overrides into this config. Override values win over self.
    /// `broker_type` is NOT merged — it is always set by the scheme, not by URI overrides.
    pub fn merge_overrides(&self, overrides: &JmsUriOverrides) -> Self {
        Self {
            broker_url: overrides
                .broker_url
                .clone()
                .unwrap_or_else(|| self.broker_url.clone()),
            broker_type: self.broker_type.clone(),
            username: overrides.username.clone().or_else(|| self.username.clone()),
            password: overrides.password.clone().or_else(|| self.password.clone()),
            bridge_version: self.bridge_version.clone(),
            bridge_cache_dir: self.bridge_cache_dir.clone(),
            bridge_start_timeout_ms: self.bridge_start_timeout_ms,
            broker_reconnect_interval_ms: self.broker_reconnect_interval_ms,
        }
    }
}

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

    #[test]
    fn parse_queue_uri() {
        let cfg = JmsEndpointConfig::from_uri("jms:queue:orders").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Queue);
        assert_eq!(cfg.destination_name, "orders");
        assert_eq!(cfg.destination(), "queue:orders");
    }

    #[test]
    fn parse_topic_uri() {
        let cfg = JmsEndpointConfig::from_uri("jms:topic:events").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Topic);
        assert_eq!(cfg.destination_name, "events");
        assert_eq!(cfg.destination(), "topic:events");
    }

    #[test]
    fn wrong_scheme_returns_error() {
        let err = JmsEndpointConfig::from_uri("kafka:orders").unwrap_err();
        assert!(err.to_string().contains("expected scheme 'jms'"));
    }

    #[test]
    fn missing_destination_name_returns_error() {
        let err = JmsEndpointConfig::from_uri("jms:queue").unwrap_err();
        assert!(err.to_string().contains("jms:queue:name"));
    }

    #[test]
    fn invalid_destination_type_returns_error() {
        let err = JmsEndpointConfig::from_uri("jms:inbox:orders").unwrap_err();
        assert!(err.to_string().contains("'queue' or 'topic'"));
    }

    #[test]
    fn parse_activemq_queue_explicit() {
        let cfg = JmsEndpointConfig::from_uri("activemq:queue:orders").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Queue);
        assert_eq!(cfg.destination_name, "orders");
        assert!(cfg.uri_overrides.broker_url.is_none());
    }

    #[test]
    fn parse_activemq_topic_explicit() {
        let cfg = JmsEndpointConfig::from_uri("activemq:topic:events").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Topic);
        assert_eq!(cfg.destination_name, "events");
    }

    #[test]
    fn parse_artemis_queue_explicit() {
        let cfg = JmsEndpointConfig::from_uri("artemis:queue:orders").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Queue);
        assert_eq!(cfg.destination_name, "orders");
    }

    #[test]
    fn parse_activemq_shorthand_defaults_to_queue() {
        let cfg = JmsEndpointConfig::from_uri("activemq:orders").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Queue);
        assert_eq!(cfg.destination_name, "orders");
    }

    #[test]
    fn parse_artemis_shorthand_defaults_to_queue() {
        let cfg = JmsEndpointConfig::from_uri("artemis:my-queue").unwrap();
        assert_eq!(cfg.destination_type, DestinationType::Queue);
        assert_eq!(cfg.destination_name, "my-queue");
    }

    #[test]
    fn parse_query_broker_url_override() {
        let cfg = JmsEndpointConfig::from_uri("activemq:queue:orders?brokerUrl=tcp://host:61617")
            .unwrap();
        assert_eq!(cfg.destination_name, "orders");
        assert_eq!(
            cfg.uri_overrides.broker_url.as_deref(),
            Some("tcp://host:61617")
        );
        assert!(cfg.uri_overrides.username.is_none());
    }

    #[test]
    fn parse_query_all_overrides() {
        let cfg = JmsEndpointConfig::from_uri(
            "jms:queue:orders?brokerUrl=tcp://h:1&username=admin&password=secret",
        )
        .unwrap();
        assert_eq!(cfg.uri_overrides.broker_url.as_deref(), Some("tcp://h:1"));
        assert_eq!(cfg.uri_overrides.username.as_deref(), Some("admin"));
        assert_eq!(cfg.uri_overrides.password.as_deref(), Some("secret"));
    }

    #[test]
    fn parse_query_unknown_params_ignored() {
        let cfg = JmsEndpointConfig::from_uri(
            "activemq:queue:orders?unknownParam=foo&brokerUrl=tcp://h:1",
        )
        .unwrap();
        assert_eq!(cfg.uri_overrides.broker_url.as_deref(), Some("tcp://h:1"));
    }

    #[test]
    fn parse_query_empty_value_treated_as_no_override() {
        let cfg = JmsEndpointConfig::from_uri("activemq:queue:orders?brokerUrl=").unwrap();
        assert!(cfg.uri_overrides.broker_url.is_none());
    }

    #[test]
    fn parse_activemq_empty_destination_errors() {
        assert!(JmsEndpointConfig::from_uri("activemq:queue:").is_err());
        assert!(JmsEndpointConfig::from_uri("activemq:").is_err());
    }

    #[test]
    fn parse_jms_shorthand_still_errors() {
        // jms: without explicit queue:/topic: is unchanged — still an error
        let err = JmsEndpointConfig::from_uri("jms:orders").unwrap_err();
        assert!(
            err.to_string().contains("jms:queue:name")
                || err.to_string().contains("jms:topic:name")
        );
    }

    #[test]
    fn parse_wrong_scheme_new_message() {
        let err = JmsEndpointConfig::from_uri("kafka:orders").unwrap_err();
        let msg = err.to_string();
        assert!(
            msg.contains("activemq") && msg.contains("artemis") && msg.contains("jms"),
            "error should mention all valid schemes, got: {msg}"
        );
    }

    #[test]
    fn uri_overrides_debug_redacts_password() {
        let o = JmsUriOverrides {
            broker_url: Some("tcp://host:61616".to_string()),
            username: Some("admin".to_string()),
            password: Some("secret".to_string()),
        };
        let s = format!("{:?}", o);
        assert!(
            s.contains("[REDACTED]"),
            "password must be redacted, got: {s}"
        );
        assert!(
            !s.contains("secret"),
            "raw password must not appear, got: {s}"
        );
    }

    #[test]
    fn uri_overrides_default_is_all_none() {
        let o = JmsUriOverrides::default();
        assert!(o.broker_url.is_none());
        assert!(o.username.is_none());
        assert!(o.password.is_none());
    }

    #[test]
    fn default_config_has_activemq() {
        let cfg = JmsConfig::default();
        assert_eq!(cfg.broker_type, BrokerType::ActiveMq);
        assert_eq!(cfg.bridge_start_timeout_ms, 30_000);
    }

    #[test]
    fn debug_redacts_password() {
        let cfg = JmsConfig {
            password: Some("secret".to_string()),
            ..JmsConfig::default()
        };
        let dbg = format!("{cfg:?}");
        assert!(dbg.contains("[REDACTED]"));
        assert!(!dbg.contains("secret"));
    }

    #[test]
    fn merge_overrides_uri_wins_for_broker_url() {
        let base = JmsConfig::default(); // broker_url = "tcp://localhost:61616"
        let overrides = JmsUriOverrides {
            broker_url: Some("tcp://override:9999".to_string()),
            username: None,
            password: None,
        };
        let merged = base.merge_overrides(&overrides);
        assert_eq!(merged.broker_url, "tcp://override:9999");
        assert_eq!(merged.broker_type, BrokerType::ActiveMq); // unchanged
        assert!(merged.username.is_none()); // from base
    }

    #[test]
    fn merge_overrides_base_used_when_no_override() {
        let base = JmsConfig {
            username: Some("base_user".to_string()),
            ..JmsConfig::default()
        };
        let overrides = JmsUriOverrides::default(); // all None
        let merged = base.merge_overrides(&overrides);
        assert_eq!(merged.broker_url, "tcp://localhost:61616");
        assert_eq!(merged.username.as_deref(), Some("base_user"));
    }

    #[test]
    fn merge_overrides_broker_type_never_overridden() {
        let base = JmsConfig {
            broker_type: BrokerType::Artemis,
            ..JmsConfig::default()
        };
        let overrides = JmsUriOverrides::default();
        let merged = base.merge_overrides(&overrides);
        assert_eq!(merged.broker_type, BrokerType::Artemis);
    }
}