Django q

InvenTree/InvenTree/apps.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+import logging
+
+from django.apps import AppConfig
+from django.core.exceptions import AppRegistryNotReady
+
+import InvenTree.tasks
+
+
+logger = logging.getLogger(__name__)
+
+
+class InvenTreeConfig(AppConfig):
+    name = 'InvenTree'
+
+    def ready(self):
+
+        self.start_background_tasks()
+
+    def start_background_tasks(self):
+
+        try:
+            from django_q.models import Schedule
+        except (AppRegistryNotReady):
+            return
+
+        logger.info("Starting background tasks...")
+
+        InvenTree.tasks.schedule_task(
+            'InvenTree.tasks.delete_successful_tasks',
+            schedule_type=Schedule.WEEKLY,
+        )
+
+        InvenTree.tasks.schedule_task(
+            'InvenTree.tasks.check_for_updates',
+            schedule_type=Schedule.DAILY
+        )
+
+        InvenTree.tasks.schedule_task(
+            'InvenTree.tasks.heartbeat',
+            schedule_type=Schedule.MINUTES,
+            minutes=5
+        )

InvenTree/InvenTree/context.py

@@ -30,10 +30,22 @@ def health_status(request):
 
     request._inventree_health_status = True
 
-    return {
-        "system_healthy": InvenTree.status.check_system_health(),
+    status = {
+        'django_q_running': InvenTree.status.is_q_cluster_running(),
     }
 
+    all_healthy = True
+
+    for k in status.keys():
+        if status[k] is not True:
+            all_healthy = False
+
+    status['system_healthy'] = all_healthy
+
+    status['up_to_date'] = InvenTree.version.isInvenTreeUpToDate()
+
+    return status
+
 
 def status_codes(request):
     """

InvenTree/InvenTree/settings.py

@@ -194,6 +194,7 @@ def get_setting(environment_var, backup_val, default_value=None):
     'report.apps.ReportConfig',
     'stock.apps.StockConfig',
     'users.apps.UsersConfig',
+    'InvenTree.apps.InvenTreeConfig',       # InvenTree app runs last
 
     # Third part add-ons
     'django_filters',                       # Extended filter functionality
@@ -211,6 +212,7 @@ def get_setting(environment_var, backup_val, default_value=None):
     'djmoney',                              # django-money integration
     'djmoney.contrib.exchange',             # django-money exchange rates
     'error_report',                         # Error reporting in the admin interface
+    'django_q',
 ]
 
 MIDDLEWARE = CONFIG.get('middleware', [
@@ -285,6 +287,18 @@ def get_setting(environment_var, backup_val, default_value=None):
 
 WSGI_APPLICATION = 'InvenTree.wsgi.application'
 
+# django-q configuration
+Q_CLUSTER = {
+    'name': 'InvenTree',
+    'workers': 4,
+    'timeout': 90,
+    'retry': 120,
+    'queue_limit': 50,
+    'bulk': 10,
+    'orm': 'default',
+    'sync': True,
+}
+
 # Markdownx configuration
 # Ref: https://neutronx.github.io/django-markdownx/customization/
 MARKDOWNX_MEDIA_PATH = datetime.now().strftime('markdownx/%Y/%m/%d')
@@ -401,11 +415,6 @@ def get_setting(environment_var, backup_val, default_value=None):
     'default': {
         'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
     },
-    'qr-code': {
-        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
-        'LOCATION': 'qr-code-cache',
-        'TIMEOUT': 3600
-    }
 }
 
 # Password validation

InvenTree/InvenTree/status.py

@@ -1,15 +1,49 @@
 """
 Provides system status functionality checks.
 """
+# -*- coding: utf-8 -*-
 
-from django.utils.translation import ugettext as _
+from __future__ import unicode_literals
 
 import logging
+from datetime import datetime, timedelta
+
+from django.utils.translation import ugettext as _
 
+from django_q.models import Success
+from django_q.monitor import Stat
 
 logger = logging.getLogger(__name__)
 
 
+def is_q_cluster_running(**kwargs):
+    """
+    Return True if at least one cluster worker is running
+    """
+
+    clusters = Stat.get_all()
+
+    if len(clusters) > 0:
+        return True
+
+    """
+    Sometimes Stat.get_all() returns [].
+    In this case we have the 'heartbeat' task running every five minutes.
+    Check to see if we have a result within the last ten minutes
+    """
+
+    now = datetime.now()
+    past = now - timedelta(minutes=10)
+
+    results = Success.objects.filter(
+        func='InvenTree.tasks.heartbeat',
+        started__gte=past
+    )
+
+    # If any results are returned, then the background worker is running!
+    return results.exists()
+
+
 def check_system_health(**kwargs):
     """
     Check that the InvenTree system is running OK.
@@ -19,21 +53,11 @@ def check_system_health(**kwargs):
 
     result = True
 
-    if not check_celery_worker(**kwargs):
+    if not is_q_cluster_running(**kwargs):
         result = False
-        logger.warning(_("Celery worker check failed"))
+        logger.warning(_("Background worker check failed"))
 
     if not result:
         logger.warning(_("InvenTree system health checks failed"))
 
     return result
-
-
-def check_celery_worker(**kwargs):
-    """
-    Check that a celery worker is running.
-    """
-
-    # TODO - Checks that the configured celery worker thing is running
-
-    return True

InvenTree/InvenTree/tasks.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import re
+import json
+import requests
+import logging
+
+from datetime import datetime, timedelta
+
+from django.core.exceptions import AppRegistryNotReady
+from django.db.utils import OperationalError, ProgrammingError
+
+
+logger = logging.getLogger(__name__)
+
+
+def schedule_task(taskname, **kwargs):
+    """
+    Create a scheduled task.
+    If the task has already been scheduled, ignore!
+    """
+
+    try:
+        from django_q.models import Schedule
+    except (AppRegistryNotReady):
+        logger.warning("Could not start background tasks - App registry not ready")
+        return
+
+    try:
+        if Schedule.objects.filter(func=taskname).exists():
+            logger.info(f"Scheduled task '{taskname}' already exists. (Skipping)")
+        else:
+            logger.info(f"Creating scheduled task '{taskname}'")
+
+            Schedule.objects.create(
+                func=taskname,
+                **kwargs
+            )
+    except (OperationalError, ProgrammingError):
+        # Required if the DB is not ready yet
+        pass
+
+
+def heartbeat():
+    """
+    Simple task which runs at 5 minute intervals,
+    so we can determine that the background worker
+    is actually running.
+
+    (There is probably a less "hacky" way of achieving this)
+    """
+    pass
+
+
+def delete_successful_tasks():
+    """
+    Delete successful task logs
+    which are more than a month old.
+    """
+
+    threshold = datetime.now() - timedelta(days=30)
+
+    results = Success.objects.filter(
+        started__lte=threshold
+    )
+
+    results.delete()
+
+
+def check_for_updates():
+    """
+    Check if there is an update for InvenTree
+    """
+
+    try:
+        import common.models
+    except AppRegistryNotReady:
+        return
+
+    response = requests.get('https://api.github.com/repos/inventree/inventree/releases/latest')
+
+    if not response.status_code == 200:
+        logger.warning(f'Unexpected status code from GitHub API: {response.status_code}')
+        return
+
+    data = json.loads(response.text)
+
+    tag = data.get('tag_name', None)
+
+    if not tag:
+        logger.warning("'tag_name' missing from GitHub response")
+        return
+
+    match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", tag)
+
+    if not len(match.groups()) == 3:
+        logger.warning(f"Version '{tag}' did not match expected pattern")
+        return
+
+    try:
+        latest_version = [int(x) for x in match.groups()]
+    except (ValueError):
+        logger.warning(f"Version '{tag}' not integer format")
+        return
+
+    if not len(latest_version) == 3:
+        logger.warning(f"Version '{tag}' is not correct format")
+        return
+
+    logger.info(f"Latest InvenTree version: '{tag}'")
+
+    # Save the version to the database
+    common.models.InvenTreeSetting.set_setting(
+        'INVENTREE_LATEST_VERSION',
+        tag,
+        None
+    )

InvenTree/InvenTree/tests.py

@@ -7,6 +7,7 @@
 
 from .validators import validate_overage, validate_part_name
 from . import helpers
+from . import version
 
 from mptt.exceptions import InvalidMove
 
@@ -269,3 +270,15 @@ def test_failures(self):
 
         with self.assertRaises(ValidationError):
             e("10, a, 7-70j", 4)
+
+
+class TestVersionNumber(TestCase):
+
+    def test_tuple(self):
+
+        v = version.inventreeVersionTuple()
+        self.assertEqual(len(v), 3)
+
+        s = '.'.join([str(i) for i in v])
+
+        self.assertTrue(s in version.inventreeVersion())