agent-queue 0.2.0

Production-grade background agent job queue system
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

use serde::{Deserialize, Serialize};

// ── Phase status: compatibility / migration-only ──
//
// All event types below use `trace_id: Option<String>` and `attempt_count: Option<u32>`
// for backward compatibility. The canonical replacements are:
//   - `trace_ctx: Option<stack_ids::TraceCtx>` (for trace_id)
//   - `attempt_id: Option<stack_ids::AttemptId>` (for attempt identity)
//   - `trial_id: Option<stack_ids::TrialId>` (for per-execution identity)
//
// Use `stack_ids::TraceCtx::from_legacy_trace_id()` to convert trace IDs.
// The `attempt_count: u32` counter semantics map to one `AttemptId` per
// re-enqueue (queue is the retry owner), with each re-enqueue creating
// a new logical retry family.
//
// Removal condition: replaced when all event consumers migrate to canonical types.

/// Emitted when a job starts executing.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct JobStartedEvent {
    pub job_id: String,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`trace_ctx`](Self::trace_ctx) instead.
    /// Removal condition: removed when all event consumers migrate to `TraceCtx`.
    #[deprecated(note = "Use trace_ctx instead. Will be removed when all consumers migrate.")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub worker_id: Option<String>,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`attempt_id`](Self::attempt_id) / [`trial_id`](Self::trial_id) instead.
    /// Removal condition: removed when all event consumers migrate to `AttemptId`/`TrialId`.
    #[deprecated(
        note = "Use attempt_id/trial_id instead. Will be removed when all consumers migrate."
    )]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_count: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Canonical trace context (replaces `trace_id`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_ctx: Option<stack_ids::TraceCtx>,
    /// Canonical attempt identity — one per re-enqueue.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_id: Option<stack_ids::AttemptId>,
    /// Canonical trial identity — one per concrete execution.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trial_id: Option<stack_ids::TrialId>,
}

/// Emitted when a job completes successfully.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct JobCompletedEvent {
    pub job_id: String,
    pub output: Option<String>,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`trace_ctx`](Self::trace_ctx) instead.
    /// Removal condition: removed when all event consumers migrate to `TraceCtx`.
    #[deprecated(note = "Use trace_ctx instead. Will be removed when all consumers migrate.")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub worker_id: Option<String>,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`attempt_id`](Self::attempt_id) / [`trial_id`](Self::trial_id) instead.
    /// Removal condition: removed when all event consumers migrate to `AttemptId`/`TrialId`.
    #[deprecated(
        note = "Use attempt_id/trial_id instead. Will be removed when all consumers migrate."
    )]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_count: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Canonical trace context (replaces `trace_id`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_ctx: Option<stack_ids::TraceCtx>,
    /// Canonical attempt identity — one per re-enqueue.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_id: Option<stack_ids::AttemptId>,
    /// Canonical trial identity — one per concrete execution.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trial_id: Option<stack_ids::TrialId>,
}

/// Emitted when a job fails.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct JobFailedEvent {
    pub job_id: String,
    pub error: String,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`trace_ctx`](Self::trace_ctx) instead.
    /// Removal condition: removed when all event consumers migrate to `TraceCtx`.
    #[deprecated(note = "Use trace_ctx instead. Will be removed when all consumers migrate.")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub worker_id: Option<String>,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`attempt_id`](Self::attempt_id) / [`trial_id`](Self::trial_id) instead.
    /// Removal condition: removed when all event consumers migrate to `AttemptId`/`TrialId`.
    #[deprecated(
        note = "Use attempt_id/trial_id instead. Will be removed when all consumers migrate."
    )]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_count: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub failure_class: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub next_retry_at: Option<String>,
    /// Canonical trace context (replaces `trace_id`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_ctx: Option<stack_ids::TraceCtx>,
    /// Canonical attempt identity — one per re-enqueue.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_id: Option<stack_ids::AttemptId>,
    /// Canonical trial identity — one per concrete execution.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trial_id: Option<stack_ids::TrialId>,
}

/// Emitted during job execution to report progress.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct JobProgressEvent {
    pub job_id: String,
    pub current_step: u32,
    pub total_steps: u32,
    pub progress: f64,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`trace_ctx`](Self::trace_ctx) instead.
    /// Removal condition: removed when all event consumers migrate to `TraceCtx`.
    #[deprecated(note = "Use trace_ctx instead. Will be removed when all consumers migrate.")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub worker_id: Option<String>,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`attempt_id`](Self::attempt_id) / [`trial_id`](Self::trial_id) instead.
    /// Removal condition: removed when all event consumers migrate to `AttemptId`/`TrialId`.
    #[deprecated(
        note = "Use attempt_id/trial_id instead. Will be removed when all consumers migrate."
    )]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_count: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Canonical trace context (replaces `trace_id`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_ctx: Option<stack_ids::TraceCtx>,
    /// Canonical attempt identity — one per re-enqueue.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_id: Option<stack_ids::AttemptId>,
    /// Canonical trial identity — one per concrete execution.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trial_id: Option<stack_ids::TrialId>,
}

/// Emitted when a job is cancelled.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct JobCancelledEvent {
    pub job_id: String,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`trace_ctx`](Self::trace_ctx) instead.
    /// Removal condition: removed when all event consumers migrate to `TraceCtx`.
    #[deprecated(note = "Use trace_ctx instead. Will be removed when all consumers migrate.")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub worker_id: Option<String>,
    /// **Deprecated — Phase status: compatibility / migration-only.**
    /// Use [`attempt_id`](Self::attempt_id) / [`trial_id`](Self::trial_id) instead.
    /// Removal condition: removed when all event consumers migrate to `AttemptId`/`TrialId`.
    #[deprecated(
        note = "Use attempt_id/trial_id instead. Will be removed when all consumers migrate."
    )]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_count: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Canonical trace context (replaces `trace_id`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trace_ctx: Option<stack_ids::TraceCtx>,
    /// Canonical attempt identity — one per re-enqueue.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attempt_id: Option<stack_ids::AttemptId>,
    /// Canonical trial identity — one per concrete execution.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trial_id: Option<stack_ids::TrialId>,
}