Merge pull request #875 from tcely/patch-6

Add and use the `update_task_status` function

tubesync/sync/tasks.py

@@ -16,9 +16,9 @@ from PIL import Image
 from django.conf import settings
 from django.core.files.base import ContentFile
 from django.core.files.uploadedfile import SimpleUploadedFile
-from django.utils import timezone
+from django.db import DatabaseError, IntegrityError
 from django.db.transaction import atomic
-from django.db.utils import IntegrityError
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from background_task import background
 from background_task.models import Task, CompletedTask
@@ -106,6 +106,27 @@ def get_error_message(task):
     return error_message.split(':', 1)[1].strip()
 
 
+def update_task_status(task, status):
+    if not task:
+        return False
+    if not task._verbose_name:
+        task._verbose_name = remove_enclosed(
+            task.verbose_name, '[', ']', ' ',
+        )
+    if status is None:
+        task.verbose_name = task._verbose_name
+    else:
+        task.verbose_name = f'[{status}] {task._verbose_name}'
+    try:
+        with atomic():
+            task.save(update_fields={'verbose_name'})
+    except DatabaseError as e:
+        if 'Save with update_fields did not affect any rows.' == str(e):
+            pass
+        raise
+    return True
+
+
 def get_source_completed_tasks(source_id, only_errors=False):
     '''
         Returns a queryset of CompletedTask objects for a source by source ID.
@@ -238,18 +259,19 @@ def index_source_task(source_id):
     fields = lambda f, m: m.get_metadata_field(f)
     task = get_source_index_task(source_id)
     if task:
-        verbose_name = remove_enclosed(
+        task._verbose_name = remove_enclosed(
             task.verbose_name, '[', ']', ' ',
             valid='0123456789/,',
             end=task.verbose_name.find('Index'),
         )
-        tvn_format = '[{:,}' + f'/{num_videos:,}] {verbose_name}'
+    tvn_format = '{:,}' + f'/{num_videos:,}'
     for vn, video in enumerate(videos, start=1):
         # Create or update each video as a Media object
         key = video.get(source.key_field, None)
         if not key:
             # Video has no unique key (ID), it can't be indexed
             continue
+        update_task_status(task, tvn_format.format(vn))
         try:
             media = Media.objects.get(key=key, source=source)
         except Media.DoesNotExist:
@@ -261,10 +283,6 @@ def index_source_task(source_id):
         published_dt = media.metadata_published(timestamp)
         if published_dt is not None:
             media.published = published_dt
-        if task:
-            task.verbose_name = tvn_format.format(vn)
-            with atomic():
-                task.save(update_fields={'verbose_name'})
         try:
             media.save()
         except IntegrityError as e:
@@ -286,10 +304,8 @@ def index_source_task(source_id):
                     priority=20,
                     verbose_name=verbose_name.format(media.pk),
                 )
-    if task:
-        task.verbose_name = verbose_name
-        with atomic():
-            task.save(update_fields={'verbose_name'})
+    # Reset task.verbose_name to the saved value
+    update_task_status(task, None)
     # Cleanup of media no longer available from the source
     cleanup_removed_media(source, videos)
 
@@ -656,17 +672,14 @@ def save_all_media_for_source(source_id):
         metadata__isnull=False,
     )
     if task:
-        verbose_name = remove_enclosed(
+        task._verbose_name = remove_enclosed(
             task.verbose_name, '[', ']', ' ',
             valid='0123456789/,',
             end=task.verbose_name.find('Check'),
         )
-        tvn_format = '[1/{:,}' + f'/{refresh_qs.count():,}] {verbose_name}'
+    tvn_format = '1/{:,}' + f'/{refresh_qs.count():,}'
     for mn, media in enumerate(refresh_qs, start=1):
-        if task:
-            task.verbose_name = tvn_format.format(mn)
-            with atomic():
-                task.save(update_fields={'verbose_name'})
+        update_task_status(task, tvn_format.format(mn))
         try:
             media.refresh_formats
         except YouTubeError as e:
@@ -679,20 +692,14 @@ def save_all_media_for_source(source_id):
 
     # Trigger the post_save signal for each media item linked to this source as various
     # flags may need to be recalculated
-    if task:
-        tvn_format = '[2/{:,}' + f'/{mqs.count():,}] {verbose_name}'
+    tvn_format = '2/{:,}' + f'/{mqs.count():,}'
     for mn, media in enumerate(mqs, start=1):
-        if task:
-            task.verbose_name = tvn_format.format(mn)
-            with atomic():
-                task.save(update_fields={'verbose_name'})
+        update_task_status(task, tvn_format.format(mn))
         if media.uuid not in already_saved:
             with atomic():
                 media.save()
-    if task:
-        task.verbose_name = verbose_name
-        with atomic():
-            task.save(update_fields={'verbose_name'})
+    # Reset task.verbose_name to the saved value
+    update_task_status(task, None)
 
 
 @background(schedule=60, remove_existing_tasks=True)