asynq 0.1.8

Simple, reliable & efficient distributed task queue in Rust, inspired by hibiken/asynq
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
542
543
544
545
546
//! WebSocket Broker trait implementation
//!
//! Implements the Broker trait for WebSocketBroker.

use crate::backend::wsdb::message::{
  AddToGroupRequest, AddToGroupUniqueRequest, AggregationCheckRequest, ArchiveRequest,
  ClearServerStateRequest, ClientMessage, DeleteAggregationSetRequest, DequeueRequest,
  EnqueueUniqueRequest, ExtendLeaseRequest, ListGroupsRequest, ListLeaseExpiredRequest,
  ReadAggregationSetRequest, RetryRequest, ScheduleRequest, ScheduleUniqueRequest, ServerMessage,
  WorkerInfoData, WriteResultRequest, WriteServerStateRequest,
};
use crate::backend::wsdb::{ws_broker::CLOSE_FRAME_TIMEOUT_MS, WebSocketBroker};
use crate::base::Broker;
use crate::error::{Error, Result};
use crate::proto::{ServerInfo, TaskMessage, WorkerInfo};
use crate::task::{Task, TaskInfo};
use async_trait::async_trait;
use base64::prelude::*;
use chrono::{DateTime, Utc};
use std::time::Duration;

#[async_trait]
impl Broker for WebSocketBroker {
  /// Ping the server
  async fn ping(&self) -> Result<()> {
    let resp = self.send_and_receive(ClientMessage::Ping).await?;
    match resp {
      ServerMessage::Pong => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Close the connection
  async fn close(&self) -> Result<()> {
    let mut conn = self.connection.write().await;
    if let Some(mut ws_conn) = conn.take() {
      // Signal shutdown to send Close frame
      if let Some(shutdown_tx) = ws_conn.shutdown_tx.take() {
        let _ = shutdown_tx.send(());
      }
      // Give time for Close frame to be sent and acknowledged
      tokio::time::sleep(tokio::time::Duration::from_millis(CLOSE_FRAME_TIMEOUT_MS)).await;
    }
    Ok(())
  }

  /// Enqueue a task
  async fn enqueue(&self, task: &Task) -> Result<TaskInfo> {
    let req = self.task_to_enqueue_request(task);
    let resp = self.send_and_receive(ClientMessage::Enqueue(req)).await?;
    self.handle_task_info_response(resp)
  }

  /// Enqueue a unique task
  async fn enqueue_unique(&self, task: &Task, ttl: Duration) -> Result<TaskInfo> {
    let req = EnqueueUniqueRequest {
      enqueue: self.task_to_enqueue_request(task),
      ttl_seconds: ttl.as_secs(),
    };
    let resp = self
      .send_and_receive(ClientMessage::EnqueueUnique(req))
      .await?;
    self.handle_task_info_response(resp)
  }

  /// Dequeue a task
  async fn dequeue(&self, queues: &[String]) -> Result<Option<TaskMessage>> {
    let req = DequeueRequest {
      queues: queues.to_vec(),
    };
    let resp = self.send_and_receive(ClientMessage::Dequeue(req)).await?;
    match resp {
      ServerMessage::DequeueResult(Some(task_resp)) => {
        Ok(Some(self.response_to_task_message(&task_resp)?))
      }
      ServerMessage::DequeueResult(None) => Ok(None),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Mark a task as done
  async fn done(&self, msg: &TaskMessage) -> Result<()> {
    let req = self.task_message_to_done_request(msg);
    let resp = self.send_and_receive(ClientMessage::Done(req)).await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Mark a task as complete
  async fn mark_as_complete(&self, msg: &TaskMessage) -> Result<()> {
    let req = self.task_message_to_done_request(msg);
    let resp = self
      .send_and_receive(ClientMessage::MarkComplete(req))
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Requeue a task
  async fn requeue(
    &self,
    msg: &TaskMessage,
    process_at: DateTime<Utc>,
    error_msg: &str,
  ) -> Result<()> {
    self
      .retry(msg, process_at, error_msg, !error_msg.is_empty())
      .await
  }

  /// Schedule a task
  async fn schedule(&self, task: &Task, process_at: DateTime<Utc>) -> Result<TaskInfo> {
    let req = ScheduleRequest {
      enqueue: self.task_to_enqueue_request(task),
      process_at: process_at.timestamp(),
    };
    let resp = self.send_and_receive(ClientMessage::Schedule(req)).await?;
    self.handle_task_info_response(resp)
  }

  /// Schedule a unique task
  async fn schedule_unique(
    &self,
    task: &Task,
    process_at: DateTime<Utc>,
    ttl: Duration,
  ) -> Result<TaskInfo> {
    let req = ScheduleUniqueRequest {
      schedule: ScheduleRequest {
        enqueue: self.task_to_enqueue_request(task),
        process_at: process_at.timestamp(),
      },
      ttl_seconds: ttl.as_secs(),
    };
    let resp = self
      .send_and_receive(ClientMessage::ScheduleUnique(req))
      .await?;
    self.handle_task_info_response(resp)
  }

  /// Retry a task
  async fn retry(
    &self,
    msg: &TaskMessage,
    process_at: DateTime<Utc>,
    error_msg: &str,
    is_failure: bool,
  ) -> Result<()> {
    let req = RetryRequest {
      task: self.task_message_to_done_request(msg),
      process_at: process_at.timestamp(),
      error_msg: error_msg.to_string(),
      is_failure,
    };
    let resp = self.send_and_receive(ClientMessage::Retry(req)).await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Archive a task
  async fn archive(&self, msg: &TaskMessage, error_msg: &str) -> Result<()> {
    let req = ArchiveRequest {
      task: self.task_message_to_done_request(msg),
      error_msg: error_msg.to_string(),
    };
    let resp = self.send_and_receive(ClientMessage::Archive(req)).await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Forward ready tasks - Not directly supported via WebSocket
  async fn forward_if_ready(&self, _queues: &[String]) -> Result<i64> {
    // Server handles this internally
    Ok(0)
  }

  /// Add a task to a group for aggregation
  async fn add_to_group(&self, task: &Task, group: &str) -> Result<TaskInfo> {
    let req = AddToGroupRequest {
      enqueue: self.task_to_enqueue_request(task),
      group: group.to_string(),
    };
    let resp = self
      .send_and_receive(ClientMessage::AddToGroup(req))
      .await?;
    self.handle_task_info_response(resp)
  }

  /// Add a unique task to a group for aggregation
  async fn add_to_group_unique(&self, task: &Task, group: &str, ttl: Duration) -> Result<TaskInfo> {
    let req = AddToGroupUniqueRequest {
      enqueue: self.task_to_enqueue_request(task),
      group: group.to_string(),
      ttl_seconds: ttl.as_secs(),
    };
    let resp = self
      .send_and_receive(ClientMessage::AddToGroupUnique(req))
      .await?;
    self.handle_task_info_response(resp)
  }

  /// List groups in a queue
  async fn list_groups(&self, queue: &str) -> Result<Vec<String>> {
    let req = ListGroupsRequest {
      queue: queue.to_string(),
    };
    let resp = self
      .send_and_receive(ClientMessage::ListGroups(req))
      .await?;
    match resp {
      ServerMessage::GroupsList(groups) => Ok(groups),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Check if aggregation conditions are met
  async fn aggregation_check(
    &self,
    queue: &str,
    group: &str,
    aggregation_delay: Duration,
    max_delay: Duration,
    max_size: usize,
  ) -> Result<Option<String>> {
    let req = AggregationCheckRequest {
      queue: queue.to_string(),
      group: group.to_string(),
      aggregation_delay_seconds: aggregation_delay.as_secs(),
      max_delay_seconds: max_delay.as_secs(),
      max_size,
    };
    let resp = self
      .send_and_receive(ClientMessage::AggregationCheck(req))
      .await?;
    match resp {
      ServerMessage::AggregationSetId(set_id) => Ok(set_id),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Read tasks from an aggregation set
  async fn read_aggregation_set(
    &self,
    queue: &str,
    group: &str,
    set_id: &str,
  ) -> Result<Vec<TaskMessage>> {
    let req = ReadAggregationSetRequest {
      queue: queue.to_string(),
      group: group.to_string(),
      set_id: set_id.to_string(),
    };
    let resp = self
      .send_and_receive(ClientMessage::ReadAggregationSet(req))
      .await?;
    match resp {
      ServerMessage::AggregationSet(tasks) => {
        let mut result = Vec::new();
        for task_resp in tasks {
          result.push(self.response_to_task_message(&task_resp)?);
        }
        Ok(result)
      }
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Delete an aggregation set
  async fn delete_aggregation_set(&self, queue: &str, group: &str, set_id: &str) -> Result<()> {
    let req = DeleteAggregationSetRequest {
      queue: queue.to_string(),
      group: group.to_string(),
      set_id: set_id.to_string(),
    };
    let resp = self
      .send_and_receive(ClientMessage::DeleteAggregationSet(req))
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Reclaim stale aggregation sets - Server handles this
  async fn reclaim_stale_aggregation_sets(&self, _queue: &str) -> Result<()> {
    Ok(())
  }

  /// Delete expired completed tasks - Server handles this
  async fn delete_expired_completed_tasks(&self, _queue: &str) -> Result<i64> {
    Ok(0)
  }

  /// List lease expired tasks
  async fn list_lease_expired(
    &self,
    cutoff: DateTime<Utc>,
    queues: &[String],
  ) -> Result<Vec<TaskMessage>> {
    let req = ListLeaseExpiredRequest {
      cutoff: cutoff.timestamp(),
      queues: queues.to_vec(),
    };
    let resp = self
      .send_and_receive(ClientMessage::ListLeaseExpired(req))
      .await?;
    match resp {
      ServerMessage::LeaseExpiredTasks(tasks) => {
        let mut result = Vec::new();
        for task_resp in tasks {
          result.push(self.response_to_task_message(&task_resp)?);
        }
        Ok(result)
      }
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Extend lease for a task
  async fn extend_lease(&self, queue: &str, task_id: &str, lease_duration: Duration) -> Result<()> {
    let req = ExtendLeaseRequest {
      queue: queue.to_string(),
      task_id: task_id.to_string(),
      lease_duration_seconds: lease_duration.as_secs(),
    };
    let resp = self
      .send_and_receive(ClientMessage::ExtendLease(req))
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Write server state
  async fn write_server_state(
    &self,
    server_info: &ServerInfo,
    workers: Vec<WorkerInfo>,
    ttl: Duration,
    _tenant: Option<&str>,
  ) -> Result<()> {
    let worker_data: Vec<WorkerInfoData> = workers
      .into_iter()
      .map(|w| WorkerInfoData {
        host: w.host.clone(),
        pid: w.pid,
        server_id: w.server_id.clone(),
        task_id: w.task_id.clone(),
        task_type: w.task_type.clone(),
        task_payload: BASE64_STANDARD.encode(&w.task_payload),
        queue: w.queue.clone(),
      })
      .collect();

    let req = WriteServerStateRequest {
      host: server_info.host.clone(),
      pid: server_info.pid,
      server_id: server_info.server_id.clone(),
      concurrency: server_info.concurrency,
      queues: server_info.queues.clone(),
      strict_priority: server_info.strict_priority,
      status: server_info.status.clone(),
      active_worker_count: server_info.active_worker_count,
      ttl_seconds: ttl.as_secs(),
      workers: worker_data,
    };
    let resp = self
      .send_and_receive(ClientMessage::WriteServerState(req))
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Clear server state
  async fn clear_server_state(
    &self,
    host: &str,
    pid: i32,
    server_id: &str,
    _tenant: Option<&str>,
  ) -> Result<()> {
    let req = ClearServerStateRequest {
      host: host.to_string(),
      pid,
      server_id: server_id.to_string(),
    };
    let resp = self
      .send_and_receive(ClientMessage::ClearServerState(req))
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Subscribe to cancellation events
  async fn cancellation_pub_sub(
    &self,
  ) -> Result<Box<dyn futures::Stream<Item = Result<String>> + Unpin + Send>> {
    use futures::stream::unfold;

    // Subscribe to cancellation channel
    let receiver = self.cancel_tx.subscribe();

    // Send subscription message to server
    let _ = self
      .send_and_receive(ClientMessage::SubscribeCancellation)
      .await;

    // Create a stream from the broadcast receiver
    let stream = unfold(receiver, |mut rx| async move {
      loop {
        match rx.recv().await {
          Ok(task_id) => return Some((Ok(task_id), rx)),
          Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => continue,
          Err(tokio::sync::broadcast::error::RecvError::Closed) => return None,
        }
      }
    });

    Ok(Box::new(Box::pin(stream)))
  }

  /// Publish cancellation
  async fn publish_cancellation(&self, task_id: &str) -> Result<()> {
    let resp = self
      .send_and_receive(ClientMessage::PublishCancellation {
        task_id: task_id.to_string(),
      })
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }

  /// Write task result
  async fn write_result(&self, queue: &str, task_id: &str, result: &[u8]) -> Result<()> {
    let req = WriteResultRequest {
      queue: queue.to_string(),
      task_id: task_id.to_string(),
      result: BASE64_STANDARD.encode(result),
    };
    let resp = self
      .send_and_receive(ClientMessage::WriteResult(req))
      .await?;
    match resp {
      ServerMessage::Success => Ok(()),
      ServerMessage::Error { message } => Err(Error::broker(message)),
      _ => Err(Error::invalid_message("Unexpected response")),
    }
  }
}

/// WebSocketBroker 实现 SchedulerBroker trait
/// WebSocketBroker implements the SchedulerBroker trait
///
/// 注意:WebSocket 后端的调度器功能可能受限,因为它通常连接到远程服务器
/// Note: Scheduler functionality for WebSocket backend may be limited as it typically connects to a remote server
#[async_trait]
impl crate::base::SchedulerBroker for WebSocketBroker {
  /// 批量写入 scheduler entries
  /// Batch write scheduler entries
  async fn write_scheduler_entries(
    &self,
    _entries: &[crate::proto::SchedulerEntry],
    _scheduler_id: &str,
    _ttl_secs: u64,
    _tenant: Option<&str>,
  ) -> Result<()> {
    // WebSocket 后端通常不支持调度器持久化
    // WebSocket backend typically doesn't support scheduler persistence
    // 这些功能由服务器端处理
    // These features are handled by the server side
    Ok(())
  }

  /// 记录调度事件
  /// Record scheduling event
  async fn record_scheduler_enqueue_event(
    &self,
    _event: &crate::proto::SchedulerEnqueueEvent,
    _entry_id: &str,
  ) -> Result<()> {
    // WebSocket 后端通常不支持调度器事件记录
    // WebSocket backend typically doesn't support scheduler event recording
    Ok(())
  }

  /// 获取所有 SchedulerEntry
  /// Get all SchedulerEntry
  async fn scheduler_entries_script(
    &self,
    _scheduler_id: &str,
  ) -> Result<std::collections::HashMap<String, Vec<u8>>> {
    // 返回空的结果
    // Return empty result
    Ok(std::collections::HashMap::new())
  }

  /// 获取调度事件列表
  /// Get scheduling event list
  async fn scheduler_events_script(&self, _count: usize) -> Result<Vec<Vec<u8>>> {
    // 返回空的结果
    // Return empty result
    Ok(Vec::new())
  }

  /// 删除 scheduler entries 数据
  /// Delete scheduler entries data
  async fn clear_scheduler_entries(
    &self,
    _scheduler_id: &str,
    _tenant: Option<&str>,
  ) -> Result<()> {
    // WebSocket 后端通常不需要清理
    // WebSocket backend typically doesn't need cleanup
    Ok(())
  }
}