Implement pipeline run status auto-refresh #390 (#428)

tdruez · web-flow · commit 5582fc887296 · 2022-04-18T18:22:19.000+04:00
* Implement pipeline run status auto-refresh #390 Signed-off-by: Thomas Druez <tdruez@nexb.com> * Display a "toast" notification on status refresh #390 Signed-off-by: Thomas Druez <tdruez@nexb.com> * Move the toast code logic to a "main.js" function #390 Signed-off-by: Thomas Druez <tdruez@nexb.com> * Fix unit test and extend the CHANGELOG #390 Signed-off-by: Thomas Druez <tdruez@nexb.com>
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,6 +7,12 @@ v31.0.0 (next)
 - WARNING: Drop support for Python 3.6 and 3.7. Add support for Python 3.10.
   Upgrade Django to version 4.x series.
 
+- Implement run status auto-refresh using the htmx JavaScript library.
+  The statuses of queued and running pipeline are now automatically refreshed
+  in the project list and project details views every 10 seconds.
+  A new "toast" type of notification is displayed along the status update.
+  https://github.com/nexB/scancode.io/issues/390
+
 - Ensure the worker service waits for migrations completion before starting.
   To solve this issue we install the wait-for-it script available in
   Debian by @vishnubob and as suggested in the Docker documentation.
diff --git a/scancodeio/static/bsd-simplified.LICENSE b/scancodeio/static/bsd-simplified.LICENSE
@@ -0,0 +1,7 @@
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/scancodeio/static/bulma-toast-2.4.1.min.js b/scancodeio/static/bulma-toast-2.4.1.min.js
diff --git a/scancodeio/static/bulma-toast-2.4.1.min.js.ABOUT b/scancodeio/static/bulma-toast-2.4.1.min.js.ABOUT
@@ -0,0 +1,15 @@
+about_resource: bulma-toast-2.4.1.min.js
+name: bulma-toast
+version: 2.4.1
+download_url: https://github.com/rfoel/bulma-toast/releases/download/v2.4.1/bulma-toast-2.4.1.tgz
+description: Bulma's pure JavaScript extension to display toasts
+homepage_url: https://rfoel.com/bulma-toast
+license_expression: mit
+attribute: yes
+checksum_md5: 9636a121215045c5b602d739f5610b6f
+checksum_sha1: 1e0ea72a810af2cc11a5c39cf4051567f5c29434
+package_url: pkg:github/rfoel/bulma-toast@2.4.1?download_url=https://github.com/rfoel/bulma-toast/releases/download/v2.4.1/bulma-toast-2.4.1.tgz
+licenses:
+  - key: mit
+    name: MIT License
+    file: mit.LICENSE
diff --git a/scancodeio/static/htmx-1.7.0.min.js b/scancodeio/static/htmx-1.7.0.min.js
diff --git a/scancodeio/static/htmx-1.7.0.min.js.ABOUT b/scancodeio/static/htmx-1.7.0.min.js.ABOUT
@@ -0,0 +1,15 @@
+about_resource: htmx-1.7.0.tar.gz
+name: htmx
+version: 1.7.0
+download_url: https://github.com/bigskysoftware/htmx/archive/refs/tags/v1.7.0.tar.gz
+description: high power tools for html
+homepage_url: https://htmx.org/
+license_expression: bsd-simplified
+attribute: yes
+checksum_md5: 60f07b7bf13a62a16d4792489252f1dd
+checksum_sha1: 3712bcbc653d0f0404e94c5d74233f70b61eb45e
+package_url: pkg:github/bigskysoftware/htmx@1.7.0
+licenses:
+  - key: bsd-simplified
+    name: BSD-2-Clause
+    file: bsd-simplified.LICENSE
diff --git a/scancodeio/static/main.js b/scancodeio/static/main.js
@@ -157,3 +157,39 @@ document.addEventListener('DOMContentLoaded', function () {
   }
 
 });
+
+// Toasts (requires bulma-toast.js)
+
+function displayPipelineStatusToast(run_status, pipeline_name, project_url) {
+    const default_options = {
+      "position": "top-center",
+      "dismissible": true,
+      "closeOnClick": false,
+      "pauseOnHover": true,
+      "duration": 30000 // 30 secs
+    }
+    let custom_options;
+
+    if (run_status === "running") {
+      custom_options = {
+        "message": `Pipeline ${pipeline_name} started.`,
+        "type": "is-info",
+        "duration": 3000 // 3 secs
+      }
+    }
+    else if (run_status === "success") {
+      custom_options = {
+        "message": `Pipeline ${pipeline_name} completed successfully.\n` +
+                   `<a href="${project_url}">Access or refresh the project page for results.</a>`,
+        "type": "is-success is-inline-block",
+      }
+    }
+    else {
+      custom_options = {
+        "message": `Pipeline ${pipeline_name} ${run_status}.`,
+        "type": "is-danger",
+      }
+    }
+
+    bulmaToast.toast({...default_options, ...custom_options});
+}
diff --git a/scanpipe/templates/scanpipe/base.html b/scanpipe/templates/scanpipe/base.html
@@ -52,6 +52,8 @@
     <script src="{% static 'main.js' %}" crossorigin="anonymous"></script>
     <script src="{% static 'fontawesome-5.15.1.all.min.js' %}" crossorigin="anonymous"></script>
     <script src="{% static 'highlight-10.6.0.min.js' %}" crossorigin="anonymous"></script>
+    <script src="{% static 'bulma-toast-2.4.1.min.js' %}" crossorigin="anonymous" defer></script>
+    <script src="{% static 'htmx-1.7.0.min.js' %}" crossorigin="anonymous" defer></script>
     {% block scripts %}{% endblock %}
   </body>
 </html>
diff --git a/scanpipe/templates/scanpipe/includes/run_modal.html b/scanpipe/templates/scanpipe/includes/run_modal.html
@@ -6,7 +6,7 @@
 
     let $modal = document.getElementById(modal_id);
     let run_uuid = event.detail.$button.dataset.uuid;
-    let run_detail_url = `/runs/${run_uuid}/`;
+    let run_detail_url = `/run/${run_uuid}/`;
     $modal.innerHTML = "";
 
     fetch(run_detail_url).then(function (response) {
diff --git a/scanpipe/templates/scanpipe/includes/run_status_tag.html b/scanpipe/templates/scanpipe/includes/run_status_tag.html
@@ -1,15 +1,29 @@
-{% if run.status == run.Status.SUCCESS %}
+{% if run.status == run.Status.RUNNING or run.status == run.Status.QUEUED %}
+  <span class="tag is-info" hx-get="{% url 'run_status' run.uuid %}?current_status={{ run.status }}" hx-trigger="load delay:10s" hx-swap="outerHTML">
+    {% if run.status == run.Status.RUNNING %}
+      Running <i class="fas fa-spinner fa-pulse ml-1" aria-hidden="true"></i>
+    {% elif run.status == run.Status.QUEUED %}
+      Queued <i class="fas fa-clock ml-1"></i>
+    {% endif %}
+  </span>
+{% elif run.status == run.Status.SUCCESS %}
   <span class="tag is-success">Success</span>
 {% elif run.status == run.Status.FAILURE %}
   <span class="tag is-danger">Failure</span>
-{% elif run.status == run.Status.RUNNING %}
-  <span class="tag is-info">Running <i class="fas fa-spinner fa-pulse ml-1" aria-hidden="true"></i></span>
-{% elif run.status == run.Status.QUEUED %}
-  <span class="tag is-info">Queued <i class="fas fa-clock ml-1"></i></span>
 {% elif run.status == run.Status.STALE %}
   <span class="tag is-dark">Stale</span>
 {% elif run.status == run.Status.STOPPED %}
   <span class="tag is-danger">Stopped</span>
 {% else %}
   <span class="tag is-light">Not started</span>
+{% endif %}
+
+{% if status_changed %}
+  <script>
+    displayPipelineStatusToast(
+      run_status="{{ run.status }}",
+      pipeline_name="{{ run.pipeline_name }}",
+      project_url="{{ run.project.get_absolute_url }}"
+    );
+  </script>
 {% endif %}
diff --git a/scanpipe/tests/test_auth.py b/scanpipe/tests/test_auth.py
@@ -139,6 +139,7 @@ def test_scancodeio_auth_views_are_protected(self):
             ("project_stop_pipeline", [a_uuid, a_uuid]),
             ("project_delete_pipeline", [a_uuid, a_uuid]),
             ("run_detail", [a_uuid]),
+            ("run_status", [a_uuid]),
             ("admin:index", None),
             ("rq_home", None),
             ("license_list", None),
diff --git a/scanpipe/tests/test_views.py b/scanpipe/tests/test_views.py
@@ -249,6 +249,50 @@ def test_scanpipe_views_delete_pipeline_view(self, mock_delete_task):
         response = self.client.get(url)
         self.assertEqual(404, response.status_code)
 
+    def test_scanpipe_views_run_status_view(self):
+        run = self.project1.add_pipeline("docker")
+        url = reverse("run_status", args=[run.uuid])
+
+        response = self.client.get(url)
+        expected = '<span class="tag is-light">Not started</span>'
+        self.assertContains(response, expected)
+
+        run.set_task_queued()
+        run.refresh_from_db()
+        response = self.client.get(url)
+        expected = 'Queued <i class="fas fa-clock ml-1"></i>'
+        self.assertContains(response, expected)
+        self.assertContains(response, f'hx-get="{url}?current_status={run.status}"')
+
+        run.set_task_started(run.pk)
+        run.refresh_from_db()
+        response = self.client.get(url)
+        expected = (
+            'Running <i class="fas fa-spinner fa-pulse ml-1" aria-hidden="true"></i>'
+        )
+        self.assertContains(response, expected)
+        self.assertContains(response, f'hx-get="{url}?current_status={run.status}"')
+
+        run.set_task_ended(exitcode=1)
+        response = self.client.get(url)
+        expected = '<span class="tag is-danger">Failure</span>'
+        self.assertContains(response, expected)
+
+        run.set_task_ended(exitcode=0)
+        response = self.client.get(url)
+        expected = '<span class="tag is-success">Success</span>'
+        self.assertContains(response, expected)
+
+        run.set_task_staled()
+        response = self.client.get(url)
+        expected = '<span class="tag is-dark">Stale</span>'
+        self.assertContains(response, expected)
+
+        run.set_task_stopped()
+        response = self.client.get(url)
+        expected = '<span class="tag is-danger">Stopped</span>'
+        self.assertContains(response, expected)
+
     def test_scanpipe_views_codebase_resource_details_annotations_missing_policy(self):
         resource1 = CodebaseResource.objects.create(
             project=self.project1,
diff --git a/scanpipe/urls.py b/scanpipe/urls.py
@@ -72,10 +72,15 @@
         name="project_reset",
     ),
     path(
-        "runs/<uuid:uuid>/",
+        "run/<uuid:uuid>/",
         views.run_detail_view,
         name="run_detail",
     ),
+    path(
+        "run/<uuid:uuid>/status/",
+        views.run_status_view,
+        name="run_status",
+    ),
     path(
         "project/<uuid:uuid>/results/<path:format>/",
         views.ProjectResultsView.as_view(),
diff --git a/scanpipe/views.py b/scanpipe/views.py
@@ -559,6 +559,19 @@ def run_detail_view(request, uuid):
     return render(request, template, context)
 
 
+@conditional_login_required
+def run_status_view(request, uuid):
+    template = "scanpipe/includes/run_status_tag.html"
+    run = get_object_or_404(Run, uuid=uuid)
+    context = {"run": run}
+
+    current_status = request.GET.get("current_status")
+    if current_status and current_status != run.status:
+        context["status_changed"] = True
+
+    return render(request, template, context)
+
+
 class CodebaseResourceRawView(
     ConditionalLoginRequired,
     ProjectRelatedViewMixin,
