reinhardt-tasks 0.1.0-rc.15

Background task execution and scheduling
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
//! Task result types and persistence

use crate::{TaskExecutionError, TaskId, TaskStatus};
use async_trait::async_trait;
use serde::{Deserialize, Serialize};

/// Task execution output
///
/// # Examples
///
/// ```rust
/// use reinhardt_tasks::{TaskOutput, TaskId};
///
/// let output = TaskOutput::new(TaskId::new(), "Processing completed".to_string());
/// assert_eq!(output.result(), "Processing completed");
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TaskOutput {
	task_id: TaskId,
	result: String,
}

impl TaskOutput {
	/// Create a new task output
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskOutput, TaskId};
	///
	/// let task_id = TaskId::new();
	/// let output = TaskOutput::new(task_id, "Success".to_string());
	/// ```
	pub fn new(task_id: TaskId, result: String) -> Self {
		Self { task_id, result }
	}

	/// Get the task ID
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskOutput, TaskId};
	///
	/// let task_id = TaskId::new();
	/// let output = TaskOutput::new(task_id, "Done".to_string());
	/// assert_eq!(output.task_id(), task_id);
	/// ```
	pub fn task_id(&self) -> TaskId {
		self.task_id
	}

	/// Get the result string
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskOutput, TaskId};
	///
	/// let output = TaskOutput::new(TaskId::new(), "Result data".to_string());
	/// assert_eq!(output.result(), "Result data");
	/// ```
	pub fn result(&self) -> &str {
		&self.result
	}
}

/// Task result type
pub type TaskResult = Result<TaskOutput, String>;

/// Task result metadata with status information
///
/// # Examples
///
/// ```rust
/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
///
/// let metadata = TaskResultMetadata::new(
///     TaskId::new(),
///     TaskStatus::Success,
///     Some("Task completed successfully".to_string()),
/// );
///
/// assert_eq!(metadata.status(), TaskStatus::Success);
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TaskResultMetadata {
	task_id: TaskId,
	status: TaskStatus,
	result: Option<String>,
	error: Option<String>,
	created_at: i64,
}

impl TaskResultMetadata {
	/// Create a new task result metadata
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
	///
	/// let metadata = TaskResultMetadata::new(
	///     TaskId::new(),
	///     TaskStatus::Success,
	///     Some("Done".to_string()),
	/// );
	/// ```
	pub fn new(task_id: TaskId, status: TaskStatus, result: Option<String>) -> Self {
		Self {
			task_id,
			status,
			result,
			error: None,
			created_at: chrono::Utc::now().timestamp(),
		}
	}

	/// Create a failed task result
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
	///
	/// let metadata = TaskResultMetadata::with_error(
	///     TaskId::new(),
	///     "Database connection failed".to_string(),
	/// );
	///
	/// assert_eq!(metadata.status(), TaskStatus::Failure);
	/// ```
	pub fn with_error(task_id: TaskId, error: String) -> Self {
		Self {
			task_id,
			status: TaskStatus::Failure,
			result: None,
			error: Some(error),
			created_at: chrono::Utc::now().timestamp(),
		}
	}

	/// Set the error message while preserving result and status fields.
	pub fn set_error(&mut self, error: String) {
		self.error = Some(error);
	}

	/// Get the task ID
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
	///
	/// let task_id = TaskId::new();
	/// let metadata = TaskResultMetadata::new(task_id, TaskStatus::Success, None);
	/// assert_eq!(metadata.task_id(), task_id);
	/// ```
	pub fn task_id(&self) -> TaskId {
		self.task_id
	}

	/// Get the task status
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
	///
	/// let metadata = TaskResultMetadata::new(
	///     TaskId::new(),
	///     TaskStatus::Success,
	///     None,
	/// );
	/// assert_eq!(metadata.status(), TaskStatus::Success);
	/// ```
	pub fn status(&self) -> TaskStatus {
		self.status
	}

	/// Get the result if available
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
	///
	/// let metadata = TaskResultMetadata::new(
	///     TaskId::new(),
	///     TaskStatus::Success,
	///     Some("Result".to_string()),
	/// );
	/// assert_eq!(metadata.result(), Some("Result"));
	/// ```
	pub fn result(&self) -> Option<&str> {
		self.result.as_deref()
	}

	/// Get the error if available
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId};
	///
	/// let metadata = TaskResultMetadata::with_error(
	///     TaskId::new(),
	///     "Error occurred".to_string(),
	/// );
	/// assert_eq!(metadata.error(), Some("Error occurred"));
	/// ```
	pub fn error(&self) -> Option<&str> {
		self.error.as_deref()
	}

	/// Get the creation timestamp
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::{TaskResultMetadata, TaskId, TaskStatus};
	///
	/// let metadata = TaskResultMetadata::new(TaskId::new(), TaskStatus::Success, None);
	/// let timestamp = metadata.created_at();
	/// assert!(timestamp > 0);
	/// ```
	pub fn created_at(&self) -> i64 {
		self.created_at
	}
}

/// Result backend trait for persisting task results
///
/// # Examples
///
/// ```
/// use reinhardt_tasks::{ResultBackend, TaskResultMetadata, TaskId, TaskStatus};
/// use async_trait::async_trait;
///
/// struct MyResultBackend;
///
/// #[async_trait]
/// impl ResultBackend for MyResultBackend {
///     async fn store_result(
///         &self,
///         metadata: TaskResultMetadata,
///     ) -> Result<(), reinhardt_tasks::TaskExecutionError> {
///         // Store the result
///         Ok(())
///     }
///
///     async fn get_result(
///         &self,
///         task_id: TaskId,
///     ) -> Result<Option<TaskResultMetadata>, reinhardt_tasks::TaskExecutionError> {
///         // Retrieve the result
///         Ok(None)
///     }
///
///     async fn delete_result(
///         &self,
///         task_id: TaskId,
///     ) -> Result<(), reinhardt_tasks::TaskExecutionError> {
///         // Delete the result
///         Ok(())
///     }
/// }
///
/// # async fn test_backend() {
/// let backend = MyResultBackend;
/// let task_id = TaskId::new();
/// let metadata = TaskResultMetadata::new(
///     task_id,
///     TaskStatus::Success,
///     Some("Task completed".to_string()),
/// );
///
/// // Test store and retrieve
/// assert!(backend.store_result(metadata.clone()).await.is_ok());
/// let result = backend.get_result(task_id).await.unwrap();
/// assert!(result.is_none()); // Our implementation returns None
/// # }
/// # tokio::runtime::Runtime::new().unwrap().block_on(test_backend());
/// ```
#[async_trait]
pub trait ResultBackend: Send + Sync {
	/// Store a task result
	async fn store_result(&self, metadata: TaskResultMetadata) -> Result<(), TaskExecutionError>;

	/// Get a task result
	async fn get_result(
		&self,
		task_id: TaskId,
	) -> Result<Option<TaskResultMetadata>, TaskExecutionError>;

	/// Delete a task result
	async fn delete_result(&self, task_id: TaskId) -> Result<(), TaskExecutionError>;
}

/// In-memory result backend for testing
///
/// # Examples
///
/// ```rust
/// use reinhardt_tasks::MemoryResultBackend;
///
/// let backend = MemoryResultBackend::new();
/// ```
pub struct MemoryResultBackend {
	results:
		std::sync::Arc<tokio::sync::RwLock<std::collections::HashMap<TaskId, TaskResultMetadata>>>,
}

impl MemoryResultBackend {
	/// Create a new in-memory result backend
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::MemoryResultBackend;
	///
	/// let backend = MemoryResultBackend::new();
	/// ```
	pub fn new() -> Self {
		Self {
			results: std::sync::Arc::new(
				tokio::sync::RwLock::new(std::collections::HashMap::new()),
			),
		}
	}
}

impl Default for MemoryResultBackend {
	fn default() -> Self {
		Self::new()
	}
}

#[async_trait]
impl ResultBackend for MemoryResultBackend {
	async fn store_result(&self, metadata: TaskResultMetadata) -> Result<(), TaskExecutionError> {
		let mut results = self.results.write().await;
		results.insert(metadata.task_id(), metadata);
		Ok(())
	}

	async fn get_result(
		&self,
		task_id: TaskId,
	) -> Result<Option<TaskResultMetadata>, TaskExecutionError> {
		let results = self.results.read().await;
		Ok(results.get(&task_id).cloned())
	}

	async fn delete_result(&self, task_id: TaskId) -> Result<(), TaskExecutionError> {
		let mut results = self.results.write().await;
		results.remove(&task_id);
		Ok(())
	}
}

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

	#[test]
	fn test_task_output() {
		let task_id = TaskId::new();
		let output = TaskOutput::new(task_id, "test result".to_string());
		assert_eq!(output.task_id(), task_id);
		assert_eq!(output.result(), "test result");
	}

	#[test]
	fn test_task_result_metadata() {
		let task_id = TaskId::new();
		let metadata =
			TaskResultMetadata::new(task_id, TaskStatus::Success, Some("success".to_string()));

		assert_eq!(metadata.task_id(), task_id);
		assert_eq!(metadata.status(), TaskStatus::Success);
		assert_eq!(metadata.result(), Some("success"));
		assert_eq!(metadata.error(), None);
	}

	#[test]
	fn test_task_result_metadata_with_error() {
		let task_id = TaskId::new();
		let metadata = TaskResultMetadata::with_error(task_id, "error occurred".to_string());

		assert_eq!(metadata.status(), TaskStatus::Failure);
		assert_eq!(metadata.error(), Some("error occurred"));
		assert_eq!(metadata.result(), None);
	}

	#[test]
	fn test_set_error_preserves_result_and_status() {
		// Arrange
		let task_id = TaskId::new();
		let mut metadata =
			TaskResultMetadata::new(task_id, TaskStatus::Success, Some("my result".to_string()));

		// Act
		metadata.set_error("something went wrong".to_string());

		// Assert
		assert_eq!(metadata.status(), TaskStatus::Success);
		assert_eq!(metadata.result(), Some("my result"));
		assert_eq!(metadata.error(), Some("something went wrong"));
	}

	#[tokio::test]
	async fn test_memory_result_backend() {
		let backend = MemoryResultBackend::new();
		let task_id = TaskId::new();

		let metadata =
			TaskResultMetadata::new(task_id, TaskStatus::Success, Some("result".to_string()));

		// Store result
		backend.store_result(metadata.clone()).await.unwrap();

		// Get result
		let retrieved = backend.get_result(task_id).await.unwrap();
		assert!(retrieved.is_some());
		assert_eq!(retrieved.unwrap().result(), Some("result"));

		// Delete result
		backend.delete_result(task_id).await.unwrap();
		let deleted = backend.get_result(task_id).await.unwrap();
		assert!(deleted.is_none());
	}
}