soulsync/tests/discovery/test_cancel_sync_idempotent.py
BoulderBadgeDad 87e5e1fa23 #702: make mirrored-playlist cancel/reset/delete idempotent (un-wedge LB weekly sync)
Root cause (from the reporter's app.log): a ListenBrainz weekly playlist syncs
through the in-memory youtube_playlist_states discovery machine. When that live
state is lost — a Docker restart, or the discovery process ending while the user
waits for the media-server scan — the DB discover-download snapshot survives but
the live state is gone. Every recovery action (Cancel/Reset/Delete) then hit
`key not in states` and returned 404 "YouTube playlist not found" (hence the
confusing "Youtube" on a ListenBrainz playlist), leaving the playlist permanently
wedged with no way to dismiss or re-sync. Works for the maintainer because a
single session with no restart keeps the live state alive.

Fix — these are cleanup ops, so "the thing is already gone" is SUCCESS, not 404:
- cancel_sync core (shared by YouTube + ListenBrainz + Tidal/Deezer/Qobuz/...) →
  missing key returns idempotent success.
- reset_youtube_playlist / delete_youtube_playlist → same.
The playlist becomes recoverable: Cancel/Reset clears the dead state and the user
re-syncs fresh.

Tests: cancel_sync core (missing key = idempotent 200 not 404; present key still
cancels + clears the worker + reverts phase); endpoint-level idempotency for
cancel/reset/delete; updated the old test that locked the 404 wedge. 834 sync/
discovery tests green.
2026-06-11 12:55:55 -07:00

45 lines
1.7 KiB
Python

"""#702: a mirrored playlist (e.g. a ListenBrainz weekly) whose in-memory
discovery state was wiped by a restart must still cancel/reset cleanly instead of
404-ing into a permanent wedge. cancel_sync is the shared core for YouTube +
ListenBrainz cancel, so its idempotency is the fix."""
from __future__ import annotations
import threading
from core.discovery.endpoints import cancel_sync
def _lock():
return threading.Lock()
def test_cancel_missing_key_is_idempotent_success_not_404():
body, code = cancel_sync(
{}, 'state_was_wiped', label='YouTube',
not_found_message='YouTube playlist not found',
sync_lock=_lock(), sync_states={}, active_sync_workers={})
assert code == 200
assert body.get('success') is True
assert 'not found' not in str(body).lower() # the wedge message must be gone
def test_cancel_present_key_cancels_and_clears_worker():
states = {'h': {'phase': 'syncing', 'sync_playlist_id': 'sp1'}}
sync_states, workers = {}, {'sp1': 'worker'}
body, code = cancel_sync(
states, 'h', label='YouTube', not_found_message='x',
sync_lock=_lock(), sync_states=sync_states, active_sync_workers=workers)
assert code == 200 and body['success'] is True
assert sync_states['sp1'] == {'status': 'cancelled'}
assert 'sp1' not in workers
assert states['h']['phase'] == 'discovered'
assert states['h']['sync_playlist_id'] is None
def test_cancel_present_with_no_active_sync_still_succeeds():
states = {'h': {'phase': 'discovered', 'sync_playlist_id': None}}
body, code = cancel_sync(
states, 'h', label='YouTube', not_found_message='x',
sync_lock=_lock(), sync_states={}, active_sync_workers={})
assert code == 200 and body['success'] is True