feat (#66): added starting datetimes to TaskResults

django_tasks/backends/database/admin.py

@@ -13,6 +13,7 @@ class DBTaskResultAdmin(admin.ModelAdmin):
         "get_task_name",
         "status",
         "enqueued_at",
+        "started_at",
         "finished_at",
         "priority",
         "queue_name",

django_tasks/backends/database/migrations/0004_dbtaskresult_started_at.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.0.6 on 2024-07-04 09:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        (
+            "django_tasks_database",
+            "0003_dbtaskresult_enqueued_at_dbtaskresult_finished_at",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="dbtaskresult",
+            name="started_at",
+            field=models.DateTimeField(null=True),
+        ),
+    ]

django_tasks/backends/database/models.py

@@ -64,6 +64,7 @@ class DBTaskResult(GenericBase[P, T], models.Model):
     )
 
     enqueued_at = models.DateTimeField(auto_now_add=True)
+    started_at = models.DateTimeField(null=True)
     finished_at = models.DateTimeField(null=True)
 
     args_kwargs = models.JSONField()
@@ -112,6 +113,7 @@ def task_result(self) -> "TaskResult[T]":
             id=str(self.id),
             status=ResultStatus[self.status],
             enqueued_at=self.enqueued_at,
+            started_at=self.started_at,
             finished_at=self.finished_at,
             args=self.args_kwargs["args"],
             kwargs=self.args_kwargs["kwargs"],
@@ -128,7 +130,8 @@ def claim(self) -> None:
         Mark as job as being run
         """
         self.status = ResultStatus.RUNNING
-        self.save(update_fields=["status"])
+        self.started_at = timezone.now()
+        self.save(update_fields=["status", "started_at"])
 
     @retry()
     def set_result(self, result: Any) -> None:

django_tasks/backends/dummy.py

@@ -35,6 +35,7 @@ def enqueue(
             id=str(uuid4()),
             status=ResultStatus.NEW,
             enqueued_at=timezone.now(),
+            started_at=None,
             finished_at=None,
             args=json_normalize(args),
             kwargs=json_normalize(kwargs),

django_tasks/backends/immediate.py

@@ -28,6 +28,7 @@ def enqueue(
         )
 
         enqueued_at = timezone.now()
+        started_at = timezone.now()
         try:
             result = json_normalize(calling_task_func(*args, **kwargs))
             status = ResultStatus.COMPLETE
@@ -40,6 +41,7 @@ def enqueue(
             id=str(uuid4()),
             status=status,
             enqueued_at=enqueued_at,
+            started_at=started_at,
             finished_at=timezone.now(),
             args=json_normalize(args),
             kwargs=json_normalize(kwargs),

django_tasks/task.py

@@ -205,6 +205,9 @@ class TaskResult(Generic[T]):
     enqueued_at: datetime
     """The time this task was enqueued"""
 
+    started_at: Optional[datetime]
+    """The time this task was started"""
+
     finished_at: Optional[datetime]
     """The time this task was finished"""
 
@@ -238,8 +241,9 @@ def refresh(self) -> None:
         """
         refreshed_task = self.task.get_backend().get_result(self.id)
 
-        # status, finished_at and result are the only refreshable attributes
+        # status, started_at, finished_at and result are the only refreshable attributes
         self.status = refreshed_task.status
+        self.started_at = refreshed_task.started_at
         self.finished_at = refreshed_task.finished_at
         self._result = refreshed_task._result
 
@@ -249,7 +253,8 @@ async def arefresh(self) -> None:
         """
         refreshed_task = await self.task.get_backend().aget_result(self.id)
 
-        # status, finished_at and result are the only refreshable attributes
+        # status, started_at, finished_at and result are the only refreshable attributes
         self.status = refreshed_task.status
+        self.started_at = refreshed_task.started_at
         self.finished_at = refreshed_task.finished_at
         self._result = refreshed_task._result

tests/tests/test_database_backend.py

@@ -40,6 +40,7 @@ def test_enqueue_task(self) -> None:
                 result = default_task_backend.enqueue(task, (1,), {"two": 3})
 
                 self.assertEqual(result.status, ResultStatus.NEW)
+                self.assertIsNone(result.started_at)
                 self.assertIsNone(result.finished_at)
                 with self.assertRaisesMessage(ValueError, "Task has not finished yet"):
                     result.result  # noqa:B018
@@ -53,6 +54,7 @@ async def test_enqueue_task_async(self) -> None:
                 result = await default_task_backend.aenqueue(task, [], {})
 
                 self.assertEqual(result.status, ResultStatus.NEW)
+                self.assertIsNone(result.started_at)
                 self.assertIsNone(result.finished_at)
                 with self.assertRaisesMessage(ValueError, "Task has not finished yet"):
                     result.result  # noqa:B018
@@ -82,13 +84,17 @@ def test_refresh_result(self) -> None:
         )
 
         DBTaskResult.objects.all().update(
-            status=ResultStatus.COMPLETE, finished_at=timezone.now()
+            status=ResultStatus.COMPLETE,
+            started_at=timezone.now(),
+            finished_at=timezone.now(),
         )
 
         self.assertEqual(result.status, ResultStatus.NEW)
+        self.assertIsNone(result.started_at)
         self.assertIsNone(result.finished_at)
         with self.assertNumQueries(1):
             result.refresh()
+        self.assertIsNotNone(result.started_at)
         self.assertIsNotNone(result.finished_at)
         self.assertEqual(result.status, ResultStatus.COMPLETE)
 
@@ -98,12 +104,16 @@ async def test_refresh_result_async(self) -> None:
         )
 
         await DBTaskResult.objects.all().aupdate(
-            status=ResultStatus.COMPLETE, finished_at=timezone.now()
+            status=ResultStatus.COMPLETE,
+            started_at=timezone.now(),
+            finished_at=timezone.now(),
         )
 
         self.assertEqual(result.status, ResultStatus.NEW)
+        self.assertIsNone(result.started_at)
         self.assertIsNone(result.finished_at)
         await result.arefresh()
+        self.assertIsNotNone(result.started_at)
         self.assertIsNotNone(result.finished_at)
         self.assertEqual(result.status, ResultStatus.COMPLETE)
 
@@ -226,8 +236,10 @@ def test_run_enqueued_task(self) -> None:
 
                 self.assertEqual(result.status, ResultStatus.NEW)
                 result.refresh()
+                self.assertIsNotNone(result.started_at)
                 self.assertIsNotNone(result.finished_at)
-                self.assertGreaterEqual(result.finished_at, result.enqueued_at)
+                self.assertGreaterEqual(result.started_at, result.enqueued_at)
+                self.assertGreaterEqual(result.finished_at, result.started_at)
                 self.assertEqual(result.status, ResultStatus.COMPLETE)
 
                 self.assertEqual(DBTaskResult.objects.ready().count(), 0)
@@ -289,8 +301,11 @@ def test_failing_task(self) -> None:
 
         self.assertEqual(result.status, ResultStatus.NEW)
         result.refresh()
+        self.assertIsNotNone(result.started_at)
         self.assertIsNotNone(result.finished_at)
-        self.assertGreaterEqual(result.finished_at, result.enqueued_at)  # type: ignore[arg-type]
+
+        self.assertGreaterEqual(result.started_at, result.enqueued_at)  # type: ignore
+        self.assertGreaterEqual(result.finished_at, result.started_at)  # type: ignore
         self.assertEqual(result.status, ResultStatus.FAILED)
 
         self.assertEqual(DBTaskResult.objects.ready().count(), 0)

tests/tests/test_dummy_backend.py

@@ -26,6 +26,7 @@ def test_enqueue_task(self) -> None:
                 result = default_task_backend.enqueue(task, (1,), {"two": 3})
 
                 self.assertEqual(result.status, ResultStatus.NEW)
+                self.assertIsNone(result.started_at)
                 self.assertIsNone(result.finished_at)
                 with self.assertRaisesMessage(ValueError, "Task has not finished yet"):
                     result.result  # noqa:B018
@@ -41,6 +42,7 @@ async def test_enqueue_task_async(self) -> None:
                 result = await default_task_backend.aenqueue(task, (), {})
 
                 self.assertEqual(result.status, ResultStatus.NEW)
+                self.assertIsNone(result.started_at)
                 self.assertIsNone(result.finished_at)
                 with self.assertRaisesMessage(ValueError, "Task has not finished yet"):
                     result.result  # noqa:B018

tests/tests/test_immediate_backend.py

@@ -24,8 +24,10 @@ def test_enqueue_task(self) -> None:
                 result = default_task_backend.enqueue(task, (1,), {"two": 3})
 
                 self.assertEqual(result.status, ResultStatus.COMPLETE)
+                self.assertIsNotNone(result.started_at)
                 self.assertIsNotNone(result.finished_at)
-                self.assertGreaterEqual(result.finished_at, result.enqueued_at)
+                self.assertGreaterEqual(result.started_at, result.enqueued_at)
+                self.assertGreaterEqual(result.finished_at, result.started_at)
                 self.assertIsNone(result.result)
                 self.assertEqual(result.task, task)
                 self.assertEqual(result.args, [1])
@@ -37,8 +39,10 @@ async def test_enqueue_task_async(self) -> None:
                 result = await default_task_backend.aenqueue(task, (), {})
 
                 self.assertEqual(result.status, ResultStatus.COMPLETE)
+                self.assertIsNotNone(result.started_at)
                 self.assertIsNotNone(result.finished_at)
-                self.assertGreaterEqual(result.finished_at, result.enqueued_at)
+                self.assertGreaterEqual(result.started_at, result.enqueued_at)
+                self.assertGreaterEqual(result.finished_at, result.started_at)
                 self.assertIsNone(result.result)
                 self.assertEqual(result.task, task)
                 self.assertEqual(result.args, [])
@@ -48,8 +52,10 @@ def test_catches_exception(self) -> None:
         result = default_task_backend.enqueue(test_tasks.failing_task, [], {})
 
         self.assertEqual(result.status, ResultStatus.FAILED)
+        self.assertIsNotNone(result.started_at)
         self.assertIsNotNone(result.finished_at)
-        self.assertGreaterEqual(result.finished_at, result.enqueued_at)
+        self.assertGreaterEqual(result.started_at, result.enqueued_at)
+        self.assertGreaterEqual(result.finished_at, result.started_at)
         self.assertIsNone(result.result)
         self.assertEqual(result.task, test_tasks.failing_task)
         self.assertEqual(result.args, [])