Report printing refactor

src/backend/InvenTree/InvenTree/api_version.py

@@ -1,11 +1,16 @@
 """InvenTree API version information."""
 
 # InvenTree API version
-INVENTREE_API_VERSION = 196
+INVENTREE_API_VERSION = 197
 """Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
 
 INVENTREE_API_TEXT = """
 
+v197 - 2024-05-05 : https://github.com/inventree/InvenTree/pull/7074
+    - Major refactor of the report template / report printing interface
+    - This is a *breaking change* to the report template API
+    - All report printing has now been simplified to a single set of API endpoints
+
 v196 - 2024-05-05 : https://github.com/inventree/InvenTree/pull/7160
     - Adds "location" field to BuildOutputComplete API endpoint
 

src/backend/InvenTree/InvenTree/apps.py

@@ -74,6 +74,7 @@
         obsolete = [
             'InvenTree.tasks.delete_expired_sessions',
             'stock.tasks.delete_old_stock_items',
+            'label.tasks.cleanup_old_label_outputs',
         ]
 
         try:
@@ -83,7 +84,14 @@
 
         # Remove any existing obsolete tasks
         try:
-            Schedule.objects.filter(func__in=obsolete).delete()
+            obsolete_tasks = Schedule.objects.filter(func__in=obsolete)
+
+            if obsolete_tasks.exists():
+                logger.info(
+                    'Removing %s obsolete background tasks', obsolete_tasks.count()
+                )
+                obsolete_tasks.delete()
+
         except Exception:
             logger.exception('Failed to remove obsolete tasks - database not ready')
 

src/backend/InvenTree/InvenTree/metadata.py

@@ -121,6 +121,16 @@
 
         serializer_info = super().get_serializer_info(serializer)
 
+        # Look for any dynamic fields which were not available when the serializer was instantiated
+        for field_name in serializer.Meta.fields:
+            if field_name in serializer_info:
+                # Already know about this one
+                continue
+
+            if hasattr(serializer, field_name):
+                field = getattr(serializer, field_name)
+                serializer_info[field_name] = self.get_field_info(field)
+
         model_class = None
 
         # Attributes to copy extra attributes from the model to the field (if they don't exist)

src/backend/InvenTree/InvenTree/models.py

@@ -1022,6 +1022,26 @@
     )
 
 
+class InvenTreeReportMixin(models.Model):
+    """A mixin class for adding report generation functionality to a model class.
+
+    In addition to exposing the model to the report generation interface,
+    this mixin provides a hook for providing extra context information to the reports.
+    """
+
+    class Meta:
+        """Metaclass options for this mixin."""
+
+        abstract = True
+
+    def report_context(self) -> dict:
+        """Generate a dict of context data to provide to the reporting framework.
+
+        The default implementation returns an empty dict object.
+        """
+        return {}
+
+
 class InvenTreeBarcodeMixin(models.Model):
     """A mixin class for adding barcode functionality to a model class.
 

src/backend/InvenTree/InvenTree/settings.py

@@ -193,7 +193,6 @@
     'common.apps.CommonConfig',
     'company.apps.CompanyConfig',
     'plugin.apps.PluginAppConfig',  # Plugin app runs before all apps that depend on the isPluginRegistryLoaded function
-    'label.apps.LabelConfig',
     'order.apps.OrderConfig',
     'part.apps.PartConfig',
     'report.apps.ReportConfig',
@@ -434,12 +433,7 @@
 TEMPLATES = [
     {
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [
-            BASE_DIR.joinpath('templates'),
-            # Allow templates in the reporting directory to be accessed
-            MEDIA_ROOT.joinpath('report'),
-            MEDIA_ROOT.joinpath('label'),
-        ],
+        'DIRS': [BASE_DIR.joinpath('templates'), MEDIA_ROOT.joinpath('report')],
         'OPTIONS': {
             'context_processors': [
                 'django.template.context_processors.debug',

src/backend/InvenTree/InvenTree/urls.py

@@ -21,7 +21,6 @@
 import build.api
 import common.api
 import company.api
-import label.api
 import machine.api
 import order.api
 import part.api
@@ -89,7 +88,7 @@
     path('stock/', include(stock.api.stock_api_urls)),
     path('build/', include(build.api.build_api_urls)),
     path('order/', include(order.api.order_api_urls)),
-    path('label/', include(label.api.label_api_urls)),
+    path('label/', include(report.api.label_api_urls)),
     path('report/', include(report.api.report_api_urls)),
     path('machine/', include(machine.api.machine_api_urls)),
     path('user/', include(users.api.user_urls)),

src/backend/InvenTree/build/admin.py

@@ -18,7 +18,7 @@ class BuildResource(InvenTreeResource):
     # TODO: 2022-05-12 - Need to investigate why this is the case!
 
     class Meta:
-        """Metaclass options"""
+        """Metaclass options."""
         models = Build
         skip_unchanged = True
         report_skipped = False

src/backend/InvenTree/build/api.py

@@ -30,7 +30,7 @@ class BuildFilter(rest_filters.FilterSet):
     """Custom filterset for BuildList API endpoint."""
 
     class Meta:
-        """Metaclass options"""
+        """Metaclass options."""
         model = Build
         fields = [
             'parent',

src/backend/InvenTree/build/migrations/0043_buildline.py

@@ -23,6 +23,7 @@ class Migration(migrations.Migration):
             ],
             options={
                 'unique_together': {('build', 'bom_item')},
+                'verbose_name': 'Build Order Line Item',
             },
         ),
     ]

src/backend/InvenTree/build/models.py

@@ -38,14 +38,22 @@
 from plugin.events import trigger_event
 
 import part.models
+import report.mixins
 import stock.models
 import users.models
 
 
 logger = logging.getLogger('inventree')
 
 
-class Build(InvenTree.models.InvenTreeBarcodeMixin, InvenTree.models.InvenTreeNotesMixin, InvenTree.models.MetadataMixin, InvenTree.models.PluginValidationMixin, InvenTree.models.ReferenceIndexingMixin, MPTTModel):
+class Build(
+    report.mixins.InvenTreeReportMixin,
+    InvenTree.models.InvenTreeBarcodeMixin,
+    InvenTree.models.InvenTreeNotesMixin,
+    InvenTree.models.MetadataMixin,
+    InvenTree.models.PluginValidationMixin,
+    InvenTree.models.ReferenceIndexingMixin,
+    MPTTModel):
     """A Build object organises the creation of new StockItem objects from other existing StockItem objects.
 
     Attributes:
@@ -139,6 +147,21 @@
                 'part': _('Build order part cannot be changed')
             })
 
+    def report_context(self) -> dict:
+        """Generate custom report context data."""
+
+        return {
+            'build': self,
+            'part': self.part,
+            'build_outputs': self.build_outputs.all(),
+            'line_items': self.build_lines.all(),
+            'bom_items': self.part.get_bom_items(),
+            'reference': self.reference,
+            'quantity': self.quantity,
+            'title': str(self)
+        }
+
+
     @staticmethod
     def filterByDate(queryset, min_date, max_date):
         """Filter by 'minimum and maximum date range'.
@@ -1291,7 +1314,7 @@
     build = models.ForeignKey(Build, on_delete=models.CASCADE, related_name='attachments')
 
 
-class BuildLine(InvenTree.models.InvenTreeModel):
+class BuildLine(report.mixins.InvenTreeReportMixin, InvenTree.models.InvenTreeModel):
     """A BuildLine object links a BOMItem to a Build.
 
     When a new Build is created, the BuildLine objects are created automatically.
@@ -1308,7 +1331,8 @@
     """
 
     class Meta:
-        """Model meta options"""
+        """Model meta options."""
+        verbose_name = _('Build Order Line Item')
         unique_together = [
             ('build', 'bom_item'),
         ]
@@ -1318,6 +1342,19 @@
         """Return the API URL used to access this model"""
         return reverse('api-build-line-list')
 
+    def report_context(self):
+        """Generate custom report context for this BuildLine object."""
+
+        return {
+            'build_line': self,
+            'build': self.build,
+            'bom_item': self.bom_item,
+            'part': self.bom_item.sub_part,
+            'quantity': self.quantity,
+            'allocated_quantity': self.allocated_quantity,
+            'allocations': self.allocations,
+        }
+
     build = models.ForeignKey(
         Build, on_delete=models.CASCADE,
         related_name='build_lines', help_text=_('Build object')
@@ -1384,7 +1421,7 @@
     """
 
     class Meta:
-        """Model meta options"""
+        """Model meta options."""
         unique_together = [
             ('build_line', 'stock_item', 'install_into'),
         ]

src/backend/InvenTree/build/templates/build/build_base.html

@@ -257,11 +257,7 @@ <h3>
 
     {% if report_enabled %}
     $('#print-build-report').click(function() {
-        printReports({
-            items: [{{ build.pk }}],
-            key: 'build',
-            url: '{% url "api-build-report-list" %}',
-        });
+        printReports('build', [{{ build.pk }}]);
     });
     {% endif %}
 

src/backend/InvenTree/common/tasks.py

@@ -55,7 +55,7 @@ def update_news_feed():
 
     # Fetch and parse feed
     try:
-        feed = requests.get(settings.INVENTREE_NEWS_URL)
+        feed = requests.get(settings.INVENTREE_NEWS_URL, timeout=30)
         d = feedparser.parse(feed.content)
     except Exception:  # pragma: no cover
         logger.warning('update_news_feed: Error parsing the newsfeed')