017553193f
Final commit of the automation-handler refactor. With this commit
every closure that used to live in
`web_server._register_automation_handlers` is now a top-level
function in `core/automation/handlers/`.
Handlers extracted in this commit:
- start_database_update + deep_scan_library
-> core/automation/handlers/database_update.py
Both share the db_update_state monitoring pattern (poll until
status flips, stall detection emits warning at 10 min, 2-hour
outer timeout). Lifted into a shared `_run_with_progress` helper
inside the module so the per-handler bodies stay tiny.
- run_duplicate_cleaner -> core/automation/handlers/duplicate_cleaner.py
- start_quality_scan -> core/automation/handlers/quality_scanner.py
- clear_quarantine, cleanup_wishlist, update_discovery_pool,
backup_database, refresh_beatport_cache
-> core/automation/handlers/maintenance.py
Grouped because each body is short (~20-50 lines) and they share
no state — splitting into per-handler files would just add import
noise.
- clean_search_history, clean_completed_downloads, full_cleanup
-> core/automation/handlers/download_cleanup.py
Grouped because all three reach the download orchestrator,
tasks_lock, and download_batches/download_tasks accessors. The
full_cleanup multi-step orchestration shares phase-detection
logic with clean_completed_downloads.
- run_script -> core/automation/handlers/run_script.py
- search_and_download -> core/automation/handlers/search_and_download.py
`AutomationDeps` grew with the new dependency surface:
- get_db_update_state + db_update_lock + db_update_executor +
run_db_update_task + run_deep_scan_task
- get_duplicate_cleaner_state + duplicate_cleaner_lock +
duplicate_cleaner_executor + run_duplicate_cleaner
- get_quality_scanner_state + quality_scanner_lock +
quality_scanner_executor + run_quality_scanner
- download_orchestrator + run_async + tasks_lock +
get_download_batches + get_download_tasks +
sweep_empty_download_directories + get_staging_path
- docker_resolve_path + get_current_profile_id +
get_watchlist_scanner + get_app + get_beatport_data_cache
- set_db_update_automation_id (writes the legacy global so the live
DB-update progress callbacks still living in web_server.py keep
emitting against the active automation card)
`web_server._register_automation_handlers` is now ~50 lines: build
deps once, call register_all. The 667-line block of remaining
closure definitions and engine register calls is gone.
The final orphan was the `_db_update_automation_id` module global —
the DB-update progress callbacks at line ~14080 still read it
directly, so the extracted database_update handler propagates the
automation id through `deps.set_db_update_automation_id` (a closure
in web_server that writes the global). When the legacy callbacks
get extracted in a future PR the setter goes away.
Tests:
- tests/automation/test_handlers_maintenance.py adds 21 boundary
tests covering every newly-extracted handler shape: guard
short-circuits (already-running returns skipped), deps wiring
(set_db_update_automation_id called with the right id),
exception swallow contract, status returns, path-traversal
blocked in run_script, source-mode skip in clean_search_history,
active-batch skip in clean_completed_downloads, etc.
- 3244 tests pass (was 3223 — 21 new), no regression.
web_server.py: 35,593 -> 34,220 lines (-1,373 net across 3 commits).
Issue #1 from the extraction punch list is now COMPLETE.
103 lines
3.8 KiB
Python
103 lines
3.8 KiB
Python
"""Automation handler: ``run_script`` action.
|
|
|
|
Lifted from ``web_server._register_automation_handlers`` (the
|
|
``_auto_run_script`` closure). Runs a user-provided shell or Python
|
|
script from the configured scripts directory with bounded timeout +
|
|
captured stdout/stderr. Path-traversal guard ensures users can't
|
|
escape the scripts directory.
|
|
|
|
Environment variables exposed to the script:
|
|
- ``SOULSYNC_EVENT``: triggering event type (when fired by an event)
|
|
- ``SOULSYNC_AUTOMATION``: automation name
|
|
- ``SOULSYNC_SCRIPTS_DIR``: absolute path to the scripts dir
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import subprocess as _sp
|
|
from typing import Any, Dict
|
|
|
|
from core.automation.deps import AutomationDeps
|
|
|
|
|
|
_MAX_TIMEOUT_SECONDS = 300 # Hard cap on user-supplied timeout config.
|
|
|
|
|
|
def auto_run_script(config: Dict[str, Any], deps: AutomationDeps) -> Dict[str, Any]:
|
|
script_name = config.get('script_name', '')
|
|
timeout = min(int(config.get('timeout', 60)), _MAX_TIMEOUT_SECONDS)
|
|
automation_id = config.get('_automation_id')
|
|
|
|
if not script_name:
|
|
return {'status': 'error', 'error': 'No script selected'}
|
|
|
|
scripts_dir = deps.docker_resolve_path(deps.config_manager.get('scripts.path', './scripts'))
|
|
if not scripts_dir or not os.path.isdir(scripts_dir):
|
|
os.makedirs(scripts_dir, exist_ok=True)
|
|
return {
|
|
'status': 'error',
|
|
'error': 'Scripts directory is empty. Add scripts to the scripts/ folder.',
|
|
}
|
|
|
|
script_path = os.path.join(scripts_dir, script_name)
|
|
script_path = os.path.realpath(script_path)
|
|
|
|
# Security: block path traversal — script must resolve under
|
|
# the scripts dir, no symlinks/.. tricks allowed out.
|
|
if not script_path.startswith(os.path.realpath(scripts_dir)):
|
|
return {'status': 'error', 'error': 'Script path traversal blocked'}
|
|
|
|
if not os.path.isfile(script_path):
|
|
return {'status': 'error', 'error': f'Script not found: {script_name}'}
|
|
|
|
deps.update_progress(automation_id, phase=f'Running {script_name}...', progress=10)
|
|
|
|
# Build environment with SoulSync context.
|
|
env = os.environ.copy()
|
|
event_data = config.get('_event_data') or {}
|
|
env['SOULSYNC_EVENT'] = str(event_data.get('type', ''))
|
|
env['SOULSYNC_AUTOMATION'] = config.get('_automation_name', '')
|
|
env['SOULSYNC_SCRIPTS_DIR'] = scripts_dir
|
|
|
|
try:
|
|
# Determine how to run the script.
|
|
if script_path.endswith('.py'):
|
|
cmd = ['python', script_path]
|
|
elif script_path.endswith('.sh'):
|
|
cmd = ['bash', script_path]
|
|
else:
|
|
cmd = [script_path]
|
|
|
|
result = _sp.run(
|
|
cmd,
|
|
capture_output=True, text=True, timeout=timeout,
|
|
cwd=scripts_dir, env=env,
|
|
)
|
|
|
|
deps.update_progress(automation_id, phase='Script completed', progress=100)
|
|
|
|
stdout = result.stdout[:2000] if result.stdout else ''
|
|
stderr = result.stderr[:1000] if result.stderr else ''
|
|
|
|
if result.returncode == 0:
|
|
deps.logger.info(f"Script '{script_name}' completed (exit 0)")
|
|
else:
|
|
deps.logger.warning(f"Script '{script_name}' exited with code {result.returncode}")
|
|
|
|
return {
|
|
'status': 'completed' if result.returncode == 0 else 'error',
|
|
'exit_code': str(result.returncode),
|
|
'stdout': stdout,
|
|
'stderr': stderr,
|
|
'script': script_name,
|
|
}
|
|
except _sp.TimeoutExpired:
|
|
deps.update_progress(automation_id, phase='Script timed out', progress=100)
|
|
return {
|
|
'status': 'error',
|
|
'error': f'Script timed out after {timeout}s',
|
|
'script': script_name,
|
|
}
|
|
except Exception as e: # noqa: BLE001 — automation handlers must never raise
|
|
return {'status': 'error', 'error': str(e), 'script': script_name}
|