🎱 Fields: Finished, Successful (#184)

* Adds custom bool fields for Finished, Successful * Simplifies js render logic
WGBH-MLA · Oct 27, 2023 · fb696c4 · fb696c4
1 parent 154ff05
commit fb696c4
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 2 deletions.
diff --git a/chowda/fields.py b/chowda/fields.py
@@ -4,7 +4,7 @@
 from starlette.datastructures import FormData
 from starlette.requests import Request
 from starlette_admin._types import RequestAction
-from starlette_admin.fields import BaseField, IntegerField, TextAreaField
+from starlette_admin.fields import BaseField, BooleanField, IntegerField, TextAreaField
 
 from chowda.models import MediaFile
 
@@ -161,3 +161,27 @@ class BatchUnstartedGuidsCount(IntegerField):
 
     async def parse_obj(self, request: Request, obj: Any) -> Any:
         return len(obj.unstarted_guids())
+
+
+@dataclass
+class FinishedField(BooleanField):
+    """A field that displays a boolean value for the 'Finished' property.
+
+        True: Green check
+    False: Grey clock"""
+
+    display_template: str = 'displays/finished.html'
+    render_function_key: str = 'finished'
+
+
+@dataclass
+class SuccessfulField(BooleanField):
+    """A field that displays a boolean value for the 'Successful' property.
+
+    True: Green check circle
+    False: Red X circle
+    None: Blank
+    """
+
+    display_template: str = 'displays/successful.html'
+    render_function_key: str = 'successful'
diff --git a/chowda/routers/events.py b/chowda/routers/events.py
@@ -53,7 +53,8 @@ async def event(event: dict):
             run = Run(f"{payload['flow_name']}/{payload['run_id']}")
             row.finished = run.finished
             row.finished_at = run.finished_at
-            row.successful = run.successful
+            if row.finished:
+                row.successful = run.successful
             row.current_step = payload['step_name']
             row.current_task = payload['task_id']
             db.add(row)

diff --git a/chowda/views.py b/chowda/views.py
@@ -24,9 +24,11 @@
     BatchPercentSuccessful,
     BatchUnstartedGuids,
     BatchUnstartedGuidsCount,
+    FinishedField,
     MediaFileCount,
     MediaFilesGuidsField,
     SonyCiAssetThumbnail,
+    SuccessfulField,
 )
 from chowda.models import MMIF, Batch, Collection, MediaFile
 from chowda.utils import get_duplicates, validate_media_file_guids
@@ -471,6 +473,19 @@ def can_create(self, request: Request) -> bool:
 class MetaflowRunView(AdminModelView):
     form_include_pk: ClassVar[bool] = True
 
+    fields: ClassVar[list[Any]] = [
+        'id',
+        'pathspec',
+        'batch',
+        'mmif',
+        'media_file',
+        'created_at',
+        FinishedField('finished'),
+        SuccessfulField('successful'),
+        'current_step',
+        'current_task',
+    ]
+
 
 class MMIFView(ChowdaModelView):
     label: ClassVar[str] = 'MMIFs'

diff --git a/static/js/custom-render.js b/static/js/custom-render.js
@@ -5,6 +5,7 @@ Object.assign(render, {
       guid => `<a href="../media-file/detail/${guid}"> ${guid} </a>`
     )
   },
+
   media_file_count: function render(data, type, full, meta, fieldOptions) {
     // Render a count of media files
     return data.length
@@ -21,4 +22,30 @@ Object.assign(render, {
       ? `<img src="${data.location}" style="max-height:150px;" loading="lazy">`
       : null
   },
+
+  finished: function render(data, type, full, meta, fieldOptions) {
+    if (data == null) return null_column();
+    data = Array.isArray(data) ? data : [data];
+    if (data.length == 0) return empty_column();
+    return `<div class="d-flex">${data
+      .map((d) =>
+        d === true
+          ? `<div class="p-1"><span class="text-center text-info"><i class="fa-solid fa-check fa-lg"></i></span></div>`
+          : `<div class="p-1"><span class="text-center text-secondary"><i class="fa-solid fa-clock fa-lg"></i></span></div>`
+      )
+      .join("")}</div>`;
+  },
+
+  successful: function render(data, type, full, meta, fieldOptions) {
+    if (data == null) return null_column();
+    data = Array.isArray(data) ? data : [data];
+    if (data.length == 0) return empty_column();
+    return `<div class="d-flex">${data
+      .map((d) =>
+        d === true
+          ? `<div class="p-1"><span class="text-center text-success"><i class="fa-solid fa-check-circle fa-lg"></i></span></div>`
+          : `<div class="p-1"><span class="text-center text-danger"><i class="fa-solid fa-circle-xmark fa-lg"></i></span></div>`
+      )
+      .join("")}</div>`;
+  },
 })
diff --git a/templates/displays/finished.html b/templates/displays/finished.html
@@ -0,0 +1,9 @@
+{% if data %}
+    <span class="text-center text-info me-1">
+        <i class="fa-solid fa-check fa-lg"></i>
+</span>
+{% else %}
+    <span class="text-center text-secondary me-1">
+        <i class="fa-solid fa-clock fa-lg"></i>
+</span>
+{% endif %}
diff --git a/templates/displays/successful.html b/templates/displays/successful.html
@@ -0,0 +1,9 @@
+{% if data %}
+    <span class="text-center text-success me-1">
+        <i class="fa-solid fa-check-circle fa-lg"></i>
+</span>
+{% elif data != None %}
+    <span class="text-center text-danger me-1">
+        <i class="fa-solid fa-circle-xmark fa-lg"></i>
+</span>
+{% endif %}