Merge pull request #1140 from ticosax/admin-filters

procrastinate/contrib/django/admin.py

@@ -1,11 +1,62 @@
 from __future__ import annotations
 
+import json
+
 from django.contrib import admin
+from django.template.loader import render_to_string
+from django.utils import timezone
+from django.utils.html import format_html
+from django.utils.safestring import mark_safe
 
 from . import models
 
+JOB_STATUS_EMOJI_MAPPING = {
+    "todo": "🗓️",
+    "doing": "🚂",
+    "failed": "❌",
+    "succeeded": "✅",
+    "cancelled": "🤚",
+    "aborting": "🔌🕑️",
+    "aborted": "🔌",
+}
+
+
+class ProcrastinateEventInline(admin.StackedInline):
+    model = models.ProcrastinateEvent
+
+
+@admin.register(models.ProcrastinateJob)
+class ProcrastinateJobAdmin(admin.ModelAdmin):
+    fields = [
+        "pk",
+        "short_task_name",
+        "pretty_args",
+        "pretty_status",
+        "queue_name",
+        "lock",
+        "queueing_lock",
+        "priority",
+        "scheduled_at",
+        "attempts",
+    ]
+    list_display = [
+        "pk",
+        "short_task_name",
+        "pretty_args",
+        "pretty_status",
+        "summary",
+    ]
+    list_filter = [
+        "status",
+        "queue_name",
+        "task_name",
+        "lock",
+        "queueing_lock",
+        "scheduled_at",
+        "priority",
+    ]
+    inlines = [ProcrastinateEventInline]
 
-class ProcrastinateAdmin(admin.ModelAdmin):
     def get_readonly_fields(
         self,
         request,
@@ -26,11 +77,41 @@ def has_add_permission(self, request, obj=None):
     def has_delete_permission(self, request, obj=None):
         return False
 
+    @admin.display(description="Status")
+    def pretty_status(self, instance: models.ProcrastinateJob) -> str:
+        emoji = JOB_STATUS_EMOJI_MAPPING.get(instance.status, "")
+        return f"{emoji} {instance.status.title()}"
+
+    @admin.display(description="Task Name")
+    def short_task_name(self, instance: models.ProcrastinateJob) -> str:
+        *modules, name = instance.task_name.split(".")
+        return format_html(
+            "<span title='{task_name}'>{name}</span>",
+            task_name=instance.task_name,
+            name=".".join(m[0] for m in modules) + f".{name}",
+        )
+
+    @admin.display(description="Args")
+    def pretty_args(self, instance: models.ProcrastinateJob) -> str:
+        indent = 2 if len(instance.args) > 1 or len(str(instance.args)) > 30 else None
+        pretty_json = json.dumps(instance.args, indent=indent)
+        if len(pretty_json) > 2000:
+            pretty_json = pretty_json[:2000] + "..."
+        return format_html(
+            '<pre style="margin: 0">{pretty_json}</pre>', pretty_json=pretty_json
+        )
 
-admin.site.register(
-    [
-        models.ProcrastinateJob,
-        models.ProcrastinateEvent,
-    ],
-    ProcrastinateAdmin,
-)
+    @admin.display(description="Summary")
+    def summary(self, instance: models.ProcrastinateJob) -> str:
+        if last_event := instance.procrastinateevent_set.latest():  # type: ignore[attr-defined]
+            return mark_safe(
+                render_to_string(
+                    "procrastinate/admin/summary.html",
+                    {
+                        "last_event": last_event,
+                        "job": instance,
+                        "now": timezone.now(),
+                    },
+                ).strip()
+            )
+        return ""

procrastinate/contrib/django/migrations/0030_alter_procrastinateevent_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.8 on 2024-08-08 14:27
+from __future__ import annotations
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("procrastinate", "0029_add_additional_params_to_retry_job"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="procrastinateevent",
+            options={"get_latest_by": "at", "managed": False},
+        ),
+    ]

procrastinate/contrib/django/models.py

@@ -4,6 +4,8 @@
 
 from django.db import models
 
+from procrastinate import jobs
+
 from . import exceptions, settings
 
 
@@ -85,6 +87,24 @@ class Meta:  # type: ignore
         managed = False
         db_table = "procrastinate_jobs"
 
+    @property
+    def procrastinate_job(self) -> jobs.Job:
+        return jobs.Job(
+            id=self.id,
+            queue=self.queue_name,
+            task_name=self.task_name,
+            task_kwargs=self.args,
+            priority=self.priority,
+            lock=self.lock,
+            status=self.status,
+            scheduled_at=self.scheduled_at,
+            attempts=self.attempts,
+            queueing_lock=self.queueing_lock,
+        )
+
+    def __str__(self) -> str:
+        return self.procrastinate_job.call_string
+
 
 class ProcrastinateEvent(ProcrastinateReadOnlyModelMixin, models.Model):
     TYPES = (
@@ -108,6 +128,10 @@ class ProcrastinateEvent(ProcrastinateReadOnlyModelMixin, models.Model):
     class Meta:  # type: ignore
         managed = False
         db_table = "procrastinate_events"
+        get_latest_by = "at"
+
+    def __str__(self) -> str:
+        return f"Event {self.id} - Job {self.job_id}: {self.type} at {self.at}"  # type: ignore
 
 
 class ProcrastinatePeriodicDefer(ProcrastinateReadOnlyModelMixin, models.Model):

procrastinate/contrib/django/templates/procrastinate/admin/summary.html

@@ -0,0 +1,48 @@
+<ul style="padding: 0; margin: 0;">
+  <li style="list-style-type: none">
+    {{ last_event.type | title }}
+    <strong title="{{ last_event.at|date:"Y-m-d H:i:s.u (e)" }}">{{ last_event.at|timesince }} ago</strong>
+  </li>
+  {% if job.queue_name %}
+    <li style="list-style-type: none">
+      <strong>Queue:</strong>
+      {{ job.queue_name }}
+    </li>
+  {% endif %}
+  {% if job.lock %}
+    <li style="list-style-type: none">
+      <strong>Lock:</strong>
+      {{ job.lock }}
+    </li>
+  {% endif %}
+  {% if job.queueing_lock %}
+    <li style="list-style-type: none">
+      <strong>Queueing lock:</strong>
+      {{ job.queueing_lock }}
+    </li>
+  {% endif %}
+  {% if job.priority != 0 %}
+    <li style="list-style-type: none">
+      <strong>Priority:</strong>
+      {{ job.priority }}
+    </li>
+  {% endif %}
+  {% if job.scheduled_at %}
+    <li style="list-style-type: none">
+      <strong>Scheduled:</strong>
+      <span title="{{ job.scheduled_at|date:"Y-m-d H:i:s.u (e)" }}">
+        {% if job.scheduled_at > now %}
+          in {{ job.scheduled_at|timeuntil }}
+        {% else %}
+          {{ job.scheduled_at|timesince }} ago
+        {% endif %}
+      </span>
+    </li>
+  {% endif %}
+  {% if job.attempts > 1 %}
+    <li style="list-style-type: none">
+      <strong>Attempts:</strong>
+      {{ job.attempts }}
+    </li>
+  {% endif %}
+</ul>

tests/acceptance/django_settings.py

@@ -11,6 +11,12 @@
     },
 }
 INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
     "procrastinate.contrib.django",
 ]
 USE_TZ = True  # To avoid RemovedInDjango50Warning

tests/integration/contrib/django/test_models.py

@@ -8,6 +8,7 @@
 import procrastinate
 import procrastinate.contrib.django
 import procrastinate.contrib.django.exceptions
+from procrastinate import jobs as jobs_module
 from procrastinate.contrib.django import models
 
 
@@ -30,6 +31,33 @@ def test_procrastinate_job(db):
     }
 
 
+def test_procrastinate_job__property(db):
+    job = models.ProcrastinateJob(
+        id=1,
+        queue_name="foo",
+        task_name="test_task",
+        priority=0,
+        lock="bar",
+        args={"a": 1, "b": 2},
+        status="todo",
+        scheduled_at=datetime.datetime(2021, 1, 1, tzinfo=datetime.timezone.utc),
+        attempts=0,
+        queueing_lock="baz",
+    )
+    assert job.procrastinate_job == jobs_module.Job(
+        id=1,
+        queue="foo",
+        task_name="test_task",
+        task_kwargs={"a": 1, "b": 2},
+        priority=0,
+        lock="bar",
+        status="todo",
+        scheduled_at=datetime.datetime(2021, 1, 1, tzinfo=datetime.timezone.utc),
+        attempts=0,
+        queueing_lock="baz",
+    )
+
+
 def test_procrastinate_job__no_create(db):
     with pytest.raises(procrastinate.contrib.django.exceptions.ReadOnlyModel):
         models.ProcrastinateJob.objects.create(task_name="test_task")

tests/unit/contrib/django/test_admin.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from procrastinate import jobs
+from procrastinate.contrib.django import admin
+
+
+def test_emoji_mapping():
+    assert set(admin.JOB_STATUS_EMOJI_MAPPING) == {e.value for e in jobs.Status}