flowsdk 0.5.3

Safety-first, realistic, behavior-predictable messaging SDK for MQTT and more.
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
// SPDX-License-Identifier: MPL-2.0

//! Timeout Integration Tests
//!
//! Tests to verify timeout behavior for sync operations in TokioAsyncMqttClient:
//! - Default timeout configuration
//! - Custom timeout overrides
//! - Timeout expiration behavior
//! - Error handling and recovery

use async_trait::async_trait;
use flowsdk::mqtt_client::client::ConnectionResult;
use flowsdk::mqtt_client::opts::MqttClientOptions;
use flowsdk::mqtt_client::tokio_async_client::{
    TokioAsyncClientConfig, TokioAsyncMqttClient, TokioMqttEventHandler,
};
use flowsdk::mqtt_client::MqttClientError;
use std::sync::{Arc, Mutex};
use std::time::Duration;

/// Simple event handler for testing
#[derive(Clone)]
struct TestEventHandler {
    connected_count: Arc<Mutex<u32>>,
}

impl TestEventHandler {
    fn new() -> Self {
        Self {
            connected_count: Arc::new(Mutex::new(0)),
        }
    }

    fn get_connected_count(&self) -> u32 {
        *self.connected_count.lock().unwrap()
    }
}

#[async_trait]
impl TokioMqttEventHandler for TestEventHandler {
    async fn on_connected(&mut self, _result: &ConnectionResult) {
        let mut count = self.connected_count.lock().unwrap();
        *count += 1;
    }
}

/// Test that connect_sync respects the configured timeout
#[tokio::test]
async fn test_connect_sync_with_default_timeout() {
    // Create a config with a short connect timeout
    let config = TokioAsyncClientConfig::builder()
        .connect_timeout_ms(100) // 100ms timeout
        .build();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-connect-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    // This should either succeed quickly or timeout
    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            let start = std::time::Instant::now();
            let result = client.connect_sync().await;
            let duration = start.elapsed();

            match result {
                Ok(_) => {
                    // Connection succeeded within timeout
                    assert!(
                        duration < Duration::from_millis(150),
                        "Connect should complete within timeout + margin"
                    );
                }
                Err(MqttClientError::OperationTimeout {
                    operation,
                    timeout_ms,
                }) => {
                    // Expected timeout behavior
                    assert_eq!(operation, "connect");
                    assert_eq!(timeout_ms, 100);
                    assert!(
                        duration >= Duration::from_millis(95)
                            && duration <= Duration::from_millis(150),
                        "Timeout should occur around the configured duration, got {:?}",
                        duration
                    );
                }
                Err(e) => {
                    // Other errors (e.g., connection refused) are also acceptable
                    println!("Connect failed with non-timeout error: {}", e);
                }
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test custom timeout override for connect_sync
#[tokio::test]
async fn test_connect_sync_with_custom_timeout() {
    let config = TokioAsyncClientConfig::default();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-connect-custom-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            // Use a very short custom timeout (50ms)
            let start = std::time::Instant::now();
            let result = client.connect_sync_with_timeout(50).await;
            let duration = start.elapsed();

            match result {
                Ok(_) => {
                    // Connection succeeded within custom timeout
                    assert!(
                        duration < Duration::from_millis(100),
                        "Connect should complete within custom timeout + margin"
                    );
                }
                Err(MqttClientError::OperationTimeout {
                    operation,
                    timeout_ms,
                }) => {
                    // Expected timeout behavior with custom timeout
                    assert_eq!(operation, "connect");
                    assert_eq!(timeout_ms, 50);
                    assert!(
                        duration >= Duration::from_millis(45)
                            && duration <= Duration::from_millis(100),
                        "Custom timeout should occur around 50ms, got {:?}",
                        duration
                    );
                }
                Err(e) => {
                    println!("Connect failed with non-timeout error: {}", e);
                }
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test that successful operations complete before timeout
#[tokio::test]
async fn test_successful_operation_within_timeout() {
    let config = TokioAsyncClientConfig::builder()
        .connect_timeout_ms(5000) // 5 second timeout
        .build();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-success-within-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler.clone()), config).await {
        Ok(client) => {
            let start = std::time::Instant::now();
            match client.connect_sync().await {
                Ok(result) => {
                    let duration = start.elapsed();

                    // Successful connection should complete well before timeout
                    assert!(
                        duration < Duration::from_secs(5),
                        "Successful connect should not take full timeout duration"
                    );

                    println!("✅ Connected successfully in {:?}", duration);
                    println!("   Reason code: {}", result.reason_code);
                    println!("   Session present: {}", result.session_present);

                    // Verify the event handler was called
                    assert_eq!(handler.get_connected_count(), 1);

                    // Clean disconnect
                    let _ = client.disconnect().await;
                }
                Err(e) => {
                    println!("Connect failed (broker may not be running): {}", e);
                }
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test timeout error conversion to io::Error
#[tokio::test]
async fn test_timeout_error_conversion_to_io_error() {
    let config = TokioAsyncClientConfig::builder()
        .connect_timeout_ms(100) // 100ms timeout
        .build();

    let options = MqttClientOptions::builder()
        .peer("192.0.2.1:1883") // TEST-NET-1: Should not be routable
        .client_id("test-timeout-conversion")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            // Test that MqttClientError can be converted to io::Error
            let result: Result<_, std::io::Error> = client.connect_sync().await.map_err(Into::into);

            match result {
                Ok(_) => {
                    println!("Unexpectedly connected");
                }
                Err(io_err) => {
                    // Verify it converted to io::Error
                    println!("Got io::Error: {:?} - {}", io_err.kind(), io_err);

                    // Timeout should map to io::ErrorKind::TimedOut
                    if io_err.to_string().contains("timed out") {
                        assert_eq!(io_err.kind(), std::io::ErrorKind::TimedOut);
                    }
                }
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test publish timeout with custom override
#[tokio::test]
async fn test_publish_sync_with_timeout() {
    let config = TokioAsyncClientConfig::default();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-publish-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            // Try to connect first
            if client.connect_sync().await.is_ok() {
                // Try publishing with a custom timeout
                let result = client
                    .publish_sync_with_timeout("test/topic", b"test payload", 1, false, 5000)
                    .await;

                match result {
                    Ok(pub_result) => {
                        println!("✅ Published successfully");
                        println!("   Packet ID: {:?}", pub_result.packet_id);
                        println!("   Reason code: {:?}", pub_result.reason_code);
                    }
                    Err(MqttClientError::OperationTimeout {
                        operation,
                        timeout_ms,
                    }) => {
                        assert_eq!(operation, "publish");
                        assert_eq!(timeout_ms, 5000);
                        println!("⏱️  Publish timed out as expected");
                    }
                    Err(e) => {
                        println!("Publish failed: {}", e);
                    }
                }

                let _ = client.disconnect().await;
            } else {
                println!("Could not connect (broker may not be running)");
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test subscribe timeout with custom override
#[tokio::test]
async fn test_subscribe_sync_with_timeout() {
    let config = TokioAsyncClientConfig::default();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-subscribe-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            if client.connect_sync().await.is_ok() {
                // Try subscribing with a custom timeout
                let result = client
                    .subscribe_sync_with_timeout("test/topic/#", 1, 3000)
                    .await;

                match result {
                    Ok(sub_result) => {
                        println!("✅ Subscribed successfully");
                        println!("   Packet ID: {:?}", sub_result.packet_id);
                        println!("   Reason codes: {:?}", sub_result.reason_codes);
                    }
                    Err(MqttClientError::OperationTimeout {
                        operation,
                        timeout_ms,
                    }) => {
                        assert_eq!(operation, "subscribe");
                        assert_eq!(timeout_ms, 3000);
                        println!("⏱️  Subscribe timed out as expected");
                    }
                    Err(e) => {
                        println!("Subscribe failed: {}", e);
                    }
                }

                let _ = client.disconnect().await;
            } else {
                println!("Could not connect (broker may not be running)");
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test ping timeout
#[tokio::test]
async fn test_ping_sync_with_timeout() {
    let config = TokioAsyncClientConfig::default();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-ping-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            if client.connect_sync().await.is_ok() {
                // Test ping with custom timeout
                let start = std::time::Instant::now();
                let result = client.ping_sync_with_timeout(2000).await;
                let duration = start.elapsed();

                match result {
                    Ok(_) => {
                        println!("✅ Ping succeeded in {:?}", duration);
                        assert!(duration < Duration::from_secs(2));
                    }
                    Err(MqttClientError::OperationTimeout {
                        operation,
                        timeout_ms,
                    }) => {
                        assert_eq!(operation, "ping");
                        assert_eq!(timeout_ms, 2000);
                        println!("⏱️  Ping timed out as expected");
                    }
                    Err(e) => {
                        println!("Ping failed: {}", e);
                    }
                }

                let _ = client.disconnect().await;
            } else {
                println!("Could not connect (broker may not be running)");
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}

/// Test that None timeout means no timeout (operation waits indefinitely)
#[tokio::test]
async fn test_none_timeout_means_no_timeout() {
    let config = TokioAsyncClientConfig::builder()
        .no_connect_timeout() // No timeout
        .build();

    let options = MqttClientOptions::builder()
        .peer("127.0.0.1:1883")
        .client_id("test-no-timeout")
        .clean_start(true)
        .build();

    let handler = TestEventHandler::new();

    match TokioAsyncMqttClient::new(options, Box::new(handler), config).await {
        Ok(client) => {
            // With None timeout, this should wait indefinitely or until success/failure
            // We wrap it in our own timeout to prevent test hanging
            let result = tokio::time::timeout(Duration::from_secs(10), client.connect_sync()).await;

            match result {
                Ok(Ok(_)) => {
                    println!("✅ Connected successfully with no timeout configured");
                    let _ = client.disconnect().await;
                }
                Ok(Err(e)) => {
                    // Should not be OperationTimeout since we set timeout to None
                    match e {
                        MqttClientError::OperationTimeout { .. } => {
                            panic!("Should not get OperationTimeout when timeout is None");
                        }
                        _ => {
                            println!("Connect failed with non-timeout error: {}", e);
                        }
                    }
                }
                Err(_) => {
                    // Our test timeout expired, but client should still be trying
                    println!("Test timeout expired (expected with None timeout config)");
                }
            }
        }
        Err(e) => {
            println!("Failed to create client: {}", e);
        }
    }
}