Skip to content

Speakr is a personal, self-hosted web application designed for transcribing audio recordings

Python

Reset stuck processing: accept QUEUED and retire the job it was waiting on

jjsmackay46e2cf80c153
diff --git a/src/api/recordings.py b/src/api/recordings.py
index 263aa209..a3c545ac 100644
--- a/src/api/recordings.py
+++ b/src/api/recordings.py
@@ -1264,10 +1264,18 @@ def reset_status(recording_id):
if not has_recording_access(recording, current_user, require_edit=True):
return jsonify({'error': 'You do not have permission to modify this recording'}), 403
- # Allow resetting if it's stuck or failed
- if recording.status in ['PENDING', 'PROCESSING', 'SUMMARIZING', 'FAILED']:
+ # Allow resetting if it's stuck or failed. QUEUED is included for a
+ # recording whose job never ran: reprocess refuses it as "already
+ # being processed", so this is its only way out.
+ if recording.status in ['PENDING', 'QUEUED', 'PROCESSING', 'SUMMARIZING', 'FAILED']:
recording.status = 'FAILED'
recording.error_message = "Manually reset from stuck or failed state."
+ # A job still waiting in the queue would claim the recording
+ # later and overwrite the reset. A running job cannot be stopped
+ # from here; it finishes on its own and sets a final status.
+ ProcessingJob.query.filter_by(recording_id=recording.id, status='queued').update(
+ {'status': 'failed', 'error_message': 'Cancelled by manual reset.'},
+ synchronize_session=False)
db.session.commit()
current_app.logger.info(f"Manually reset status for recording {recording_id} to FAILED.")
diff --git a/templates/components/detail/mobile-header.html b/templates/components/detail/mobile-header.html
index 852c49c0..d4586eb9 100644
--- a/templates/components/detail/mobile-header.html
+++ b/templates/components/detail/mobile-header.html
@@ -238,7 +238,7 @@
class="btn btn--icon btn--sm flex-shrink-0"
:title="t('summary.regenerateSummary')"><i class="fas fa-sync-alt"></i></button>
<button @click.stop="confirmReset(selectedRecording)"
- v-if="['PENDING', 'PROCESSING', 'SUMMARIZING', 'FAILED'].includes(selectedRecording.status)"
+ v-if="['PENDING', 'QUEUED', 'PROCESSING', 'SUMMARIZING', 'FAILED'].includes(selectedRecording.status)"
class="btn btn--icon btn--sm flex-shrink-0"
style="color: var(--text-warn, #d97706);"
:title="t('buttons.resetStuckProcessing')"><i class="fas fa-undo"></i></button>
diff --git a/templates/components/header.html b/templates/components/header.html
index 34c7a78b..697a1195 100644
--- a/templates/components/header.html
+++ b/templates/components/header.html
@@ -152,7 +152,7 @@
<!-- Reprocess menu: transcription and summary for settled
recordings, reset for stuck ones. Transcription needs the
audio, so it is left out once the audio is removed. -->
- <div v-if="(selectedRecording.can_edit !== false && (selectedRecording.status === 'COMPLETED' || selectedRecording.status === 'FAILED')) || ['PENDING', 'PROCESSING', 'SUMMARIZING', 'FAILED'].includes(selectedRecording.status)"
+ <div v-if="(selectedRecording.can_edit !== false && (selectedRecording.status === 'COMPLETED' || selectedRecording.status === 'FAILED')) || ['PENDING', 'QUEUED', 'PROCESSING', 'SUMMARIZING', 'FAILED'].includes(selectedRecording.status)"
class="relative hidden md:inline-flex" data-header-reprocess-menu>
<button @click.stop="showHeaderReprocessMenu = !showHeaderReprocessMenu; showHeaderMoreMenu = false"
class="btn btn--icon" :aria-expanded="showHeaderReprocessMenu" aria-haspopup="menu"
@@ -174,7 +174,7 @@
<i class="fas fa-sync-alt w-4 text-center text-[var(--text-muted)]"></i>
<span v-text="t('buttons.reprocessSummary')"></span>
</button>
- <button v-if="['PENDING', 'PROCESSING', 'SUMMARIZING', 'FAILED'].includes(selectedRecording.status)"
+ <button v-if="['PENDING', 'QUEUED', 'PROCESSING', 'SUMMARIZING', 'FAILED'].includes(selectedRecording.status)"
role="menuitem" @click="showHeaderReprocessMenu = false; confirmReset(selectedRecording)"
class="w-full flex items-center gap-2 px-3 py-2 text-left text-sm hover:bg-[var(--bg-tertiary)] transition-colors whitespace-nowrap" style="color: rgb(249, 115, 22);">
<i class="fas fa-undo w-4 text-center"></i>
diff --git a/tests/test_reset_status_queued.py b/tests/test_reset_status_queued.py
new file mode 100644
index 00000000..3392fede
--- /dev/null
+++ b/tests/test_reset_status_queued.py
@@ -0,0 +1,75 @@
+"""Reset stuck processing also covers QUEUED, and drops the job it was waiting on.
+
+A recording whose job never ran (an enqueue that raised, a queue row lost
+across an upgrade) sat QUEUED with no way out: reprocess refused it as
+"already being processed" and reset_status did not accept QUEUED. Resetting
+a QUEUED recording that does still have a queued job must also retire that
+job, or the worker claims it later and overwrites the reset.
+
+SHARED-DB: users, recordings and jobs are removed afterwards.
+"""
+
+import os
+import secrets
+import sys
+
+import pytest
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+from src.app import app, db
+from src.models import ProcessingJob, Recording, User
+
+app.config["WTF_CSRF_ENABLED"] = False
+
+
+def world():
+ with app.app_context():
+ n = f"reset_{secrets.token_hex(4)}"
+ u = User(username=n, email=f"{n}@local.test", password="x")
+ db.session.add(u)
+ db.session.commit()
+ r = Recording(user_id=u.id, title="Stuck", status="QUEUED", original_filename="s.wav",
+ audio_path="local://s.wav")
+ db.session.add(r)
+ db.session.commit()
+ ids = dict(user=u.id, rec=r.id)
+ yield ids
+ with app.app_context():
+ ProcessingJob.query.filter_by(recording_id=ids["rec"]).delete()
+ for model, key in ((Recording, "rec"), (User, "user")):
+ obj = db.session.get(model, ids[key])
+ if obj is not None:
+ db.session.delete(obj)
+ db.session.commit()
+
+
+def _reset(ids):
+ with app.test_client() as c:
+ with c.session_transaction() as sess:
+ sess["_user_id"] = str(ids["user"])
+ sess["_fresh"] = True
+ return c.post(f"/recording/{ids['rec']}/reset_status")
+
+
+def test_queued_recording_with_no_job_can_be_reset(world):
+ resp = _reset(world)
+ assert resp.status_code == 200, resp.get_data(as_text=True)[:300]
+ with app.app_context():
+ assert db.session.get(Recording, world["rec"]).status == "FAILED"
+
+
+def test_reset_retires_the_queued_job_but_not_a_running_one(world):
+ with app.app_context():
+ db.session.add_all([
+ ProcessingJob(user_id=world["user"], recording_id=world["rec"],
+ job_type="transcribe", status="queued"),
+ ProcessingJob(user_id=world["user"], recording_id=world["rec"],
+ job_type="summarize", status="processing"),
+ ])
+ db.session.commit()
+ assert _reset(world).status_code == 200
+ with app.app_context():
+ by_type = {j.job_type: j.status for j in ProcessingJob.query.filter_by(recording_id=world["rec"])}
+ assert by_type == {"transcribe": "failed", "summarize": "processing"}