Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
Merge: keep the originals without their audio (#413)
Murtaza Nasir8ce991cecf90
diff --git a/src/api/recordings.py b/src/api/recordings.pyindex be4477ee..ac895a88 100644--- a/src/api/recordings.py+++ b/src/api/recordings.py@@ -786,6 +786,9 @@ def merge_recordings_endpoint():- title (str, optional): title for the merged recording.- delete_originals (bool, optional): delete the sources after a successfulmerge (default False).+ - remove_original_audio (bool, optional): keep the sources but remove+ their audio after a successful merge (#413); ignored with+ delete_originals.Validation happens in-request; the audio concat runs later on a worker(job_type 'merge'), so a long merge never blocks the request. The merged@@ -807,6 +810,7 @@ def merge_recordings_endpoint():title = data.get('title')delete_originals = bool(data.get('delete_originals', False))+ remove_original_audio = bool(data.get('remove_original_audio', False)) and not delete_originals# notes_source_id: which source's notes to keep on the merged recording.# key absent -> default to the first source@@ -824,8 +828,9 @@ def merge_recordings_endpoint():else:notes_source_id = _UNSET- # Storage quota (#413): keeping the originals adds a copy of their audio.- if not delete_originals:+ # Storage quota (#413): keeping the originals with their audio adds a copy.+ # The answer names the two ways out the merge dialog offers.+ if not delete_originals and not remove_original_audio:from src.services.storage_quota import check_room, StorageQuotaExceededmerged_bytes = db.session.query(db.func.coalesce(db.func.sum(Recording.file_size), 0)).filter(Recording.id.in_([int(i) for i in recording_ids if str(i).isdigit()]),@@ -833,7 +838,10 @@ def merge_recordings_endpoint():try:check_room(current_user, int(merged_bytes))except StorageQuotaExceeded as quota_error:- return quota_error.response()+ body, status = quota_error.response()+ data_out = body.get_json()+ data_out['merge_options'] = ['remove_original_audio', 'delete_originals']+ return jsonify(data_out), statustry:recording = create_merge_recording(@@ -842,6 +850,7 @@ def merge_recordings_endpoint():title=title,delete_originals=delete_originals,notes_source_id=notes_source_id,+ remove_original_audio=remove_original_audio,)except MergeError as e:return jsonify({'error': str(e)}), 400diff --git a/src/services/recording_merge.py b/src/services/recording_merge.pyindex 05652700..bb9fb287 100644--- a/src/services/recording_merge.py+++ b/src/services/recording_merge.py@@ -165,7 +165,7 @@ def _validate_sources(user, recording_ids, storage, require_settled=True):def create_merge_recording(user, recording_ids, title=None, delete_originals=False,- require_settled=True, notes_source_id=_UNSET):+ require_settled=True, notes_source_id=_UNSET, remove_original_audio=False):"""Validate sources and create a placeholder recording queued for merging.Runs in the request (or, with ``require_settled=False``, from the stitch@@ -277,6 +277,9 @@ def create_merge_recording(user, recording_ids, title=None, delete_originals=Falparams={'source_ids': ordered_ids,'delete_originals': bool(delete_originals),+ # Keep the sources but remove their audio once the merged file+ # is stored: frees the space, keeps transcripts and notes (#413).+ 'remove_original_audio': bool(remove_original_audio) and not delete_originals,},is_new_upload=True,)@@ -300,6 +303,7 @@ def run_merge_job(recording, params):source_ids = (params or {}).get('source_ids') or []part_ids = (params or {}).get('part_ids') or []delete_originals = bool((params or {}).get('delete_originals', False))+ remove_original_audio = bool((params or {}).get('remove_original_audio', False))if len(source_ids) < 2 and len(part_ids) < 2:raise MergeError("Merge job is missing its source recordings.")@@ -393,6 +397,18 @@ def run_merge_job(recording, params):except Exception as e:db.session.rollback()current_app.logger.warning(f"Failed to delete source recording {rec.id} after merge: {e}")+ elif remove_original_audio:+ # Same point as deletion: the merged audio is stored, so the sources'+ # audio lives on in it. A source whose removal fails keeps its audio.+ from src.services.retention import remove_recording_audio+ for rec in sources:+ if rec.audio_deleted_at:+ continue+ try:+ remove_recording_audio(rec)+ except Exception as e:+ db.session.rollback()+ current_app.logger.warning(f"Failed to remove the audio of source recording {rec.id} after merge: {e}")# Queue transcription with the SAME resolved params a normal upload gets, so# the merged file honors all of the owner's tag/folder/account preferencesdiff --git a/src/services/recording_stitch.py b/src/services/recording_stitch.pyindex ebc4cc41..6d439a51 100644--- a/src/services/recording_stitch.py+++ b/src/services/recording_stitch.py@@ -490,6 +490,7 @@ def _try_kickoff_merge(recording, user_id, metadata) -> bool:source_ids,title=(intent.get('title') or None),delete_originals=bool(intent.get('delete_originals', False)),+ remove_original_audio=bool(intent.get('remove_original_audio', False)),require_settled=False,notes_source_id=notes_source_id,)diff --git a/static/js/modules/composables/audio.js b/static/js/modules/composables/audio.jsindex ece2680f..de1cee8f 100644--- a/static/js/modules/composables/audio.js+++ b/static/js/modules/composables/audio.js@@ -1468,10 +1468,11 @@ export function useAudio(state, utils) {// Called by the merge modal (recording mode) on confirm: finalize the// recording session with the merge intent. `orderedSpec` is the ordered// source list with the string '__self__' marking this clip's position.- const finalizeRecordingMerge = async (orderedSpec, { deleteOriginals = true, title = undefined, notesSource = undefined } = {}) => {+ const finalizeRecordingMerge = async (orderedSpec, { deleteOriginals = true, removeOriginalAudio = false, title = undefined, notesSource = undefined } = {}) => {const mergeIntent = {order: orderedSpec,delete_originals: !!deleteOriginals,+ remove_original_audio: !deleteOriginals && !!removeOriginalAudio,title: title || undefined,};// notesSource: '__self__' | <id> | null. Only include the key when thediff --git a/static/js/modules/composables/bulk-operations.js b/static/js/modules/composables/bulk-operations.jsindex 2f693e6f..e51c084c 100644--- a/static/js/modules/composables/bulk-operations.js+++ b/static/js/modules/composables/bulk-operations.js@@ -37,7 +37,11 @@ export function useBulkOperations({// Merge stateconst mergeOrderedList = ref([]); // ordered array of recording objectsconst mergeTitle = ref('');- const mergeDeleteOriginals = ref(false);+ // What happens to the sources after a merge: 'keep', 'remove_audio' (keep+ // them without their audio, which frees the space, #413) or 'delete'.+ const mergeOriginals = ref('keep');+ // Set when the server refused to keep a second copy for the storage quota.+ const mergeStorageNotice = ref('');const mergeInProgress = ref(false);// 'bulk' = merge existing recordings (POST /api/recordings/merge).// 'recording' = merge a just-recorded clip into existing ones; the list@@ -377,7 +381,8 @@ export function useBulkOperations({mergeMode.value = 'bulk';mergeOrderedList.value = selectedRecordings.value.slice();mergeTitle.value = '';- mergeDeleteOriginals.value = false;+ mergeOriginals.value = 'keep';+ mergeStorageNotice.value = '';mergeNotesSourceId.value = null;mergeAddPickerOpen.value = false;mergeAddSearch.value = '';@@ -397,7 +402,8 @@ export function useBulkOperations({notes: clipNotes || '',}];mergeTitle.value = '';- mergeDeleteOriginals.value = true;+ mergeOriginals.value = 'delete';+ mergeStorageNotice.value = '';mergeNotesSourceId.value = null;mergeAddPickerOpen.value = false;mergeAddSearch.value = '';@@ -417,7 +423,8 @@ export function useBulkOperations({mergeMode.value = 'bulk';mergeOrderedList.value = (seedRecordings || []).slice();mergeTitle.value = title || '';- mergeDeleteOriginals.value = !!deleteOriginals;+ mergeOriginals.value = deleteOriginals ? 'delete' : 'keep';+ mergeStorageNotice.value = '';mergeNotesSourceId.value = null;mergeAddPickerOpen.value = false;mergeAddSearch.value = '';@@ -474,12 +481,13 @@ export function useBulkOperations({const hasExisting = orderedSpec.some(x => x !== '__self__');if (!hasExisting || typeof finalizeRecordingMerge !== 'function') return;const title = mergeTitle.value.trim() || undefined;- const deleteOriginals = mergeDeleteOriginals.value;+ const deleteOriginals = mergeOriginals.value === 'delete';+ const removeOriginalAudio = mergeOriginals.value === 'remove_audio';// notes source: 'none' -> keep none (null); else the id or '__self__'.const notesSource = mergeNotesSourceId.value === 'none' ? null : mergeNotesSourceId.value;closeBulkMergeModal();try {- await finalizeRecordingMerge(orderedSpec, { deleteOriginals, title, notesSource });+ await finalizeRecordingMerge(orderedSpec, { deleteOriginals, removeOriginalAudio, title, notesSource });} catch (error) {console.error('Recording merge finalize error:', error);setGlobalError(`Failed to start merge: ${error.message}`);@@ -503,7 +511,8 @@ export function useBulkOperations({body: JSON.stringify({recording_ids: orderedIds,title: mergeTitle.value.trim() || undefined,- delete_originals: mergeDeleteOriginals.value,+ delete_originals: mergeOriginals.value === 'delete',+ remove_original_audio: mergeOriginals.value === 'remove_audio',// 'none' -> keep no notes (null); otherwise the chosen source id.notes_source_id: mergeNotesSourceId.value === 'none' ? null : mergeNotesSourceId.value})@@ -511,6 +520,14 @@ export function useBulkOperations({const data = await response.json();+ // Not enough room to keep a second copy (#413): keep the dialog+ // open, explain, and preselect keeping the originals without audio.+ if (response.status === 507 && data.code === 'storage_quota_exceeded') {+ mergeStorageNotice.value = _t('mergeRecordings.storageNotice', 'There is not enough storage to keep the originals with their audio. Keep them without their audio, or delete them.');+ mergeOriginals.value = 'remove_audio';+ return;+ }+if (!response.ok) {throw new Error(data.error || 'Failed to merge recordings');}@@ -771,7 +788,8 @@ export function useBulkOperations({bulkReprocessType,mergeOrderedList,mergeTitle,- mergeDeleteOriginals,+ mergeOriginals,+ mergeStorageNotice,mergeInProgress,mergeAddPickerOpen,mergeAddSearch,diff --git a/static/locales/de.json b/static/locales/de.jsonindex 1876eae6..8ef7cadc 100644--- a/static/locales/de.json+++ b/static/locales/de.json@@ -1446,7 +1446,15 @@"notesLabel": "Notizen übernehmen von","notesNone": "Keine Notizen übernehmen","notesWarning": "Es können nur die Notizen einer Aufnahme übernommen werden. Teilnehmer und Tags aller Aufnahmen werden zusammengeführt.",- "notesHint": "Teilnehmer und Tags aller Aufnahmen werden zusammengeführt."+ "notesHint": "Teilnehmer und Tags aller Aufnahmen werden zusammengeführt.",+ "originalsLabel": "Nach dem Zusammenführen",+ "originals_keep": "Originale behalten",+ "originals_keepHint": "Die ursprünglichen Aufnahmen bleiben unverändert.",+ "originals_remove_audio": "Originale ohne Audio behalten",+ "originals_remove_audioHint": "Die Originale behalten Transkript, Zusammenfassung und Notizen; ihr Audio wird entfernt, sobald die zusammengeführte Aufnahme gespeichert ist, und gibt so Speicher frei.",+ "originals_delete": "Originale löschen",+ "originals_deleteHint": "Die ursprünglichen Aufnahmen werden gelöscht, sobald die zusammengeführte Aufnahme gespeichert ist.",+ "storageNotice": "Der Speicher reicht nicht, um die Originale mit Audio zu behalten. Behalten Sie sie ohne Audio oder löschen Sie sie."},"messages": {"colorSchemeApplied": "Farbschema angewendet",diff --git a/static/locales/en.json b/static/locales/en.jsonindex 32c5dd35..817604f8 100644--- a/static/locales/en.json+++ b/static/locales/en.json@@ -1446,7 +1446,15 @@"notesLabel": "Keep notes from","notesNone": "Don't keep notes","notesWarning": "Only one recording's notes can be kept. Participants and tags from all recordings are combined.",- "notesHint": "Participants and tags from all recordings are combined."+ "notesHint": "Participants and tags from all recordings are combined.",+ "originalsLabel": "After merging",+ "originals_keep": "Keep the originals",+ "originals_keepHint": "The original recordings stay as they are.",+ "originals_remove_audio": "Keep the originals without their audio",+ "originals_remove_audioHint": "The originals keep their transcripts, summaries and notes; their audio is removed once the merged recording is saved, which frees the space.",+ "originals_delete": "Delete the originals",+ "originals_deleteHint": "The original recordings are deleted once the merged recording is saved.",+ "storageNotice": "There is not enough storage to keep the originals with their audio. Keep them without their audio, or delete them."},"messages": {"colorSchemeApplied": "Color scheme applied",diff --git a/static/locales/es.json b/static/locales/es.jsonindex 3eac82c5..3a279b69 100644--- a/static/locales/es.json+++ b/static/locales/es.json@@ -1446,7 +1446,15 @@"notesLabel": "Conservar notas de","notesNone": "No conservar notas","notesWarning": "Solo se pueden conservar las notas de una grabación. Los participantes y las etiquetas de todas las grabaciones se combinan.",- "notesHint": "Los participantes y las etiquetas de todas las grabaciones se combinan."+ "notesHint": "Los participantes y las etiquetas de todas las grabaciones se combinan.",+ "originalsLabel": "Después de combinar",+ "originals_keep": "Conservar los originales",+ "originals_keepHint": "Las grabaciones originales quedan como están.",+ "originals_remove_audio": "Conservar los originales sin su audio",+ "originals_remove_audioHint": "Los originales conservan su transcripción, resumen y notas; su audio se elimina cuando se guarda la grabación combinada, lo que libera espacio.",+ "originals_delete": "Eliminar los originales",+ "originals_deleteHint": "Las grabaciones originales se eliminan cuando se guarda la grabación combinada.",+ "storageNotice": "No hay almacenamiento suficiente para conservar los originales con su audio. Consérvelos sin audio o elimínelos."},"messages": {"colorSchemeApplied": "Esquema de color aplicado",diff --git a/static/locales/fr.json b/static/locales/fr.jsonindex 1b99bb7d..b43182f8 100644--- a/static/locales/fr.json+++ b/static/locales/fr.json@@ -1446,7 +1446,15 @@"notesLabel": "Conserver les notes de","notesNone": "Ne pas conserver de notes","notesWarning": "Les notes d'un seul enregistrement peuvent être conservées. Les participants et les étiquettes de tous les enregistrements sont regroupés.",- "notesHint": "Les participants et les étiquettes de tous les enregistrements sont regroupés."+ "notesHint": "Les participants et les étiquettes de tous les enregistrements sont regroupés.",+ "originalsLabel": "Après la fusion",+ "originals_keep": "Conserver les originaux",+ "originals_keepHint": "Les enregistrements d'origine restent tels quels.",+ "originals_remove_audio": "Conserver les originaux sans leur audio",+ "originals_remove_audioHint": "Les originaux gardent leur transcription, leur résumé et leurs notes ; leur audio est supprimé une fois l'enregistrement fusionné sauvegardé, ce qui libère de l'espace.",+ "originals_delete": "Supprimer les originaux",+ "originals_deleteHint": "Les enregistrements d'origine sont supprimés une fois l'enregistrement fusionné sauvegardé.",+ "storageNotice": "Le stockage ne suffit pas pour conserver les originaux avec leur audio. Conservez-les sans audio ou supprimez-les."},"messages": {"colorSchemeApplied": "Thème de couleurs appliqué",diff --git a/static/locales/pt-BR.json b/static/locales/pt-BR.jsonindex 7c2d9b6e..ab1a6122 100644--- a/static/locales/pt-BR.json+++ b/static/locales/pt-BR.json@@ -1446,7 +1446,15 @@"notesLabel": "Manter notas de","notesNone": "Não manter notas","notesWarning": "Somente as notas de uma gravação podem ser mantidas. Os participantes e as tags de todas as gravações são combinados.",- "notesHint": "Os participantes e as tags de todas as gravações são combinados."+ "notesHint": "Os participantes e as tags de todas as gravações são combinados.",+ "originalsLabel": "Depois de mesclar",+ "originals_keep": "Manter os originais",+ "originals_keepHint": "As gravações originais ficam como estão.",+ "originals_remove_audio": "Manter os originais sem o áudio",+ "originals_remove_audioHint": "Os originais mantêm transcrição, resumo e notas; o áudio deles é removido quando a gravação mesclada é salva, o que libera espaço.",+ "originals_delete": "Excluir os originais",+ "originals_deleteHint": "As gravações originais são excluídas quando a gravação mesclada é salva.",+ "storageNotice": "Não há armazenamento suficiente para manter os originais com o áudio. Mantenha-os sem o áudio ou exclua-os."},"messages": {"colorSchemeApplied": "Esquema de cores aplicado",diff --git a/static/locales/ru.json b/static/locales/ru.jsonindex 46991d78..e8fb290f 100644--- a/static/locales/ru.json+++ b/static/locales/ru.json@@ -1446,7 +1446,15 @@"notesLabel": "Сохранить заметки из","notesNone": "Не сохранять заметки","notesWarning": "Можно сохранить заметки только одной записи. Участники и теги всех записей объединяются.",- "notesHint": "Участники и теги всех записей объединяются."+ "notesHint": "Участники и теги всех записей объединяются.",+ "originalsLabel": "После объединения",+ "originals_keep": "Сохранить исходные записи",+ "originals_keepHint": "Исходные записи останутся без изменений.",+ "originals_remove_audio": "Сохранить исходные записи без аудио",+ "originals_remove_audioHint": "У исходных записей останутся расшифровка, сводка и заметки; их аудио удаляется после сохранения объединённой записи, что освобождает место.",+ "originals_delete": "Удалить исходные записи",+ "originals_deleteHint": "Исходные записи удаляются после сохранения объединённой записи.",+ "storageNotice": "Недостаточно места, чтобы сохранить исходные записи с аудио. Сохраните их без аудио или удалите."},"messages": {"colorSchemeApplied": "Цветовая схема применена",diff --git a/static/locales/zh.json b/static/locales/zh.jsonindex c11f11d1..799afcb1 100644--- a/static/locales/zh.json+++ b/static/locales/zh.json@@ -1446,7 +1446,15 @@"notesLabel": "保留备注来自","notesNone": "不保留备注","notesWarning": "只能保留一条录音的备注。所有录音的参与者和标签将被合并。",- "notesHint": "所有录音的参与者和标签将被合并。"+ "notesHint": "所有录音的参与者和标签将被合并。",+ "originalsLabel": "合并之后",+ "originals_keep": "保留原录音",+ "originals_keepHint": "原录音保持不变。",+ "originals_remove_audio": "保留原录音但删除其音频",+ "originals_remove_audioHint": "原录音保留转录、摘要和笔记;合并录音保存后删除其音频,从而释放空间。",+ "originals_delete": "删除原录音",+ "originals_deleteHint": "合并录音保存后删除原录音。",+ "storageNotice": "存储空间不足,无法连同音频保留原录音。请保留但删除其音频,或删除原录音。"},"messages": {"colorSchemeApplied": "已应用配色方案",diff --git a/templates/modals/bulk-merge-modal.html b/templates/modals/bulk-merge-modal.htmlindex 6e91a453..28610bd4 100644--- a/templates/modals/bulk-merge-modal.html+++ b/templates/modals/bulk-merge-modal.html@@ -94,14 +94,24 @@:placeholder="t('mergeRecordings.titlePlaceholder')"></div>- <!-- Delete originals -->- <label class="flex items-start gap-3 p-3 rounded-md border border-[var(--border-primary)] cursor-pointer hover:bg-[var(--bg-tertiary)] transition-colors">- <input type="checkbox" v-model="mergeDeleteOriginals" class="mt-1">- <div>- <span class="t-body-strong" v-text="t('mergeRecordings.deleteOriginals')"></span>- <p class="t-meta mt-0.5" v-text="t('mergeRecordings.deleteOriginalsHint')"></p>+ <!-- What happens to the originals: keep, keep without audio (frees+ the space, transcripts and notes stay, #413), or delete. -->+ <fieldset class="space-y-2">+ <legend class="block text-sm font-medium text-[var(--text-secondary)] mb-1" v-text="t('mergeRecordings.originalsLabel')"></legend>+ <div v-if="mergeStorageNotice" class="banner banner--warn" style="display: flex; align-items: flex-start; gap: var(--sp-2);">+ <i class="fas fa-database" style="margin-top: 2px;"></i>+ <div class="t-meta" v-text="mergeStorageNotice"></div></div>- </label>+ <label v-for="opt in ['keep', 'remove_audio', 'delete']" :key="opt"+ class="flex items-start gap-3 p-3 rounded-md border border-[var(--border-primary)] cursor-pointer hover:bg-[var(--bg-tertiary)] transition-colors"+ :class="{ 'border-[var(--border-focus)]': mergeOriginals === opt }">+ <input type="radio" :value="opt" v-model="mergeOriginals" name="merge-originals" class="mt-1">+ <div>+ <span class="t-body-strong" v-text="t('mergeRecordings.originals_' + opt)"></span>+ <p class="t-meta mt-0.5" v-text="t('mergeRecordings.originals_' + opt + 'Hint')"></p>+ </div>+ </label>+ </fieldset><div class="banner banner--warn mt-4" style="display: flex; align-items: flex-start; gap: var(--sp-2);"><i class="fas fa-info-circle" style="margin-top: 2px;"></i>diff --git a/tests/test_merge_export_features.py b/tests/test_merge_export_features.pyindex d5f993b8..1ca0b442 100644--- a/tests/test_merge_export_features.py+++ b/tests/test_merge_export_features.py@@ -365,6 +365,54 @@ def test_run_merge_job_delete_originals_removes_sources_after_concat():assert db.session.get(Recording, merged.id) is not None+def test_run_merge_job_can_keep_the_originals_without_their_audio():+ """#413: the sources stay with their transcripts; their audio is removed+ only after the merged file is stored, so the audio is never lost."""+ from src.services.recording_merge import create_merge_recording, run_merge_job+ with app.app_context():+ user = _mk_user()+ r1 = _mk_recording(user, title="A")+ r2 = _mk_recording(user, title="B")+ r1.transcription = "kept words"+ db.session.commit()+ with _endpoint_mocks() as enqueue:+ merged = create_merge_recording(user, [r1.id, r2.id], remove_original_audio=True)+ assert enqueue.call_args.kwargs["params"]["remove_original_audio"] is True++ params = {"source_ids": [r1.id, r2.id], "remove_original_audio": True}+ removed = []+ fake_retention_storage = MagicMock()+ fake_retention_storage.exists.return_value = True+ fake_retention_storage.delete.side_effect = lambda path, **kw: removed.append(path)+ with _worker_mocks(), patch("src.services.retention.get_storage_service", return_value=fake_retention_storage):+ run_merge_job(merged, params)++ for rid in (r1.id, r2.id):+ rec = db.session.get(Recording, rid)+ assert rec is not None and rec.audio_deleted_at is not None+ assert db.session.get(Recording, r1.id).transcription == "kept words"+ assert len(removed) == 2+ assert db.session.get(Recording, merged.id).audio_path.startswith("local://")+++def test_a_failed_merge_leaves_the_originals_audio():+ from src.services.recording_merge import create_merge_recording, run_merge_job, MergeError+ import pytest+ with app.app_context():+ user = _mk_user()+ r1 = _mk_recording(user, title="A")+ r2 = _mk_recording(user, title="B")+ with _endpoint_mocks():+ merged = create_merge_recording(user, [r1.id, r2.id], remove_original_audio=True)+ params = {"source_ids": [r1.id, r2.id], "remove_original_audio": True}+ with _worker_mocks() as (storage, _enqueue):+ storage.upload_local_file = MagicMock(side_effect=OSError("disk full"))+ with pytest.raises(MergeError):+ run_merge_job(merged, params)+ for rid in (r1.id, r2.id):+ assert db.session.get(Recording, rid).audio_deleted_at is None++def test_run_merge_job_empty_output_raises():from src.services.recording_merge import create_merge_recording, run_merge_job, MergeErrorimport pytest