qrusty_client 0.12.0

A Rust client for the qrusty priority queue server.
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
//! Qrusty API client implementation

use crate::error::QrustyClientError;
use backoff::future::retry;
use backoff::ExponentialBackoff;
use log::info;
use reqwest::{Client, StatusCode};
use serde::Deserialize;

/// Qrusty API client configuration
#[derive(Debug, Clone)]
pub struct QrustyClient {
    base_url: String,
    client: Client,
}

impl QrustyClient {
    /// Create a new QrustyClient with the given base URL
    pub fn new(base_url: impl Into<String>) -> Self {
        QrustyClient {
            base_url: base_url.into(),
            client: Client::new(),
        }
    }

    /// Checks the health of the Qrusty server.
    ///
    /// Returns `Ok(())` if the server responds with 200 OK, otherwise returns an error.
    /// Retries transient errors with exponential backoff.
    pub async fn health(&self) -> Result<(), QrustyClientError> {
        let url = format!("{}/health", self.base_url);
        info!("Checking health at {}", url);
        let op = || async {
            let resp = self
                .client
                .get(&url)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                Ok(())
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(1));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Health check failed: {}", e)))
    }

    /// Creates a new queue with the specified ordering.
    ///
    /// # Arguments
    /// * `name` - Name of the queue
    /// * `ordering` - Priority ordering ("MaxFirst" or "MinFirst")
    ///
    /// Retries transient errors with exponential backoff.
    pub async fn create_queue(&self, name: &str, ordering: &str) -> Result<(), QrustyClientError> {
        let url = format!("{}/create-queue", self.base_url);
        let body = serde_json::json!({
            "name": name,
            "config": { "ordering": ordering }
        });
        info!("Creating queue '{}' with ordering '{}'", name, ordering);
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .json(&body)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                Ok(())
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Create queue failed: {}", e)))
    }

    /// Updates an existing queue's configuration.
    ///
    /// # Arguments
    /// * `name` - Current name of the queue
    /// * `new_name` - Optional new name for the queue
    /// * `allow_duplicates` - Optional new allow_duplicates setting
    ///
    /// At least one of `new_name` or `allow_duplicates` must be specified.
    /// Queue type (ordering) cannot be changed after creation.
    ///
    /// Retries transient errors with exponential backoff.
    pub async fn update_queue(
        &self,
        name: &str,
        new_name: Option<&str>,
        allow_duplicates: Option<bool>,
    ) -> Result<(), QrustyClientError> {
        if new_name.is_none() && allow_duplicates.is_none() {
            return Err(QrustyClientError::InvalidResponse(
                "At least one of new_name or allow_duplicates must be specified".to_string(),
            ));
        }

        let url = format!("{}/update-queue", self.base_url);
        let mut config = serde_json::Map::new();
        if let Some(new_name) = new_name {
            config.insert("name".to_string(), serde_json::json!(new_name));
        }
        if let Some(allow_duplicates) = allow_duplicates {
            config.insert(
                "allow_duplicates".to_string(),
                serde_json::json!(allow_duplicates),
            );
        }

        let body = serde_json::json!({
            "name": name,
            "config": config
        });

        info!(
            "Updating queue '{}': new_name={:?}, allow_duplicates={:?}",
            name, new_name, allow_duplicates
        );
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .json(&body)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                Ok(())
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Update queue failed: {}", e)))
    }

    /// Publishes a message to the specified queue.
    ///
    /// # Arguments
    /// * `queue` - Queue name
    /// * `priority` - Message priority
    /// * `payload` - Message payload (JSON string)
    /// * `max_retries` - Optional max retry count
    ///
    /// Returns the message ID on success. Retries transient errors.
    pub async fn publish(
        &self,
        queue: &str,
        priority: u64,
        payload: &str,
        max_retries: Option<u32>,
    ) -> Result<String, QrustyClientError> {
        let url = format!("{}/publish", self.base_url);
        let mut body = serde_json::json!({
            "queue": queue,
            "priority": priority,
            "payload": payload
        });
        if let Some(retries) = max_retries {
            body["max_retries"] = serde_json::json!(retries);
        }
        info!(
            "Publishing message to queue '{}' with priority {}",
            queue, priority
        );
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .json(&body)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                let v: serde_json::Value = resp
                    .json()
                    .await
                    .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
                Ok(v["id"].as_str().unwrap_or("").to_string())
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Publish failed: {}", e)))
    }

    /// Consumes a message from the specified queue.
    ///
    /// # Arguments
    /// * `queue` - Queue name
    /// * `consumer_id` - Consumer identifier
    /// * `timeout_seconds` - Optional lock timeout
    ///
    /// Returns `Some(ConsumeResponse)` if a message is available, or `None` if the queue is empty.
    /// Retries transient errors.
    pub async fn consume(
        &self,
        queue: &str,
        consumer_id: &str,
        timeout_seconds: Option<u64>,
    ) -> Result<Option<ConsumeResponse>, QrustyClientError> {
        let url = format!("{}/consume/{}", self.base_url, queue);
        let body = serde_json::json!({
            "consumer_id": consumer_id,
            "timeout_seconds": timeout_seconds.unwrap_or(30)
        });
        info!(
            "Consuming message from queue '{}' as consumer '{}'",
            queue, consumer_id
        );
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .json(&body)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                let v: Option<ConsumeResponse> = resp
                    .json()
                    .await
                    .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
                Ok(v)
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Consume failed: {}", e)))
    }

    /// Acknowledges a message as successfully processed.
    ///
    /// # Arguments
    /// * `queue` - Queue name
    /// * `id` - Message ID
    /// * `consumer_id` - Consumer identifier
    ///
    /// Retries transient errors.
    pub async fn ack(
        &self,
        queue: &str,
        id: &str,
        consumer_id: &str,
    ) -> Result<(), QrustyClientError> {
        let url = format!("{}/ack/{}/{}", self.base_url, queue, id);
        let body = serde_json::json!({ "consumer_id": consumer_id });
        info!(
            "Acknowledging message '{}' in queue '{}' by consumer '{}'",
            id, queue, consumer_id
        );
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .json(&body)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            match resp.status() {
                StatusCode::OK => Ok(()),
                StatusCode::NOT_FOUND => Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(
                        "Message not found or not locked by this consumer".to_string(),
                    ),
                )),
                s if s.is_server_error() => Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", s)),
                )),
                _ => Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                )),
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Ack failed: {}", e)))
    }

    /// Negative acknowledges a message (failed processing).
    ///
    /// # Arguments
    /// * `queue` - Queue name
    /// * `id` - Message ID
    /// * `consumer_id` - Consumer identifier
    ///
    /// Retries transient errors.
    pub async fn nack(
        &self,
        queue: &str,
        id: &str,
        consumer_id: &str,
    ) -> Result<(), QrustyClientError> {
        let url = format!("{}/nack/{}/{}", self.base_url, queue, id);
        let body = serde_json::json!({ "consumer_id": consumer_id });
        info!(
            "Nacking message '{}' in queue '{}' by consumer '{}'",
            id, queue, consumer_id
        );
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .json(&body)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            match resp.status() {
                StatusCode::OK => Ok(()),
                StatusCode::NOT_FOUND => Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(
                        "Message not found or not locked by this consumer".to_string(),
                    ),
                )),
                s if s.is_server_error() => Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", s)),
                )),
                _ => Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                )),
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Nack failed: {}", e)))
    }

    /// Gets statistics for all queues.
    ///
    /// Returns a JSON value with queue and summary statistics. Retries transient errors.
    pub async fn stats(&self) -> Result<serde_json::Value, QrustyClientError> {
        let url = format!("{}/stats", self.base_url);
        info!("Getting queue statistics from {}", url);
        let op = || async {
            let resp = self
                .client
                .get(&url)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                let v: serde_json::Value = resp
                    .json()
                    .await
                    .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
                Ok(v)
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Stats failed: {}", e)))
    }

    /// Purges all messages from the specified queue.
    ///
    /// # Arguments
    /// * `queue` - Queue name
    ///
    /// Returns the number of purged messages. Retries transient errors.
    pub async fn purge_queue(&self, queue: &str) -> Result<usize, QrustyClientError> {
        let url = format!("{}/purge-queue/{}", self.base_url, queue);
        info!("Purging queue '{}'", queue);
        let op = || async {
            let resp = self
                .client
                .post(&url)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                let v: serde_json::Value = resp
                    .json()
                    .await
                    .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
                Ok(v["purged_messages"].as_u64().unwrap_or(0) as usize)
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Purge queue failed: {}", e)))
    }

    /// Deletes the specified queue and all its messages.
    ///
    /// # Arguments
    /// * `queue` - Queue name
    ///
    /// Returns the number of deleted messages. Retries transient errors.
    pub async fn delete_queue(&self, queue: &str) -> Result<usize, QrustyClientError> {
        let url = format!("{}/delete-queue/{}", self.base_url, queue);
        info!("Deleting queue '{}'", queue);
        let op = || async {
            let resp = self
                .client
                .delete(&url)
                .send()
                .await
                .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
            if resp.status() == StatusCode::OK {
                let v: serde_json::Value = resp
                    .json()
                    .await
                    .map_err(|e| backoff::Error::transient(QrustyClientError::Http(e)))?;
                Ok(v["deleted_messages"].as_u64().unwrap_or(0) as usize)
            } else if resp.status().is_server_error() {
                Err(backoff::Error::transient(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            } else {
                Err(backoff::Error::permanent(
                    QrustyClientError::InvalidResponse(format!("Status: {}", resp.status())),
                ))
            }
        };
        let mut backoff = ExponentialBackoff::default();
        backoff.max_elapsed_time = Some(std::time::Duration::from_secs(2));
        retry(backoff, op)
            .await
            .map_err(|e| QrustyClientError::RetryFailed(format!("Delete queue failed: {}", e)))
    }
}

#[derive(Debug, Deserialize)]
pub struct ConsumeResponse {
    pub id: String,
    pub payload: String,
    pub retry_count: u32,
}

#[cfg(test)]
mod tests {
    use super::*;
    use httpmock::Method::GET;
    use httpmock::MockServer;
    use tokio;

    #[tokio::test]
    async fn test_health_ok() {
        let server = MockServer::start();
        let health_mock = server.mock(|when, then| {
            when.method(GET).path("/health");
            then.status(200);
        });
        let client = QrustyClient::new(server.url(""));
        let result = client.health().await;
        health_mock.assert();
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_health_fail() {
        let server = MockServer::start();
        let health_mock = server.mock(|when, then| {
            when.method(GET).path("/health");
            then.status(500);
        });
        let client = QrustyClient::new(server.url(""));
        let result = client.health().await;
        // The client should retry several times before failing
        health_mock.assert_hits(health_mock.hits()); // Accept any number of hits
        assert!(result.is_err());
    }
}