mirror of
https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
synced 2026-10-01 20:42:50 +08:00
Major bug fixes and corner-case hardening across the backend, plus a
comprehensive feature test suite. All 94 unit tests + 51 integration
tests pass against a local TS3 server.
Lifecycle & state consistency
-----------------------------
- Bug A: startBot() now wraps connect() in a 15s deadline. A hung TS
handshake no longer blocks the /start HTTP call forever; the failing
instance is torn down and the caller gets a clean 500.
- Bug B: executeCommand rejects audio-dispatching commands (play, add,
next, skip, prev, playlist, album, fm) when the bot is disconnected.
Config-only commands (vol, mode, clear, stop, queue, now, lyrics)
still work so the UI stays usable while offline.
- Bug C: the tsClient 'disconnected' handler always clears player state
now, even when connect() never completed. A separate disconnectEmitted
flag guards duplicate external event emission. Previously an orphaned
connect attempt that idle-timed-out would leave playing=true forever.
- resolveAndPlay re-checks this.connected AFTER the URL-resolve await so
a stop() during the network call can't spawn ffmpeg on a disconnected
bot.
- connect() throws if disconnect() fired during the handshake await,
preventing a concurrent stop from being overwritten by a late connected
flag flip.
- startBot always disconnects the outgoing BotInstance before creating
a replacement, covering the mid-handshake case where isConnected()
still returned false but the library client was live.
- startBot now reuses the stored identity so server groups granted to
the bot survive restarts (was regenerating a fresh UID each time).
WebSocket reliability
---------------------
- BotManager extends EventEmitter and emits 'botInstance' whenever a
new instance is created. websocket.ts listens and re-attaches its
stateChange / connected / disconnected listeners immediately, fixing
the bug where player-bar UI never updated until manual refresh.
- attachedBots map now stores the BotInstance reference and detaches
stale listeners when the instance is replaced. Safety-net interval
(5s) also reconciles to catch anything missed.
- removeBot emits 'botInstanceRemoved' -> WS broadcasts a new
{type:"botRemoved", botId} message. Client drops the bot from its
local store instead of showing it as permanently offline.
HTTP input validation
---------------------
- /volume rejects non-number, NaN, Infinity, and out-of-range values
with a proper 400 instead of a 200 OK wrapping a usage-text string.
- /mode rejects anything not in {seq, loop, random, rloop} with 400.
- /seek rejects NaN / Infinity / negative (previously NaN slipped
through typeof==="number" and poisoned seekOffset).
- /play-at validates index < queue.size() BEFORE stopping current
playback (was silently killing the current song on invalid input).
- /play, /add, /playlist, /play-by-id, /add-by-id, /play-playlist
all honour platform=youtube now (previously fell through to netease
and silently played the wrong platform).
YouTube made truly optional
---------------------------
- Lazy checkYtDlpAvailable() runs `yt-dlp --version` once, caches only
positive results so users can install yt-dlp mid-run and have it
picked up without a restart.
- getAuthStatus() returns loggedIn=false with nickname
"YouTube (yt-dlp not installed)" when the binary is missing. UI can
grey out YouTube instead of silently returning empty searches.
- findYtDlp() picks .exe on win32 and bare binary elsewhere.
- /auth/status?platform=youtube now routes to the YouTube provider
instead of falling through to NetEase and leaking the NetEase
user's nickname + avatar.
- /auth/cookie rejects platform=youtube with 400 instead of clobbering
the NetEase cookie entry.
- README documents yt-dlp install paths (bin/ local vs PATH) and adds
a dedicated "Optional: YouTube source" section.
Bot Selector UI
---------------
- New power button in each row of the dropdown with play-state-aware
styling: disabled + wait-cursor during API call, green highlight when
connected, greys out when the bot is offline.
- Dropdown always visible when >=1 bot exists, bigger font + padding.
Queue correctness
-----------------
- PlayQueue.remove(current) now decrements currentIndex so next() in
sequential mode advances to the shifted song. Previously removing
the currently-playing track silently skipped the next track because
current() falsely reported it as active and next() then incremented
past it.
Vote-skip hardening
-------------------
- cmdVote: needed threshold is Math.max(1, ceil(users/2)) so a single
voter in an empty channel can't unanimously pass a vote with
needed=0.
- resolveAndPlay clears voteSkipUsers on every new track load so votes
can't leak across songs via cmdPlay/cmdPlaylist/cmdAlbum/cmdFm paths.
cmdAdd parity
-------------
- cmdAdd auto-plays the newly-added song if the player was idle,
matching /api/player/:id/add-by-id behaviour. Previously add'ing to
an empty queue on a connected+idle bot silently enqueued without
starting playback.
Test suite
----------
- scripts/test_full_feature.py — 51 tests across 10 groups exercising
every HTTP endpoint, WebSocket broadcasts, all music providers, bot
lifecycle, disconnected-state corners, seek validation, input
validation, and the main race conditions. Captures and restores the
target bot's initial state. Resilient to TS3 anti-flood via retry
with exponential backoff. Runs against a real local TS3 server.
- scripts/test_rapid_cycle.py — Bugs A/B/C regressions
- scripts/test_corner_cases.py — disconnect-during-connect race, config
commands while disconnected, etc.
- scripts/test_more_corners.py — resolveAndPlay race, seek NaN
- scripts/test_power_button.py — E2E for the new power button
- scripts/test_bot_remove.py — E2E for WS botRemoved broadcast
- scripts/test_playbar.py — player bar auto-show regression (updated
to restore bot state on exit)
- scripts/test_multibot.py — two-bot concurrent playback monitor
- src/audio/queue.test.ts — 4 new vitest cases for remove() edge cases
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
120 lines
4.2 KiB
Python
120 lines
4.2 KiB
Python
"""Reproduce / regression-check the player-bar-not-appearing bug.
|
|
|
|
Captures the bot's initial playback state and restores it on exit so the
|
|
test never leaves the user with surprise music or a cleared queue.
|
|
"""
|
|
import time
|
|
import requests
|
|
from playwright.sync_api import sync_playwright
|
|
|
|
BASE = "http://localhost:3000"
|
|
|
|
|
|
def api(path, method="GET", **kw):
|
|
fn = getattr(requests, method.lower())
|
|
r = fn(f"{BASE}{path}", timeout=10, **kw)
|
|
r.raise_for_status()
|
|
return r.json() if r.text else None
|
|
|
|
|
|
def get_bot(bot_id):
|
|
return next(b for b in api("/api/bot/")["bots"] if b["id"] == bot_id)
|
|
|
|
|
|
def capture_state(bot_id):
|
|
b = get_bot(bot_id)
|
|
return {
|
|
"playing": b["playing"],
|
|
"paused": b["paused"],
|
|
"song": (b["currentSong"] or {}).get("name"),
|
|
}
|
|
|
|
|
|
def main():
|
|
bots = api("/api/bot/")["bots"]
|
|
if not bots:
|
|
print("[skip] no bots")
|
|
return
|
|
bot_id = bots[0]["id"]
|
|
initial = capture_state(bot_id)
|
|
print(f"[init] initial state: {initial}")
|
|
|
|
try:
|
|
# Clear slate
|
|
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
time.sleep(0.6)
|
|
|
|
with sync_playwright() as p:
|
|
browser = p.chromium.launch(headless=True)
|
|
try:
|
|
ctx = browser.new_context()
|
|
ctx.add_init_script(
|
|
"""
|
|
(() => {
|
|
const OrigWS = window.WebSocket;
|
|
window.__wsMessages = [];
|
|
window.WebSocket = function(...args) {
|
|
const ws = new OrigWS(...args);
|
|
ws.addEventListener('message', (ev) => {
|
|
try {
|
|
const d = JSON.parse(ev.data);
|
|
window.__wsMessages.push({type: d.type, botId: d.botId});
|
|
} catch(e) {}
|
|
});
|
|
return ws;
|
|
};
|
|
Object.assign(window.WebSocket, OrigWS);
|
|
})();
|
|
"""
|
|
)
|
|
page = ctx.new_page()
|
|
page.goto(BASE)
|
|
page.wait_for_load_state("networkidle")
|
|
time.sleep(0.8)
|
|
|
|
assert page.locator(".player-wrapper").count() == 0, (
|
|
"player bar should be hidden before playback"
|
|
)
|
|
|
|
# Trigger play via API (simulates any play trigger)
|
|
api(
|
|
f"/api/player/{bot_id}/play",
|
|
method="POST",
|
|
json={"query": "the mass", "platform": "netease"},
|
|
)
|
|
|
|
# Poll for up to 6s to see if player bar appears automatically
|
|
appeared_at = None
|
|
for i in range(60):
|
|
if page.locator(".player-wrapper").count() > 0:
|
|
appeared_at = i * 0.1
|
|
break
|
|
page.wait_for_timeout(100)
|
|
|
|
if appeared_at is None:
|
|
msgs = page.evaluate("() => window.__wsMessages")
|
|
print(f"[FAIL] player bar never appeared; WS msgs: {msgs}")
|
|
raise AssertionError("player bar did not auto-show on stateChange")
|
|
print(f"[PASS] player bar appeared after {appeared_at:.1f}s")
|
|
finally:
|
|
browser.close()
|
|
finally:
|
|
# Restore: stop the "test" song we triggered, then re-apply initial
|
|
# state as best we can. We can't re-queue the user's previous song,
|
|
# but we can at least stop ours and leave the bot idle if it was idle.
|
|
try:
|
|
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
except Exception as e:
|
|
print(f"[warn] failed to stop test song on cleanup: {e}")
|
|
post = capture_state(bot_id)
|
|
print(f"[restore] bot now idle (was playing={initial['playing']} song={initial['song']!r})")
|
|
if initial["playing"] and initial["song"]:
|
|
print(
|
|
f"[note] initial bot was playing {initial['song']!r}; "
|
|
"this test cannot resume arbitrary tracks — you may need to restart playback"
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|