django-admin-background-task 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

bgtask/admin.py

@@ -2,7 +2,6 @@ from django.contrib import admin
 from django.template.loader import render_to_string
 
 from .models import BackgroundTask
-from .views import task_dict
 
 
 def background_task_status(obj):
@@ -15,7 +14,7 @@ def background_task_status(obj):
         bgtask = bgtasks.first()
 
     output = render_to_string(
-        "bgtask/bg_changelist_status_column.html", {"bgtask": bgtask and task_dict(bgtask)}
+        "bgtask/bg_changelist_status_column.html", {"bgtask": bgtask and bgtask.task_dict}
     )
     return output
 
@@ -25,6 +24,9 @@ background_task_status.__name__ = "Task Status"
 
 @admin.register(BackgroundTask)
 class BackgroundTaskAdmin(admin.ModelAdmin):
-    list_filter = ["state", "result"]
-    list_display = ("created", background_task_status, "result", "completed_at")
+    list_filter = ["state", "namespace", "name"]
+    list_display = ("created", "namespace_name", background_task_status, "result", "completed_at")
     ordering = ["-created"]
+
+    def namespace_name(self, bgtask):
+        return ".".join(f for f in [bgtask.namespace, bgtask.name] if f)

bgtask/backends/__init__.py

@@ -0,0 +1,3 @@
+from . import thread_pool
+
+default_backend = thread_pool

bgtask/backends/thread_pool.py

@@ -0,0 +1,12 @@
+from concurrent.futures import ThreadPoolExecutor
+
+
+SHARED_THREAD_POOL = None
+
+
+def dispatch(func, bg_task, *args, **kwargs):
+    global SHARED_THREAD_POOL
+    if SHARED_THREAD_POOL is None:
+        SHARED_THREAD_POOL = ThreadPoolExecutor()
+
+    SHARED_THREAD_POOL.submit(func, bg_task, *args, **kwargs)

bgtask/decorators.py

@@ -0,0 +1,46 @@
+import logging
+from functools import wraps
+
+from django.contrib.messages import INFO
+
+
+from .models import BackgroundTask
+
+
+log = logging.getLogger(__name__)
+
+
+def bgtask_admin_action(func=None):
+    if func is not None:
+        return bgtask_admin_action()(func)
+
+    def bgtask_admin_action_factory(func):
+
+        task_name = f"AdminTask-{func.__name__}"
+
+        @wraps(func)
+        def bgtask_admin_action_wrapper(self, request, queryset):
+            log.info("Running func %s", func.__name__)
+            bg_task = self.start_bgtask(task_name)
+
+            self.message_user(request, "Started background task", level=INFO)
+
+            from .backends import default_backend
+
+            default_backend.dispatch(_run_bg_task_func, func, bg_task, request, queryset)
+
+
+        bgtask_admin_action_wrapper.bgtask_name = task_name
+
+        return bgtask_admin_action_wrapper
+
+    return bgtask_admin_action_factory
+
+
+def _run_bg_task_func(func, bg_task, request, queryset):
+    try:
+        func(bg_task, request, queryset)
+    except Exception as exc:
+        bg_task.fail(exc)
+    else:
+        bg_task.succeed()

bgtask/migrations/0002_backgroundtask_namespace_alter_backgroundtask_name.py

@@ -0,0 +1,31 @@
+# Generated by Django 4.2.11 on 2024-04-16 14:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bgtask", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="backgroundtask",
+            name="namespace",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="Optional namespace that can be used to avoid having to make names unique across an entire codebase, allowing them to be shorter and human readable",
+                max_length=1000,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="backgroundtask",
+            name="name",
+            field=models.CharField(
+                help_text="Name (or type) of this task, is not unique per task instance but generally per task functionality",
+                max_length=1000,
+            ),
+        ),
+    ]

bgtask/model_admin.py

@@ -0,0 +1,72 @@
+from datetime import timedelta
+
+from django.contrib import admin
+from django.contrib.admin.utils import label_for_field
+from django.db.models import Q
+from django.utils import timezone
+
+from .models import BackgroundTask
+
+
+class BGTaskModelAdmin(admin.ModelAdmin):
+    # This is not overridden to avoid messing with the implicit logic for finding change list
+    # templates that ModelAdmin uses. So you either need to specify this yourself on your
+    # subclass or you need to extend from this in your custom template.
+    # change_list_template = "bgtask/admin/change_list.html"
+
+    # ----------------------------------------------------------------------------------------------
+    # API for subclasses
+    # ----------------------------------------------------------------------------------------------
+    def start_bgtask(self, name, **kwargs):
+        bgtask = BackgroundTask.objects.create(
+            name=name,
+            namespace=self._bgtask_namespace,
+            **kwargs,
+        )
+        bgtask.start()
+        return bgtask
+
+    # ----------------------------------------------------------------------------------------------
+    # Superclass overrides
+    # ----------------------------------------------------------------------------------------------
+    def changelist_view(self, request, extra_context=None):
+        extra_context = extra_context or {}
+        extra_context["admin_bg_tasks"] = self._admin_bg_tasks(request)
+        return super().changelist_view(request, extra_context=extra_context)
+
+    # ----------------------------------------------------------------------------------------------
+    # Internal functions
+    # ----------------------------------------------------------------------------------------------
+    @property
+    def _bgtask_namespace(self):
+        return type(self).__module__ + "." + type(self).__name__
+
+    def _admin_bg_tasks(self, request):
+        task_name_to_desc = {}
+        for action, action_name, action_description in self.get_actions(request).values():
+            if hasattr(action, "bgtask_name"):
+                task_name_to_desc[action.bgtask_name] = action_description
+
+        for name in getattr(self, "bgtask_names", []):
+            task_name_to_desc[name] = name
+
+        if not task_name_to_desc:
+            return BackgroundTask.objects.none()
+
+        bgts = list(
+            BackgroundTask.objects.filter(
+                name__in=task_name_to_desc, namespace=self._bgtask_namespace
+            )
+            .filter(
+                Q(state=BackgroundTask.STATES.running)
+                | (
+                    ~Q(state=BackgroundTask.STATES.not_started)
+                    & Q(completed_at__gt=timezone.now() - timedelta(minutes=30))
+                )
+            )
+            .order_by("-started_at")
+        )
+        for bgt in bgts:
+            bgt.admin_description = task_name_to_desc[bgt.name]
+
+        return bgts

bgtask/models.py

@@ -4,10 +4,12 @@ import os
 import time
 import traceback
 import uuid
+from contextlib import contextmanager
 
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.db import models, transaction
+from django.forms.models import model_to_dict
 from django.utils import timezone
 
 from model_utils import Choices
@@ -19,9 +21,19 @@ log = logging.getLogger(__name__)
 def locked(meth):
     @functools.wraps(meth)
     def _locked_meth(self, *args, **kwargs):
+        if getattr(self, "_locked", False):
+            return meth(self, *args, **kwargs)
+
         with transaction.atomic():
             BackgroundTask.objects.filter(id=self.id).select_for_update().only("id").get()
-            return meth(self, *args, **kwargs)
+            self.refresh_from_db()
+
+            # Mark as locked in case we are called recursively
+            self._locked = True
+            try:
+                return meth(self, *args, **kwargs)
+            finally:
+                self._locked = False
 
     return _locked_meth
 
@@ -41,14 +53,24 @@ def only_if_state(state):
     return only_if_state_decorator
 
 
-class CreatedUpdatedMixin(models.Model):
-    class Meta:
-        abstract = True
-
-
-class BackgroundTask(CreatedUpdatedMixin):
+class BackgroundTask(models.Model):
     id = models.UUIDField(primary_key=True, editable=False, default=uuid.uuid4)
-    name = models.CharField(max_length=1000)
+    name = models.CharField(
+        max_length=1000,
+        help_text=(
+            "Name (or type) of this task, is not unique "
+            "per task instance but generally per task functionality"
+        ),
+    )
+    namespace = models.CharField(
+        max_length=1000,
+        default="",
+        blank=True,
+        help_text=(
+            "Optional namespace that can be used to avoid having to make names unique across an "
+            "entire codebase, allowing them to be shorter and human readable"
+        ),
+    )
 
     STATES = Choices("not_started", "running", "success", "partial_success", "failed")
     state = models.CharField(max_length=16, default=STATES.not_started, choices=STATES)
@@ -79,6 +101,11 @@ class BackgroundTask(CreatedUpdatedMixin):
     class Meta:
         ordering = ["created", "id"]
 
+    @property
+    def task_dict(self):
+        task_dict = model_to_dict(self)
+        return {"id": str(self.id), "updated": self.updated.isoformat(), **task_dict}
+
     @property
     def num_failed_steps(self):
         return sum(error.get("num_failed_steps", 0) for error in self.errors)
@@ -87,6 +114,24 @@ class BackgroundTask(CreatedUpdatedMixin):
     def incomplete(self):
         return self.state in [self.STATES.not_started, self.STATES.running]
 
+    @contextmanager
+    def runs_single_step(self):
+        try:
+            yield
+        except Exception as exc:
+            self.steps_failed(1, error=exc)
+        else:
+            self.add_successful_steps(1)
+
+    @contextmanager
+    def finishes(self):
+        try:
+            yield
+        except Exception as exc:
+            self.fail(exc)
+        else:
+            self.succeed()
+
     @locked
     @only_if_state(STATES.not_started)
     def start(self):
@@ -109,10 +154,10 @@ class BackgroundTask(CreatedUpdatedMixin):
 
     @locked
     @only_if_state(STATES.running)
-    def succeed(self, result):
+    def succeed(self, result=None):
         log.info("%s succeeded.", self)
         self.state = self.STATES.success
-        self.completion = 1
+        self.steps_completed = self.steps_to_complete
         self.completed_at = timezone.now()
         self.result = self.serialize_result(result)
         self.save()
@@ -125,8 +170,8 @@ class BackgroundTask(CreatedUpdatedMixin):
             log.info("Finishing as success with no errors")
             self.state = self.STATES.success
         elif self.steps_to_complete is None:
-            log.info("Finishing as failure with no steps to complete configured")
-            self.state = self.STATES.failed
+            log.info("Finishing as success with no steps to complete configured")
+            self.state = self.STATES.success
         elif self.num_failed_steps == self.steps_to_complete:
             log.info("Finishing as failure with all steps failed")
             self.state = self.STATES.failed
@@ -134,11 +179,13 @@ class BackgroundTask(CreatedUpdatedMixin):
             log.info("Finishing as partial success with some steps failed")
             self.state = self.STATES.partial_success
 
+        self.completed_at = timezone.now()
+        self.save()
+
     @locked
     def add_successful_steps(self, num_steps):
         self.steps_completed += num_steps
-        self._maybe_finish()
-        self.save()
+        self._finish_or_save()
 
     @locked
     def steps_failed(self, num_steps, steps_identifier=None, error=None):
@@ -153,8 +200,7 @@ class BackgroundTask(CreatedUpdatedMixin):
         error_dict.update(self._error_dict_for_error(error))
 
         self.errors.append(error_dict)
-        self._maybe_finish()
-        self.save()
+        self._finish_or_save()
 
     def dispatch(self):
         # double fork to avoid zombies
@@ -227,9 +273,12 @@ class BackgroundTask(CreatedUpdatedMixin):
             )
         return error_dict
 
-    def _maybe_finish(self):
-        if self.steps_to_complete is None:
-            return
-
-        if self.steps_completed >= self.steps_to_complete:
+    def _finish_or_save(self):
+        if (
+            self.steps_to_complete is not None
+            and self.steps_completed is not None
+            and self.steps_completed >= self.steps_to_complete
+        ):
             self.finish()
+        else:
+            self.save()

bgtask/static/bgtask/js/bgtask.js

@@ -21,7 +21,7 @@ class ProgressState {
     constructor(element, {value, max} = {value: null, max: null}) {
         this.element = element;
 
-        this.timerId = null;
+        this.animationFrameRequestId = null;
 
         this.max = max;
         // set it immediately initially
@@ -56,56 +56,60 @@ class ProgressState {
       this._cancelTimer();
       const currentValue = this.progEle.value || 0;
       if (value === null || value === undefined) {
+          // console.info("null value");
           this.progEle.removeAttribute("value");
-          this._clearState();
           return
       }
       if (value >= this.max) {
+          // console.info("greater than max", value, this.max);
           this.progEle.value = this.max;
-          this._clearState();
           return;
       }
       if (currentValue === value) {
-          this._clearState();
+          // console.info("already at value", currentValue, value);
           return;
       }
 
       // completion due in the refresh period plus a bit so that we don't get there too soon
       // and cause a visible stop: we would rather the next update arrived before we reached the
       // target value
-      const completionDue = new Date(new Date().getTime() + REFRESH_PERIOD_MS + 500);
-      const initialMSToCompletion = completionDue - new Date();
+      const now = new Date();
+      const completionDue = new Date(now.getTime() + REFRESH_PERIOD_MS + PROGRESS_REFRESH_MS);
+      const initialMSToCompletion = completionDue - now;
+      const completionDueHighRes = performance.now() + initialMSToCompletion;
       const previousValue = currentValue;
 
-      const updateProgress = () => {
-          const now = new Date();
-          if (completionDue <= now) {
-              this.progEle.value = value;
-              this._cancelTimer();
-              this._clearState();
-              return;
-          }
-
-          const msRemaining = completionDue - now;
-
-          const newValue = previousValue + (
-              ((initialMSToCompletion - msRemaining) / initialMSToCompletion)
-              * (value - previousValue)
-          );
-          this.progEle.value = newValue;
-      };
-
-      this.timerId = setInterval(updateProgress, PROGRESS_REFRESH_MS);
-    }
+      let startTimestamp = null;
 
-    _cancelTimer() {
-        if (this.timerId !== null) {
-            clearInterval(this.timerId);
+      const updateProgressStep = (now) => {
+        if (startTimestamp === null) {
+          startTimestamp = now;
+          this.animationFrameRequestId = window.requestAnimationFrame(updateProgressStep);
+          return;
+        }
+        const msRemaining = completionDueHighRes - now;
+        const newValue = previousValue + (
+            ((initialMSToCompletion - msRemaining) / initialMSToCompletion)
+            * (value - previousValue)
+        );
+
+        if (completionDue <= now || Math.abs((value - newValue) / this.progEle.max) < 0.001) {
+          this.progEle.value = value;
+          return;
         }
-        this.timerId = null;
+
+        this.progEle.value = newValue;
+        this.animationFrameRequestId = window.requestAnimationFrame(updateProgressStep);
+      }
+
+      this.animationFrameRequestId = window.requestAnimationFrame(updateProgressStep);
     }
 
-    _clearState() {
+    _cancelTimer() {
+        if (this.animationFrameRequestId !== null) {
+          window.cancelAnimationFrame(this.animationFrameRequestId)
+        }
+        this.animationFrameRequestId = null;
     }
 }
 

bgtask/templates/bgtask/admin/change_list.html

@@ -0,0 +1,31 @@
+{% extends "admin/change_list.html" %}
+{% load static %}
+
+{% block extrastyle %}
+{{ block.super }}
+<link rel="stylesheet" type="text/css" href="{% static "admin/css/forms.css" %}">
+{% endblock %}
+
+{% block object-tools %}
+{{ block.super }}
+<div>
+  <h3>Action background tasks</h3>
+  {% if not admin_bg_tasks|length %}
+  <p class="help" style="font-style: italic;">No recent background tasks</p>
+  {% else %}
+  <table>
+    <thead>
+      <tr><th>Task name</th><th>Started</th><th>Finished</th><th>Status</th></tr>
+    </thead>
+    <tbody>
+      {% for bgt in admin_bg_tasks %}
+      {% with bgtask=bgt.task_dict %}
+      <tr class="bgtask-row"><td><a href="{% url 'admin:bgtask_backgroundtask_change' bgtask.id %}">{{ bgt.admin_description }}</a></td><td>{{ bgt.started_at|timesince }} ago</td><td>{% if bgt.completed_at %}{{ bgt.completed_at|timesince }} ago{% else %}–{% endif %}</td><td>
+      {% include "bgtask/bg_changelist_status_column.html" %}</td></tr>
+      {% endwith %}
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endif %}
+</div>
+{% endblock %}

bgtask/templates/bgtask/bg_changelist_status_column.html

@@ -6,7 +6,11 @@
 {{ bgtask|json_script:initialTasksJsonId }}
 {% endwith %}
 <script src="{% static 'bgtask/js/bgtask-once.js' %}"></script>
+{% if bgtask.acted_on_object_id %}
 <a href="{% url 'bgtask:tasks' %}?object_id={{bgtask.acted_on_object_id}}">
+{% else %}
+<a href="{% url 'admin:bgtask_backgroundtask_change' bgtask.id %}">
+{% endif %}
     <div id="bgtask-column-{{ bgtask.id }}">
         {% include 'bgtask/progress.html' %}
     </div>

bgtask/views.py

@@ -10,15 +10,8 @@ from .models import BackgroundTask
 Q_NONE = Q(pk__in=[])
 
 
-def task_dict(task):
-    task_dict = model_to_dict(task)
-    if "stack_context" in task_dict:
-        del task_dict["stack_context"]
-    return {"id": str(task.id), "updated": task.updated.isoformat(), **task_dict}
-
-
 def _tasks_dict(tasks):
-    td = {str(task.id): task_dict(task) for task in tasks}
+    td = {str(task.id): task.task_dict for task in tasks}
     return td
 
 

{django_admin_background_task-0.1.0.dist-info → django_admin_background_task-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-admin-background-task
-Version: 0.1.0
+Version: 0.2.0
 Summary: A set of tools for django apps to persist and monitor the status of background tasks
 Home-page: https://github.com/daphtdazz/django-bgtask
 License: Apache-2.0
@@ -41,7 +41,7 @@ INSTALLED_APPS = [
 ]
 ```
 
-And mount the amdin monitoring URLs:
+And mount the admin monitoring URLs:
 
 ```
 urlpatterns = [

{django_admin_background_task-0.1.0.dist-info → django_admin_background_task-0.2.0.dist-info}/RECORD

@@ -1,14 +1,19 @@
-bgtask/.DS_Store,sha256=TdvU4O6xL31hGFKIbymkCVOa_vP5cJS4x-K9dIzwxGI,6148
 bgtask/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bgtask/admin.py,sha256=G400_bFRTFzYexKajrJ3eS6lvy4mFBWQq7hGXEZxEJk,854
+bgtask/admin.py,sha256=cOhbR__7WJ3rmjlbZjGKh_gJDpEz_c6Ll2zwHo7mpiM,965
 bgtask/apps.py,sha256=zZHsNaW9nnJgK7jnpty0IjM0TTpsk33xhpsGTa-x3iE,144
+bgtask/backends/__init__.py,sha256=zZlL7gHXL12heAhHD_7D7lEBihCE-LHYb07yIbk055s,57
+bgtask/backends/thread_pool.py,sha256=y5EtO9ltA5lc7GUtvqHPJuoo1brJPOurp1IQ7JdCUEI,304
+bgtask/decorators.py,sha256=UsiCBhqaWm1Yn4n4hmFbauGQvNezoeDm7Iqpjbvxbjk,1119
 bgtask/migrations/0001_initial.py,sha256=YDTEy_hiXHru-1ZdIH-n3po82r5vyzbkyYIrF9_yiI8,2013
+bgtask/migrations/0002_backgroundtask_namespace_alter_backgroundtask_name.py,sha256=XIG_gIvdA73tz0NRbNkGU_ieKde3ZtQltPeLdslD5Xo,968
 bgtask/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bgtask/models.py,sha256=04Cz_XgibkRukbteZcaI2qFuYEzwHfe04Ucxt1cLCpE,7683
+bgtask/model_admin.py,sha256=tx90pz3MGMkN2DsZ8jEwEXY875QVXySGg_9rGcID50k,2925
+bgtask/models.py,sha256=VulETkcBXJkyUgmExSx9fuOvpp1HnY2sLQLD5BUvbHk,9184
 bgtask/stack_contexts.py,sha256=2Hun6O5Mm949uAioC2E3i54Rg-_H8P7LsHdhJYc0w6E,231
 bgtask/static/bgtask/js/bgtask-once.js,sha256=DBerpxPLP21IH--HpBxVFk3kN52FtBiuyJsDCjg7mCA,746
-bgtask/static/bgtask/js/bgtask.js,sha256=0S_emqYF1WStRWgOAqPn0gKst4Ytn9EGnWJelkecesU,12636
-bgtask/templates/bgtask/bg_changelist_status_column.html,sha256=AKvJvIoPG7LVmRvcsNGzOExe0qT71Yt4OqOpXqxsMKc,852
+bgtask/static/bgtask/js/bgtask.js,sha256=VQ853jxRxs53E5E4XKLLeRByVcFuyqHEsniBIb8wq4Q,13151
+bgtask/templates/bgtask/admin/change_list.html,sha256=_Vjm1SLGj_Z2lX1H5y-jfLNWFiRfmvKLgh2YG0QfCpc,1062
+bgtask/templates/bgtask/bg_changelist_status_column.html,sha256=4ATqCKTx8yVINvSUfRKckjrs8JteX45R4fnAAHm9c9g,978
 bgtask/templates/bgtask/bgtask_templates.html,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 bgtask/templates/bgtask/bgtask_view.html,sha256=AeubqERFF14PHWjInBD39wGImnRx4taS42iOMOPDUlM,1845
 bgtask/templates/bgtask/progress.html,sha256=VVYbrunGasOshRlz8Nm8hFPxqcVtrpaW1e2QxzAMcMM,166
@@ -16,8 +21,8 @@ bgtask/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 bgtask/templatetags/bgtask.py,sha256=WUEWlQX5AarbXJBV6EGp-khT1zegVwGNigSKRF5mCTE,413
 bgtask/tests/test_bgtask.py,sha256=9AsBppPphaIdphuB-pHuQjgLhYNp8ySWtmcWF2uQl3Q,1090
 bgtask/urls.py,sha256=DXXjgj18LTSCq2-xZf23-pkgO4RmZglv67mgrp-fDyk,161
-bgtask/views.py,sha256=4ypwMNwH_N9iKOrP5Ub_rLGFVV5BUMvuZVkCBXoSa7k,1983
-django_admin_background_task-0.1.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-django_admin_background_task-0.1.0.dist-info/METADATA,sha256=IIZyk-zPNWp-1f_xiA7Q-7LjZ-_0fQ-LObBMuwCqs90,1416
-django_admin_background_task-0.1.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-django_admin_background_task-0.1.0.dist-info/RECORD,,
+bgtask/views.py,sha256=tPblidBq8mIv9cbyAfzJfNlM-I-Z11XVoobdA3DZBVM,1765
+django_admin_background_task-0.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+django_admin_background_task-0.2.0.dist-info/METADATA,sha256=zM0kMweJLTim6uyYHhQIsFKR-RpYW-wwcNlwcZAyk6M,1416
+django_admin_background_task-0.2.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+django_admin_background_task-0.2.0.dist-info/RECORD,,