Add a new AboutCode tab in Package details view #42 (#119)

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

CHANGELOG.rst

@@ -72,6 +72,9 @@ Release notes
 - Always display the full Package URL in the UI view including the "pkg:" prefix.
   https://github.com/nexB/dejacode/issues/115
 
+- Add a new AboutCode tab in Package details view.
+  https://github.com/nexB/dejacode/issues/42
+
 ### Version 5.0.1
 
 - Improve the stability of the "Check for new Package versions" feature.

component_catalog/models.py

@@ -2016,9 +2016,15 @@ def size_formatted(self):
 
     @cached_property
     def component(self):
-        """Return the Component instance if 1 and only 1 Component is assigned to this Package."""
-        with suppress(ObjectDoesNotExist, MultipleObjectsReturned):
-            return self.component_set.get()
+        """
+        Return the Component instance if 1 and only 1 Component is assigned to this
+        Package.
+        Using ``component_set.all()`` to benefit from prefetch_related when it was
+        applied to the Package QuerySet.
+        """
+        component_set = self.component_set.all()
+        if len(component_set) == 1:
+            return component_set[0]
 
     def set_values_from_component(self, component, user):
         changed_fields = set_fields_from_object(

component_catalog/templates/component_catalog/tabs/tab_aboutcode.html

@@ -0,0 +1,21 @@
+<div class="alert alert-primary m-0 mb-3" role="alert">
+  <p class="m-0">
+    This tab renders a preview of the AboutCode files: .ABOUT and .NOTICE,
+    exactly as it will appear in the generated .yml files.<br>
+    <a href="{{ object.get_about_files_url }}" class="fw-bold">Click here to download</a>
+    those files as a zip archive.
+  </p>
+</div>
+
+<dl class="row mb-0">
+  <dt class="col-sm-1 text-end pt-2 pe-0">.ABOUT</dt>
+  <dd class="col-sm-11">
+    <pre class="pre-bg-body-tertiary mb-1">{{ values.about_content }}</pre>
+  </dd>
+  {% if values.notice_content %}
+    <dt class="col-sm-1 text-end pt-2 pe-0">.NOTICE</dt>
+    <dd class="col-sm-11">
+      <pre class="pre-bg-body-tertiary mb-1">{{ values.notice_content }}</pre>
+    </dd>
+  {% endif %}
+</dl>

component_catalog/tests/test_views.py

@@ -1342,6 +1342,15 @@ def test_package_details_view_add_package_links(self):
         for expected in expecteds:
             self.assertContains(response, expected)
 
+    def test_package_details_view_aboutcode_tab(self):
+        details_url = self.package1.get_absolute_url()
+        self.client.login(username=self.super_user.username, password="secret")
+        response = self.client.get(details_url)
+        self.assertContains(response, 'id="tab_aboutcode-tab"')
+        self.assertContains(response, 'id="tab_aboutcode"')
+        self.assertContains(response, "This tab renders a preview of the AboutCode files")
+        self.assertContains(response, "about_resource: package1")
+
     def test_package_list_view_add_to_product(self):
         user = create_user("user", self.dataspace)
         self.client.login(username=user.username, password="secret")

component_catalog/views.py

@@ -34,6 +34,7 @@
 from django.utils.formats import date_format
 from django.utils.html import escape
 from django.utils.html import format_html
+from django.utils.text import normalize_newlines
 from django.utils.translation import gettext
 from django.utils.translation import gettext_lazy as _
 from django.views.decorators.csrf import csrf_exempt
@@ -1147,8 +1148,8 @@ class PackageDetailsView(
     AcceptAnonymousMixin,
     AddPackagePermissionMixin,
     TabVulnerabilityMixin,
-    ObjectDetailsView,
     AddToProductFormMixin,
+    ObjectDetailsView,
 ):
     model = Package
     slug_url_kwarg = "uuid"
@@ -1247,6 +1248,9 @@ class PackageDetailsView(
         "vulnerabilities": {
             "verbose_name": "Vulnerabilities",
         },
+        "aboutcode": {
+            "verbose_name": "AboutCode",
+        },
         "history": {
             "fields": [
                 "created_date",
@@ -1266,8 +1270,7 @@ def get_context_data(self, **kwargs):
         has_change_package_permission = user.has_perm("component_catalog.change_package")
         context_data["has_change_package_permission"] = has_change_package_permission
 
-        # License data is required for the Scan tab "scan to package"
-        # license expression fields
+        # License data is required for the Scan tab "scan to package" license expression fields
         client_data = getattr(self.request, "client_data", {})
         include_all_licenses = all(
             [
@@ -1280,9 +1283,9 @@ def get_context_data(self, **kwargs):
             all_licenses = License.objects.scope(user.dataspace).filter(is_active=True)
             add_client_data(self.request, license_data=all_licenses.data_for_expression_builder())
 
-        if self.request.user.has_perm("component_catalog.change_component"):
+        if user.has_perm("component_catalog.change_component"):
             context_data["add_to_component_form"] = AddToComponentForm(
-                self.request.user, initial={self.model._meta.model_name: self.object}
+                user, initial={self.model._meta.model_name: self.object}
             )
 
         return context_data
@@ -1447,6 +1450,15 @@ def tab_purldb(self):
         }
         return {"fields": [(None, tab_context, None, template)]}
 
+    def tab_aboutcode(self):
+        template = "component_catalog/tabs/tab_aboutcode.html"
+        context = {
+            "about_content": self.object.as_about_yaml(),
+            "notice_content": normalize_newlines(self.object.notice_text),
+        }
+
+        return {"fields": [(None, context, None, template)]}
+
     def get_vulnerabilities_tab_fields(self, vulnerabilities):
         dataspace = self.object.dataspace
         fields = []

dje/models.py

@@ -1127,13 +1127,15 @@ def clean_extra_spaces_in_identifier_fields(self):
                     setattr(self, field_name, " ".join(field_value.split()))
 
     def mark_all_notifications_as_read(self, user):
-        unread_notifications = Notification.objects.unread().filter(
+        unread_notifications_qs = Notification.objects.unread().filter(
             action_object_content_type__model=self._meta.model_name,
             action_object_object_id=self.id,
             recipient=user,
         )
-        if unread_notifications:
-            unread_notifications.update(unread=False)
+        # Trigger a single UPDATE query on the "unread" Notification.
+        # Even if the QS is empty, this is faster than checking is the QS contains
+        # entries first.
+        unread_notifications_qs.update(unread=False)
 
 
 class HistoryDateFieldsMixin(models.Model):

dje/tests/test_permissions.py

@@ -116,6 +116,7 @@ def test_permissions_get_all_tabsets(self):
                 "scan",
                 "purldb",
                 "vulnerabilities",
+                "aboutcode",
                 "history",
             ],
             "license": [