django-admin-background-task 0.2.0__tar.gz → 0.3.0__tar.gz

{django_admin_background_task-0.2.0 → django_admin_background_task-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-admin-background-task
-Version: 0.2.0
+Version: 0.3.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

{django_admin_background_task-0.2.0 → django_admin_background_task-0.3.0}/bgtask/model_admin.py

@@ -1,7 +1,9 @@
 from datetime import timedelta
+from functools import wraps
 
 from django.contrib import admin
 from django.contrib.admin.utils import label_for_field
+from django.contrib.messages import INFO
 from django.db.models import Q
 from django.utils import timezone
 
@@ -12,8 +14,29 @@ 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"
 
+    # ----------------------------------------------------------------------------------------------
+    # Class API
+    # ----------------------------------------------------------------------------------------------
+    @classmethod
+    def starts_task(cls, name, **task_kwargs):
+
+        def starts_task_decorator(func):
+
+            @wraps(func)
+            def starts_task_wrapper(self, request, *args, **kwargs):
+                bgtask = self.start_bgtask(name, **task_kwargs)
+                result = func(self, request, *args, bgtask=bgtask, **kwargs)
+                self.message_user(request, f"Dispatched task {name}", INFO)
+
+            func.bgtask_name = name
+
+            return starts_task_wrapper
+
+        return starts_task_decorator
+
     # ----------------------------------------------------------------------------------------------
     # API for subclasses
     # ----------------------------------------------------------------------------------------------
@@ -41,11 +64,26 @@ class BGTaskModelAdmin(admin.ModelAdmin):
     def _bgtask_namespace(self):
         return type(self).__module__ + "." + type(self).__name__
 
+    @staticmethod
+    def _extract_bgtask_name_from_admin_action(action):
+        # recurse through the potentially wrapped action until we find one that declares
+        # the bgtask_name
+        next_action = action
+        while True:
+            if hasattr(next_action, "bgtask_name"):
+                return next_action.bgtask_name
+
+            if not hasattr(next_action, "__wrapped__"):
+                return None
+
+            next_action = next_action.__wrapped__
+
     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
+            bgtask_name = self._extract_bgtask_name_from_admin_action(action)
+            if bgtask_name is not None:
+                task_name_to_desc[bgtask_name] = action_description
 
         for name in getattr(self, "bgtask_names", []):
             task_name_to_desc[name] = name
@@ -58,10 +96,13 @@ class BGTaskModelAdmin(admin.ModelAdmin):
                 name__in=task_name_to_desc, namespace=self._bgtask_namespace
             )
             .filter(
-                Q(state=BackgroundTask.STATES.running)
+                (
+                    Q(state=BackgroundTask.STATES.running)
+                    & Q(started_at__gt=timezone.now() - timedelta(days=1))
+                )
                 | (
                     ~Q(state=BackgroundTask.STATES.not_started)
-                    & Q(completed_at__gt=timezone.now() - timedelta(minutes=30))
+                    & Q(completed_at__gt=timezone.now() - timedelta(hours=2))
                 )
             )
             .order_by("-started_at")

{django_admin_background_task-0.2.0 → django_admin_background_task-0.3.0}/bgtask/static/bgtask/js/bgtask.js

@@ -14,6 +14,33 @@ const TIME_TO_REDUCED_REFRESH_PERIOD_S = 300;
 const REDUCED_REFRESH_PERIOD_S = 60;
 const PROGRESS_REFRESH_MS = 100;
 
+function millisecondsToTimeAgoString(ms) {
+  const seconds = Math.floor(ms / 1000);
+  const minutes = Math.floor(seconds / 60);
+  const hours = Math.floor(minutes / 60);
+  const days = Math.floor(hours / 24);
+
+  if (days > 0) {
+    if (days === 1) {
+      return `${days} day, ${hours % 24} hours ago`;
+    }
+    return `${days} days ago`;
+  }
+  if (hours > 0) {
+    if (hours === 1) {
+      return `${hours} hour, ${minutes % 60} minutes ago`;
+    }
+    return `${hours} hours ago`;
+  }
+  if (minutes > 0) {
+    if (minutes === 1) {
+      return `${minutes} minute, ${seconds % 60} seconds ago`;
+    }
+    return `${minutes} minutes ago`;
+  }
+  return `${seconds} seconds ago`;
+}
+
 // -------------------------------------------------------------------------------------------------
 // Generic live-looking progress bar manager.
 // -------------------------------------------------------------------------------------------------
@@ -140,7 +167,6 @@ class TaskProgressDiv {
   }
 
   updateFromTask(task) {
-    // console.log(`TaskProgressDiv.updateFromTask`, task);
     this.div.title = "";
 
     switch (task.state) {
@@ -152,7 +178,14 @@ class TaskProgressDiv {
       case "failed":
         this._hideProgress();
         this._showState();
-        this._addTitle("Task failed");
+        let title = "Task failed";
+        for (const error of task.errors) {
+          if (error.traceback) {
+            title = `${title}\n${error.traceback}\n\n${error.error_message}`;
+            break;
+          }
+        }
+        this._addTitle(title);
         break;
       case "success":
         this._hideProgress();
@@ -205,6 +238,26 @@ class TaskProgressDiv {
   }
 }
 
+// -------------------------------------------------------------------------------------------------
+// Manage an element which just shows one field from the task
+// -------------------------------------------------------------------------------------------------
+class TaskFieldElement {
+  constructor (element, fieldName, task) {
+    this.taskId = task.id;
+    this.element = element;
+    this.fieldName = fieldName;
+    this.updateFromTask(task);
+  }
+
+  attachToPoller(poller) {
+    poller.monitorTask(this.taskId, task => this.updateFromTask(task));
+  }
+
+  updateFromTask(task) {
+    this.element.innerHTML = task[this.fieldName];
+  }
+}
+
 // -------------------------------------------------------------------------------------------------
 // Manage a task detail div
 // -------------------------------------------------------------------------------------------------
@@ -299,6 +352,14 @@ class BGTaskPoller {
 
   static normalizeTask(task) {
     task.updated = new Date(task.updated);
+
+    if (task.completed_at !== null) {
+      task.completed_at = new Date(task.completed_at);
+      const completedTimeAgoMS = Date.now() - task.completed_at.getTime();
+      task.completed_at_time_ago = millisecondsToTimeAgoString(completedTimeAgoMS);
+    } else {
+      task.completed_at_time_ago = "–";
+    }
   }
 
   static sharedInstance(baseURL) {
@@ -357,7 +418,9 @@ class BGTaskPoller {
     const req = new XMLHttpRequest();
     const self = this;
     req.addEventListener("load", function () { self._receivePoll(this); });
-    const url = `${this.baseURL}?tasks=${Object.keys(this.taskCallbacks).join(",")}`;
+    const taskIds = Object.keys(this.taskCallbacks).join(",");
+    const url = `${this.baseURL}?tasks=${taskIds}`;
+    console.log(`Poll for tasks ${taskIds}`);
     req.open("GET", url);
     req.setRequestHeader('Accept', 'application/json');
     req.send();

{django_admin_background_task-0.2.0 → django_admin_background_task-0.3.0}/bgtask/templates/bgtask/admin/change_list.html

@@ -8,7 +8,7 @@
 
 {% block object-tools %}
 {{ block.super }}
-<div>
+<div style="margin-bottom: 10px;">
   <h3>Action background tasks</h3>
   {% if not admin_bg_tasks|length %}
   <p class="help" style="font-style: italic;">No recent background tasks</p>
@@ -20,7 +20,7 @@
     <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>
+      <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>{% include "bgtask/bg_completed_column.html" %}</td><td>
       {% include "bgtask/bg_changelist_status_column.html" %}</td></tr>
       {% endwith %}
       {% endfor %}

{django_admin_background_task-0.2.0 → django_admin_background_task-0.3.0}/bgtask/templates/bgtask/bg_changelist_status_column.html

@@ -6,11 +6,7 @@
 {{ 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>

django_admin_background_task-0.3.0/bgtask/templates/bgtask/bg_completed_column.html

@@ -0,0 +1,24 @@
+{% load static %}
+{% if not bgtask %}
+–
+{% else %}
+{% with initialTasksJsonId="initialTasksJson-completedcolumn-"|add:bgtask.id %}
+{{ bgtask|json_script:initialTasksJsonId }}
+{% endwith %}
+<script src="{% static 'bgtask/js/bgtask-once.js' %}"></script>
+<span></span>
+<script>
+(() => {
+    const completedSpan = document.currentScript.previousElementSibling;
+
+    const originalTask = JSON.parse(
+        document.getElementById("initialTasksJson-completedcolumn-{{ bgtask.id }}").textContent
+    );
+    BGTaskPoller.normalizeTask(originalTask);
+
+    const statusCol = new TaskFieldElement(completedSpan, "completed_at_time_ago", originalTask);
+    const poller = BGTaskPoller.sharedInstance("{% url 'bgtask:tasks' %}");
+    statusCol.attachToPoller(poller);
+})();
+</script>
+{% endif %}

{django_admin_background_task-0.2.0 → django_admin_background_task-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "django-admin-background-task"
-version = "0.2.0"
+version = "0.3.0"
 description = "A set of tools for django apps to persist and monitor the status of background tasks"
 authors = [
     "David Park <david@greenparksoftware.co.uk>",