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
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
//! Task registry for dynamic task dispatch
//!
//! This module provides a registry system to store and retrieve task executors
//! by name, enabling dynamic task dispatch in distributed task systems.

use crate::{TaskError, TaskExecutor, TaskResult};
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::RwLock;

/// Serialized task data for storage and transmission
///
/// # Examples
///
/// ```rust
/// use reinhardt_tasks::SerializedTask;
///
/// let task = SerializedTask::new(
///     "send_email".to_string(),
///     r#"{"to":"user@example.com","subject":"Hello"}"#.to_string(),
/// );
///
/// assert_eq!(task.name(), "send_email");
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SerializedTask {
	name: String,
	data: String,
}

impl SerializedTask {
	/// Create a new serialized task
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::SerializedTask;
	///
	/// let task = SerializedTask::new("process_data".to_string(), "{}".to_string());
	/// ```
	pub fn new(name: String, data: String) -> Self {
		Self { name, data }
	}

	/// Get the task name
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::SerializedTask;
	///
	/// let task = SerializedTask::new("task_name".to_string(), "{}".to_string());
	/// assert_eq!(task.name(), "task_name");
	/// ```
	pub fn name(&self) -> &str {
		&self.name
	}

	/// Get the task data
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::SerializedTask;
	///
	/// let task = SerializedTask::new("task".to_string(), r#"{"key":"value"}"#.to_string());
	/// assert_eq!(task.data(), r#"{"key":"value"}"#);
	/// ```
	pub fn data(&self) -> &str {
		&self.data
	}

	/// Convert to JSON string
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::SerializedTask;
	///
	/// let task = SerializedTask::new("test".to_string(), "{}".to_string());
	/// let json = task.to_json().unwrap();
	/// assert!(json.contains("\"name\":\"test\""));
	/// ```
	pub fn to_json(&self) -> Result<String, serde_json::Error> {
		serde_json::to_string(self)
	}

	/// Create from JSON string
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::SerializedTask;
	///
	/// let json = r#"{"name":"test","data":"{}"}"#;
	/// let task = SerializedTask::from_json(json).unwrap();
	/// assert_eq!(task.name(), "test");
	/// ```
	pub fn from_json(json: &str) -> Result<Self, serde_json::Error> {
		serde_json::from_str(json)
	}
}

/// Task factory trait for creating task executors from serialized data
///
/// # Examples
///
/// ```rust,no_run
/// use reinhardt_tasks::{TaskFactory, TaskResult, TaskExecutor, Task, TaskError, TaskId};
/// use async_trait::async_trait;
///
/// struct EmailTask { to: String }
///
/// impl Task for EmailTask {
///     fn name(&self) -> &str { "EmailTask" }
///     fn id(&self) -> TaskId { TaskId::new() }
/// }
///
/// #[async_trait]
/// impl TaskExecutor for EmailTask {
///     async fn execute(&self) -> TaskResult<()> { Ok(()) }
/// }
///
/// struct EmailTaskFactory;
///
/// #[async_trait]
/// impl TaskFactory for EmailTaskFactory {
///     async fn create(&self, data: &str) -> TaskResult<Box<dyn TaskExecutor>> {
///         // Deserialize data and create task executor
///         let email_data: serde_json::Value = serde_json::from_str(data)
///             .map_err(|e| TaskError::SerializationError(e.to_string()))?;
///         Ok(Box::new(EmailTask { to: email_data["to"].as_str().unwrap().to_string() }))
///     }
/// }
/// ```
#[async_trait]
pub trait TaskFactory: Send + Sync {
	/// Create a task executor from serialized data
	async fn create(&self, data: &str) -> TaskResult<Box<dyn TaskExecutor>>;
}

/// Global task registry for dynamic task dispatch
///
/// This registry maintains a mapping of task names to their factory functions,
/// allowing workers to dynamically create and execute tasks based on serialized data.
///
/// # Examples
///
/// ```rust,no_run
/// use reinhardt_tasks::{TaskRegistry, TaskFactory, TaskResult, TaskExecutor, Task, TaskError, TaskId};
/// use async_trait::async_trait;
/// use std::sync::Arc;
///
/// # struct EmailTaskFactory;
/// # struct EmailTask { to: String }
/// # impl Task for EmailTask {
/// #     fn name(&self) -> &str { "EmailTask" }
/// #     fn id(&self) -> TaskId { TaskId::new() }
/// # }
/// # #[async_trait]
/// # impl TaskExecutor for EmailTask {
/// #     async fn execute(&self) -> TaskResult<()> { Ok(()) }
/// # }
/// # #[async_trait]
/// # impl TaskFactory for EmailTaskFactory {
/// #     async fn create(&self, data: &str) -> TaskResult<Box<dyn TaskExecutor>> {
/// #         let email_data: serde_json::Value = serde_json::from_str(data)
/// #             .map_err(|e| TaskError::SerializationError(e.to_string()))?;
/// #         Ok(Box::new(EmailTask { to: email_data["to"].as_str().unwrap().to_string() }))
/// #     }
/// # }
///
/// # async fn example() -> TaskResult<()> {
/// let registry = TaskRegistry::new();
///
/// // Register a task factory
/// registry.register("send_email".to_string(), Arc::new(EmailTaskFactory)).await;
///
/// // Create task from serialized data
/// let task_data = r#"{"to":"user@example.com"}"#;
/// let executor = registry.create("send_email", task_data).await?;
/// # Ok(())
/// # }
/// ```
pub struct TaskRegistry {
	factories: Arc<RwLock<HashMap<String, Arc<dyn TaskFactory>>>>,
}

impl TaskRegistry {
	/// Create a new task registry
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::TaskRegistry;
	///
	/// let registry = TaskRegistry::new();
	/// ```
	pub fn new() -> Self {
		Self {
			factories: Arc::new(RwLock::new(HashMap::new())),
		}
	}

	/// Register a task factory
	///
	/// # Examples
	///
	/// ```rust,no_run
	/// use reinhardt_tasks::{TaskRegistry, TaskFactory, Task, TaskId};
	/// use std::sync::Arc;
	///
	/// # struct MyTaskFactory;
	/// # struct MyTask;
	/// # impl Task for MyTask {
	/// #     fn name(&self) -> &str { "MyTask" }
	/// #     fn id(&self) -> TaskId { TaskId::new() }
	/// # }
	/// # #[async_trait::async_trait]
	/// # impl reinhardt_tasks::TaskExecutor for MyTask {
	/// #     async fn execute(&self) -> reinhardt_tasks::TaskResult<()> { Ok(()) }
	/// # }
	/// # #[async_trait::async_trait]
	/// # impl TaskFactory for MyTaskFactory {
	/// #     async fn create(&self, _data: &str) -> reinhardt_tasks::TaskResult<Box<dyn reinhardt_tasks::TaskExecutor>> {
	/// #         Ok(Box::new(MyTask))
	/// #     }
	/// # }
	///
	/// # async fn example() {
	/// let registry = TaskRegistry::new();
	/// let factory = Arc::new(MyTaskFactory);
	/// registry.register("my_task".to_string(), factory).await;
	/// # }
	/// ```
	pub async fn register(&self, name: String, factory: Arc<dyn TaskFactory>) {
		let mut factories = self.factories.write().await;
		factories.insert(name, factory);
	}

	/// Unregister a task factory
	///
	/// # Examples
	///
	/// ```rust,no_run
	/// use reinhardt_tasks::TaskRegistry;
	///
	/// # async fn example() {
	/// let registry = TaskRegistry::new();
	/// registry.unregister("task_name").await;
	/// # }
	/// ```
	pub async fn unregister(&self, name: &str) {
		let mut factories = self.factories.write().await;
		factories.remove(name);
	}

	/// Check if a task is registered
	///
	/// # Examples
	///
	/// ```rust,no_run
	/// use reinhardt_tasks::TaskRegistry;
	///
	/// # async fn example() {
	/// let registry = TaskRegistry::new();
	/// let exists = registry.has("task_name").await;
	/// assert!(!exists);
	/// # }
	/// ```
	pub async fn has(&self, name: &str) -> bool {
		let factories = self.factories.read().await;
		factories.contains_key(name)
	}

	/// Create a task executor from serialized data
	///
	/// # Examples
	///
	/// ```rust,no_run
	/// use reinhardt_tasks::TaskRegistry;
	///
	/// # async fn example() -> reinhardt_tasks::TaskResult<()> {
	/// let registry = TaskRegistry::new();
	/// let executor = registry.create("task_name", r#"{"key":"value"}"#).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn create(&self, name: &str, data: &str) -> TaskResult<Box<dyn TaskExecutor>> {
		let factories = self.factories.read().await;

		let factory = factories
			.get(name)
			.ok_or_else(|| TaskError::ExecutionFailed(format!("Task not registered: {}", name)))?;

		factory.create(data).await
	}

	/// Get all registered task names
	///
	/// # Examples
	///
	/// ```rust,no_run
	/// use reinhardt_tasks::TaskRegistry;
	///
	/// # async fn example() {
	/// let registry = TaskRegistry::new();
	/// let task_names = registry.list().await;
	/// println!("Registered tasks: {:?}", task_names);
	/// # }
	/// ```
	pub async fn list(&self) -> Vec<String> {
		let factories = self.factories.read().await;
		factories.keys().cloned().collect()
	}

	/// Clear all registered task factories
	///
	/// # Examples
	///
	/// ```rust
	/// use reinhardt_tasks::TaskRegistry;
	///
	/// # async fn example() {
	/// let registry = TaskRegistry::new();
	/// registry.clear().await;
	/// # }
	/// ```
	pub async fn clear(&self) {
		let mut factories = self.factories.write().await;
		factories.clear();
	}
}

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

#[cfg(test)]
mod tests {
	use super::*;
	use crate::{Task, TaskId, TaskPriority};

	struct TestTask {
		id: TaskId,
	}

	impl Task for TestTask {
		fn id(&self) -> TaskId {
			self.id
		}

		fn name(&self) -> &str {
			"test_task"
		}

		fn priority(&self) -> TaskPriority {
			TaskPriority::default()
		}
	}

	#[async_trait]
	impl TaskExecutor for TestTask {
		async fn execute(&self) -> TaskResult<()> {
			Ok(())
		}
	}

	struct TestTaskFactory;

	#[async_trait]
	impl TaskFactory for TestTaskFactory {
		async fn create(&self, _data: &str) -> TaskResult<Box<dyn TaskExecutor>> {
			Ok(Box::new(TestTask { id: TaskId::new() }))
		}
	}

	#[test]
	fn test_serialized_task() {
		let task = SerializedTask::new("test".to_string(), r#"{"key":"value"}"#.to_string());
		assert_eq!(task.name(), "test");
		assert_eq!(task.data(), r#"{"key":"value"}"#);
	}

	#[test]
	fn test_serialized_task_json() {
		let task = SerializedTask::new("test".to_string(), "{}".to_string());
		let json = task.to_json().unwrap();
		let restored = SerializedTask::from_json(&json).unwrap();
		assert_eq!(restored.name(), "test");
	}

	#[tokio::test]
	async fn test_registry_register_and_has() {
		let registry = TaskRegistry::new();
		let factory = Arc::new(TestTaskFactory);

		assert!(!registry.has("test_task").await);

		registry.register("test_task".to_string(), factory).await;

		assert!(registry.has("test_task").await);
	}

	#[tokio::test]
	async fn test_registry_unregister() {
		let registry = TaskRegistry::new();
		let factory = Arc::new(TestTaskFactory);

		registry.register("test_task".to_string(), factory).await;
		assert!(registry.has("test_task").await);

		registry.unregister("test_task").await;
		assert!(!registry.has("test_task").await);
	}

	#[tokio::test]
	async fn test_registry_create() {
		let registry = TaskRegistry::new();
		let factory = Arc::new(TestTaskFactory);

		registry.register("test_task".to_string(), factory).await;

		let executor = registry.create("test_task", "{}").await;
		assert!(executor.is_ok());
	}

	#[tokio::test]
	async fn test_registry_create_not_found() {
		let registry = TaskRegistry::new();

		let result = registry.create("nonexistent", "{}").await;
		assert!(result.is_err());
	}

	#[tokio::test]
	async fn test_registry_list() {
		let registry = TaskRegistry::new();
		let factory = Arc::new(TestTaskFactory);

		registry
			.register("task1".to_string(), factory.clone())
			.await;
		registry.register("task2".to_string(), factory).await;

		let names = registry.list().await;
		assert_eq!(names.len(), 2);
		assert!(names.contains(&"task1".to_string()));
		assert!(names.contains(&"task2".to_string()));
	}

	#[tokio::test]
	async fn test_registry_clear() {
		let registry = TaskRegistry::new();
		let factory = Arc::new(TestTaskFactory);

		registry.register("task1".to_string(), factory).await;
		assert!(registry.has("task1").await);

		registry.clear().await;
		assert!(!registry.has("task1").await);
	}
}