django-admin-background-task 0.1.0__tar.gz

django_admin_background_task-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

django_admin_background_task-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: django-admin-background-task
+Version: 0.1.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
+Author: David Park
+Author-email: david@greenparksoftware.co.uk
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: all
+Requires-Dist: Django (>=4.2,<4.3) ; extra == "all"
+Requires-Dist: django-model-utils (>=4.4.0,<4.5.0)
+Requires-Dist: psycopg2 (>=2.9.9,<3.0.0)
+Project-URL: Repository, https://github.com/daphtdazz/django-bgtask
+Description-Content-Type: text/markdown
+
+# django-bgtask
+
+Background task monitoring tool for django apps
+
+## Installation
+
+Grab it from PyPI, e.g:
+
+```
+pip install django-admin-background-task
+```
+
+## Setup
+
+Add it to your django apps:
+
+```
+INSTALLED_APPS = [
+    ...
+    "bgtask",
+]
+```
+
+And mount the amdin monitoring URLs:
+
+```
+urlpatterns = [
+    # You should be able to mount them anywhere but I put them here
+    path(r"admin/background-task/", include("bgtask.urls")),
+    path("admin", admin.site.urls),
+]
+```
+
+## Usage
+
+### Creating a task and updating it
+
+```
+from bgtask.models import BackgroundTask
+
+BackgroundTask.new(name)
+

django_admin_background_task-0.1.0/README.md

@@ -0,0 +1,41 @@
+# django-bgtask
+
+Background task monitoring tool for django apps
+
+## Installation
+
+Grab it from PyPI, e.g:
+
+```
+pip install django-admin-background-task
+```
+
+## Setup
+
+Add it to your django apps:
+
+```
+INSTALLED_APPS = [
+    ...
+    "bgtask",
+]
+```
+
+And mount the amdin monitoring URLs:
+
+```
+urlpatterns = [
+    # You should be able to mount them anywhere but I put them here
+    path(r"admin/background-task/", include("bgtask.urls")),
+    path("admin", admin.site.urls),
+]
+```
+
+## Usage
+
+### Creating a task and updating it
+
+```
+from bgtask.models import BackgroundTask
+
+BackgroundTask.new(name)

django_admin_background_task-0.1.0/bgtask/admin.py

@@ -0,0 +1,30 @@
+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):
+    if isinstance(obj, BackgroundTask):
+        bgtask = obj
+    else:
+        bgtasks = BackgroundTask.objects.filter(acted_on_object_id=obj.id).order_by("-created")
+
+        # for now just pick the most recent
+        bgtask = bgtasks.first()
+
+    output = render_to_string(
+        "bgtask/bg_changelist_status_column.html", {"bgtask": bgtask and task_dict(bgtask)}
+    )
+    return output
+
+
+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")
+    ordering = ["-created"]

django_admin_background_task-0.1.0/bgtask/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class BgtaskConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "bgtask"

django_admin_background_task-0.1.0/bgtask/migrations/0001_initial.py

@@ -0,0 +1,38 @@
+# Generated by Django 3.2.18 on 2023-04-08 13:59
+
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='BackgroundTask',
+            fields=[
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('updated', models.DateTimeField(auto_now=True)),
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=1000)),
+                ('state', models.CharField(choices=[('not_started', 'not_started'), ('running', 'running'), ('success', 'success'), ('partial_success', 'partial_success'), ('failed', 'failed')], default='not_started', max_length=16)),
+                ('steps_to_complete', models.PositiveIntegerField(blank=True, help_text='The number of steps in the task for it to be completed.', null=True)),
+                ('steps_completed', models.PositiveIntegerField(blank=True, help_text='The number of steps completed so far by this task', null=True)),
+                ('started_at', models.DateTimeField(blank=True, null=True)),
+                ('completed_at', models.DateTimeField(blank=True, null=True)),
+                ('result', models.JSONField(blank=True, help_text='The result(s) of the task, if any', null=True)),
+                ('errors', models.JSONField(blank=True, default=list, help_text='Any errors that occurred during processing')),
+                ('acted_on_object_id', models.TextField(blank=True, db_index=True, null=True)),
+                ('content_type', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='contenttypes.contenttype')),
+            ],
+            options={
+                'ordering': ['created', 'id'],
+            },
+        ),
+    ]

django_admin_background_task-0.1.0/bgtask/models.py

@@ -0,0 +1,235 @@
+import functools
+import logging
+import os
+import time
+import traceback
+import uuid
+
+from django.contrib.contenttypes.fields import GenericForeignKey
+from django.contrib.contenttypes.models import ContentType
+from django.db import models, transaction
+from django.utils import timezone
+
+from model_utils import Choices
+
+
+log = logging.getLogger(__name__)
+
+
+def locked(meth):
+    @functools.wraps(meth)
+    def _locked_meth(self, *args, **kwargs):
+        with transaction.atomic():
+            BackgroundTask.objects.filter(id=self.id).select_for_update().only("id").get()
+            return meth(self, *args, **kwargs)
+
+    return _locked_meth
+
+
+def only_if_state(state):
+    def only_if_state_decorator(meth):
+        def only_if_state_wrapper(self, *args, **kwargs):
+            if self.state != state:
+                raise RuntimeError(
+                    "%s cannot execute %s as in state %s not %s"
+                    % (self, meth.__name__, self.state, state)
+                )
+            return meth(self, *args, **kwargs)
+
+        return only_if_state_wrapper
+
+    return only_if_state_decorator
+
+
+class CreatedUpdatedMixin(models.Model):
+    class Meta:
+        abstract = True
+
+
+class BackgroundTask(CreatedUpdatedMixin):
+    id = models.UUIDField(primary_key=True, editable=False, default=uuid.uuid4)
+    name = models.CharField(max_length=1000)
+
+    STATES = Choices("not_started", "running", "success", "partial_success", "failed")
+    state = models.CharField(max_length=16, default=STATES.not_started, choices=STATES)
+    steps_to_complete = models.PositiveIntegerField(
+        null=True, blank=True, help_text="The number of steps in the task for it to be completed."
+    )
+    steps_completed = models.PositiveIntegerField(
+        null=True, blank=True, help_text="The number of steps completed so far by this task"
+    )
+
+    started_at = models.DateTimeField(null=True, blank=True)
+    completed_at = models.DateTimeField(null=True, blank=True)
+    result = models.JSONField(null=True, blank=True, help_text="The result(s) of the task, if any")
+    errors = models.JSONField(
+        default=list, blank=True, help_text="Any errors that occurred during processing"
+    )
+
+    # This follows the pattern described in
+    # https://docs.djangoproject.com/en/3.0/ref/contrib/contenttypes/#generic-relations
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE, blank=True, null=True)
+    acted_on_object_id = models.TextField(db_index=True, blank=True, null=True)
+    content_object = GenericForeignKey("content_type", "acted_on_object_id")
+
+    # Helpful to have these for debugging mostly
+    created = models.DateTimeField(auto_now_add=True)
+    updated = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        ordering = ["created", "id"]
+
+    @property
+    def num_failed_steps(self):
+        return sum(error.get("num_failed_steps", 0) for error in self.errors)
+
+    @property
+    def incomplete(self):
+        return self.state in [self.STATES.not_started, self.STATES.running]
+
+    @locked
+    @only_if_state(STATES.not_started)
+    def start(self):
+        log.info("%s starting", self)
+        self.state = self.STATES.running
+        self.started_at = timezone.now()
+        self.save()
+
+    @locked
+    @only_if_state(STATES.running)
+    def fail(self, exc):
+        """Call to indicate a complete and final failure of the task"""
+        log.info("%s failed: %s", self, exc)
+        self.state = self.STATES.failed
+        self.completed_at = timezone.now()
+        self.errors.append(
+            {"datetime": self.completed_at.isoformat(), **self._error_dict_for_error(exc)},
+        )
+        self.save()
+
+    @locked
+    @only_if_state(STATES.running)
+    def succeed(self, result):
+        log.info("%s succeeded.", self)
+        self.state = self.STATES.success
+        self.completion = 1
+        self.completed_at = timezone.now()
+        self.result = self.serialize_result(result)
+        self.save()
+
+    @locked
+    @only_if_state(STATES.running)
+    def finish(self):
+        """Mark task as finished, automatically deducing the final state."""
+        if not self.errors:
+            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
+        elif self.num_failed_steps == self.steps_to_complete:
+            log.info("Finishing as failure with all steps failed")
+            self.state = self.STATES.failed
+        else:
+            log.info("Finishing as partial success with some steps failed")
+            self.state = self.STATES.partial_success
+
+    @locked
+    def add_successful_steps(self, num_steps):
+        self.steps_completed += num_steps
+        self._maybe_finish()
+        self.save()
+
+    @locked
+    def steps_failed(self, num_steps, steps_identifier=None, error=None):
+        self.steps_completed += num_steps
+        error_dict = {
+            "datetime": timezone.now().isoformat(),
+            "num_failed_steps": num_steps,
+        }
+        if steps_identifier:
+            error_dict["steps_identifier"] = steps_identifier
+
+        error_dict.update(self._error_dict_for_error(error))
+
+        self.errors.append(error_dict)
+        self._maybe_finish()
+        self.save()
+
+    def dispatch(self):
+        # double fork to avoid zombies
+        pid = os.fork()
+
+        if pid != 0:
+            log.info("Waiting for child %d", pid)
+            os.waitpid(pid, 0)
+            log.info("Child exited")
+            return
+
+        # get fresh db connections in all children
+        from django import db
+
+        db.connections.close_all()
+
+        pid2 = os.fork()
+        if pid2 != 0:
+            log.info("Child exiting %d", os.getpid())
+            os._exit(0)
+
+        self.start()
+
+        time.sleep(5)
+        self.steps_to_complete = 100
+        self.steps_completed = 0
+        self.save()
+
+        def raise_an_exception():
+            raise Exception("Some exception")
+
+        for ii in range(100):
+            time.sleep(0.2)
+
+            if ii % 52 == 0:
+                try:
+                    raise_an_exception()
+                except Exception as exc:
+                    self.steps_failed(1, str(ii), error=exc)
+            else:
+                self.add_successful_steps(1)
+            if ii % 10 == 0:
+                log.info("Completed %d items", ii)
+
+        os._exit(0)
+
+    # ----------------------------------------------------------------------------------------------
+    # For overriding by subclasses
+    # ----------------------------------------------------------------------------------------------
+    def __str__(self):
+        return "%s %s %s" % (type(self).__name__, self.id, self.state)
+
+    @staticmethod
+    def serialize_result(result):
+        return result
+
+    # ----------------------------------------------------------------------------------------------
+    # Internals
+    # ----------------------------------------------------------------------------------------------
+    @staticmethod
+    def _error_dict_for_error(error):
+        if not error:
+            return {}
+
+        error_dict = {"error_message": str(error)}
+
+        if hasattr(error, "__traceback__"):
+            error_dict["traceback"] = "".join(
+                traceback.format_list(traceback.extract_tb(error.__traceback__))
+            )
+        return error_dict
+
+    def _maybe_finish(self):
+        if self.steps_to_complete is None:
+            return
+
+        if self.steps_completed >= self.steps_to_complete:
+            self.finish()

django_admin_background_task-0.1.0/bgtask/stack_contexts.py

@@ -0,0 +1,11 @@
+from utils.stack_context import stack_context
+
+from .models import BackgroundTask
+
+
+__all__ = ["bgtask_context"]
+
+
+@stack_context(logging_param_name="bgtask_id")
+def bgtask_context(id):
+    return BackgroundTask.objects.get(id=id)

django_admin_background_task-0.1.0/bgtask/static/bgtask/js/bgtask-once.js

@@ -0,0 +1,19 @@
+// Add bgtask.js into the page just once, allowing this to be added many times on the same page
+// without running into errors due to redeclaring variables etc.
+//
+// Must be executed syncronously, so without the async flag to <script>
+(() => {
+  if (window.BG_TASK_ADDED) {
+    // Have already bootstrapped.
+    return;
+  }
+
+  // Get the URL of the current script. This only works if this script is executed synchronously.
+  const scripts = document.getElementsByTagName('script');
+  const thisScript = scripts[scripts.length - 1];
+  const src = thisScript.src;
+  const baseSrc = src.replace(/[^\/]+$/, '');
+
+  // Use document.write() to inject the main script immediately.
+  document.write(`<script src="${baseSrc}bgtask.js"></script>`);
+})();