Mask missing library dependency data handling (boostorg#1878)

Author: daveoconnor

libraries/views.py

@@ -1,4 +1,5 @@
 import datetime
+import structlog
 
 from django.contrib import messages
 from django.db.models import F, Count, Prefetch
@@ -10,6 +11,7 @@
 from django.views.generic import DetailView, ListView
 
 from core.githubhelper import GithubAPIClient
+from versions.exceptions import BoostImportedDataException
 from versions.models import Version
 
 from .constants import README_MISSING
@@ -30,6 +32,8 @@
 )
 from .constants import LATEST_RELEASE_URL_PATH_STR
 
+logger = structlog.get_logger()
+
 
 class LibraryListDispatcher(View):
     def dispatch(self, request, *args, **kwargs):
@@ -239,7 +243,12 @@ def get_context_data(self, **kwargs):
 
         # Populate the commit graphs
         context["commit_data_by_release"] = self.get_commit_data_by_release()
-        context["dependency_diff"] = self.get_dependency_diff(library_version)
+        try:
+            context["dependency_diff"] = self.get_dependency_diff(library_version)
+        except BoostImportedDataException:
+            logger.warning("Library version dependencies not set, need importing.")
+            context["dependency_diff"] = {}
+            context["dependencies_not_calculated"] = True
 
         # Populate the library description
         client = GithubAPIClient(repo_slug=self.object.github_repo)

templates/libraries/detail.html

@@ -137,41 +137,45 @@ <h2 class="text-2xl">This Release</h2>
     </section>
     {% endif %}
 
-    {% if dependency_diff.previous_dependencies and dependency_diff.current_dependencies %}
     <section class="p-6 pt-1 my-4 bg-white md:rounded-lg md:shadow-lg dark:text-white text-slate dark:bg-charcoal dark:bg-neutral-700">
       <h2 class="text-2xl">Dependencies</h2>
-      <div class="flex gap-x-4 gap-y-2 flex-wrap">
-        {% for dep in dependency_diff.current_dependencies %}
-          <div>
-            {{ dep.name }}
-          </div>
-        {% endfor %}
-      </div>
-
-      {% if dependency_diff.added %}
-        <h4 class="mt-3">Added</h4>
-        <div class="flex gap-x-4 flex-wrap">
+      {% if dependency_diff.previous_dependencies and dependency_diff.current_dependencies %}
+        <div class="flex gap-x-4 gap-y-2 flex-wrap">
           {% for dep in dependency_diff.current_dependencies %}
-            {% if dep.name in dependency_diff.added %}
-              <div>{{ dep.name }}</div>
-            {% endif %}
+            <div>
+              {{ dep.name }}
+            </div>
           {% endfor %}
         </div>
-      {% endif %}
 
-      {% if dependency_diff.removed %}
-        <h4 class="mt-3">Removed</h4>
-        <div class="flex gap-x-4 flex-wrap">
-          {% for dep in dependency_diff.previous_dependencies %}
-            {% if dep.name in dependency_diff.removed %}
-              <div>{{ dep.name }}</div>
-            {% endif %}
-          {% endfor %}
+        {% if dependency_diff.added %}
+          <h4 class="mt-3">Added</h4>
+          <div class="flex gap-x-4 flex-wrap">
+            {% for dep in dependency_diff.current_dependencies %}
+              {% if dep.name in dependency_diff.added %}
+                <div>{{ dep.name }}</div>
+              {% endif %}
+            {% endfor %}
+          </div>
+        {% endif %}
+
+        {% if dependency_diff.removed %}
+          <h4 class="mt-3">Removed</h4>
+          <div class="flex gap-x-4 flex-wrap">
+            {% for dep in dependency_diff.previous_dependencies %}
+              {% if dep.name in dependency_diff.removed %}
+                <div>{{ dep.name }}</div>
+              {% endif %}
+            {% endfor %}
+          </div>
+        {% endif %}
+      {% elif dependencies_not_calculated %}
+        <div class="text-sm">
+          Library dependencies will be generated soon, please check back later.
         </div>
       {% endif %}
 
     </section>
-    {% endif %}
 
     {% if description %}
       <section id="libraryReadMe"

templates/versions/detail.html

@@ -81,8 +81,12 @@
                   </div>
                 </div>
               </div>
+              {% elif dependencies_not_calculated %}
+                <div class="text-base whitespace-normal text-sm">
+                  Library dependency calculations will be generated soon, please check back later.
+                </div>
+              {% endif %}
             </div>
-          {% endif %}
         {% endif %}
 
         </div>

versions/exceptions.py

@@ -0,0 +1,4 @@
+class BoostImportedDataException(Exception):
+    """Custom exception for Boost data errors."""
+
+    pass

versions/models.py

@@ -6,6 +6,7 @@
 from django.utils.text import slugify
 
 from .converters import to_url
+from .exceptions import BoostImportedDataException
 from .managers import VersionManager, VersionFileManager
 from .utils.model_validators import validate_version_name_format
 
@@ -91,6 +92,7 @@ def get_dependency_diffs(self, library=None):
                 library=library
             )
         diffs = {}
+        dependencies_count = 0
         if previous_library_versions and current_library_versions:
             prev = {x.library.name: x for x in previous_library_versions}
             current = {x.library.name: x for x in current_library_versions}
@@ -102,6 +104,7 @@ def get_dependency_diffs(self, library=None):
                 current_dep_objects = current_lv.dependencies.all()
                 old_dependencies = {x.name for x in prev_dep_objects}
                 current_dependencies = {x.name for x in current_dep_objects}
+                dependencies_count += len(current_dependencies)
                 diffs[key] = {
                     "library_id": current_lv.library_id,
                     "added": list(current_dependencies - old_dependencies),
@@ -117,6 +120,9 @@ def get_dependency_diffs(self, library=None):
                         key=lambda x: x.name.lower(),
                     ),
                 }
+        if dependencies_count == 0:
+            msg = "No dependencies found for libraries in this version."
+            raise BoostImportedDataException(msg)
         return diffs
 
     @cached_property

versions/views.py

@@ -1,3 +1,4 @@
+import structlog
 from django.contrib.admin.views.decorators import staff_member_required
 from django.db.models.query import QuerySet
 from itertools import groupby
@@ -23,8 +24,11 @@
     determine_selected_boost_version,
     library_doc_latest_transform,
 )
+from versions.exceptions import BoostImportedDataException
 from versions.models import Review, Version
 
+logger = structlog.get_logger()
+
 
 @method_decorator(csrf_exempt, name="dispatch")
 class VersionDetail(BoostVersionMixin, VersionAlertMixin, DetailView):
@@ -66,7 +70,12 @@ def get_context_data(self, **kwargs):
         context["top_contributors_release"] = self.get_top_contributors_release(obj)
 
         context["documentation_url"] = obj.documentation_url
-        context["deps"] = self.get_library_version_dependencies(obj)
+        try:
+            context["deps"] = self.get_library_version_dependencies(obj)
+        except BoostImportedDataException:
+            logger.warning("Library version dependencies not set, need importing.")
+            context["deps"] = None
+            context["dependencies_not_calculated"] = True
         if context["version_str"] == LATEST_RELEASE_URL_PATH_STR:
             context["documentation_url"] = library_doc_latest_transform(
                 obj.documentation_url