Merge pull request #1124 from tcely/patch-16

Begin a common task history model

Author: meeb

tubesync/common/migrations/0001_initial.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.2.3 on 2025-06-30 07:11
+
+import common.json
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='TaskHistory',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(db_index=True, max_length=190)),
+                ('task_id', models.CharField(db_index=True, max_length=40)),
+                ('task_params', models.JSONField(default=dict, encoder=common.json.JSONEncoder)),
+                ('verbose_name', models.CharField(blank=True, max_length=255, null=True)),
+                ('start_at', models.DateTimeField(blank=True, db_index=True, null=True)),
+                ('end_at', models.DateTimeField(db_index=True, default=django.utils.timezone.now)),
+                ('priority', models.IntegerField(db_index=True, default=0)),
+                ('queue', models.CharField(blank=True, db_index=True, max_length=190, null=True)),
+                ('attempts', models.IntegerField(db_index=True, default=0)),
+                ('failed_at', models.DateTimeField(blank=True, db_index=True, null=True)),
+                ('last_error', models.TextField(blank=True)),
+                ('repeat', models.BigIntegerField(default=0)),
+                ('repeat_until', models.DateTimeField(blank=True, null=True)),
+            ],
+        ),
+    ]
+
+

tubesync/common/models.py

@@ -0,0 +1,5 @@
+from .tasks import TaskHistory
+
+__all__ = [
+    'TaskHistory',
+]

tubesync/common/models/__init__.py

@@ -0,0 +1,90 @@
+from datetime import timedelta
+
+from django.db import models
+from django.utils import timezone
+
+from ..json import JSONEncoder
+# from common.json import JSONEncoder
+
+class TaskHistoryQuerySet(models.QuerySet):
+
+    def failed(self, within=None):
+        """
+        :param within: A timedelta object
+        :return: A queryset of CompletedTasks that failed within the given timeframe (e.g. less than 1h ago)
+        """
+        qs = self.filter(
+            failed_at__isnull=False,
+        )
+        if within:
+            if not isinstance(within, timedelta):
+                within = timedelta(seconds=within)
+            time_limit = timezone.now() - within
+            qs = qs.filter(failed_at__gt=time_limit)
+        return qs
+
+    def succeeded(self, within=None):
+        """
+        :param within: A timedelta object
+        :return: A queryset of CompletedTasks that completed successfully within the given timeframe
+        (e.g. less than 1h ago)
+        """
+        qs = self.filter(
+            failed_at__isnull=True,
+        )
+        if within:
+            if not isinstance(within, timedelta):
+                within = timedelta(seconds=within)
+            time_limit = timezone.now() - within
+            qs = qs.filter(end_at__gt=time_limit)
+        return qs
+
+
+class TaskHistory(models.Model):
+    # the "name" of the task/function to be run
+    name = models.CharField(max_length=190, db_index=True)
+    task_id = models.CharField(max_length=40, db_index=True)
+    # the json encoded parameters to pass to the task
+    task_params = models.JSONField(default=dict, encoder=JSONEncoder)
+
+    verbose_name = models.CharField(max_length=255, null=True, blank=True)
+
+    start_at = models.DateTimeField(db_index=True, null=True, blank=True)
+    # when the task was completed
+    end_at = models.DateTimeField(default=timezone.now, db_index=True)
+
+    # what priority the task had
+    priority = models.IntegerField(default=0, db_index=True)
+    # the "name" of the queue this is to be run on
+    queue = models.CharField(max_length=190, db_index=True, null=True, blank=True)
+
+    # how many times the task has been tried
+    attempts = models.IntegerField(default=0, db_index=True)
+    # when the task last failed
+    failed_at = models.DateTimeField(db_index=True, null=True, blank=True)
+    # details of the error that occurred
+    last_error = models.TextField(blank=True)
+
+    repeat = models.BigIntegerField(default=0)
+    repeat_until = models.DateTimeField(null=True, blank=True)
+
+    objects = TaskHistoryQuerySet.as_manager()
+
+    def save(self, *args, **kwargs):
+        self.queue = self.queue or None
+        self.verbose_name = self.verbose_name or None
+        return super().save(*args, **kwargs)
+        
+    def has_error(self):
+        """
+        Check if the last_error field is empty.
+        """
+        return bool(self.last_error)
+
+    def __str__(self):
+        return u'{} - {}'.format(
+            self.verbose_name or self.task_name,
+            self.end_at,
+        )
+
+