Refresh the cell every 10 seconds on running scan #222

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

Author: tdruez

component_catalog/urls.py

@@ -23,6 +23,7 @@
 from component_catalog.views import ScanListView
 from component_catalog.views import component_create_ajax_view
 from component_catalog.views import delete_scan_view
+from component_catalog.views import get_scan_progress_htmx_view
 from component_catalog.views import package_create_ajax_view
 from component_catalog.views import package_scan_view
 from component_catalog.views import send_scan_data_as_file_view
@@ -98,6 +99,11 @@
         package_scan_view,
         name="package_scan",
     ),
+    path(
+        "packages/<str:dataspace>/<uuid:uuid>/scan_progress_htmx/",
+        get_scan_progress_htmx_view,
+        name="scan_progress_htmx",
+    ),
     path(
         "packages/<str:dataspace>/<uuid:uuid>/tab_scan/",
         PackageTabScanView.as_view(),

component_catalog/views.py

@@ -40,6 +40,7 @@
 from django.utils.translation import gettext_lazy as _
 from django.views.decorators.csrf import csrf_exempt
 from django.views.decorators.csrf import csrf_protect
+from django.views.decorators.http import require_GET
 from django.views.decorators.http import require_POST
 from django.views.generic import FormView
 from django.views.generic.edit import BaseFormView
@@ -1477,9 +1478,17 @@ def package_scan_view(request, dataspace, uuid):
                     dataspace=dataspace,
                 )
                 scan["download_result_url"] = get_scan_results_as_file_url(scan)
+
+                status = scancodeio.get_status_from_scan_results(scan)
+                needs_refresh = False
+                if status in ["running", "not_started", "queued"]:
+                    needs_refresh = True
+
                 context = {
+                    "package": package,
                     "scan": scan,
                     "view_url": package.get_absolute_url(),
+                    "needs_refresh": needs_refresh,
                 }
                 return render(request, template, context)
 
@@ -1498,6 +1507,36 @@ def package_scan_view(request, dataspace, uuid):
     return redirect(f"{package.details_url}#scan")
 
 
+@login_required
+@require_GET
+def get_scan_progress_htmx_view(request, dataspace, uuid):
+    template = "product_portfolio/tables/scan_progress_cell.html"
+    dataspace = request.user.dataspace
+    package = get_object_or_404(Package, uuid=uuid, dataspace=dataspace)
+    scancodeio = ScanCodeIO(dataspace)
+
+    scan = scancodeio.get_scan_results(
+        download_url=package.download_url,
+        dataspace=dataspace,
+    )
+    if not scan:
+        raise Http404("Scan not found.")
+
+    status = scancodeio.get_status_from_scan_results(scan)
+    needs_refresh = False
+    if status in ["running", "not_started", "queued"]:
+        needs_refresh = True
+
+    scan["download_result_url"] = get_scan_results_as_file_url(scan)
+    context = {
+        "package": package,
+        "scan": scan,
+        "view_url": package.get_absolute_url(),
+        "needs_refresh": needs_refresh,
+    }
+    return render(request, template, context)
+
+
 @login_required
 @require_POST
 def package_create_ajax_view(request):

dejacode_toolkit/scancodeio.py

@@ -156,6 +156,13 @@ def delete_scan(self, detail_url):
             logger.debug(f"{self.label} [Exception] {exception}")
         return False
 
+    @staticmethod
+    def get_status_from_scan_results(scan_results):
+        status = ""
+        if runs := scan_results.get("runs"):
+            status = runs[0].get("status", "")
+        return status
+
     def update_from_scan(self, package, user):
         """
         Update the provided `package` instance using values from Scan results.

product_portfolio/templates/product_portfolio/tables/scan_progress_cell.html

@@ -1,4 +1,10 @@
-<div id="scan-progress-{{ scan.uuid }}">
+<div id="scan-progress-{{ scan.uuid }}"
+     {% if needs_refresh %}
+     hx-get="{% url 'component_catalog:scan_progress_htmx' package.dataspace.name package.uuid %}"
+     hx-trigger="load delay:10s"
+     hx-swap="innerHTML"
+     {% endif %}
+>
   {% include 'component_catalog/includes/scan_status.html' with status=scan.runs.0.status only %}
   <ul class="list-inline mt-1 mb-0">
     {% if view_url %}

product_portfolio/templates/product_portfolio/tabs/tab_inventory.html

@@ -149,7 +149,7 @@
           {% if display_scan_features %}
             <td>
               {% if relation.scan %}
-                {% include 'product_portfolio/tables/scan_progress_cell.html' with scan=relation.scan view_url=relation.package.get_absolute_url only %}
+                {% include 'product_portfolio/tables/scan_progress_cell.html' with scan=relation.scan view_url=relation.package.get_absolute_url package=relation.packages only %}
               {% elif relation.package %}
                 {% include 'product_portfolio/tables/scan_action_cell.html' with package=relation.package user=request.user only %}
               {% endif %}