mirror of
https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
synced 2026-10-02 04:52:50 +08:00
Compare commits
304
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ea0f7c17b5 | ||
|
|
051171b019 | ||
|
|
750ad9b1cc | ||
|
|
3841fa80d3 | ||
|
|
04ceac5a97 | ||
|
|
ada292574f | ||
|
|
15190413b2 | ||
|
|
f637ba0191 | ||
|
|
b9767a7471 | ||
|
|
47b29358ae | ||
|
|
cb66d77e9c | ||
|
|
9f5e27a277 | ||
|
|
486c3a0a69 | ||
|
|
8359c56dc7 | ||
|
|
a97e72ef30 | ||
|
|
a1cc0b8574 | ||
|
|
81b8953d52 | ||
|
|
1a3ccd0e38 | ||
|
|
ec0a027a1e | ||
|
|
19306002e3 | ||
|
|
8e89a078a7 | ||
|
|
4cd269d852 | ||
|
|
49a47f5e2b | ||
|
|
952bd26d2d | ||
|
|
7e58e8a611 | ||
|
|
2e05d276bf | ||
|
|
9a32f3c602 | ||
|
|
2413a9a3a1 | ||
|
|
03690952cb | ||
|
|
c8227faf31 | ||
|
|
beda8d626c | ||
|
|
08fe350e02 | ||
|
|
6dc99d88e2 | ||
|
|
11c0948330 | ||
|
|
0914cfeb2f | ||
|
|
d796dd48ff | ||
|
|
399cf0cf41 | ||
|
|
b4c3cc0539 | ||
|
|
dc763ec689 | ||
|
|
b9fe770ab1 | ||
|
|
657c198a37 | ||
|
|
488734c0db | ||
|
|
6e0a0f7392 | ||
|
|
6a72833c2a | ||
|
|
b672d76634 | ||
|
|
eb3523f374 | ||
|
|
6bde51c991 | ||
|
|
8998b9623f | ||
|
|
322335dfc5 | ||
|
|
efe47c5bbc | ||
|
|
35bdd2a168 | ||
|
|
540bf8c032 | ||
|
|
333f7606e4 | ||
|
|
8c84090b63 | ||
|
|
3277736f5d | ||
|
|
8bd0aae7c3 | ||
|
|
9c796ec05c | ||
|
|
b5b3585e77 | ||
|
|
179e7c248a | ||
|
|
3a9504500b | ||
|
|
6debe23034 | ||
|
|
641da086e5 | ||
|
|
9d55bea240 | ||
|
|
f2b14b5f00 | ||
|
|
470a62129a | ||
|
|
32718f0118 | ||
|
|
978e6ee7f2 | ||
|
|
77d71fe418 | ||
|
|
50bdaae26a | ||
|
|
e1171dbcfe | ||
|
|
9a9f68c446 | ||
|
|
848b3931b8 | ||
|
|
828fd21e29 | ||
|
|
6c16e2d966 | ||
|
|
b352d71528 | ||
|
|
92bdfcb294 | ||
|
|
f8743a904f | ||
|
|
f6e42811a5 | ||
|
|
08260182a9 | ||
|
|
de4343cfbb | ||
|
|
af50d69b00 | ||
|
|
e1439a5899 | ||
|
|
5ae5168b6b | ||
|
|
4cb1da29d4 | ||
|
|
f9caea6c79 | ||
|
|
a12c419dd2 | ||
|
|
af326a37b7 | ||
|
|
45f5d236c1 | ||
|
|
ea6820204d | ||
|
|
e849db2286 | ||
|
|
e12cbf8863 | ||
|
|
4e148302fc | ||
|
|
9c861f487d | ||
|
|
70c0273ae7 | ||
|
|
e2fa288f48 | ||
|
|
59a9e742c8 | ||
|
|
31d3830791 | ||
|
|
d1bd010260 | ||
|
|
fbb127a86d | ||
|
|
7b2bd0ea6a | ||
|
|
8e5e9c810e | ||
|
|
e104093614 | ||
|
|
b387d6581e | ||
|
|
17ab477af6 | ||
|
|
10e29476f4 | ||
|
|
215e328f17 | ||
|
|
3346286ffd | ||
|
|
72ffd44f68 | ||
|
|
b090a8ec21 | ||
|
|
f98ce47c52 | ||
|
|
0c7f7e128b | ||
|
|
0cc77fdee0 | ||
|
|
3b2b2185a5 | ||
|
|
253c0a46a1 | ||
|
|
a1a70dea5d | ||
|
|
43c0175334 | ||
|
|
c1d73b6ba8 | ||
|
|
66230e6b43 | ||
|
|
952f1fbad3 | ||
|
|
365352cdd3 | ||
|
|
45414b3baa | ||
|
|
f142c514cd | ||
|
|
e47fc76529 | ||
|
|
0fe0e973e6 | ||
|
|
28cff59a6f | ||
|
|
b17057cc41 | ||
|
|
15fcb11f4f | ||
|
|
9d8c95b2f9 | ||
|
|
e36a049216 | ||
|
|
3042f87199 | ||
|
|
a21a01f0dd | ||
|
|
78cf516c4c | ||
|
|
0c59a9f84a | ||
|
|
d2ab888114 | ||
|
|
0073d7d612 | ||
|
|
e0acbf5457 | ||
|
|
d763043305 | ||
|
|
821fa0669d | ||
|
|
8fbc522d06 | ||
|
|
271504eec1 | ||
|
|
c9a0719128 | ||
|
|
0514162824 | ||
|
|
60c8a5c993 | ||
|
|
fb7f187ede | ||
|
|
1fd5dbaba3 | ||
|
|
3433ccb661 | ||
|
|
694ff77712 | ||
|
|
06aaec4ba5 | ||
|
|
62b5b09857 | ||
|
|
05f090d83a | ||
|
|
4244695075 | ||
|
|
6f21b6354a | ||
|
|
3a34c01abb | ||
|
|
ba11519fdb | ||
|
|
d3fd547ea0 | ||
|
|
75f09694a3 | ||
|
|
6d56f1f371 | ||
|
|
64328d7bdf | ||
|
|
287dd240b1 | ||
|
|
22ec7328fa | ||
|
|
540641700d | ||
|
|
3422d45eeb | ||
|
|
f7626f40b3 | ||
|
|
de2c956c31 | ||
|
|
3802c90d2d | ||
|
|
839f777a75 | ||
|
|
dd6affca6d | ||
|
|
bea2f92508 | ||
|
|
f19f56a666 | ||
|
|
140020f63a | ||
|
|
6e10764d28 | ||
|
|
9bfe831022 | ||
|
|
bbdd4cbc78 | ||
|
|
c57cd35f09 | ||
|
|
1a1f365cf1 | ||
|
|
d1544bab42 | ||
|
|
e0d17cf404 | ||
|
|
b2de607391 | ||
|
|
355793b7e6 | ||
|
|
593b42830c | ||
|
|
463a8e2f8a | ||
|
|
88ac7d2a68 | ||
|
|
53d28de17e | ||
|
|
ca07ebc3b7 | ||
|
|
bf1fb1fd88 | ||
|
|
846fb2c28c | ||
|
|
34655e5f50 | ||
|
|
491bc53dec | ||
|
|
8f5bb26b3a | ||
|
|
4ba4b013b0 | ||
|
|
484202e90d | ||
|
|
9f0ac74fbc | ||
|
|
51c954993a | ||
|
|
907a6651f5 | ||
|
|
1ca1ca9d0c | ||
|
|
d70664067c | ||
|
|
5177b41951 | ||
|
|
bb86f7e9ed | ||
|
|
221f7c8dcf | ||
|
|
cf76e0f69a | ||
|
|
abf60141d9 | ||
|
|
ce15f36e5e | ||
|
|
1f0f162f66 | ||
|
|
cd6f2c6078 | ||
|
|
696b224f8d | ||
|
|
7a8666efbb | ||
|
|
f0c979ce71 | ||
|
|
d810a2ec0f | ||
|
|
554501cc74 | ||
|
|
aaf6ba2ab4 | ||
|
|
547aaa304e | ||
|
|
f09a589940 | ||
|
|
a861b41809 | ||
|
|
e9b3ba0075 | ||
|
|
0401534b88 | ||
|
|
f720da49d6 | ||
|
|
3abb468cca | ||
|
|
c8daa14219 | ||
|
|
81cd8a2bec | ||
|
|
35210cf570 | ||
|
|
d2bad58aa8 | ||
|
|
f73ca1f61b | ||
|
|
a0f290459d | ||
|
|
b6b9aa07bc | ||
|
|
a39fc25104 | ||
|
|
1a11489f2e | ||
|
|
c0504d65a5 | ||
|
|
780726a4e3 | ||
|
|
a73f797bcb | ||
|
|
b0b61f8fce | ||
|
|
7be4f13774 | ||
|
|
6af0e97f51 | ||
|
|
ceb24595e6 | ||
|
|
fb7feec5cf | ||
|
|
175b8e6065 | ||
|
|
f46b37192f | ||
|
|
a8b056d2aa | ||
|
|
e148c1556e | ||
|
|
e2e888710a | ||
|
|
7509814abc | ||
|
|
0dc8746914 | ||
|
|
2560fc87c2 | ||
|
|
6db35f704d | ||
|
|
490b2d57dc | ||
|
|
486979841e | ||
|
|
ee5673a22f | ||
|
|
d1c9e14bf0 | ||
|
|
17c11f0512 | ||
|
|
df5d125279 | ||
|
|
5914f41ea1 | ||
|
|
68a2fb2943 | ||
|
|
34523cb00f | ||
|
|
8ea1a64c59 | ||
|
|
df79976933 | ||
|
|
d3af918f53 | ||
|
|
f7c16888e7 | ||
|
|
a2982948a7 | ||
|
|
b7e1f9f30b | ||
|
|
7fc5186c24 | ||
|
|
de92c8bcd4 | ||
|
|
6b143e1a56 | ||
|
|
5728209573 | ||
|
|
02d8b39d75 | ||
|
|
f87aaaf8c3 | ||
|
|
8861f39ecc | ||
|
|
6d5755ced7 | ||
|
|
997bb17ceb | ||
|
|
ea6501ea81 | ||
|
|
1d2da33d3c | ||
|
|
0e68e287b7 | ||
|
|
ecdb2d253e | ||
|
|
8860347bfe | ||
|
|
beb99f1d8e | ||
|
|
63f1ced2bc | ||
|
|
fa6013d22e | ||
|
|
6b60792277 | ||
|
|
c562fe05b0 | ||
|
|
9efa818bbb | ||
|
|
d757e69bf4 | ||
|
|
88ff62c829 | ||
|
|
8cccf2ed24 | ||
|
|
f6b82b8e21 | ||
|
|
51d7ce61bd | ||
|
|
20f4cfacea | ||
|
|
7d9081efc1 | ||
|
|
a2453784c1 | ||
|
|
0f9c7b3c4c | ||
|
|
914180792d | ||
|
|
935656dc4f | ||
|
|
2dd6a9e20d | ||
|
|
ffa27d7224 | ||
|
|
edd0fc58eb | ||
|
|
366edf7843 | ||
|
|
ff5502be2f | ||
|
|
4407cd0c67 | ||
|
|
b8c12e0291 | ||
|
|
e7411ee7fb | ||
|
|
ce88d12a60 | ||
|
|
719ceae303 | ||
|
|
52ece9321f | ||
|
|
0bf34d8652 | ||
|
|
9179780afb | ||
|
|
f76500cfb2 | ||
|
|
7eb96d9068 |
No files matched your search
@@ -15,8 +15,6 @@
|
||||
"mcp__scheduled-tasks__*"
|
||||
],
|
||||
"deny": [
|
||||
"Bash(git push * main)",
|
||||
"Bash(git push * master)",
|
||||
"Bash(git push --force *)",
|
||||
"Bash(rm -rf /)"
|
||||
]
|
||||
|
||||
@@ -19,8 +19,6 @@
|
||||
"Read(//tmp/**)"
|
||||
],
|
||||
"deny": [
|
||||
"Bash(git push * main)",
|
||||
"Bash(git push * master)",
|
||||
"Bash(git push --force *)",
|
||||
"Bash(rm -rf /)"
|
||||
]
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
name: Build and Publish Docker Image
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: 'Extra tag to publish (optional, e.g. "edge")'
|
||||
required: false
|
||||
default: ''
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: zhangtianyao1/teamspeak-music-bot
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to GHCR
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Extract image metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
type=semver,pattern={{major}}.{{minor}}
|
||||
type=semver,pattern={{major}}
|
||||
type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/v') }}
|
||||
type=raw,value=${{ inputs.tag }},enable=${{ inputs.tag != '' }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
file: scripts/docker/Dockerfile
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
@@ -7,5 +7,6 @@ config.json
|
||||
cookies/
|
||||
.superpowers/
|
||||
.worktrees/
|
||||
setup.log
|
||||
/bin/
|
||||
scripts/navbar_bigger.png
|
||||
@@ -5,7 +5,7 @@
|
||||
<h1 align="center">TSMusicBot</h1>
|
||||
|
||||
<p align="center">
|
||||
<strong>TeamSpeak 音乐机器人</strong> — 网易云音乐 + QQ 音乐 + 哔哩哔哩 + YouTube(可选),YesPlayMusic 风格 WebUI 控制面板
|
||||
<strong>TeamSpeak 音乐机器人</strong> — 网易云音乐 + QQ 音乐 + 酷狗音乐 + 哔哩哔哩 + YouTube(可选),Jellyfin / Spotify 可选启用,YesPlayMusic 风格 WebUI 控制面板
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -15,25 +15,37 @@
|
||||
<img src="https://img.shields.io/badge/许可证-MIT-green" />
|
||||
<img src="https://img.shields.io/badge/FFmpeg-已内置-orange?logo=ffmpeg" />
|
||||
<img src="https://img.shields.io/badge/Docker-支持-2496ED?logo=docker&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/酷狗音乐-支持-2ca2f9" />
|
||||
<img src="https://img.shields.io/badge/BiliBili-支持-00a1d6?logo=bilibili&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/Jellyfin-可选-aa5cc3?logo=jellyfin&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/YouTube-可选-FF0000?logo=youtube&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/Spotify-可选-1DB954?logo=spotify&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/TS3-支持-2580C3?logo=teamspeak&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/TS6-支持-2580C3?logo=teamspeak&logoColor=white" />
|
||||
</p>
|
||||
|
||||
> v1.10.0 新增**可选**的 [Jellyfin](https://jellyfin.org/) 音源(由 [@ItsEricRao](https://github.com/ItsEricRao) 在 [PR #123](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/pull/123) 中贡献):连接自建 Jellyfin 服务器直接播放你自己的音乐库。默认关闭,在 **设置 → Jellyfin 音乐库** 一键开启;原有在线音源保持默认启用,行为不变。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- **多平台音源** — 网易云音乐 + QQ 音乐 + 哔哩哔哩(默认内置),YouTube 可选启用(通过 yt-dlp),统一搜索,结果标注来源
|
||||
- **WebUI 鉴权与细粒度权限(必选)** — 用户名 + 密码登录,多用户、两种角色(管理员 / 成员);成员可进一步配置**细粒度能力**(播放控制 / 队列管理 / 机器人管理 / 平台登录 / 音质)和**按机器人授权白名单**,所有变更操作由后端逐请求强制校验。bcrypt 加密、HttpOnly 会话 Cookie,CSRF 防护,WebSocket 同样鉴权。首次访问引导创建管理员。从无鉴权旧版本升级时请参阅 [更新升级](#更新升级) 章节
|
||||
- **游客模式(免登录点歌,默认关闭)** — 管理员可选择允许访客**无需账号密码**进入 WebUI 点歌,并逐项配置游客权限(8 个开关,默认仅「添加到队列末尾」开启)与可控机器人白名单;游客无法查看 / 修改任何设置、管理机器人或访问用户管理。开启后登录页出现 **「以游客身份进入」**。详见下文 **「游客模式 / Guest mode」** 小节
|
||||
- **本地收藏歌单** — 在首页 / 搜索 / 歌单页一键收藏,收藏内容按用户存储,登录后跨设备同步
|
||||
- **本地音频上传播放** — 在搜索页拖拽或选择本地音频上传,上传后可直接播放 / 下一首播放 / 加入队列;管理员可在 设置 → 行为设置 开关此功能,播放结束或停止/清空/替换队列时会清理服务端接收的本地文件
|
||||
- **专属链接(单机器人锁定)** — 通过 `/bot/<id>` 专属链接打开 WebUI 时锁定到单个机器人,刷新后保持,适合把某台机器人的控制页分享给特定用户
|
||||
- **频道无人时自动暂停** — 机器人所在频道没有其他人时自动暂停播放,有人加入后自动恢复(**默认关闭**,可在设置中开启)
|
||||
- **Jellyfin 音源(可选)** — 连接自建 [Jellyfin](https://jellyfin.org/) 服务器作为额外音源:搜索(歌曲 / 专辑 / 歌单)、懒解析直传播放、同步歌词、收藏 Instant Mix 电台(`!fm -j`)、首页「最近添加 / 播放最多 / 收藏 / 流派」,并把播放进度回报给 Jellyfin(PlayCount / 播放状态)。**默认关闭**,在 设置 → Jellyfin 音乐库 一键开启。详见 [可选:Jellyfin 音源](#可选jellyfin-音源)
|
||||
- **多平台音源(enabledProviders 门控)** — 网易云音乐 / QQ 音乐 / 酷狗音乐 / 哔哩哔哩 / YouTube(yt-dlp,需安装)**默认启用**,可在 `config.json` 的 `enabledProviders` 中逐个停用;Jellyfin 为可选音源(见上),**Spotify(实验性)** 由独立开关控制(需 Premium + 自建开发者应用,默认关闭,详见 [Spotify 音源(实验性)](#spotify-音源实验性))。统一搜索(歌曲 / 歌单 / 专辑均支持翻页「加载更多」),结果标注来源,禁用音源不出现在搜索栏
|
||||
- **真实客户端协议 (TS3/TS6 双协议)** — 机器人在 TeamSpeak 中可见(非 ServerQuery 隐身模式),自动检测并适配 TS3 和 TS6 服务器,支持 TS6 HTTP Query API
|
||||
- **YesPlayMusic 风格 WebUI** — 精美界面,支持深色/浅色主题切换
|
||||
- **完整播放控制** — 播放/暂停/上一首/下一首/进度跳转/音量调节
|
||||
- **四种播放模式** — 顺序播放/循环播放/随机播放/随机循环
|
||||
- **实时歌词同步** — 歌词滚动显示,支持翻译歌词,服务端帧计数精确同步
|
||||
- **歌单管理** — 推荐歌单/我的歌单/每日推荐/私人FM,点击播放全部
|
||||
- **歌单管理** — 推荐歌单/我的歌单/每日推荐/私人FM,点击播放全部;私人 FM 支持网易云、**QQ 音乐雷达推荐**(`!fm -q`)与**酷狗私人电台**(`!fm -k`)。网易云、QQ、酷狗均提供登录后的推荐歌单 / 每日推荐 / 我的歌单
|
||||
- **音质选择** — 标准(128k) / 较高(192k) / 极高(320k) / 无损(FLAC) / Hi-Res / 超清母带
|
||||
- **B站视频音频提取** — 搜索B站视频,自动提取DASH最高码率音频流播放
|
||||
- **B站热门推荐** — 首页展示B站热门视频和个性化推荐(登录后更准确)
|
||||
- **QR码登录** — 扫码登录网易云/QQ音乐/哔哩哔哩账号,Cookie 自动持久化
|
||||
- **QR码登录** — 扫码登录网易云/QQ音乐/酷狗音乐/哔哩哔哩账号,Cookie 自动持久化
|
||||
- **机器人形象自动更新** — 播放时自动更新头像(专辑封面)、昵称(当前歌曲)、描述、Away 状态、频道描述,停止时恢复默认值。每项功能独立可配置,权限不足时自动降级
|
||||
- **多机器人独立播放** — 多个机器人同时在不同服务器或频道播放不同音乐,每个机器人独立的播放队列、进度和音量,WebUI 一键切换控制
|
||||
- **播放历史** — 自动记录所有播放过的歌曲
|
||||
@@ -155,6 +167,81 @@ sudo ./scripts/install.sh
|
||||
>
|
||||
> **如何判断是否需要迁移**:如果你是全新安装,或者你的机器人数据库中 `identity` 字段已经是空的,则**无需任何操作**。完成上述步骤后,按下面对应的系统升级步骤执行即可。
|
||||
|
||||
### 关于 enabledProviders 音源开关(v1.10.0 起)
|
||||
|
||||
v1.10.0([PR #123](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/pull/123))引入 `enabledProviders` 音源开关与可选的 Jellyfin 音源。当前默认值为 `["netease", "qq", "bilibili", "youtube", "kugou"]`——**与旧版行为一致**,从更早版本升级**无需任何操作**,在线音源照常可用;Jellyfin 需要手动开启(详见 [可选:Jellyfin 音源](#可选jellyfin-音源))。
|
||||
|
||||
> ⚠️ **仅影响短暂运行过 v1.10.0 初版的用户**:该版本曾把默认音源设为 Jellyfin-only。如果你在那段时间保存过设置,`data/config.json` 中可能被写入了 `"enabledProviders": ["jellyfin"]`,升级后在线音源会保持停用。修复方法:把在线音源加回列表(或直接删除该字段以使用默认值),重启机器人(网易云 / QQ 的内嵌 API 服务需要重启才会启动):
|
||||
>
|
||||
> ```json
|
||||
> "enabledProviders": ["netease", "qq", "bilibili", "youtube", "kugou", "jellyfin"]
|
||||
> ```
|
||||
|
||||
### 从 WebUI 无鉴权版本升级(重要)
|
||||
|
||||
本次更新引入了**强制 WebUI 鉴权**。从无鉴权旧版本升级后,**WebUI 必须先创建管理员账号才能使用**。所有 `/api/*` 端点(除少量公共白名单)和 `/ws` 现在都需要登录。
|
||||
|
||||
**升级行为**:
|
||||
|
||||
- 启动时数据库自动迁移:新增 `users`、`sessions`、`user_audit` 三张表;旧的 `bot_instances`、`play_history` 数据**完全保留**。
|
||||
- 第一次打开 WebUI 自动跳转到 `/first-run` 引导创建首位管理员(角色固定为 `admin`)。
|
||||
- 之后访问任何页面都会校验登录态,未登录跳转 `/login`。
|
||||
|
||||
**会话与 Cookie**:
|
||||
|
||||
- 登录态保存 7 天,每次请求滚动续期(活跃用户不会被踢出)。
|
||||
- 同一账号最多保持 10 个并发会话(超过自动剔除最旧的)。
|
||||
- Cookie 设置为 `HttpOnly; SameSite=Lax`,HTTPS 部署需配合 `trustProxy: true`(详见 [反向代理部署注意事项](#反向代理部署注意事项))。
|
||||
|
||||
**多用户与角色**:
|
||||
|
||||
- 角色 `admin`:完整权限(用户管理、审计、机器人、音乐平台、播放控制)。
|
||||
- 角色 `member`:除"用户管理"和"操作审计"外的所有功能(适合给团队成员开通播放权)。
|
||||
- 在 **设置 → 用户管理**(仅管理员)中添加 / 删除 / 重置密码 / 切换角色。
|
||||
- 至少保留一个管理员:系统会阻止删除或降级最后一位管理员。
|
||||
|
||||
**游客模式 / Guest mode**:
|
||||
|
||||
让访客**无需账号密码**即可进入 WebUI 点歌,同时严格限制其可用能力。该功能**默认关闭**,只有管理员能开启。
|
||||
|
||||
- **开启方式**:管理员在 **设置 → 游客模式** 打开「允许游客访问」(仅管理员可见此区块)。开启后登录页会出现 **「以游客身份进入」** 按钮,访客点击即可创建游客会话,无需任何凭据。游客共享同一匿名身份、会话有效期较短(约 1 天)。关闭游客模式(或缩小机器人作用域)后立即生效,所有在线游客会话——包括正在连接的实时 WebSocket——会被立刻断开 / 重新限制。
|
||||
- **逐项权限(8 个开关,管理员配置)**:除「添加到队列末尾」外**全部默认关闭**,按需逐项放开。
|
||||
|
||||
| 开关 | 字段 | 默认 |
|
||||
|------|------|------|
|
||||
| 添加到队列末尾 | `addToQueue` | **开** |
|
||||
| 添加到下一首 | `playNext` | 关 |
|
||||
| 立即播放(不清空队列) | `playNow` | 关 |
|
||||
| 跳过当前歌曲 | `skip` | 关 |
|
||||
| 暂停/继续/进度/音量 | `transport` | 关 |
|
||||
| 移除/清空队列 | `removeClear` | 关 |
|
||||
| 切换播放模式 / FM | `playMode` | 关 |
|
||||
| 播放整个歌单/专辑 | `playCollection` | 关 |
|
||||
|
||||
- **按机器人授权(游客作用域)**:可选择「全部机器人」或指定一份机器人白名单。作用域之外的机器人对游客**不可见、不可控**。
|
||||
- **游客始终被禁止**:查看或修改任何设置、管理机器人、设置音乐平台账号 / 凭据、修改音质、收藏歌单、修改密码、访问用户管理与操作审计,以及读取机器人主人的私人歌单 / 私人 FM / 每日推荐等平台账号数据。这些限制不受上面 8 个开关影响,**永远锁死**。
|
||||
- **复现 issue #83 的「下一首 only」需求**:在 **设置 → 游客模式** 中关闭「添加到队列末尾」并打开「添加到下一首」,游客便只能把歌曲加到下一首播放。
|
||||
|
||||
**如何重置忘记的管理员密码**:
|
||||
|
||||
如果你忘记了管理员密码,可以直接编辑 SQLite 数据库 `data/tsmusicbot.db`:
|
||||
|
||||
```bash
|
||||
# 方案 1:清空所有用户,重新进入 first-run 流程
|
||||
sqlite3 data/tsmusicbot.db "DELETE FROM users; DELETE FROM sessions;"
|
||||
# 然后重启机器人,浏览器再次访问会自动进入 /first-run
|
||||
|
||||
# 方案 2:把指定用户重置为已知密码(密码 'changeme-now' 的 bcrypt 哈希示例如下)
|
||||
# 先用 node 生成哈希:
|
||||
node -e "console.log(require('bcryptjs').hashSync('changeme-now', 12))"
|
||||
# 把输出贴到 SQL 里:
|
||||
sqlite3 data/tsmusicbot.db "UPDATE users SET passwordHash='<paste-hash-here>' WHERE username='你的用户名';"
|
||||
```
|
||||
|
||||
**反向代理用户特别注意**:如果通过 nginx / Caddy / Cloudflare 暴露 WebUI,**必须**在 `config.json` 中设置 `"trustProxy": true`,否则 Cookie 不会带 `Secure` 标志,且登录限流会把所有用户合并到同一个桶。详见下方 [反向代理部署注意事项](#反向代理部署注意事项)。
|
||||
|
||||
**`config.adminGroups`(现已启用)**:用于限制管理类聊天命令(`stop`/`clear`/`remove`/`move`/`vol`/`mode`)只能由指定 TeamSpeak 服务器组的成员运行;为空时不做任何限制(向后兼容)。详见 [TeamSpeak 命令权限](#teamspeak-命令权限管理类命令限制)。`config.adminPassword` 则是旧版预留字段,当前版本未使用,保留以兼容旧 `config.json`,可以放心忽略。
|
||||
|
||||
### Windows 用户
|
||||
|
||||
```
|
||||
@@ -221,21 +308,28 @@ sudo systemctl start tsmusicbot
|
||||
|
||||
### 首次配置
|
||||
|
||||
1. 打开 **http://localhost:3000/setup** 进入设置向导
|
||||
2. 填写 TeamSpeak 服务器地址(默认端口:9987)
|
||||
3. 设置机器人昵称
|
||||
4. (可选)扫码登录网易云/QQ音乐账号以播放 VIP 歌曲
|
||||
1. 启动机器人后打开 **http://localhost:3000/**
|
||||
- 全新部署:自动跳转 `/first-run`,填写用户名(3-32 字符)和密码(≥8 位)创建首位**管理员**账号
|
||||
- 之后所有 WebUI 操作都需要登录,登录态保持 7 天(活动会滚动续期)
|
||||
2. 在 **设置 → 机器人管理** 中点击"创建新实例",填写:
|
||||
- TeamSpeak 服务器地址(无端口,仅主机名,例如 `ts.example.com`)
|
||||
- 端口(默认 9987,自托管或非标准端口请填写实际值)
|
||||
- 机器人昵称
|
||||
- 可选:服务器密码、默认频道
|
||||
3. 在 **设置 → 音乐账号** 扫码登录网易云 / QQ 音乐 / 酷狗音乐 / B 站账号(可选,登录后可播放 VIP 歌曲、获取每日推荐 / 我的歌单等)
|
||||
4. (可选)在 **设置 → Jellyfin 音乐库** 连接自建 Jellyfin 服务器并打开「启用 Jellyfin 音源」(安装向导第 3 步保存连接时会自动启用;详见 [可选:Jellyfin 音源](#可选jellyfin-音源))
|
||||
5. 在 **设置 → 用户管理**(仅管理员可见)按需添加成员。成员默认可控制播放但无法管理其他用户;管理员还可为每个成员单独配置**能力**(播放控制 / 队列 / 机器人管理 / 平台登录 / 音质)和**可操作的机器人白名单**,未授权的机器人对该成员不可见、不可控
|
||||
|
||||
### WebUI 页面说明
|
||||
|
||||
| 页面 | 功能 |
|
||||
|------|------|
|
||||
| **首页** | 推荐歌单、每日推荐、私人FM、我的歌单 |
|
||||
| **搜索** | 三平台统一搜索,结果标注网易云/QQ/B站来源 |
|
||||
| **歌单** | 查看歌单详情,播放全部(根据当前播放模式选择首歌) |
|
||||
| **首页** | 推荐歌单、每日推荐、私人FM(网易云 / QQ 雷达 / 酷狗电台)、我的歌单、收藏的歌单(各源带标签切换);启用 Jellyfin 后另有「Jellyfin 电台 / 最近添加 / 播放最多 / 收藏 / 流派」区块 |
|
||||
| **搜索** | 跨音源统一搜索(仅显示已启用的音源;启用 Jellyfin 后其结果排最前),结果标注来源,可一键收藏歌单 |
|
||||
| **歌单** | 查看歌单详情,播放全部(根据当前播放模式选择首歌),一键收藏 |
|
||||
| **歌词** | 全屏歌词页,实时同步滚动,模糊专辑封面背景 |
|
||||
| **历史** | 播放历史记录 |
|
||||
| **设置** | 主题切换、机器人管理、三平台账号登录、音质选择、命令前缀 |
|
||||
| **设置** | 账户(修改自己密码) / 主题切换 / 机器人管理 / 行为设置(空闲超时、频道无人自动暂停) / 多平台账号登录(网易云 / QQ / 酷狗 / B站) / 音质选择 / 命令前缀 / 用户管理(仅管理员,含成员能力与机器人白名单)/ 操作审计(仅管理员) |
|
||||
|
||||
### TeamSpeak 文字命令
|
||||
|
||||
@@ -243,23 +337,33 @@ sudo systemctl start tsmusicbot
|
||||
|
||||
| 命令 | 说明 |
|
||||
|------|------|
|
||||
| `!play <歌名>` | 搜索并播放 |
|
||||
| `!play <歌名>` | 搜索并播放(取最热门的匹配项;默认音源为网易云) |
|
||||
| `!play -n <歌名>` | 显式从网易云音乐搜索(默认音源即网易云,通常可省略) |
|
||||
| `!play -j <歌名>` | 从 Jellyfin 搜索(需先启用 Jellyfin 音源) |
|
||||
| `!play -q <歌名>` | 从 QQ 音乐搜索 |
|
||||
| `!play -k <歌名>` | 从酷狗音乐搜索 |
|
||||
| `!play -b <关键词>` | 从哔哩哔哩搜索视频并播放音频 |
|
||||
| `!play -y <关键词>` | 从 YouTube 搜索并播放(需要安装 [yt-dlp](#可选youtube-音源))|
|
||||
| `!add <歌名>` | 添加到播放队列 |
|
||||
| `!search <歌名> [-j\|-n\|-q\|-k\|-b\|-y]` | 列出前若干个匹配结果(含序号与 id),用于挑选同名歌曲;可加平台标志切换音源 |
|
||||
| `!play #<序号>` | 播放上一次 `!search` 结果中的第 N 项(区分同名歌曲) |
|
||||
| `!play id:<id>` | 按歌曲 id 播放精确的某首歌(也支持直接粘贴网易云 / QQ / B站 歌曲链接;Jellyfin 曲目用 GUID ItemId) |
|
||||
| `!add <歌名>` | 添加到播放队列(同样支持 `#序号` / `id:<id>` / 链接) |
|
||||
| `!pause` / `!resume` | 暂停 / 恢复播放 |
|
||||
| `!next` / `!prev` | 下一首 / 上一首 |
|
||||
| `!stop` | 停止播放并清空队列 |
|
||||
| `!vol <0-100>` | 设置音量 |
|
||||
| `!queue` | 查看播放队列 |
|
||||
| `!remove <位置>` | 从队列中删除指定位置的歌曲(位置从 1 开始,见 `!queue`) |
|
||||
| `!mode <seq\|loop\|random\|rloop>` | 切换播放模式 |
|
||||
| `!playlist <歌单名或ID>` | 加载歌单(支持名称模糊搜索和 ID) |
|
||||
| `!playlist <歌单名或ID>` | 加载歌单(支持名称模糊搜索和 ID;Jellyfin 歌单 GUID 也可直接粘贴) |
|
||||
| `!playlist -q <歌单名>` | 从 QQ 音乐搜索并加载歌单 |
|
||||
| `!album <ID>` | 加载专辑 |
|
||||
| `!artist <歌手名>` | 按歌手循环播放(支持 `-q`/`-b`/`-y`) |
|
||||
| `!fm` | 私人 FM(网易云,自动续播) |
|
||||
| `!lyrics` | 显示当前歌词 |
|
||||
| `!album <专辑名或ID>` | 加载专辑(支持名称搜索 / 数字 ID / Jellyfin GUID) |
|
||||
| `!artist <歌手名>` | 按歌手循环播放(支持 `-j`/`-n`/`-q`/`-k`/`-b`/`-y`) |
|
||||
| `!fm` | 私人 FM(默认网易云,自动续播) |
|
||||
| `!fm -j` | Jellyfin 电台:从收藏出发的 Instant Mix(需启用 Jellyfin,自动续播) |
|
||||
| `!fm -q` | QQ 音乐雷达 / 猜你喜欢 FM(自动续播) |
|
||||
| `!fm -k` | 酷狗私人电台 / 个性化推荐 FM(自动续播) |
|
||||
| `!lyrics` | 显示当前完整歌词(自动分多条消息发送,不再只显示开头几行) |
|
||||
| `!now` | 当前播放信息 |
|
||||
| `!vote` | 投票跳过当前歌曲 |
|
||||
| `!move <频道名>` | 移动到指定频道 |
|
||||
@@ -267,8 +371,31 @@ sudo systemctl start tsmusicbot
|
||||
|
||||
> 命令前缀默认为 `!`,可在设置页面修改。支持别名:`!p` = `!play`,`!s` = `!skip`,`!n` = `!next`
|
||||
|
||||
### TeamSpeak 命令权限(管理类命令限制)
|
||||
|
||||
默认情况下,频道里任何人都能运行所有聊天命令。你可以把一组「管理类」命令限制为只有特定 TeamSpeak 服务器组的成员才能运行:
|
||||
|
||||
- 受限命令:`stop`、`clear`、`remove`、`move`、`vol`、`mode`
|
||||
- 其余命令(点歌、队列、跳过、歌词等)始终对所有人开放
|
||||
- **默认不限制**:管理服务器组列表为空时,所有命令对所有人开放(向后兼容)
|
||||
|
||||
**配置方式**
|
||||
|
||||
- 网页端:设置 → 命令权限,填写允许的服务器组 ID(逗号分隔),保存即时生效。
|
||||
- 或编辑 `config.json` 的 `adminGroups`(数字数组),例如 `"adminGroups": [6, 8]`。
|
||||
|
||||
填入任意服务器组 ID 后,限制立即开启:只有属于这些组之一的用户才能运行受限命令,其他人会收到「⛔ 需要管理员权限(该命令仅限管理员服务器组)」的提示。
|
||||
|
||||
> 提示(fail-closed):当受限命令来自一个机器人当前看不到其服务器组的发送者(例如不在机器人所在频道的私聊),机器人会尝试查询其分组;若仍无法确定,则拒绝执行。
|
||||
|
||||
**如何查看服务器组 ID**
|
||||
|
||||
在 TeamSpeak 客户端中打开「权限 → 服务器组」(Permissions → Server Groups)对话框,选中某个组后,其 ID 会显示在标题栏/状态栏;或在服务器组管理界面中查看每个组对应的数字 ID。把需要授权的组 ID 填入上面的设置即可。
|
||||
|
||||
### 音质等级
|
||||
|
||||
**在线音源(网易云等)**
|
||||
|
||||
| 等级 | 码率 | 格式 | 说明 |
|
||||
|------|------|------|------|
|
||||
| 标准 | 128kbps | MP3 | 免费可用 |
|
||||
@@ -278,6 +405,13 @@ sudo systemctl start tsmusicbot
|
||||
| Hi-Res | ~1500kbps | FLAC | 需要 VIP |
|
||||
| 超清母带 | ~4000kbps | FLAC | 需要黑胶 VIP |
|
||||
|
||||
**Jellyfin(启用后)**
|
||||
|
||||
| 等级 | 说明 |
|
||||
|------|------|
|
||||
| **原始直传(direct)** | **默认**:原始文件不转码直传(机器人本地统一转 Opus,此档即最高音质) |
|
||||
| 320kbps / 192kbps / 128kbps | 由 Jellyfin 服务器转码后传输,适合公网带宽有限的自建服务器 |
|
||||
|
||||
在设置页面选择音质,立即生效(影响后续播放的歌曲)。
|
||||
|
||||
## 项目架构
|
||||
@@ -293,15 +427,19 @@ teamspeak-music-bot/
|
||||
│ │ ├── commands.ts # 文字命令解析器(前缀、别名、权限)
|
||||
│ │ ├── instance.ts # Bot 实例(绑定 TS3 + 播放器 + 音源)
|
||||
│ │ ├── manager.ts # 多实例生命周期管理
|
||||
│ │ ├── auto-pause.ts # 频道无人自动暂停/恢复的决策逻辑
|
||||
│ │ └── profile.ts # 机器人形象管理(头像/昵称/描述/Away/频道描述)
|
||||
│ ├── data/ # 数据层
|
||||
│ │ ├── config.ts # JSON 配置文件
|
||||
│ │ └── database.ts # SQLite 数据库(播放历史、实例持久化)
|
||||
│ │ ├── config.ts # JSON 配置文件(持久化到 data/config.json)
|
||||
│ │ ├── permissions.ts # 细粒度能力 + 按机器人授权白名单
|
||||
│ │ └── database.ts # SQLite 数据库(播放历史、实例、收藏、权限持久化)
|
||||
│ ├── music/ # 音源服务
|
||||
│ │ ├── provider.ts # 统一 MusicProvider 接口
|
||||
│ │ ├── jellyfin.ts # Jellyfin 适配器(可选音源,直连 REST API)
|
||||
│ │ ├── netease.ts # 网易云音乐适配器
|
||||
│ │ ├── qq.ts # QQ 音乐适配器
|
||||
│ │ ├── bilibili.ts # 哔哩哔哩适配器(视频音频提取)
|
||||
│ │ ├── kugou.ts # 酷狗音乐适配器(直连 API,无 npm 依赖 / 无内嵌服务)
|
||||
│ │ ├── youtube.ts # YouTube 适配器(可选,依赖 yt-dlp)
|
||||
│ │ ├── auth.ts # Cookie 持久化存储
|
||||
│ │ └── api-server.ts # 嵌入式 API 服务(自动启动)
|
||||
@@ -313,10 +451,13 @@ teamspeak-music-bot/
|
||||
│ ├── web/ # Web 后端
|
||||
│ │ ├── server.ts # Express + WebSocket 服务
|
||||
│ │ ├── websocket.ts # 实时状态广播
|
||||
│ │ ├── middleware/ # requireAuth / requireAdmin / requirePermission / CSRF
|
||||
│ │ └── api/ # REST API 路由
|
||||
│ │ ├── bot.ts # 机器人管理 CRUD
|
||||
│ │ ├── music.ts # 搜索/歌单/歌词/音质
|
||||
│ │ ├── player.ts # 播放控制/队列/历史/跳转
|
||||
│ │ ├── player.ts # 播放控制/队列/历史/跳转/FM
|
||||
│ │ ├── favorites.ts # 本地收藏歌单 CRUD
|
||||
│ │ ├── users.ts # 用户管理 + 成员权限
|
||||
│ │ └── auth.ts # QR登录/Cookie/SMS
|
||||
│ └── index.ts # 入口(启动所有服务)
|
||||
├── web/src/ # 前端源码 (Vue 3)
|
||||
@@ -332,11 +473,11 @@ teamspeak-music-bot/
|
||||
│ └── docker/ # Docker 部署文件
|
||||
│ ├── Dockerfile
|
||||
│ └── docker-compose.yml
|
||||
├── data/ # 运行时数据(自动创建,不上传)
|
||||
│ ├── tsmusicbot.db # SQLite 数据库
|
||||
│ ├── cookies/ # 登录 Cookie
|
||||
│ └── logs/ # 日志文件
|
||||
└── config.json # 配置文件(首次运行自动生成,不上传)
|
||||
└── data/ # 运行时数据(自动创建,不上传)
|
||||
├── config.json # 配置文件(首次运行自动生成,可手动编辑)
|
||||
├── tsmusicbot.db # SQLite 数据库
|
||||
├── cookies/ # 登录 Cookie
|
||||
└── logs/ # 日志文件
|
||||
```
|
||||
|
||||
## 技术栈
|
||||
@@ -348,14 +489,73 @@ teamspeak-music-bot/
|
||||
| **数据库** | better-sqlite3 (SQLite) |
|
||||
| **音频处理** | FFmpeg (ffmpeg-static 内置), @discordjs/opus |
|
||||
| **TS 协议** | @honeybbq/teamspeak-client(完整客户端协议)+ 自研 TS6 协议适配层 |
|
||||
| **Jellyfin** | Jellyfin REST API(可选音源,直连,无额外 npm 依赖) |
|
||||
| **网易云 API** | NeteaseCloudMusicApi |
|
||||
| **QQ 音乐 API** | @sansenjian/qq-music-api |
|
||||
| **QQ 音乐 API** | @sansenjian/qq-music-api(锁定 `~2.4.0`,需 Node ≥ 20.17) |
|
||||
| **哔哩哔哩** | BiliBili Web API(搜索、DASH 音频流、QR 登录) |
|
||||
| **酷狗音乐** | 酷狗公开 API(直连,无 npm 依赖 / 无内嵌服务;请求签名 / KRC 歌词解码 / 设备注册移植自 MIT 的 MakcRe/KuGouMusicApi,改用 Node 内置 crypto + zlib) |
|
||||
| **前端框架** | Vue 3, Vite 5, Pinia, Vue Router 4 |
|
||||
| **界面样式** | SCSS(YesPlayMusic 设计风格) |
|
||||
| **图标** | @iconify/vue |
|
||||
| **日志** | pino |
|
||||
|
||||
## 可选:Jellyfin 音源
|
||||
|
||||
本项目可将自建 [Jellyfin](https://jellyfin.org/) 媒体服务器作为**额外音源**:机器人直接播放你自己音乐库里的文件,不依赖任何在线平台的可用性 / 版权 / 登录状态。该音源**默认关闭**,需要手动启用。
|
||||
|
||||
### 启用与连接配置
|
||||
|
||||
三种方式任选:
|
||||
|
||||
1. **首次安装向导** — 第 3 步即 Jellyfin 连接卡(可跳过,稍后配置);填写并「保存并继续」会**自动启用**该音源。
|
||||
2. **WebUI** — 设置 → Jellyfin 音乐库(可选):打开「**启用 Jellyfin 音源**」开关,填写服务器地址、选择认证方式、「测试连接」验证后保存,**保存即时生效,无需重启**。
|
||||
3. **config.json** — 手动编辑 `jellyfin` 配置块,并把 `"jellyfin"` 加入 `enabledProviders`,然后重启。
|
||||
|
||||
两种认证方式:
|
||||
|
||||
| 模式 | 填写内容 | 说明 |
|
||||
|------|---------|------|
|
||||
| **账号密码**(默认) | `username` + `password` | 以该用户身份登录(`AuthenticateByName`),token 自动持久化、失效自动重登 |
|
||||
| **API Key** | `apiKey` + `userId` | 使用管理后台生成的 API Key;`userId` 决定使用谁的音乐库 / 收藏 / 歌单 |
|
||||
|
||||
```jsonc
|
||||
// config.json 片段
|
||||
{
|
||||
"jellyfin": {
|
||||
"serverUrl": "https://jellyfin.example.com",
|
||||
"authMode": "userpass", // 或 "apikey"
|
||||
"username": "music",
|
||||
"password": "······",
|
||||
"apiKey": "", // apikey 模式填写
|
||||
"userId": "" // apikey 模式填写
|
||||
},
|
||||
"enabledProviders": ["netease", "qq", "bilibili", "youtube", "kugou", "jellyfin"]
|
||||
}
|
||||
```
|
||||
|
||||
> 密码 / API Key 在 WebUI 中**只写不回显**;表单留空表示保持已保存的值不变。
|
||||
|
||||
### 功能
|
||||
|
||||
- **搜索** — 歌曲 / 专辑 / 歌单,支持翻页「加载更多」;WebUI 统一搜索中 Jellyfin 结果排最前
|
||||
- **播放** — 懒解析播放地址;默认**原始直传**(不经 Jellyfin 转码),也可选 320/192/128kbps 服务器转码档(设置 → 音质设置)
|
||||
- **歌词** — 读取 Jellyfin 的歌词接口(内嵌或 .lrc),时间轴同步滚动,`!lyrics` 可用
|
||||
- **电台 / FM**(`!fm -j` 或首页「Jellyfin 电台」卡片)— 随机取一首**收藏**做种子生成 Instant Mix 歌曲流;没有收藏则回退到最近播放、再回退随机曲目
|
||||
- **首页区块** — 最近添加(专辑)/ 播放最多 / Jellyfin 收藏 / 我的歌单 / 流派(点流派芯片即播放该流派)
|
||||
- **播放上报** — 播放开始 / 进度(约 10s 一次)/ 停止会回报给 Jellyfin(`Sessions/Playing` 系列接口),你的 Jellyfin 播放统计(PlayCount、最近播放)保持准确;上报失败不影响播放
|
||||
- **聊天命令** — 启用后用 `-j` 标志:`!play -j <歌名>`、`!fm -j`、`!artist -j <歌手>`;`!playlist` / `!album` / `!play id:` 可直接粘贴 Jellyfin GUID。若把在线音源全部停用、只保留 Jellyfin,不带标志的命令会自动以 Jellyfin 为默认音源
|
||||
|
||||
### enabledProviders:音源开关
|
||||
|
||||
`config.json` 的 `enabledProviders` 数组决定哪些音源可用(默认 `["netease", "qq", "bilibili", "youtube", "kugou"]`,即在线音源全开、Jellyfin 关闭):
|
||||
|
||||
- 可选值:`jellyfin`、`netease`、`qq`、`bilibili`、`youtube`、`kugou`(`local` 由 `localAudioEnabled` 控制,`spotify` 由 `spotify.enabled` 控制)
|
||||
- 未列出的音源:聊天命令返回「音源未启用」、REST 返回 400、WebUI 搜索栏 / 登录卡 / FM 卡片自动隐藏
|
||||
- 不带平台标志的命令走**固定优先级中第一个已启用的音源**:网易云 → QQ → 酷狗 → Jellyfin → B站 → YouTube(默认配置下即网易云)
|
||||
- 网易云 / QQ 停用时,其内嵌 API 服务(端口 3001 / 3200)**不会启动**
|
||||
- 示例(Jellyfin 为主、只留网易云备用):`"enabledProviders": ["jellyfin", "netease"]`(此时默认音源仍为网易云,点歌用 `-j` 或停用网易云);示例(纯 Jellyfin):`"enabledProviders": ["jellyfin"]`
|
||||
- 注意:重新启用网易云 / QQ 的内嵌 API 服务需要重启机器人;其余音源改动即时生效(WebUI 的 Jellyfin 开关即改此列表)
|
||||
|
||||
## 可选:YouTube 音源
|
||||
|
||||
YouTube 是**可选**的音源,默认**未启用**,需要安装 [yt-dlp](https://github.com/yt-dlp/yt-dlp) 才能使用。启用后可通过聊天命令 `!play -y <关键词>` 或 WebUI 的 YouTube 平台选项搜索/播放 YouTube 视频的音频流。
|
||||
@@ -405,9 +605,134 @@ pip install -U yt-dlp
|
||||
- 受 YouTube 风控/地域限制,部分视频可能无法播放
|
||||
- `yt-dlp` 更新较频繁,如果播放失败,先尝试升级 `yt-dlp` 到最新版本
|
||||
|
||||
## Spotify 音源(实验性)
|
||||
|
||||
> **⚠️ 实验性功能,启用前请务必读完本节**
|
||||
>
|
||||
> - **需要 Spotify Premium 账号。** 免费账号无法通过 Spotify Connect 输出音频,无法使用本功能。
|
||||
> - **使用你自己在 Spotify Developer Dashboard 注册的应用(Client ID)。** 本项目**不内置任何共享凭据**,也不会替你代管账号。
|
||||
> - Spotify 官方并未开放第三方播放的公开授权,本功能处于 **Spotify 服务条款的灰色地带**,是否使用请自行评估,**风险自负**。
|
||||
> - 该音源**默认关闭**(`spotify.enabled = false`),需要手动开启并完成授权。
|
||||
> - 这**不是** YouTube 那样的「免登录回退音源」,而是**真正的 Spotify 音频**,必须有 Premium 才能出声;音频链路依赖第三方开源解码器(librespot / go-librespot),本项目仅在本地作为独立子进程调用,**播放效果不做保证**,也未在本仓库端到端测试。
|
||||
|
||||
### 工作原理(简述)
|
||||
|
||||
1. `librespot`(Rust)或 `go-librespot`(Linux)作为**独立子进程**登录 Spotify Connect 并解码音频,输出原始 **PCM**。
|
||||
2. 本项目用内置 **ffmpeg** 把 PCM 重采样到 **48kHz**。
|
||||
3. 重采样后的音频接入**现有的 Opus 编码 / 发送管线**(与其它音源共用),推送到 TeamSpeak。
|
||||
4. 歌名、歌手、封面等**元数据来自 Spotify Web API**。
|
||||
|
||||
### 平台矩阵
|
||||
|
||||
后端由配置项 `spotify.backend` 决定,可选 `auto`(默认)/ `go-librespot` / `librespot`:
|
||||
|
||||
| 平台 | 默认后端(`auto`) | 说明 |
|
||||
|------|------|------|
|
||||
| Windows | `librespot`(Rust) | 不支持 go-librespot(FIFO 仅限 POSIX,且官方无 Windows 资产) |
|
||||
| Linux / Docker | `go-librespot`(可回退 `librespot`) | `auto` 优先 go-librespot,未检测到时自动改用 librespot |
|
||||
| macOS | `librespot`(Rust) | 与 Windows 同,仅支持 Rust 版 |
|
||||
|
||||
> `auto` 会按平台与二进制可用性自动选择:优先 `go-librespot`(若可用),否则 `librespot`。若显式指定 `go-librespot` 或 `librespot` 但对应二进制不存在,则该音源保持不可用。
|
||||
|
||||
### 获取二进制
|
||||
|
||||
程序会先在项目根目录的 `bin/` 中查找,找不到再回退到系统 `PATH`。`bin/` 已被 `.gitignore` 忽略,不影响代码更新。
|
||||
|
||||
**Rust librespot(librespot-org,全平台)** — 官方**没有预编译发布包**,需自行获取(任选其一):
|
||||
|
||||
```bash
|
||||
# 方式 1:用 Cargo 编译安装(需要 Rust 工具链)
|
||||
cargo install librespot
|
||||
|
||||
# 方式 2(Windows):scoop / choco
|
||||
scoop install librespot # 或:choco install librespot
|
||||
|
||||
# 方式 3:把可执行文件放到项目 bin/ 目录
|
||||
# Windows: bin/librespot.exe
|
||||
# Linux/macOS: bin/librespot
|
||||
```
|
||||
|
||||
或直接把 `librespot` 加入系统 `PATH`。
|
||||
|
||||
**go-librespot(仅 Linux)** — 官方仅提供 **Linux** 预编译资产:
|
||||
|
||||
```bash
|
||||
# 从 Release 页下载对应架构的二进制:
|
||||
# https://github.com/devgianlu/go-librespot/releases
|
||||
# 放到项目 bin/ 目录(或加入系统 PATH):
|
||||
# bin/go-librespot
|
||||
```
|
||||
|
||||
> **Windows 不支持 go-librespot**:它依赖 POSIX FIFO(`mkfifo`),官方也只发布 Linux 资产。Windows / macOS 请使用 Rust `librespot`。
|
||||
|
||||
### 注册 Spotify 开发者应用 + 回调地址
|
||||
|
||||
1. 打开 [Spotify Developer Dashboard](https://developer.spotify.com/dashboard),新建一个应用,记下 **Client ID**。
|
||||
2. 在应用设置里添加 **Redirect URI(回调地址)**,精确填写:
|
||||
|
||||
```
|
||||
http://127.0.0.1:<webPort>/api/spotify/callback
|
||||
```
|
||||
|
||||
其中 `<webPort>` 与本项目设置里的 Web 端口一致(默认 `3000`,即 `http://127.0.0.1:3000/api/spotify/callback`)。回调路径必须精确为 `/api/spotify/callback`。
|
||||
3. 本项目使用 **Authorization Code + PKCE** 流程,**不需要 Client Secret**(配置里的 `clientSecret` 可留空)。
|
||||
4. 授权时请求的权限范围(scope):
|
||||
|
||||
```
|
||||
streaming user-read-playback-state user-modify-playback-state user-read-currently-playing playlist-read-private
|
||||
```
|
||||
|
||||
### 启用步骤
|
||||
|
||||
1. 进入**设置页**的「连接 Spotify」卡片。
|
||||
2. 填入 **Client ID**、选择**后端**(`auto` / `go-librespot` / `librespot`)、打开**开关**。
|
||||
3. 点击**保存**。
|
||||
4. 点击「**连接 Spotify**」,在弹出的 Spotify 页面完成 **OAuth 授权**。
|
||||
|
||||
> 仅当 **`enabled = true`** + **已完成 OAuth 授权** + **检测到可用的后端二进制** 三者同时满足时,Spotify 音源才可播放。任一条件不满足,该音源保持**不可用**(点播会被跳过,播放队列照常前进,不影响其它音源)。
|
||||
|
||||
对应的配置块(`data/config.json`):
|
||||
|
||||
```json
|
||||
{
|
||||
"spotify": {
|
||||
"enabled": false,
|
||||
"backend": "auto",
|
||||
"clientId": "",
|
||||
"clientSecret": "",
|
||||
"deviceName": "TSMusicBot",
|
||||
"bitrate": 320
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
OAuth 相关端点:`/api/spotify/login`、`/api/spotify/callback`、`/api/spotify/status`。
|
||||
|
||||
### 许可与来源
|
||||
|
||||
- **go-librespot** 采用 **GPL-3.0** 许可。本项目**仅将其作为独立子进程调用**(mere aggregation / 独立聚合),**不链接、不打包**其代码,因此**不影响本项目自身的 MIT 许可**。
|
||||
- 源码与许可:<https://github.com/devgianlu/go-librespot>(GPL-3.0;如需其对应源码请前往该仓库获取 —— source offer)。
|
||||
- **Rust librespot** 采用 **MIT** 许可:<https://github.com/librespot-org/librespot>。
|
||||
|
||||
### 故障排查
|
||||
|
||||
| 现象 | 处理 |
|
||||
|------|------|
|
||||
| 提示「未检测到 librespot / go-librespot」 | 检查项目 `bin/` 目录里是否放了可执行文件,或该命令是否在系统 `PATH` 中;Rust 版可用 `cargo install librespot` 安装 |
|
||||
| 提示「未授权 / 需要连接 Spotify」 | 在设置页「连接 Spotify」卡片点击「连接 Spotify」完成 OAuth 授权 |
|
||||
| Windows 上无法使用 go-librespot | 属预期行为(FIFO 仅限 POSIX,官方无 Windows 资产);请把 `backend` 设为 `librespot` 或 `auto` |
|
||||
| 完全没有声音 | 确认账号为 **Spotify Premium**;免费账号无法通过 Spotify Connect 输出音频 |
|
||||
|
||||
### 已知限制
|
||||
|
||||
- 在多租户/共享主机上,librespot 通过命令行参数接收访问令牌,同机其他本地进程理论上可读取(令牌约 1 小时有效,需本地访问权限)。
|
||||
- Spotify 连续播放(gapless spotify→spotify)时,网页进度条的"已播放时间"可能不准确(以后端上报的播放进度为准)。
|
||||
- 运行多个启用 Spotify 的 bot 时,若两个 bot 的 id 端口哈希发生冲突(同一 % 1000 桶),第二个 go-librespot 边车会因端口占用而启动失败、该 bot 的 Spotify 不可用(后续将改为按需分配空闲端口)。
|
||||
- **一个 Spotify Premium 账号只支持「一路」正在播放的音频流**。因此若要同时运行**多个**启用 Spotify 的 bot 并让它们各自独立播放,必须为**每个 bot 配置独立的 Spotify 账号**。在 Rust(librespot)后端上,本机制已把播放控制(暂停/继续/跳转)限定到 bot 自己的设备,并在读取播放状态时忽略其它设备的状态,以避免多 bot 之间互相抢占、来回抖动(cross-control/thrash);但受 Spotify 平台限制,**共用同一账号无法实现多路同时播放**(第二个 bot 开始播放会夺走该账号唯一的活跃会话)。go-librespot 后端为每个边车独立的本地 REST API,不受此账号级抢占影响。
|
||||
|
||||
## 配置文件
|
||||
|
||||
`config.json` 在首次运行时自动生成,可手动编辑:
|
||||
配置文件位于 **`data/config.json`**(与数据库、Cookie、日志同在持久化的 `data/` 目录,Docker 部署对应挂载卷),首次运行时自动生成,可手动编辑:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -421,10 +746,27 @@ pip install -U yt-dlp
|
||||
"adminPassword": "",
|
||||
"adminGroups": [],
|
||||
"autoReturnDelay": 300,
|
||||
"autoPauseOnEmpty": true
|
||||
"autoPauseOnEmpty": false,
|
||||
"idleTimeoutMinutes": 0,
|
||||
"publicUrl": "",
|
||||
"trustProxy": false
|
||||
}
|
||||
```
|
||||
|
||||
> **配置文件位置变更**:旧版本把 `config.json` 写在项目根目录(不在 Docker 挂载卷内,导致重启丢失、手动编辑不生效)。现在统一放在 `data/config.json`。升级时若检测到根目录存在旧的 `config.json`,会在首次启动时自动迁移到 `data/` 并保留你的设置,无需手动操作。
|
||||
|
||||
> **关于 `adminPassword` 和 `adminGroups`**:`adminGroups` 现已启用,用于限制管理类聊天命令只能由指定 TeamSpeak 服务器组运行(为空 = 不限制),详见 [TeamSpeak 命令权限](#teamspeak-命令权限管理类命令限制)。`adminPassword` 仍为旧版预留字段、当前版本未使用——WebUI 鉴权改为基于数据库的用户账号系统(见 [首次配置](#首次配置)),无需在 `config.json` 中设置密码。
|
||||
|
||||
### 反向代理部署注意事项
|
||||
|
||||
当 WebUI 部署在反向代理(nginx / Caddy / Cloudflare 等)之后时,请务必在 `config.json` 中设置 `"trustProxy": true`:
|
||||
|
||||
- **Cookie Secure 标志**:未启用 `trustProxy` 时,Express 无法从 `X-Forwarded-Proto` 正确判断请求实际是否为 HTTPS,会话 cookie 不会被标记为 `Secure`。
|
||||
- **登录限流**:登录限流以 `req.ip` 为键,未启用 `trustProxy` 时所有请求都会被识别为代理本身的 IP,单个攻击者会拖累所有合法用户共用同一个限流桶。
|
||||
- **审计日志的客户端 IP**(如果未来添加该字段)也需要 `trustProxy` 才能正确记录。
|
||||
|
||||
直接暴露端口(无代理)时无需启用该选项。
|
||||
|
||||
## 常见问题
|
||||
|
||||
**Q:支持 TeamSpeak 6 Server 吗?**
|
||||
@@ -436,6 +778,9 @@ A:确保机器人和你在同一个频道。检查音量(`!vol 75`)。部
|
||||
**Q:提示"无法获取播放链接"?**
|
||||
A:在设置页面扫码登录音乐账号。许多歌曲需要登录后才能播放。
|
||||
|
||||
**Q:同名歌曲 `!play` 只能播到最热门的那首,怎么播放指定的版本?**
|
||||
A:`!play <歌名>` 默认取最热门的匹配项。要播放同名的另一首,有三种方式:(1) 先 `!search <歌名>` 列出带序号的结果,再 `!play #序号` 选择;(2) `!play id:<歌曲id>` 按 id 精确播放;(3) 直接粘贴歌曲链接,如 `!play https://music.163.com/song?id=442867526`(也支持 QQ / B站 链接)。在 WebUI 中则可直接在搜索结果列表里点选任意同名歌曲。
|
||||
|
||||
**Q:如何更换机器人所在频道?**
|
||||
A:使用 `!move <频道名>` 命令,或在设置页面创建机器人时指定默认频道。
|
||||
|
||||
@@ -445,6 +790,12 @@ A:可以。在设置页面创建多个实例,分别连接不同的 TS 服务
|
||||
**Q:端口 3200 被占用?**
|
||||
A:QQ 音乐 API 启动时自动监听 3200 端口。如果之前的进程还在运行,程序会自动复用。如需重启可手动结束 `node` 进程。
|
||||
|
||||
**Q:QQ 音乐二维码不弹 / 扫码登录失败 / cookie 无法使用?**
|
||||
A:通常是内置的 QQ 音乐 API 服务没起来——它一旦没监听 3200 端口,机器人去取二维码就会拿到 `ECONNREFUSED 127.0.0.1:3200`,于是二维码不显示,登录和 cookie 也全失效。先看日志里 QQ API 的启动报错:
|
||||
- 报 `ERR_REQUIRE_ESM`:装到了不兼容的 `@sansenjian/qq-music-api` 版本。本项目把它锁在 **`~2.4.0`**(需要 **Node ≥ 20.17 / 22.9**);务必用 `npm ci` 或 `npm install` 让版本与锁文件一致,**不要**手动 `npm update` 把它升级或降级到不兼容的中间版本(2.3.0/2.3.1 是纯 ESM、会触发此错)。
|
||||
- 报 Node 版本不满足:升级 Node 到 ≥ 20.17,或将该依赖降到 `~2.2.10`(无此 Node 要求)后重装。
|
||||
修好版本后重新 `npm install && npm run build` 并重启即可。
|
||||
|
||||
**Q:播放歌曲时报 FFmpeg EACCES 错误?**
|
||||
A:`ffmpeg-static` 内置的 FFmpeg 二进制文件缺少执行权限。程序已自动尝试修复,如果仍然失败,请手动执行:
|
||||
```bash
|
||||
@@ -464,6 +815,30 @@ A:YouTube 是可选音源,需要手动安装 `yt-dlp`。详见 [可选:You
|
||||
**Q:如何更新到新版本?**
|
||||
A:`git pull` 拉取最新代码,然后 `npm install && npm run build && npm start` 重新构建启动。Docker 用户执行 `docker-compose up -d --build`。
|
||||
|
||||
**Q:忘记管理员密码怎么办?**
|
||||
A:直接操作 SQLite 数据库。最简单的办法是清空 `users` 表然后重新进入 first-run 流程:`sqlite3 data/tsmusicbot.db "DELETE FROM users; DELETE FROM sessions;"`,重启后浏览器会自动跳转 `/first-run` 让你重新创建管理员。详细方法见 [从 WebUI 无鉴权版本升级](#从-webui-无鉴权版本升级重要)。
|
||||
|
||||
**Q:成员(member)能做什么?不能做什么?**
|
||||
A:成员默认可以:管理机器人(启动/停止/创建/编辑)、控制播放(搜索/播放/队列)、登录音乐平台账号、修改自己的密码。成员**始终不能**:管理其他用户、查看操作审计日志、降级或删除管理员。此外管理员可在 **设置 → 用户管理** 为每个成员单独**收紧权限**:勾选允许的能力(播放控制 / 队列 / 机器人管理 / 平台登录 / 音质)以及可操作的机器人白名单——未授权的能力会返回 403,未授权的机器人对该成员不可见也不可控。管理员不受任何限制。
|
||||
|
||||
**Q:收藏的歌单存在哪里?其他用户能看到吗?**
|
||||
A:收藏按用户存储在本地 SQLite 数据库(`favorite_playlists` 表),仅本人可见,登录后跨设备同步。在首页、搜索结果或歌单页点击收藏图标即可增删。
|
||||
|
||||
**Q:什么是"专属链接"?怎么用?**
|
||||
A:通过 `/bot/<机器人ID>` 打开 WebUI 会把界面锁定到该机器人(顶部显示"专属模式",刷新后保持),适合把单台机器人的控制页分享给特定用户。点击"退出"可返回多机器人视图。注意:专属链接只是 UI 层的锁定,真正的访问控制由成员权限(机器人白名单)在后端强制。
|
||||
|
||||
**Q:机器人播放时突然自动暂停了?**
|
||||
A:这是"频道无人时自动暂停"功能:当机器人所在频道没有其他人时会自动暂停,有人加入后自动恢复,避免空播。该功能**默认关闭**,仅在你于 **设置 → 行为设置** 开启后生效;如需停用,在同一页面关闭即可。(占用检测依赖 TeamSpeak 的 `clientlist` 命令,部分服务器在频道有其他人时可能查询失败——此时机器人会按"占用情况未知"处理,不会误暂停。)
|
||||
|
||||
**Q:如何把某个用户从成员升级为管理员?**
|
||||
A:管理员登录后进入 **设置 → 用户管理**,点击对应用户的"提升管理员"按钮即可。降级同理("降为成员"按钮)。系统会阻止降级最后一位管理员。
|
||||
|
||||
**Q:登录之后多久会自动退出?**
|
||||
A:登录态有效期 7 天,活跃使用会滚动续期(每次受保护请求都会刷新过期时间)。同一账号最多保持 10 个并发会话(多设备登录时超过的会自动剔除最旧的会话)。
|
||||
|
||||
**Q:部署到公网后如何防止暴力登录?**
|
||||
A:本项目内置 `/login` 限流(每 IP 每分钟 5 次),但生产部署建议同时在反向代理(nginx `limit_req` / Caddy 等)层加一层限流,并启用 HTTPS。反向代理部署务必设置 `"trustProxy": true`(详见 [反向代理部署注意事项](#反向代理部署注意事项))。
|
||||
|
||||
## 参与贡献
|
||||
|
||||
1. Fork 本仓库
|
||||
@@ -476,7 +851,50 @@ A:`git pull` 拉取最新代码,然后 `npm install && npm run build && npm
|
||||
|
||||
> 完整历史请查看 [git log](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/commits/main) 或 [Releases](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/releases)。这里只列出重要变更和面向用户的破坏性改动。
|
||||
|
||||
### 最新版本
|
||||
### 最新版本 — Jellyfin 可选音源
|
||||
|
||||
**Jellyfin 集成([PR #123](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/pull/123),由 [@ItsEricRao](https://github.com/ItsEricRao) 贡献;随后调整为可选音源)**
|
||||
|
||||
- **Jellyfin 音源(可选,默认关闭)**:连接自建 [Jellyfin](https://jellyfin.org/) 服务器作为额外音源——搜索(歌曲 / 专辑 / 歌单,支持翻页)、懒解析直传播放、同步歌词、收藏 Instant Mix 电台(`!fm -j`)、首页「最近添加 / 播放最多 / 收藏 / 流派」区块、播放进度回报(PlayCount / 播放状态)。账号密码或 API Key 两种认证,在 设置 → Jellyfin 音乐库 打开「启用 Jellyfin 音源」即可,保存即时生效。详见 [可选:Jellyfin 音源](#可选jellyfin-音源)。
|
||||
- **enabledProviders 音源开关**:`config.json` 新增 `enabledProviders` 字段,默认 `["netease", "qq", "bilibili", "youtube", "kugou"]`——在线音源保持默认启用,**从旧版本升级无行为变化**;列表外的音源在聊天命令 / REST / WebUI 中一律不可用,网易云 / QQ 停用时其内嵌 API 服务(端口 3001 / 3200)不再启动。
|
||||
- **新增 `-j`(Jellyfin)与 `-n`(网易云)平台标志**;不带标志的 `!play` / `!search` / `!fm` 等走固定优先级中第一个已启用的音源(默认配置下即网易云,行为与旧版一致)。
|
||||
- ⚠️ **v1.10.0 初版曾短暂把默认音源设为 Jellyfin-only,现已回退**。若你在该版本保存过设置导致 `config.json` 中为 `"enabledProviders": ["jellyfin"]`,请手动把在线音源加回(详见 [更新升级](#关于-enabledproviders-音源开关v1100-起))。
|
||||
- **QQ 按 ID 播放空歌名修复**([PR #124](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/pull/124),感谢 [@Slldyd2077](https://github.com/Slldyd2077)):按 ID 播放 QQ 歌曲时回填歌曲元数据,TS 端不再显示空歌名。
|
||||
|
||||
### v1.9.0 及更早
|
||||
|
||||
**功能增强:Spotify 音源(实验性)/ 搜索结果翻页 / 细粒度权限 / 本地收藏 / 本地音频上传 / 专属链接 / 自动暂停 / QQ 雷达 FM**
|
||||
|
||||
- **细粒度账号权限**(叠加在 admin / member 之上):管理员可为每个成员勾选 5 项能力(`player.control` / `player.queue` / `bot.manage` / `platform.auth` / `quality`)和按机器人授权白名单;所有变更路由由后端 `requirePermission` / `requireBotAccess` 中间件逐请求强制校验,未授权返回 403,未授权的机器人对成员不可见(列表过滤,无 403-vs-404 枚举泄漏)。已有成员经一次性迁移获得全部能力,新成员默认基础能力。
|
||||
- **本地收藏歌单**:按用户存储的收藏(`favorite_playlists` 表 + `/api/favorites`),首页 / 搜索 / 歌单页一键收藏,跨设备同步。
|
||||
- **本地音频上传播放**:搜索页支持拖拽 / 选择本地音频上传(保存到 `data/local-audio`),上传后可像普通歌曲一样播放、下一首播放或加入队列;设置 → 行为设置 中新增「本地音频播放」开关,关闭后拒绝新的本地上传和本地歌曲播放请求。播放结束或停止 / 清空 / 替换队列时会从服务端删除已接收文件并更新索引。
|
||||
- **专属链接(单机器人锁定)**:`/bot/<id>` 打开时锁定到单台机器人,`?bot=<id>` 随刷新保持;与权限白名单组合,机器人下拉只显示"作用域 ∩ 可控"的机器人。
|
||||
- **频道无人时自动暂停**:机器人所在频道清空时暂停、有人加入时恢复(区分用户手动暂停,不会误恢复);可在 设置 → 行为设置 开关(默认关闭)。占用检测在 `clientlist` 查询失败时按"未知"处理而非"无人",避免有人在听时被误暂停。
|
||||
- **QQ 音乐雷达 / 私人 FM**:`!fm -q` 或 WebUI 启动 QQ 雷达推荐流(失败回退"猜你喜欢"),FM 自动续播现支持任意平台。
|
||||
- **#112 Spotify 音源(实验性)**:新增 Spotify 作为可选音源,默认关闭、需 Premium + 自建开发者应用(PKCE,无需 Client Secret)。采用混合 librespot 后端(Linux/Docker 用 go-librespot,Windows 用 Rust librespot),元数据走 Spotify Web API,可与现有音源混排入队。为 ToS 灰色地带的实验特性,详见 [Spotify 音源(实验性)](#spotify-音源实验性)。
|
||||
- **#115 搜索结果翻页**:WebUI 搜索现按来源、按分类(歌曲 / 歌单 / 专辑)提供「加载更多」,服务端新增 `offset` 分页,不再固定只返回首页 20 首 / 10 个歌单 / 10 张专辑。
|
||||
|
||||
**Bug 修复**
|
||||
|
||||
- **#116 `!lyrics` 只显示开头几行**:聊天命令曾把歌词截断为前 10 行,且长消息未分片会触及 TeamSpeak 单条约 1 KB 上限。现发送完整歌词,并按 UTF-8 字节安全地分割成多条消息(长回复通用分片,不再截断)。
|
||||
- **#86 config.json 未在首次运行生成**:配置文件改放到持久化的 `data/config.json`(旧版写在项目根目录,不在 Docker 卷内,导致重启丢失、手动编辑不生效);升级时自动把根目录旧配置迁移到 `data/` 并保留你的设置。
|
||||
- **#89 B站长音频约 16 分钟被暂停且无法继续**:ffmpeg 增加 `-reconnect_at_eof`(B站 CDN 会在 token/会话到期时提前关闭连接造成 EOF),并新增"远离结尾的卡死看门狗"——彻底卡死的流会自动推进到下一首而不是永久静音。
|
||||
- **#84 音量曲线不顺滑**:0–100 改为连续单调曲线 `0.2x + 0.8x^8`(消除 80–99 的"死区"与 100 处的突跳,满响度仍保留在 100)。
|
||||
|
||||
**WebUI 鉴权与权限系统**
|
||||
|
||||
- **首次运行强制创建管理员账号**:浏览器打开 WebUI 自动跳转 `/first-run`;之后所有 `/api/*`(除少量公共白名单:`/api/health`、`/api/config/public-url`、`/api/session/*`)和 `/ws` 都需要登录。详见 [更新升级 → 从 WebUI 无鉴权版本升级](#从-webui-无鉴权版本升级重要)。
|
||||
- **两种角色:admin / member**。`member` 可以管理机器人、控制播放、登录音乐平台账号、修改自己密码,但不能管理其他用户或查看审计日志。`admin` 拥有全部权限。
|
||||
- **用户管理 UI**:管理员在 设置 → 用户管理 可以增删用户、切换角色、重置密码。系统强制保留至少一位管理员。
|
||||
- **操作审计日志**:管理员在 设置 → 操作审计 可以查看用户管理相关事件(创建、删除、密码重置、角色变更、首位管理员创建、自助修改密码)。
|
||||
- **自助修改密码**:所有用户都可在 设置 → 账户 修改自己密码。
|
||||
- **会话存储**:服务端 SQLite 表 `sessions`,存储 sha256(token);浏览器只持有原始 token cookie。7 天 TTL,每小时滚动续期。同账号最多 10 个并发会话(超出剔除最旧)。
|
||||
- **登录限流**:每 IP 每分钟 5 次 `/login` + 3 次 `/setup`,命中返回 429 + `Retry-After`。
|
||||
- **CSRF & 安全头**:所有 mutating 请求强制 `Origin`/`Referer` 同源;响应携带 `X-Frame-Options: DENY` 和 `Content-Security-Policy: frame-ancestors 'none'`(防点击劫持)。
|
||||
- **搜索引擎隐身(防止实例被收录,issue #128)**:为避免部署实例的 WebUI 被搜索引擎收录、被陌生人搜到控制页,采用纵深防御——所有响应携带 `X-Robots-Tag: noindex, nofollow`,`/robots.txt` 返回 `User-agent: * / Disallow: /`,`index.html` 内置 `<meta name="robots" content="noindex, nofollow">`(专属链接 `/bot/<id>` 等所有页面同样覆盖)。这些只阻止「被索引」,不是访问控制——**请不要把自己的 WebUI 链接发到公开网页 / 论坛 / 聊天群**,真正的防护来自登录鉴权与反向代理。
|
||||
- **配置变更**:反向代理部署务必 `"trustProxy": true`(详见 [反向代理部署注意事项](#反向代理部署注意事项))。`config.adminGroups` 现已启用,用于限制管理类聊天命令只能由指定 TeamSpeak 服务器组运行(为空 = 不限制,详见 [TeamSpeak 命令权限](#teamspeak-命令权限管理类命令限制));`config.adminPassword` 仍为旧版预留字段,保留以兼容旧 `config.json`,当前未使用。
|
||||
|
||||
### v0.x — Bot Profile 自动更新与协议层升级
|
||||
|
||||
**机器人形象自动更新(Bot Profile)**
|
||||
|
||||
@@ -546,6 +964,7 @@ A:`git pull` 拉取最新代码,然后 `npm install && npm run build && npm
|
||||
- **初始 TS3/TS6 双协议支持**:自动协议检测(TS3 port 10011 vs TS6 port 10080)、TS6 HTTP Query 客户端、数据库持久化 `serverProtocol` / `ts6ApiKey`。
|
||||
- **多机器人架构**:支持同一进程中运行多个机器人实例,独立队列、进度、音量;WebUI 一键切换。
|
||||
- **网易云 / QQ 音乐 / 哔哩哔哩**:三平台原生音源,QR 码登录,Cookie 持久化。
|
||||
- **酷狗音乐音源**:第四个原生音源(直连 API,无 npm 依赖 / 无内嵌服务),覆盖搜索 / 播放 / KRC 歌词 / 专辑 / QR 登录,登录后支持每日推荐 / 推荐歌单 / 我的歌单 / 私人电台与歌曲封面。
|
||||
- **Docker & systemd 部署**:一键部署脚本,数据卷持久化,自动重启支持。
|
||||
|
||||
## 致谢
|
||||
@@ -554,6 +973,8 @@ A:`git pull` 拉取最新代码,然后 `npm install && npm run build && npm
|
||||
|
||||
| 项目 | 说明 |
|
||||
|------|------|
|
||||
| [Jellyfin](https://github.com/jellyfin/jellyfin) | 自由软件媒体服务器(本项目的可选自建音源) |
|
||||
| [ItsEricRao](https://github.com/ItsEricRao) | Jellyfin 音源集成贡献者([PR #123](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/pull/123)) |
|
||||
| [yichen11818/NeteaseTSBot](https://github.com/yichen11818/NeteaseTSBot) | TS6 协议兼容参考(vendored tsproto 补丁) |
|
||||
| [Splamy/TS3AudioBot](https://github.com/Splamy/TS3AudioBot) | 优秀的 TeamSpeak 音频机器人框架 |
|
||||
| [TS3AudioBot-BiliBiliPlugin](https://github.com/xxmod/TS3AudioBot-BiliBiliPlugin) | 提供插件开发参考 |
|
||||
@@ -566,6 +987,7 @@ A:`git pull` 拉取最新代码,然后 `npm install && npm run build && npm
|
||||
| [@sansenjian/qq-music-api](https://github.com/sansenjian/qq-music-api) | QQ 音乐 API 活跃维护版本 |
|
||||
| [@honeybbq/teamspeak-client](https://www.npmjs.com/package/@honeybbq/teamspeak-client) | TS3 完整客户端协议实现 |
|
||||
| [bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) | 哔哩哔哩 API 文档 |
|
||||
| [MakcRe/KuGouMusicApi](https://github.com/MakcRe/KuGouMusicApi) | 酷狗音乐 API 参考(请求签名 / KRC 歌词解码 / 设备注册移植来源,MIT 许可) |
|
||||
|
||||
## 开源许可
|
||||
|
||||
|
||||
@@ -0,0 +1,520 @@
|
||||
# Album Search & Playback Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Surface albums in search results and allow playing the whole album from the web UI. Currently `SearchResult.albums` is always `[]` and Search.vue only renders songs.
|
||||
|
||||
**Architecture:** Extend `search()` in netease + qq providers to populate `albums`. Aggregate them in `/search/all`. Add a new "专辑" (and "歌单") section to Search.vue. Reuse `Playlist.vue` as the album detail page by branching on `route.meta.kind` between `/playlist/:id` and `/album/:id` endpoints. The existing `getAlbumSongs(id)` and `/api/music/album/:id` endpoint already work.
|
||||
|
||||
**Tech Stack:** Node 20 + TS, Express 5, Vue 3 + Vue Router 4, axios. No new deps.
|
||||
|
||||
---
|
||||
|
||||
## Spec Reference
|
||||
|
||||
`docs/superpowers/specs/2026-05-07-custom-avatar-and-album-search-design.md` — section "专辑搜索".
|
||||
|
||||
## File Structure
|
||||
|
||||
| File | Action | Responsibility |
|
||||
|---|---|---|
|
||||
| `src/music/provider.ts` | Read-only | Verify `Album` and `SearchResult.albums` shape (no change expected) |
|
||||
| `src/music/netease.ts` | Modify | `search()` adds a third parallel call (`type=10`) and maps albums |
|
||||
| `src/music/qq.ts` | Modify | `search()` adds `req_album` section and maps albums |
|
||||
| `src/music/netease.test.ts` | Modify | New tests for albums in search response |
|
||||
| `src/music/qq.test.ts` | Modify (or create if absent) | Tests for albums in qq search |
|
||||
| `src/web/api/music.ts` | Modify | `/search/all` returns `{songs, albums, playlists}` |
|
||||
| `web/src/views/Search.vue` | Modify | Render albums + playlists sections |
|
||||
| `web/src/views/Playlist.vue` | Modify | Branch endpoint by `route.meta.kind === 'album'` |
|
||||
| `web/src/router/index.ts` | Modify | Add `/album/:id` route reusing Playlist component, set `meta.kind = 'album'` |
|
||||
|
||||
## Conventions
|
||||
|
||||
- TDD throughout. Each task: failing test → implement → verify → commit.
|
||||
- Mock HTTP via existing fixtures pattern (look at `src/music/netease.test.ts` for setup).
|
||||
- Keep all platform-specific quirks inside the provider class — no leaking into Search.vue logic.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: netease.ts — fetch albums in search
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/music/netease.ts`
|
||||
- Modify: `src/music/netease.test.ts`
|
||||
|
||||
- [ ] **Step 1: Read the existing test setup so we mock the same way**
|
||||
|
||||
```bash
|
||||
grep -n 'cloudsearch\|MockAdapter\|axios.create\|mock\|nock\|fixture' src/music/netease.test.ts | head -20
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Write the failing test**
|
||||
|
||||
Append to `src/music/netease.test.ts` inside the existing `describe`:
|
||||
|
||||
```ts
|
||||
it("populates SearchResult.albums from cloudsearch type=10", async () => {
|
||||
// Adjust the fixture/mock helper to your existing test pattern.
|
||||
// The test should: arrange a mock that returns a non-empty albums array
|
||||
// for type=10, run search(), assert result.albums has the expected shape.
|
||||
mockApi.onGet("/cloudsearch", { params: expect.objectContaining({ type: 10 }) }).reply(200, {
|
||||
result: {
|
||||
albums: [
|
||||
{ id: 42, name: "Album A", picUrl: "https://x/p.jpg", artists: [{ name: "Artist X" }] },
|
||||
],
|
||||
},
|
||||
});
|
||||
mockApi.onGet("/cloudsearch", { params: expect.objectContaining({ type: 1 }) }).reply(200, { result: { songs: [] } });
|
||||
mockApi.onGet("/cloudsearch", { params: expect.objectContaining({ type: 1000 }) }).reply(200, { result: { playlists: [] } });
|
||||
|
||||
const provider = makeProvider();
|
||||
const r = await provider.search("foo", 5);
|
||||
expect(r.albums).toEqual([
|
||||
{ id: "42", name: "Album A", artist: "Artist X", coverUrl: "https://x/p.jpg", platform: "netease" },
|
||||
]);
|
||||
});
|
||||
```
|
||||
|
||||
If the existing tests use a different mock library (e.g. `msw` or manual axios stubbing), translate the fixture above to match. Do not introduce new test deps.
|
||||
|
||||
- [ ] **Step 3: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/music/netease.test.ts`
|
||||
Expected: FAIL — `result.albums` is `[]`
|
||||
|
||||
- [ ] **Step 4: Implement the change**
|
||||
|
||||
In `src/music/netease.ts` `search()` (~line 93), change the `Promise.all` from 2 to 3 calls:
|
||||
|
||||
```ts
|
||||
const [songRes, playlistRes, albumRes] = await Promise.all([
|
||||
this.api.get("/cloudsearch", { params: { keywords: query, type: 1, limit, ...this.cookieParams } }),
|
||||
this.api.get("/cloudsearch", { params: { keywords: query, type: 1000, limit: 5, ...this.cookieParams } }),
|
||||
this.api.get("/cloudsearch", { params: { keywords: query, type: 10, limit: 5, ...this.cookieParams } }),
|
||||
]);
|
||||
```
|
||||
|
||||
After the existing `playlists: Playlist[] = ...` mapping, add:
|
||||
|
||||
```ts
|
||||
const albums: Album[] = (albumRes.data?.result?.albums ?? []).map((a: any) => ({
|
||||
id: String(a.id),
|
||||
name: a.name ?? "",
|
||||
artist: (a.artists ?? []).map((x: any) => x.name).join(" / "),
|
||||
coverUrl: a.picUrl ?? "",
|
||||
platform: "netease",
|
||||
}));
|
||||
```
|
||||
|
||||
Update the `return { songs, playlists, albums: [] }` to `return { songs, playlists, albums }`.
|
||||
|
||||
(Make sure `Album` is imported from `./provider.js`; if not yet imported, add it to the existing import.)
|
||||
|
||||
- [ ] **Step 5: Run test to verify it passes**
|
||||
|
||||
Run: `npx vitest run src/music/netease.test.ts`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/music/netease.ts src/music/netease.test.ts
|
||||
git commit -m "feat(netease): include albums in search results"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 2: qq.ts — fetch albums in search
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/music/qq.ts`
|
||||
- Modify or Create: `src/music/qq.test.ts`
|
||||
|
||||
- [ ] **Step 1: Verify whether qq.test.ts exists**
|
||||
|
||||
```bash
|
||||
ls src/music/qq.test.ts
|
||||
```
|
||||
|
||||
If absent, create a minimal one mirroring `netease.test.ts` style: instantiate provider, mock the `qqDirectApi` axios instance, assert `r.albums.length > 0` after a `search()` call.
|
||||
|
||||
- [ ] **Step 2: Write the failing test**
|
||||
|
||||
Add to `src/music/qq.test.ts`:
|
||||
|
||||
```ts
|
||||
it("populates SearchResult.albums from a parallel album search request", async () => {
|
||||
// Mock returns an album list under req_album.data.body.album.list
|
||||
mockApi.onGet("/cgi-bin/musicu.fcg").reply((cfg) => {
|
||||
const data = JSON.parse(cfg.params?.data ?? "{}");
|
||||
if (data.req_album) {
|
||||
return [200, { req_album: { data: { body: { album: { list: [
|
||||
{ albumMID: "abc", albumName: "Aero", singerName: "S", albumPic: "https://x/p.jpg" },
|
||||
] } } } } }];
|
||||
}
|
||||
if (data.req_0) {
|
||||
return [200, { req_0: { data: { body: { song: { list: [] } } } } }];
|
||||
}
|
||||
return [200, {}];
|
||||
});
|
||||
|
||||
const provider = makeProvider();
|
||||
const r = await provider.search("foo", 5);
|
||||
expect(r.albums).toEqual([
|
||||
{ id: "abc", name: "Aero", artist: "S", coverUrl: expect.stringContaining("https://"), platform: "qq" },
|
||||
]);
|
||||
});
|
||||
```
|
||||
|
||||
Verify the actual QQ API response shape against a real call before finalizing the field names — `albumMID` vs `mid`, `albumPic` vs `pic`, etc. If unsure, log a real response once and freeze the shape in the fixture.
|
||||
|
||||
- [ ] **Step 3: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/music/qq.test.ts`
|
||||
Expected: FAIL — `r.albums` is `[]`
|
||||
|
||||
- [ ] **Step 4: Implement the change**
|
||||
|
||||
In `src/music/qq.ts` `search()` (~line 63), change `reqData` to include both `req_0` (songs) and `req_album` (albums):
|
||||
|
||||
```ts
|
||||
const reqData = JSON.stringify({
|
||||
req_0: {
|
||||
module: "music.search.SearchCgiService",
|
||||
method: "DoSearchForQQMusicDesktop",
|
||||
param: { searchid: "1", query, num_per_page: Math.min(limit, 50), search_type: 0 },
|
||||
},
|
||||
req_album: {
|
||||
module: "music.search.SearchCgiService",
|
||||
method: "DoSearchForQQMusicDesktop",
|
||||
param: { searchid: "1", query, num_per_page: 5, search_type: 8 },
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
After the existing `songs` mapping, add:
|
||||
|
||||
```ts
|
||||
const albumList: any[] = res.data?.req_album?.data?.body?.album?.list ?? [];
|
||||
const albums: Album[] = albumList.map((a: any) => ({
|
||||
id: String(a.albumMID ?? a.mid ?? a.albumID ?? ""),
|
||||
name: a.albumName ?? a.title ?? "",
|
||||
artist: a.singerName ?? (a.singer ?? []).map((s: any) => s.name).join(" / "),
|
||||
coverUrl: a.albumMID
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${a.albumMID}.jpg`
|
||||
: (a.albumPic ?? ""),
|
||||
platform: "qq",
|
||||
}));
|
||||
```
|
||||
|
||||
Change `return { songs, playlists: [], albums: [] }` to `return { songs, playlists: [], albums }`.
|
||||
|
||||
- [ ] **Step 5: Run test to verify it passes**
|
||||
|
||||
Run: `npx vitest run src/music/qq.test.ts`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/music/qq.ts src/music/qq.test.ts
|
||||
git commit -m "feat(qq): include albums in search results"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 3: /search/all — aggregate albums + playlists
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/api/music.ts`
|
||||
|
||||
- [ ] **Step 1: Look at the current aggregation**
|
||||
|
||||
In `src/web/api/music.ts` near line 40 the `/search/all` handler builds only `songs`. Extend it.
|
||||
|
||||
- [ ] **Step 2: Write a failing integration test (if test infra allows)**
|
||||
|
||||
If there's already a test file for music.ts, add a test that mocks the providers and asserts `res.body.albums.length > 0`. If not, skip and rely on Task 1+2 unit coverage + manual verification in Task 4.
|
||||
|
||||
- [ ] **Step 3: Aggregate albums + playlists**
|
||||
|
||||
Replace the existing `songs = ...` block + `res.json({ songs })` at lines ~54–62 with:
|
||||
|
||||
```ts
|
||||
const songs = [
|
||||
...(neteaseResult.status === "fulfilled" ? neteaseResult.value.songs : []),
|
||||
...(qqResult.status === "fulfilled" ? qqResult.value.songs : []),
|
||||
...(bilibiliResult.status === "fulfilled" ? bilibiliResult.value.songs : []),
|
||||
];
|
||||
const albums = [
|
||||
...(neteaseResult.status === "fulfilled" ? neteaseResult.value.albums : []),
|
||||
...(qqResult.status === "fulfilled" ? qqResult.value.albums : []),
|
||||
];
|
||||
const playlists = [
|
||||
...(neteaseResult.status === "fulfilled" ? neteaseResult.value.playlists : []),
|
||||
...(qqResult.status === "fulfilled" ? qqResult.value.playlists : []),
|
||||
];
|
||||
|
||||
res.json({ songs, albums, playlists });
|
||||
```
|
||||
|
||||
(Bilibili intentionally skipped for albums/playlists — no album concept; playlists likewise minor.)
|
||||
|
||||
- [ ] **Step 4: Verify by curl**
|
||||
|
||||
Build + run, then:
|
||||
|
||||
```bash
|
||||
curl -s 'http://localhost:3000/api/music/search/all?q=Beyond' \
|
||||
| python3 -c 'import json,sys;d=json.load(sys.stdin);print({k: len(v) for k, v in d.items()})'
|
||||
```
|
||||
|
||||
Expected: `{'songs': N>0, 'albums': N>0, 'playlists': N>=0}`
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/web/api/music.ts
|
||||
git commit -m "feat(api): /search/all returns albums and playlists"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: Album route reusing Playlist.vue
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/router/index.ts`
|
||||
- Modify: `web/src/views/Playlist.vue`
|
||||
|
||||
- [ ] **Step 1: Look at the current router config and Playlist load logic**
|
||||
|
||||
```bash
|
||||
grep -n "path:\|component:\|meta" web/src/router/index.ts
|
||||
grep -n "loadPlaylist\|/api/music/playlist\|onMounted" web/src/views/Playlist.vue
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Add /album/:id route**
|
||||
|
||||
In `web/src/router/index.ts`, find the `/playlist/:id` route entry. Right after it, add:
|
||||
|
||||
```ts
|
||||
{
|
||||
path: '/album/:id',
|
||||
component: () => import('../views/Playlist.vue'),
|
||||
meta: { kind: 'album' },
|
||||
},
|
||||
```
|
||||
|
||||
(If `/playlist/:id` is `meta:`-less, also add `meta: { kind: 'playlist' }` to it for symmetry.)
|
||||
|
||||
- [ ] **Step 3: Branch the endpoint inside Playlist.vue**
|
||||
|
||||
Find the load function (probably `onMounted(async () => { axios.get('/api/music/playlist/' + id, ...) })`). Refactor:
|
||||
|
||||
```ts
|
||||
const route = useRoute();
|
||||
const kind = (route.meta.kind as string) ?? 'playlist'; // 'playlist' | 'album'
|
||||
const endpoint = kind === 'album' ? '/api/music/album/' : '/api/music/playlist/';
|
||||
// ... use `${endpoint}${route.params.id}` ...
|
||||
```
|
||||
|
||||
For the hero metadata, the playlist endpoint returns `{songs}` only (no top-level cover/title) — verify what the Album endpoint currently returns. If both only return `{songs}`, the existing Playlist.vue must already derive the cover from somewhere (probably the first song's coverUrl, or an additional `/api/music/playlist/:id/detail` call). Keep the existing pattern; if a separate detail call is needed for albums, fetch the metadata from `/api/music/song/<firstSong.id>` to get the album name + cover, OR add a thin `/api/music/album/:id/detail` endpoint that returns `{ name, coverUrl, description }`.
|
||||
|
||||
**Decision:** if Playlist.vue currently uses ONLY `/api/music/playlist/:id` and derives metadata from songs, do the same for albums (no new endpoint). If it calls a separate detail endpoint, add a matching `/api/music/album/:id/detail` returning `{ name, coverUrl }` from the first song's `album` and `coverUrl` fields.
|
||||
|
||||
- [ ] **Step 4: Verify in browser**
|
||||
|
||||
Run `cd web && npm run dev`. Visit `/album/<some-netease-album-id>` (pick one from a search). Expect: hero header + song list + play-all button — same UX as a playlist page.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add web/src/router/index.ts web/src/views/Playlist.vue
|
||||
git commit -m "feat(web): /album/:id route reusing Playlist view"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 5: Search.vue — render albums + playlists sections
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/views/Search.vue`
|
||||
|
||||
- [ ] **Step 1: Read current Search.vue**
|
||||
|
||||
```bash
|
||||
sed -n '1,120p' web/src/views/Search.vue
|
||||
```
|
||||
|
||||
Identify: the `results.value = res.data.songs` line and the `<div v-else-if="results.length > 0">` block.
|
||||
|
||||
- [ ] **Step 2: Refactor to three result lists**
|
||||
|
||||
Replace the script:
|
||||
|
||||
```ts
|
||||
import type { Song } from '../stores/player.js';
|
||||
|
||||
interface Album { id: string; name: string; artist: string; coverUrl: string; platform: string; }
|
||||
interface Playlist { id: string; name: string; coverUrl: string; songCount?: number; platform: string; }
|
||||
|
||||
const songs = ref<Song[]>([]);
|
||||
const albums = ref<Album[]>([]);
|
||||
const playlists = ref<Playlist[]>([]);
|
||||
const loading = ref(false);
|
||||
const searched = ref(false);
|
||||
|
||||
async function doSearch() {
|
||||
if (!query.value.trim()) return;
|
||||
loading.value = true;
|
||||
searched.value = true;
|
||||
try {
|
||||
const res = await axios.get('/api/music/search/all', { params: { q: query.value } });
|
||||
songs.value = res.data.songs ?? [];
|
||||
albums.value = res.data.albums ?? [];
|
||||
playlists.value = res.data.playlists ?? [];
|
||||
} catch {
|
||||
songs.value = []; albums.value = []; playlists.value = [];
|
||||
} finally {
|
||||
loading.value = false;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Render the sections**
|
||||
|
||||
Replace the existing `<div v-else-if="results.length > 0" class="results">` block:
|
||||
|
||||
```vue
|
||||
<template v-else-if="songs.length || albums.length || playlists.length">
|
||||
<section v-if="albums.length" class="result-section">
|
||||
<h2 class="section-title">专辑</h2>
|
||||
<div class="card-grid">
|
||||
<router-link
|
||||
v-for="al in albums"
|
||||
:key="`${al.platform}-${al.id}`"
|
||||
:to="`/album/${al.id}?platform=${al.platform}`"
|
||||
class="card hover-scale"
|
||||
>
|
||||
<CoverArt :url="al.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
||||
<div class="card-name">{{ al.name }}</div>
|
||||
<div class="card-sub">{{ al.artist }}</div>
|
||||
</router-link>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section v-if="playlists.length" class="result-section">
|
||||
<h2 class="section-title">歌单</h2>
|
||||
<div class="card-grid">
|
||||
<router-link
|
||||
v-for="pl in playlists"
|
||||
:key="`${pl.platform}-${pl.id}`"
|
||||
:to="`/playlist/${pl.id}?platform=${pl.platform}`"
|
||||
class="card hover-scale"
|
||||
>
|
||||
<CoverArt :url="pl.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
||||
<div class="card-name">{{ pl.name }}</div>
|
||||
</router-link>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section v-if="songs.length" class="result-section">
|
||||
<h2 class="section-title">单曲</h2>
|
||||
<SongCard
|
||||
v-for="(song, i) in songs"
|
||||
:key="`${song.platform}-${song.id}`"
|
||||
:song="song"
|
||||
:index="i + 1"
|
||||
:active="store.currentSong?.id === song.id"
|
||||
@play="store.playSong(song)"
|
||||
@playNext="store.playNextSong(song)"
|
||||
@add="store.addSong(song)"
|
||||
/>
|
||||
</section>
|
||||
</template>
|
||||
|
||||
<div v-else-if="searched" class="empty">未找到相关结果</div>
|
||||
```
|
||||
|
||||
(Import `CoverArt`: `import CoverArt from '../components/CoverArt.vue';`.)
|
||||
|
||||
- [ ] **Step 4: Add minimal styles**
|
||||
|
||||
Append to the `<style lang="scss" scoped>` block:
|
||||
|
||||
```scss
|
||||
.result-section {
|
||||
margin-bottom: 32px;
|
||||
.section-title { font-size: 18px; margin: 0 0 12px; opacity: 0.85; }
|
||||
}
|
||||
.card-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
|
||||
gap: 16px;
|
||||
}
|
||||
.card {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 6px;
|
||||
text-decoration: none;
|
||||
color: inherit;
|
||||
.card-name { font-size: 14px; line-height: 1.3; max-height: 2.6em; overflow: hidden; }
|
||||
.card-sub { font-size: 12px; opacity: 0.6; }
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Build + visually verify**
|
||||
|
||||
```bash
|
||||
cd web && npm run build
|
||||
```
|
||||
|
||||
Then `npm run dev` → search "周杰伦" → see three sections; click an album card → arrives at `/album/:id` with songs + play-all.
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add web/src/views/Search.vue
|
||||
git commit -m "feat(web): show album + playlist sections in search"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Open PR
|
||||
|
||||
- [ ] **Step 1: Push branch**
|
||||
|
||||
```bash
|
||||
git checkout -b feat/album-search
|
||||
git push -u origin feat/album-search
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create the PR**
|
||||
|
||||
```bash
|
||||
gh pr create --title "feat(search): album section + album playback" --body "Closes part of #51 (album half).
|
||||
|
||||
## Summary
|
||||
- netease.search() / qq.search() now populate SearchResult.albums
|
||||
- /api/music/search/all returns albums + playlists alongside songs
|
||||
- Search.vue renders three sections: 专辑 / 歌单 / 单曲
|
||||
- /album/:id route reuses Playlist.vue with meta.kind='album'
|
||||
- bilibili / youtube intentionally still return albums:[] (no album API)
|
||||
|
||||
## Test plan
|
||||
- [x] vitest covers netease + qq search returning non-empty albums
|
||||
- [x] curl /search/all?q=周杰伦 returns {songs, albums, playlists}
|
||||
- [x] Manual: search → click album card → /album/:id → play all
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review Checklist
|
||||
|
||||
- [x] Spec coverage: backend album search → Tasks 1+2; aggregator → Task 3; album detail route → Task 4; UI sections → Task 5
|
||||
- [x] No "TBD"/placeholder text — every step shows the actual diff or command
|
||||
- [x] Type names consistent: `Album` (capital A), `albums` (lowercase plural), `SearchResult.albums`
|
||||
- [x] Bilibili/YouTube explicitly out of scope per spec — confirmed in Task 3 by skipping them in albums aggregation
|
||||
- [x] Routes use `meta.kind` — same key referenced in Playlist.vue (Task 4) and `/album/:id` registration (Task 4 Step 2)
|
||||
@@ -0,0 +1,903 @@
|
||||
# Custom Bot Avatar Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Let users upload a fixed avatar per bot. When `avatarEnabled=true`, the avatar follows the song cover during playback and reverts to the custom avatar (instead of clearing) on stop. When `avatarEnabled=false` and a custom avatar exists, the bot always shows the custom avatar.
|
||||
|
||||
**Architecture:** New SQLite column stores a relative file path; bytes live on disk under `data/avatars/<botId>.<ext>` (mirrors `data/cookies/`). `BotProfileManager` gains a `customAvatar` Buffer; the existing `clearAvatar()` becomes "restore custom or clear"; `onConnect()` immediately applies the custom avatar when sync is off. Three new REST endpoints (GET/PUT/DELETE) under `/api/bot/:id/avatar` accept base64 JSON (avoids adding multer; bump `express.json()` limit).
|
||||
|
||||
**Tech Stack:** Node 20 + TS + Express 5, better-sqlite3, Vue 3 + axios. No new runtime deps.
|
||||
|
||||
---
|
||||
|
||||
## Spec Reference
|
||||
|
||||
`docs/superpowers/specs/2026-05-07-custom-avatar-and-album-search-design.md` — section "自定义头像".
|
||||
|
||||
## File Structure
|
||||
|
||||
| File | Action | Responsibility |
|
||||
|---|---|---|
|
||||
| `src/data/database.ts` | Modify | Add `custom_avatar_path` column + migration + accessor methods |
|
||||
| `src/data/avatars.ts` | **Create** | Read/write/delete avatar files under `data/avatars/` |
|
||||
| `src/bot/profile.ts` | Modify | `customAvatar` field, `setCustomAvatar`, `applyIdleAvatar`, modify `clearAvatar`, modify `onConnect` |
|
||||
| `src/bot/instance.ts` | Modify | Load custom avatar on start, pass to ProfileManager |
|
||||
| `src/web/api/bot.ts` | Modify | Add GET/PUT/DELETE `/avatar` endpoints |
|
||||
| `src/web/server.ts` | Modify | Bump `express.json()` limit to `400kb` |
|
||||
| `src/index.ts` | Modify | Pass `AVATAR_DIR` to bot manager / API router |
|
||||
| `src/data/database.test.ts` | Modify | Test custom avatar path persistence + migration idempotency |
|
||||
| `src/data/avatars.test.ts` | **Create** | Unit tests for avatar store |
|
||||
| `src/bot/profile.test.ts` | **Create** | Tests for new precedence logic with a mock TS3Client |
|
||||
| `web/src/components/AvatarUpload.vue` | **Create** | Reusable avatar picker + preview + delete |
|
||||
| `web/src/views/Settings.vue` | Modify | Add custom avatar row in profile features list; insert into create-bot and edit-bot forms |
|
||||
|
||||
## Conventions
|
||||
|
||||
- TDD: failing test → implement → verify → commit, every step.
|
||||
- Commits use conventional format: `feat(profile):`, `feat(api):`, `feat(web):`, `test(...)`. Each task ends with one commit.
|
||||
- Tests live in vitest (`npm test`).
|
||||
- All paths absolute or relative to repo root.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: DB migration + getter/setter for custom avatar path
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/data/database.ts`
|
||||
- Modify: `src/data/database.test.ts`
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
|
||||
Add to `src/data/database.test.ts` after the existing tests (find the closing `});` of the last test case in the `describe` block, insert before it):
|
||||
|
||||
```ts
|
||||
it("persists and clears customAvatarPath on a bot instance", () => {
|
||||
const inst = {
|
||||
id: "bot-1",
|
||||
name: "B",
|
||||
serverAddress: "x",
|
||||
serverPort: 9987,
|
||||
nickname: "n",
|
||||
defaultChannel: "",
|
||||
channelPassword: "",
|
||||
autoStart: false,
|
||||
serverProtocol: "",
|
||||
ts6ApiKey: "",
|
||||
serverPassword: "",
|
||||
};
|
||||
botDb.saveBotInstance(inst);
|
||||
expect(botDb.getCustomAvatarPath("bot-1")).toBeNull();
|
||||
botDb.setCustomAvatarPath("bot-1", "avatars/bot-1.png");
|
||||
expect(botDb.getCustomAvatarPath("bot-1")).toBe("avatars/bot-1.png");
|
||||
botDb.setCustomAvatarPath("bot-1", null);
|
||||
expect(botDb.getCustomAvatarPath("bot-1")).toBeNull();
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/data/database.test.ts`
|
||||
Expected: FAIL — `botDb.getCustomAvatarPath is not a function`
|
||||
|
||||
- [ ] **Step 3: Add the column to migration + interface + statements**
|
||||
|
||||
In `src/data/database.ts`:
|
||||
|
||||
1. Find `BotDatabase` interface (~line 54), add two methods before `close()`:
|
||||
|
||||
```ts
|
||||
getCustomAvatarPath(botId: string): string | null;
|
||||
setCustomAvatarPath(botId: string, path: string | null): void;
|
||||
```
|
||||
|
||||
2. Find `migrateSchema()` (~line 66). After the `for (const col of profileCols)` loop, append:
|
||||
|
||||
```ts
|
||||
if (!names.includes("custom_avatar_path")) {
|
||||
db.exec("ALTER TABLE bot_instances ADD COLUMN custom_avatar_path TEXT");
|
||||
}
|
||||
```
|
||||
|
||||
3. In `createDatabase()` after the existing `prepare(...)` calls (~line 180), add:
|
||||
|
||||
```ts
|
||||
const selectCustomAvatar = db.prepare(
|
||||
`SELECT custom_avatar_path FROM bot_instances WHERE id = ?`,
|
||||
);
|
||||
const updateCustomAvatar = db.prepare(
|
||||
`UPDATE bot_instances SET custom_avatar_path = ? WHERE id = ?`,
|
||||
);
|
||||
```
|
||||
|
||||
4. Inside the returned object, add (before `close()`):
|
||||
|
||||
```ts
|
||||
getCustomAvatarPath(botId) {
|
||||
const row = selectCustomAvatar.get(botId) as { custom_avatar_path: string | null } | undefined;
|
||||
return row?.custom_avatar_path ?? null;
|
||||
},
|
||||
|
||||
setCustomAvatarPath(botId, path) {
|
||||
updateCustomAvatar.run(path, botId);
|
||||
},
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run test to verify it passes**
|
||||
|
||||
Run: `npx vitest run src/data/database.test.ts`
|
||||
Expected: PASS — all tests including the new one
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/data/database.ts src/data/database.test.ts
|
||||
git commit -m "feat(db): custom_avatar_path column + accessors"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 2: Avatar storage helper
|
||||
|
||||
**Files:**
|
||||
- Create: `src/data/avatars.ts`
|
||||
- Create: `src/data/avatars.test.ts`
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
|
||||
Create `src/data/avatars.test.ts`:
|
||||
|
||||
```ts
|
||||
import { describe, it, expect, beforeEach } from "vitest";
|
||||
import { mkdtempSync, rmSync, existsSync, readFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { createAvatarStore } from "./avatars.js";
|
||||
|
||||
let dir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
dir = mkdtempSync(join(tmpdir(), "avatar-test-"));
|
||||
});
|
||||
|
||||
describe("createAvatarStore", () => {
|
||||
it("write returns a relative path under the store dir", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
const buf = Buffer.from("fake-png");
|
||||
const rel = store.write("bot-1", "image/png", buf);
|
||||
expect(rel).toBe("bot-1.png");
|
||||
expect(readFileSync(join(dir, "bot-1.png")).equals(buf)).toBe(true);
|
||||
});
|
||||
|
||||
it("write picks correct extension for jpeg / webp", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
expect(store.write("a", "image/jpeg", Buffer.from(""))).toBe("a.jpg");
|
||||
expect(store.write("b", "image/webp", Buffer.from(""))).toBe("b.webp");
|
||||
});
|
||||
|
||||
it("write rejects unsupported MIME types", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
expect(() => store.write("c", "image/gif", Buffer.from(""))).toThrow(
|
||||
/unsupported/i,
|
||||
);
|
||||
});
|
||||
|
||||
it("read returns the bytes for an existing file", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
store.write("bot-1", "image/png", Buffer.from("hello"));
|
||||
const buf = store.read("bot-1.png");
|
||||
expect(buf?.equals(Buffer.from("hello"))).toBe(true);
|
||||
});
|
||||
|
||||
it("read returns null when path is missing", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
expect(store.read("missing.png")).toBeNull();
|
||||
});
|
||||
|
||||
it("remove deletes the file (idempotent)", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
store.write("bot-1", "image/png", Buffer.from("x"));
|
||||
store.remove("bot-1.png");
|
||||
expect(existsSync(join(dir, "bot-1.png"))).toBe(false);
|
||||
expect(() => store.remove("bot-1.png")).not.toThrow();
|
||||
});
|
||||
|
||||
it("write replaces any existing file for the same botId regardless of old extension", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
store.write("bot-1", "image/png", Buffer.from("old"));
|
||||
const rel = store.write("bot-1", "image/jpeg", Buffer.from("new"));
|
||||
expect(rel).toBe("bot-1.jpg");
|
||||
expect(existsSync(join(dir, "bot-1.png"))).toBe(false);
|
||||
expect(existsSync(join(dir, "bot-1.jpg"))).toBe(true);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/data/avatars.test.ts`
|
||||
Expected: FAIL — module not found
|
||||
|
||||
- [ ] **Step 3: Implement the store**
|
||||
|
||||
Create `src/data/avatars.ts`:
|
||||
|
||||
```ts
|
||||
import { mkdirSync, writeFileSync, readFileSync, rmSync, readdirSync, existsSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
|
||||
const MIME_TO_EXT: Record<string, string> = {
|
||||
"image/png": "png",
|
||||
"image/jpeg": "jpg",
|
||||
"image/webp": "webp",
|
||||
};
|
||||
|
||||
export interface AvatarStore {
|
||||
/** Returns the relative path written (e.g. "bot-1.png"). */
|
||||
write(botId: string, mime: string, buffer: Buffer): string;
|
||||
read(relPath: string): Buffer | null;
|
||||
remove(relPath: string): void;
|
||||
getDir(): string;
|
||||
}
|
||||
|
||||
export function createAvatarStore(dir: string): AvatarStore {
|
||||
if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
|
||||
return {
|
||||
write(botId, mime, buffer) {
|
||||
const ext = MIME_TO_EXT[mime];
|
||||
if (!ext) throw new Error(`unsupported avatar MIME: ${mime}`);
|
||||
// Remove any existing avatar for this bot regardless of extension.
|
||||
for (const name of readdirSync(dir)) {
|
||||
if (name.startsWith(`${botId}.`)) rmSync(join(dir, name), { force: true });
|
||||
}
|
||||
const rel = `${botId}.${ext}`;
|
||||
writeFileSync(join(dir, rel), buffer);
|
||||
return rel;
|
||||
},
|
||||
read(relPath) {
|
||||
const full = join(dir, relPath);
|
||||
if (!existsSync(full)) return null;
|
||||
return readFileSync(full);
|
||||
},
|
||||
remove(relPath) {
|
||||
rmSync(join(dir, relPath), { force: true });
|
||||
},
|
||||
getDir() {
|
||||
return dir;
|
||||
},
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run test to verify it passes**
|
||||
|
||||
Run: `npx vitest run src/data/avatars.test.ts`
|
||||
Expected: PASS — all 7 tests
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/data/avatars.ts src/data/avatars.test.ts
|
||||
git commit -m "feat(data): avatar file store helper"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 3: BotProfileManager — custom avatar precedence
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/bot/profile.ts`
|
||||
- Create: `src/bot/profile.test.ts`
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
|
||||
Create `src/bot/profile.test.ts`:
|
||||
|
||||
```ts
|
||||
import { describe, it, expect, beforeEach, vi } from "vitest";
|
||||
import { BotProfileManager } from "./profile.js";
|
||||
import type { TS3Client } from "../ts-protocol/client.js";
|
||||
|
||||
function makeMockTs(): TS3Client & {
|
||||
uploadCalls: Buffer[];
|
||||
clearCalls: number;
|
||||
} {
|
||||
const calls: Buffer[] = [];
|
||||
let clears = 0;
|
||||
const ts: any = {
|
||||
uploadCalls: calls,
|
||||
get clearCalls() { return clears; },
|
||||
getHost: () => "127.0.0.1",
|
||||
getHttpQuery: () => null,
|
||||
fileTransferInitUpload: vi.fn().mockResolvedValue({}),
|
||||
uploadFileData: vi.fn().mockImplementation(async (_h, _i, stream: any) => {
|
||||
const chunks: Buffer[] = [];
|
||||
for await (const c of stream) chunks.push(c as Buffer);
|
||||
calls.push(Buffer.concat(chunks));
|
||||
}),
|
||||
fileTransferDeleteFile: vi.fn().mockResolvedValue(undefined),
|
||||
sendCommandNoWait: vi.fn().mockImplementation(async (cmd: string) => {
|
||||
if (/client_flag_avatar=$/.test(cmd)) clears++;
|
||||
}),
|
||||
};
|
||||
return ts;
|
||||
}
|
||||
|
||||
const noopLogger: any = { child: () => noopLogger, info: () => {}, debug: () => {}, warn: () => {}, error: () => {} };
|
||||
|
||||
const cfgOn = { avatarEnabled: true, descriptionEnabled: false, nicknameEnabled: false, awayStatusEnabled: false, channelDescEnabled: false, nowPlayingMsgEnabled: false };
|
||||
const cfgOff = { ...cfgOn, avatarEnabled: false };
|
||||
|
||||
describe("BotProfileManager custom avatar precedence", () => {
|
||||
let ts: ReturnType<typeof makeMockTs>;
|
||||
beforeEach(() => { ts = makeMockTs(); });
|
||||
|
||||
it("on stop with custom avatar set + sync on, uploads custom (does not clear)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
const custom = Buffer.from([1, 2, 3, 4]);
|
||||
pm.setCustomAvatar(custom);
|
||||
await pm.onSongChange(null);
|
||||
expect(ts.uploadCalls.at(-1)?.equals(custom)).toBe(true);
|
||||
expect(ts.clearCalls).toBe(0);
|
||||
});
|
||||
|
||||
it("on stop with no custom avatar, falls back to clear", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
await pm.onSongChange(null);
|
||||
expect(ts.clearCalls).toBe(1);
|
||||
expect(ts.uploadCalls.length).toBe(0);
|
||||
});
|
||||
|
||||
it("on connect with sync off + custom avatar set, applies custom immediately", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOff, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([9, 9]));
|
||||
await pm.onConnect();
|
||||
expect(ts.uploadCalls.length).toBe(1);
|
||||
expect(ts.uploadCalls[0].equals(Buffer.from([9, 9]))).toBe(true);
|
||||
});
|
||||
|
||||
it("on connect with sync off + no custom avatar, does not touch avatar", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOff, "Bot");
|
||||
await pm.onConnect();
|
||||
expect(ts.uploadCalls.length).toBe(0);
|
||||
expect(ts.clearCalls).toBe(0);
|
||||
});
|
||||
|
||||
it("setCustomAvatar(null) makes subsequent onSongChange(null) clear again", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([1]));
|
||||
pm.setCustomAvatar(null);
|
||||
await pm.onSongChange(null);
|
||||
expect(ts.clearCalls).toBe(1);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/bot/profile.test.ts`
|
||||
Expected: FAIL — `pm.setCustomAvatar is not a function` and/or `onConnect` not exported
|
||||
|
||||
- [ ] **Step 3: Look at the existing profile.ts to understand `onConnect` shape**
|
||||
|
||||
Run: `grep -n 'onConnect\|public async\|public ' src/bot/profile.ts | head -10`
|
||||
|
||||
`onConnect` likely already exists; if not, locate where reconnect resets state. Add or extend it.
|
||||
|
||||
- [ ] **Step 4: Implement `customAvatar`, `setCustomAvatar`, `applyIdleAvatar`; modify `clearAvatar` and `onConnect`**
|
||||
|
||||
In `src/bot/profile.ts`:
|
||||
|
||||
1. Inside the class, add fields next to `defaultNickname` (around line 27):
|
||||
|
||||
```ts
|
||||
private customAvatar: Buffer | null = null;
|
||||
```
|
||||
|
||||
2. After the `constructor`, add:
|
||||
|
||||
```ts
|
||||
/** Set/clear the persistent idle avatar. Pass null to remove. */
|
||||
setCustomAvatar(buffer: Buffer | null): void {
|
||||
this.customAvatar = buffer;
|
||||
}
|
||||
```
|
||||
|
||||
3. Find `clearAvatar()` (~line 173). Change the body so that if `this.customAvatar` is set, we upload it instead of clearing the flag. Replace the existing method with:
|
||||
|
||||
```ts
|
||||
private async clearAvatar(gen: number): Promise<void> {
|
||||
if (this.customAvatar && this.customAvatar.length > 0) {
|
||||
await this.applyIdleAvatar(gen);
|
||||
return;
|
||||
}
|
||||
try {
|
||||
await this.withTimeout(
|
||||
this.tsClient.fileTransferDeleteFile(0n, ["/avatar"]),
|
||||
FILE_TRANSFER_TIMEOUT_MS,
|
||||
);
|
||||
} catch {
|
||||
// File may not exist or transfer timed out — that's fine
|
||||
}
|
||||
if (this.generation !== gen) return;
|
||||
try {
|
||||
await this.tsClient.sendCommandNoWait("clientupdate client_flag_avatar=");
|
||||
} catch (err) {
|
||||
this.handleFeatureError("avatar", err);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
4. Add a new private method right below `clearAvatar`:
|
||||
|
||||
```ts
|
||||
private async applyIdleAvatar(gen: number): Promise<void> {
|
||||
if (!this.customAvatar || this.customAvatar.length === 0) return;
|
||||
if (this.permDenied.avatar) return;
|
||||
try {
|
||||
await this.withTimeout(this.doAvatarUpload(this.customAvatar), FILE_TRANSFER_TIMEOUT_MS);
|
||||
if (this.generation !== gen) return;
|
||||
this.logger.info({ bytes: this.customAvatar.length }, "Idle (custom) avatar applied");
|
||||
} catch (err) {
|
||||
this.handleFeatureError("avatar", err);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
5. Find `onConnect` (the existing method that resets per-feature flags). At its end, immediately after the `permDenied` reset, add:
|
||||
|
||||
```ts
|
||||
if (!this.config.avatarEnabled && this.customAvatar) {
|
||||
const gen = ++this.generation;
|
||||
void this.applyIdleAvatar(gen);
|
||||
}
|
||||
```
|
||||
|
||||
If `onConnect` does not exist as a method, search for where reconnect resets `permDenied` and add the block there.
|
||||
|
||||
- [ ] **Step 5: Run test to verify it passes**
|
||||
|
||||
Run: `npx vitest run src/bot/profile.test.ts`
|
||||
Expected: PASS — 5/5
|
||||
|
||||
Run also: `npx vitest run src/audio src/data src/bot` — confirm no regressions.
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/bot/profile.ts src/bot/profile.test.ts
|
||||
git commit -m "feat(profile): custom avatar with idle/playback precedence"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: Wire avatar load on bot start
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/bot/instance.ts`
|
||||
- Modify: `src/bot/manager.ts` (if it constructs the instance)
|
||||
- Modify: `src/index.ts`
|
||||
|
||||
- [ ] **Step 1: Confirm where `BotProfileManager` is constructed and how `BotInstance` receives DB**
|
||||
|
||||
Run: `grep -n 'new BotProfileManager\|profileManager =\|database\|botDb' src/bot/instance.ts src/bot/manager.ts | head -20`
|
||||
|
||||
Identify the BotInstance constructor params and verify that the DB and the avatar dir can flow in.
|
||||
|
||||
- [ ] **Step 2: Add `AVATAR_DIR` constant + `avatarStore` to `src/index.ts`**
|
||||
|
||||
Find where `COOKIE_DIR` / `createCookieStore` are set up (~line 48 in src/index.ts) and add directly after:
|
||||
|
||||
```ts
|
||||
const AVATAR_DIR = process.env.AVATAR_DIR ?? join(DATA_DIR, "avatars");
|
||||
const avatarStore = createAvatarStore(AVATAR_DIR);
|
||||
```
|
||||
|
||||
(import as needed: `import { createAvatarStore } from "./data/avatars.js";`)
|
||||
|
||||
Pass `avatarStore` through to whatever constructs `BotManager` (and from there to `BotInstance`).
|
||||
|
||||
- [ ] **Step 3: In `BotInstance`, after `profileManager` is created, load the avatar from disk if any**
|
||||
|
||||
In `src/bot/instance.ts`, after `this.profileManager = new BotProfileManager(...)`:
|
||||
|
||||
```ts
|
||||
const relPath = this.botDb.getCustomAvatarPath(this.id);
|
||||
if (relPath) {
|
||||
const buf = this.avatarStore.read(relPath);
|
||||
if (buf) this.profileManager.setCustomAvatar(buf);
|
||||
}
|
||||
```
|
||||
|
||||
(Add `private botDb: BotDatabase` and `private avatarStore: AvatarStore` constructor params; thread them down from `BotManager.createBot()` / `BotManager` constructor.)
|
||||
|
||||
- [ ] **Step 4: Add `getProfileManager()` accessor if not present**
|
||||
|
||||
If grep already shows `getProfileManager(): BotProfileManager`, skip. Otherwise add a public method that returns `this.profileManager`.
|
||||
|
||||
- [ ] **Step 5: Build and run the existing tests**
|
||||
|
||||
Run: `npx tsc --noEmit`
|
||||
Expected: no TS errors
|
||||
|
||||
Run: `npm test`
|
||||
Expected: all green
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/index.ts src/bot/instance.ts src/bot/manager.ts
|
||||
git commit -m "feat(bot): load custom avatar on instance startup"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 5: REST endpoints for avatar upload / fetch / delete
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/server.ts` (json size limit)
|
||||
- Modify: `src/web/api/bot.ts`
|
||||
|
||||
- [ ] **Step 1: Bump express.json size limit**
|
||||
|
||||
In `src/web/server.ts`, find `app.use(express.json())` (~line 46) and change to:
|
||||
|
||||
```ts
|
||||
app.use(express.json({ limit: "400kb" }));
|
||||
```
|
||||
|
||||
(Avatar payload is base64-encoded ≤200 KB → ~270 KB on the wire; 400 KB gives margin.)
|
||||
|
||||
- [ ] **Step 2: Write a failing API test (use supertest if not present, otherwise inline fetch)**
|
||||
|
||||
Run: `grep -E '"supertest"|"vitest"' package.json`
|
||||
|
||||
If supertest is not present, write the test using `node:http` raw client or skip API integration test and rely on manual + unit tests on Task 7. Don't add new deps unless approved.
|
||||
|
||||
If supertest IS present, add `src/web/api/bot.test.ts`:
|
||||
|
||||
```ts
|
||||
import { describe, it, expect } from "vitest";
|
||||
import request from "supertest";
|
||||
import express from "express";
|
||||
import { createBotRouter } from "./bot.js";
|
||||
// ... build minimal app with mocked manager + DB + avatarStore
|
||||
```
|
||||
|
||||
If not present: skip Step 2, jump to Step 3 and verify by manual curl in Step 5.
|
||||
|
||||
- [ ] **Step 3: Add the three endpoints**
|
||||
|
||||
In `src/web/api/bot.ts`, modify the factory signature to accept `avatarStore` and `botDb`:
|
||||
|
||||
```ts
|
||||
export function createBotRouter(
|
||||
botManager: BotManager,
|
||||
config: BotConfig,
|
||||
configPath: string,
|
||||
logger: Logger,
|
||||
botDb: BotDatabase,
|
||||
avatarStore: AvatarStore,
|
||||
): Router {
|
||||
```
|
||||
|
||||
Inside the router, after the existing `/:id/config` GET, add:
|
||||
|
||||
```ts
|
||||
router.get("/:id/avatar", (req, res) => {
|
||||
const path = botDb.getCustomAvatarPath(req.params.id);
|
||||
if (!path) { res.status(404).end(); return; }
|
||||
const buf = avatarStore.read(path);
|
||||
if (!buf) { res.status(404).end(); return; }
|
||||
const ext = path.split(".").pop()!;
|
||||
const mime = ext === "png" ? "image/png" : ext === "webp" ? "image/webp" : "image/jpeg";
|
||||
res.set("Content-Type", mime);
|
||||
res.set("Cache-Control", "no-cache");
|
||||
res.send(buf);
|
||||
});
|
||||
|
||||
router.put("/:id/avatar", (req, res) => {
|
||||
const bot = botManager.getBot(req.params.id);
|
||||
if (!bot && !botDb.getBotInstances().some((b) => b.id === req.params.id)) {
|
||||
res.status(404).json({ error: "Bot not found" });
|
||||
return;
|
||||
}
|
||||
const { dataUrl } = req.body as { dataUrl?: string };
|
||||
if (typeof dataUrl !== "string") {
|
||||
res.status(400).json({ error: "dataUrl required" });
|
||||
return;
|
||||
}
|
||||
const m = /^data:(image\/(png|jpeg|webp));base64,(.+)$/.exec(dataUrl);
|
||||
if (!m) {
|
||||
res.status(400).json({ error: "dataUrl must be image/png|jpeg|webp base64" });
|
||||
return;
|
||||
}
|
||||
const mime = m[1];
|
||||
const buf = Buffer.from(m[3], "base64");
|
||||
if (buf.length > 200 * 1024) {
|
||||
res.status(413).json({ error: "avatar exceeds 200KB limit" });
|
||||
return;
|
||||
}
|
||||
const rel = avatarStore.write(req.params.id, mime, buf);
|
||||
botDb.setCustomAvatarPath(req.params.id, rel);
|
||||
bot?.getProfileManager().setCustomAvatar(buf);
|
||||
res.json({ path: rel });
|
||||
});
|
||||
|
||||
router.delete("/:id/avatar", (req, res) => {
|
||||
const path = botDb.getCustomAvatarPath(req.params.id);
|
||||
if (path) avatarStore.remove(path);
|
||||
botDb.setCustomAvatarPath(req.params.id, null);
|
||||
const bot = botManager.getBot(req.params.id);
|
||||
bot?.getProfileManager().setCustomAvatar(null);
|
||||
res.status(204).end();
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Update the call site that constructs the router**
|
||||
|
||||
Search: `grep -n 'createBotRouter' src/`
|
||||
|
||||
In the call site (likely `src/web/server.ts` or `src/index.ts`), pass the new args. Fix the call signature.
|
||||
|
||||
- [ ] **Step 5: Manual smoke test**
|
||||
|
||||
Run: `npm run build && npm run start`
|
||||
In another terminal:
|
||||
|
||||
```bash
|
||||
# create a small valid PNG (1x1) base64
|
||||
B64=$(node -e "console.log(Buffer.from([137,80,78,71,13,10,26,10,0,0,0,13,73,72,68,82,0,0,0,1,0,0,0,1,8,2,0,0,0,144,119,83,222,0,0,0,12,73,68,65,84,8,153,99,248,255,255,63,0,5,254,2,254,205,250,236,184,0,0,0,0,73,69,78,68,174,66,96,130]).toString('base64'))")
|
||||
|
||||
curl -X PUT http://localhost:3000/api/bot/<BOT_ID>/avatar \
|
||||
-H 'Content-Type: application/json' \
|
||||
-d "{\"dataUrl\":\"data:image/png;base64,$B64\"}"
|
||||
|
||||
curl http://localhost:3000/api/bot/<BOT_ID>/avatar -o /tmp/x.png
|
||||
file /tmp/x.png
|
||||
|
||||
curl -X DELETE http://localhost:3000/api/bot/<BOT_ID>/avatar -i
|
||||
```
|
||||
|
||||
Expected: PUT returns `{"path":"<id>.png"}`, GET returns the bytes, DELETE returns 204.
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/web/server.ts src/web/api/bot.ts src/index.ts
|
||||
git commit -m "feat(api): /api/bot/:id/avatar GET/PUT/DELETE"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Frontend — `AvatarUpload.vue` component
|
||||
|
||||
**Files:**
|
||||
- Create: `web/src/components/AvatarUpload.vue`
|
||||
|
||||
- [ ] **Step 1: Create the component**
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<div class="avatar-upload">
|
||||
<div class="preview" :class="{ empty: !previewUrl }">
|
||||
<img v-if="previewUrl" :src="previewUrl" alt="avatar" />
|
||||
<Icon v-else icon="mdi:account-circle-outline" />
|
||||
</div>
|
||||
<div class="actions">
|
||||
<input
|
||||
ref="fileInput"
|
||||
type="file"
|
||||
accept="image/png,image/jpeg,image/webp"
|
||||
class="hidden"
|
||||
@change="onFile"
|
||||
/>
|
||||
<button type="button" class="btn-sm" @click="fileInput?.click()">
|
||||
{{ previewUrl ? '更换' : '上传' }}
|
||||
</button>
|
||||
<button v-if="previewUrl" type="button" class="btn-sm btn-danger" @click="clear">
|
||||
删除
|
||||
</button>
|
||||
</div>
|
||||
<p v-if="error" class="hint error">{{ error }}</p>
|
||||
<p v-else class="hint">PNG / JPG / WebP,≤200 KB</p>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { ref, watch } from 'vue';
|
||||
import { Icon } from '@iconify/vue';
|
||||
|
||||
const props = defineProps<{ modelValue: string | null }>();
|
||||
const emit = defineEmits<{ 'update:modelValue': [value: string | null] }>();
|
||||
|
||||
const previewUrl = ref<string | null>(props.modelValue);
|
||||
const error = ref<string | null>(null);
|
||||
const fileInput = ref<HTMLInputElement | null>(null);
|
||||
|
||||
watch(() => props.modelValue, (v) => { previewUrl.value = v; });
|
||||
|
||||
function onFile(ev: Event) {
|
||||
const file = (ev.target as HTMLInputElement).files?.[0];
|
||||
if (!file) return;
|
||||
if (!['image/png', 'image/jpeg', 'image/webp'].includes(file.type)) {
|
||||
error.value = '仅支持 PNG / JPG / WebP';
|
||||
return;
|
||||
}
|
||||
if (file.size > 200 * 1024) {
|
||||
error.value = `图片 ${(file.size / 1024).toFixed(0)} KB 超过 200 KB 上限`;
|
||||
return;
|
||||
}
|
||||
error.value = null;
|
||||
const reader = new FileReader();
|
||||
reader.onload = () => {
|
||||
const dataUrl = reader.result as string;
|
||||
previewUrl.value = dataUrl;
|
||||
emit('update:modelValue', dataUrl);
|
||||
};
|
||||
reader.readAsDataURL(file);
|
||||
}
|
||||
|
||||
function clear() {
|
||||
previewUrl.value = null;
|
||||
emit('update:modelValue', null);
|
||||
if (fileInput.value) fileInput.value.value = '';
|
||||
}
|
||||
</script>
|
||||
|
||||
<style lang="scss" scoped>
|
||||
.avatar-upload { display: flex; flex-direction: column; gap: 8px; align-items: flex-start; }
|
||||
.preview {
|
||||
width: 80px; height: 80px; border-radius: 50%;
|
||||
background: var(--bg-card); display: flex; align-items: center; justify-content: center;
|
||||
overflow: hidden;
|
||||
img { width: 100%; height: 100%; object-fit: cover; }
|
||||
&.empty :deep(svg) { font-size: 48px; opacity: 0.4; }
|
||||
}
|
||||
.actions { display: flex; gap: 8px; }
|
||||
.hidden { display: none; }
|
||||
.hint { font-size: 12px; opacity: 0.6; margin: 0; }
|
||||
.hint.error { color: var(--color-danger, #e85060); opacity: 1; }
|
||||
.btn-danger { color: var(--color-danger, #e85060); }
|
||||
</style>
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Verify the component compiles**
|
||||
|
||||
Run: `cd web && npx vue-tsc --noEmit`
|
||||
Expected: no errors
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git add web/src/components/AvatarUpload.vue
|
||||
git commit -m "feat(web): AvatarUpload component"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 7: Wire AvatarUpload into Settings.vue (create + edit + standalone row)
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/views/Settings.vue`
|
||||
|
||||
- [ ] **Step 1: Read the relevant Settings.vue regions**
|
||||
|
||||
```bash
|
||||
grep -n '同步头像\|openEditBot\|saveEditBot\|createBot\|create-bot\|profile-features\|features.find' web/src/views/Settings.vue | head -20
|
||||
```
|
||||
|
||||
Identify:
|
||||
- Create-bot form template region (`<div class="create-bot">` block)
|
||||
- Edit-bot modal/dialog template region
|
||||
- The profile features table where `avatarEnabled` row lives
|
||||
|
||||
- [ ] **Step 2: Add component import + reactive state for avatar dataUrl on the create-bot form**
|
||||
|
||||
In the script setup region, near other `newBot*` refs:
|
||||
|
||||
```ts
|
||||
import AvatarUpload from '../components/AvatarUpload.vue';
|
||||
const newBotAvatar = ref<string | null>(null);
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Insert `<AvatarUpload v-model="newBotAvatar" />` into the create-bot form template**
|
||||
|
||||
In the `<div class="create-bot">` block, right before `<button class="btn-primary" @click="createBot">创建</button>`, add:
|
||||
|
||||
```vue
|
||||
<div class="form-row">
|
||||
<label>自定义头像(可选)</label>
|
||||
<AvatarUpload v-model="newBotAvatar" />
|
||||
</div>
|
||||
```
|
||||
|
||||
- [ ] **Step 4: After successful `createBot()`, PUT the avatar if set**
|
||||
|
||||
Find the `createBot` async function. After the POST resolves and the bot id is known (`res.data.id` or similar), append:
|
||||
|
||||
```ts
|
||||
if (newBotAvatar.value) {
|
||||
await axios.put(`/api/bot/${res.data.id}/avatar`, { dataUrl: newBotAvatar.value });
|
||||
}
|
||||
newBotAvatar.value = null;
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Add an "自定义头像" row in the per-bot profile features table**
|
||||
|
||||
Find the profile-features table render (look for the `features` array iteration). The cleanest path: add a custom row OUTSIDE the array (since it isn't a boolean toggle). Right before `</template>` of the bot row, add:
|
||||
|
||||
```vue
|
||||
<div class="feature-row">
|
||||
<div class="feature-label">自定义头像</div>
|
||||
<div class="feature-control">
|
||||
<CustomAvatarRow :bot-id="bot.id" />
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
Where `CustomAvatarRow` is an inline-defined component or a small file `web/src/components/CustomAvatarRow.vue` that:
|
||||
- Mounts → `axios.get(/api/bot/<id>/avatar, { responseType: 'blob' })` → previews if 200, ignore 404
|
||||
- Wraps `<AvatarUpload>` and on `update:modelValue`:
|
||||
- If string → `axios.put(/avatar, { dataUrl })`
|
||||
- If null → `axios.delete(/avatar)`
|
||||
|
||||
Create `web/src/components/CustomAvatarRow.vue` with that logic; keep its body small (~50 lines).
|
||||
|
||||
- [ ] **Step 6: Build and visually verify**
|
||||
|
||||
Run: `cd web && npm run build` → no errors. Then `npm run dev` → open create-instance, upload PNG, create — verify the avatar appears on the bot in TS3 once it connects. Check edit/Settings flow.
|
||||
|
||||
- [ ] **Step 7: Commit**
|
||||
|
||||
```bash
|
||||
git add web/src/views/Settings.vue web/src/components/CustomAvatarRow.vue
|
||||
git commit -m "feat(web): custom avatar in create-bot + Settings"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 8: Open PR
|
||||
|
||||
- [ ] **Step 1: Push the branch**
|
||||
|
||||
```bash
|
||||
git checkout -b feat/custom-bot-avatar
|
||||
git push -u origin feat/custom-bot-avatar
|
||||
```
|
||||
|
||||
(If commits were already on `main`, instead create the branch from the first relevant commit and reset main: `git branch feat/custom-bot-avatar HEAD && git reset --hard origin/main && git checkout feat/custom-bot-avatar`. The exact sequence depends on the working state when starting.)
|
||||
|
||||
- [ ] **Step 2: Create the PR**
|
||||
|
||||
```bash
|
||||
gh pr create --title "feat(profile): custom bot avatar" --body "Closes part of #51 (avatar half).
|
||||
|
||||
## Summary
|
||||
- New /api/bot/:id/avatar GET/PUT/DELETE
|
||||
- BotProfileManager: custom avatar acts as idle image; cover sync still wins during playback when avatarEnabled=true
|
||||
- AvatarUpload component used in create-bot form and Settings per-bot row
|
||||
- Bump express.json limit to 400kb to allow base64 payload
|
||||
|
||||
## Behavior matrix
|
||||
| avatarEnabled | custom set | playing | stopped |
|
||||
|---|---|---|---|
|
||||
| ✓ | ✓ | cover | restore custom |
|
||||
| ✓ | ✗ | cover | clear |
|
||||
| ✗ | ✓ | custom | custom |
|
||||
| ✗ | ✗ | no-op | no-op |
|
||||
|
||||
## Test plan
|
||||
- [x] vitest covers DB, avatar store, ProfileManager precedence
|
||||
- [x] Manual: upload PNG → bot avatar shows; play song → cover; stop → custom; delete → cleared
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.com/claude-code)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Review Checklist
|
||||
|
||||
- [x] Each spec section has at least one task: precedence matrix → Task 3; storage → Task 2; DB → Task 1; API → Task 5; UI → Task 6+7
|
||||
- [x] No "TBD" / "fill in" / "implement later" text in any step
|
||||
- [x] Type names consistent: `AvatarStore` / `createAvatarStore` / `getCustomAvatarPath` / `setCustomAvatarPath` / `setCustomAvatar` (singular per call site)
|
||||
- [x] All code blocks compile under existing TS/Vue config (express 5, vitest, vue 3 + iconify already in use)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,811 @@
|
||||
# Account Permissions Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Let an admin grant each member account a set of capabilities and a list of bots they may control, enforced on the backend.
|
||||
|
||||
**Architecture:** Capability tokens + per-member bot allow-list stored in two new SQLite tables, loaded onto `req.user` per request (live, no re-login), enforced by `requirePermission` / `requireBotAccess` middleware mirroring the existing `requireAdmin`. Admin stays a super-user. Existing members are backfilled to full access on upgrade; new members get a basic tier. The Vue UI hides what a member can't do and gives admins a permission editor.
|
||||
|
||||
**Tech Stack:** Node ESM + TypeScript, Express, better-sqlite3, Vitest + supertest, Vue 3 + Pinia.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-05-30-account-permissions-design.md`
|
||||
|
||||
**Conventions:** All file paths are repo-relative. Tests run with `npx vitest run <path>`. Backend is TDD (test first, watch fail, implement, watch pass, commit). Commit after each task.
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
**Create:**
|
||||
- `src/data/permissions.ts` — capability constants + `PermissionStore` (tables accessed here)
|
||||
- `src/data/permissions.test.ts` — store + constants tests
|
||||
- `src/web/middleware/requirePermission.ts` — `requirePermission(cap)` + `requireBotAccess(param)`
|
||||
- `src/web/middleware/requirePermission.test.ts` — middleware tests
|
||||
|
||||
**Modify:**
|
||||
- `src/data/database.ts` — `initTables`: add the two tables + index; migration backfill of existing members
|
||||
- `src/data/audit.ts` — add `"user.permissions_changed"` to `AuditAction`
|
||||
- `src/web/middleware/requireAuth.ts` — widen `req.user`; load capabilities + bot access
|
||||
- `src/web/auth/validateSession.ts` — (no change; just confirm) — actually unchanged
|
||||
- `src/web/api/session.ts` — `/me` returns capabilities + bots; inline auth attaches them
|
||||
- `src/web/server.ts` — construct `PermissionStore`, pass into routers/middleware
|
||||
- `src/web/api/player.ts` — `requireBotAccess` on `/:botId`; per-route `requirePermission`
|
||||
- `src/web/api/bot.ts` — `requirePermission("bot.manage")` + `requireBotAccess("id")`
|
||||
- `src/web/api/auth.ts` — `requirePermission("platform.auth")`
|
||||
- `src/web/api/music.ts` — `requirePermission("quality")` on the quality POST; filter `GET /api/bot`? no — bot list is in bot.ts
|
||||
- `src/web/api/bot.ts` — filter `GET /` to allowed bots for members
|
||||
- `src/web/api/users.ts` — `GET/PUT /api/users/:id/permissions`
|
||||
- `src/bot/manager.ts` — `removeBot` calls `permissions.pruneBot(botId)`
|
||||
- Frontend: `web/src/composables/useSession.ts`, `web/src/components/Navbar.vue`, `web/src/components/Player.vue`, `web/src/views/Settings.vue`, `web/src/stores/player.ts`
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Capability constants + PermissionStore + tables
|
||||
|
||||
**Files:**
|
||||
- Create: `src/data/permissions.ts`
|
||||
- Create: `src/data/permissions.test.ts`
|
||||
- Modify: `src/data/database.ts` (initTables)
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
|
||||
`src/data/permissions.test.ts`:
|
||||
|
||||
```typescript
|
||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import os from "node:os";
|
||||
import { createDatabase, type BotDatabase } from "./database.js";
|
||||
import { createPermissionStore } from "./permissions.js";
|
||||
import { CAPABILITIES, BASIC_TIER_CAPABILITIES } from "./permissions.js";
|
||||
|
||||
describe("PermissionStore", () => {
|
||||
let dbFile: string;
|
||||
let db: BotDatabase;
|
||||
|
||||
beforeEach(() => {
|
||||
dbFile = path.join(os.tmpdir(), `perm-test-${Date.now()}-${Math.random().toString(36).slice(2)}.db`);
|
||||
db = createDatabase(dbFile);
|
||||
// a user row is required for FK; insert directly
|
||||
db.db.prepare(
|
||||
"INSERT INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES (?,?,?,?,?,?)"
|
||||
).run("u1", "alice", "x", Date.now(), Date.now(), "member");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
db.close();
|
||||
try { fs.rmSync(dbFile, { force: true }); } catch {}
|
||||
try { fs.rmSync(dbFile + "-wal", { force: true }); } catch {}
|
||||
try { fs.rmSync(dbFile + "-shm", { force: true }); } catch {}
|
||||
});
|
||||
|
||||
it("exposes the five capability tokens and a basic tier", () => {
|
||||
expect(CAPABILITIES).toEqual([
|
||||
"player.control", "player.queue", "bot.manage", "platform.auth", "quality",
|
||||
]);
|
||||
expect(BASIC_TIER_CAPABILITIES).toEqual(["player.control", "player.queue"]);
|
||||
});
|
||||
|
||||
it("defaults to no capabilities and no bots", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
expect(store.getCapabilities("u1")).toEqual([]);
|
||||
expect(store.getBotAccess("u1")).toEqual([]);
|
||||
});
|
||||
|
||||
it("round-trips capabilities and a specific bot list", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control", "quality"], bots: ["botA", "botB"] });
|
||||
expect(store.getCapabilities("u1").sort()).toEqual(["player.control", "quality"]);
|
||||
expect(store.getBotAccess("u1")).toEqual(["botA", "botB"]);
|
||||
});
|
||||
|
||||
it("stores the all-bots flag as 'all'", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control"], bots: "all" });
|
||||
expect(store.getBotAccess("u1")).toBe("all");
|
||||
});
|
||||
|
||||
it("setPermissions replaces prior capabilities and bots", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control"], bots: ["botA"] });
|
||||
store.setPermissions("u1", { capabilities: ["quality"], bots: "all" });
|
||||
expect(store.getCapabilities("u1")).toEqual(["quality"]);
|
||||
expect(store.getBotAccess("u1")).toBe("all");
|
||||
});
|
||||
|
||||
it("ignores unknown capability tokens", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control", "bogus" as any], bots: [] });
|
||||
expect(store.getCapabilities("u1")).toEqual(["player.control"]);
|
||||
});
|
||||
|
||||
it("pruneBot removes a bot from every user's allow-list", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: [], bots: ["botA", "botB"] });
|
||||
store.pruneBot("botA");
|
||||
expect(store.getBotAccess("u1")).toEqual(["botB"]);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/data/permissions.test.ts`
|
||||
Expected: FAIL — `createPermissionStore` / `CAPABILITIES` not found (module missing).
|
||||
|
||||
- [ ] **Step 3: Create `src/data/permissions.ts`**
|
||||
|
||||
```typescript
|
||||
import type Database from "better-sqlite3";
|
||||
|
||||
export const CAPABILITIES = [
|
||||
"player.control",
|
||||
"player.queue",
|
||||
"bot.manage",
|
||||
"platform.auth",
|
||||
"quality",
|
||||
] as const;
|
||||
export type Capability = (typeof CAPABILITIES)[number];
|
||||
|
||||
/** Marker token stored in user_permissions meaning "all bots, incl. future". */
|
||||
export const BOTS_ALL = "bots.all";
|
||||
|
||||
/** Capabilities granted to a newly-created member by default. */
|
||||
export const BASIC_TIER_CAPABILITIES: Capability[] = ["player.control", "player.queue"];
|
||||
|
||||
export function isCapability(x: string): x is Capability {
|
||||
return (CAPABILITIES as readonly string[]).includes(x);
|
||||
}
|
||||
|
||||
export type BotAccess = "all" | string[];
|
||||
|
||||
export interface PermissionStore {
|
||||
getCapabilities(userId: string): Capability[];
|
||||
getBotAccess(userId: string): BotAccess;
|
||||
setPermissions(userId: string, input: { capabilities: string[]; bots: BotAccess }): void;
|
||||
pruneBot(botId: string): void;
|
||||
}
|
||||
|
||||
export function createPermissionStore(db: Database.Database): PermissionStore {
|
||||
const selCaps = db.prepare("SELECT permission FROM user_permissions WHERE userId = ?");
|
||||
const delCaps = db.prepare("DELETE FROM user_permissions WHERE userId = ?");
|
||||
const insCap = db.prepare("INSERT OR IGNORE INTO user_permissions (userId, permission) VALUES (?, ?)");
|
||||
const selBots = db.prepare("SELECT botId FROM user_bot_access WHERE userId = ?");
|
||||
const delBots = db.prepare("DELETE FROM user_bot_access WHERE userId = ?");
|
||||
const insBot = db.prepare("INSERT OR IGNORE INTO user_bot_access (userId, botId) VALUES (?, ?)");
|
||||
const pruneBotStmt = db.prepare("DELETE FROM user_bot_access WHERE botId = ?");
|
||||
|
||||
return {
|
||||
getCapabilities(userId) {
|
||||
return (selCaps.all(userId) as { permission: string }[])
|
||||
.map((r) => r.permission)
|
||||
.filter((p): p is Capability => isCapability(p));
|
||||
},
|
||||
getBotAccess(userId) {
|
||||
const all = (selCaps.all(userId) as { permission: string }[]).some((r) => r.permission === BOTS_ALL);
|
||||
if (all) return "all";
|
||||
return (selBots.all(userId) as { botId: string }[]).map((r) => r.botId);
|
||||
},
|
||||
setPermissions(userId, input) {
|
||||
const caps = input.capabilities.filter(isCapability);
|
||||
const tx = db.transaction(() => {
|
||||
delCaps.run(userId);
|
||||
delBots.run(userId);
|
||||
for (const c of caps) insCap.run(userId, c);
|
||||
if (input.bots === "all") {
|
||||
insCap.run(userId, BOTS_ALL);
|
||||
} else {
|
||||
for (const b of input.bots) insBot.run(userId, b);
|
||||
}
|
||||
});
|
||||
tx();
|
||||
},
|
||||
pruneBot(botId) {
|
||||
pruneBotStmt.run(botId);
|
||||
},
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Add tables in `src/data/database.ts` initTables**
|
||||
|
||||
Find `initTables` (creates users/sessions/user_audit). Add, after the `user_audit` CREATE:
|
||||
|
||||
```typescript
|
||||
db.exec(`
|
||||
CREATE TABLE IF NOT EXISTS user_permissions (
|
||||
userId TEXT NOT NULL,
|
||||
permission TEXT NOT NULL,
|
||||
PRIMARY KEY (userId, permission),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS user_bot_access (
|
||||
userId TEXT NOT NULL,
|
||||
botId TEXT NOT NULL,
|
||||
PRIMARY KEY (userId, botId),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_user_bot_access_userId ON user_bot_access(userId);
|
||||
`);
|
||||
```
|
||||
|
||||
(If `initTables` uses individual `db.exec` calls, match that style. The `BotDatabase` type already exposes `.db` and `.close()` — confirm by reading the file; the test uses `db.db` and `db.close()`.)
|
||||
|
||||
- [ ] **Step 5: Run tests to verify they pass**
|
||||
|
||||
Run: `npx vitest run src/data/permissions.test.ts`
|
||||
Expected: PASS (7 tests).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/data/permissions.ts src/data/permissions.test.ts src/data/database.ts
|
||||
git commit -m "feat(perm): permission store + capability tokens + tables"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 2: requirePermission + requireBotAccess middleware
|
||||
|
||||
**Files:**
|
||||
- Create: `src/web/middleware/requirePermission.ts`
|
||||
- Create: `src/web/middleware/requirePermission.test.ts`
|
||||
- Modify: `src/web/middleware/requireAuth.ts` (widen `req.user`)
|
||||
|
||||
- [ ] **Step 1: Widen the `req.user` augmentation in `src/web/middleware/requireAuth.ts`**
|
||||
|
||||
Change the `declare module` block so `req.user` carries capabilities + bot access:
|
||||
|
||||
```typescript
|
||||
declare module "express-serve-static-core" {
|
||||
interface Request {
|
||||
user?: {
|
||||
id: string;
|
||||
username: string;
|
||||
role: "admin" | "member";
|
||||
capabilities: Set<string>;
|
||||
bots: "all" | Set<string>;
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
(The loading of these fields is done in Task 4 — for now this only widens the type. Existing assignments to `req.user` will fail to typecheck until Task 4; that is expected and Task 4 fixes them. If you need the build green between tasks, do Task 2 + Task 4 back-to-back before running `tsc`.)
|
||||
|
||||
- [ ] **Step 2: Write the failing middleware test**
|
||||
|
||||
`src/web/middleware/requirePermission.test.ts`:
|
||||
|
||||
```typescript
|
||||
import { describe, it, expect } from "vitest";
|
||||
import express from "express";
|
||||
import request from "supertest";
|
||||
import { requirePermission, requireBotAccess } from "./requirePermission.js";
|
||||
|
||||
function appWith(user: any) {
|
||||
const app = express();
|
||||
app.use((req, _res, next) => { (req as any).user = user; next(); });
|
||||
app.post("/cap", requirePermission("quality"), (_req, res) => res.json({ ok: true }));
|
||||
app.post("/bot/:botId", requireBotAccess("botId"), (_req, res) => res.json({ ok: true }));
|
||||
return app;
|
||||
}
|
||||
|
||||
const member = (caps: string[], bots: "all" | string[]) => ({
|
||||
id: "u1", username: "a", role: "member",
|
||||
capabilities: new Set(caps), bots: bots === "all" ? "all" : new Set(bots),
|
||||
});
|
||||
const admin = { id: "a", username: "admin", role: "admin", capabilities: new Set(), bots: "all" };
|
||||
|
||||
describe("requirePermission", () => {
|
||||
it("401 when unauthenticated", async () => {
|
||||
const app = express();
|
||||
app.post("/cap", requirePermission("quality"), (_r, res) => res.json({ ok: true }));
|
||||
expect((await request(app).post("/cap")).status).toBe(401);
|
||||
});
|
||||
it("403 when member lacks the capability", async () => {
|
||||
expect((await request(appWith(member([], "all"))).post("/cap")).status).toBe(403);
|
||||
});
|
||||
it("200 when member has the capability", async () => {
|
||||
expect((await request(appWith(member(["quality"], "all"))).post("/cap")).status).toBe(200);
|
||||
});
|
||||
it("200 for admin regardless of capabilities", async () => {
|
||||
expect((await request(appWith(admin)).post("/cap")).status).toBe(200);
|
||||
});
|
||||
});
|
||||
|
||||
describe("requireBotAccess", () => {
|
||||
it("200 when bots = all", async () => {
|
||||
expect((await request(appWith(member([], "all"))).post("/bot/b1")).status).toBe(200);
|
||||
});
|
||||
it("200 when botId in allow-list", async () => {
|
||||
expect((await request(appWith(member([], ["b1"]))).post("/bot/b1")).status).toBe(200);
|
||||
});
|
||||
it("403 when botId not in allow-list", async () => {
|
||||
expect((await request(appWith(member([], ["b2"]))).post("/bot/b1")).status).toBe(403);
|
||||
});
|
||||
it("200 for admin", async () => {
|
||||
expect((await request(appWith(admin)).post("/bot/b1")).status).toBe(200);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Run test to verify it fails**
|
||||
|
||||
Run: `npx vitest run src/web/middleware/requirePermission.test.ts`
|
||||
Expected: FAIL — module `./requirePermission.js` not found.
|
||||
|
||||
- [ ] **Step 4: Create `src/web/middleware/requirePermission.ts`**
|
||||
|
||||
```typescript
|
||||
import type { Request, Response, NextFunction, RequestHandler } from "express";
|
||||
|
||||
export function requirePermission(capability: string): RequestHandler {
|
||||
return (req: Request, res: Response, next: NextFunction) => {
|
||||
if (!req.user) { res.status(401).json({ error: "unauthenticated" }); return; }
|
||||
if (req.user.role === "admin" || req.user.capabilities.has(capability)) { next(); return; }
|
||||
res.status(403).json({ error: "forbidden" });
|
||||
};
|
||||
}
|
||||
|
||||
export function requireBotAccess(paramName = "botId"): RequestHandler {
|
||||
return (req: Request, res: Response, next: NextFunction) => {
|
||||
if (!req.user) { res.status(401).json({ error: "unauthenticated" }); return; }
|
||||
if (req.user.role === "admin" || req.user.bots === "all") { next(); return; }
|
||||
const botId = req.params[paramName];
|
||||
if (botId && req.user.bots.has(botId)) { next(); return; }
|
||||
res.status(403).json({ error: "forbidden" });
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Run test to verify it passes**
|
||||
|
||||
Run: `npx vitest run src/web/middleware/requirePermission.test.ts`
|
||||
Expected: PASS (8 tests).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/web/middleware/requirePermission.ts src/web/middleware/requirePermission.test.ts src/web/middleware/requireAuth.ts
|
||||
git commit -m "feat(perm): requirePermission + requireBotAccess middleware"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 3: Effective-permissions resolver (admin = all)
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/data/permissions.ts` (add `resolveContext` helper)
|
||||
- Modify: `src/data/permissions.test.ts` (add tests)
|
||||
|
||||
- [ ] **Step 1: Add failing tests** to `src/data/permissions.test.ts`:
|
||||
|
||||
```typescript
|
||||
import { resolvePermissionContext } from "./permissions.js";
|
||||
|
||||
describe("resolvePermissionContext", () => {
|
||||
it("admin gets all capabilities and all bots regardless of stored rows", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
const ctx = resolvePermissionContext("admin", "u1", store);
|
||||
expect([...ctx.capabilities].sort()).toEqual([...CAPABILITIES].sort());
|
||||
expect(ctx.bots).toBe("all");
|
||||
});
|
||||
it("member reflects stored capabilities + bot access", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control"], bots: ["b1"] });
|
||||
const ctx = resolvePermissionContext("member", "u1", store);
|
||||
expect([...ctx.capabilities]).toEqual(["player.control"]);
|
||||
expect(ctx.bots).toEqual(new Set(["b1"]));
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run to verify fail**
|
||||
|
||||
Run: `npx vitest run src/data/permissions.test.ts`
|
||||
Expected: FAIL — `resolvePermissionContext` not exported.
|
||||
|
||||
- [ ] **Step 3: Add to `src/data/permissions.ts`**
|
||||
|
||||
```typescript
|
||||
export interface PermissionContext {
|
||||
capabilities: Set<string>;
|
||||
bots: "all" | Set<string>;
|
||||
}
|
||||
|
||||
export function resolvePermissionContext(
|
||||
role: "admin" | "member",
|
||||
userId: string,
|
||||
store: PermissionStore
|
||||
): PermissionContext {
|
||||
if (role === "admin") {
|
||||
return { capabilities: new Set(CAPABILITIES), bots: "all" };
|
||||
}
|
||||
const access = store.getBotAccess(userId);
|
||||
return {
|
||||
capabilities: new Set(store.getCapabilities(userId)),
|
||||
bots: access === "all" ? "all" : new Set(access),
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run to verify pass**
|
||||
|
||||
Run: `npx vitest run src/data/permissions.test.ts`
|
||||
Expected: PASS.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/data/permissions.ts src/data/permissions.test.ts
|
||||
git commit -m "feat(perm): resolvePermissionContext (admin = super-user)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 4: Load permissions onto req.user (requireAuth + session inline + /me)
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/middleware/requireAuth.ts`
|
||||
- Modify: `src/web/api/session.ts`
|
||||
- Modify: `src/web/server.ts`
|
||||
|
||||
- [ ] **Step 1: Thread `PermissionStore` into `createRequireAuth`**
|
||||
|
||||
`src/web/middleware/requireAuth.ts` — change the factory signature and set the new fields:
|
||||
|
||||
```typescript
|
||||
import { resolvePermissionContext, type PermissionStore } from "../../data/permissions.js";
|
||||
|
||||
export function createRequireAuth(sessions: SessionStore, permissions: PermissionStore): RequestHandler {
|
||||
return function requireAuth(req, res, next) {
|
||||
const result = validateSessionFromHeaders(req.headers.cookie, sessions);
|
||||
if (!result) {
|
||||
res.clearCookie(SESSION_COOKIE_NAME, { path: "/" });
|
||||
res.status(401).json({ error: "unauthenticated" });
|
||||
return;
|
||||
}
|
||||
const ctx = resolvePermissionContext(result.role, result.userId, permissions);
|
||||
req.user = {
|
||||
id: result.userId, username: result.username, role: result.role,
|
||||
capabilities: ctx.capabilities, bots: ctx.bots,
|
||||
};
|
||||
const token = extractSessionToken(req.headers.cookie);
|
||||
if (token) {
|
||||
res.cookie(SESSION_COOKIE_NAME, token, {
|
||||
httpOnly: true, sameSite: "lax", secure: req.secure, path: "/", maxAge: SESSION_TTL_MS,
|
||||
});
|
||||
}
|
||||
next();
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Update `src/web/server.ts`**
|
||||
|
||||
Construct the store next to the others and pass it in:
|
||||
|
||||
```typescript
|
||||
import { createPermissionStore } from "../data/permissions.js";
|
||||
// ...
|
||||
const permissions = createPermissionStore(options.database.db);
|
||||
// ...
|
||||
const requireAuth = createRequireAuth(sessions, permissions);
|
||||
```
|
||||
|
||||
Keep `permissions` in scope — it's passed to routers in Tasks 5–7.
|
||||
|
||||
- [ ] **Step 3: Update session inline auth + `/me` in `src/web/api/session.ts`**
|
||||
|
||||
`createSessionRouter` must accept `permissions` and (a) attach capabilities in `requireAuthInline`, (b) include them in `/me`. Pass `permissions` from `server.ts` into `createSessionRouter(users, sessions, audit, logger, permissions)`. In the `/me` handler, return:
|
||||
|
||||
```typescript
|
||||
const ctx = resolvePermissionContext(validation.role, validation.userId, permissions);
|
||||
res.json({
|
||||
id: validation.userId, username: validation.username, role: validation.role,
|
||||
capabilities: [...ctx.capabilities],
|
||||
bots: ctx.bots === "all" ? "all" : [...ctx.bots],
|
||||
});
|
||||
```
|
||||
|
||||
(Match the existing `/me` shape; just add `capabilities` + `bots`. Read the file to find the exact response object.)
|
||||
|
||||
- [ ] **Step 4: Verify build + existing tests**
|
||||
|
||||
Run: `npx tsc --noEmit`
|
||||
Expected: exit 0 (the widened `req.user` is now populated everywhere it's read).
|
||||
|
||||
Run: `npx vitest run src/web`
|
||||
Expected: PASS (existing auth/session/csrf tests still green; if a test constructs `createRequireAuth(sessions)` it must be updated to pass a `createPermissionStore(db)`).
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/web/middleware/requireAuth.ts src/web/server.ts src/web/api/session.ts
|
||||
git commit -m "feat(perm): load capabilities + bot access onto req.user; expose via /me"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 5: Enforce capabilities on the action routes
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/api/player.ts`, `src/web/api/bot.ts`, `src/web/api/auth.ts`, `src/web/api/music.ts`
|
||||
- Modify: `src/web/api/player.test.ts` (or create `src/web/api/permissions-enforcement.test.ts`)
|
||||
|
||||
- [ ] **Step 1: Write a failing integration test** at `src/web/api/permissions-enforcement.test.ts` that builds the real app (or the relevant router) with a stubbed `req.user` and asserts:
|
||||
- member without `player.control` → `POST /api/player/:botId/pause` → 403
|
||||
- member with `player.control` + bot in allow-list → 200 (bot resolves)
|
||||
- member with `player.control` but bot NOT in allow-list → 403
|
||||
- member without `player.queue` → `POST /api/player/:botId/clear` → 403
|
||||
- member without `bot.manage` → `POST /api/bot` → 403
|
||||
- member without `platform.auth` → `POST /api/auth/cookie` → 403
|
||||
- member without `quality` → `POST /api/music/quality` → 403
|
||||
- admin → all 200/allowed
|
||||
|
||||
Use the same `appWith(user)` injection pattern as Task 2 (insert a middleware that sets `req.user` before the router) and a fake `BotManager`/providers so routes resolve. Model it on the existing `src/web/api/*.test.ts` setup (read one first for the harness).
|
||||
|
||||
- [ ] **Step 2: Run to verify fail** — `npx vitest run src/web/api/permissions-enforcement.test.ts` → FAIL (routes currently allow everyone).
|
||||
|
||||
- [ ] **Step 3: Apply gates.**
|
||||
|
||||
`src/web/api/player.ts` — the shared `/:botId` middleware already resolves the bot. Add bot-access there, and add per-action capability guards. Define the queue-capability routes vs control routes:
|
||||
|
||||
```typescript
|
||||
import { requirePermission, requireBotAccess } from "../middleware/requirePermission.js";
|
||||
|
||||
// after the existing router.use("/:botId", resolveBot):
|
||||
router.use("/:botId", requireBotAccess("botId"));
|
||||
|
||||
const control = requirePermission("player.control");
|
||||
const queue = requirePermission("player.queue");
|
||||
// control: play, pause, resume, next, prev, stop, seek, volume, mode, play-song, play-at, play-by-id, play-playlist, play-album, play-next-song
|
||||
// queue: add, add-song, add-by-id, clear, playlist, /queue/:index (DELETE)
|
||||
// Apply per route, e.g.:
|
||||
router.post("/:botId/pause", control, async (req, res) => { /* existing */ });
|
||||
router.post("/:botId/add", queue, async (req, res) => { /* existing */ });
|
||||
router.delete("/:botId/queue/:index", queue, async (req, res) => { /* existing */ });
|
||||
```
|
||||
|
||||
(Insert the `control`/`queue` middleware as the 2nd arg of each existing `router.post/delete`. Do not change handler bodies. `PUT /:botId/profile` → `requirePermission("bot.manage")`.)
|
||||
|
||||
`src/web/api/bot.ts` — gate management + per-bot:
|
||||
|
||||
```typescript
|
||||
const manage = requirePermission("bot.manage");
|
||||
router.post("/", manage, ...); // create (no botId)
|
||||
router.put("/:id", manage, requireBotAccess("id"), ...);
|
||||
router.delete("/:id", manage, requireBotAccess("id"), ...);
|
||||
router.post("/:id/start", manage, requireBotAccess("id"), ...);
|
||||
router.post("/:id/stop", manage, requireBotAccess("id"), ...);
|
||||
router.put("/:id/avatar", manage, requireBotAccess("id"), ...);
|
||||
router.delete("/:id/avatar", manage, requireBotAccess("id"), ...);
|
||||
router.post("/settings", manage, ...); // global idle timeout
|
||||
```
|
||||
|
||||
`src/web/api/auth.ts` — gate every mutating route with `requirePermission("platform.auth")`:
|
||||
`POST /qrcode`, `POST /sms/send`, `POST /sms/verify`, `POST /cookie`. (Leave `GET /status`, `GET /qrcode/status` open — read-only.)
|
||||
|
||||
`src/web/api/music.ts` — gate the one mutating route:
|
||||
`router.post("/quality", requirePermission("quality"), ...)`.
|
||||
|
||||
- [ ] **Step 4: Run to verify pass** — `npx vitest run src/web/api/permissions-enforcement.test.ts` → PASS. Then `npx vitest run src/web` → all green.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/web/api/player.ts src/web/api/bot.ts src/web/api/auth.ts src/web/api/music.ts src/web/api/permissions-enforcement.test.ts
|
||||
git commit -m "feat(perm): enforce capabilities + bot access on action routes"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 6: Filter the bot list for members
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/api/bot.ts` (`GET /`)
|
||||
- Modify: `src/bot/manager.ts` (`removeBot` → `permissions.pruneBot`)
|
||||
- Modify: test from Task 5
|
||||
|
||||
- [ ] **Step 1: Add failing test** — member with `bots: ["b1"]` calling `GET /api/bot` sees only `b1`; admin sees all.
|
||||
|
||||
- [ ] **Step 2: Run → fail.**
|
||||
|
||||
- [ ] **Step 3: Implement.** In `GET /` of `bot.ts`:
|
||||
|
||||
```typescript
|
||||
const all = getAllBots().map((b) => b.getStatus());
|
||||
const u = req.user!;
|
||||
const bots = u.role === "admin" || u.bots === "all"
|
||||
? all
|
||||
: all.filter((b) => (u.bots as Set<string>).has(b.id));
|
||||
res.json({ bots });
|
||||
```
|
||||
|
||||
In `src/bot/manager.ts`, give `BotManager` access to the `PermissionStore` (constructor param) and call `this.permissions.pruneBot(id)` inside `removeBot(id)` after deletion, so deleted bots drop out of allow-lists. Thread `permissions` from `index.ts`/`server.ts` into `BotManager`.
|
||||
|
||||
- [ ] **Step 4: Run → pass; `npx vitest run src/web src/bot` green.**
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/web/api/bot.ts src/bot/manager.ts src/web/api/permissions-enforcement.test.ts
|
||||
git commit -m "feat(perm): filter GET /api/bot to allowed bots; prune access on bot delete"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 7: Management API (GET/PUT permissions) + audit
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/data/audit.ts` (add action)
|
||||
- Modify: `src/web/api/users.ts` (+ permissions endpoints; new-member default)
|
||||
- Modify: `src/web/server.ts` (pass `permissions` into `createUsersRouter`)
|
||||
- Create/extend: `src/web/api/users.test.ts`
|
||||
|
||||
- [ ] **Step 1: Add `"user.permissions_changed"`** to the `AuditAction` union in `src/data/audit.ts`.
|
||||
|
||||
- [ ] **Step 2: Write failing tests** for the users router (admin-only):
|
||||
- `GET /api/users/:id/permissions` → `{ capabilities: [], bots: [] }` for a fresh member.
|
||||
- `PUT /api/users/:id/permissions` with `{capabilities:["player.control"], bots:"all"}` → 200; subsequent GET reflects it; an audit row `user.permissions_changed` exists.
|
||||
- `PUT` with an unknown capability token → it is dropped (not stored).
|
||||
- New member created via `POST /api/users` → GET permissions returns basic tier (`["player.control","player.queue"]`, bots `"all"`).
|
||||
|
||||
- [ ] **Step 3: Run → fail.**
|
||||
|
||||
- [ ] **Step 4: Implement** in `src/web/api/users.ts` (router already admin-gated at mount). Accept `permissions: PermissionStore` param. Add:
|
||||
|
||||
```typescript
|
||||
import { CAPABILITIES, isCapability, BASIC_TIER_CAPABILITIES } from "../../data/permissions.js";
|
||||
|
||||
router.get("/:id/permissions", (req, res) => {
|
||||
const user = users.findById(req.params.id);
|
||||
if (!user) { res.status(404).json({ error: "not_found" }); return; }
|
||||
res.json({ capabilities: permissions.getCapabilities(user.id), bots: permissions.getBotAccess(user.id) });
|
||||
});
|
||||
|
||||
router.put("/:id/permissions", (req, res) => {
|
||||
const user = users.findById(req.params.id);
|
||||
if (!user) { res.status(404).json({ error: "not_found" }); return; }
|
||||
const body = req.body ?? {};
|
||||
const caps = Array.isArray(body.capabilities) ? body.capabilities.filter(isCapability) : [];
|
||||
const bots = body.bots === "all" ? "all" : (Array.isArray(body.bots) ? body.bots.map(String) : []);
|
||||
permissions.setPermissions(user.id, { capabilities: caps, bots });
|
||||
audit.record({
|
||||
actorId: req.user!.id, actorUsername: req.user!.username,
|
||||
targetUserId: user.id, targetUsername: user.username,
|
||||
action: "user.permissions_changed",
|
||||
});
|
||||
res.json({ success: true });
|
||||
});
|
||||
```
|
||||
|
||||
In the existing `POST /api/users` handler, after creating a member, seed the basic tier:
|
||||
|
||||
```typescript
|
||||
if (created.role === "member") {
|
||||
permissions.setPermissions(created.id, { capabilities: BASIC_TIER_CAPABILITIES, bots: "all" });
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Run → pass; `npx vitest run src/web` green.**
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add src/data/audit.ts src/web/api/users.ts src/web/server.ts src/web/api/users.test.ts
|
||||
git commit -m "feat(perm): admin permissions API + audit + new-member basic tier"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 8: One-time migration backfill (existing members → full)
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/data/database.ts` (`migrateSchema` or a dedicated backfill)
|
||||
- Create: `src/data/permissions-migration.test.ts`
|
||||
|
||||
- [ ] **Step 1: Write failing test** — given a fresh db with an existing `member` user and NO permission rows, after `createDatabase()` runs the backfill, that member has all 5 capabilities + `bots.all`; an `admin` user gets nothing (bypasses). Backfill is idempotent (running twice does not duplicate / does not re-grant a member who was later restricted to empty).
|
||||
|
||||
Idempotency approach: store a one-shot marker. Use a `meta` row or check: only backfill members who currently have ZERO permission rows AND only on first introduction. Simplest robust marker: a row in a tiny `schema_meta(key TEXT PK, value TEXT)` table, key `perm_backfill_done`. If present, skip.
|
||||
|
||||
- [ ] **Step 2: Run → fail.**
|
||||
|
||||
- [ ] **Step 3: Implement** a `backfillMemberPermissions(db)` run once inside `createDatabase` after `initTables`:
|
||||
|
||||
```typescript
|
||||
db.exec(`CREATE TABLE IF NOT EXISTS schema_meta (key TEXT PRIMARY KEY, value TEXT)`);
|
||||
const done = db.prepare("SELECT value FROM schema_meta WHERE key = 'perm_backfill_done'").get();
|
||||
if (!done) {
|
||||
const members = db.prepare("SELECT id FROM users WHERE role = 'member'").all() as { id: string }[];
|
||||
const insCap = db.prepare("INSERT OR IGNORE INTO user_permissions (userId, permission) VALUES (?, ?)");
|
||||
const tx = db.transaction(() => {
|
||||
for (const m of members) {
|
||||
for (const c of ["player.control","player.queue","bot.manage","platform.auth","quality","bots.all"]) {
|
||||
insCap.run(m.id, c);
|
||||
}
|
||||
}
|
||||
db.prepare("INSERT INTO schema_meta (key, value) VALUES ('perm_backfill_done', ?)").run(String(Date.now()));
|
||||
});
|
||||
tx();
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run → pass.**
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add src/data/database.ts src/data/permissions-migration.test.ts
|
||||
git commit -m "feat(perm): one-time backfill of existing members to full access"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 9: Frontend — session capabilities + helpers
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/composables/useSession.ts`
|
||||
|
||||
- [ ] **Step 1:** Extend the `User` type with `capabilities: string[]` and `bots: 'all' | string[]`; populate from `/api/session/me`, `/login`, `/setup` responses (the backend now returns them).
|
||||
- [ ] **Step 2:** Add computed helpers:
|
||||
|
||||
```typescript
|
||||
function can(cap: string): boolean {
|
||||
const u = currentUser.value;
|
||||
return !!u && (u.role === 'admin' || (u.capabilities ?? []).includes(cap));
|
||||
}
|
||||
function canControlBot(botId: string): boolean {
|
||||
const u = currentUser.value;
|
||||
if (!u) return false;
|
||||
if (u.role === 'admin' || u.bots === 'all') return true;
|
||||
return Array.isArray(u.bots) && u.bots.includes(botId);
|
||||
}
|
||||
```
|
||||
|
||||
Export `can` and `canControlBot` from the composable.
|
||||
|
||||
- [ ] **Step 3:** Manual check: log in as admin → `can('quality')` true; (after backend done) a restricted member → false. Build: `cd web && npx vue-tsc --noEmit`.
|
||||
- [ ] **Step 4: Commit** `git add web/src/composables/useSession.ts && git commit -m "feat(perm): frontend session capabilities + can()/canControlBot()"`
|
||||
|
||||
---
|
||||
|
||||
## Task 10: Frontend — gate UI by capability + filter bots
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/components/Navbar.vue`, `web/src/components/Player.vue`, `web/src/views/Settings.vue`, `web/src/stores/player.ts`
|
||||
|
||||
- [ ] **Step 1:** Navbar bot selector: render only controllable bots — `v-for="bot in store.bots"` becomes a filtered computed `controllableBots = store.bots.filter(b => session.canControlBot(b.id))`. (The backend already filters `GET /api/bot`, so this is belt-and-suspenders + correctness if both lists diverge.) Ensure `store.activeBot` fallback never lands on a bot the user can't control.
|
||||
- [ ] **Step 2:** Player.vue: wrap control buttons with `v-if="session.can('player.control')"` and queue actions with `v-if="session.can('player.queue')"`.
|
||||
- [ ] **Step 3:** Settings.vue: wrap the platform login cards with `v-if="session.can('platform.auth')"`, the audio-quality control with `v-if="session.can('quality')"`, and bot create/edit/delete with `v-if="session.can('bot.manage')"`.
|
||||
- [ ] **Step 4:** Manual verification (see Verification section). Build: `cd web && npx vue-tsc --noEmit`.
|
||||
- [ ] **Step 5: Commit** `git add web/src/components/Navbar.vue web/src/components/Player.vue web/src/views/Settings.vue web/src/stores/player.ts && git commit -m "feat(perm): hide UI a member lacks capability for"`
|
||||
|
||||
---
|
||||
|
||||
## Task 11: Frontend — admin permission editor
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/views/Settings.vue` (User Management section)
|
||||
|
||||
- [ ] **Step 1:** In each member row of the admin User-Management list, add a "权限" button opening an editor (inline panel or dialog) with: 5 capability checkboxes (labels: 播放控制 / 队列管理 / 机器人管理 / 平台登录凭据 / 音质设置), and a bot allow-list — an "全部机器人" toggle plus, when off, a checkbox per bot from `store.bots`.
|
||||
- [ ] **Step 2:** On open, `GET /api/users/:id/permissions`; on save, `PUT /api/users/:id/permissions` with `{capabilities, bots}` then re-fetch. Admin rows show "全部权限(管理员)" and no editor.
|
||||
- [ ] **Step 3:** Manual verification. Build: `cd web && npx vue-tsc --noEmit`.
|
||||
- [ ] **Step 4: Commit** `git add web/src/views/Settings.vue && git commit -m "feat(perm): admin permission editor in user management"`
|
||||
|
||||
---
|
||||
|
||||
## Final verification
|
||||
|
||||
- [ ] `npx tsc --noEmit` → exit 0
|
||||
- [ ] `npx vitest run src/` → all green (clean-checkout-equivalent; ignore stale `dist/` twins — see note)
|
||||
- [ ] `cd web && npx vue-tsc --noEmit` → exit 0
|
||||
- [ ] `npm run build` → succeeds
|
||||
- [ ] Manual (run the bot, log in): admin sees everything; create a member, restrict to `player.control` on one bot → member sees only that bot, can play/pause but cannot add to queue, cannot open platform login / quality / bot management; backend returns 403 on a forged request to a disallowed action (verify with curl + the member's session cookie).
|
||||
|
||||
> **Note (pre-existing):** `tsconfig.json` compiles `*.test.ts` into `dist/`, and vitest also runs the `dist/` twins after a build — so `npx vitest run` (no path) double-runs and can fail on stale artifacts. Scope verification to `npx vitest run src/`. (A separate cleanup PR could add `exclude: ['**/dist/**']` to a vitest config.)
|
||||
|
||||
## Out of scope (separate PRs, per spec)
|
||||
|
||||
#1 guest mode · #2 dedicated-link bot hiding UX · #3 auto-pause on empty channel · #4 dedicated-link refresh bug.
|
||||
@@ -0,0 +1,196 @@
|
||||
# Auto-pause on Empty Channel — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: superpowers:subagent-driven-development. Steps use checkbox (`- [ ]`) syntax.
|
||||
|
||||
**Goal:** Auto-pause playback when the bot's channel empties (no disconnect) and auto-resume when someone returns — only resuming tracks we auto-paused — gated by the existing global `autoPauseOnEmpty` flag.
|
||||
|
||||
**Architecture:** A pure decision function decides pause/resume from (player state, autoPaused, flag, userCount). `BotInstance` owns an `autoPaused` flag and a `checkChannelOccupancy()` that the existing 30s idle poll AND new TS enter/leave/move events both call. The toggle is wired into `/api/bot/settings` + the Settings UI.
|
||||
|
||||
**Tech:** Node ESM + TS, Vitest, Express, Vue 3.
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-05-30-autopause-empty-channel-design.md`
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Pure occupancy-decision function
|
||||
|
||||
**Files:** Create `src/bot/auto-pause.ts`, `src/bot/auto-pause.test.ts`.
|
||||
|
||||
- [ ] **Step 1 — failing test** `src/bot/auto-pause.test.ts`:
|
||||
|
||||
```typescript
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { decideOccupancyAction } from "./auto-pause.js";
|
||||
|
||||
describe("decideOccupancyAction", () => {
|
||||
// (playerState, autoPaused, enabled, userCount) => "pause" | "resume" | "none"
|
||||
it("pauses when empty while playing and enabled", () => {
|
||||
expect(decideOccupancyAction("playing", false, true, 0)).toBe("pause");
|
||||
});
|
||||
it("does not pause when the feature is disabled", () => {
|
||||
expect(decideOccupancyAction("playing", false, false, 0)).toBe("none");
|
||||
});
|
||||
it("does not pause when idle (nothing playing)", () => {
|
||||
expect(decideOccupancyAction("idle", false, true, 0)).toBe("none");
|
||||
});
|
||||
it("does not pause when already paused", () => {
|
||||
expect(decideOccupancyAction("paused", false, true, 0)).toBe("none");
|
||||
});
|
||||
it("resumes when re-populated and we auto-paused", () => {
|
||||
expect(decideOccupancyAction("paused", true, true, 2)).toBe("resume");
|
||||
});
|
||||
it("does NOT resume a user-paused track on re-population", () => {
|
||||
expect(decideOccupancyAction("paused", false, true, 2)).toBe("none");
|
||||
});
|
||||
it("does nothing when re-populated and already playing", () => {
|
||||
expect(decideOccupancyAction("playing", false, true, 2)).toBe("none");
|
||||
});
|
||||
it("resume is independent of the enabled flag (we already auto-paused)", () => {
|
||||
expect(decideOccupancyAction("paused", true, false, 1)).toBe("resume");
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2 — run, expect fail:** `npx vitest run src/bot/auto-pause.test.ts` → module missing.
|
||||
|
||||
- [ ] **Step 3 — implement** `src/bot/auto-pause.ts`:
|
||||
|
||||
```typescript
|
||||
export type PlayerStateName = "idle" | "playing" | "paused";
|
||||
export type OccupancyAction = "pause" | "resume" | "none";
|
||||
|
||||
/**
|
||||
* Decide what auto-pause should do given the channel occupancy.
|
||||
* - empty (userCount <= 0): pause iff enabled and currently playing.
|
||||
* - re-populated (userCount > 0): resume iff we previously auto-paused and are still paused.
|
||||
* `autoPaused` distinguishes our auto-pause from a user pause, so user pauses are never resumed.
|
||||
*/
|
||||
export function decideOccupancyAction(
|
||||
playerState: PlayerStateName,
|
||||
autoPaused: boolean,
|
||||
enabled: boolean,
|
||||
userCount: number,
|
||||
): OccupancyAction {
|
||||
const empty = userCount <= 0;
|
||||
if (empty) {
|
||||
if (enabled && playerState === "playing") return "pause";
|
||||
return "none";
|
||||
}
|
||||
if (autoPaused && playerState === "paused") return "resume";
|
||||
return "none";
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4 — run, expect pass:** `npx vitest run src/bot/auto-pause.test.ts` → 8 pass.
|
||||
- [ ] **Step 5 — commit:** `git add src/bot/auto-pause.ts src/bot/auto-pause.test.ts && git commit -m "feat(autopause): pure occupancy-decision function"`
|
||||
|
||||
---
|
||||
|
||||
## Task 2: Wire decision into BotInstance (autoPaused flag + checkChannelOccupancy)
|
||||
|
||||
**Files:** Modify `src/bot/instance.ts`.
|
||||
|
||||
Context: `_startIdlePoller` (~lines 190-206) polls every 30s, computes `userCount = (await getClientsInChannel()).length - 1`, and calls `_scheduleIdleCheck()` (empty) / `_cancelIdleTimer()` (occupied). `cmdPause`/`cmdResume` (~484-494), `cmdStop` (~496-505), and the playback start (`cmdPlay`/resolveAndPlay) wrap `player`. There's an unused `channelUserCount` field (~line 68). The instance has `this.config` (BotConfig) and `this.player`.
|
||||
|
||||
- [ ] **Step 1 — add state + helper.** Add a private field `private autoPaused = false;`. Create a method that centralizes occupancy handling and is called with a freshly-computed userCount:
|
||||
|
||||
```typescript
|
||||
import { decideOccupancyAction } from "./auto-pause.js";
|
||||
|
||||
private handleOccupancy(userCount: number): void {
|
||||
// idle-disconnect (unchanged behavior)
|
||||
if (userCount <= 0) this._scheduleIdleCheck();
|
||||
else this._cancelIdleTimer();
|
||||
|
||||
// auto-pause
|
||||
const action = decideOccupancyAction(
|
||||
this.player.getState() as "idle" | "playing" | "paused",
|
||||
this.autoPaused,
|
||||
this.config.autoPauseOnEmpty,
|
||||
userCount,
|
||||
);
|
||||
if (action === "pause") {
|
||||
this.player.pause();
|
||||
this.autoPaused = true;
|
||||
this.emit("stateChange");
|
||||
} else if (action === "resume") {
|
||||
this.player.resume();
|
||||
this.autoPaused = false;
|
||||
this.emit("stateChange");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2 — route the idle poller through it.** In `_startIdlePoller`, replace the inline `userCount`→schedule/cancel logic with: compute `userCount` then `this.handleOccupancy(userCount)`. (Keep the 30s interval + the same getClientsInChannel call + error handling.) Remove the now-redundant inline schedule/cancel branch (it lives in `handleOccupancy`).
|
||||
|
||||
- [ ] **Step 3 — clear autoPaused on user actions + lifecycle.** In `cmdPause`, `cmdResume`, `cmdStop`, and the play-start path (`cmdPlay`/wherever playback (re)starts), set `this.autoPaused = false`. In the `disconnected` handler and on (re)connect, set `this.autoPaused = false`. (These ensure a user pause is never auto-resumed and the flag resets across connections.)
|
||||
|
||||
- [ ] **Step 4 — `updateAutoPause`.** Add (mirrors `updateIdleTimeout`):
|
||||
|
||||
```typescript
|
||||
updateAutoPause(enabled: boolean): void {
|
||||
this.config.autoPauseOnEmpty = enabled;
|
||||
// if turning off, leave current playback as-is; if a track was auto-paused, optionally resume:
|
||||
if (!enabled && this.autoPaused && this.player.getState() === "paused") {
|
||||
this.player.resume();
|
||||
this.autoPaused = false;
|
||||
this.emit("stateChange");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 5 — verify:** `npx tsc --noEmit` → exit 0. `npx vitest run src/bot src/audio` → pass (existing tests unaffected).
|
||||
- [ ] **Step 6 — commit:** `git add src/bot/instance.ts && git commit -m "feat(autopause): drive pause/resume from channel occupancy in BotInstance"`
|
||||
|
||||
---
|
||||
|
||||
## Task 3: Re-emit TS member events for instant reaction
|
||||
|
||||
**Files:** Modify `src/ts-protocol/client.ts`, `src/bot/instance.ts`.
|
||||
|
||||
Context: `client.ts` forwards `textMessage`/`disconnected`/`connected` and only debug-logs `clientEnter` (~lines 219-224); `clientLeave`/`clientMoved` are not handled. `BotInstance.setupTsEvents()` (~lines 132-156) wires tsClient events.
|
||||
|
||||
- [ ] **Step 1 — re-emit in client.ts.** Where `clientEnter` is logged, also `this.emit("clientEnter", info)`. Add subscriptions for `clientLeave` and `clientMoved` that `this.emit(...)` them upward (match the existing forwarding style; just propagate, no payload transformation needed since the instance re-queries).
|
||||
|
||||
- [ ] **Step 2 — react in instance.ts.** In `setupTsEvents()`, add handlers: on `clientEnter` / `clientLeave` / `clientMoved`, call a small `async refreshOccupancy()` that does `const clients = await this.getClientsInChannel(); this.handleOccupancy(clients.length - 1);` (guarded with try/catch + only when connected). This gives near-instant pause/resume; the 30s poll remains the fallback.
|
||||
|
||||
- [ ] **Step 3 — verify:** `npx tsc --noEmit` → 0. `npx vitest run src/bot` → pass.
|
||||
- [ ] **Step 4 — commit:** `git add src/ts-protocol/client.ts src/bot/instance.ts && git commit -m "feat(autopause): re-emit client enter/leave/move for instant pause/resume"`
|
||||
|
||||
---
|
||||
|
||||
## Task 4: API wiring for the toggle
|
||||
|
||||
**Files:** Modify `src/web/api/bot.ts`; add/extend a test.
|
||||
|
||||
Context: `GET /api/bot/settings` returns `{ idleTimeoutMinutes }`; `POST /api/bot/settings` validates `idleTimeoutMinutes`, sets `config.idleTimeoutMinutes`, `saveConfig`, then loops `botManager.getAllBots()` → `bot.updateIdleTimeout(...)`. This route is `requirePermission("bot.manage")`-gated.
|
||||
|
||||
- [ ] **Step 1 — failing API test** (extend the existing bot settings test or add one): `GET /api/bot/settings` returns `autoPauseOnEmpty` (boolean); `POST /api/bot/settings` with `{ autoPauseOnEmpty: false }` persists it (a follow-up GET reflects false) and calls `updateAutoPause` on bots. Model the harness on the existing settings test.
|
||||
|
||||
- [ ] **Step 2 — run, expect fail.**
|
||||
|
||||
- [ ] **Step 3 — implement.** In `GET /settings`, add `autoPauseOnEmpty: options.config.autoPauseOnEmpty` to the response. In `POST /settings`, if `typeof req.body.autoPauseOnEmpty === "boolean"`, set `config.autoPauseOnEmpty`, include it in the `saveConfig`, and loop bots calling `bot.updateAutoPause(config.autoPauseOnEmpty)`. Keep the existing `idleTimeoutMinutes` handling intact (handle both fields in one save).
|
||||
|
||||
- [ ] **Step 4 — verify:** `npx vitest run src/web` → pass; `npx tsc --noEmit` → 0.
|
||||
- [ ] **Step 5 — commit:** `git add src/web/api/bot.ts <test> && git commit -m "feat(autopause): expose autoPauseOnEmpty via /api/bot/settings"`
|
||||
|
||||
---
|
||||
|
||||
## Task 5: Frontend toggle in Settings
|
||||
|
||||
**Files:** Modify `web/src/views/Settings.vue` (and the settings load/save it uses).
|
||||
|
||||
Context: The **行为设置** section (already `v-if="can('bot.manage')"`) holds the idle-timeout control, loaded via `loadIdleTimeout()` (GET /api/bot/settings) and saved via `saveIdleTimeout()` (POST). Read these first.
|
||||
|
||||
- [ ] **Step 1 — implement.** Add an `autoPauseOnEmpty` ref. In the settings load, populate it from the GET response. Add a checkbox/toggle in the 行为设置 section labelled e.g. "频道无人时自动暂停" bound to it, and include `autoPauseOnEmpty` in the POST payload of the save function (alongside `idleTimeoutMinutes`, or via its own save — match the existing pattern). Use existing form/toggle CSS classes.
|
||||
- [ ] **Step 2 — verify:** `cd web && npx vue-tsc --noEmit` → exit 0; read template back for correctness.
|
||||
- [ ] **Step 3 — commit:** `git add web/src/views/Settings.vue && git commit -m "feat(autopause): autoPauseOnEmpty toggle in Settings"`
|
||||
|
||||
---
|
||||
|
||||
## Final verification
|
||||
- [ ] `npx tsc --noEmit` → 0
|
||||
- [ ] `npx vitest run src/` → all pass
|
||||
- [ ] `cd web && npx vue-tsc --noEmit` → 0
|
||||
- [ ] `npm run build` → succeeds
|
||||
- [ ] Manual: with a bot playing, leave its channel → music auto-pauses (no disconnect); rejoin → resumes. Manually pause, leave, rejoin → stays paused. Toggle off in Settings → no auto-pause.
|
||||
@@ -0,0 +1,156 @@
|
||||
# Dedicated-link Bot Scoping (+ refresh fix) — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: superpowers:subagent-driven-development. Steps use checkbox (`- [ ]`) syntax.
|
||||
|
||||
**Goal:** Opening a dedicated link locks the WebUI to that one bot (selector shows only it, switching disabled, with an explicit exit); the lock is carried in the URL (`?bot=<id>`) so it survives refresh — fixing item 4 too.
|
||||
|
||||
**Architecture:** A `scopedBotId` in the Pinia player store is the runtime lock; the URL query `?bot=<id>` is the durable source of truth. A router `beforeEach` syncs scope from the query and re-attaches `?bot` across in-app navigation while scoped. `BotRedirect` seeds it; Navbar renders the lock; graceful clear if the bot doesn't exist.
|
||||
|
||||
**Tech:** Vue 3 + Pinia + vue-router, TypeScript. (Frontend isn't unit-tested in this repo → verify via `vue-tsc` + manual; extract one pure helper to unit-test.)
|
||||
|
||||
**Spec:** `docs/superpowers/specs/2026-05-30-dedicated-link-scope-design.md`
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Store scope state + pure resolve helper (with test)
|
||||
|
||||
**Files:** Modify `web/src/stores/player.ts`; create `web/src/stores/scope.ts` + `web/src/stores/scope.test.ts`.
|
||||
|
||||
READ `web/src/stores/player.ts` first: `activeBotId` state (~line 52), `setActiveBotId` action (~127-133), `fetchBots` (~196-198 default to bots[0]), `activeBot` getter (~73-75), and the localStorage pattern used by `theme` (~175-183) for reference (we are NOT using localStorage, but match code style).
|
||||
|
||||
- [ ] **Step 1 — pure helper + failing test.** Create `web/src/stores/scope.ts`:
|
||||
|
||||
```typescript
|
||||
/** Given the desired scoped id (from ?bot) and the known bot ids, decide the
|
||||
* effective scope. Returns the id if it exists, else null (graceful clear:
|
||||
* a stale/forbidden id never locks the UI). */
|
||||
export function resolveScopedBot(
|
||||
requestedId: string | null | undefined,
|
||||
knownBotIds: readonly string[],
|
||||
): string | null {
|
||||
if (!requestedId) return null;
|
||||
return knownBotIds.includes(requestedId) ? requestedId : null;
|
||||
}
|
||||
```
|
||||
|
||||
`web/src/stores/scope.test.ts`:
|
||||
|
||||
```typescript
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { resolveScopedBot } from "./scope.js";
|
||||
|
||||
describe("resolveScopedBot", () => {
|
||||
it("returns null when no id requested", () => {
|
||||
expect(resolveScopedBot(null, ["a", "b"])).toBeNull();
|
||||
expect(resolveScopedBot(undefined, ["a"])).toBeNull();
|
||||
expect(resolveScopedBot("", ["a"])).toBeNull();
|
||||
});
|
||||
it("returns the id when it exists in the bot list", () => {
|
||||
expect(resolveScopedBot("b", ["a", "b"])).toBe("b");
|
||||
});
|
||||
it("clears (null) when the requested id is not a known bot", () => {
|
||||
expect(resolveScopedBot("ghost", ["a", "b"])).toBeNull();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2 — run, expect fail:** `npx vitest run web/src/stores/scope.test.ts` → module missing.
|
||||
(Note: the repo's vitest runs from root; this test lives under web/. If the root vitest config doesn't include web/src, run it via the web workspace: `cd web && npx vitest run src/stores/scope.test.ts`. Use whichever picks it up; confirm it FAILS first.)
|
||||
|
||||
- [ ] **Step 3 — implement the helper** (code above).
|
||||
|
||||
- [ ] **Step 4 — add scope state to `web/src/stores/player.ts`:**
|
||||
- state: `scopedBotId: null as string | null`.
|
||||
- getter: `isScoped: (state) => state.scopedBotId !== null`.
|
||||
- actions:
|
||||
- `setScope(id: string)` → `this.scopedBotId = id;` and also set `this.activeBotId = id` (scoped == active), then ensure that bot's queue is loaded like `setActiveBotId` does.
|
||||
- `clearScope()` → `this.scopedBotId = null;`.
|
||||
- `applyScopeFromQuery(requestedId: string | null)` → uses `resolveScopedBot(requestedId, this.bots.map(b => b.id))`; if result non-null → `setScope(result)`; if null and a scope was requested → `clearScope()`. (Called after bots are loaded.)
|
||||
- Guard `setActiveBotId(id)`: at the top, `if (this.scopedBotId !== null && id !== this.scopedBotId) return;` so switching is blocked while scoped.
|
||||
|
||||
- [ ] **Step 5 — run helper test, expect pass:** `cd web && npx vitest run src/stores/scope.test.ts` → 3 pass. `cd web && npx vue-tsc --noEmit` → exit 0.
|
||||
|
||||
- [ ] **Step 6 — commit:** `git add web/src/stores/scope.ts web/src/stores/scope.test.ts web/src/stores/player.ts && git commit -m "feat(scope): player store scopedBotId + resolveScopedBot helper"`
|
||||
|
||||
---
|
||||
|
||||
## Task 2: Router guard — sync scope from `?bot` + preserve across navigation
|
||||
|
||||
**Files:** Modify `web/src/router/index.ts`.
|
||||
|
||||
READ the file: the existing `beforeEach` (~lines 36-60) handles needsSetup/auth. Add scope handling AFTER auth resolves (so we don't fight the login redirect). Import the player store (use it inside the guard via `usePlayerStore()` — Pinia is active by the time navigation runs).
|
||||
|
||||
- [ ] **Step 1 — implement.** In `beforeEach`, after the existing auth/needsSetup logic decides the navigation is allowed to proceed to `to` (i.e., not redirecting to /login or /first-run), add:
|
||||
|
||||
```typescript
|
||||
const store = usePlayerStore();
|
||||
const qBot = typeof to.query.bot === "string" ? to.query.bot : null;
|
||||
if (qBot) {
|
||||
// entering/with a scope in the URL — store will validate against bots later
|
||||
store.scopedBotId = qBot; // tentative; applyScopeFromQuery (after fetchBots) confirms/clears
|
||||
return next();
|
||||
}
|
||||
if (store.scopedBotId) {
|
||||
// scoped but this navigation dropped ?bot → re-attach so the lock survives in-app nav + refresh
|
||||
if (to.query.bot !== store.scopedBotId) {
|
||||
return next({ ...to, query: { ...to.query, bot: store.scopedBotId } });
|
||||
}
|
||||
}
|
||||
return next();
|
||||
```
|
||||
|
||||
(Adapt to the file's existing `next()` style — it may use `next(...)`/return. Ensure this runs only for allowed navigations, not when redirecting to /login. The exit action in Task 4 calls `store.clearScope()` BEFORE navigating to `/`, so `store.scopedBotId` is null and the re-attach branch is skipped — that's how exit works.)
|
||||
|
||||
- [ ] **Step 2 — verify:** `cd web && npx vue-tsc --noEmit` → exit 0. Re-read the guard to ensure no redirect loop (when `to.query.bot === store.scopedBotId`, it does NOT redirect again).
|
||||
|
||||
- [ ] **Step 3 — commit:** `git add web/src/router/index.ts && git commit -m "feat(scope): router guard syncs + preserves ?bot across navigation"`
|
||||
|
||||
---
|
||||
|
||||
## Task 3: BotRedirect seeds the URL scope
|
||||
|
||||
**Files:** Modify `web/src/views/BotRedirect.vue`.
|
||||
|
||||
READ it: onMounted reads `route.params.id`, ensures `store.fetchBots()`, finds the bot; if found `store.setActiveBotId(id)` + `router.replace('/')`; else shows not-found.
|
||||
|
||||
- [ ] **Step 1 — implement.** Change the found-branch to seed scope via the URL instead of bouncing to a bare `/`:
|
||||
- keep the fetchBots + existence check,
|
||||
- if found: `router.replace({ path: '/', query: { bot: botId } })` (the router guard + store will set the scope). Optionally also call `store.setScope(botId)` directly for immediacy.
|
||||
- if not found: unchanged (show "机器人不存在或未加载").
|
||||
|
||||
- [ ] **Step 2 — verify:** `cd web && npx vue-tsc --noEmit` → exit 0.
|
||||
- [ ] **Step 3 — commit:** `git add web/src/views/BotRedirect.vue && git commit -m "feat(scope): dedicated link seeds ?bot scope instead of bare redirect"`
|
||||
|
||||
---
|
||||
|
||||
## Task 4: Navbar lock UI + apply-scope-on-load
|
||||
|
||||
**Files:** Modify `web/src/components/Navbar.vue`, `web/src/App.vue`.
|
||||
|
||||
READ both: Navbar has `controllableBots` (computed) + the dropdown selector + `selectBot`; App.vue onMounted calls `playerStore.fetchBots()` (+ loadTheme/connect).
|
||||
|
||||
- [ ] **Step 1 — Navbar lock.** When `store.isScoped`:
|
||||
- render only the scoped bot (a `displayedBots` computed → if scoped, `controllableBots.filter(b => b.id === store.scopedBotId)`, else `controllableBots`),
|
||||
- disable the dropdown open / switching (no chevron, or make the trigger non-interactive) so the user can't switch,
|
||||
- hide other bots' "copy link" affordances (only the scoped bot remains anyway),
|
||||
- show a small "专属模式" badge and an "退出" button → `store.clearScope(); router.push('/')` (clear BEFORE navigating so the guard doesn't re-attach `?bot`). Import `useRouter` if not present.
|
||||
When not scoped: behavior unchanged.
|
||||
|
||||
- [ ] **Step 2 — apply scope on load (App.vue).** After `fetchBots()` resolves in onMounted, call `playerStore.applyScopeFromQuery(routeBot)` where `routeBot` is the current `?bot` query (via `useRoute().query.bot` as string|null). This confirms a refreshed `?bot` against the loaded bots and sets activeBotId (or gracefully clears if the bot is gone). (If Task 2's guard already set `scopedBotId` tentatively, this validates it against the now-loaded bot list.)
|
||||
|
||||
- [ ] **Step 3 — verify:** `cd web && npx vue-tsc --noEmit` → exit 0. Read templates back for valid syntax; confirm read-only displays aren't broken and the non-scoped path is unchanged.
|
||||
- [ ] **Step 4 — commit:** `git add web/src/components/Navbar.vue web/src/App.vue && git commit -m "feat(scope): lock Navbar selector to scoped bot + apply scope on load"`
|
||||
|
||||
---
|
||||
|
||||
## Final verification
|
||||
- [ ] `cd web && npx vue-tsc --noEmit` → exit 0
|
||||
- [ ] `npx tsc --noEmit` → exit 0 (backend unaffected)
|
||||
- [ ] `cd web && npx vitest run src/stores/scope.test.ts` (or root vitest if it includes web) → pass
|
||||
- [ ] `npm run build` → succeeds
|
||||
- [ ] Manual: open `/bot/<id>` → URL becomes `/?bot=<id>`, selector shows only that bot, switching disabled; **refresh → still locked** (item 4 fixed); navigate to Search → URL keeps `?bot`; refresh on Search → still locked; click 退出 → back to all bots (`/`, no `?bot`); open `/` directly → full multi-bot control; open `/?bot=<nonexistent>` → gracefully shows all bots (no lock).
|
||||
|
||||
## Notes
|
||||
- Backend per-bot authorization (PR #80) is the real security boundary; this is a UX lock.
|
||||
- No localStorage — URL is the source of truth, so the lock is shareable and self-clearing.
|
||||
- Item 4 is fixed as a consequence of carrying `?bot` in the URL across refresh/navigation.
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,840 @@
|
||||
# TeamSpeak chat-command permission control — Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Gate a fixed set of "admin" TeamSpeak chat commands (`stop`, `clear`, `remove`, `move`, `vol`, `mode`) behind configured TS server-group IDs, opt-in and backward-compatible, configurable from the WebUI and `config.json`.
|
||||
|
||||
**Architecture:** A pure helper `canRunCommand(name, invokerGroups, adminGroups)` decides allow/deny. The chat handler `handleTextMessage` (NOT the WebUI-shared `executeCommand`) consults it before executing, performs a best-effort group lookup when the sender's groups weren't delivered with the event, fails closed, and replies on deny. The privileged groups live in the already-declared `config.adminGroups`, surfaced through the existing `GET/POST /api/bot/settings` endpoints and an admin-only Settings.vue section.
|
||||
|
||||
**Tech Stack:** Node 20, TypeScript (ESM), Express 5, Vitest + supertest (backend), Vue 3 + `vue-tsc` (frontend), `@honeybbq/teamspeak-client`.
|
||||
|
||||
## Global Constraints
|
||||
|
||||
- **ESM import specifiers:** every relative import ends in `.js` even in `.ts` files (e.g. `import { canRunCommand } from "./commands.js"`).
|
||||
- **Admin command set (exact, single source of truth):** `stop`, `clear`, `remove`, `move`, `vol`, `mode`. Everything else is public. (Note: `follow` is intentionally NOT admin — it becomes public.)
|
||||
- **Enforcement is opt-in / backward-compatible:** `config.adminGroups === []` (the default) ⇒ no enforcement; admin commands stay open to everyone exactly as today.
|
||||
- **Fail closed:** an admin command, with enforcement on, whose sender groups cannot be determined (even after fallback) is **denied**.
|
||||
- **Group-id normalization:** `invokerGroups` are strings, `adminGroups` are numbers — compare as the same type so `"6"` matches `6`.
|
||||
- **Denial reply text (exact):** `⛔ 需要管理员权限(该命令仅限管理员服务器组)`.
|
||||
- **`adminGroups` validation:** array of non-negative integers; filter out everything else; ignore a non-array value entirely.
|
||||
- **Live config:** `BotInstance` shares the same `config` object the router mutates; the gate reads `this.config.adminGroups` live (no restart, no propagation call).
|
||||
- **Per-task tests:** run `npx vitest run <file>` (targets `.ts` directly). Before any full `npm test`, run `rm -rf dist` first — a stale untracked `dist/` makes vitest double-run compiled `.test.js` copies (known environment quirk). The repo path contains spaces (`/c/Users/saopig1/Music/teamspeak music bot`) — quote it.
|
||||
- **Frontend type-check:** `cd web && npx vue-tsc --noEmit` (must be clean).
|
||||
- **TDD + frequent commits:** every task is red→green→commit. Keep project `tsc`/`vitest` green after each task.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: `canRunCommand` helper + admin-set as single source of truth
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/bot/commands.ts` (lines 8-16 sets; line 59-61 `isAdminCommand`)
|
||||
- Test: `src/bot/commands.test.ts` (append a new `describe` block)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: nothing from other tasks.
|
||||
- Produces:
|
||||
- `export const ADMIN_COMMANDS: Set<string>` = `{stop, clear, remove, move, vol, mode}`
|
||||
- `export function isAdminCommand(commandName: string): boolean` (unchanged signature)
|
||||
- `export function canRunCommand(commandName: string, invokerGroups: readonly (string | number)[], adminGroups: readonly number[]): boolean` — consumed by Task 3.
|
||||
|
||||
- [ ] **Step 1: Write the failing tests**
|
||||
|
||||
Append to `src/bot/commands.test.ts`:
|
||||
|
||||
```ts
|
||||
import { canRunCommand, isAdminCommand } from "./commands.js";
|
||||
|
||||
describe("isAdminCommand classification", () => {
|
||||
it("treats stop/clear/remove/move/vol/mode as admin", () => {
|
||||
for (const c of ["stop", "clear", "remove", "move", "vol", "mode"]) {
|
||||
expect(isAdminCommand(c)).toBe(true);
|
||||
}
|
||||
});
|
||||
it("treats follow and play as NOT admin", () => {
|
||||
expect(isAdminCommand("follow")).toBe(false);
|
||||
expect(isAdminCommand("play")).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("canRunCommand", () => {
|
||||
it("allows any public command regardless of groups", () => {
|
||||
expect(canRunCommand("play", [], [6])).toBe(true);
|
||||
expect(canRunCommand("follow", [], [6])).toBe(true);
|
||||
});
|
||||
it("allows admin command when enforcement is off (empty adminGroups)", () => {
|
||||
expect(canRunCommand("stop", [], [])).toBe(true);
|
||||
});
|
||||
it("allows admin command when an invoker group matches (string vs number)", () => {
|
||||
expect(canRunCommand("stop", ["6"], [6])).toBe(true);
|
||||
expect(canRunCommand("stop", [6], [6])).toBe(true);
|
||||
expect(canRunCommand("vol", ["8", "6"], [6])).toBe(true);
|
||||
});
|
||||
it("denies admin command when no invoker group matches", () => {
|
||||
expect(canRunCommand("stop", ["8"], [6])).toBe(false);
|
||||
});
|
||||
it("denies admin command when invoker has no groups and enforcement is on", () => {
|
||||
expect(canRunCommand("clear", [], [6])).toBe(false);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run the tests to verify they fail**
|
||||
|
||||
Run: `npx vitest run "src/bot/commands.test.ts"`
|
||||
Expected: FAIL — `canRunCommand` is not exported / not a function.
|
||||
|
||||
- [ ] **Step 3: Implement the helper and tighten the admin set**
|
||||
|
||||
In `src/bot/commands.ts`, delete the dead `PUBLIC_COMMANDS` export (nothing imports it; the admin set is the sole source of truth), set `ADMIN_COMMANDS` to the exact spec set (drop `follow`), and add `canRunCommand`. The file becomes:
|
||||
|
||||
```ts
|
||||
export interface ParsedCommand {
|
||||
name: string;
|
||||
args: string;
|
||||
rawArgs: string[];
|
||||
flags: Set<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* The fixed set of "admin" chat commands. This is the SINGLE source of truth
|
||||
* for which commands the permission gate restricts; reclassifying a command is
|
||||
* a one-line edit here. Everything not in this set is public.
|
||||
*/
|
||||
export const ADMIN_COMMANDS = new Set([
|
||||
"stop", "clear", "remove", "move", "vol", "mode",
|
||||
]);
|
||||
|
||||
export function parseCommand(
|
||||
message: string,
|
||||
prefix: string,
|
||||
aliases: Record<string, string> = {},
|
||||
): ParsedCommand | null {
|
||||
const trimmed = message.trim();
|
||||
if (!trimmed.startsWith(prefix)) return null;
|
||||
|
||||
const withoutPrefix = trimmed.slice(prefix.length);
|
||||
if (!withoutPrefix) return null;
|
||||
|
||||
const parts = withoutPrefix.split(/\s+/);
|
||||
let name = parts[0].toLowerCase();
|
||||
|
||||
if (aliases[name]) {
|
||||
name = aliases[name];
|
||||
}
|
||||
|
||||
const flags = new Set<string>();
|
||||
const argParts: string[] = [];
|
||||
|
||||
for (let i = 1; i < parts.length; i++) {
|
||||
if (
|
||||
parts[i].startsWith("-") &&
|
||||
parts[i].length === 2 &&
|
||||
/[a-zA-Z]/.test(parts[i][1])
|
||||
) {
|
||||
flags.add(parts[i][1].toLowerCase());
|
||||
} else {
|
||||
argParts.push(parts[i]);
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
name,
|
||||
args: argParts.join(" "),
|
||||
rawArgs: argParts,
|
||||
flags,
|
||||
};
|
||||
}
|
||||
|
||||
export function isAdminCommand(commandName: string): boolean {
|
||||
return ADMIN_COMMANDS.has(commandName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Decide whether a chat command may run, given the invoker's TS server groups
|
||||
* and the configured admin groups. Pure + synchronous so it is trivially unit
|
||||
* tested and reused by the async gate in BotInstance.
|
||||
*
|
||||
* Allowed iff: (1) it is a public command, OR (2) enforcement is off
|
||||
* (adminGroups empty), OR (3) some invoker group is in adminGroups.
|
||||
* invokerGroups (strings from TS) and adminGroups (numbers) are normalized to
|
||||
* strings before comparison so "6" matches 6.
|
||||
*/
|
||||
export function canRunCommand(
|
||||
commandName: string,
|
||||
invokerGroups: readonly (string | number)[],
|
||||
adminGroups: readonly number[],
|
||||
): boolean {
|
||||
if (!isAdminCommand(commandName)) return true;
|
||||
if (adminGroups.length === 0) return true;
|
||||
const admin = new Set(adminGroups.map((g) => String(g)));
|
||||
return invokerGroups.some((g) => admin.has(String(g)));
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run the tests to verify they pass**
|
||||
|
||||
Run: `npx vitest run "src/bot/commands.test.ts"`
|
||||
Expected: PASS (parser tests + the new classification/canRunCommand tests).
|
||||
|
||||
- [ ] **Step 5: Verify nothing else imported the deleted symbol**
|
||||
|
||||
Run: `grep -rn "PUBLIC_COMMANDS" src/`
|
||||
Expected: no matches (confirms the deletion is safe).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add "src/bot/commands.ts" "src/bot/commands.test.ts"
|
||||
git commit -m "feat(commands): add canRunCommand gate helper + admin-set source of truth"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 2: Surface `invokerGroups` on `TS3TextMessage`
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/ts-protocol/client.ts` (interface lines 58-64; mapping lines 205-214)
|
||||
- Test: `src/ts-protocol/text-message.test.ts` (new)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: nothing from other tasks.
|
||||
- Produces:
|
||||
- `TS3TextMessage` gains `invokerGroups: string[]`.
|
||||
- `export function toTS3TextMessage(msg: TextMessage): TS3TextMessage` — a pure mapper, used by the `textMessage` event handler and unit-testable. Consumed (the field) by Task 3.
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
|
||||
Create `src/ts-protocol/text-message.test.ts`:
|
||||
|
||||
```ts
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { toTS3TextMessage } from "./client.js";
|
||||
import type { TextMessage } from "@honeybbq/teamspeak-client";
|
||||
|
||||
function makeMsg(over: Partial<TextMessage> = {}): TextMessage {
|
||||
return {
|
||||
invokerName: "Alice",
|
||||
invokerUID: "uid-abc",
|
||||
message: "!stop",
|
||||
invokerGroups: ["6", "8"],
|
||||
targetMode: 2,
|
||||
targetID: 0n,
|
||||
invokerID: 5,
|
||||
...over,
|
||||
};
|
||||
}
|
||||
|
||||
describe("toTS3TextMessage", () => {
|
||||
it("maps core fields and stringifies invokerID", () => {
|
||||
const r = toTS3TextMessage(makeMsg());
|
||||
expect(r.invokerName).toBe("Alice");
|
||||
expect(r.invokerId).toBe("5");
|
||||
expect(r.invokerUid).toBe("uid-abc");
|
||||
expect(r.message).toBe("!stop");
|
||||
expect(r.targetMode).toBe(2);
|
||||
});
|
||||
|
||||
it("preserves the sender's server groups", () => {
|
||||
expect(toTS3TextMessage(makeMsg({ invokerGroups: ["6"] })).invokerGroups).toEqual(["6"]);
|
||||
});
|
||||
|
||||
it("defaults missing invokerGroups to an empty array", () => {
|
||||
const partial = {
|
||||
invokerName: "Bob",
|
||||
invokerUID: "u",
|
||||
message: "!stop",
|
||||
targetMode: 1,
|
||||
targetID: 0n,
|
||||
invokerID: 7,
|
||||
} as unknown as TextMessage;
|
||||
expect(toTS3TextMessage(partial).invokerGroups).toEqual([]);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run the test to verify it fails**
|
||||
|
||||
Run: `npx vitest run "src/ts-protocol/text-message.test.ts"`
|
||||
Expected: FAIL — `toTS3TextMessage` is not exported.
|
||||
|
||||
- [ ] **Step 3: Add the field and the pure mapper, and use it in the handler**
|
||||
|
||||
In `src/ts-protocol/client.ts`, extend the interface (add `invokerGroups`):
|
||||
|
||||
```ts
|
||||
export interface TS3TextMessage {
|
||||
invokerName: string;
|
||||
invokerId: string;
|
||||
invokerUid: string;
|
||||
message: string;
|
||||
targetMode: number; // 1=private, 2=channel, 3=server
|
||||
invokerGroups: string[]; // sender's TS server-group ids; [] when not in view cache
|
||||
}
|
||||
```
|
||||
|
||||
Add the pure mapper just below the interface (still above the `TS3Client` class):
|
||||
|
||||
```ts
|
||||
/**
|
||||
* Map the library's TextMessage to our wrapper. Preserves invokerGroups (the
|
||||
* sender's TS server groups), which the library populates only when the sender
|
||||
* is in the bot's client-view cache; otherwise it is []. Used by the chat
|
||||
* command permission gate.
|
||||
*/
|
||||
export function toTS3TextMessage(msg: TextMessage): TS3TextMessage {
|
||||
return {
|
||||
invokerName: msg.invokerName,
|
||||
invokerId: String(msg.invokerID),
|
||||
invokerUid: msg.invokerUID,
|
||||
message: msg.message,
|
||||
targetMode: msg.targetMode,
|
||||
invokerGroups: msg.invokerGroups ?? [],
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Replace the inline mapping inside `this.client.on("textMessage", ...)` (currently lines 205-214) with a call to the mapper:
|
||||
|
||||
```ts
|
||||
this.client.on("textMessage", (msg: TextMessage) => {
|
||||
this.emit("textMessage", toTS3TextMessage(msg));
|
||||
});
|
||||
```
|
||||
|
||||
(`TextMessage` is already imported at the top of the file.)
|
||||
|
||||
- [ ] **Step 4: Run the test to verify it passes**
|
||||
|
||||
Run: `npx vitest run "src/ts-protocol/text-message.test.ts"`
|
||||
Expected: PASS (3 tests).
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add "src/ts-protocol/client.ts" "src/ts-protocol/text-message.test.ts"
|
||||
git commit -m "feat(ts-protocol): surface invokerGroups on TS3TextMessage via pure mapper"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 3: Permission gate in `handleTextMessage` (fallback lookup + fail-closed + denial reply)
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/bot/instance.ts` (imports lines 10-14; add a module constant; `handleTextMessage` lines 317-349; add two private methods)
|
||||
- Test: `src/bot/instance.test.ts` (append a new `describe` block)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes:
|
||||
- `canRunCommand(commandName, invokerGroups, adminGroups)` from `./commands.js` (Task 1).
|
||||
- `TS3TextMessage.invokerGroups: string[]` (Task 2).
|
||||
- Existing `this.tsClient.getClientsInChannel(): Promise<ClientInfo[]>` where each `ClientInfo` has `id: number` and `serverGroups: string[]` (library already parses these).
|
||||
- Existing `this.tsClient.sendTextMessage(message: string, targetMode?: number): Promise<void>`.
|
||||
- Produces:
|
||||
- `export const COMMAND_DENIED_MESSAGE: string` (exported so the test can assert it).
|
||||
- Private `isCommandAllowed(commandName, msg)` and `lookupInvokerGroups(invokerId)` (exercised via prototype in the test).
|
||||
|
||||
- [ ] **Step 1: Write the failing tests**
|
||||
|
||||
Append to `src/bot/instance.test.ts`:
|
||||
|
||||
```ts
|
||||
import { vi } from "vitest";
|
||||
import { COMMAND_DENIED_MESSAGE } from "./instance.js";
|
||||
import type { TS3TextMessage } from "../ts-protocol/client.js";
|
||||
|
||||
/** Minimal `this` carrying only what handleTextMessage's gate path touches.
|
||||
* The gate methods live on the prototype and are attached here so calls like
|
||||
* `this.isCommandAllowed(...)` resolve against this same object. */
|
||||
function makeGateCtx(opts: {
|
||||
adminGroups?: number[];
|
||||
clients?: Array<{ id: number; serverGroups: string[] }>;
|
||||
}) {
|
||||
const ctx: any = {
|
||||
config: { commandPrefix: "!", commandAliases: {}, adminGroups: opts.adminGroups ?? [] },
|
||||
logger: { info: vi.fn(), error: vi.fn() },
|
||||
tsClient: {
|
||||
sendTextMessage: vi.fn(async () => {}),
|
||||
getClientsInChannel: vi.fn(async () => opts.clients ?? []),
|
||||
},
|
||||
executeCommand: vi.fn(async () => null),
|
||||
isCommandAllowed: (BotInstance.prototype as any).isCommandAllowed,
|
||||
lookupInvokerGroups: (BotInstance.prototype as any).lookupInvokerGroups,
|
||||
};
|
||||
return ctx;
|
||||
}
|
||||
|
||||
function makeMsg(message: string, invokerGroups: string[] = [], invokerId = "5"): TS3TextMessage {
|
||||
return { invokerName: "Tester", invokerId, invokerUid: "uid", message, targetMode: 2, invokerGroups };
|
||||
}
|
||||
|
||||
const handleTextMessage = (BotInstance.prototype as any).handleTextMessage as (
|
||||
this: unknown,
|
||||
msg: TS3TextMessage,
|
||||
) => Promise<void>;
|
||||
|
||||
describe("BotInstance.handleTextMessage — command permission gate", () => {
|
||||
it("runs a public command even with enforcement on", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!play 晴天"));
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.tsClient.sendTextMessage).not.toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("runs an admin command when enforcement is off (empty adminGroups)", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop"));
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("runs an admin command when the event carried a matching group", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", ["6"]));
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.tsClient.getClientsInChannel).not.toHaveBeenCalled(); // no fallback needed
|
||||
});
|
||||
|
||||
it("denies an admin command when known groups do not match (no fallback, with reply)", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", ["8"]));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.getClientsInChannel).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("falls back to a group lookup when the event carried no groups, and allows on match", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], clients: [{ id: 5, serverGroups: ["6"] }] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", [], "5"));
|
||||
expect(ctx.tsClient.getClientsInChannel).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("fails closed when the fallback finds the client but no matching group", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], clients: [{ id: 5, serverGroups: ["8"] }] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", [], "5"));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("fails closed when the fallback cannot find the client at all", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], clients: [] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", [], "5"));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run the tests to verify they fail**
|
||||
|
||||
Run: `npx vitest run "src/bot/instance.test.ts"`
|
||||
Expected: FAIL — `COMMAND_DENIED_MESSAGE` is not exported; `isCommandAllowed`/`lookupInvokerGroups` are undefined.
|
||||
|
||||
- [ ] **Step 3: Implement the gate**
|
||||
|
||||
In `src/bot/instance.ts`, change the commands import (lines 10-14) from `isAdminCommand` to `canRunCommand`:
|
||||
|
||||
```ts
|
||||
import {
|
||||
parseCommand,
|
||||
canRunCommand,
|
||||
type ParsedCommand,
|
||||
} from "./commands.js";
|
||||
```
|
||||
|
||||
Add a module-level constant just after the imports (above `export interface BotInstanceOptions`):
|
||||
|
||||
```ts
|
||||
/** Reply sent when a non-admin invokes an admin-only chat command. */
|
||||
export const COMMAND_DENIED_MESSAGE = "⛔ 需要管理员权限(该命令仅限管理员服务器组)";
|
||||
```
|
||||
|
||||
Replace `handleTextMessage` (lines 317-349) so the dead stub becomes the real gate:
|
||||
|
||||
```ts
|
||||
private async handleTextMessage(msg: TS3TextMessage): Promise<void> {
|
||||
const parsed = parseCommand(
|
||||
msg.message,
|
||||
this.config.commandPrefix,
|
||||
this.config.commandAliases
|
||||
);
|
||||
if (!parsed) return;
|
||||
|
||||
if (!(await this.isCommandAllowed(parsed.name, msg))) {
|
||||
this.logger.info(
|
||||
{ command: parsed.name, invoker: msg.invokerName },
|
||||
"Command denied: invoker not in adminGroups"
|
||||
);
|
||||
try {
|
||||
await this.tsClient.sendTextMessage(COMMAND_DENIED_MESSAGE);
|
||||
} catch (sendErr) {
|
||||
this.logger.error({ err: sendErr }, "Failed to send permission-denied message to chat");
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
this.logger.info(
|
||||
{ command: parsed.name, args: parsed.args, invoker: msg.invokerName },
|
||||
"Command received"
|
||||
);
|
||||
|
||||
try {
|
||||
const response = await this.executeCommand(parsed, msg);
|
||||
if (response) {
|
||||
await this.tsClient.sendTextMessage(response);
|
||||
}
|
||||
} catch (err) {
|
||||
this.logger.error({ err, command: parsed.name }, "Command execution error");
|
||||
try {
|
||||
await this.tsClient.sendTextMessage(
|
||||
`Error: ${(err as Error).message}`
|
||||
);
|
||||
} catch (sendErr) {
|
||||
this.logger.error({ err: sendErr }, "Failed to send error message to chat");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Decide whether a chat command may run for this sender. Reads adminGroups
|
||||
* live from this.config (the router mutates the same object). Only performs
|
||||
* the async group lookup when the synchronous decision is "deny because the
|
||||
* event carried no groups" — i.e. an admin command, enforcement on, and
|
||||
* empty invokerGroups. Fails closed if groups remain undeterminable.
|
||||
*/
|
||||
private async isCommandAllowed(commandName: string, msg: TS3TextMessage): Promise<boolean> {
|
||||
const adminGroups = this.config.adminGroups;
|
||||
if (canRunCommand(commandName, msg.invokerGroups, adminGroups)) return true;
|
||||
// Here: admin command, enforcement on, and the provided groups did not match.
|
||||
// If the event actually carried groups, this is a genuine deny — no lookup.
|
||||
if (msg.invokerGroups.length > 0) return false;
|
||||
// Groups unknown (sender not in the view cache): one targeted lookup, then
|
||||
// re-decide. canRunCommand([], …) is false ⇒ fail-closed when still unknown.
|
||||
const groups = await this.lookupInvokerGroups(msg.invokerId);
|
||||
return canRunCommand(commandName, groups, adminGroups);
|
||||
}
|
||||
|
||||
/**
|
||||
* Best-effort lookup of a sender's server groups by client id, via the
|
||||
* channel client list (whose entries already carry parsed serverGroups).
|
||||
* Returns [] when the client can't be found or the query fails (→ deny).
|
||||
*/
|
||||
private async lookupInvokerGroups(invokerId: string): Promise<string[]> {
|
||||
const clid = Number(invokerId);
|
||||
if (!Number.isFinite(clid) || clid <= 0) return [];
|
||||
try {
|
||||
const clients = await this.tsClient.getClientsInChannel();
|
||||
const match = clients.find((c) => c.id === clid);
|
||||
return match?.serverGroups ?? [];
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run the gate tests to verify they pass**
|
||||
|
||||
Run: `npx vitest run "src/bot/instance.test.ts"`
|
||||
Expected: PASS (existing `runExclusive` tests + the 7 new gate tests).
|
||||
|
||||
- [ ] **Step 5: Confirm the live-config invariant**
|
||||
|
||||
Confirm `BotInstance` reads `adminGroups` from the shared, mutable config — not a copy. The constructor stores `this.config = options.config` (line 91 region) and the router (`src/web/api/bot.ts`) mutates that same object; no propagation call is needed. Quick check:
|
||||
|
||||
Run: `grep -n "this.config = options.config\|this.config.adminGroups" "src/bot/instance.ts"`
|
||||
Expected: shows the assignment and the gate read (proves the gate uses the live reference).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add "src/bot/instance.ts" "src/bot/instance.test.ts"
|
||||
git commit -m "feat(bot): gate admin chat commands on adminGroups with fallback + deny reply"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: Read/write `adminGroups` in the settings endpoints
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/api/bot.ts` (GET `/settings` lines 35-41; POST `/settings` lines 45-97)
|
||||
- Test: `src/web/api/bot.test.ts` (append `it` cases to the first `describe("bot router /settings", …)` block)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: existing `config.adminGroups: number[]` (already declared in `src/data/config.ts`, default `[]`).
|
||||
- Produces: `GET /api/bot/settings` returns `adminGroups: number[]`; `POST /api/bot/settings` accepts, validates, persists, and echoes `adminGroups`.
|
||||
|
||||
- [ ] **Step 1: Write the failing tests**
|
||||
|
||||
Append these `it` cases inside the existing first `describe("bot router /settings", …)` block in `src/web/api/bot.test.ts` (it already wires `app`, `config`, and an admin `cookie`):
|
||||
|
||||
```ts
|
||||
it("GET /settings includes adminGroups reflecting config", async () => {
|
||||
config.adminGroups = [6, 8];
|
||||
const res = await request(app).get("/api/bot/settings").set("Cookie", cookie);
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.adminGroups).toEqual([6, 8]);
|
||||
});
|
||||
|
||||
it("POST /settings persists a validated adminGroups and GET returns it", async () => {
|
||||
const res = await request(app)
|
||||
.post("/api/bot/settings")
|
||||
.set("Cookie", cookie)
|
||||
.send({ adminGroups: [6, 8] });
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.adminGroups).toEqual([6, 8]);
|
||||
expect(config.adminGroups).toEqual([6, 8]);
|
||||
const followUp = await request(app).get("/api/bot/settings").set("Cookie", cookie);
|
||||
expect(followUp.body.adminGroups).toEqual([6, 8]);
|
||||
});
|
||||
|
||||
it("POST /settings filters invalid adminGroups entries (negative, non-integer, non-number)", async () => {
|
||||
const res = await request(app)
|
||||
.post("/api/bot/settings")
|
||||
.set("Cookie", cookie)
|
||||
.send({ adminGroups: [6, -1, 2.5, "x", 8] });
|
||||
expect(res.status).toBe(200);
|
||||
expect(config.adminGroups).toEqual([6, 8]);
|
||||
});
|
||||
|
||||
it("POST /settings ignores a non-array adminGroups (leaves config unchanged)", async () => {
|
||||
config.adminGroups = [6];
|
||||
const res = await request(app)
|
||||
.post("/api/bot/settings")
|
||||
.set("Cookie", cookie)
|
||||
.send({ adminGroups: "6" });
|
||||
expect(res.status).toBe(200);
|
||||
expect(config.adminGroups).toEqual([6]);
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run the tests to verify they fail**
|
||||
|
||||
Run: `npx vitest run "src/web/api/bot.test.ts"`
|
||||
Expected: FAIL — `res.body.adminGroups` is `undefined`; the POST does not persist `adminGroups`.
|
||||
|
||||
- [ ] **Step 3: Extend the GET handler**
|
||||
|
||||
In `src/web/api/bot.ts`, add `adminGroups` to the GET `/settings` response (the handler at lines 35-41):
|
||||
|
||||
```ts
|
||||
router.get("/settings", requireNotGuest, (_req, res) => {
|
||||
res.json({
|
||||
idleTimeoutMinutes: config.idleTimeoutMinutes ?? 0,
|
||||
autoPauseOnEmpty: config.autoPauseOnEmpty,
|
||||
adminGroups: config.adminGroups ?? [],
|
||||
guestMode: config.guestMode,
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Extend the POST handler**
|
||||
|
||||
In the POST `/settings` handler: (a) pull `adminGroups` out of `req.body`; (b) validate + assign before `saveConfig`; (c) echo it in the response. Change the destructuring line (46):
|
||||
|
||||
```ts
|
||||
const { idleTimeoutMinutes, autoPauseOnEmpty, guestMode, adminGroups } = req.body;
|
||||
```
|
||||
|
||||
Add this block just before `saveConfig(configPath, config);` (line 77):
|
||||
|
||||
```ts
|
||||
if (Array.isArray(adminGroups)) {
|
||||
config.adminGroups = adminGroups.filter(
|
||||
(g: unknown): g is number =>
|
||||
typeof g === "number" && Number.isInteger(g) && g >= 0,
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Add `adminGroups` to BOTH `res.json({ … })` bodies in this handler (the success response near line 92, and — if present — keep them consistent):
|
||||
|
||||
```ts
|
||||
res.json({
|
||||
idleTimeoutMinutes: config.idleTimeoutMinutes ?? 0,
|
||||
autoPauseOnEmpty: config.autoPauseOnEmpty,
|
||||
adminGroups: config.adminGroups ?? [],
|
||||
guestMode: config.guestMode,
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Run the tests to verify they pass**
|
||||
|
||||
Run: `npx vitest run "src/web/api/bot.test.ts"`
|
||||
Expected: PASS (existing settings/guest-mode tests + the 4 new adminGroups tests).
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add "src/web/api/bot.ts" "src/web/api/bot.test.ts"
|
||||
git commit -m "feat(api): read/write adminGroups in bot settings endpoints"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 5: Admin-only "命令权限" section in Settings.vue
|
||||
|
||||
**Files:**
|
||||
- Modify: `web/src/views/Settings.vue` (template: add a section after the Guest Mode section, before the Bot Profile section ~line 506; script: add state + handlers near the guest-mode block ~line 1093; hydrate in `loadIdleTimeout` ~line 1024)
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: `GET /api/bot/settings` → `adminGroups: number[]`; `POST /api/bot/settings` with `{ adminGroups: number[] }` (Task 4). Existing `session.isAdmin.value`.
|
||||
- Produces: UI only.
|
||||
|
||||
- [ ] **Step 1: Add the template section**
|
||||
|
||||
In `web/src/views/Settings.vue`, insert this `<section>` immediately AFTER the closing `</section>` of the Guest Mode block (the one whose title is `游客模式`, ends ~line 505) and BEFORE the `<!-- Bot Profile … -->` section:
|
||||
|
||||
```html
|
||||
<!-- Command Permissions (admin only) -->
|
||||
<section v-if="session.isAdmin.value" class="settings-section">
|
||||
<h2 class="section-title">命令权限</h2>
|
||||
<p class="profile-section-hint">
|
||||
限制谁能在 TeamSpeak 聊天里运行管理类命令(stop / clear / remove / move / vol / mode)。
|
||||
填写允许的服务器组 ID(逗号分隔)。留空 = 不限制,所有人可用。如何查看服务器组 ID 见 README。
|
||||
</p>
|
||||
<div class="setting-row">
|
||||
<div class="prefix-input-wrap">
|
||||
<input v-model="adminGroupsText" class="input input-sm" placeholder="如 6, 8" />
|
||||
<button class="btn-primary" :disabled="adminGroupsSaving" @click="saveAdminGroups">
|
||||
{{ adminGroupsSaving ? '保存中…' : '保存' }}
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Add the script state + handlers**
|
||||
|
||||
In the `<script setup>` block, add this just after the guest-mode block (after `saveGuestMode` closes, ~line 1093):
|
||||
|
||||
```ts
|
||||
// --- Command permissions (admin only) ---
|
||||
const adminGroupsText = ref('');
|
||||
const adminGroupsSaving = ref(false);
|
||||
|
||||
function applyAdminGroupsFromServer(groups: unknown) {
|
||||
if (Array.isArray(groups)) {
|
||||
adminGroupsText.value = groups.filter((g) => typeof g === 'number').join(', ');
|
||||
}
|
||||
}
|
||||
|
||||
function parseAdminGroups(text: string): number[] {
|
||||
return text
|
||||
.split(',')
|
||||
.map((s) => s.trim())
|
||||
.filter((s) => s.length > 0)
|
||||
.map((s) => Number(s))
|
||||
.filter((n) => Number.isInteger(n) && n >= 0);
|
||||
}
|
||||
|
||||
async function saveAdminGroups() {
|
||||
adminGroupsSaving.value = true;
|
||||
try {
|
||||
const res = await axios.post('/api/bot/settings', { adminGroups: parseAdminGroups(adminGroupsText.value) });
|
||||
applyAdminGroupsFromServer(res.data?.adminGroups);
|
||||
} catch { /* ignore */ } finally {
|
||||
adminGroupsSaving.value = false;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Hydrate on load**
|
||||
|
||||
In `loadIdleTimeout` (the existing function ~lines 1024-1031), add the hydrate call alongside `applyGuestModeFromServer`:
|
||||
|
||||
```ts
|
||||
async function loadIdleTimeout() {
|
||||
try {
|
||||
const res = await axios.get('/api/bot/settings');
|
||||
idleTimeout.value = res.data.idleTimeoutMinutes ?? 0;
|
||||
autoPauseOnEmpty.value = res.data.autoPauseOnEmpty ?? false;
|
||||
applyGuestModeFromServer(res.data.guestMode);
|
||||
applyAdminGroupsFromServer(res.data.adminGroups);
|
||||
} catch { /* ignore */ }
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Type-check the frontend**
|
||||
|
||||
Run: `cd "web" && npx vue-tsc --noEmit`
|
||||
Expected: no errors.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add "web/src/views/Settings.vue"
|
||||
git commit -m "feat(web): admin-only command-permission (adminGroups) settings section"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Document the feature in the README
|
||||
|
||||
**Files:**
|
||||
- Modify: `README.md`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: nothing (docs).
|
||||
- Produces: user-facing documentation of the feature + how to find TS server-group IDs.
|
||||
|
||||
- [ ] **Step 1: Locate the insertion point**
|
||||
|
||||
Run: `grep -n "游客模式\|Guest\|权限\|adminGroups" "README.md"`
|
||||
Expected: shows the guest-mode / permissions area. Insert the new subsection immediately after the guest-mode documentation block (or, if there is a dedicated permissions/features section, at its end).
|
||||
|
||||
- [ ] **Step 2: Add the documentation block**
|
||||
|
||||
Insert this markdown at the chosen point:
|
||||
|
||||
```markdown
|
||||
### TeamSpeak 命令权限(管理类命令限制)
|
||||
|
||||
默认情况下,频道里任何人都能运行所有聊天命令。你可以把一组「管理类」命令限制为只有特定 TeamSpeak 服务器组的成员才能运行:
|
||||
|
||||
- 受限命令:`stop`、`clear`、`remove`、`move`、`vol`、`mode`
|
||||
- 其余命令(点歌、队列、跳过、歌词等)始终对所有人开放
|
||||
- **默认不限制**:管理服务器组列表为空时,所有命令对所有人开放(向后兼容)
|
||||
|
||||
**配置方式**
|
||||
|
||||
- 网页端:设置 → 命令权限,填写允许的服务器组 ID(逗号分隔),保存即时生效。
|
||||
- 或编辑 `config.json` 的 `adminGroups`(数字数组),例如 `"adminGroups": [6, 8]`。
|
||||
|
||||
填入任意服务器组 ID 后,限制立即开启:只有属于这些组之一的用户才能运行受限命令,其他人会收到「⛔ 需要管理员权限」的提示。
|
||||
|
||||
> 提示(fail-closed):当受限命令来自一个机器人当前看不到其服务器组的发送者(例如不在机器人所在频道的私聊),机器人会尝试查询其分组;若仍无法确定,则拒绝执行。
|
||||
|
||||
**如何查看服务器组 ID**
|
||||
|
||||
在 TeamSpeak 客户端中打开「权限 → 服务器组」(Permissions → Server Groups)对话框,选中某个组后,其 ID 会显示在标题栏/状态栏;或在服务器组管理界面中查看每个组对应的数字 ID。把需要授权的组 ID 填入上面的设置即可。
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Sanity-check the docs render**
|
||||
|
||||
Run: `grep -n "命令权限\|adminGroups" "README.md"`
|
||||
Expected: shows the newly added section.
|
||||
|
||||
- [ ] **Step 4: Commit**
|
||||
|
||||
```bash
|
||||
git add "README.md"
|
||||
git commit -m "docs: document TeamSpeak chat-command permission control"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Final verification (after all tasks)
|
||||
|
||||
- [ ] Remove stale compiled output, then run the full suite:
|
||||
|
||||
```bash
|
||||
rm -rf dist
|
||||
npm test
|
||||
```
|
||||
Expected: all tests pass (the new `canRunCommand`, `toTS3TextMessage`, gate, and `adminGroups` settings tests included).
|
||||
|
||||
- [ ] Full build (backend `tsc` + frontend `vue-tsc` + vite):
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
Expected: SUCCESS (no type errors).
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,520 @@
|
||||
# Spotify Source — Stage 4 (Polish, Config UI, Docs) Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Complete the Spotify source's last mile — make it user-configurable and user-authorizable from the web UI, document it (with the required safety warnings), and land the deferred OAuth-robustness hardening.
|
||||
|
||||
**Architecture:** The Stage-3 OAuth endpoints (`/api/spotify/{login,callback,status}`) and the single shared `SpotifyOAuth` already exist but are unreachable from the UI. Stage 4 adds: (1) a `spotify` block to the `/api/bot/settings` config API (secret masked); (2) a resolved-backend indicator on `/status`; (3) OAuth refresh/verifier hardening; (4) the approved Settings "Connect Spotify" card (spec §8); (5) the README Spotify section (spec §11/§12). Deferred (documented, NOT built this stage): runtime binary auto-download, connect play-not-reflected diagnostics, extra watchdog.
|
||||
|
||||
**Tech Stack:** TypeScript (ESM, `.js` specifiers), Express, Vitest (root config also runs `web/src/**/*.test.ts` — stores/composables only; there is NO `.vue` component-test harness), Vue 3 + `<script setup>` + Pinia, `vue-tsc` (web build gate).
|
||||
|
||||
## Global Constraints
|
||||
|
||||
- **Safe-by-default (spec §2/§7):** Spotify stays inert unless `enabled` AND authorized AND a resolvable binary. Nothing in this stage may change behavior when `spotify.enabled === false`.
|
||||
- **Never expose secrets (spec §2/§7):** `clientSecret` is the operator's own value. The config GET API MUST NOT return the raw `clientSecret` — return only a boolean `hasClientSecret`. POST overwrites `clientSecret` only when a non-empty string is supplied (blank/omitted = unchanged). No bundled credentials, no shared Developer app.
|
||||
- **Permissions:** config writes gated by `requirePermission("bot.manage")`; reads by `requireNotGuest`; the OAuth login card is additionally shown only to `can('platform.auth')` / admins — mirror the existing Settings gating.
|
||||
- **Validation mirrors `src/data/config.ts`:** `backend` ∈ `{"auto","go-librespot","librespot"}`; `bitrate` ∈ `{96,160,320}`; `deviceName` non-empty trimmed string (else keep prior); strings coerced/guarded. Reuse the exact value sets.
|
||||
- **Language:** README additions are in Chinese (repo is Chinese-only), matching existing heading style (`## 功能特性` etc.).
|
||||
- **Licensing (spec §9):** go-librespot is GPL-3.0 — the README must include its license note + a source offer; the bot ships NO binary (source-only Rust librespot; Linux-only go-librespot assets).
|
||||
- **Honesty:** live audio / Connect control / real OAuth round-trip remain NOT verifiable here (need Premium + real binaries + a real account). "Done" = unit-tested (mocked process/HTTP/FS), `tsc --noEmit` clean, `cd web && npm run build` clean, full suite green, reviewed. Never claim audio works.
|
||||
- **Branch:** all work on `feat/spotify-audio`. Do NOT create per-task branches.
|
||||
- **Full suite command:** `npx vitest run --no-file-parallelism` (avoids the users.test.ts bcrypt LOAD flake). Typecheck: `npx tsc --noEmit`. Web build: `cd web && npm run build`.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: `/api/bot/settings` reads & writes the `spotify` block (secret masked)
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/web/api/bot.ts` (GET `/settings` response + POST `/settings` destructure/validate/echo)
|
||||
- Test: `src/web/api/bot.test.ts`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: `config.spotify: SpotifyConfig` (`{ enabled, backend, clientId, clientSecret, deviceName, bitrate }`), `saveConfig(configPath, config)`, `requirePermission("bot.manage")`, `requireNotGuest` — all already imported/used in this file.
|
||||
- Produces (new response shape on GET+POST, both add a `spotify` key):
|
||||
```ts
|
||||
// masked view — NEVER includes clientSecret
|
||||
spotify: {
|
||||
enabled: boolean;
|
||||
backend: "auto" | "go-librespot" | "librespot";
|
||||
clientId: string;
|
||||
deviceName: string;
|
||||
bitrate: number;
|
||||
hasClientSecret: boolean; // whether a non-empty secret is stored
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 1.1: Write failing tests.** Add to `src/web/api/bot.test.ts` (mirror the existing settings tests — reuse their app/harness + auth stubs). Cover:
|
||||
1. GET `/api/bot/settings` includes a `spotify` object with `enabled/backend/clientId/deviceName/bitrate/hasClientSecret` and does NOT include a `clientSecret` key. With a stored secret, `hasClientSecret === true`; with `clientSecret: ""`, `false`.
|
||||
2. POST `/api/bot/settings` with `{ spotify: { enabled: true, backend: "librespot", clientId: "cid", deviceName: "Dev", bitrate: 160 } }` updates all those fields and echoes the masked view; `saveConfig` called.
|
||||
3. POST with `{ spotify: { backend: "bogus" } }` leaves `backend` unchanged (invalid rejected, not 400 for the whole request — partial-merge semantics like the other fields). Same for `bitrate: 999`.
|
||||
4. POST with `{ spotify: { clientSecret: "newsecret" } }` sets the secret (assert via `hasClientSecret === true` in the echo AND that `config.spotify.clientSecret === "newsecret"`). POST with `{ spotify: { clientSecret: "" } }` does NOT overwrite an existing secret.
|
||||
5. POST `/api/bot/settings` spotify write requires `bot.manage` (a member without it → 403; reuse the existing 403 test pattern).
|
||||
6. An existing settings POST that omits `spotify` still works and does not touch `config.spotify` (no regression).
|
||||
|
||||
- [ ] **Step 1.2: Run the tests — expect failure** (`npx vitest run src/web/api/bot.test.ts`): the `spotify` key is absent from responses.
|
||||
|
||||
- [ ] **Step 1.3: Extend GET `/settings`.** Add the masked spotify view to the response object (both the GET at ~line 36 and the POST echo at ~line 103 — extract a local helper to avoid duplication):
|
||||
```ts
|
||||
// near the top of createBotRouter, after other helpers:
|
||||
const maskedSpotify = () => ({
|
||||
enabled: config.spotify.enabled,
|
||||
backend: config.spotify.backend,
|
||||
clientId: config.spotify.clientId,
|
||||
deviceName: config.spotify.deviceName,
|
||||
bitrate: config.spotify.bitrate,
|
||||
hasClientSecret: config.spotify.clientSecret.length > 0,
|
||||
});
|
||||
```
|
||||
Add `spotify: maskedSpotify(),` to BOTH the GET response and the POST echo object.
|
||||
|
||||
- [ ] **Step 1.4: Handle `spotify` in POST `/settings`.** Add `spotify` to the destructure and a partial-merge block (mirror config.ts validation). Place before `saveConfig(...)`:
|
||||
```ts
|
||||
const VALID_BACKENDS = ["auto", "go-librespot", "librespot"] as const;
|
||||
const VALID_BITRATES = [96, 160, 320];
|
||||
const sp = req.body?.spotify;
|
||||
if (sp && typeof sp === "object") {
|
||||
const t = config.spotify;
|
||||
if (typeof sp.enabled === "boolean") t.enabled = sp.enabled;
|
||||
if (typeof sp.backend === "string" && (VALID_BACKENDS as readonly string[]).includes(sp.backend)) {
|
||||
t.backend = sp.backend as SpotifyConfig["backend"];
|
||||
}
|
||||
if (typeof sp.clientId === "string") t.clientId = sp.clientId;
|
||||
// Secret is write-only + set-on-non-empty so a blank field never wipes it.
|
||||
if (typeof sp.clientSecret === "string" && sp.clientSecret.length > 0) {
|
||||
t.clientSecret = sp.clientSecret;
|
||||
}
|
||||
if (typeof sp.deviceName === "string" && sp.deviceName.trim().length > 0) {
|
||||
t.deviceName = sp.deviceName.trim();
|
||||
}
|
||||
if (typeof sp.bitrate === "number" && VALID_BITRATES.includes(sp.bitrate)) {
|
||||
t.bitrate = sp.bitrate;
|
||||
}
|
||||
}
|
||||
```
|
||||
Add the type import if not present: `import type { SpotifyConfig } from "../../data/config.js";`.
|
||||
|
||||
- [ ] **Step 1.5: Run tests — expect pass** (`npx vitest run src/web/api/bot.test.ts`). Then `npx tsc --noEmit` clean.
|
||||
|
||||
- [ ] **Step 1.6: Commit.**
|
||||
```bash
|
||||
git add src/web/api/bot.ts src/web/api/bot.test.ts
|
||||
git commit -m "feat(spotify): expose spotify config on /api/bot/settings (secret masked) [S4.1]"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 2: `/api/spotify/status` reports the RESOLVED backend + binary availability (D11)
|
||||
|
||||
**Files:**
|
||||
- Create: `src/music/spotify/backend-select.ts` (pure resolver) + `src/music/spotify/backend-select.test.ts`
|
||||
- Modify: `src/music/spotify/controller.ts` (delegate `chooseBackend` to the resolver)
|
||||
- Modify: `src/web/api/spotify.ts` (`/status` shape + `getBackendInfo` type)
|
||||
- Modify: `src/web/server.ts` (`getBackendInfo` computes the resolved kind)
|
||||
- Modify: `src/web/api/spotify.test.ts` (update the `/status` shape assertion)
|
||||
|
||||
**Interfaces:**
|
||||
- Produces:
|
||||
```ts
|
||||
// backend-select.ts
|
||||
export type SpotifyBackendKind = "go-librespot" | "librespot";
|
||||
export function resolveSpotifyBackendKind(
|
||||
backend: "auto" | "go-librespot" | "librespot",
|
||||
goPresent: boolean,
|
||||
rustPresent: boolean,
|
||||
): SpotifyBackendKind | null;
|
||||
// spotify.ts getBackendInfo now returns:
|
||||
{ backend: string; deviceName: string; binaryAvailable: boolean }
|
||||
// /status response now:
|
||||
{ authorized: boolean; backend: string; deviceName: string; binaryAvailable: boolean }
|
||||
```
|
||||
- Note: `SpotifyBackendKind` currently lives in `controller.ts`. Move the canonical definition to `backend-select.ts` and re-export it from `controller.ts` (`export type { SpotifyBackendKind } from "./backend-select.js";`) so existing importers are unaffected.
|
||||
|
||||
- [ ] **Step 2.1: Write failing resolver tests** `src/music/spotify/backend-select.test.ts` — the same 8-case matrix S3.5 used, but against the pure function:
|
||||
```ts
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { resolveSpotifyBackendKind as pick } from "./backend-select.js";
|
||||
describe("resolveSpotifyBackendKind", () => {
|
||||
it("auto: go present -> go-librespot", () => expect(pick("auto", true, true)).toBe("go-librespot"));
|
||||
it("auto: go absent, rust present -> librespot", () => expect(pick("auto", false, true)).toBe("librespot"));
|
||||
it("auto: neither -> null", () => expect(pick("auto", false, false)).toBeNull());
|
||||
it("go-librespot: present -> go-librespot", () => expect(pick("go-librespot", true, true)).toBe("go-librespot"));
|
||||
it("go-librespot: absent -> null even if rust present", () => expect(pick("go-librespot", false, true)).toBeNull());
|
||||
it("librespot: present -> librespot", () => expect(pick("librespot", true, true)).toBe("librespot"));
|
||||
it("librespot: absent -> null even if go present", () => expect(pick("librespot", true, false)).toBeNull());
|
||||
it("auto default fallthrough matches auto", () => expect(pick("auto", true, false)).toBe("go-librespot"));
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2.2: Run — expect failure** (module missing).
|
||||
|
||||
- [ ] **Step 2.3: Create the resolver** `src/music/spotify/backend-select.ts`:
|
||||
```ts
|
||||
/** Which concrete backend runs for a given config + host binary availability. */
|
||||
export type SpotifyBackendKind = "go-librespot" | "librespot";
|
||||
|
||||
/**
|
||||
* Pure backend selection shared by SpotifyController.chooseBackend() (per-bot)
|
||||
* and the web /status endpoint (process-wide). Booleans in, no IO — the caller
|
||||
* supplies platform+binary presence.
|
||||
*/
|
||||
export function resolveSpotifyBackendKind(
|
||||
backend: "auto" | "go-librespot" | "librespot",
|
||||
goPresent: boolean,
|
||||
rustPresent: boolean,
|
||||
): SpotifyBackendKind | null {
|
||||
switch (backend) {
|
||||
case "go-librespot":
|
||||
return goPresent ? "go-librespot" : null;
|
||||
case "librespot":
|
||||
return rustPresent ? "librespot" : null;
|
||||
case "auto":
|
||||
default:
|
||||
if (goPresent) return "go-librespot";
|
||||
if (rustPresent) return "librespot";
|
||||
return null;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2.4: Run resolver tests — expect pass.**
|
||||
|
||||
- [ ] **Step 2.5: Delegate from the controller.** In `controller.ts`, import the type+resolver **with a local binding** (a bare `export … from` re-export does NOT create a local name, and `SpotifyBackendKind` is still referenced locally at `chooseBackend()`'s return type and `buildBackend(kind: SpotifyBackendKind)` → would fail TS2304). Use:
|
||||
```ts
|
||||
import { resolveSpotifyBackendKind, type SpotifyBackendKind } from "./backend-select.js";
|
||||
export type { SpotifyBackendKind }; // keep the name exported for existing importers
|
||||
// ...
|
||||
chooseBackend(): SpotifyBackendKind | null {
|
||||
return resolveSpotifyBackendKind(this.config.backend, this.goPresent(), this.rustPresent());
|
||||
}
|
||||
```
|
||||
Remove the old inline `switch` body and the standalone `export type SpotifyBackendKind = "go-librespot" | "librespot";` line. Keep `goPresent()/rustPresent()` as-is. Run `npx vitest run src/music/spotify/controller.test.ts` — the S3.5 matrix + auth-gate specs MUST still pass unchanged.
|
||||
|
||||
- [ ] **Step 2.6: Update `/status`** in `src/web/api/spotify.ts` — extend the `getBackendInfo` type and the response:
|
||||
```ts
|
||||
getBackendInfo: () => { backend: string; deviceName: string; binaryAvailable: boolean };
|
||||
// ...
|
||||
router.get("/status", requireNotGuest, (_req, res) => {
|
||||
const info = opts.getBackendInfo();
|
||||
res.json({
|
||||
authorized: oauth.isAuthorized(),
|
||||
backend: info.backend,
|
||||
deviceName: info.deviceName,
|
||||
binaryAvailable: info.binaryAvailable,
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
- [ ] **Step 2.7: Compute the resolved kind in `server.ts`.** Replace the `getBackendInfo` closure (currently returns raw `config.spotify.backend`) with a resolver call using live probes. Add imports `import { resolveSpotifyBackendKind } from "../music/spotify/backend-select.js";` and `import { isGoLibrespotSupported, findGoLibrespot, isRustLibrespotSupported, findLibrespot } from "../music/spotify/binary.js";` and `import { existsSync } from "node:fs";` (verify existsSync isn't already imported):
|
||||
```ts
|
||||
getBackendInfo: () => {
|
||||
const goPresent = isGoLibrespotSupported() && existsSync(findGoLibrespot());
|
||||
const rustPresent = isRustLibrespotSupported() && existsSync(findLibrespot());
|
||||
const resolved = resolveSpotifyBackendKind(options.config.spotify.backend, goPresent, rustPresent);
|
||||
return {
|
||||
backend: resolved ?? "none",
|
||||
deviceName: options.config.spotify.deviceName,
|
||||
binaryAvailable: resolved !== null,
|
||||
};
|
||||
},
|
||||
```
|
||||
|
||||
- [ ] **Step 2.8: Update the `/status` test** in `src/web/api/spotify.test.ts` — the existing `toEqual({ authorized, backend, deviceName })` must become `toEqual({ authorized, backend, deviceName, binaryAvailable })`; extend the fake `getBackendInfo` in that test to return `binaryAvailable`. This is THIS task's contract change; update only the status test.
|
||||
|
||||
- [ ] **Step 2.9: Verify.** `npx vitest run src/music/spotify/backend-select.test.ts src/music/spotify/controller.test.ts src/web/api/spotify.test.ts` all pass; `npx tsc --noEmit` clean.
|
||||
|
||||
- [ ] **Step 2.10: Commit.**
|
||||
```bash
|
||||
git add src/music/spotify/backend-select.ts src/music/spotify/backend-select.test.ts src/music/spotify/controller.ts src/web/api/spotify.ts src/web/server.ts src/web/api/spotify.test.ts
|
||||
git commit -m "feat(spotify): report resolved backend + binaryAvailable on /status; share backend resolver [S4.2]"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 3: OAuth robustness — in-flight refresh cache + verifier TTL/cap (D9)
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/music/spotify/spotify-oauth.ts`
|
||||
- Test: `src/music/spotify/spotify-oauth.test.ts`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: existing `SpotifyOAuthOptions.deps?: { http?: AxiosInstance }`. Extend deps with an optional clock for testability: `deps?: { http?: AxiosInstance; now?: () => number }`.
|
||||
- Produces: no public API change. Internals: `refreshInFlight: Promise<string|null> | null`; `pendingVerifiers: Map<string, { verifier: string; expiresAt: number }>`.
|
||||
|
||||
- [ ] **Step 3.1: Write failing tests.** Add to `src/music/spotify/spotify-oauth.test.ts`:
|
||||
1. **Concurrent refresh collapses to one POST.** Build with a fake `http` whose `post("/api/token")` returns a promise you resolve manually (a `Deferred`) or counts calls, and a MUTABLE fake store (`save()` persists, `load()` returns the last saved value) seeded with an expired token. Fire two `getAccessToken()` calls before the POST resolves; assert `http.post` called exactly ONCE and both awaited results equal the new access token.
|
||||
2. **In-flight clears after settle.** Using the same mutable store + a mutable `now` (`let t=…; now=()=>t`), after test 1 resolves, advance `t` past the newly-saved `expiresAt` and call `getAccessToken()` again → a NEW POST fires (count → 2). (Requires `toTokens` on `this.now()` per Step 3.3.)
|
||||
3. **Verifier TTL.** With injected mutable `now`, `buildAuthorizeUrl()` at t=0 (capture its `state`), advance `now` to TTL+1, then `handleCallback(code, state)` → returns false (expired) and the entry is gone.
|
||||
4. **Verifier cap.** Call `buildAuthorizeUrl()` `VERIFIER_MAX + 1` times (capturing the FIRST `state`); assert **behaviorally** that `handleCallback(code, <first state>)` now returns false (evicted as oldest). Prefer this behavioral assertion over inspecting the private `pendingVerifiers` map (no `as any` cast). Use the injected `now` for all timing.
|
||||
|
||||
- [ ] **Step 3.2: Run — expect failure.**
|
||||
|
||||
- [ ] **Step 3.3: Add the clock + in-flight refresh.** In the constructor: `this.now = o.deps?.now ?? (() => Date.now());` (add `private now: () => number;`). Rewrite `getAccessToken()` + add the in-flight field:
|
||||
```ts
|
||||
private refreshInFlight: Promise<string | null> | null = null;
|
||||
|
||||
async getAccessToken(): Promise<string | null> {
|
||||
if (!this.clientId) return null;
|
||||
const tokens = this.store.load();
|
||||
if (!tokens?.refreshToken) return null;
|
||||
if (tokens.accessToken && this.now() < tokens.expiresAt) return tokens.accessToken;
|
||||
// Collapse concurrent refreshes: rotation makes a second in-flight refresh
|
||||
// use a refresh token the first one already invalidated.
|
||||
if (this.refreshInFlight) return this.refreshInFlight;
|
||||
this.refreshInFlight = this.refresh(tokens).finally(() => {
|
||||
this.refreshInFlight = null;
|
||||
});
|
||||
return this.refreshInFlight;
|
||||
}
|
||||
```
|
||||
Replace the `Date.now()` in `getAccessToken` (spotify-oauth.ts:188) with `this.now()`. **Also change `toTokens` (spotify-oauth.ts:~221) to compute `expiresAt` from `this.now()` instead of `Date.now()`** — this is REQUIRED for testability: if `toTokens` kept real `Date.now()` while `getAccessToken` used an injected fixed clock, a freshly-refreshed token's `expiresAt` would sit far in the injected past/future and the "subsequent call → new POST" test would be non-deterministic. With both on `this.now()`, the test drives a mutable `now` (e.g. `let t = 0; const now = () => t;`) and advances it past the new `expiresAt` to force the second refresh.
|
||||
|
||||
- [ ] **Step 3.4: Add verifier TTL + cap.** Change the map type and the two touch points:
|
||||
```ts
|
||||
private pendingVerifiers = new Map<string, { verifier: string; expiresAt: number }>();
|
||||
private static readonly VERIFIER_TTL_MS = 10 * 60 * 1000;
|
||||
private static readonly VERIFIER_MAX = 32;
|
||||
|
||||
private evictStaleVerifiers(): void {
|
||||
const t = this.now();
|
||||
for (const [state, e] of this.pendingVerifiers) {
|
||||
if (e.expiresAt < t) this.pendingVerifiers.delete(state);
|
||||
}
|
||||
// Bound memory even if all are unexpired: drop oldest (insertion order).
|
||||
while (this.pendingVerifiers.size >= SpotifyOAuth.VERIFIER_MAX) {
|
||||
const oldest = this.pendingVerifiers.keys().next().value;
|
||||
if (oldest === undefined) break;
|
||||
this.pendingVerifiers.delete(oldest);
|
||||
}
|
||||
}
|
||||
```
|
||||
In `buildAuthorizeUrl()`: call `this.evictStaleVerifiers();` before the set, then `this.pendingVerifiers.set(state, { verifier, expiresAt: this.now() + SpotifyOAuth.VERIFIER_TTL_MS });`.
|
||||
In `handleCallback()`: replace the `get`:
|
||||
```ts
|
||||
const entry = this.pendingVerifiers.get(state);
|
||||
if (!entry || entry.expiresAt < this.now()) {
|
||||
this.pendingVerifiers.delete(state);
|
||||
return false;
|
||||
}
|
||||
const verifier = entry.verifier;
|
||||
```
|
||||
(Keep the existing `finally { this.pendingVerifiers.delete(state); }`.)
|
||||
|
||||
- [ ] **Step 3.5: Run tests — expect pass.** Then `npx vitest run src/music/spotify/spotify-oauth.test.ts` (all, incl. prior S3.2 tests) + `npx tsc --noEmit` clean.
|
||||
|
||||
- [ ] **Step 3.6: Commit.**
|
||||
```bash
|
||||
git add src/music/spotify/spotify-oauth.ts src/music/spotify/spotify-oauth.test.ts
|
||||
git commit -m "fix(spotify): collapse concurrent OAuth refresh + TTL/cap PKCE verifiers [S4.3]"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: Settings "Connect Spotify" card (spec §8)
|
||||
|
||||
**Files:**
|
||||
- Create: `web/src/composables/useSpotifySettings.ts` (pure, testable logic) + `web/src/composables/useSpotifySettings.test.ts`
|
||||
- Modify: `web/src/views/Settings.vue` (add the card + wiring)
|
||||
|
||||
**Interfaces (composable — the unit-tested surface):**
|
||||
```ts
|
||||
export interface SpotifyConfigForm {
|
||||
enabled: boolean;
|
||||
backend: "auto" | "go-librespot" | "librespot";
|
||||
clientId: string;
|
||||
clientSecret: string; // blank means "unchanged"
|
||||
deviceName: string;
|
||||
bitrate: number;
|
||||
}
|
||||
export interface SpotifyStatus { authorized: boolean; backend: string; deviceName: string; binaryAvailable: boolean; }
|
||||
export const SPOTIFY_DISCLAIMER: string; // Chinese risk copy
|
||||
export function buildSpotifyPayload(f: SpotifyConfigForm): { spotify: Record<string, unknown> }; // omits clientSecret when blank
|
||||
export function parseSpotifyRedirect(search: string): "success" | "error" | null; // from ?spotify=...
|
||||
export function statusSummary(s: SpotifyStatus | null, enabled: boolean): { label: string; tone: "ok" | "warn" | "off" };
|
||||
```
|
||||
|
||||
- [ ] **Step 4.1: Write failing composable tests** `web/src/composables/useSpotifySettings.test.ts` (root vitest picks it up; import from `./useSpotifySettings.js` per the repo's ESM `.js` convention):
|
||||
- `buildSpotifyPayload` includes `clientSecret` only when non-blank; always includes enabled/backend/clientId/deviceName/bitrate under a `spotify` key.
|
||||
- `parseSpotifyRedirect("?spotify=success")==="success"`, `"?spotify=error"==="error"`, `"?x=1"===null`.
|
||||
- `statusSummary(null, false)` → tone `"off"`; `statusSummary({authorized:false,binaryAvailable:false,...}, true)` → tone `"warn"`; `statusSummary({authorized:true,binaryAvailable:true,...}, true)` → tone `"ok"`.
|
||||
|
||||
- [ ] **Step 4.2: Run — expect failure** (module missing).
|
||||
|
||||
- [ ] **Step 4.3: Implement the composable** `web/src/composables/useSpotifySettings.ts`:
|
||||
```ts
|
||||
export interface SpotifyConfigForm { enabled: boolean; backend: "auto" | "go-librespot" | "librespot"; clientId: string; clientSecret: string; deviceName: string; bitrate: number; }
|
||||
export interface SpotifyStatus { authorized: boolean; backend: string; deviceName: string; binaryAvailable: boolean; }
|
||||
|
||||
// 实验性 · 灰色地带 · 需要 Premium · 使用你自己的开发者应用凭据
|
||||
export const SPOTIFY_DISCLAIMER =
|
||||
"实验性功能:通过 librespot 播放 Spotify 需要 Spotify Premium 账号,并使用你自己注册的 Spotify 开发者应用凭据。" +
|
||||
"该方式处于 Spotify 服务条款的灰色地带,风险自负;默认关闭,不会内置任何共享凭据。";
|
||||
|
||||
export function buildSpotifyPayload(f: SpotifyConfigForm): { spotify: Record<string, unknown> } {
|
||||
const spotify: Record<string, unknown> = {
|
||||
enabled: f.enabled,
|
||||
backend: f.backend,
|
||||
clientId: f.clientId,
|
||||
deviceName: f.deviceName,
|
||||
bitrate: f.bitrate,
|
||||
};
|
||||
if (f.clientSecret && f.clientSecret.length > 0) spotify.clientSecret = f.clientSecret;
|
||||
return { spotify };
|
||||
}
|
||||
|
||||
export function parseSpotifyRedirect(search: string): "success" | "error" | null {
|
||||
const v = new URLSearchParams(search).get("spotify");
|
||||
return v === "success" || v === "error" ? v : null;
|
||||
}
|
||||
|
||||
export function statusSummary(s: SpotifyStatus | null, enabled: boolean): { label: string; tone: "ok" | "warn" | "off" } {
|
||||
if (!enabled) return { label: "已关闭", tone: "off" };
|
||||
if (!s) return { label: "未知", tone: "warn" };
|
||||
if (!s.binaryAvailable) return { label: "未检测到 librespot 可执行文件", tone: "warn" };
|
||||
if (!s.authorized) return { label: "未授权(点击“连接 Spotify”登录)", tone: "warn" };
|
||||
return { label: `已就绪 · 后端 ${s.backend}`, tone: "ok" };
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4.4: Run composable tests — expect pass.**
|
||||
|
||||
- [ ] **Step 4.5: Add the card to `Settings.vue`.** Insert a new `.account-card`-style section in the settings surface, gated `v-if="can('platform.auth')"` (mirror the platform-login section). Follow the EXISTING patterns in this file:
|
||||
- typed input + Save → mirror the idle-timeout input/saver (`Settings.vue` idle-timeout block + `saveIdleTimeout()` → `POST /api/bot/settings`);
|
||||
- select group → mirror the quality button-group for `backend` and `bitrate`;
|
||||
- toggle → mirror `localAudioEnabled` for `enabled`.
|
||||
**Fields to render (all six):** the `enabled` toggle, `backend` group, `bitrate` group, a `clientId` text input, a `deviceName` text input, and a **Client Secret** field — a write-only password input (`type="password"`, `autocomplete="off"`), left BLANK on load with a "已设置 / 未设置" hint from `hasClientSecret`; a blank secret on Save means "unchanged" (never wipes). The Secret is §8-mandated — do not omit it.
|
||||
Wiring (use `axios`, matching the file's other calls):
|
||||
- **Load** on mount: `GET /api/bot/settings` → populate the form from `res.data.spotify` (leave `clientSecret` blank; show “已设置/未设置” from `hasClientSecret`); `GET /api/spotify/status` → status indicator via `statusSummary`.
|
||||
- **Save**: `POST /api/bot/settings` with `buildSpotifyPayload(form)`; on success re-load status.
|
||||
- **Connect**: `const { data } = await axios.get('/api/spotify/login'); window.location.href = data.url;` (guard errors → show message; a 403 means missing `platform.auth`).
|
||||
- **Redirect handling**: on mount, `parseSpotifyRedirect(window.location.search)`; if `success`/`error`, show a toast/message and strip the param (e.g. `history.replaceState`). Reuse the file's existing notification/toast mechanism if present; otherwise a simple reactive message line.
|
||||
- **Disclaimer**: render `SPOTIFY_DISCLAIMER` prominently in the card.
|
||||
Keep the `<script setup>` logic thin — delegate payload/summary/redirect parsing to the composable (already tested). Do not add a `.vue` test (no harness).
|
||||
- **Keep the two "spotify auth" concepts distinct:** the card's status comes ONLY from `/api/spotify/status` (playback OAuth `authorized`). Do NOT wire it to the player store's `authStatus.spotify`, which reflects `/api/auth/status?platform=spotify` (metadata Web-API `loggedIn`) — a different thing. Leave the player store untouched.
|
||||
- **`vue-tsc` typing:** annotate the form as `reactive<SpotifyConfigForm>({...})` and the status as `ref<SpotifyStatus | null>(null)`; otherwise a button-group assignment (`form.backend = 'librespot'`) widens `backend` to `string` and the `null` init breaks the union passed into `buildSpotifyPayload`/`statusSummary` under `vue-tsc --noEmit`.
|
||||
- **Hard order dependency:** `binaryAvailable` on `/api/spotify/status` exists only after Task 2 — execute this task AFTER Task 2.
|
||||
|
||||
- [ ] **Step 4.6: Build gate.** `cd web && npm run build` → `vue-tsc --noEmit` clean + vite build succeeds. Then from root `npx vitest run web/src/composables/useSpotifySettings.test.ts` green.
|
||||
|
||||
- [ ] **Step 4.7: Commit.**
|
||||
```bash
|
||||
git add web/src/composables/useSpotifySettings.ts web/src/composables/useSpotifySettings.test.ts web/src/views/Settings.vue
|
||||
git commit -m "feat(spotify): Connect-Spotify settings card (config + OAuth login + status) [S4.4]"
|
||||
```
|
||||
|
||||
**Notes:** NOT e2e-verifiable (needs a real account/binary). Verified = composable unit tests + `vue-tsc` typecheck + build. The card only exposes config + a login trigger; it never displays the stored `clientSecret` (GET returns `hasClientSecret`, not the value).
|
||||
|
||||
---
|
||||
|
||||
### Task 5: README Spotify section (Chinese) — spec §9/§11/§12
|
||||
|
||||
**Files:**
|
||||
- Modify: `README.md` (add a `## Spotify 音源(实验性)` section; add "Spotify" to the feature bullet if appropriate)
|
||||
|
||||
**Content (required — write real prose, not placeholders):**
|
||||
- [ ] **Step 5.1:** Add a top-level section `## Spotify 音源(实验性)` covering, in Chinese:
|
||||
1. **醒目警告框:** 实验性;需要 **Spotify Premium**;使用**你自己注册的 Spotify 开发者应用**(不内置任何共享凭据);处于 Spotify 服务条款灰色地带,风险自负;**默认关闭**。
|
||||
2. **工作原理(简述):** 通过 librespot(Rust)/ go-librespot(Linux)作为独立进程解码 → PCM → ffmpeg 重采样到 48k → 走现有 Opus 发送管线。元数据来自 Spotify Web API。
|
||||
3. **平台矩阵:** Windows → `librespot`(Rust);Linux/Docker → `go-librespot`(可回退 `librespot`);`auto` 自动选择(表格)。
|
||||
4. **获取二进制:** Rust librespot 无预编译包 → `cargo install librespot` 或 scoop/choco,或将可执行文件放入项目 `bin/`(`bin/librespot.exe` / `bin/librespot`)。go-librespot 仅提供 Linux 资产(`github.com/devgianlu/go-librespot/releases`),放入 `bin/go-librespot` 或加入 PATH。
|
||||
5. **注册开发者应用 + 回调:** 在 Spotify Developer Dashboard 建应用,取 Client ID,回调地址填 `http://127.0.0.1:<webPort>/api/spotify/callback`(与设置里的 Web 端口一致);PKCE 不需要 Client Secret。
|
||||
6. **启用步骤:** 设置页「连接 Spotify」卡片 → 填 Client ID、选后端、开启开关 → 保存 → 点「连接 Spotify」完成 OAuth 授权。
|
||||
7. **许可与来源:** go-librespot 为 **GPL-3.0**,作为独立子进程调用(mere aggregation,不影响本项目许可);附上其源码地址与许可说明(source offer)。
|
||||
8. **故障排查:** 「未检测到 librespot」→ 检查 `bin/` 或 PATH;「未授权」→ 完成 OAuth;Windows 不支持 go-librespot(FIFO 仅限 POSIX)。
|
||||
- [ ] **Step 5.2:** Sanity-check the doc renders (headings consistent with existing `##` style; links valid). No code test.
|
||||
- [ ] **Step 5.3: Commit.**
|
||||
```bash
|
||||
git add README.md
|
||||
git commit -m "docs(spotify): README Spotify source section — setup, binaries, warnings, license [S4.5]"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Rust Connect command retry/backoff (recovery/watchdog — spec §4.3/§13)
|
||||
|
||||
**Rationale:** Spec §4.3 mandates "a watchdog + retry/backoff for device-visibility latency and command 202/404 flakiness"; §13 lists Rust Connect as the **top risk** (mitigation: retry/backoff + degrade-to-skipped). Stage 3 already landed the device-visibility watchdog (`waitForDevice()` bounded poll in `rust-librespot.ts`) and per-track device-absence → skip (`findDeviceByName`→null → `playTrack` false → BotInstance skips). The remaining, un-built piece is transient-failure retry/backoff on the Connect **mutating commands** — this task adds it while preserving C3.6 (never reject up the queue path; swallow on exhaustion).
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/music/spotify/connect-api.ts` (retry/backoff around the mutating PUTs; optional injected `sleep`/`logger`)
|
||||
- Modify: `src/music/spotify/controller.ts` (pass `this.logger` into the default `SpotifyConnectApi`)
|
||||
- Test: `src/music/spotify/connect-api.test.ts`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: existing `constructor(getToken: () => Promise<string|null>, deps?: { http?: AxiosInstance })`. **Extend deps** to `{ http?: AxiosInstance; sleep?: (ms: number) => Promise<void>; logger?: import("pino").Logger }` (all optional → source-compatible).
|
||||
- No public method signature change: `transfer/play/pause/resume/seek` stay `Promise<void>` and still swallow on final failure.
|
||||
|
||||
- [ ] **Step 6.1: Write failing tests** in `src/music/spotify/connect-api.test.ts` (reuse the existing `getToken`/`http` injection pattern; inject a no-op `sleep: async () => {}` so no real timers run):
|
||||
1. `play()` retries a transient 404 then succeeds: `http.put` rejects once with `{ response: { status: 404 } }` then resolves → assert `http.put` called TWICE, no throw.
|
||||
2. `play()` exhausts on persistent 500: `http.put` always rejects `{ response: { status: 500 } }` → assert exactly `MAX_ATTEMPTS` calls, no throw (swallowed), and `logger.warn` called once (logger provided).
|
||||
3. Non-transient (403) is NOT retried: reject `{ response: { status: 403 } }` → exactly ONE call, no throw.
|
||||
4. `429` honors a **capped** `Retry-After`: reject once `{ response: { status: 429, headers: { "retry-after": "1" } } }` then resolve → `sleep` called with a bounded delay (≤ the cap) and 2 calls total.
|
||||
5. `transfer()` uses the same retry path (one representative non-`play` mutator) — 404-then-success → 2 calls.
|
||||
|
||||
- [ ] **Step 6.2: Confirm Red** (`npx vitest run src/music/spotify/connect-api.test.ts`).
|
||||
|
||||
- [ ] **Step 6.3: Implement retry/backoff.** Add module constants + a private helper and route each mutating PUT through it:
|
||||
```ts
|
||||
const TRANSIENT = new Set([404, 429, 500, 502, 503]);
|
||||
const MAX_ATTEMPTS = 3;
|
||||
const BASE_DELAY_MS = 150;
|
||||
const MAX_DELAY_MS = 2_000;
|
||||
// ...
|
||||
private async mutateWithRetry(put: () => Promise<unknown>): Promise<void> {
|
||||
for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
|
||||
try {
|
||||
await put();
|
||||
return;
|
||||
} catch (err: any) {
|
||||
const status = err?.response?.status;
|
||||
if (!TRANSIENT.has(status) || attempt === MAX_ATTEMPTS) {
|
||||
// C3.6: never reject up the queue path — swallow, but surface once.
|
||||
this.logger?.warn({ status }, "Spotify Connect command failed (exhausted/non-retryable)");
|
||||
return;
|
||||
}
|
||||
let delay = Math.min(BASE_DELAY_MS * 2 ** (attempt - 1), MAX_DELAY_MS);
|
||||
if (status === 429) {
|
||||
const ra = Number(err?.response?.headers?.["retry-after"]);
|
||||
if (Number.isFinite(ra) && ra > 0) delay = Math.min(ra * 1000, MAX_DELAY_MS);
|
||||
}
|
||||
await this.sleep(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
In the constructor: `this.sleep = deps?.sleep ?? ((ms) => new Promise((r) => setTimeout(r, ms)));` and `this.logger = deps?.logger;`. Rewrite `transfer/play/pause/resume/seek` so their body becomes: guard `authHeaders()` as today (unauth → `return;`, no retry), then `await this.mutateWithRetry(() => this.http.put(<url>, <body>, { headers, ... }));`. Keep the exact URLs/bodies/params from the current methods.
|
||||
|
||||
- [ ] **Step 6.4: Thread the logger from the controller.** In `controller.ts` where the default connect is built:
|
||||
```ts
|
||||
this.connect = o.connect ?? new SpotifyConnectApi(() => this.oauth.getAccessToken(), { logger: this.logger });
|
||||
```
|
||||
(`Logger` is already imported in controller.ts.) Injected-connect tests are unaffected.
|
||||
|
||||
- [ ] **Step 6.5: Update any conflicting existing connect test.** The S3.3 (C3.6) tests assert mutating calls swallow errors. If any asserts a single `http.put` call on a *transient*-status rejection, it now expects `MAX_ATTEMPTS` — update ONLY that count (this task's contract change). Do NOT weaken the swallow/no-throw guarantees or the non-transient single-call behavior.
|
||||
|
||||
- [ ] **Step 6.6: Verify.** `npx vitest run src/music/spotify/connect-api.test.ts src/music/spotify/controller.test.ts` all pass; `npx tsc --noEmit` clean.
|
||||
|
||||
- [ ] **Step 6.7: Commit.**
|
||||
```bash
|
||||
git add src/music/spotify/connect-api.ts src/music/spotify/connect-api.test.ts src/music/spotify/controller.ts
|
||||
git commit -m "feat(spotify): retry/backoff on Connect commands (device-latency/flakiness watchdog) [S4.6]"
|
||||
```
|
||||
|
||||
**Notes:** Bounded retry adds latency only on the (off-audio-path) control commands and only on transient failure; the injected `sleep` makes tests instant. Not e2e-verifiable (no real account). The `202`-accepted-but-not-effective case from §4.3 is NOT handled here (it needs post-command state verification, which the existing poll-based track-end already tolerates) — noted as a follow-up.
|
||||
|
||||
---
|
||||
|
||||
### Task 7: Stage 4 verification + whole-branch final review + finish
|
||||
|
||||
**Files:** none (verification + review + branch finish).
|
||||
|
||||
- [ ] **Step 7.1: Full verification.** `npx vitest run --no-file-parallelism` (all green), `npx tsc --noEmit` (clean), `cd web && npm run build` (clean). Record counts.
|
||||
- [ ] **Step 7.2: Whole-branch adversarial review.** Review the ENTIRE `feat/spotify-audio` branch (`git merge-base main HEAD`..HEAD) — Stages 2+3+4 — with a fan-out of finders across dimensions (lifecycle/teardown correctness, OAuth/token security + no-secret-leak, backend selection + gating, async races, error handling, test hygiene) and adversarial verification of each finding. Dispatch ONE fix subagent with the consolidated Critical/Important findings; roll up Minors.
|
||||
- [ ] **Step 7.3: Address findings**, re-verify, then use superpowers:finishing-a-development-branch to complete the branch (tests green → present options → execute choice).
|
||||
|
||||
---
|
||||
|
||||
## Self-Review (author)
|
||||
|
||||
- **Spec coverage:** §8 Settings card → Task 4; §9 binaries/GPL note + §11 README → Task 5; §12 "docs, README" → Task 5; §12/§4.3/§13 "recovery/watchdog" (Connect retry/backoff) → Task 6 (device-visibility watchdog + per-track skip already landed in Stage 3); D9 → Task 3; D11 → Task 2; config editability (prereq for the card) → Task 1.
|
||||
- **Deferred (documented, NOT built this stage), with rationale:** runtime binary auto-download (spec §9 calls it "optional"; README documents manual install + Docker instead — avoids a tar.gz/checksum/platform-detection downloader on the critical path); the §4.3 `202`-accepted-but-not-effective verification (needs post-command playback-state confirmation the poll-based track-end already tolerates); D10's separate play-not-reflected diagnostic beyond the retry-exhaustion `logger.warn` Task 6 adds. These are listed in the ledger as follow-ups.
|
||||
- **Placeholder scan:** backend tasks (1–3) carry complete code; frontend/docs (4–5) carry the tested composable in full + explicit wiring contracts + named existing patterns to mirror (Settings.vue has no component-test harness, so exact `.vue` template text is intentionally pattern-referenced, not dictated line-by-line).
|
||||
- **Type consistency:** `SpotifyBackendKind` canonicalized in `backend-select.ts`, re-exported from `controller.ts`; `getBackendInfo` return type updated in both `spotify.ts` and its `server.ts` supplier and the `/status` test; `buildSpotifyPayload`/`SpotifyStatus` shapes match Task 1's masked view (`hasClientSecret`) and Task 2's `/status` (`binaryAvailable`).
|
||||
@@ -0,0 +1,53 @@
|
||||
# Jellyfin 音源(主音源化)实施计划
|
||||
|
||||
目标:自建 Jellyfin 服务器成为默认且主要的音源;现有 NetEase / QQ / Bilibili / YouTube / Kugou
|
||||
继续编译但默认停用(`enabledProviders` 配置门控,本次不删除)。约束:`src/audio/*`、
|
||||
`src/ts-protocol/*` 不改(唯一例外:`queue.ts` 中 `QueuedSong.platform` 联合类型加一个成员,
|
||||
纯类型加宽,无任何逻辑改动,否则无法编译)。
|
||||
|
||||
## 触点地图
|
||||
|
||||
后端:
|
||||
- `src/music/provider.ts` — platform 联合类型加 `"jellyfin"`(Song/Playlist/Album/MusicProvider)
|
||||
- `src/audio/queue.ts` — 同上(仅类型,一个词)
|
||||
- `src/data/database.ts` — PlayHistoryRecord.platform 加 `"jellyfin"`
|
||||
- `src/music/auth.ts` — CookieStore 平台加 `"jellyfin"`(token JSON 与 cookie 同路径持久化)
|
||||
- `src/data/config.ts` — 新增 `JellyfinConfig`(serverUrl / authMode / username / password /
|
||||
apiKey / userId)+ `enabledProviders`(默认 `["jellyfin"]`)+ 载入清洗 + `isProviderEnabled` /
|
||||
`defaultPlatform` 助手。spotify 仍由 `spotify.enabled` 门控、local 仍由 `localAudioEnabled` 门控
|
||||
- `src/music/jellyfin.ts` — 新 Provider:认证(userpass=AuthenticateByName + MediaBrowser 头,
|
||||
401 重登一次;apikey=X-Emby-Token)、搜索(Audio/MusicAlbum/Playlist, StartIndex 翻页)、
|
||||
懒解析播放 URL(direct=`/Audio/{id}/stream?static=true`;320/192/128=`/Audio/{id}/universal`
|
||||
转码)、歌单/专辑/歌词(ticks→秒,404=无歌词)、收藏→InstantMix 电台链(收藏→最近播放→随机曲目)、
|
||||
最近添加/最多播放/流派、播放上报(Sessions/Playing[/Progress|/Stopped],全部吞错)、
|
||||
音质档(direct 原始直传 / 320k / 192k / 128k)
|
||||
- `src/music/api-server.ts` — 按 provider 开关决定是否绑定 3001/3200
|
||||
- `src/index.ts` — 构造 JellyfinProvider、加载持久化 token、穿线
|
||||
- `src/bot/manager.ts` — 穿线 jellyfinProvider(与 spotifyProvider 同模式)
|
||||
- `src/bot/instance.ts` — jellyfin 分支(getProviderFor / getProvider,新 flag `-j`/`-n`)、
|
||||
默认平台=jellyfin、停用音源友好报错、歌单/专辑命令识别 GUID、播放上报挂钩、帮助文本
|
||||
- `src/web/api/music.ts` — provider 选择 + 门控、`/providers`、jellyfin 首页数据端点、音质路由
|
||||
- `src/web/api/auth.ts` — jellyfin 状态 + 测试连接(/System/Info);无 QR
|
||||
- `src/web/api/player.ts` — 平台白名单 + platformFlag(netease 显式 `-n`)
|
||||
- `src/web/api/bot.ts` — settings 读写 jellyfin 配置块(密码/APIKey 写入不回显)+ 热更新 provider
|
||||
|
||||
前端(Vue 3,保持 YesPlayMusic 风格;新增文案 zh+en):
|
||||
- `stores/player.ts` — Source 加 jellyfin、enabledProviders 状态、jellyfin 首页数据
|
||||
- `views/Search.vue` — 音源条只显示启用的 provider、Jellyfin 徽标
|
||||
- `views/Home.vue` — 最近添加 / 播放最多 / 我的歌单 / 收藏 / 流派 区块 + jellyfin FM 卡片
|
||||
- `views/Settings.vue` — Jellyfin 连接卡(地址/认证模式/凭据/测试连接)、隐藏停用 provider 的
|
||||
登录卡、jellyfin 音质档
|
||||
- `views/Setup.vue` — 向导第 3 步换成 Jellyfin 连接卡
|
||||
- `views/Playlist.vue` 等 — ID 均按 string 处理,审计通过(GUID 无数字假设)
|
||||
|
||||
文档:README 增加「Jellyfin 音源」章节 + fork 出处与 MIT 归属(上游
|
||||
ZHANGTIANYAO1/teamspeak-music-bot)。
|
||||
|
||||
## 阶段与验证
|
||||
|
||||
1. 类型 + 配置 → `npx tsc --noEmit`
|
||||
2. JellyfinProvider + 单测 → tsc + vitest
|
||||
3. 门控 + bot 穿线 → tsc + vitest
|
||||
4. REST → tsc + vitest
|
||||
5. WebUI → `cd web && npm run build`
|
||||
6. README + 全量构建/测试
|
||||
@@ -0,0 +1,149 @@
|
||||
# 自定义机器人头像 + 专辑搜索/播放
|
||||
|
||||
**Date:** 2026-05-07
|
||||
**Status:** Spec — pending implementation
|
||||
**Issue:** [#51](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/51)
|
||||
|
||||
## Problem
|
||||
|
||||
Issue #51 的两个独立但同源的反馈:
|
||||
|
||||
1. **机器人头像无法固定** — 当前 `ProfileConfig.avatarEnabled` 控制是否同步专辑封面,但没有任何"上传一张固定头像"的入口。多 bot 房间里用户依赖头像辨识具体 bot,封面跟着歌变会让识别成本变高。
|
||||
2. **网页端搜索不能播放整张专辑** — `SearchResult.albums` 类型字段存在但所有 provider 都返回 `[]`,搜索 API `/search/all` 只聚合 `songs`;Search.vue 里也只渲染 SongCard。Netease 后端 `getAlbumSongs` 已实现,唯独缺把搜索/UI 连起来。
|
||||
|
||||
两件事独立,分两个 PR;本 spec 同时覆盖两块以保持 #51 的单一 issue 关系。
|
||||
|
||||
## Goal
|
||||
|
||||
### 自定义头像
|
||||
|
||||
- "创建新实例"弹窗里有一个"自定义头像"上传/预览控件(PNG/JPG/WebP,≤200 KB,与 TS3 头像上限一致)
|
||||
- Settings 已有的"同步头像"那行下面增加同等的"自定义头像"卡片,可以在已存在的 bot 上随时改/删
|
||||
- 行为矩阵:
|
||||
|
||||
| `avatarEnabled` | 有自定义 | 播放时 | 停播时 |
|
||||
|---|---|---|---|
|
||||
| true | 是 | 跟当前歌曲封面 | **回到自定义** |
|
||||
| true | 否 | 跟当前歌曲封面 | 清空(保持现状) |
|
||||
| false | 是 | 一直显示自定义 | 一直显示自定义 |
|
||||
| false | 否 | 不主动改 | 不主动改 |
|
||||
|
||||
### 专辑搜索
|
||||
|
||||
- 搜索结果里能看到"专辑"分区(先支持 Netease + QQ,bilibili/youtube 仍返回 `[]`)
|
||||
- 点专辑卡片进入详情页 → 看到曲目列表 + 顶部"播放全部 / 加入队列"
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- 头像格式自动转换(用户传 GIF/BMP 不接受,前端校验拒掉)
|
||||
- 头像服务端自动 resize(本期保持"上传时校验大小",后期可加 sharp/jimp 但不在本期)
|
||||
- 专辑搜索的多平台聚合排序(按 `netease → qq` 简单拼接,与现有 `songs` 聚合一致)
|
||||
- 专辑详情页的"喜欢/收藏"按钮(playlist 详情页本身也没有)
|
||||
- 专辑作为推荐位(Home 不出现"推荐专辑"这一栏)
|
||||
- bilibili / youtube 的专辑概念(这两个平台无对应 API)
|
||||
|
||||
## Architecture
|
||||
|
||||
### 自定义头像
|
||||
|
||||
#### 存储
|
||||
|
||||
- 文件落地 `data/avatars/<botId>.<ext>`(仿 `data/cookies/<platform>.json`,Docker volume 友好)
|
||||
- DB schema:`bot_instances` 表新增 `custom_avatar_path` TEXT NULL(存相对路径,如 `avatars/<botId>.png`),通过 `migrateSchema()` 迁移
|
||||
- 加载时机:`BotProfileManager` 构造时把文件读到内存 `Buffer`,避免每次 stop 都读盘
|
||||
|
||||
#### 后端 API
|
||||
|
||||
新增 `src/web/api/bot.ts` 里(如不存在则在 `instance.ts` 同源处):
|
||||
|
||||
- `POST /api/bot/:id/avatar` (multipart) — 校验大小 ≤200 KB、MIME ∈ {png,jpeg,webp};写盘 + 更新 DB;广播给运行中实例(重新加载 buffer + 立即 `applyIdleAvatar()`)
|
||||
- `DELETE /api/bot/:id/avatar` — 删盘 + 清 DB;运行中实例切回原 clear 语义
|
||||
- `GET /api/bot/:id/avatar` — 直接 `res.sendFile`(带强 ETag)供前端预览
|
||||
|
||||
#### `BotProfileManager` 改动
|
||||
|
||||
新增字段 + 方法:
|
||||
|
||||
```ts
|
||||
private customAvatar: Buffer | null = null;
|
||||
|
||||
setCustomAvatar(buf: Buffer | null): void;
|
||||
private async applyIdleAvatar(gen: number): Promise<void>; // 上传 customAvatar
|
||||
```
|
||||
|
||||
修改:
|
||||
|
||||
- `clearAvatar(gen)` → `if (this.customAvatar) { applyIdleAvatar(gen) } else { 当前逻辑 }`
|
||||
- `onConnect()` 新增:`if (!avatarEnabled && customAvatar) applyIdleAvatar(gen)`
|
||||
- `setCustomAvatar(buf)`:更新内存 buffer,并触发 `applyIdleAvatar` 一次(仅当当前应该显示 idle avatar 时,即没在播放或 avatarEnabled=false)
|
||||
|
||||
#### 前端
|
||||
|
||||
新组件 `web/src/components/AvatarUpload.vue`:
|
||||
|
||||
- props: `botId?` (上传时空表示走临时 base64 缓存)、`v-model:value`
|
||||
- 拖拽 / 文件选择 / 预览圆框 / 删除按钮
|
||||
- 内部 `axios.post('/api/bot/<id>/avatar', formData)` 或在创建表单里把 base64 与表单一同提交
|
||||
|
||||
接入点:
|
||||
|
||||
- 创建实例弹窗(搜索 `BotEditor.vue` 或类似)—— 表单提交后用返回的 botId 再 POST 头像;或者表单本身保存 base64 等创建完成后由后端解码落盘
|
||||
- Settings.vue:在 features 列表中插入一行"自定义头像",右侧渲染 `<AvatarUpload :bot-id="botId" />`
|
||||
|
||||
### 专辑搜索 / 详情
|
||||
|
||||
#### 后端
|
||||
|
||||
`src/music/netease.ts` `search()`:
|
||||
|
||||
- 多发一个 `cloudsearch?type=10` 请求,把返回的 `result.albums[]` 映射成 `Album[]` 填进 `SearchResult.albums`
|
||||
- 字段 `id` / `name` / `coverUrl` (`picUrl`) / `artist` (`artists[].name.join(' / ')`)
|
||||
|
||||
`src/music/qq.ts` `search()`:
|
||||
|
||||
- 在现有 `req_0` 旁增加 `req_album: { module: "music.search.SearchCgiService", method: "DoSearchForQQMusicDesktop", param: { searchid, query, search_type: 8 } }`,映射 `body.album.list[]`
|
||||
|
||||
`src/web/api/music.ts` `/search/all`:
|
||||
|
||||
- 在响应里增加 `albums` 和 `playlists`,与 `songs` 一同合并
|
||||
|
||||
`/album/:id` 已存在,无需改动。
|
||||
|
||||
#### 前端
|
||||
|
||||
- `web/src/views/Search.vue`:响应 schema 升级为 `{songs, albums, playlists}`;模板加入两个新分区("专辑"、"歌单"),各自一个简单的卡片网格(参考 Home.vue 的 `playlist-grid`)
|
||||
- 新路由 `/album/:id` → 复用 `Playlist.vue`,把它的 `loadPlaylist()` 重构为根据 `route.path` 决定调 `/playlist/:id` 还是 `/album/:id`,或者新建 `Album.vue` 内部 import 同一个 `<PlaylistDetail />` 子组件
|
||||
- **方案选择**:拆出 `<PlaylistDetail :endpoint="...">` 组件 + `Album.vue` / `Playlist.vue` 两个薄壳。当前 `Playlist.vue` 内部仅 ~60 行模板,单文件改造比新建 PlaylistDetail 子组件更小,先用最小改动:在 `Playlist.vue` 内根据 `route.meta.kind === 'album'` 切换 endpoint
|
||||
- 路由:`router/index.ts` 加 `{ path: '/album/:id', component: Playlist, meta: { kind: 'album' } }`
|
||||
|
||||
### 拆分
|
||||
|
||||
**两个 PR:**
|
||||
|
||||
1. `feat(profile): custom bot avatar with idle/playback precedence`
|
||||
- DB migration + ProfileManager 改动 + 上传 API + AvatarUpload.vue + 接入两个表单
|
||||
2. `feat(search): album section in search results + album detail playback`
|
||||
- netease/qq search 扩展 + /search/all + Search.vue 分区 + Playlist.vue 复用为 album
|
||||
|
||||
## Testing
|
||||
|
||||
### 自定义头像
|
||||
|
||||
- 单元:DB 迁移加 `custom_avatar_path` 列幂等;上传 API 校验大小/MIME;ProfileManager.applyIdleAvatar 在 onSongChange(null) 后被调用
|
||||
- 集成:mock TS3Client 验证 fileTransferInitUpload 收到的 buffer 是 customAvatar
|
||||
- 手动:本地起 bot 上传一张 png → 检查头像;播一首歌 → 头像切封面;停止 → 头像回到 png;关掉 avatarEnabled 重启 → 头像直接是 png
|
||||
|
||||
### 专辑搜索
|
||||
|
||||
- 单元:netease/qq `search()` 测试:响应包含 albums 字段,长度 > 0 (mock fixture 必须含 album 段)
|
||||
- 集成:`/search/all` 响应 schema 包含 `albums`/`playlists`
|
||||
- 手动:搜"周杰伦" → 看到歌曲 + 专辑 + 歌单三个分区;点专辑 → 详情页 → 播放全部 → 队列加上整张专辑
|
||||
|
||||
## Migration
|
||||
|
||||
DB 迁移:`bot_instances.custom_avatar_path` TEXT NULL,默认 NULL。已存在 bot 不受影响。
|
||||
|
||||
## Open Questions
|
||||
|
||||
- TS6 协议路径下 `fileTransferInitUpload` 是否一致?(既有 avatar 流程已经覆盖 TS3 + TS6,本期沿用同一路径,不单独验证)
|
||||
- 头像超过 200 KB 时前端用 Canvas 自动 resize 还是直接拒?— **决定:拒,错误提示"请压缩到 200KB 以内"**,简单可控
|
||||
@@ -0,0 +1,360 @@
|
||||
# WebUI Authentication
|
||||
|
||||
**Date:** 2026-05-27
|
||||
**Status:** Spec — pending implementation
|
||||
**Branch:** `feat/webui-auth`
|
||||
|
||||
## Problem
|
||||
|
||||
WebUI 的所有后端端点和 WebSocket 当前没有任何鉴权:
|
||||
|
||||
- `src/web/server.ts` 注册的 `/api/bot`、`/api/player`、`/api/music`、`/api/auth`、`/api/config/public-url`、`/api/health`、`/ws` 均无中间件拦截。
|
||||
- 静态前端通过 `express.static()` 直接对外提供。
|
||||
|
||||
后果:任何能访问 WebUI 端口(默认 `3000`)的人都能控制 bot、修改配置、操控播放,并触发对网易云 / QQ / Bilibili 的登录二维码流程。一旦 WebUI 端口暴露公网(无论是直接绑定 `0.0.0.0`、还是经 nginx 反代),即被任意访客接管。
|
||||
|
||||
## Goal
|
||||
|
||||
为 WebUI 增加用户名 + 密码登录,覆盖所有 HTTP `/api/*` 端点(除显式公共白名单)以及 `/ws` WebSocket,使未登录访客无法调用任何敏感接口或观察 bot 状态。
|
||||
|
||||
## Out of Scope(明确不做)
|
||||
|
||||
- 登录失败的限流 / 锁定(无 brute-force 防御;可放在反代层;后续 PR 单独做)
|
||||
- 角色与权限(admin / viewer)—— 全员同权
|
||||
- 密码重置流程(不挂邮件;仅提供登录后 `change-password`)
|
||||
- 双因素认证(2FA)
|
||||
- "记住我" / 绝对过期 vs 滑动过期的可配置
|
||||
- 旧版"无鉴权"兼容开关(`requireAuth=false`)—— 合入后所有部署强制启用鉴权
|
||||
- 现有 `config.adminPassword` 字段的迁移 —— 保留为未使用字段,避免破坏旧 `config.json`
|
||||
|
||||
## Non-functional Constraints
|
||||
|
||||
- 不引入需要原生编译的依赖(Windows 用户多,build tools 不稳定)。密码哈希用纯 JS 的 `bcryptjs`。
|
||||
- Cookie 行为必须兼容现有 `trustProxy` 反代部署。
|
||||
- 升级路径:旧用户首次启动新版本 → 自动进入 `/setup` 创建首位 admin;期间所有 `/api/*` 仍拒绝访问。期间不存在"裸奔窗口"。
|
||||
- 后续维护者要能在不阅读 `requireAuth` 内部细节的情况下,把新路由挂到 `/api/*` 下并自动获得鉴权。
|
||||
|
||||
## Architecture
|
||||
|
||||
### 数据层(`src/data/`)
|
||||
|
||||
扩展 `src/data/database.ts` 的 schema-migration 块,新增两张表:
|
||||
|
||||
```sql
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id TEXT PRIMARY KEY, -- uuid v4
|
||||
username TEXT NOT NULL UNIQUE COLLATE NOCASE,
|
||||
passwordHash TEXT NOT NULL, -- bcryptjs, 12 rounds
|
||||
createdAt INTEGER NOT NULL,
|
||||
updatedAt INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS sessions (
|
||||
id TEXT PRIMARY KEY, -- sha256(rawToken) hex
|
||||
userId TEXT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
||||
createdAt INTEGER NOT NULL,
|
||||
expiresAt INTEGER NOT NULL, -- ms epoch
|
||||
lastSeenAt INTEGER NOT NULL
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_sessions_userId ON sessions(userId);
|
||||
CREATE INDEX IF NOT EXISTS idx_sessions_expiresAt ON sessions(expiresAt);
|
||||
```
|
||||
|
||||
**为什么 `sessions.id` 存 sha256(token) 而不是 token 本身:** 若 SQLite 文件被泄露(备份、误传、磁盘扫描),原始 token 会让攻击者直接冒充任意已登录用户。存 hash 后只能爆破。代价仅是每次请求一次 sha256。
|
||||
|
||||
新模块:
|
||||
|
||||
`src/data/users.ts`
|
||||
- `createUser(username, password): User` — 在事务里 INSERT;遇到 UNIQUE 冲突抛出 `UsernameTakenError`
|
||||
- `findByUsername(username): User | null`
|
||||
- `verifyPassword(plain, hash): Promise<boolean>` — bcryptjs compare
|
||||
- `countUsers(): number` — 用于 `/needs-setup`
|
||||
- `changePassword(userId, newPassword): void`
|
||||
|
||||
`src/data/sessions.ts`
|
||||
- `createSession(userId): { token: string; expiresAt: number }` — 生成 32 字节随机 token(`crypto.randomBytes(32).toString('base64url')`),存 sha256
|
||||
- `validateAndTouch(rawToken): { userId, username } | null` — 单次 SQL JOIN:查 session + user;过期 → 返回 null + 删除该行;否则若 `now - lastSeenAt > 1h` 则 UPDATE 滑动续期到 `now + 7d`
|
||||
- `deleteSession(rawToken): void` — 退出
|
||||
- `deleteAllForUser(userId, exceptToken?): void` — change-password 时调用,可保留当前会话
|
||||
- `cleanupExpired(): void` — 定时任务
|
||||
|
||||
### HTTP 层(`src/web/`)
|
||||
|
||||
#### 新增中间件
|
||||
|
||||
`src/web/middleware/requireAuth.ts`
|
||||
```
|
||||
读取 req.cookies.tsmb_session
|
||||
→ 缺失 → 401 { error: "unauthenticated" }
|
||||
→ 调 sessions.validateAndTouch
|
||||
→ null → 清 cookie + 401
|
||||
→ 有效 → req.user = { id, username }; next()
|
||||
```
|
||||
|
||||
`src/web/middleware/csrf.ts`
|
||||
```
|
||||
若 method ∈ {GET, HEAD, OPTIONS} → next()
|
||||
否则要求 req.headers.origin || req.headers.referer 的 host 与 req.get('host') 一致
|
||||
→ 不一致或两者都缺失 → 403 { error: "bad origin" }
|
||||
```
|
||||
|
||||
#### 新路由:`src/web/api/session.ts`
|
||||
|
||||
挂在 `/api/session`,全部公共(不挂 requireAuth):
|
||||
|
||||
| Method | Path | 行为 |
|
||||
|---|---|---|
|
||||
| GET | `/needs-setup` | `{ needsSetup: users.countUsers() === 0 }` |
|
||||
| POST | `/setup` | Body `{ username, password }`。在事务内再次检查 `countUsers() === 0`:是则 INSERT user + 立刻 createSession + Set-Cookie + 200 `{ id, username }`;否则 409 `{ error: "already initialized" }` |
|
||||
| POST | `/login` | Body `{ username, password }`。匹配则 createSession + Set-Cookie + 200;不匹配则等待 250ms 后 401 `{ error: "invalid credentials" }`(常量时间延迟,降低用户名枚举风险) |
|
||||
| POST | `/logout` | 删 session,清 cookie,204 |
|
||||
| GET | `/me` | 走 requireAuth;返回 `{ id, username }` |
|
||||
| POST | `/change-password` | 走 requireAuth;Body `{ oldPassword, newPassword }`;通过则 changePassword + deleteAllForUser(except 当前) + 204 |
|
||||
|
||||
> `/me` 与 `/change-password` 例外地需要 requireAuth —— 在路由内单独挂中间件,避免污染 `/api/session/*` 的公共属性。
|
||||
|
||||
#### Cookie 规范
|
||||
|
||||
- 名称:`tsmb_session`
|
||||
- 值:32 字节 random → base64url
|
||||
- 属性:`HttpOnly; SameSite=Lax; Path=/; Max-Age=604800`(7 天)
|
||||
- `Secure` 标志:当 `req.secure === true`(依赖 `trustProxy` + `X-Forwarded-Proto`);本地 HTTP 调试时不加,避免 cookie 被丢弃
|
||||
|
||||
#### 装配顺序(`src/web/server.ts`)
|
||||
|
||||
```ts
|
||||
app.use(express.json({ limit: "400kb" }));
|
||||
app.use(cookieParser()); // 新增
|
||||
|
||||
// 公共
|
||||
app.get("/api/health", …);
|
||||
app.get("/api/config/public-url", …);
|
||||
app.use("/api/session", createSessionRouter(...));
|
||||
|
||||
// 闸门(仅作用于下方注册的 /api/* 路由)
|
||||
app.use("/api", csrfOriginCheck);
|
||||
app.use("/api", requireAuth);
|
||||
|
||||
// 受保护
|
||||
app.use("/api/bot", createBotRouter(...));
|
||||
app.use("/api/music", createMusicRouter(...));
|
||||
app.use("/api/player", createPlayerRouter(...));
|
||||
app.use("/api/auth", createAuthRouter(...)); // 音乐平台 QR
|
||||
|
||||
// 静态 SPA(公共,前端自行判定登录态后跳转)
|
||||
app.use(express.static(staticDir));
|
||||
app.get(/^(?!\/api|\/ws)/, sendIndex);
|
||||
```
|
||||
|
||||
> Express 的 `app.use` 仅对匹配前缀生效。公共路由先注册即可命中;之后的 `app.use("/api", …)` 闸门只在公共路由未匹配时执行,因此 `/api/health`、`/api/config/public-url`、`/api/session/*` 不会被闸门拦截。
|
||||
|
||||
#### 定时清理
|
||||
|
||||
`server.start()` 内启动 `setInterval(cleanupExpired, 60 * 60 * 1000)`,`server.stop()` 内 `clearInterval`。
|
||||
|
||||
### WebSocket 层(`src/web/websocket.ts` + `src/web/server.ts`)
|
||||
|
||||
改造为手动 upgrade:
|
||||
|
||||
```ts
|
||||
const wss = new WebSocketServer({ noServer: true });
|
||||
|
||||
server.on("upgrade", (req, socket, head) => {
|
||||
if (req.url !== "/ws") { socket.destroy(); return; }
|
||||
const session = validateCookieFromHeaders(req.headers.cookie);
|
||||
if (!session) {
|
||||
socket.write("HTTP/1.1 401 Unauthorized\r\nConnection: close\r\n\r\n");
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
wss.handleUpgrade(req, socket, head, (ws) => {
|
||||
(ws as any).userId = session.userId;
|
||||
wss.emit("connection", ws, req);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
`validateCookieFromHeaders` 在 `src/web/auth/validateSession.ts` 提供,HTTP 中间件与 WS upgrade 共用同一实现,确保不会出现"HTTP 拒、WS 放行"或反之的偏差。
|
||||
|
||||
不需要在 upgrade 上单独做 CSRF:浏览器在跨站 WebSocket 请求里仍会带 Origin 头,可在 validate 之外顺手比对 `req.headers.origin` host 与 `req.headers.host` 一致;不一致直接拒绝。
|
||||
|
||||
### 前端层(`web/`)
|
||||
|
||||
#### 新视图
|
||||
|
||||
- `web/src/views/Login.vue` — 用户名 + 密码表单 → POST `/api/session/login` → 成功跳 `next` 或 `/`
|
||||
- `web/src/views/FirstRunSetup.vue` — 同样表单 + 二次确认密码 → POST `/api/session/setup` → 成功后自动登录并跳 `/`
|
||||
- 名称避免与既有 `Setup.vue`(bot 创建向导)冲突
|
||||
|
||||
#### Session 状态
|
||||
|
||||
新增 `web/src/composables/useSession.ts`:暴露 `currentUser: Ref<User|null>`、`refresh()`、`logout()`、`needsSetup: Ref<boolean>`。在 `App.vue` mount 时调用 `refresh()`。
|
||||
|
||||
#### 路由守卫(`web/src/router/index.ts`)
|
||||
|
||||
- 公共路由:`/login`、`/setup`
|
||||
- 全局 `beforeEach`:
|
||||
1. 先 `GET /api/session/needs-setup`(仅在 `needsSetup` 未知时拉一次并缓存)
|
||||
2. `needsSetup === true` 且目标不是 `/setup` → `redirect('/setup')`
|
||||
3. 否则 `GET /api/session/me`,401 且目标非公共路由 → `redirect('/login?next=<path>')`
|
||||
|
||||
#### API 客户端
|
||||
|
||||
- 所有 `fetch` 改为 `credentials: 'same-origin'`(若现有有 wrapper 则改一处;否则按文件逐个改 —— 实施时由 plan 列出)
|
||||
- 包一层 401 拦截器:任意受保护请求返回 401 → 清 `currentUser` → `router.push('/login')`
|
||||
|
||||
#### UI
|
||||
|
||||
- 顶栏新增已登录用户名 + "退出"按钮(POST `/logout` → `router.push('/login')`)
|
||||
- 修改密码入口暂放在已有的"设置"页签内(若无则新增极简 section)
|
||||
|
||||
### 依赖
|
||||
|
||||
新增到 `package.json`:
|
||||
|
||||
```
|
||||
"bcryptjs": "^2.4.3",
|
||||
"cookie-parser": "^1.4.6",
|
||||
"@types/bcryptjs": "^2.4.6",
|
||||
"@types/cookie-parser": "^1.4.7"
|
||||
```
|
||||
|
||||
不引入 `express-session`、`jsonwebtoken`、`passport` 等更大栈。
|
||||
|
||||
## Data Flow
|
||||
|
||||
### 首次启动
|
||||
|
||||
```
|
||||
Browser → GET / → static SPA
|
||||
SPA mounted → GET /api/session/needs-setup → { needsSetup: true }
|
||||
SPA → router.replace('/setup')
|
||||
User submits form → POST /api/session/setup
|
||||
Server (TX): countUsers() === 0 → INSERT user → createSession → Set-Cookie → 200
|
||||
SPA → currentUser refresh → router.replace('/')
|
||||
```
|
||||
|
||||
### 已部署用户升级
|
||||
|
||||
旧 `config.adminPassword` 字段保留不动;首次启动新版本仍会因 `users` 表为空而进入 setup 流程 —— 旧字段不被采纳,避免歧义。
|
||||
|
||||
### 后续登录
|
||||
|
||||
```
|
||||
SPA → GET /api/session/me → 401
|
||||
SPA → router.replace('/login?next=/queue')
|
||||
User submits → POST /api/session/login → Set-Cookie + 200
|
||||
SPA → currentUser refresh → router.replace('/queue')
|
||||
```
|
||||
|
||||
### 受保护请求
|
||||
|
||||
```
|
||||
SPA → fetch('/api/bot', { credentials: 'same-origin' })
|
||||
Server requireAuth: validateAndTouch(cookie)
|
||||
→ ok → req.user 注入 → 业务路由处理
|
||||
→ 不 ok → 401 → SPA 拦截器跳 /login
|
||||
```
|
||||
|
||||
### WebSocket
|
||||
|
||||
```
|
||||
SPA → new WebSocket(`${wsScheme}://${host}/ws`) // 浏览器自动带 cookie
|
||||
Server upgrade handler: validateCookieFromHeaders
|
||||
→ ok → handleUpgrade → connection event
|
||||
→ 不 ok → HTTP 401 写回原始 socket → destroy
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
| 场景 | HTTP 响应 | 备注 |
|
||||
|---|---|---|
|
||||
| 未带 cookie | 401 `{ error: "unauthenticated" }` | requireAuth |
|
||||
| Cookie 解析失败 / token 不存在 | 401 + `Set-Cookie tsmb_session=; Max-Age=0` 清掉 | 自愈 |
|
||||
| Session 过期 | 同上 + DELETE 该行 | validateAndTouch 内部完成 |
|
||||
| 用户名/密码不匹配 | 401 `{ error: "invalid credentials" }` + 250ms 延迟 | 不区分"用户不存在"和"密码错"两类 |
|
||||
| `setup` 时已存在用户 | 409 `{ error: "already initialized" }` | 防止重复初始化 |
|
||||
| `setup` 用户名重复 | 在 `/setup` 流程中不可能(只允许 0 → 1) | |
|
||||
| `change-password` 旧密码错 | 401 `{ error: "invalid credentials" }` | |
|
||||
| CSRF Origin 不匹配 | 403 `{ error: "bad origin" }` | |
|
||||
| WS 无 cookie / 校验失败 | 写回 HTTP/1.1 401 并 destroy socket | 在握手前拒绝,避免 onopen 假成功 |
|
||||
|
||||
所有错误响应统一 `{ error: string }` 形式,匹配现有 API 风格。
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### 单元(vitest)
|
||||
|
||||
`src/data/users.test.ts`
|
||||
- createUser 成功后 findByUsername 命中(大小写不敏感)
|
||||
- 重复 username 抛 UsernameTakenError
|
||||
- verifyPassword 正反例
|
||||
- changePassword 之后旧哈希不再验证通过
|
||||
|
||||
`src/data/sessions.test.ts`
|
||||
- createSession 返回的 token 不是 DB 内 id(DB 内是 sha256(token))
|
||||
- validateAndTouch 过期记录返回 null 且记录被删
|
||||
- validateAndTouch 未过 1h 不写 DB;过 1h 后写 DB(用 `Date.now` mock 验证)
|
||||
- deleteAllForUser(exceptToken) 保留指定会话
|
||||
|
||||
### 集成(vitest + supertest,真 SQLite in-memory)
|
||||
|
||||
`src/web/api/session.test.ts`
|
||||
- empty DB → /needs-setup 返回 true;/setup 成功;/needs-setup 再调返回 false;二次 /setup 返回 409
|
||||
- /login 成功后受保护路由 (`GET /api/bot`) 200;不带 cookie 401
|
||||
- /logout 之后同一 cookie 调受保护路由 401
|
||||
- /change-password 后 a) 旧密码 /login 失败 b) 新密码 /login 成功 c) 之前签发的其他 cookie 失效,当前 cookie 仍可用
|
||||
|
||||
`src/web/middleware/csrf.test.ts`
|
||||
- 带匹配 Origin 的 POST 通过
|
||||
- Origin 与 host 不匹配 → 403
|
||||
- 同样规则适用 Referer
|
||||
- GET 永远通过
|
||||
|
||||
`src/web/websocket.test.ts`(新增或扩展)
|
||||
- 无 cookie 的 ws 握手 → 收到 HTTP 401,socket 关闭
|
||||
- 带有效 cookie → 握手成功,收到 init 消息
|
||||
- Session 删除后已建立的 ws **不会**被主动断(明确记录此妥协 —— 见 Trade-offs)
|
||||
|
||||
### 前端
|
||||
|
||||
不在本 PR 引入新的 e2e 框架。手动用例(在 PR 描述里列):
|
||||
- 全新数据库启动 → 自动跳 /setup → 创建账户 → 进入主界面
|
||||
- 退出 → 自动跳 /login
|
||||
- 关闭浏览器 7 天内再开 → 仍登录
|
||||
- 登录态下后端重启清空 sessions → 任意 API 调用 → 自动跳 /login
|
||||
|
||||
## Files Changed
|
||||
|
||||
```
|
||||
src/data/database.ts (schema migration)
|
||||
src/data/users.ts (new)
|
||||
src/data/users.test.ts (new)
|
||||
src/data/sessions.ts (new)
|
||||
src/data/sessions.test.ts (new)
|
||||
src/web/auth/validateSession.ts (new, shared by HTTP + WS)
|
||||
src/web/middleware/requireAuth.ts (new)
|
||||
src/web/middleware/csrf.ts (new)
|
||||
src/web/middleware/csrf.test.ts (new)
|
||||
src/web/api/session.ts (new)
|
||||
src/web/api/session.test.ts (new)
|
||||
src/web/server.ts (cookieParser + 公共白名单 + 闸门 + cleanup interval + WS upgrade 重构调用)
|
||||
src/web/websocket.ts (移除被动 path 绑定;改为 handleUpgrade 模式)
|
||||
src/web/websocket.test.ts (新增 / 扩展)
|
||||
package.json (deps)
|
||||
|
||||
web/src/views/Login.vue (new)
|
||||
web/src/views/FirstRunSetup.vue (new)
|
||||
web/src/composables/useSession.ts (new)
|
||||
web/src/router/index.ts (公共路由 + beforeEach 守卫)
|
||||
web/src/api/*.ts (credentials: 'same-origin' + 401 拦截)
|
||||
web/src/App.vue (顶栏 logout + 当前用户名)
|
||||
```
|
||||
|
||||
## Trade-offs / 已知妥协
|
||||
|
||||
1. **会话失效不主动断 WS** —— 后台 deleteSession 后,已有 WS 仍在跑(直到客户端断或服务端进程重启)。原因:WS 长连接没有"每条消息再次鉴权"的廉价手段;为此引入会浪费时间。影响面有限:WS 只推状态、不接收 mutating 命令;所有写操作仍走 HTTP。
|
||||
2. **无登录限流** —— 见 Out of Scope。若部署面向公网,建议在反代层加 limit(如 nginx `limit_req`)。
|
||||
3. **`config.adminPassword` 留作未使用字段** —— 不迁移、不读取。后续 PR 可移除并加 schema migration。当前保留是为避免破坏旧 `config.json` 解析。
|
||||
4. **单一管理员模型** —— 多用户表已存在,但 UI 当前不暴露增删用户。下一个 PR 再加用户管理界面。
|
||||
5. **Origin/Referer CSRF 检查** —— 不是 token,但配合 `SameSite=Lax` 已能挡掉常规 CSRF 攻击。代价:会拒绝缺 Origin/Referer 的非浏览器客户端 POST 请求(如裸 curl)—— 这是预期行为。
|
||||
@@ -0,0 +1,167 @@
|
||||
# Fine-grained account permissions — design
|
||||
|
||||
**Issue:** [#79](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/79) (item E — the maintainer's permission-management idea)
|
||||
**Date:** 2026-05-30
|
||||
**Status:** Approved (brainstorm), pending implementation plan
|
||||
|
||||
## Scope
|
||||
|
||||
Issue #79 bundles five things. This spec covers **only item E**: allow an admin to
|
||||
grant each non-admin (member) account a set of capabilities and a list of bots they
|
||||
may control. The other items are handled in separate PRs and are **out of scope**
|
||||
here:
|
||||
|
||||
- #1 Guest mode (login-less playback)
|
||||
- #2 Dedicated-link hides other bots (subsumed conceptually by E's bot allow-list, but the link-specific UX is separate)
|
||||
- #3 Auto-pause when channel empty
|
||||
- #4 Dedicated link loses bot binding on refresh (a bug)
|
||||
|
||||
## Problem
|
||||
|
||||
Today the bot has a coarse two-role system: `admin | member` (single `role` column,
|
||||
read live per request). `requireAdmin` gates only `/api/users` and `/api/audit`.
|
||||
**Every other action — create/edit/delete bots, start/stop, all playback & queue
|
||||
control, set platform login cookies, set audio quality — is open to any logged-in
|
||||
member, on every bot.** Admins want to delegate limited control to members without
|
||||
handing them full power.
|
||||
|
||||
## Decisions (from brainstorm)
|
||||
|
||||
1. **Model = capability flags + per-member bot allow-list** (not a per-bot×per-action
|
||||
matrix, not role templates).
|
||||
2. **Defaults:** on upgrade, existing members are backfilled with full capabilities +
|
||||
all bots (no behavior change); newly-created members get a **basic tier**.
|
||||
3. **Bot allow-list semantics:** an explicit "all bots" toggle OR a specific list;
|
||||
empty list = no bots controllable. Members **cannot see** bots outside their
|
||||
allow-list (hidden, not merely disabled).
|
||||
4. **Capability set (5 toggles)** — see below; basic tier = playback + queue + all bots.
|
||||
5. **Admin is a super-user** (bypasses all checks). The last admin cannot be demoted
|
||||
(existing invariant preserved). Permission grants/revokes are written to the
|
||||
existing audit log.
|
||||
|
||||
## Capability taxonomy
|
||||
|
||||
| Capability token | Covers | Scope |
|
||||
|---|---|---|
|
||||
| `player.control` | play/pause/resume/next/prev/stop/seek/volume/mode | per-bot (allow-list) |
|
||||
| `player.queue` | search-add / clear / remove / play-at / playlist / album / play-song | per-bot (allow-list) |
|
||||
| `bot.manage` | create / edit / delete / start / stop / avatar / profile / idle settings | global (create) + per-bot (operate a specific bot) |
|
||||
| `platform.auth` | set NetEase/QQ/Bilibili cookie, QR, SMS | **global** (shared credentials) |
|
||||
| `quality` | set audio quality per platform | **global** |
|
||||
|
||||
Bot scope is independent of capabilities: a member with `player.control` can only
|
||||
exercise it on bots in their allow-list (or all, if the "all bots" flag is set).
|
||||
`platform.auth` and `quality` are global capabilities with no bot scope.
|
||||
|
||||
**Basic tier** (new members): `{ player.control, player.queue }` + `bots.all = true`.
|
||||
A new member can play/queue on every bot but cannot manage bots, change credentials,
|
||||
or change quality.
|
||||
|
||||
## Data model (SQLite, additive — follows existing `CREATE TABLE IF NOT EXISTS` pattern)
|
||||
|
||||
```sql
|
||||
-- capability tokens + the "all bots" flag (stored as token 'bots.all')
|
||||
CREATE TABLE IF NOT EXISTS user_permissions (
|
||||
userId TEXT NOT NULL,
|
||||
permission TEXT NOT NULL,
|
||||
PRIMARY KEY (userId, permission),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
|
||||
-- specific bot allow-list (only consulted when 'bots.all' is NOT present)
|
||||
CREATE TABLE IF NOT EXISTS user_bot_access (
|
||||
userId TEXT NOT NULL,
|
||||
botId TEXT NOT NULL,
|
||||
PRIMARY KEY (userId, botId),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_user_bot_access_userId ON user_bot_access(userId);
|
||||
```
|
||||
|
||||
- Admins have no rows (they bypass). Only members are constrained.
|
||||
- `bots.all` present ⇒ all bots (incl. future ones). Absent ⇒ only `user_bot_access`
|
||||
rows; empty ⇒ none.
|
||||
- `foreign_keys = ON` and WAL are already enabled; cascade-on-user-delete works.
|
||||
- `user_bot_access.botId` references bot instance ids; when a bot is deleted, its
|
||||
access rows should be cleaned up (either an FK to the bot table if one exists, or an
|
||||
explicit cleanup in `BotManager.removeBot` / `PermissionStore.pruneBot(botId)`).
|
||||
|
||||
New `PermissionStore` in `src/data/permissions.ts` (mirrors `createUserStore` /
|
||||
`createSessionStore`: prepared statements + an interface). Methods:
|
||||
`getCapabilities(userId)`, `getBotAccess(userId)` → `'all' | string[]`,
|
||||
`setPermissions(userId, { capabilities, bots })`, `pruneBot(botId)`.
|
||||
|
||||
## Backend enforcement (real 403 — not just hidden UI)
|
||||
|
||||
- **`req.user` widened** to carry `capabilities: Set<string>` and bot access. Loaded in
|
||||
`requireAuth` (one extra lookup, or a JOIN in the session query). The same
|
||||
`{id,username,role,capabilities,bots}` shape must be kept in sync in the three places
|
||||
it is built today: `requireAuth.ts`, `session.ts` `requireAuthInline`, and the WS
|
||||
upgrade handler in `server.ts` (WS only needs it if a push action becomes gated).
|
||||
Because it's read live, permission changes take effect immediately (no re-login).
|
||||
- **`requirePermission(cap)`** middleware (new, mirrors `requireAdmin.ts`): 401 if no
|
||||
user; allow if `role === 'admin'` or `capabilities.has(cap)`; else 403.
|
||||
- **`requireBotAccess`** helper: allow if admin or `bots.all` or botId ∈ access list;
|
||||
else 403. Mounted on the player router's existing `/:botId` choke-point
|
||||
(`src/web/api/player.ts`) and on each `:id` route in `src/web/api/bot.ts`
|
||||
(start/stop/edit/delete/avatar/profile).
|
||||
- **Route → capability mapping:**
|
||||
- `/api/player/:botId/*` playback actions → `player.control` (+ `requireBotAccess`)
|
||||
- `/api/player/:botId/*` queue actions → `player.queue` (+ `requireBotAccess`)
|
||||
- `/api/bot` create, `/api/bot/:id` edit/delete, `/api/bot/:id/start|stop|avatar|profile`, `/api/bot/settings` → `bot.manage` (+ `requireBotAccess` for the `:id` ones)
|
||||
- `/api/auth/*` (cookie/QR/SMS) → `platform.auth`
|
||||
- `/api/music/quality` POST → `quality`
|
||||
- **`GET /api/bot`** filters its result to the caller's allowed bots for members
|
||||
(admins see all). This is what "hides" disallowed bots in the UI.
|
||||
|
||||
## Management API (admin-only, added to the existing users router)
|
||||
|
||||
- `GET /api/users/:id/permissions` → `{ capabilities: string[], bots: 'all' | string[] }`
|
||||
- `PUT /api/users/:id/permissions` → body `{ capabilities, bots }`; validates tokens
|
||||
against the known set and botIds against existing bots; writes audit
|
||||
`user.permissions_changed`.
|
||||
- `GET /api/session/me` is extended to include the **current** user's
|
||||
`{ capabilities, bots }` so the frontend can gate UI. (admins report effectively-all.)
|
||||
|
||||
## Frontend
|
||||
|
||||
- `useSession` extends `User` with `capabilities` + bot scope and exposes
|
||||
`can(cap)` and `canControlBot(botId)` helpers.
|
||||
- **Navbar bot selector** filters `store.bots` to controllable bots (others hidden);
|
||||
`activeBot` fallback and `fetchBots` default only ever land on an allowed bot.
|
||||
- **Player / Settings** hide controls and whole sections a member lacks: platform
|
||||
login, audio quality, and bot create/edit/delete are hidden without the matching
|
||||
capability; playback/queue buttons hidden without `player.control` / `player.queue`.
|
||||
- **Admin permission editor:** in the Settings → User Management list, each member row
|
||||
gets a "权限" editor — capability checkboxes + a bot allow-list with an "全部机器人"
|
||||
toggle. Saving calls `PUT /api/users/:id/permissions`.
|
||||
|
||||
## Defaults & migration
|
||||
|
||||
- New tables created idempotently in `initTables`.
|
||||
- **One-time backfill** (guarded so it runs once): every existing `member` gets all
|
||||
five capabilities + `bots.all`. Admins are skipped (they bypass). This preserves
|
||||
current behavior for existing members on upgrade.
|
||||
- **New member default** (`POST /api/users` with role member): capabilities
|
||||
`{ player.control, player.queue }` + `bots.all` (basic tier).
|
||||
- Pre-existing accounts default to `role = 'admin'` per the current schema — those are
|
||||
super-users and unaffected.
|
||||
|
||||
## Testing (TDD)
|
||||
|
||||
- `PermissionStore` unit tests (set/get capabilities + bot access; `'all'` vs list vs
|
||||
empty; `pruneBot`).
|
||||
- `requirePermission` / `requireBotAccess` middleware tests (admin bypass; has/lacks
|
||||
cap → 200/403; bot in/out of allow-list; `bots.all`).
|
||||
- API tests: member without cap → 403; with cap → 200; bot not allowed → 403/hidden;
|
||||
`GET /api/bot` filtered for members, full for admin; `PUT .../permissions` validates
|
||||
+ audits.
|
||||
- Migration test: existing members backfilled to full + `bots.all`; new member gets
|
||||
basic tier.
|
||||
|
||||
## Non-goals
|
||||
|
||||
- No per-bot×per-capability matrix, no custom role templates (YAGNI).
|
||||
- Guest mode, dedicated-link UX, auto-pause, and the refresh bug (#1–#4) are separate.
|
||||
- No change to the admin/member role concept itself; this layers capabilities under
|
||||
the existing `member` role.
|
||||
@@ -0,0 +1,138 @@
|
||||
# Auto-pause on empty channel — design
|
||||
|
||||
**Issue:** [#79](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/79) item 3
|
||||
**Date:** 2026-05-30
|
||||
**Status:** Approved (brainstorm), pending implementation plan
|
||||
|
||||
## Problem
|
||||
|
||||
When everyone leaves the bot's voice channel, music keeps playing to an empty room.
|
||||
The maintainer wants an option to **auto-pause when the channel is empty** (no disconnect)
|
||||
and resume when someone returns.
|
||||
|
||||
## Decisions (from brainstorm)
|
||||
|
||||
- **Global toggle**, reusing the **already-declared but currently dead** `config.autoPauseOnEmpty`
|
||||
(`src/data/config.ts`, default `true`). No per-bot granularity (YAGNI).
|
||||
- **Event-driven, near-instant** reaction (not the 30s poll alone) — subscribe to TS client
|
||||
enter/leave/move events; keep the existing 30s idle poll as a fallback.
|
||||
- **Auto-resume only what we auto-paused** — a user-paused track is never auto-resumed.
|
||||
- Independent of the existing **idle-disconnect** (`idleTimeoutMinutes`): both share the same
|
||||
emptiness signal but act independently (pause immediately; disconnect after N minutes).
|
||||
|
||||
## Current state (verified)
|
||||
|
||||
- `client.ts` `getClientsInChannel()` returns all clients in the bot's channel *including the
|
||||
bot*; callers compute "others" as `length - 1`. No persistent roster.
|
||||
- The library emits `clientEnter` / `clientLeave` / `clientMoved`; `client.ts` currently only
|
||||
*logs* `clientEnter` and does not re-emit leave/moved.
|
||||
- The idle poller in `instance.ts` (`_startIdlePoller`, every 30s) already computes
|
||||
`userCount = getClientsInChannel().length - 1` and, when `<= 0`, schedules an
|
||||
idle-disconnect after `idleTimeoutMinutes`.
|
||||
- `player.pause()` / `player.resume()` already pause/resume **without disconnecting** (ffmpeg
|
||||
stays alive, no voice sent). The player only knows `idle|playing|paused` — there is **no**
|
||||
auto-vs-user-pause distinction today.
|
||||
- `BotConfig.autoPauseOnEmpty` exists (default true) but is **read nowhere**.
|
||||
|
||||
## Design
|
||||
|
||||
### Occupancy signal (shared)
|
||||
Extract the idle poller's count into one method on `BotInstance`:
|
||||
`checkChannelOccupancy()` → queries `getClientsInChannel()`, computes `userCount = length - 1`,
|
||||
and drives **both** the existing idle-disconnect timer (unchanged behavior) **and** the new
|
||||
auto-pause logic below. It is called by:
|
||||
1. the existing 30s poll (fallback), and
|
||||
2. new TS event handlers.
|
||||
|
||||
### Event subscription
|
||||
`client.ts`: subscribe to and **re-emit** `clientEnter`, `clientLeave`, `clientMoved` up to
|
||||
`BotInstance`. `BotInstance.setupTsEvents()` calls `checkChannelOccupancy()` on each (a re-query
|
||||
is simplest, since `clientLeave` carries no channel id). This gives near-instant pause/resume;
|
||||
the poll remains as a safety net.
|
||||
|
||||
### Auto-pause logic (inside `checkChannelOccupancy`)
|
||||
Add a private `autoPaused = false` flag to `BotInstance`.
|
||||
- **Empty** (`userCount <= 0`): if `config.autoPauseOnEmpty` **and** `player.getState() === "playing"`
|
||||
→ `player.pause()`, `autoPaused = true`, emit `stateChange`. (Idle-disconnect timer still
|
||||
scheduled as today.)
|
||||
- **Re-populated** (`userCount > 0`): if `autoPaused` **and** `player.getState() === "paused"`
|
||||
→ `player.resume()`, `autoPaused = false`, emit `stateChange`. (Idle timer cancelled as today.)
|
||||
|
||||
### `autoPaused` bookkeeping (so user pauses are respected)
|
||||
Clear `autoPaused = false` in `cmdPause`, `cmdResume`, `cmdStop`, `cmdPlay`, and on
|
||||
connect/disconnect (the `disconnected` handler calls `player.stop()` → idle). Net effect: only a
|
||||
track *we* auto-paused gets auto-resumed; a user-paused track stays paused when someone returns.
|
||||
|
||||
### Config wiring
|
||||
- `GET /api/bot/settings`: include `autoPauseOnEmpty` in the payload (alongside `idleTimeoutMinutes`).
|
||||
- `POST /api/bot/settings`: accept + validate a boolean `autoPauseOnEmpty`, `saveConfig`, and
|
||||
propagate to live bots via a new `BotInstance.updateAutoPause(enabled)` (mirrors
|
||||
`updateIdleTimeout`). Since the instance reads `this.config.autoPauseOnEmpty` live, propagation
|
||||
can be as simple as updating the stored config reference / a field the check reads.
|
||||
- Frontend `Settings.vue` → the **行为设置** section (already `bot.manage`-gated): add a toggle
|
||||
for `autoPauseOnEmpty` next to the idle-timeout control; load it in the settings fetch and send
|
||||
it on save.
|
||||
|
||||
## Components / files
|
||||
|
||||
- `src/ts-protocol/client.ts` — subscribe + re-emit `clientEnter`/`clientLeave`/`clientMoved`.
|
||||
- `src/bot/instance.ts` — `autoPaused` field; `checkChannelOccupancy()` (refactored from the
|
||||
idle poller, drives idle + auto-pause); event handlers; clear `autoPaused` in user commands +
|
||||
connect/disconnect; `updateAutoPause(enabled)`.
|
||||
- `src/web/api/bot.ts` — `GET`/`POST /settings` handle `autoPauseOnEmpty`.
|
||||
- `web/src/views/Settings.vue` (+ player store settings load/save) — the toggle.
|
||||
- `src/data/config.ts` — field already exists (no change beyond confirming default).
|
||||
|
||||
## Testing
|
||||
|
||||
- **Decision unit test (TDD):** extract the pause/resume decision into a testable method, e.g.
|
||||
`applyOccupancy(userCount)` operating on an injected fake player (`getState`/`pause`/`resume`)
|
||||
+ the `autoPaused` flag + the config flag. Cases: empty+playing+enabled → pause + `autoPaused`;
|
||||
re-populated+`autoPaused`+paused → resume + clear; re-populated when NOT `autoPaused` (user
|
||||
pause) → no resume; flag disabled → no pause; empty while idle (not playing) → no-op.
|
||||
- **API test:** `GET`/`POST /api/bot/settings` round-trips `autoPauseOnEmpty` (validates boolean,
|
||||
persists, propagates).
|
||||
- Live TS event wiring is verified by code review + a manual run (can't unit-test a real server).
|
||||
|
||||
## Non-goals
|
||||
|
||||
- No per-bot toggle (global only). No change to idle-disconnect behavior. No new dependency.
|
||||
- Reaction relies on events the bot can already see (same-channel members are always in view);
|
||||
no extra channel subscription needed.
|
||||
|
||||
---
|
||||
|
||||
## Update (2026-06): occupancy is event-driven & server-wide, not channel-filtered
|
||||
|
||||
Live testing against a real TS3 server (with `@honeybbq/teamspeak-client` 0.2.2)
|
||||
invalidated two assumptions above. Recording the corrected model here so nobody
|
||||
reintroduces the old design:
|
||||
|
||||
- **Default is OFF**, not on. See `getDefaultConfig()` in `src/data/config.ts`
|
||||
and the rationale comment there.
|
||||
- **Query commands are unusable when others are present.** `clientlist`,
|
||||
`channellist`, and `channelclientlist` ALL time out (~5–10s) whenever ≥2
|
||||
clients are connected to the **server** (verified even when the two clients
|
||||
are in *different* channels). They succeed only when the bot is the sole
|
||||
client on the whole server. So `getClientsInChannel()` returns `[]` exactly
|
||||
when occupancy matters, and `occupancyFromClientList(0)` returns `null`
|
||||
("unknown") so callers skip the decision rather than mis-reading it as empty.
|
||||
- **PAUSE** therefore only ever fires when the bot becomes alone on the server
|
||||
(the one state where the query works). This is reliable and stays on the
|
||||
query path (`refreshOccupancy()` + the 30s idle poller).
|
||||
- **RESUME** is armed directly from the `clientEnter` push event
|
||||
(`shouldResumeOnReturn()` + `_resumeIfReturning()` in `instance.ts`), NOT from
|
||||
a query. Because the bot only auto-pauses while alone, the sole way occupancy
|
||||
can return while `autoPaused` is set is a fresh connection — delivered as
|
||||
`clientEnter`. The resume branch never pauses (userCount is always > 0).
|
||||
- **Net semantics:** "pause when the server is empty (bot alone), resume when
|
||||
someone connects." Channel granularity is **impossible** with this library:
|
||||
`clientEnter`'s channel field is always `0` (library reads notify param `cid`
|
||||
but enter-view carries `ctid`), and `clientMoved` delivery is flaky. Do NOT
|
||||
attempt to layer `clientMoved.targetChannelID` channel-accuracy on top — it is
|
||||
systematically wrong for direct-connect clients and reintroduces unreliability.
|
||||
The correct path to true channel scoping is an upstream library fix.
|
||||
- **Knock-on:** idle-disconnect shares the same signal and is likewise
|
||||
server-wide. UI copy in `web/src/views/Settings.vue` was updated to say
|
||||
"服务器" rather than "频道" to match. `cmdVote` was intentionally left on the
|
||||
query path (out of scope; switching it would inherit the same timeout).
|
||||
@@ -0,0 +1,65 @@
|
||||
# Dedicated-link bot scoping (+ refresh fix) — design
|
||||
|
||||
**Issue:** [#79](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/79) items 2 and 4
|
||||
**Date:** 2026-05-30
|
||||
**Status:** Approved (brainstorm), pending implementation plan
|
||||
|
||||
## Problem
|
||||
|
||||
- **Item 2:** A dedicated link (`/bot/:id`) is meant to give someone control of *one* bot, but today it just sets the active bot and bounces to `/`; the user can still switch to any other bot from the top-right selector.
|
||||
- **Item 4 (bug):** After opening a dedicated link, refreshing the page loses the bot — the UI falls back to the first bot.
|
||||
|
||||
Root cause (verified): `BotRedirect.vue` does `router.replace('/')` (dropping the id), and `activeBotId` is in-memory-only Pinia state with no persistence, so a reload resets it to `bots[0]`.
|
||||
|
||||
## Decision (from brainstorm: Q2 = URL-carried scope)
|
||||
|
||||
Carry the scoped bot in the **URL query** (`?bot=<id>`). One mechanism fixes **both** items: the URL is durable across refresh (item 4) and shareable/self-clearing, and the frontend locks the selector to the scoped bot (item 2). No localStorage sticky-lock; plain `/` (no `?bot`) = full control. Backend per-bot authorization (PR #80) remains the real boundary — this is a UX lock.
|
||||
|
||||
## Design
|
||||
|
||||
### Scope state (store)
|
||||
Add to the player store:
|
||||
- `scopedBotId: string | null` — the bot the UI is locked to.
|
||||
- getter `isScoped` = `scopedBotId !== null`.
|
||||
- action `setScope(id)` / `clearScope()`.
|
||||
- `setActiveBotId(id)` becomes a no-op (or ignores) when `isScoped` and `id !== scopedBotId`, so stray switch attempts can't change bots.
|
||||
|
||||
### URL as the durable source of truth
|
||||
- `BotRedirect.vue` (`/bot/:id`): instead of `router.replace('/')`, validate the bot exists, then `router.replace({ path: '/', query: { bot: id } })`. (Keeps the "clean" home URL but with `?bot=`.)
|
||||
- **Router `beforeEach` guard** (the heart of it):
|
||||
- If `to.query.bot` is present → `store.setScope(to.query.bot)` and continue.
|
||||
- Else if `store.isScoped` (a scope is active and this navigation dropped the param) → redirect to the same route **with** `query.bot = store.scopedBotId` re-attached (so the lock survives in-app navigation to /search, /library, etc.).
|
||||
- Else → no scope; continue.
|
||||
This keeps `?bot=` on the URL for every route while scoped, so a refresh on *any* route re-establishes the lock → **fixes item 4**.
|
||||
- On app load / after `fetchBots()`: apply `scopedBotId`/`?bot` to `activeBotId`; if the scoped bot doesn't exist or isn't in the user's allowed set, **clear the scope gracefully** (fall back to normal multi-bot view) rather than locking onto a dead id.
|
||||
|
||||
### Exit
|
||||
- `clearScope()` sets `scopedBotId = null`; the exit affordance navigates to `/` *after* clearing, so the guard won't re-attach `?bot`. This is the only way to leave scoped mode (self-clearing, intentional).
|
||||
|
||||
### Navbar (the lock UI)
|
||||
- When `isScoped`: the bot selector shows **only** the scoped bot, the dropdown/switching is disabled (no chevron / non-interactive), and other bots' "copy link" affordances are not shown.
|
||||
- Show a small "专属模式" indicator with an "退出" control → `clearScope()` + navigate to `/`.
|
||||
- When not scoped: unchanged (full selector over `controllableBots`).
|
||||
|
||||
### Active-bot coherence
|
||||
Because every player action already routes through `activeBotId`, locking `activeBotId === scopedBotId` guarantees all controls affect only the scoped bot. The store's `activeBot` getter `bots[0]` fallback still degrades safely if the scoped id ever fails to match (combined with the graceful-clear above).
|
||||
|
||||
## Components / files
|
||||
|
||||
- `web/src/stores/player.ts` — `scopedBotId` state, `isScoped`, `setScope`/`clearScope`, guard in `setActiveBotId`, apply scope→active in `fetchBots`/init (graceful clear if missing).
|
||||
- `web/src/router/index.ts` — `beforeEach` scope sync + `?bot` preservation.
|
||||
- `web/src/views/BotRedirect.vue` — set scope + `replace({ path: '/', query: { bot: id } })`.
|
||||
- `web/src/components/Navbar.vue` — locked selector + "专属模式/退出" affordance.
|
||||
- `web/src/App.vue` — ensure scope is applied to `activeBotId` after `fetchBots` on load (if not already handled by the store/guard).
|
||||
|
||||
## Testing
|
||||
|
||||
Vue UI isn't unit-tested in this repo, so verification is `vue-tsc` + manual run. The **store scope logic is testable** if a lightweight test harness exists for Pinia stores; otherwise assert the pure pieces:
|
||||
- `setActiveBotId` ignores a switch to a non-scoped bot while scoped; allows the scoped bot.
|
||||
- `clearScope` resets state.
|
||||
- A small helper for "resolve scope from query + bots list → {scopedBotId, activeBotId} or cleared-if-missing" can be extracted and unit-tested.
|
||||
Manual: open `/bot/<id>` → locked to that bot, selector shows only it; refresh → still locked (item 4 fixed); navigate to Search then refresh → still locked; click 退出 → back to all bots; open `/` directly → full control (no lock).
|
||||
|
||||
## Non-goals
|
||||
|
||||
- No localStorage persistence (URL is the source of truth). No backend change (per-bot auth already exists in #80). No change to how dedicated links are generated (still `<base>/bot/<id>`); only what happens when one is opened.
|
||||
@@ -0,0 +1,317 @@
|
||||
# Guest mode (login-less WebUI access) — design
|
||||
|
||||
**Issue:** [#83](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/83) — "请求增加 WebUI 鉴权 guest 登录功能"
|
||||
**Date:** 2026-06-24
|
||||
**Status:** Approved (brainstorm), pending implementation plan
|
||||
|
||||
## Scope
|
||||
|
||||
Add an optional, **default-OFF** guest mode. When an admin enables it, anyone who can
|
||||
reach the WebUI can enter **without logging in** ("以游客身份进入 / Continue as guest")
|
||||
and use a restricted subset of playback/queue features. The admin chooses, per
|
||||
deployment, exactly what guests may do (a set of toggles) and which bot(s) guests may
|
||||
control. Guests can **never** view or change settings, manage bots, set platform
|
||||
credentials, change audio quality, or see the user/audit admin panels.
|
||||
|
||||
This builds directly on the existing `admin | member` role + capability system
|
||||
(`src/data/permissions.ts`, `requirePermission`, `useSession().can()`) and the existing
|
||||
append-vs-play-next queue split (`PlayQueue.add` vs `addNext`). It does **not** rebuild
|
||||
auth.
|
||||
|
||||
The original issue asked specifically that guest song requests go to "下一首" only.
|
||||
That exact behavior is reproducible in this design by the admin turning the
|
||||
"add to end" toggle **off** and the "play next" toggle **on** — it is one configuration
|
||||
of a more general per-ability toggle model (chosen in brainstorm).
|
||||
|
||||
## Problem
|
||||
|
||||
Today every `/api/*` route past the session router requires a real account
|
||||
(`requireAuth`). There is no anonymous/guest path: to let a friend queue a song, an
|
||||
admin must create them a `member` account. The maintainer wants a low-friction,
|
||||
admin-gated way to let untrusted visitors request music without an account, while
|
||||
keeping all administration locked down.
|
||||
|
||||
## Decisions (from brainstorm)
|
||||
|
||||
1. **Guest = no-login.** A guest is an **anonymous, config-driven synthetic principal**
|
||||
(`role: "guest"`), not a database user with a password. No favorites, no
|
||||
change-password, short-lived session.
|
||||
2. **Default OFF**, enforced **server-side** (the guest-session endpoint rejects when
|
||||
the flag is off — never rely on hiding the button).
|
||||
3. **Per-ability toggles**, not a single "mode". Every song action and control action is
|
||||
its own admin switch. Default state when guest mode is first enabled: only
|
||||
"add to end of queue" is ON; everything else OFF.
|
||||
4. **Per-bot guest scope** (`"all"` or an explicit bot list), mirroring the existing
|
||||
member bot allow-list. Guests cannot see or control out-of-scope bots — including
|
||||
over WebSocket.
|
||||
5. **Settings are always hidden AND server-blocked for guests** (view + change), closing
|
||||
the two currently-ungated reads (`GET /api/bot/settings`, `GET /api/music/quality`).
|
||||
6. **"Play now" for guests is non-destructive**: insert-next + skip to it, **never** the
|
||||
existing clear-the-whole-queue `/play-song` behavior.
|
||||
7. **One unified authorization gate** encapsulates admin/member/guest logic so the
|
||||
existing member/admin capability system is left behavior-unchanged.
|
||||
|
||||
## Guest ability model
|
||||
|
||||
### Always allowed (baseline read-only — the point of the feature)
|
||||
- Browse/search library, playlists, history, song detail, lyrics, cover art.
|
||||
- See now-playing and the live queue (REST + WebSocket), **scoped to allowed bots**.
|
||||
|
||||
### Always denied (hard locks — not toggles)
|
||||
- View **or** change any settings (idle timeout, auto-pause, theme persistence server-side, command prefix, etc.).
|
||||
- Bot management (create/edit/delete/start/stop, bot config, avatar, profile).
|
||||
- Music-platform login (`/api/auth/*`), audio quality (`/api/music/quality`).
|
||||
- User management (`/api/users`), audit log (`/api/audit`), change-password.
|
||||
|
||||
### Admin-configurable toggles (`guestMode.permissions.*`, all default `false` except `addToQueue`)
|
||||
|
||||
| Flag | 中文 | Default | Backend route(s) gated |
|
||||
|---|---|---|---|
|
||||
| `addToQueue` | 添加到队列末尾 | **true** | `POST /:botId/add`, `/add-song`, `/add-by-id` |
|
||||
| `playNext` | 添加到下一首 | false | `POST /:botId/play-next-song` |
|
||||
| `playNow` | 立即播放(不清空队列) | false | new guest-safe play-now (insert-next + skip) |
|
||||
| `skip` | 跳过当前歌曲 | false | `POST /:botId/next` |
|
||||
| `transport` | 暂停/继续/进度/音量 | false | `POST /:botId/pause`, `/resume`, `/seek`, `/volume` |
|
||||
| `removeClear` | 移除/清空队列 | false | `DELETE /:botId/queue/:index`, `POST /:botId/clear` |
|
||||
| `playMode` | 切换播放模式 / FM | false | `POST /:botId/mode`, `/fm` |
|
||||
|
||||
Notes:
|
||||
- Routes with **no** guest flag (e.g. `/prev`, `/stop`, `/play-song`, `/play-playlist`,
|
||||
`/play-album`, `/play-at`, all of `/api/bot/*`, `/api/auth/*`, settings, users, audit)
|
||||
are **never** reachable by guests — the gate denies any guest without an explicit flag.
|
||||
This is the safe default: new routes are guest-denied unless deliberately opted in.
|
||||
- `/play-song`, `/play-playlist`, `/play-album` call `queue.clear()` and must stay
|
||||
guest-denied regardless of toggles (they would wipe everyone's queue).
|
||||
|
||||
## Config schema (`src/data/config.ts`)
|
||||
|
||||
```ts
|
||||
export interface GuestPermissions {
|
||||
addToQueue: boolean; // append to end
|
||||
playNext: boolean; // 下一首 (insert after current)
|
||||
playNow: boolean; // 立即播放: insert-next + skip-to-it (non-destructive)
|
||||
skip: boolean; // skip current track
|
||||
transport: boolean; // pause/resume/seek/volume
|
||||
removeClear: boolean; // remove a queue item / clear the queue
|
||||
playMode: boolean; // play mode (shuffle/repeat) + FM
|
||||
}
|
||||
|
||||
export interface GuestModeConfig {
|
||||
enabled: boolean; // master switch, default false
|
||||
bots: "all" | string[]; // per-bot scope (botIds); default "all"
|
||||
permissions: GuestPermissions;
|
||||
}
|
||||
|
||||
// added to BotConfig:
|
||||
guestMode: GuestModeConfig;
|
||||
```
|
||||
|
||||
`getDefaultConfig()` returns:
|
||||
```ts
|
||||
guestMode: {
|
||||
enabled: false,
|
||||
bots: "all",
|
||||
permissions: {
|
||||
addToQueue: true, playNext: false, playNow: false,
|
||||
skip: false, transport: false, removeClear: false, playMode: false,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
**Merge hardening:** `loadConfig` currently does a shallow `{...defaults, ...partial}`,
|
||||
which would drop `guestMode` sub-keys if a saved config only contains a partial
|
||||
`guestMode`. `loadConfig` must **deep-merge `guestMode`** (and its `permissions`) over
|
||||
the defaults so missing sub-keys are back-filled. Covered by a `config.test.ts` case.
|
||||
|
||||
**Bot deletion:** when a bot is removed, prune its id from `guestMode.bots` (if it's an
|
||||
array) and persist — mirrors `PermissionStore.pruneBot(botId)` for members. Done in the
|
||||
same `BotManager.removeBot` path that already prunes member access.
|
||||
|
||||
## Backend design
|
||||
|
||||
### Synthetic guest principal & session entry
|
||||
- **Role union widened** to `"admin" | "member" | "guest"` (`UserRole` in
|
||||
`src/data/users.ts`, the `req.user` augmentation in `requireAuth.ts`, the frontend
|
||||
`User` type, and the role badge in Navbar).
|
||||
- **Reserved guest user row.** A single fixed row (e.g. id `"__guest__"`, role `"guest"`,
|
||||
an unusable password hash, username e.g. `"guest"`) is created idempotently by
|
||||
migration. It exists only to satisfy the `sessions.userId` FK and the
|
||||
`validateAndTouch` JOIN; it is excluded from user-management listings and the
|
||||
last-admin guards (those count `role = 'admin'` only, so guests don't interfere).
|
||||
- **Guest login endpoint:** `POST /api/session/guest`, mounted in the **public** block
|
||||
(before `csrfOriginCheck`/`requireAuth`, like `/login` and `/setup`), rate-limited.
|
||||
- If `config.guestMode.enabled` is false → `403 guest mode disabled`.
|
||||
- Else `sessions.createSession("__guest__")` and set the same `tsmb_session` httpOnly
|
||||
cookie. **Guest sessions use a short TTL** (e.g. `GUEST_SESSION_TTL_MS`, ~24h) and
|
||||
**bypass `MAX_SESSIONS_PER_USER`** for the guest principal (otherwise guest #11
|
||||
would evict guest #1). Expired guest sessions are already deleted on validation; an
|
||||
optional periodic sweep can prune stale ones.
|
||||
- **Disable = logout.** In `createRequireAuth`/`validateSession`, if a validated session
|
||||
has `role === "guest"` but `config.guestMode.enabled` is now false, treat it as
|
||||
unauthenticated (401). So flipping guest mode off immediately ends guest access.
|
||||
- **Expose availability:** extend `GET /api/session/needs-setup` (or add a sibling
|
||||
`GET /api/session/guest-config`) to return `guestAllowed: boolean` so the **public**
|
||||
Login page can decide whether to show the guest button. This must not leak any other
|
||||
config.
|
||||
|
||||
### Permission resolution
|
||||
`resolvePermissionContext` gains a `guest` branch. Signature extended to receive the
|
||||
live guest config:
|
||||
```ts
|
||||
resolvePermissionContext(role, userId, store, guestConfig?) => {
|
||||
admin → { capabilities: all CAPABILITIES, bots: "all" }
|
||||
member → stored caps + stored bots // unchanged
|
||||
guest → {
|
||||
capabilities: new Set(), // holds NO member capabilities
|
||||
bots: guestConfig.bots === "all" ? "all" : new Set(guestConfig.bots),
|
||||
guest: guestConfig.permissions, // resolved per-request from live config
|
||||
}
|
||||
}
|
||||
```
|
||||
`PermissionContext` and `req.user` gain an optional `guest?: GuestPermissions`. Because
|
||||
`req.user` is rebuilt per request, toggling a permission or the bot scope takes effect on
|
||||
the guest's next request (no re-login).
|
||||
|
||||
### Unified authorization gate (`src/web/middleware/authorize.ts`, new)
|
||||
Replaces `requirePermission('x')` on **guest-reachable** routes:
|
||||
```ts
|
||||
authorize({ capability?: Capability, guestFlag?: keyof GuestPermissions })
|
||||
// 401 if no req.user
|
||||
// admin → next()
|
||||
// guest → (req.user.guest?.[guestFlag] === true) ? next() : 403 // also 403 if no guestFlag
|
||||
// member → (capability && req.user.capabilities.has(capability)) ? next() : 403
|
||||
```
|
||||
- Member/admin semantics are **identical** to today's `requirePermission`.
|
||||
- A route with no `guestFlag` is automatically guest-denied (safe default).
|
||||
- `requireBotAccess` is unchanged and already enforces the guest `bots` scope (guests
|
||||
flow through `req.user.bots`).
|
||||
- `requireAdmin` is unchanged (guests are non-admin → 403), so `/api/users` and
|
||||
`/api/audit` stay locked.
|
||||
|
||||
### Route changes (`src/web/api/player.ts`, `bot.ts`, `music.ts`)
|
||||
- Re-express guest-reachable player routes via `authorize({ capability, guestFlag })`:
|
||||
- `/add`, `/add-song`, `/add-by-id` → `{ capability: "player.queue", guestFlag: "addToQueue" }`
|
||||
- `/play-next-song` → `{ capability: "player.control", guestFlag: "playNext" }`
|
||||
(members keep `player.control`; guests pass only via `playNext`)
|
||||
- new guest-safe **play-now** → `{ capability: "player.control", guestFlag: "playNow" }`
|
||||
- `/next` → `{ capability: "player.control", guestFlag: "skip" }`
|
||||
- `/pause`,`/resume`,`/seek`,`/volume` → `{ capability: "player.control", guestFlag: "transport" }`
|
||||
- `DELETE /queue/:index`, `/clear` → `{ capability: "player.queue", guestFlag: "removeClear" }`
|
||||
- `/mode`, `/fm` → `{ capability: "player.control", guestFlag: "playMode" }`
|
||||
- everything else stays `authorize({ capability })` (no guest flag) → guest-denied.
|
||||
- **Guest-safe play-now**: a new behavior (own route, e.g. `POST /:botId/play-now`, or a
|
||||
`mode:"now"` branch) that does `queue.addNext(song)` then advances to it (skip into the
|
||||
inserted track) — **no `queue.clear()`**. Members/admins may also use it; the existing
|
||||
destructive `/play-song` stays for the normal ▶ in non-guest UI. Exact wiring decided
|
||||
in the plan.
|
||||
- **Close ungated reads against guests:** `GET /api/bot/settings` and
|
||||
`GET /api/music/quality` currently have no guard, so a guest could read config. Add a
|
||||
small `requireNotGuest` guard (allow `admin` + `member`, deny `guest` → 403). This
|
||||
**does not change member/admin behavior** — members keep their current read access; only
|
||||
guests are newly denied. (Deliberately not a new member capability, to avoid touching
|
||||
member semantics.)
|
||||
|
||||
### WebSocket (`src/web/websocket.ts`, `src/web/server.ts`)
|
||||
- Guests authenticate over the WS upgrade unchanged (session cookie).
|
||||
- **Add per-client bot-scope filtering** for guests: the upgrade handler already stamps
|
||||
`ws.userId`; also resolve and stamp the client's bot scope (`"all"` or a Set). In
|
||||
`setupWebSocket`, when sending `init` and broadcasting `stateChange` /
|
||||
`botConnected/Disconnected/Removed`, **filter to bots the client may see**. For guests
|
||||
with a scoped `bots` list, out-of-scope bots are omitted. Admin/member payloads are
|
||||
unchanged (they resolve to `"all"` or their existing member scope — to avoid changing
|
||||
member behavior, filtering may be applied **only when the client is a guest**; decided
|
||||
in the plan).
|
||||
|
||||
### Settings write (`POST /api/bot/settings`)
|
||||
Extend the existing settings writer (today only idle-timeout + auto-pause) to also accept
|
||||
and persist the `guestMode` block (admin-only via `bot.manage`/`requireAdmin`), calling
|
||||
`saveConfig`. Live effect: subsequent guest requests read the updated in-memory config.
|
||||
|
||||
## Frontend design
|
||||
|
||||
- **`useSession.ts`**: extend `User` with `role:'guest'` and a `guest?: GuestPermissions`
|
||||
field (from `/api/session/me`). Add `isGuest` computed and `guestCan(flag)`; make `can`
|
||||
guest-aware where it maps cleanly, but UI gating for guest-specific actions uses
|
||||
`guestCan('addToQueue' | 'playNext' | ...)`. `canControlBot` already enforces the bot
|
||||
scope and works for guests via the `bots` field.
|
||||
- **Login page (`Login.vue`)**: when `guestAllowed`, show a prominent
|
||||
"以游客身份进入 / Continue as guest" button calling a new `session.continueAsGuest()`
|
||||
→ `POST /api/session/guest` → refresh → redirect to `?next` or home.
|
||||
- **Router (`web/src/router/index.ts`)**: in the global `beforeEach`, block guests from
|
||||
`/settings` and `/setup` (redirect to home). Default-off ⇒ when not a guest, behavior
|
||||
is unchanged.
|
||||
- **Navbar (`Navbar.vue`)**: hide the settings cog for guests; add a `游客` role badge
|
||||
branch; the bot selector already filters via `canControlBot`, so scoped guests only see
|
||||
allowed bots.
|
||||
- **App shell (`App.vue`)**: hide the mobile `/settings` tab for guests; the mini-player
|
||||
transport reduces to the guest's allowed actions.
|
||||
- **SongCard / Queue / Player**: gate each action button by the matching `guestCan(flag)`
|
||||
(e.g. show ▶/下一首/添加 per `playNow`/`playNext`/`addToQueue`; show skip/transport/
|
||||
remove/clear/mode per their flags). Buttons a guest lacks are hidden, mirroring how
|
||||
`Queue.vue` already gates on `can('player.queue')` / `can('player.control')`.
|
||||
- **Settings → Guest mode admin section (`Settings.vue`)**: new admin-only panel: a
|
||||
master enable switch, the 7 permission checkboxes (with 中文 labels), and a bot scope
|
||||
control (an "全部机器人 / all bots" toggle + per-bot checkboxes) reusing the existing
|
||||
member permission-editor bot allow-list UI. Saving calls `POST /api/bot/settings` with
|
||||
the `guestMode` block.
|
||||
|
||||
## Defaults, migration & backward-compat
|
||||
|
||||
- `getDefaultConfig().guestMode.enabled = false` ⇒ **no behavior change** on upgrade;
|
||||
existing installs see nothing until an admin opts in.
|
||||
- Migration adds the reserved `__guest__` user row idempotently (guarded like the
|
||||
existing `backfillMemberPermissions` `schema_meta` marker) and does **not** grant it
|
||||
any `user_permissions` (guest authorization is config-driven, not row-driven).
|
||||
- `loadConfig` deep-merges `guestMode` so older config files gain the new block with
|
||||
defaults.
|
||||
- Member/admin flows, capabilities, and the backfill are untouched.
|
||||
|
||||
## Testing (TDD)
|
||||
|
||||
- **Config**: `getDefaultConfig` includes `guestMode` default-off; `loadConfig`
|
||||
deep-merges a partial `guestMode` (missing sub-keys back-filled); round-trips through
|
||||
`saveConfig`.
|
||||
- **`resolvePermissionContext` guest branch**: empty member capabilities; `bots` `"all"`
|
||||
vs scoped Set; `guest` permissions object passthrough.
|
||||
- **`authorize` gate**: admin bypass; member has/lacks capability → 200/403 (regression
|
||||
parity with `requirePermission`); guest allowed only when the specific flag is true;
|
||||
guest with no flag on a route → 403; guest on settings reads → 403.
|
||||
- **Enforcement (mirror `permissions-enforcement.test.ts`)**: each toggle independently
|
||||
opens exactly its route(s) for a guest and nothing else; `/play-song`/`/play-playlist`/
|
||||
`/play-album` always 403 for guests; per-bot scope: guest 403 on out-of-scope `:botId`.
|
||||
- **Session entry**: `POST /api/session/guest` → 403 when disabled, mints guest session
|
||||
when enabled; guest session bypasses `MAX_SESSIONS_PER_USER`; disabling guest mode
|
||||
invalidates existing guest sessions (401); guest TTL shorter than member TTL.
|
||||
- **WS scope**: guest receives only in-scope bots' `init`/`stateChange`; reject upgrade
|
||||
unchanged for no cookie.
|
||||
- **Frontend** (where covered): `guestCan` gating; router blocks `/settings` for guests.
|
||||
|
||||
## Non-goals (YAGNI)
|
||||
|
||||
- No guest accounts/usernames, passwords, favorites, or persistence per guest.
|
||||
- No per-guest individual identity or rate-limiting beyond the existing IP rate limits
|
||||
(a basic abuse guard on `/api/session/guest` is in; richer abuse controls are future).
|
||||
- No change to the `admin | member` capability semantics; guest is an additive,
|
||||
config-driven third principal.
|
||||
- No chat-command (TeamSpeak `!add`/`!playnext`) changes — guest mode is **WebUI-only**
|
||||
(the issue is explicitly about WebUI 鉴权).
|
||||
- Per-guest bot scoping beyond a single shared guest scope is out of scope (one guest
|
||||
scope applies to all guests).
|
||||
|
||||
## Key files touched
|
||||
|
||||
Backend: `src/data/config.ts` (+test), `src/data/permissions.ts` (+test),
|
||||
`src/data/users.ts` (role union, reserved guest row), `src/data/database.ts` (migration),
|
||||
`src/data/sessions.ts` (guest TTL + cap bypass), `src/web/middleware/authorize.ts` (new,
|
||||
+test), `src/web/middleware/requireNotGuest.ts` (new, small — for the config reads),
|
||||
`src/web/api/session.ts` (guest endpoint, `/me`, `needs-setup`),
|
||||
`src/web/api/player.ts` (re-gate + guest play-now), `src/web/api/bot.ts` (settings
|
||||
read-lock + guestMode write), `src/web/api/music.ts` (quality read-lock),
|
||||
`src/web/server.ts` + `src/web/websocket.ts` (WS scope), `src/web/auth/validateSession.ts`
|
||||
(guest disable→401), enforcement tests.
|
||||
|
||||
Frontend: `web/src/composables/useSession.ts`, `web/src/views/Login.vue`,
|
||||
`web/src/router/index.ts`, `web/src/components/Navbar.vue`, `web/src/App.vue`,
|
||||
`web/src/components/SongCard.vue`, `web/src/components/Queue.vue`,
|
||||
`web/src/components/Player.vue`, `web/src/views/Settings.vue`,
|
||||
`web/src/stores/player.ts`.
|
||||
@@ -0,0 +1,116 @@
|
||||
# TeamSpeak chat-command permission control — design
|
||||
|
||||
**Origin:** User request — "给 ts 命令也加上权限控制" (give the TS chat commands permission control too, like the WebUI already has). Completes the unused `adminGroups` scaffold the original authors left behind.
|
||||
**Date:** 2026-06-25
|
||||
**Status:** Approved (brainstorm), pending implementation plan
|
||||
|
||||
## Scope
|
||||
|
||||
Add permission control to **TeamSpeak chat commands** (`!play`, `!add`, `!stop`, …). Today any client in a channel with the bot can run any command; only the WebUI path is permission-gated. This adds a **binary admin gate** keyed on the sender's **TS server groups**: a fixed set of "admin" commands may be restricted to members of configured admin server-groups, while all other commands stay public. Enforcement is **opt-in and backward-compatible** — it activates only once an admin lists their server-group ID(s).
|
||||
|
||||
The privileged server-groups are configured in `config.adminGroups` (already declared, currently unused) and become editable from the WebUI.
|
||||
|
||||
## Problem
|
||||
|
||||
`src/bot/commands.ts` already declares `PUBLIC_COMMANDS` / `ADMIN_COMMANDS` sets and an `isAdminCommand()` helper, and `src/bot/instance.ts:325` has the stub `// TODO: Check if invoker is in adminGroups` — but none of it gates anything. `config.adminGroups: number[]` (`src/data/config.ts:21,46`) is documented as a legacy placeholder and read nowhere. So chat commands are unauthenticated: anyone can `!stop`, `!clear`, `!remove`, move the bot, change volume/mode. The WebUI, by contrast, gates everything via `authorize()` at the HTTP layer.
|
||||
|
||||
`executeCommand` (`instance.ts:351`) is **shared** by the chat handler and the WebUI player router; the WebUI gates at the HTTP layer, so the chat gate must live in the **chat handler**, never inside `executeCommand` (else the already-gated WebUI would be double-gated).
|
||||
|
||||
## Decisions (from brainstorm)
|
||||
|
||||
1. **Binary admin gate**, not per-group capabilities and not a whole-bot allowlist. Reuses the existing `adminGroups` scaffold.
|
||||
2. **Admin command set (fixed, one source of truth):** `stop`, `clear`, `remove`, `move`, `vol`, `mode`. Everything else is public. The set lives in one constant so reclassifying a command is a one-line change.
|
||||
3. **Default = open / opt-in (backward-compatible):** when `config.adminGroups` is empty (the default), there is **no enforcement** — admin commands stay open to everyone, exactly as today. Enforcement turns on only when `adminGroups` is non-empty.
|
||||
4. **Identity key = TS server groups**, matched against `adminGroups`.
|
||||
5. **Fail-closed on undeterminable groups:** if an admin command arrives, enforcement is on, and the sender's groups cannot be determined (even after a fallback lookup), **deny**.
|
||||
6. **Reply on deny:** the bot sends the sender a brief permission-denied message (silent denial is confusing; the bot already replies to commands).
|
||||
7. **Config surface:** `adminGroups` becomes editable from an admin-only WebUI Settings section, live-applied via the existing `/api/bot/settings` endpoint; `config.json` continues to work.
|
||||
|
||||
## Permission model
|
||||
|
||||
Tier definitions live in `src/bot/commands.ts` (repurpose the existing dead sets; the admin set is the source of truth):
|
||||
- **Admin commands:** `stop`, `clear`, `remove`, `move`, `vol`, `mode`.
|
||||
- **Public commands:** all others (`play`, `add`, `playnext`/`pn`, `skip`/`next`, `prev`, `pause`, `resume`, `now`, `queue`/`list`, `lyrics`, `vote`, `help`, `search`/`find`, `playlist`, `album`, `artist`, `fm`).
|
||||
|
||||
**Enforcement rule** — a command is **allowed** iff:
|
||||
1. it is a public command, **OR**
|
||||
2. `config.adminGroups` is empty (enforcement off), **OR**
|
||||
3. the sender's server groups ∩ `config.adminGroups` ≠ ∅.
|
||||
|
||||
Otherwise it is **denied** (no execution; a denial reply is sent).
|
||||
|
||||
Expressed as a pure, unit-testable helper (no TS/async dependency):
|
||||
```ts
|
||||
// returns true = allowed, false = denied
|
||||
function canRunCommand(
|
||||
commandName: string,
|
||||
invokerGroups: readonly (string | number)[],
|
||||
adminGroups: readonly number[]
|
||||
): boolean
|
||||
```
|
||||
- not an admin command → `true`.
|
||||
- admin command, `adminGroups.length === 0` → `true` (enforcement off).
|
||||
- admin command, non-empty `adminGroups` → `true` iff any `invokerGroups` value (normalized to number/string consistently) is in `adminGroups`, else `false`.
|
||||
|
||||
> Note: `invokerGroups` from TS are strings; `adminGroups` are numbers. Normalize both sides (compare as the same type) to avoid `"6" !== 6` bugs.
|
||||
|
||||
## Identity resolution
|
||||
|
||||
The TS library already delivers the sender's server groups on each chat event (`TextMessage.invokerGroups: string[]` in `@honeybbq/teamspeak-client`), but the wrapper type `TS3TextMessage` (`src/ts-protocol/client.ts:58-64`) and its mapping (`client.ts:205-214`) **drop** it.
|
||||
|
||||
Changes:
|
||||
1. Add `invokerGroups: string[]` to `TS3TextMessage` and populate it from `msg.invokerGroups` in the mapping.
|
||||
2. **Availability caveat:** `invokerGroups` is populated only when the sender's client is in the bot's local cache (typically same channel / in view). For a private message from an unseen client, it is `[]`.
|
||||
3. **Fallback lookup (only when needed):** in the gate, if the command is admin-gated **and** enforcement is on **and** `invokerGroups` is empty, perform a targeted lookup of the sender's groups keyed on `invokerId` (clid) — reuse the already-wrapped `getClientsInChannel()` (`client.ts:314-323`, whose `ClientInfo` carries `serverGroups`), or add a thin wrapper around the library's `getClientInfo(client, clid)` for a precise `clientinfo` query. This query is skipped entirely for public commands, when enforcement is off, and when the event already carried groups (the common "listener in the channel types `!stop`" case).
|
||||
4. **Fail-closed:** if after the fallback the groups are still unknown, deny the admin command.
|
||||
|
||||
## Enforcement seam
|
||||
|
||||
In `handleTextMessage` (`src/bot/instance.ts:317`), replace the dead stub at `instance.ts:325-327` with the real check, placed after `parseCommand` succeeds and **before** `executeCommand` (`instance.ts:335`):
|
||||
- compute `allowed` via `canRunCommand(parsed.name, msg.invokerGroups, this.config.adminGroups)`, performing the async fallback lookup only when the synchronous check is "deny due to empty groups on an admin command with enforcement on";
|
||||
- if denied → send the denial reply to `msg` (respecting its `targetMode`/sender) and return without executing;
|
||||
- if allowed → `executeCommand(parsed, msg)` as today.
|
||||
|
||||
`executeCommand` stays permission-agnostic, so the WebUI path is unaffected.
|
||||
|
||||
**Live config:** `BotInstance` already holds the shared `config` object by reference (passed through `BotInstanceOptions`); `POST /api/bot/settings` mutates that same object in place, so reading `this.config.adminGroups` in the gate reflects edits immediately — no restart, no re-wiring. (Implementation must confirm the instance reads `adminGroups` from the live `config` reference, not a copied-at-construction value.)
|
||||
|
||||
## Denied UX
|
||||
|
||||
The bot replies to the sender with a short bilingual-ish message, e.g. `⛔ 需要管理员权限(该命令仅限管理员服务器组)`, via the same reply mechanism the command handlers already use, honoring the message's `targetMode` (private vs channel). No execution occurs.
|
||||
|
||||
## Config surface
|
||||
|
||||
**Backend** (`src/web/api/bot.ts`): extend the existing settings endpoints (already admin-gated: `GET` behind `requireNotGuest`, `POST` behind `requirePermission("bot.manage")`):
|
||||
- `GET /api/bot/settings` → also return `adminGroups: number[]`.
|
||||
- `POST /api/bot/settings` → also accept `adminGroups`; validate it is an array of non-negative integers (filter/reject otherwise), assign to `config.adminGroups`, `saveConfig`. Reuses the in-place-mutation + `saveConfig` pattern already used for idle-timeout/auto-pause/guestMode, so it is live-applied.
|
||||
|
||||
**Frontend** (`web/src/views/Settings.vue`): a new admin-only section **"命令权限 / Command permissions"** (`v-if="session.isAdmin.value"`), mirroring the idle-timeout/guest-mode sections:
|
||||
- a text input for comma-separated server-group IDs (parsed to `number[]`, ignoring blanks/non-numbers), a Save button calling `POST /api/bot/settings`, hydrated by the existing `loadIdleTimeout()` GET;
|
||||
- hint: "仅这些组可运行 stop/clear/remove/move/vol/mode;留空 = 不限制(所有人可用)。如何查看服务器组 ID 见 README。"
|
||||
|
||||
**`config.json`**: `adminGroups` continues to work for file-based config.
|
||||
|
||||
## Testing
|
||||
|
||||
- **`canRunCommand` unit tests** (`src/bot/commands.test.ts` or a new file): public command always allowed; admin command with empty `adminGroups` allowed; admin command with a matching group allowed; admin command with no matching group denied; string-vs-number normalization (`["6"]` matches `[6]`).
|
||||
- **Handler gate tests:** a denied admin command does NOT call `executeCommand` and triggers a denial reply; an allowed admin command (matching group) and any public command DO call `executeCommand`. (Use a fake `msg` + a `config` with `adminGroups` set; stub the reply + `executeCommand`.)
|
||||
- **Fallback path:** admin command with empty `invokerGroups` + enforcement on triggers the group lookup; if the lookup yields a matching group → allowed; if it yields nothing → denied (fail-closed).
|
||||
- **Settings round-trip** (`src/web/api/bot.test.ts`): `POST /api/bot/settings` persists a validated `adminGroups`; `GET` returns it; invalid values (non-array, negative, non-integer) are rejected/filtered.
|
||||
- **Frontend:** `vue-tsc --noEmit` clean.
|
||||
|
||||
## Non-goals (YAGNI)
|
||||
|
||||
- No per-group capability map and no whole-bot allowlist (binary admin gate only).
|
||||
- No per-command customization of the admin/public split in the UI (the set is a code constant; reclassifying is a one-line edit).
|
||||
- No server-group picker UI (admin types IDs; a picker that lists the bot's visible groups is a possible future enhancement).
|
||||
- No new chat *management* commands.
|
||||
- No change to the WebUI authorization model or `executeCommand` semantics.
|
||||
|
||||
## Key files touched
|
||||
|
||||
Backend: `src/bot/commands.ts` (admin-set constant + `canRunCommand` helper, repurpose the dead sets; +test), `src/bot/instance.ts` (gate in `handleTextMessage`, denial reply, live `adminGroups`), `src/ts-protocol/client.ts` (surface `invokerGroups` on `TS3TextMessage`; possibly a `getClientInfo` wrapper for the fallback), `src/web/api/bot.ts` (settings read/write `adminGroups`; +test). Possibly `src/data/config.ts` (no schema change; `adminGroups` already exists).
|
||||
|
||||
Frontend: `web/src/views/Settings.vue` (admin-only 命令权限 section).
|
||||
|
||||
Docs: `README.md` (document the feature + how to find TS server-group IDs).
|
||||
@@ -0,0 +1,202 @@
|
||||
# Spotify audio source (optional, hybrid librespot) — design spec
|
||||
|
||||
- **Issue:** [#112 — Support for Spotify audio source](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/112)
|
||||
- **Date:** 2026-07-01
|
||||
- **Status:** Approved (design) — pending implementation plan
|
||||
- **Chosen approach:** Hybrid — real Spotify streaming via a librespot-family sidecar, with **go-librespot on Linux/Docker** and **Rust librespot on Windows**, behind one backend interface.
|
||||
|
||||
---
|
||||
|
||||
## 1. Summary
|
||||
|
||||
Add `spotify` as a new **optional** `MusicProvider`. Metadata (search / track / album / playlist) is read from the official **Spotify Web API**. Audio is the *real* Spotify stream, produced by a librespot-family sidecar and piped through ffmpeg into the bot's existing voice path.
|
||||
|
||||
The feature is **disabled by default**, opt-in, and **requires the user's own Spotify Premium account**. librespot is an unofficial, reverse-engineered client and using it **violates Spotify's Terms of Service** (account-ban risk). This is surfaced to the user as an explicit experimental warning, and no credentials are ever bundled.
|
||||
|
||||
If the feature is disabled, unauthenticated, or the sidecar binary is missing, the provider disables itself gracefully — exactly like `YouTubeProvider` when `yt-dlp` is absent (empty results, greyed-out in the UI, no crash).
|
||||
|
||||
## 2. Goals / Non-goals
|
||||
|
||||
**Goals**
|
||||
- First-class `spotify` source: search, play, playlist/album import, lyrics best-effort, login status.
|
||||
- Real Spotify audio (Premium), not a YouTube match.
|
||||
- Cross-platform: works on the project's three deployments — native Windows one-click, Linux systemd, Docker.
|
||||
- Strictly optional and safe-by-default; zero impact when off.
|
||||
- Mixed queues keep working (Spotify tracks interleaved with netease/qq/etc.).
|
||||
|
||||
**Non-goals**
|
||||
- No free-tier audio (Premium is mandatory for librespot streaming).
|
||||
- No bundled Spotify credentials or shared Developer app.
|
||||
- No replacement of, or change to, existing sources' behavior.
|
||||
- No CI e2e against live Spotify (requires Premium; manual only).
|
||||
|
||||
## 3. Backend selection
|
||||
|
||||
`spotify.backend: "auto" | "go-librespot" | "librespot"` (default `auto`).
|
||||
|
||||
| Platform | `auto` resolves to | Why |
|
||||
|---|---|---|
|
||||
| Windows | `librespot` (Rust) | go-librespot has **no** Windows binary and its FIFO capture is POSIX-only |
|
||||
| Linux / Docker | `go-librespot` (fallback `librespot`) | clean REST play-by-URI + prebuilt Linux binary |
|
||||
| macOS | `librespot` (or `go-librespot` if built) | no go-librespot macOS binary published |
|
||||
|
||||
The split is **platform-determined**, not a per-run user toggle (a user may still force one via config if they have the binary).
|
||||
|
||||
## 4. Architecture
|
||||
|
||||
### 4.1 The seam — `SpotifyAudioBackend`
|
||||
|
||||
New file `src/music/spotify/backend.ts`:
|
||||
|
||||
```ts
|
||||
export interface SpotifyTrackEndedEvent { uri: string; reason: "ended" | "stopped" | "error"; }
|
||||
|
||||
export interface SpotifyAudioBackend {
|
||||
start(): Promise<void>; // launch sidecar + resampling ffmpeg
|
||||
stop(): void; // tear everything down
|
||||
isReady(): boolean; // device online & streamable
|
||||
playTrack(uri: string): Promise<void>; // begin ONE track (spotify:track:...)
|
||||
pause(): Promise<void>;
|
||||
resume(): Promise<void>;
|
||||
seek(ms: number): Promise<void>;
|
||||
getPcmStream(): Readable; // 48kHz s16le stereo (post-ffmpeg)
|
||||
getPosition(): number; // ms into current track
|
||||
on(event: "trackEnded", cb: (e: SpotifyTrackEndedEvent) => void): void;
|
||||
on(event: "metadata", cb: (m: SpotifyNowPlaying) => void): void;
|
||||
on(event: "ready" | "error", cb: (arg?: unknown) => void): void;
|
||||
}
|
||||
```
|
||||
|
||||
Both implementations emit the **same** 48 kHz s16le stereo PCM and the **same** events, so everything above the seam (provider, controller, player, UI) is backend-agnostic.
|
||||
|
||||
### 4.2 `GoLibrespotBackend` (Linux/Docker) — `src/music/spotify/go-librespot.ts`
|
||||
|
||||
- Writes a `config.yml` with `server: { enabled: true, address: 'localhost', port: <p> }`, `audio_backend: 'pipe'`, `audio_output_pipe: '<fifo>'`, `audio_output_pipe_format: 's16le'`, `bitrate: 320`, credentials block.
|
||||
- `start()`: `mkfifo <fifo>` → **spawn the FIFO-reading ffmpeg first** → then spawn go-librespot. (FIFO open ordering is mandatory: go-librespot opens the write end with `O_WRONLY|O_NONBLOCK` and errors `ENXIO` if no reader exists yet.) ffmpeg: `-f s16le -ar 44100 -ac 2 -i <fifo> -f s16le -ar 48000 -ac 2 -`. ffmpeg stdout = `getPcmStream()`.
|
||||
- Control (REST): `POST /player/play {uri}`, `POST /player/pause`, `POST /player/resume`, `POST /player/seek {position}`. `GET /status` for position.
|
||||
- Events (WebSocket `/events`): `metadata` → `metadata`; `not_playing` → `trackEnded` (track boundaries can NOT be read from the FIFO — it is gapless/continuous and never EOFs between tracks).
|
||||
- Metadata token: go-librespot exposes `POST /token` (first-party session token) and a `/web-api/<path>` proxy to `api.spotify.com` — so on this backend a separate Spotify Developer app is **optional**.
|
||||
- Recovery: on reader death go-librespot's write returns `EPIPE` and closes the pipe output; backend restarts the ffmpeg reader + reactivates the device.
|
||||
|
||||
### 4.3 `RustLibrespotBackend` (Windows / cross-platform) — `src/music/spotify/rust-librespot.ts`
|
||||
|
||||
Rust librespot is a **passive Spotify Connect receiver**; the bot acts as the **Connect controller** via the Spotify Web API.
|
||||
|
||||
- `start()`: spawn `librespot --backend pipe --name "<deviceName>" --bitrate 320 --cache <dir> [--access-token <tok> | --enable-oauth]`. With **no `--device`**, librespot writes raw PCM (**s16le, 44100 Hz, stereo**) to **stdout** (cross-platform; verified against `pipe.rs` — `None => Box::new(io::stdout())`). Pipe stdout → ffmpeg `-f s16le -ar 44100 -ac 2 -i pipe:0 -f s16le -ar 48000 -ac 2 -` → `getPcmStream()`. Do **not** pass `--passthrough` (that emits raw Ogg, not PCM).
|
||||
- `playTrack(uri)`: `GET /v1/me/player/devices` → find our `device_id` by `deviceName` → `PUT /v1/me/player/play?device_id={id}` body `{uris:[uri]}`. `pause/resume/seek` → `PUT /v1/me/player/{pause,play,seek}`.
|
||||
- `trackEnded`: poll `GET /v1/me/player` (is_playing → false / `item` changed / `progress_ms ≈ duration_ms`) plus optional `--onevent` hook (read-only notifications). Add a watchdog + retry/backoff for device-visibility latency and command `202/404` flakiness.
|
||||
- Requires a **user OAuth token** with scopes `streaming user-read-playback-state user-modify-playback-state user-read-currently-playing` (+ `playlist-read-private playlist-read-collaborative` for user playlists).
|
||||
|
||||
## 5. Shared subsystems
|
||||
|
||||
### 5.1 Metadata — `src/music/spotify/webapi.ts`
|
||||
|
||||
Thin `axios` client mapping Spotify catalog objects → the bot's `Song` / `Playlist` / `Album`:
|
||||
- `GET /v1/search?type=track,album,playlist&q=…`
|
||||
- `GET /v1/tracks/{id}`, `GET /v1/albums/{id}/tracks`, `GET /v1/playlists/{id}/tracks`
|
||||
|
||||
All confirmed still available with a normal token **after** Spotify's 2024-11-27 cut (that cut removed related-artists, recommendations, audio-features/analysis, featured/category playlists, and `preview_url` — none of which we use). Token source is pluggable: user Developer-app token (primary) or go-librespot `/web-api` proxy (go-librespot path). Handle `429 Retry-After` (rolling 30 s window; dev-mode quota).
|
||||
|
||||
### 5.2 Auth — `src/music/spotify/auth.ts`
|
||||
|
||||
One web-UI **Authorization-Code + PKCE** login.
|
||||
- **Primary:** the user registers their own Spotify Developer app (Client ID [+ Secret] + redirect URI) — reliable, ToS-cleaner. The resulting access token drives metadata + Web-API control; the refresh token is persisted (credential store); access tokens (~1 h) auto-refresh. The same token bootstraps librespot via `--access-token`, after which librespot caches reusable credentials — **one user-facing login**.
|
||||
- **Fallbacks:** librespot `--enable-oauth` (built-in client `65b708073fc0480ea92a077233ca87bd`, redirect `http://127.0.0.1:8898/login`) or go-librespot interactive login (`http://127.0.0.1:36842/login?code=…`) as a separate one-time step; go-librespot `/web-api` proxy when no Developer app is provided.
|
||||
- Username/password is **dead** (removed by Spotify in 2024); do not implement it.
|
||||
|
||||
### 5.3 Provider — `src/music/spotify/provider.ts`
|
||||
|
||||
`SpotifyProvider implements MusicProvider` with `platform: "spotify"`:
|
||||
- `search`, `getSongDetail`, `getPlaylistSongs`, `getAlbumSongs`, `getLyrics` (best-effort/empty), `getRecommendPlaylists` → Web API.
|
||||
- `getAuthStatus()` reports login state **and** backend/binary availability (drives greying-out in UI, like YouTube).
|
||||
- `getSongUrl(id)` returns a **sentinel** (`{ url: "spotify:track:<id>" }`) — actual playback is via the backend/controller, not a URL. `instance.ts` recognizes the sentinel and routes to the `SpotifyController`.
|
||||
- QR-code login methods are no-ops; Spotify uses the OAuth card instead.
|
||||
|
||||
## 6. Queue / player / instance integration
|
||||
|
||||
- **`SpotifyController`** (`src/music/spotify/controller.ts`, one per bot): owns the chosen backend and the Web-API/auth clients; exposes `playTrack/pause/resume/seek/stop` and forwards `trackEnded`/`metadata`.
|
||||
- **`AudioPlayer` — new external-PCM mode:** add `playPcmStream(readable, { onExternalEnd })` that feeds the existing `pcmBuffer` → 20 ms frame loop → encoder → `frame` path **without spawning a url-ffmpeg**. For Spotify, `trackEnd` is driven by the backend's `trackEnded` event (the librespot→ffmpeg pipeline is long-lived and does not exit per song). `pause/resume/seek` on a Spotify song are routed to the backend by `instance.ts` (and gate frame emission locally for crisp UI state).
|
||||
- **`instance.ts`:** `getProviderFor("spotify")`, a `-s` command flag in `getProvider(flags)`. When a dequeued `song.platform === "spotify"`: ensure the controller/backend is started + device active, `playTrack(uri)`, attach the player to the backend PCM. On `trackEnded` → advance the queue. When a **non-Spotify** song is next, **pause the sidecar** (so it doesn't buffer ahead) and use the normal `player.play(url)` path. This preserves one-track-at-a-time on-demand playback and mixed-source queues.
|
||||
- Real-time pacing is guaranteed by the voice consumer: TS voice pulls 20 ms frames at real time → the player reads PCM at real time → ffmpeg's read of the sidecar stalls → sidecar backpressure pauses decode. (This is why go-librespot's pull model avoids the classic librespot "plays too fast / skips" bug; Rust librespot to stdout is likewise paced by our reads.)
|
||||
|
||||
## 7. Config, opt-in & safety
|
||||
|
||||
`BotConfig.spotify` (all default-off), added to `getDefaultConfig()` and sanitized in `loadConfig()`:
|
||||
|
||||
```ts
|
||||
spotify: {
|
||||
enabled: false,
|
||||
backend: "auto", // "auto" | "go-librespot" | "librespot"
|
||||
clientId: "", // user's Developer app (optional on go-librespot path)
|
||||
clientSecret: "", // optional — PKCE needs none; only for confidential/client-credentials flows
|
||||
deviceName: "TSMusicBot",
|
||||
bitrate: 320, // 96 | 160 | 320
|
||||
}
|
||||
```
|
||||
|
||||
Inert unless `enabled` **and** logged-in **and** a resolvable binary. First-run/settings shows the experimental + ToS + Premium + own-credentials warning. Never store or transmit shared secrets.
|
||||
|
||||
## 8. Web UI
|
||||
|
||||
- Add `spotify` to `platform` and `Source` unions (`web/src/stores/player.ts`, `web/src/stores/sourceTabs.ts`).
|
||||
- `SourceTabs.vue`: add "Spotify" tab; `SongCard.vue`: green **#1DB954** badge; `variables.scss`: `--brand-spotify` tokens.
|
||||
- `stores/player.ts`: extend `authStatus` / `recommendPlaylists` / `dailySongs` / `userPlaylists` maps + the auth/recommend fetch fan-out.
|
||||
- Settings: a **Spotify login card distinct from the QR cards** — "Connect Spotify" OAuth button, optional Client ID/Secret fields, backend/binary status indicator, and the risk disclaimer.
|
||||
|
||||
## 9. Binary / dependency resolution — `src/music/spotify/binary.ts`
|
||||
|
||||
Mirror `findYtDlp()`: resolve `go-librespot` / `librespot(.exe)` from `bin/` then PATH; positive availability cached, negative retried (install-while-running).
|
||||
- **No prebuilt Rust librespot exists** (source-only: `cargo install librespot`, distro/`scoop`/`choco`, or a binary dropped in `bin/`).
|
||||
- **go-librespot** ships **Linux-only** assets (`go-librespot_linux_{x86_64,arm64,armv6,armv6_rpi}.tar.gz`, ~6 MB, at `github.com/devgianlu/go-librespot/releases`). Docker build downloads the correct Linux asset; optional runtime auto-download (like yt-dlp). go-librespot is **GPL-3.0** → sidecar = mere aggregation (does not infect the Node code); ship its license text + a source offer.
|
||||
- Unresolved binary → source disabled with an actionable "install X / see docs" message.
|
||||
|
||||
## 10. Testing
|
||||
|
||||
Vitest, mocking child processes and HTTP:
|
||||
- Web-API response → `Song/Playlist/Album` mapping.
|
||||
- `chooseBackend()` per platform/config.
|
||||
- Auth: PKCE challenge, token refresh, credential persistence.
|
||||
- Config load/sanitize (defaults, hand-edited/corrupt input).
|
||||
- `SpotifyProvider` methods (mock webapi).
|
||||
- Player external-PCM path: feed a fake `Readable` → assert `frame` emission + `trackEnd` on external end.
|
||||
- go-librespot `/events` → `trackEnded` translation; Rust-backend Web-API poll → `trackEnded`.
|
||||
- e2e against live Spotify is **manual & documented** (Premium required), not CI.
|
||||
|
||||
## 11. Files touched
|
||||
|
||||
**New:** `src/music/spotify/{provider,backend,go-librespot,rust-librespot,webapi,auth,controller,binary}.ts` (+ `.test.ts`).
|
||||
**Edited (backend):** `src/music/provider.ts` (union: `Song`/`Playlist`/`Album`/`MusicProvider`), `src/index.ts`, `src/bot/manager.ts`, `src/bot/instance.ts` (router + `-s` flag + spotify routing), `src/audio/player.ts` (external-PCM mode), `src/data/config.ts`, `src/music/auth.ts` (credential store union), `src/web/api/auth.ts`, `src/web/api/music.ts` (routers + search aggregation), `src/web/server.ts`, `src/data/database.ts` (platform).
|
||||
**Edited (frontend):** `web/src/stores/player.ts`, `web/src/stores/sourceTabs.ts`, `web/src/components/SourceTabs.vue`, `web/src/components/SongCard.vue`, `web/src/styles/variables.scss`.
|
||||
**Docs:** `README.md` (Spotify section + warnings + install notes).
|
||||
|
||||
## 12. Staged rollout
|
||||
|
||||
1. **Metadata + provider + config + UI plumbing** (no audio): `spotify` source searchable/browsable; playback returns "not yet playable". Fully testable without a sidecar.
|
||||
2. **go-librespot backend (Linux/Docker):** real playback on Linux; REST + FIFO + WebSocket.
|
||||
3. **Rust librespot backend (Windows):** stdout PCM + Web-API Connect control.
|
||||
4. **Polish:** recovery/watchdog, docs, binary auto-download, README.
|
||||
|
||||
## 13. Risks & open questions
|
||||
|
||||
- **Rust librespot control is the top risk** — Connect device visibility/latency, poll-based track-end. Mitigation: retry/backoff + watchdog; degrade to "skipped" on repeated failure.
|
||||
- **One-OAuth-token bootstraps librespot** (`--access-token` from the user's own app client) is *plausible but unverified* — may fall back to two one-time logins. Verify with a spike in stage 3.
|
||||
- **Windows go-librespot is impossible** (FIFO) → Windows always uses Rust librespot.
|
||||
- **Token scope from librespot's built-in client** may not include `user-modify-playback-state`; if so, a user Developer app is required for the Rust/Windows control path.
|
||||
- Large surface area → staged rollout above; each stage independently shippable.
|
||||
|
||||
## Appendix A — Verified technical facts (with sources)
|
||||
|
||||
go-librespot API (`devgianlu/go-librespot`, v0.7.x):
|
||||
- REST: `POST /player/{play,pause,resume,playpause,stop,next,prev,seek,volume,add_to_queue}`, `GET /status`, `GET /` (`{playback_ready}`), `POST /token`, `GET|POST /web-api/<path>`. `POST /player/play` body `{uri, skip_to_uri?, paused?}`. Server enabled only when `server.enabled: true`.
|
||||
- WebSocket `/events` envelopes `{type, data}`; types include `metadata, will_play, playing, paused, not_playing, stopped, seek, volume, active, inactive`. Track-end = `not_playing`.
|
||||
- Pipe backend: continuous raw PCM, no header, 44100 Hz stereo, format `s16le|s32le|f32le`; FIFO opened once; POSIX-only. Backpressure real (blocks when reader stalls).
|
||||
- Sources: `github.com/devgianlu/go-librespot` (README, `api-spec.yml`, `daemon/api_server.go`, `output/driver-pipe.go`).
|
||||
|
||||
Rust librespot (`librespot-org/librespot`, v0.8.0, MIT):
|
||||
- `--backend pipe` with no `--device` → raw PCM to **stdout**; default S16 / 44100 / stereo; `--format` for higher bit depth; `--passthrough` = raw Ogg (do not use). Passive Connect receiver — no play-by-URI; control via Web API Connect. `--onevent` = read-only hook. No prebuilt binaries.
|
||||
- Sources: `github.com/librespot-org/librespot` wiki (Audio-Backends, Options), `librespot_playback/audio_backend/pipe.rs`, `docs/authentication.md`.
|
||||
|
||||
Spotify auth & Web API:
|
||||
- Username/password removed (2024); use OAuth (Auth-Code+PKCE) or Zeroconf. Premium required for librespot audio.
|
||||
- Client-Credentials token authorizes `/v1/search` + public track/album/playlist GETs; 2024-11-27 cut did **not** touch these. Token endpoint `POST https://accounts.spotify.com/api/token` (`grant_type=client_credentials`, Basic base64(id:secret), `expires_in=3600`, no refresh). 429 on a rolling 30 s window.
|
||||
- Sources: `developer.spotify.com` (Web API docs; 2024-11-27 blog), `librespot` `docs/authentication.md`.
|
||||
Generated
+560
-352
File diff suppressed because it is too large.
Load diff
+16
-2
@@ -17,16 +17,18 @@
|
||||
"@discordjs/opus": "^0.10.0",
|
||||
"@honeybbq/teamspeak-client": "^0.2.1",
|
||||
"@koa/router": "^15.4.0",
|
||||
"@sansenjian/qq-music-api": "^2.2.10",
|
||||
"@sansenjian/qq-music-api": "~2.4.0",
|
||||
"axios": "^1.14.0",
|
||||
"bcryptjs": "^2.4.3",
|
||||
"better-sqlite3": "^12.8.0",
|
||||
"chalk": "^5.6.2",
|
||||
"cookie-parser": "^1.4.7",
|
||||
"express": "^5.2.1",
|
||||
"ffmpeg-static": "^5.3.0",
|
||||
"koa": "^3.2.0",
|
||||
"koa-bodyparser": "^4.4.1",
|
||||
"koa-static": "^5.0.0",
|
||||
"NeteaseCloudMusicApi": "^4.30.0",
|
||||
"NeteaseCloudMusicApi": "~4.32.0",
|
||||
"pino": "^10.3.1",
|
||||
"ts3-nodejs-library": "^3.5.1",
|
||||
"tweetnacl": "^1.0.3",
|
||||
@@ -34,12 +36,24 @@
|
||||
"yt-dlp-wrap": "^2.3.12"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/bcryptjs": "^2.4.6",
|
||||
"@types/better-sqlite3": "^7.6.13",
|
||||
"@types/cookie-parser": "^1.4.10",
|
||||
"@types/express": "^5.0.6",
|
||||
"@types/node": "^25.5.0",
|
||||
"@types/supertest": "^6.0.3",
|
||||
"@types/ws": "^8.18.1",
|
||||
"supertest": "^7.2.2",
|
||||
"tsx": "^4.21.0",
|
||||
"typescript": "^6.0.2",
|
||||
"vitest": "^4.1.2"
|
||||
},
|
||||
"allowScripts": {
|
||||
"@discordjs/opus@0.10.0": true,
|
||||
"better-sqlite3@12.11.1": true,
|
||||
"cpu-features@0.0.10": true,
|
||||
"esbuild@0.28.1": true,
|
||||
"ffmpeg-static@5.3.0": true,
|
||||
"ssh2@1.17.0": true
|
||||
}
|
||||
}
|
||||
@@ -1,14 +1,16 @@
|
||||
# TSMusicBot — Docker Compose
|
||||
# 一键部署:docker-compose up -d
|
||||
# 一键部署:docker-compose pull && docker-compose up -d
|
||||
#
|
||||
# 所有依赖已内置(Node.js, FFmpeg, Opus 编码器)无需安装任何额外软件
|
||||
# FFmpeg 使用系统包管理器安装,确保容器内兼容性
|
||||
# 默认从 GitHub Container Registry 拉取预构建镜像(amd64 + arm64),
|
||||
# 无需本地编译,无需 Node.js / 构建工具链。
|
||||
# 镜像内置:Node.js, FFmpeg, Opus 编码器,原生模块均已交叉编译。
|
||||
#
|
||||
# 如需指定版本,把 :latest 换成具体 tag(例如 :1.4.0)。
|
||||
# 如需本地构建(开发或 fork),见底部注释。
|
||||
|
||||
services:
|
||||
tsmusicbot:
|
||||
build:
|
||||
context: ../..
|
||||
dockerfile: scripts/docker/Dockerfile
|
||||
image: ghcr.io/zhangtianyao1/teamspeak-music-bot:latest
|
||||
container_name: tsmusicbot
|
||||
# Use host network so the bot can reach TS3 server on LAN
|
||||
# If your TS3 server is on the same machine, this is required
|
||||
@@ -27,3 +29,12 @@ services:
|
||||
volumes:
|
||||
tsmusicbot-data:
|
||||
driver: local
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# 本地构建(仅开发 / fork 场景使用):
|
||||
# 把上面的 `image:` 行删掉,换成下面的 build 块即可。
|
||||
#
|
||||
# build:
|
||||
# context: ../..
|
||||
# dockerfile: scripts/docker/Dockerfile
|
||||
# ------------------------------------------------------------------
|
||||
Executable
+161
@@ -0,0 +1,161 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Download native binaries (ffmpeg + @discordjs/opus) from npmmirror CDN.
|
||||
* Called by setup.bat after npm install --ignore-scripts.
|
||||
*
|
||||
* Usage: node scripts/download-binaries.mjs [cdn_base_url]
|
||||
*/
|
||||
|
||||
import { existsSync, mkdirSync, writeFileSync, statSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join, dirname } from "node:path";
|
||||
import { createGunzip } from "node:zlib";
|
||||
import { pipeline } from "node:stream/promises";
|
||||
import { createWriteStream } from "node:fs";
|
||||
import { get } from "node:https";
|
||||
import { Readable } from "node:stream";
|
||||
import { execSync } from "node:child_process";
|
||||
import { createRequire } from "node:module";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const ROOT = join(dirname(fileURLToPath(import.meta.url)), "..");
|
||||
const CDN = process.argv[2] || "https://cdn.npmmirror.com/binaries";
|
||||
const PLATFORM = process.platform;
|
||||
const ARCH = process.arch;
|
||||
const NODE_ABI = process.versions.modules;
|
||||
|
||||
function download(url) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const req = get(url, { timeout: 120000 }, (res) => {
|
||||
if (res.statusCode < 200 || res.statusCode >= 400) {
|
||||
reject(new Error(`HTTP ${res.statusCode}: ${url}`));
|
||||
return;
|
||||
}
|
||||
const chunks = [];
|
||||
res.on("data", (c) => chunks.push(c));
|
||||
res.on("end", () => resolve(Buffer.concat(chunks)));
|
||||
});
|
||||
req.on("error", reject);
|
||||
req.on("timeout", () => { req.destroy(); reject(new Error("timeout")); });
|
||||
});
|
||||
}
|
||||
|
||||
function log(msg) {
|
||||
console.log(` [binary] ${msg}`);
|
||||
}
|
||||
|
||||
function isValidSize(filePath, minBytes) {
|
||||
try { return statSync(filePath).size >= minBytes; } catch { return false; }
|
||||
}
|
||||
|
||||
async function downloadFfmpeg() {
|
||||
const ffDir = join(ROOT, "node_modules", "ffmpeg-static");
|
||||
const ffName = PLATFORM === "win32" ? "ffmpeg.exe" : "ffmpeg";
|
||||
const ffDest = join(ffDir, ffName);
|
||||
|
||||
if (!existsSync(ffDir)) { log("ffmpeg-static not installed, skipping"); return false; }
|
||||
if (existsSync(ffDest)) {
|
||||
if (isValidSize(ffDest, 50 * 1024 * 1024)) {
|
||||
log("ffmpeg already exists, skipping");
|
||||
return true;
|
||||
}
|
||||
log("ffmpeg exists but seems corrupted (too small), re-downloading...");
|
||||
}
|
||||
|
||||
const url = `${CDN}/ffmpeg-static/b6.1.1/ffmpeg-${PLATFORM}-${ARCH}.gz`;
|
||||
log("Downloading ffmpeg...");
|
||||
const buf = await download(url);
|
||||
await pipeline(Readable.from(buf), createGunzip(), createWriteStream(ffDest));
|
||||
try { execSync(`chmod +x "${ffDest}"`); } catch {}
|
||||
const size = ((await statSync(ffDest)).size / 1024 / 1024).toFixed(1);
|
||||
log(`ffmpeg OK (${size} MB)`);
|
||||
return true;
|
||||
}
|
||||
|
||||
async function downloadOpus() {
|
||||
const opusDir = join(ROOT, "node_modules", "@discordjs", "opus");
|
||||
const prebuildName = `node-v${NODE_ABI}-napi-v3-${PLATFORM}-${ARCH}-unknown-unknown`;
|
||||
const opusDest = join(opusDir, "prebuild", prebuildName, "opus.node");
|
||||
|
||||
if (!existsSync(opusDir)) { log("@discordjs/opus not installed, skipping"); return false; }
|
||||
if (existsSync(opusDest)) {
|
||||
if (isValidSize(opusDest, 100 * 1024)) {
|
||||
log("@discordjs/opus already exists, skipping");
|
||||
return true;
|
||||
}
|
||||
log("@discordjs/opus exists but seems corrupted (too small), re-downloading...");
|
||||
}
|
||||
|
||||
const url = `${CDN}/@discordjs/opus/v0.10.0/opus-v0.10.0-node-v${NODE_ABI}-napi-v3-${PLATFORM}-${ARCH}-unknown-unknown.tar.gz`;
|
||||
log("Downloading @discordjs/opus...");
|
||||
try {
|
||||
const buf = await download(url);
|
||||
mkdirSync(dirname(opusDest), { recursive: true });
|
||||
const require = createRequire(import.meta.url);
|
||||
const tar = require("tar");
|
||||
const tmpFile = join(tmpdir(), `discordjs-opus-${Date.now()}.tar.gz`);
|
||||
writeFileSync(tmpFile, buf);
|
||||
await tar.extract({ cwd: join(opusDir, "prebuild"), file: tmpFile });
|
||||
log("@discordjs/opus OK");
|
||||
return true;
|
||||
} catch (err) {
|
||||
log(`CDN download failed (${err.message}), trying to build from source...`);
|
||||
try {
|
||||
execSync("npm rebuild @discordjs/opus", { cwd: ROOT, stdio: "inherit" });
|
||||
if (existsSync(opusDest) && isValidSize(opusDest, 100 * 1024)) {
|
||||
log("@discordjs/opus built from source OK");
|
||||
return true;
|
||||
}
|
||||
log("Source build completed but .node file not found");
|
||||
return false;
|
||||
} catch (buildErr) {
|
||||
log(`Source build failed: ${buildErr.message}`);
|
||||
log("Install build tools: sudo apt install build-essential (Ubuntu/Debian)");
|
||||
log(" sudo yum groupinstall 'Development Tools' (CentOS/RHEL)");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function downloadBetterSqlite3() {
|
||||
const pkgDir = join(ROOT, "node_modules", "better-sqlite3");
|
||||
const dest = join(pkgDir, "build", "Release", "better_sqlite3.node");
|
||||
|
||||
if (!existsSync(pkgDir)) { log("better-sqlite3 not installed, skipping"); return false; }
|
||||
if (existsSync(dest)) {
|
||||
if (isValidSize(dest, 500 * 1024)) {
|
||||
log("better-sqlite3 already exists, skipping");
|
||||
return true;
|
||||
}
|
||||
log("better-sqlite3 exists but seems corrupted (too small), re-downloading...");
|
||||
}
|
||||
|
||||
const version = "12.8.0";
|
||||
const url = `${CDN}/better-sqlite3/v${version}/better-sqlite3-v${version}-node-v${NODE_ABI}-${PLATFORM}-${ARCH}.tar.gz`;
|
||||
log("Downloading better-sqlite3...");
|
||||
const buf = await download(url);
|
||||
const require = createRequire(import.meta.url);
|
||||
const tar = require("tar");
|
||||
const tmpFile = join(tmpdir(), `better-sqlite3-${Date.now()}.tar.gz`);
|
||||
writeFileSync(tmpFile, buf);
|
||||
mkdirSync(dirname(dest), { recursive: true });
|
||||
await tar.extract({ cwd: pkgDir, file: tmpFile });
|
||||
if (existsSync(dest)) {
|
||||
log(`better-sqlite3 OK (${((await statSync(dest)).size / 1024).toFixed(0)} KB)`);
|
||||
return true;
|
||||
}
|
||||
log("better-sqlite3 extracted but .node file not found at expected path");
|
||||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
const results = await Promise.all([downloadFfmpeg(), downloadOpus(), downloadBetterSqlite3()]);
|
||||
if (results.some(Boolean)) {
|
||||
console.log(" [binary] All downloads complete");
|
||||
}
|
||||
} catch (e) {
|
||||
console.error(` [binary] ERROR: ${e.message}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
+294
-321
@@ -1,321 +1,294 @@
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
chcp 65001 >nul
|
||||
title TSMusicBot Setup
|
||||
|
||||
:: ============================================================
|
||||
:: TSMusicBot Setup Script (Robust Edition)
|
||||
:: - Auto-detect China network, switch to npmmirror
|
||||
:: - Strict error checking at every step
|
||||
:: - Detailed logging to setup.log
|
||||
:: - Skip already-completed steps on re-run
|
||||
:: ============================================================
|
||||
|
||||
set "SCRIPT_VERSION=2.0"
|
||||
set "MIN_NODE_MAJOR=20"
|
||||
set "LOG_FILE=%~dp0..\setup.log"
|
||||
set "FAILED=0"
|
||||
|
||||
:: Resolve project root (one level up from scripts/)
|
||||
cd /d "%~dp0.." || (
|
||||
echo [FATAL] Cannot change to project directory.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
set "PROJECT_ROOT=%cd%"
|
||||
|
||||
:: ---- Initialize log ----
|
||||
echo. > "%LOG_FILE%"
|
||||
call :log "============================================"
|
||||
call :log " TSMusicBot Setup v%SCRIPT_VERSION%"
|
||||
call :log " Started: %date% %time%"
|
||||
call :log " Project root: %PROJECT_ROOT%"
|
||||
call :log "============================================"
|
||||
|
||||
echo ============================================
|
||||
echo TSMusicBot - First-Time Setup (Windows)
|
||||
echo Version %SCRIPT_VERSION%
|
||||
echo ============================================
|
||||
echo.
|
||||
echo Log file: %LOG_FILE%
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 1: Check Node.js
|
||||
:: ============================================================
|
||||
call :step "1/6" "Checking Node.js"
|
||||
|
||||
where node >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "Node.js not found in PATH."
|
||||
echo.
|
||||
echo Please install Node.js %MIN_NODE_MAJOR% LTS or newer from one of:
|
||||
echo - https://nodejs.org/ ^(official^)
|
||||
echo - https://nodejs.cn/ ^(China mirror, recommended for CN users^)
|
||||
echo.
|
||||
echo After installation:
|
||||
echo 1. Close this window completely
|
||||
echo 2. Open a NEW Command Prompt
|
||||
echo 3. Run scripts\setup.bat again
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: Check Node version >= 20
|
||||
for /f "tokens=1 delims=v." %%a in ('node --version 2^>nul') do set "NODE_RAW=%%a"
|
||||
for /f "tokens=1 delims=v." %%a in ('node --version 2^>nul') do (
|
||||
for /f "tokens=1 delims=." %%b in ("%%a") do set "NODE_MAJOR=%%b"
|
||||
)
|
||||
|
||||
:: Robust version parse
|
||||
for /f "delims=" %%v in ('node --version 2^>nul') do set "NODE_VER=%%v"
|
||||
set "NODE_VER_NUM=%NODE_VER:v=%"
|
||||
for /f "tokens=1 delims=." %%a in ("%NODE_VER_NUM%") do set "NODE_MAJOR=%%a"
|
||||
|
||||
call :log "Node.js version: %NODE_VER%"
|
||||
echo [OK] Node.js found: %NODE_VER%
|
||||
|
||||
if %NODE_MAJOR% LSS %MIN_NODE_MAJOR% (
|
||||
call :error "Node.js version too old. Need %MIN_NODE_MAJOR%+, found %NODE_VER%."
|
||||
echo Please upgrade Node.js to version %MIN_NODE_MAJOR% LTS or newer.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 2: Check npm
|
||||
:: ============================================================
|
||||
call :step "2/6" "Checking npm"
|
||||
|
||||
where npm >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "npm not found. This is unusual since Node.js is installed."
|
||||
echo Please reinstall Node.js to fix this.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
for /f "delims=" %%v in ('npm --version 2^>nul') do set "NPM_VER=%%v"
|
||||
call :log "npm version: %NPM_VER%"
|
||||
echo [OK] npm found: %NPM_VER%
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 3: Detect network and configure mirror
|
||||
:: ============================================================
|
||||
call :step "3/6" "Checking network"
|
||||
|
||||
set "USE_MIRROR=0"
|
||||
|
||||
:: Try reaching npm registry with a short timeout
|
||||
echo Testing connection to registry.npmjs.org...
|
||||
call :log "Testing npm registry connectivity..."
|
||||
|
||||
:: Use curl if available (more reliable than ping for HTTPS)
|
||||
where curl >nul 2>&1
|
||||
if not errorlevel 1 (
|
||||
curl -s -o nul -m 5 -w "%%{http_code}" https://registry.npmjs.org/ > "%TEMP%\npmtest.txt" 2>nul
|
||||
set /p HTTP_CODE=<"%TEMP%\npmtest.txt"
|
||||
del "%TEMP%\npmtest.txt" >nul 2>&1
|
||||
if "!HTTP_CODE!"=="200" (
|
||||
echo [OK] npm registry reachable.
|
||||
call :log "npm registry HTTP 200 OK"
|
||||
) else (
|
||||
echo [WARN] npm registry slow or unreachable ^(code: !HTTP_CODE!^).
|
||||
call :log "npm registry returned: !HTTP_CODE!"
|
||||
set "USE_MIRROR=1"
|
||||
)
|
||||
) else (
|
||||
:: Fallback to ping
|
||||
ping -n 1 -w 3000 registry.npmjs.org >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
echo [WARN] Cannot reach npm registry quickly.
|
||||
set "USE_MIRROR=1"
|
||||
) else (
|
||||
echo [OK] npm registry reachable.
|
||||
)
|
||||
)
|
||||
|
||||
if "%USE_MIRROR%"=="1" (
|
||||
echo.
|
||||
echo Slow connection detected. Switching to China mirror ^(npmmirror.com^)...
|
||||
call :log "Switching to npmmirror.com"
|
||||
call npm config set registry https://registry.npmmirror.com >>"%LOG_FILE%" 2>&1
|
||||
call npm config set disturl https://registry.npmmirror.com/-/binary/node >>"%LOG_FILE%" 2>&1
|
||||
call npm config set electron_mirror https://registry.npmmirror.com/-/binary/electron/ >>"%LOG_FILE%" 2>&1
|
||||
call npm config set sqlite3_binary_host_mirror https://registry.npmmirror.com/-/binary/better-sqlite3 >>"%LOG_FILE%" 2>&1
|
||||
call npm config set node_sqlite3_binary_host_mirror https://registry.npmmirror.com/-/binary/better-sqlite3 >>"%LOG_FILE%" 2>&1
|
||||
call npm config set sharp_binary_host https://registry.npmmirror.com/-/binary/sharp >>"%LOG_FILE%" 2>&1
|
||||
call npm config set sharp_libvips_binary_host https://registry.npmmirror.com/-/binary/sharp-libvips >>"%LOG_FILE%" 2>&1
|
||||
call npm config set FFMPEG_BINARIES_URL https://registry.npmmirror.com/-/binary/ffmpeg-static >>"%LOG_FILE%" 2>&1
|
||||
call npm config set @discordjs:registry https://registry.npmmirror.com >>"%LOG_FILE%" 2>&1
|
||||
echo [OK] Mirror configured.
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 4: Install backend dependencies
|
||||
:: ============================================================
|
||||
call :step "4/6" "Installing backend dependencies"
|
||||
|
||||
if exist "node_modules\.package-lock.json" (
|
||||
echo Found existing node_modules. Checking integrity...
|
||||
call :log "Existing node_modules detected, running npm install to verify"
|
||||
)
|
||||
|
||||
echo Running: npm install ^(this can take 5-15 minutes on slow networks^)
|
||||
echo Press Ctrl+C to abort.
|
||||
echo.
|
||||
|
||||
call npm install >>"%LOG_FILE%" 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "Backend npm install failed."
|
||||
echo.
|
||||
echo Common causes:
|
||||
echo - Network timeout ^(retry with VPN or check %LOG_FILE%^)
|
||||
echo - Native module compile failure ^(missing Python/VS Build Tools^)
|
||||
echo - Disk space full
|
||||
echo.
|
||||
echo Try manually:
|
||||
echo cd /d "%PROJECT_ROOT%"
|
||||
echo npm install --verbose
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Backend dependencies installed.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 5: Install frontend dependencies
|
||||
:: ============================================================
|
||||
call :step "5/6" "Installing frontend dependencies"
|
||||
|
||||
if not exist "web\package.json" (
|
||||
call :error "web\package.json not found. Repository may be incomplete."
|
||||
echo Please re-clone the repository:
|
||||
echo git clone https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
echo Running: npm install ^(in web/ directory^)
|
||||
echo.
|
||||
|
||||
pushd web >nul
|
||||
call npm install >>"%LOG_FILE%" 2>&1
|
||||
set "WEB_INSTALL_RESULT=!errorlevel!"
|
||||
popd >nul
|
||||
|
||||
if !WEB_INSTALL_RESULT! neq 0 (
|
||||
call :error "Frontend npm install failed ^(exit code !WEB_INSTALL_RESULT!^)."
|
||||
echo.
|
||||
echo Try manually:
|
||||
echo cd /d "%PROJECT_ROOT%\web"
|
||||
echo npm install --verbose
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Frontend dependencies installed.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 6: Build project (backend + frontend)
|
||||
:: ============================================================
|
||||
call :step "6/6" "Building project"
|
||||
|
||||
echo Running: npm run build
|
||||
echo.
|
||||
|
||||
call npm run build >>"%LOG_FILE%" 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "Build failed."
|
||||
echo.
|
||||
echo Check the log file for details: %LOG_FILE%
|
||||
echo.
|
||||
echo Try manually:
|
||||
echo cd /d "%PROJECT_ROOT%"
|
||||
echo npm run build
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Build succeeded.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Verify build outputs
|
||||
:: ============================================================
|
||||
echo Verifying build outputs...
|
||||
set "BUILD_OK=1"
|
||||
|
||||
if not exist "dist" (
|
||||
call :error "dist/ directory missing after build."
|
||||
set "BUILD_OK=0"
|
||||
)
|
||||
if not exist "web\dist" (
|
||||
call :error "web\dist/ directory missing after build."
|
||||
set "BUILD_OK=0"
|
||||
)
|
||||
|
||||
if "!BUILD_OK!"=="0" (
|
||||
echo.
|
||||
echo Build completed but expected output is missing.
|
||||
echo Check %LOG_FILE% for details.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Build outputs verified.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Optional: config.json hint
|
||||
:: ============================================================
|
||||
if not exist "config.json" (
|
||||
echo [INFO] config.json will be auto-generated on first launch.
|
||||
) else (
|
||||
echo [OK] config.json already exists.
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Done
|
||||
:: ============================================================
|
||||
call :log "Setup completed successfully at %date% %time%"
|
||||
|
||||
echo ============================================
|
||||
echo Setup Complete!
|
||||
echo ============================================
|
||||
echo.
|
||||
echo Next steps:
|
||||
echo 1. Run: scripts\start.bat
|
||||
echo 2. Open: http://localhost:3000
|
||||
echo 3. Follow the in-browser setup wizard.
|
||||
echo.
|
||||
echo Setup log saved to: %LOG_FILE%
|
||||
echo.
|
||||
pause
|
||||
exit /b 0
|
||||
|
||||
:: ============================================================
|
||||
:: Subroutines
|
||||
:: ============================================================
|
||||
:step
|
||||
echo ---- Step %~1: %~2 ----
|
||||
call :log ""
|
||||
call :log "---- Step %~1: %~2 ----"
|
||||
goto :eof
|
||||
|
||||
:error
|
||||
echo.
|
||||
echo [ERROR] %~1
|
||||
call :log "[ERROR] %~1"
|
||||
goto :eof
|
||||
|
||||
:log
|
||||
echo [%time%] %~1 >> "%LOG_FILE%"
|
||||
goto :eof
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
chcp 65001 >nul
|
||||
title TSMusicBot Setup
|
||||
|
||||
:: ============================================================
|
||||
:: TSMusicBot Setup Script (Windows)
|
||||
:: - Auto-detect China network, switch to npmmirror
|
||||
:: - Download native binaries from CDN (避开 GitHub)
|
||||
:: - 自动修复 PowerShell 环境变量
|
||||
:: ============================================================
|
||||
|
||||
set "SCRIPT_VERSION=2.1"
|
||||
set "MIN_NODE_MAJOR=20"
|
||||
set "LOG_FILE=%~dp0..\setup.log"
|
||||
set "FAILED=0"
|
||||
|
||||
:: Resolve project root (one level up from scripts/)
|
||||
cd /d "%~dp0.." || (
|
||||
echo [FATAL] Cannot change to project directory.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
set "PROJECT_ROOT=%cd%"
|
||||
|
||||
:: ---- Initialize log ----
|
||||
echo. > "%LOG_FILE%"
|
||||
call :log "============================================"
|
||||
call :log " TSMusicBot Setup v%SCRIPT_VERSION%"
|
||||
call :log " Started: %date% %time%"
|
||||
call :log " Project root: %PROJECT_ROOT%"
|
||||
call :log "============================================"
|
||||
|
||||
echo ============================================
|
||||
echo TSMusicBot - First-Time Setup (Windows)
|
||||
echo Version %SCRIPT_VERSION%
|
||||
echo ============================================
|
||||
echo.
|
||||
echo Log file: %LOG_FILE%
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 1: Check Node.js
|
||||
:: ============================================================
|
||||
call :step "1/7" "Checking Node.js"
|
||||
|
||||
where node >nul 2>&1
|
||||
if not errorlevel 1 goto :check_node_version
|
||||
|
||||
call :error "Node.js not found in PATH."
|
||||
echo.
|
||||
echo Please install Node.js %MIN_NODE_MAJOR% LTS or newer from:
|
||||
echo https://nodejs.org/ (official)
|
||||
echo https://nodejs.cn/ (China mirror, recommended)
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
|
||||
:check_node_version
|
||||
for /f "delims=" %%v in ('node --version 2^>nul') do set "NODE_VER=%%v"
|
||||
for /f "tokens=1 delims=v." %%a in ("%NODE_VER%") do set "NODE_MAJOR=%%a"
|
||||
|
||||
call :log "Node.js version: %NODE_VER%"
|
||||
echo [OK] Node.js found: %NODE_VER%
|
||||
|
||||
if %NODE_MAJOR% LSS %MIN_NODE_MAJOR% (
|
||||
call :error "Node.js version too old. Need %MIN_NODE_MAJOR%+, found %NODE_VER%."
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 2: Check npm
|
||||
:: ============================================================
|
||||
call :step "2/7" "Checking npm"
|
||||
|
||||
where npm >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "npm not found."
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
for /f "delims=" %%v in ('npm --version 2^>nul') do set "NPM_VER=%%v"
|
||||
call :log "npm version: %NPM_VER%"
|
||||
echo [OK] npm found: %NPM_VER%
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 3: Detect network and configure mirror
|
||||
:: ============================================================
|
||||
call :step "3/7" "Checking network"
|
||||
|
||||
set "USE_MIRROR=0"
|
||||
set "MIRROR_REGISTRY=https://registry.npmjs.org"
|
||||
|
||||
echo Testing connection to npm registry...
|
||||
call :log "Testing npm registry connectivity..."
|
||||
|
||||
ping -n 1 -w 4000 registry.npmjs.org >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
echo [WARN] Cannot reach npm registry quickly, using China mirror.
|
||||
call :log "npm registry unreachable via ping"
|
||||
set "USE_MIRROR=1"
|
||||
) else (
|
||||
echo [OK] npm registry reachable.
|
||||
call :log "npm registry reachable"
|
||||
)
|
||||
|
||||
if "%USE_MIRROR%"=="1" (
|
||||
echo.
|
||||
echo [INFO] Using China mirror (npmmirror.com)
|
||||
call :log "Switching to npmmirror.com"
|
||||
set "MIRROR_REGISTRY=https://registry.npmmirror.com"
|
||||
set "CDN_MIRROR=https://cdn.npmmirror.com/binaries"
|
||||
) else (
|
||||
set "CDN_MIRROR="
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 4: Install backend dependencies (跳过二进制)
|
||||
:: ============================================================
|
||||
call :step "4/7" "Installing backend dependencies"
|
||||
|
||||
if exist "node_modules\.package-lock.json" (
|
||||
echo Found existing node_modules. Checking integrity...
|
||||
)
|
||||
|
||||
echo Running: npm install --ignore-scripts (跳过 GitHub 二进制下载)
|
||||
echo.
|
||||
|
||||
call npm install --registry=%MIRROR_REGISTRY% --ignore-scripts >>"%LOG_FILE%" 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "Backend npm install failed."
|
||||
echo Check the log: %LOG_FILE%
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Backend dependencies installed.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 4b: Download native binaries from CDN
|
||||
:: ============================================================
|
||||
call :step "4b/7" "Downloading native binaries"
|
||||
|
||||
node scripts/download-binaries.mjs %CDN_MIRROR% >>"%LOG_FILE%" 2>&1
|
||||
if errorlevel 1 (
|
||||
echo [WARN] Binary download had issues. Check %LOG_FILE% for details.
|
||||
) else (
|
||||
echo [OK] Native binaries installed.
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 5: Install frontend dependencies
|
||||
:: ============================================================
|
||||
call :step "5/7" "Installing frontend dependencies"
|
||||
|
||||
if not exist "web\package.json" (
|
||||
call :error "web\package.json not found."
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
echo Running: npm install (in web/)
|
||||
echo.
|
||||
|
||||
pushd web >nul
|
||||
call npm install --registry=%MIRROR_REGISTRY% >>"%LOG_FILE%" 2>&1
|
||||
set "WEB_INSTALL_RESULT=!errorlevel!"
|
||||
popd >nul
|
||||
|
||||
if !WEB_INSTALL_RESULT! neq 0 (
|
||||
call :error "Frontend npm install failed."
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Frontend dependencies installed.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 6: Build project
|
||||
:: ============================================================
|
||||
call :step "6/7" "Building project"
|
||||
|
||||
echo Running: npm run build
|
||||
echo.
|
||||
|
||||
call npm run build >>"%LOG_FILE%" 2>&1
|
||||
if errorlevel 1 (
|
||||
call :error "Build failed. Check: %LOG_FILE%"
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Build succeeded.
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Step 7: Ensure PowerShell in PATH (修复 jdymusic CDN 播放)
|
||||
:: ============================================================
|
||||
call :step "7/7" "Checking PowerShell PATH"
|
||||
|
||||
where powershell >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
echo [WARN] PowerShell not found in PATH.
|
||||
echo Attempting to fix...
|
||||
set "POWERSHELL_PATH=C:\Windows\System32\WindowsPowerShell\v1.0"
|
||||
if exist "!POWERSHELL_PATH!\powershell.exe" (
|
||||
:: 为用户添加永久 PATH 环境变量
|
||||
echo [INFO] Adding PowerShell to user PATH...
|
||||
call setx PATH "!POWERSHELL_PATH!;%PATH%" >nul 2>&1
|
||||
echo [OK] PowerShell added to PATH. Please restart your terminal.
|
||||
) else (
|
||||
echo [WARN] Could not find powershell.exe on this system.
|
||||
echo If you encounter playback issues with some NetEase songs,
|
||||
echo run: set PATH=%%PATH%%;C:\Windows\System32\WindowsPowerShell\v1.0\
|
||||
echo before running scripts\start.bat
|
||||
)
|
||||
) else (
|
||||
echo [OK] PowerShell found in PATH.
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Verify build outputs
|
||||
:: ============================================================
|
||||
echo Verifying build outputs...
|
||||
set "BUILD_OK=1"
|
||||
|
||||
if not exist "dist" (
|
||||
call :error "dist/ directory missing after build."
|
||||
set "BUILD_OK=0"
|
||||
)
|
||||
if not exist "web\dist" (
|
||||
call :error "web\dist/ directory missing after build."
|
||||
set "BUILD_OK=0"
|
||||
)
|
||||
|
||||
if "!BUILD_OK!"=="0" (
|
||||
echo Build completed but expected output is missing.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
echo [OK] Build outputs verified.
|
||||
echo.
|
||||
|
||||
if not exist "config.json" (
|
||||
echo [INFO] config.json will be auto-generated on first launch.
|
||||
) else (
|
||||
echo [OK] config.json already exists.
|
||||
)
|
||||
echo.
|
||||
|
||||
:: ============================================================
|
||||
:: Done
|
||||
:: ============================================================
|
||||
call :log "Setup completed successfully at %date% %time%"
|
||||
|
||||
echo ============================================
|
||||
echo Setup Complete!
|
||||
echo ============================================
|
||||
echo.
|
||||
echo Next steps:
|
||||
echo 1. Run: scripts\start.bat
|
||||
echo 2. Open: http://localhost:3000
|
||||
echo.
|
||||
echo Setup log: %LOG_FILE%
|
||||
echo.
|
||||
pause
|
||||
exit /b 0
|
||||
|
||||
:: ============================================================
|
||||
:: Subroutines
|
||||
:: ============================================================
|
||||
:step
|
||||
echo ---- Step %~1: %~2 ----
|
||||
call :log ""
|
||||
call :log "---- Step %~1: %~2 ----"
|
||||
goto :eof
|
||||
|
||||
:error
|
||||
echo.
|
||||
echo [ERROR] %~1
|
||||
call :log "[ERROR] %~1"
|
||||
goto :eof
|
||||
|
||||
:log
|
||||
echo [%time%] %~1 >> "%LOG_FILE%"
|
||||
goto :eof
|
||||
|
||||
Executable
+145
@@ -0,0 +1,145 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
#
|
||||
# TSMusicBot Setup Script (Linux/macOS)
|
||||
# - Auto-detect China network, switch to npmmirror
|
||||
# - Download native binaries from CDN (避开 GitHub)
|
||||
# - One-click setup, same as setup.bat for Windows
|
||||
#
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
PROJECT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||||
LOG_FILE="$PROJECT_DIR/setup.log"
|
||||
|
||||
echo "============================================"
|
||||
echo " TSMusicBot - First-Time Setup (Linux)"
|
||||
echo "============================================"
|
||||
echo ""
|
||||
echo "Log file: $LOG_FILE"
|
||||
echo ""
|
||||
|
||||
# ---- Check Node.js ----
|
||||
if ! command -v node &>/dev/null; then
|
||||
echo "[ERROR] Node.js not found. Please install Node.js 20+ from https://nodejs.org"
|
||||
echo " or https://nodejs.cn/ (China mirror)."
|
||||
exit 1
|
||||
fi
|
||||
echo "[OK] Node.js $(node -v)"
|
||||
|
||||
if ! command -v npm &>/dev/null; then
|
||||
echo "[ERROR] npm not found."
|
||||
exit 1
|
||||
fi
|
||||
echo "[OK] npm v$(npm -v)"
|
||||
echo ""
|
||||
|
||||
# ---- Detect China network ----
|
||||
USE_MIRROR=0
|
||||
MIRROR_REGISTRY="https://registry.npmjs.org"
|
||||
CDN_MIRROR=""
|
||||
|
||||
echo "Testing connection to npm registry..."
|
||||
if ping -c 1 -W 4 registry.npmjs.org &>/dev/null; then
|
||||
echo "[OK] npm registry reachable."
|
||||
else
|
||||
echo "[WARN] Cannot reach npm registry, using China mirror."
|
||||
USE_MIRROR=1
|
||||
fi
|
||||
|
||||
if [ "$USE_MIRROR" = "1" ]; then
|
||||
echo "[INFO] Using China mirror (npmmirror.com)"
|
||||
MIRROR_REGISTRY="https://registry.npmmirror.com"
|
||||
CDN_MIRROR="https://cdn.npmmirror.com/binaries"
|
||||
export npm_config_registry="$MIRROR_REGISTRY"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# ---- Check build tools (needed for native module fallback) ----
|
||||
if ! command -v gcc &>/dev/null && ! command -v clang &>/dev/null; then
|
||||
echo "[INFO] No C compiler found. If CDN binaries are unavailable,"
|
||||
echo " native modules may fail. Install build tools:"
|
||||
echo " sudo apt install build-essential (Ubuntu/Debian)"
|
||||
echo " sudo yum groupinstall 'Development Tools' (CentOS/RHEL)"
|
||||
echo ""
|
||||
fi
|
||||
|
||||
# ---- Step 1: Install dependencies (skip GitHub binaries) ----
|
||||
echo "---- 1/5: Installing Node.js dependencies ----"
|
||||
echo ""
|
||||
|
||||
cd "$PROJECT_DIR"
|
||||
npm install --registry="$MIRROR_REGISTRY" --ignore-scripts 2>&1 | tee -a "$LOG_FILE"
|
||||
echo "[OK] Dependencies installed."
|
||||
echo ""
|
||||
|
||||
# ---- Step 2: Download native binaries from CDN ----
|
||||
echo "---- 2/5: Downloading native binaries ----"
|
||||
echo ""
|
||||
|
||||
if node scripts/download-binaries.mjs $CDN_MIRROR 2>&1 | tee -a "$LOG_FILE"; then
|
||||
echo "[OK] Native binaries installed."
|
||||
else
|
||||
echo "[WARN] Some native binaries had issues (will try source build as fallback)."
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# ---- Step 3: Install web panel dependencies ----
|
||||
echo "---- 3/5: Installing web panel dependencies ----"
|
||||
echo ""
|
||||
|
||||
if [ -f "web/package.json" ]; then
|
||||
cd "$PROJECT_DIR/web"
|
||||
npm install --registry="$MIRROR_REGISTRY" 2>&1 | tee -a "$LOG_FILE"
|
||||
cd "$PROJECT_DIR"
|
||||
echo "[OK] Web panel dependencies installed."
|
||||
else
|
||||
echo "[SKIP] web/package.json not found."
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# ---- Step 4: Build project ----
|
||||
echo "---- 4/5: Building project ----"
|
||||
echo ""
|
||||
|
||||
npm run build 2>&1 | tee -a "$LOG_FILE"
|
||||
echo "[OK] Build succeeded."
|
||||
echo ""
|
||||
|
||||
# ---- Step 5: Verify ----
|
||||
echo "---- 5/5: Verifying build ----"
|
||||
echo ""
|
||||
|
||||
BUILD_OK=1
|
||||
if [ ! -d "dist" ]; then
|
||||
echo "[ERROR] dist/ directory missing."
|
||||
BUILD_OK=0
|
||||
fi
|
||||
if [ -d "web" ] && [ ! -d "web/dist" ]; then
|
||||
echo "[ERROR] web/dist/ directory missing."
|
||||
BUILD_OK=0
|
||||
fi
|
||||
|
||||
if [ "$BUILD_OK" = "0" ]; then
|
||||
echo "Build completed but expected output is missing."
|
||||
exit 1
|
||||
fi
|
||||
echo "[OK] Build outputs verified."
|
||||
echo ""
|
||||
|
||||
if [ ! -f "config.json" ]; then
|
||||
echo "[INFO] config.json will be auto-generated on first launch."
|
||||
fi
|
||||
echo ""
|
||||
|
||||
echo "============================================"
|
||||
echo " Setup Complete!"
|
||||
echo "============================================"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo " 1. Run: npm start"
|
||||
echo " 2. Open: http://localhost:3000"
|
||||
echo ""
|
||||
echo "Setup log: $LOG_FILE"
|
||||
echo ""
|
||||
|
||||
+43
-46
@@ -1,47 +1,44 @@
|
||||
@echo off
|
||||
title TSMusicBot
|
||||
echo Starting TSMusicBot...
|
||||
echo.
|
||||
@echo off
|
||||
title TSMusicBot
|
||||
echo Starting TSMusicBot...
|
||||
echo.
|
||||
|
||||
:: Check if node is available
|
||||
where node >nul 2>&1
|
||||
if %errorlevel% neq 0 (
|
||||
echo Node.js is not installed.
|
||||
echo Run scripts\setup.bat first.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: Resolve project root (one level up from scripts/)
|
||||
cd /d "%~dp0.."
|
||||
|
||||
:: Check if dependencies are installed
|
||||
if not exist "node_modules" (
|
||||
echo Dependencies not found. Please run scripts\setup.bat first.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: Check if build output exists
|
||||
if not exist "dist" (
|
||||
echo Build not found. Please run scripts\setup.bat first.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: Ensure PowerShell is in PATH (fix for jdymusic CDN playback on some systems)
|
||||
where powershell >nul 2>&1
|
||||
if errorlevel 1 (
|
||||
if exist "C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe" (
|
||||
set "PATH=%PATH%;C:\Windows\System32\WindowsPowerShell\v1.0\"
|
||||
)
|
||||
)
|
||||
|
||||
:: Start the application
|
||||
node dist/index.js
|
||||
|
||||
pause
|
||||
|
||||
:: Check if node is available
|
||||
where node >nul 2>&1
|
||||
if %errorlevel% neq 0 (
|
||||
echo Node.js is not installed.
|
||||
echo Run scripts\setup.bat for automatic installation, or install Node.js 20+ from https://nodejs.org
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: Resolve project root (one level up from scripts/)
|
||||
cd /d "%~dp0.."
|
||||
|
||||
:: Install dependencies if needed
|
||||
if not exist "node_modules" (
|
||||
echo Installing dependencies...
|
||||
call npm install --production
|
||||
if %errorlevel% neq 0 (
|
||||
echo Failed to install dependencies.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
)
|
||||
|
||||
:: Build if dist/ doesn't exist
|
||||
if not exist "dist" (
|
||||
echo Building project...
|
||||
call npx tsc
|
||||
if %errorlevel% neq 0 (
|
||||
echo Build failed.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
)
|
||||
|
||||
:: FFmpeg is bundled via ffmpeg-static — no PATH check needed.
|
||||
echo FFmpeg is bundled via node_modules (ffmpeg-static).
|
||||
echo.
|
||||
|
||||
:: Start the application
|
||||
node dist/index.js
|
||||
|
||||
pause
|
||||
@@ -0,0 +1,106 @@
|
||||
// Empirically verifies the PowerShell-download workaround for jdymusic CDN
|
||||
// blocks Node.js HTTP. Runs A/B against the same fresh /jdymusic/ URL:
|
||||
// A) ffmpeg direct with browser UA (the previous fix in this branch)
|
||||
// B) PowerShell WebClient -> temp file -> ffmpeg from file (the new fix)
|
||||
// Reports bytes received + exit code + stderr-tail for each.
|
||||
|
||||
import { spawn } from "node:child_process";
|
||||
import { mkdtempSync, statSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { buildFfmpegArgs } from "../dist/audio/player.js";
|
||||
|
||||
const url = process.argv[2];
|
||||
if (!url) {
|
||||
console.error("usage: node scripts/test_jdymusic_powershell.mjs <jdymusic_url>");
|
||||
process.exit(2);
|
||||
}
|
||||
if (!url.includes("/jdymusic/")) {
|
||||
console.error("warning: this script targets /jdymusic/ URLs specifically");
|
||||
}
|
||||
|
||||
const FFMPEG = "ffmpeg";
|
||||
const BROWSER_UA =
|
||||
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
|
||||
const TIMEOUT_MS = 20_000;
|
||||
|
||||
function runFfmpeg(label, args, stdinSource) {
|
||||
return new Promise((resolve) => {
|
||||
const proc = spawn(FFMPEG, args, { stdio: [stdinSource ?? "ignore", "pipe", "pipe"] });
|
||||
let bytes = 0;
|
||||
let stderrTail = "";
|
||||
let killed = false;
|
||||
proc.stdout.on("data", (chunk) => { bytes += chunk.length; });
|
||||
proc.stderr.on("data", (chunk) => { stderrTail = (stderrTail + chunk.toString()).slice(-1500); });
|
||||
const timer = setTimeout(() => { killed = true; proc.kill("SIGTERM"); }, TIMEOUT_MS);
|
||||
proc.on("exit", (code, signal) => {
|
||||
clearTimeout(timer);
|
||||
resolve({ label, bytes, code, signal, killed, stderrTail });
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
function downloadViaPowerShell(targetUrl, outFile) {
|
||||
return new Promise((resolve) => {
|
||||
const psScript = [
|
||||
"$ErrorActionPreference = 'Stop'",
|
||||
"$ProgressPreference = 'SilentlyContinue'",
|
||||
"$wc = New-Object System.Net.WebClient",
|
||||
"$wc.Headers.Add('User-Agent', $env:DL_UA)",
|
||||
"$wc.Headers.Add('Referer', $env:DL_REFERER)",
|
||||
"$wc.DownloadFile($env:DL_URL, $env:DL_OUT)",
|
||||
].join("; ");
|
||||
const ps = spawn(
|
||||
"powershell",
|
||||
["-NoProfile", "-ExecutionPolicy", "Bypass", "-Command", psScript],
|
||||
{
|
||||
env: {
|
||||
...process.env,
|
||||
DL_URL: targetUrl,
|
||||
DL_OUT: outFile,
|
||||
DL_UA: BROWSER_UA,
|
||||
DL_REFERER: "https://music.163.com/",
|
||||
},
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
},
|
||||
);
|
||||
let stderr = "";
|
||||
ps.stderr.on("data", (chunk) => { stderr += chunk.toString(); });
|
||||
ps.on("exit", (code) => resolve({ code, stderr }));
|
||||
});
|
||||
}
|
||||
|
||||
console.log(`URL: ${url}\n`);
|
||||
|
||||
console.log("[A] ffmpeg direct (browser UA via -headers)");
|
||||
const a = await runFfmpeg("A", buildFfmpegArgs(url, 0));
|
||||
console.log(` code=${a.code} bytes=${a.bytes} killed=${a.killed}`);
|
||||
console.log(` stderr-tail: ${a.stderrTail.split("\n").slice(-3).join(" | ")}\n`);
|
||||
|
||||
console.log("[B] PowerShell WebClient -> temp file -> ffmpeg -i tempfile");
|
||||
const tempDir = mkdtempSync(join(tmpdir(), "tsbot-jdymusic-test-"));
|
||||
const tempFile = join(tempDir, "song.audio");
|
||||
const psStart = Date.now();
|
||||
const dl = await downloadViaPowerShell(url, tempFile);
|
||||
const psMs = Date.now() - psStart;
|
||||
if (dl.code !== 0) {
|
||||
console.log(` PowerShell download FAILED: code=${dl.code}`);
|
||||
console.log(` stderr: ${dl.stderr.slice(-500)}`);
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
process.exit(1);
|
||||
}
|
||||
const dlSize = statSync(tempFile).size;
|
||||
console.log(` PowerShell downloaded ${dlSize} bytes in ${psMs}ms`);
|
||||
|
||||
const b = await runFfmpeg("B", buildFfmpegArgs(tempFile, 0));
|
||||
console.log(` ffmpeg-from-file: code=${b.code} bytes=${b.bytes} killed=${b.killed}`);
|
||||
console.log(` stderr-tail: ${b.stderrTail.split("\n").slice(-3).join(" | ")}\n`);
|
||||
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
|
||||
const aBlocked = a.bytes === 0 && !a.killed;
|
||||
const bWorked = b.bytes > 100_000;
|
||||
console.log(
|
||||
`Verdict: direct ${aBlocked ? "BLOCKED" : "OK"} ; ` +
|
||||
`powershell-then-ffmpeg ${bWorked ? "WORKED" : "FAILED"}`,
|
||||
);
|
||||
@@ -0,0 +1,73 @@
|
||||
// Empirically tests whether the browser UA + Referer headers fix the
|
||||
// connection resets we saw in bot.log against m701/m801.music.126.net.
|
||||
//
|
||||
// Spawns ffmpeg twice against the SAME fresh Netease CDN URL:
|
||||
// A) old args from before the fix (no headers, -reconnect_delay_max 5)
|
||||
// B) new args from after the fix (browser UA + Referer for music.126.net)
|
||||
// and reports bytes received + exit code + stderr-tail for each.
|
||||
|
||||
import { spawn } from "node:child_process";
|
||||
import { buildFfmpegArgs } from "../dist/audio/player.js";
|
||||
|
||||
const url = process.argv[2];
|
||||
if (!url) {
|
||||
console.error("usage: node scripts/test_netease_ua_fix.mjs <netease_cdn_url>");
|
||||
process.exit(2);
|
||||
}
|
||||
|
||||
const FFMPEG = "ffmpeg";
|
||||
const TIMEOUT_MS = 15_000;
|
||||
|
||||
function legacyArgs(u) {
|
||||
return [
|
||||
"-reconnect", "1",
|
||||
"-reconnect_streamed", "1",
|
||||
"-reconnect_delay_max", "5",
|
||||
"-i", u,
|
||||
"-f", "s16le",
|
||||
"-ar", "48000",
|
||||
"-ac", "2",
|
||||
"-acodec", "pcm_s16le",
|
||||
"-",
|
||||
];
|
||||
}
|
||||
|
||||
function runFfmpeg(label, args) {
|
||||
return new Promise((resolve) => {
|
||||
const proc = spawn(FFMPEG, args, { stdio: ["ignore", "pipe", "pipe"] });
|
||||
let bytes = 0;
|
||||
let stderrTail = "";
|
||||
let killed = false;
|
||||
|
||||
proc.stdout.on("data", (chunk) => {
|
||||
bytes += chunk.length;
|
||||
});
|
||||
proc.stderr.on("data", (chunk) => {
|
||||
stderrTail = (stderrTail + chunk.toString()).slice(-1500);
|
||||
});
|
||||
|
||||
const timer = setTimeout(() => {
|
||||
killed = true;
|
||||
proc.kill("SIGTERM");
|
||||
}, TIMEOUT_MS);
|
||||
|
||||
proc.on("exit", (code, signal) => {
|
||||
clearTimeout(timer);
|
||||
resolve({ label, bytes, code, signal, killed, stderrTail });
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
console.log(`URL: ${url}\n`);
|
||||
|
||||
const a = await runFfmpeg("A) legacy args (no UA)", legacyArgs(url));
|
||||
console.log(`[A] code=${a.code} signal=${a.signal} killed=${a.killed} bytes=${a.bytes}`);
|
||||
console.log(` stderr-tail:\n${a.stderrTail.split("\n").slice(-6).map((l) => " " + l).join("\n")}\n`);
|
||||
|
||||
const b = await runFfmpeg("B) fixed args (browser UA + Referer)", buildFfmpegArgs(url, 0));
|
||||
console.log(`[B] code=${b.code} signal=${b.signal} killed=${b.killed} bytes=${b.bytes}`);
|
||||
console.log(` stderr-tail:\n${b.stderrTail.split("\n").slice(-6).map((l) => " " + l).join("\n")}\n`);
|
||||
|
||||
const aFailed = a.bytes === 0 && !a.killed && a.code !== 0;
|
||||
const bWorked = b.bytes > 100_000; // got real audio bytes
|
||||
console.log(`Verdict: legacy ${aFailed ? "FAILED (no bytes, exit code 1)" : "??"} ; fixed ${bWorked ? "WORKED (received audio)" : "??"}`);
|
||||
@@ -0,0 +1,588 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { mkdtempSync, writeFileSync, existsSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { Readable } from "node:stream";
|
||||
import { buildFfmpegArgs, shouldUsePowerShellDownload, cleanupTempDir, shouldEndOnStall, volumeToFactor, AudioPlayer } from "./player.js";
|
||||
import type { Logger } from "../logger.js";
|
||||
|
||||
function getHeadersArg(args: string[]): string {
|
||||
const idx = args.indexOf("-headers");
|
||||
if (idx === -1) return "";
|
||||
return args[idx + 1] ?? "";
|
||||
}
|
||||
|
||||
describe("buildFfmpegArgs", () => {
|
||||
it("includes browser User-Agent and Referer for Netease CDN URLs", () => {
|
||||
const url = "http://m701.music.126.net/some/path/song.mp3?vuutv=abc";
|
||||
const args = buildFfmpegArgs(url, 0);
|
||||
const headers = getHeadersArg(args);
|
||||
expect(headers).toContain("User-Agent:");
|
||||
expect(headers).toContain("Mozilla/5.0");
|
||||
expect(headers).toContain("Referer: https://music.163.com/");
|
||||
});
|
||||
|
||||
it("keeps Bilibili Referer + UA for bilibili URLs", () => {
|
||||
const url = "https://upos-sz-mirrorcoso1.bilivideo.com/foo/bar.mp3";
|
||||
const args = buildFfmpegArgs(url, 0);
|
||||
const headers = getHeadersArg(args);
|
||||
expect(headers).toContain("Referer: https://www.bilibili.com");
|
||||
expect(headers).toContain("User-Agent: Mozilla/5.0");
|
||||
});
|
||||
|
||||
it("does not set custom headers for unknown URLs", () => {
|
||||
const url = "https://example.com/song.mp3";
|
||||
const args = buildFfmpegArgs(url, 0);
|
||||
expect(args).not.toContain("-headers");
|
||||
});
|
||||
|
||||
it("includes resilient reconnect flags for all URLs", () => {
|
||||
const args = buildFfmpegArgs("https://example.com/song.mp3", 0);
|
||||
expect(args).toContain("-reconnect");
|
||||
expect(args).toContain("-reconnect_streamed");
|
||||
expect(args).toContain("-reconnect_delay_max");
|
||||
expect(args).toContain("-reconnect_on_network_error");
|
||||
expect(args).toContain("-reconnect_on_http_error");
|
||||
const idx = args.indexOf("-reconnect_delay_max");
|
||||
expect(Number(args[idx + 1])).toBeGreaterThanOrEqual(30);
|
||||
});
|
||||
|
||||
it("sets -reconnect_at_eof 1 (before -i) so long B站 streams resume after premature EOF (#89)", () => {
|
||||
const args = buildFfmpegArgs("https://x.bilivideo.com/audio.m4s", 0);
|
||||
const idx = args.indexOf("-reconnect_at_eof");
|
||||
expect(idx).toBeGreaterThan(-1);
|
||||
expect(args[idx + 1]).toBe("1");
|
||||
expect(idx).toBeLessThan(args.indexOf("-i")); // input options must precede -i
|
||||
});
|
||||
|
||||
it("inserts -ss before -i when seekSeconds > 0", () => {
|
||||
const args = buildFfmpegArgs("https://example.com/song.mp3", 42);
|
||||
const ssIdx = args.indexOf("-ss");
|
||||
const iIdx = args.indexOf("-i");
|
||||
expect(ssIdx).toBeGreaterThan(-1);
|
||||
expect(args[ssIdx + 1]).toBe("42");
|
||||
expect(ssIdx).toBeLessThan(iIdx);
|
||||
});
|
||||
|
||||
it("does not insert -ss when seekSeconds is 0", () => {
|
||||
const args = buildFfmpegArgs("https://example.com/song.mp3", 0);
|
||||
expect(args).not.toContain("-ss");
|
||||
});
|
||||
|
||||
it("omits HTTP-only flags when input is a local file path", () => {
|
||||
const args = buildFfmpegArgs("C:/temp/song.mp3", 0);
|
||||
expect(args).not.toContain("-reconnect");
|
||||
expect(args).not.toContain("-reconnect_at_eof");
|
||||
expect(args).not.toContain("-reconnect_on_network_error");
|
||||
expect(args).not.toContain("-reconnect_on_http_error");
|
||||
expect(args).not.toContain("-headers");
|
||||
expect(args).toContain("-i");
|
||||
expect(args[args.indexOf("-i") + 1]).toBe("C:/temp/song.mp3");
|
||||
});
|
||||
|
||||
it("ends args with the input URL and PCM output spec", () => {
|
||||
const url = "https://example.com/song.mp3";
|
||||
const args = buildFfmpegArgs(url, 0);
|
||||
const iIdx = args.indexOf("-i");
|
||||
expect(args[iIdx + 1]).toBe(url);
|
||||
expect(args).toContain("-f");
|
||||
expect(args).toContain("s16le");
|
||||
expect(args[args.length - 1]).toBe("-");
|
||||
});
|
||||
});
|
||||
|
||||
describe("volumeToFactor (#84 smooth volume curve)", () => {
|
||||
it("is 0 at vol 0 and exactly 1.0 at vol 100 (full loudness still reserved at 100)", () => {
|
||||
expect(volumeToFactor(0)).toBe(0);
|
||||
expect(volumeToFactor(100)).toBe(1);
|
||||
});
|
||||
|
||||
it("clamps out-of-range input", () => {
|
||||
expect(volumeToFactor(-20)).toBe(0);
|
||||
expect(volumeToFactor(150)).toBe(1);
|
||||
});
|
||||
|
||||
it("is strictly monotonic across the whole range (no dead zone)", () => {
|
||||
for (let v = 0; v < 100; v++) {
|
||||
expect(volumeToFactor(v + 1)).toBeGreaterThan(volumeToFactor(v));
|
||||
}
|
||||
});
|
||||
|
||||
it("removes the old flat 80-99 dead zone", () => {
|
||||
// Old mapping moved only 0.16 -> 0.198 across 80..99; new curve climbs clearly.
|
||||
expect(volumeToFactor(99) - volumeToFactor(80)).toBeGreaterThan(0.3);
|
||||
});
|
||||
|
||||
it("removes the discontinuity at 100 (old jump was ~0.8)", () => {
|
||||
expect(volumeToFactor(100) - volumeToFactor(99)).toBeLessThan(0.1);
|
||||
});
|
||||
|
||||
it("keeps the low range gentle", () => {
|
||||
expect(volumeToFactor(50)).toBeLessThan(0.12);
|
||||
});
|
||||
});
|
||||
|
||||
describe("shouldUsePowerShellDownload", () => {
|
||||
const jdymusicUrl =
|
||||
"http://m801.music.126.net/20260507/abc/jdymusic/obj/xyz/song.mp3?vuutv=tok";
|
||||
const newCdnUrl =
|
||||
"http://m801.music.126.net/20260507/abc/jd-musicrep-ts/obj/xyz/song.mp3?vuutv=tok";
|
||||
const ymusicUrl =
|
||||
"http://m801.music.126.net/20260507/abc/ymusic/obj/xyz/song.mp3?vuutv=tok";
|
||||
|
||||
it("returns true for /jdymusic/ URL on win32", () => {
|
||||
expect(shouldUsePowerShellDownload(jdymusicUrl, "win32")).toBe(true);
|
||||
});
|
||||
|
||||
it("returns false for /jdymusic/ URL on linux", () => {
|
||||
expect(shouldUsePowerShellDownload(jdymusicUrl, "linux")).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false for /jdymusic/ URL on darwin", () => {
|
||||
expect(shouldUsePowerShellDownload(jdymusicUrl, "darwin")).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false for new-format /jd-musicrep-ts/ URL on win32", () => {
|
||||
expect(shouldUsePowerShellDownload(newCdnUrl, "win32")).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false for /ymusic/ URL on win32", () => {
|
||||
expect(shouldUsePowerShellDownload(ymusicUrl, "win32")).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false for unrelated URLs", () => {
|
||||
expect(shouldUsePowerShellDownload("https://example.com/x.mp3", "win32")).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("cleanupTempDir", () => {
|
||||
it("removes a directory and its contents", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsbot-test-"));
|
||||
writeFileSync(join(dir, "song.mp3"), "fake-bytes");
|
||||
expect(existsSync(dir)).toBe(true);
|
||||
cleanupTempDir(dir);
|
||||
expect(existsSync(dir)).toBe(false);
|
||||
});
|
||||
|
||||
it("does not throw when directory does not exist", () => {
|
||||
const missing = join(tmpdir(), "tsbot-test-does-not-exist-xyz");
|
||||
expect(() => cleanupTempDir(missing)).not.toThrow();
|
||||
});
|
||||
|
||||
it("does not throw when called twice", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsbot-test-"));
|
||||
cleanupTempDir(dir);
|
||||
expect(() => cleanupTempDir(dir)).not.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe("shouldEndOnStall (#89 mid-track stall watchdog)", () => {
|
||||
const MAX_EMPTY = 250; // ~5s near-end threshold
|
||||
const MAX_STALL = 3000; // ~60s far-from-end watchdog
|
||||
|
||||
it("ends quickly near the end once the empty threshold is reached (normal EOF)", () => {
|
||||
expect(shouldEndOnStall(MAX_EMPTY, true, MAX_EMPTY, MAX_STALL)).toBe(true);
|
||||
expect(shouldEndOnStall(MAX_EMPTY - 1, true, MAX_EMPTY, MAX_STALL)).toBe(false);
|
||||
});
|
||||
|
||||
it("does NOT end far from the end at the near-end threshold (avoids false skips on transient underruns)", () => {
|
||||
// This is the core regression: a brief underrun mid-song must not end the track.
|
||||
expect(shouldEndOnStall(MAX_EMPTY, false, MAX_EMPTY, MAX_STALL)).toBe(false);
|
||||
expect(shouldEndOnStall(MAX_STALL - 1, false, MAX_EMPTY, MAX_STALL)).toBe(false);
|
||||
});
|
||||
|
||||
it("eventually ends far from the end once the long stall watchdog trips (dead stream recovers)", () => {
|
||||
// The pre-fix bug: far-from-end stalls grew unbounded and never ended -> permanent silence.
|
||||
expect(shouldEndOnStall(MAX_STALL, false, MAX_EMPTY, MAX_STALL)).toBe(true);
|
||||
expect(shouldEndOnStall(MAX_STALL + 500, false, MAX_EMPTY, MAX_STALL)).toBe(true);
|
||||
});
|
||||
|
||||
it("never ends before any threshold", () => {
|
||||
expect(shouldEndOnStall(0, true, MAX_EMPTY, MAX_STALL)).toBe(false);
|
||||
expect(shouldEndOnStall(10, false, MAX_EMPTY, MAX_STALL)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
// Minimal stub: AudioPlayer only calls debug/info/warn/error; child() returns self.
|
||||
const silentLogger = {
|
||||
debug() {},
|
||||
info() {},
|
||||
warn() {},
|
||||
error() {},
|
||||
fatal() {},
|
||||
trace() {},
|
||||
child() {
|
||||
return silentLogger;
|
||||
},
|
||||
} as unknown as Logger;
|
||||
|
||||
// A readable we fully control: no underlying source; we push PCM manually and
|
||||
// keep it open (never push(null)) to model the long-lived go-librespot sidecar.
|
||||
function openPcmReadable(): Readable {
|
||||
return new Readable({ read() {} });
|
||||
}
|
||||
|
||||
const wait = (ms: number): Promise<void> => new Promise<void>((r) => setTimeout(r, ms));
|
||||
const FRAME_BYTES = 3840; // PCM_FRAME_BYTES: 960 samples * 2ch * 2 bytes @48k s16le
|
||||
|
||||
describe("AudioPlayer external-PCM mode (playPcmStream)", () => {
|
||||
it("emits Opus 'frame' events from the external PCM stream without spawning ffmpeg", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const frames: Buffer[] = [];
|
||||
player.on("frame", (f) => frames.push(f));
|
||||
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 10)); // ~10 frames of PCM
|
||||
|
||||
await wait(150); // ~7 frame ticks at 20ms
|
||||
|
||||
expect(player.getState()).toBe("playing");
|
||||
expect(frames.length).toBeGreaterThan(0);
|
||||
expect(Buffer.isBuffer(frames[0])).toBe(true);
|
||||
player.stop();
|
||||
});
|
||||
|
||||
it("does NOT emit 'trackEnd' on underrun while external (stream stays open)", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
let ended = 0;
|
||||
const frames: Buffer[] = [];
|
||||
player.on("trackEnd", () => ended++);
|
||||
player.on("frame", (f) => frames.push(f));
|
||||
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 2)); // only 2 frames, then underrun
|
||||
|
||||
await wait(200); // long after those 2 frames have drained
|
||||
|
||||
// In the url path, ffmpeg===null + empty buffer would fire trackEnd; here it must not.
|
||||
expect(ended).toBe(0);
|
||||
// Silence frames keep the 20ms timeline alive -> more than the 2 fed frames emitted.
|
||||
expect(frames.length).toBeGreaterThan(2);
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
});
|
||||
|
||||
// CORRECTION C2 (c): stop() DETACHES the shared readable — it must NOT be destroyed
|
||||
// (destroying the sidecar's long-lived ffmpeg stdout would kill it for every future
|
||||
// track). The sessionId bump + listener removal fence stale PCM out of pcmBuffer.
|
||||
it("stop() detaches external mode without destroying the readable, and fences via sessionId", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const frames: Buffer[] = [];
|
||||
player.on("frame", (f) => frames.push(f));
|
||||
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
expect(stream.listenerCount("data")).toBe(1);
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 5));
|
||||
await wait(80);
|
||||
|
||||
player.stop();
|
||||
expect(player.getState()).toBe("idle");
|
||||
// C2: the shared sidecar stream must NOT be destroyed by teardown.
|
||||
expect(stream.destroyed).toBe(false);
|
||||
// Player's listeners are removed on detach (data/end/error).
|
||||
expect(stream.listenerCount("data")).toBe(0);
|
||||
expect(stream.listenerCount("end")).toBe(0);
|
||||
expect(stream.listenerCount("error")).toBe(0);
|
||||
|
||||
const countAtStop = frames.length;
|
||||
// sessionId fence + detached listeners: PCM pushed after stop must not
|
||||
// resurrect the timeline or re-feed pcmBuffer.
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 5));
|
||||
await wait(80);
|
||||
expect(frames.length).toBe(countAtStop);
|
||||
});
|
||||
|
||||
// CORRECTION C2 (a): a gapless track change is driven by the sidecar pushing LATER
|
||||
// PCM over the SAME already-attached stream. The player must NOT detach/re-attach
|
||||
// (no second playPcmStream) — one persistent data listener serves every track.
|
||||
it("(C2-a) feeds a later chunk over the SAME single attachment — gapless track change, no re-attach", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const frames: Buffer[] = [];
|
||||
player.on("frame", (f) => frames.push(f));
|
||||
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
expect(stream.listenerCount("data")).toBe(1); // attached exactly once
|
||||
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 4)); // "track 1" PCM
|
||||
await wait(120);
|
||||
const afterFirst = frames.length;
|
||||
expect(afterFirst).toBeGreaterThan(0);
|
||||
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 4)); // sidecar seamlessly rolls into "track 2"
|
||||
await wait(120);
|
||||
expect(frames.length).toBeGreaterThan(afterFirst);
|
||||
|
||||
// Still exactly ONE listener — no detach/re-attach across the handoff.
|
||||
expect(stream.listenerCount("data")).toBe(1);
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
});
|
||||
|
||||
// CORRECTION C2 (b): a second playPcmStream detaches the first (NOT destroyed, and it
|
||||
// stops feeding pcmBuffer) and attaches the second.
|
||||
it("(C2-b) a second playPcmStream detaches the first (not destroyed, stops feeding) and attaches the second", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const frames: Buffer[] = [];
|
||||
player.on("frame", (f) => frames.push(f));
|
||||
|
||||
const first = openPcmReadable();
|
||||
player.playPcmStream(first, {});
|
||||
first.push(Buffer.alloc(FRAME_BYTES * 4));
|
||||
await wait(120);
|
||||
expect(frames.length).toBeGreaterThan(0);
|
||||
expect(first.listenerCount("data")).toBe(1);
|
||||
|
||||
const second = openPcmReadable();
|
||||
player.playPcmStream(second, {}); // fences + detaches `first`, attaches `second`
|
||||
|
||||
// C2: `first` is DETACHED, not destroyed.
|
||||
expect(first.destroyed).toBe(false);
|
||||
// `first` no longer feeds pcmBuffer — its data listener was removed.
|
||||
expect(first.listenerCount("data")).toBe(0);
|
||||
// `second` is now the attached source.
|
||||
expect(second.listenerCount("data")).toBe(1);
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
});
|
||||
|
||||
it("fires onExternalEnd when the readable ends (drives controller-based advance)", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
let endedCb = 0;
|
||||
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, { onExternalEnd: () => endedCb++ });
|
||||
stream.push(Buffer.alloc(FRAME_BYTES));
|
||||
await wait(40);
|
||||
stream.push(null); // end-of-stream
|
||||
await wait(40);
|
||||
|
||||
expect(endedCb).toBe(1);
|
||||
player.stop();
|
||||
});
|
||||
|
||||
it("seek() is a local no-op in external mode (never respawns ffmpeg on a spotify sentinel)", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 3));
|
||||
await wait(40);
|
||||
|
||||
expect(() => player.seek(30)).not.toThrow();
|
||||
// Still external, still playing — no url-ffmpeg respawn, state unchanged.
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
});
|
||||
|
||||
it("isExternalActive() is false initially, true after playPcmStream, false after stop()", () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
// Idle: never attached.
|
||||
expect(player.isExternalActive()).toBe(false);
|
||||
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
// Attached to the external sidecar stream.
|
||||
expect(player.isExternalActive()).toBe(true);
|
||||
|
||||
player.stop();
|
||||
// Detached again — the orchestrator uses this to know it must re-attach.
|
||||
expect(player.isExternalActive()).toBe(false);
|
||||
});
|
||||
|
||||
it("pause()/resume() still gate local emission in external mode (unchanged semantics)", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const stream = openPcmReadable();
|
||||
player.playPcmStream(stream, {});
|
||||
stream.push(Buffer.alloc(FRAME_BYTES * 3));
|
||||
await wait(40);
|
||||
|
||||
player.pause();
|
||||
expect(player.getState()).toBe("paused");
|
||||
player.resume();
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
});
|
||||
|
||||
// CORRECTION C1 (whole-branch): mixed queue [spotifyA, neteaseB, spotifyC].
|
||||
// Advancing A -> B (a NON-spotify track) calls stop(), whose detachExternalStream()
|
||||
// PAUSES the backend's long-lived SHARED readable (state.flowing = false). When the
|
||||
// LATER spotify track C reuses the SAME backend, the orchestrator re-attaches that
|
||||
// SAME readable via playPcmStream(). Node's Readable.on('data') only auto-resumes
|
||||
// when flowing !== false, so without an explicit resume() the shared stream stays
|
||||
// paused, onData never fires, pcmBuffer stays empty, and C plays only silence frames.
|
||||
// Regression: after re-attach the shared stream MUST be flowing again and real PCM
|
||||
// MUST reach the player.
|
||||
it("(C1) resumes a re-attached, previously-paused SHARED stream so a later Spotify track isn't silent", async () => {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const frames: Buffer[] = [];
|
||||
player.on("frame", (f) => frames.push(f));
|
||||
|
||||
// The backend's long-lived, SHARED readable, reused across every track.
|
||||
const shared = openPcmReadable();
|
||||
|
||||
// --- Spotify track A: first attach (auto-resumes, flowing was null !== false).
|
||||
player.playPcmStream(shared, {});
|
||||
shared.push(Buffer.alloc(FRAME_BYTES * 4));
|
||||
await wait(120);
|
||||
expect(frames.length).toBeGreaterThan(0);
|
||||
|
||||
// --- Advance to a NON-spotify track (neteaseB): play(url) begins with stop(),
|
||||
// which detaches AND pauses the shared stream (state.flowing = false).
|
||||
player.stop();
|
||||
expect(shared.isPaused()).toBe(true); // shared stream is now paused
|
||||
expect(player.getState()).toBe("idle");
|
||||
|
||||
// --- Spotify track C reuses the SAME backend: isExternalActive() is false so the
|
||||
// orchestrator re-attaches the SAME (paused) shared readable.
|
||||
expect(player.isExternalActive()).toBe(false);
|
||||
|
||||
// Spy on the shared stream to observe whether real PCM actually flows to the
|
||||
// player. Adding a 'data' listener while flowing===false does NOT resume it
|
||||
// (Node semantics), so this spy cannot mask the bug — pre-fix it stays at 0.
|
||||
let spyBytes = 0;
|
||||
shared.on("data", (c: Buffer) => {
|
||||
spyBytes += c.length;
|
||||
});
|
||||
|
||||
player.playPcmStream(shared, {}); // re-attach the SAME shared readable
|
||||
|
||||
// The re-attached stream must be flowing again, or track C is silent.
|
||||
expect(shared.isPaused()).toBe(false);
|
||||
|
||||
shared.push(Buffer.alloc(FRAME_BYTES * 4)); // "track C" PCM
|
||||
await wait(120);
|
||||
|
||||
// onData must have run (real PCM reached the player), not just silence frames.
|
||||
expect(spyBytes).toBeGreaterThan(0);
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
});
|
||||
});
|
||||
|
||||
// R3-4: the 20ms frame loop keeps running while paused (so a live-but-silent
|
||||
// stream can refill on resume). But the stall/EOF end-detection branches MUST
|
||||
// only run while state==="playing" — otherwise pausing a stalled or
|
||||
// unknown-duration stream still accumulates emptyFrameAttempts and auto-emits
|
||||
// trackEnd (~5s later), making the controller skip the paused track.
|
||||
//
|
||||
// These tests drive the real url-path frame loop (this.ffmpeg !== null, NOT
|
||||
// external mode), which cannot be exercised via playPcmStream (that sets
|
||||
// externalMode and suppresses both branches). We inject a fake live ffmpeg +
|
||||
// an empty pcmBuffer (a stream that stays alive but never yields a full PCM
|
||||
// frame) and run the actual startFrameLoop() under fake timers. `performance`
|
||||
// is faked in lockstep with the timer clock so each tick advances a real 20ms,
|
||||
// letting us cheaply cross MAX_EMPTY_ATTEMPTS (250 ticks ≈ 5s) deterministically.
|
||||
describe("AudioPlayer stall/EOF end-detection is gated on playing state (R3-4)", () => {
|
||||
// Fake `performance` in lockstep with the timer clock so each advanced 20ms is
|
||||
// a real frame tick (the loop computes its delay from performance.now()).
|
||||
const FAKE_TIMER_OPTS: Parameters<typeof vi.useFakeTimers>[0] = {
|
||||
toFake: ["setTimeout", "clearTimeout", "setInterval", "clearInterval", "Date", "performance"],
|
||||
};
|
||||
|
||||
// A player primed as "playing" with a LIVE ffmpeg that never produces a full
|
||||
// PCM frame (unknown duration -> isNearEnd forced true). startFrameLoop() runs
|
||||
// the genuine loop; no real process is spawned (fake ffmpeg has no pid, so the
|
||||
// end path never touches forceCleanup/process.kill).
|
||||
function makeStalledPlaying(): AudioPlayer {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const p = player as unknown as {
|
||||
ffmpeg: unknown;
|
||||
currentSongDuration: number;
|
||||
pcmBuffer: Buffer;
|
||||
emptyFrameAttempts: number;
|
||||
framesPlayed: number;
|
||||
state: string;
|
||||
startFrameLoop(): void;
|
||||
};
|
||||
p.ffmpeg = { pid: undefined }; // live ffmpeg, but delivers no PCM
|
||||
p.currentSongDuration = 0; // unknown duration -> isNearEnd === true
|
||||
p.pcmBuffer = Buffer.alloc(0); // always < one PCM frame
|
||||
p.emptyFrameAttempts = 0;
|
||||
p.framesPlayed = 0;
|
||||
p.state = "playing";
|
||||
p.startFrameLoop();
|
||||
return player;
|
||||
}
|
||||
|
||||
it("does NOT emit trackEnd (and stays paused) when a stalled unknown-duration stream is paused past the stall threshold", () => {
|
||||
vi.useFakeTimers(FAKE_TIMER_OPTS);
|
||||
try {
|
||||
const player = makeStalledPlaying();
|
||||
let ended = 0;
|
||||
player.on("trackEnd", () => ended++);
|
||||
|
||||
player.pause();
|
||||
expect(player.getState()).toBe("paused");
|
||||
|
||||
// Advance well past MAX_EMPTY_ATTEMPTS (250 ticks ≈ 5s): ~300 ticks.
|
||||
vi.advanceTimersByTime(20 * 300);
|
||||
|
||||
expect(ended).toBe(0);
|
||||
expect(player.getState()).toBe("paused");
|
||||
player.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it("STILL emits trackEnd when the SAME stalled unknown-duration stream is left playing (dead-stream recovery #89 preserved)", () => {
|
||||
vi.useFakeTimers(FAKE_TIMER_OPTS);
|
||||
try {
|
||||
const player = makeStalledPlaying(); // stays "playing"
|
||||
let ended = 0;
|
||||
player.on("trackEnd", () => ended++);
|
||||
|
||||
vi.advanceTimersByTime(20 * 300); // cross the 250-tick stall threshold
|
||||
|
||||
expect(ended).toBe(1);
|
||||
expect(player.getState()).toBe("idle");
|
||||
player.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it("does not spuriously end after a brief pause+resume on a healthy stream", () => {
|
||||
vi.useFakeTimers(FAKE_TIMER_OPTS);
|
||||
try {
|
||||
const player = new AudioPlayer(silentLogger);
|
||||
const p = player as unknown as {
|
||||
ffmpeg: unknown;
|
||||
currentSongDuration: number;
|
||||
pcmBuffer: Buffer;
|
||||
emptyFrameAttempts: number;
|
||||
framesPlayed: number;
|
||||
state: string;
|
||||
startFrameLoop(): void;
|
||||
};
|
||||
// Healthy: a live ffmpeg with a large buffered runway that never drains
|
||||
// empty across the ticks below, so no underrun is ever seen.
|
||||
p.ffmpeg = { pid: undefined };
|
||||
p.currentSongDuration = 0;
|
||||
p.pcmBuffer = Buffer.alloc(FRAME_BYTES * 400);
|
||||
p.emptyFrameAttempts = 0;
|
||||
p.framesPlayed = 0;
|
||||
p.state = "playing";
|
||||
p.startFrameLoop();
|
||||
|
||||
let ended = 0;
|
||||
player.on("trackEnd", () => ended++);
|
||||
|
||||
vi.advanceTimersByTime(20 * 5); // play a few frames
|
||||
player.pause();
|
||||
vi.advanceTimersByTime(20 * 100); // brief pause (buffer NOT drained while paused)
|
||||
player.resume();
|
||||
expect(player.getState()).toBe("playing");
|
||||
vi.advanceTimersByTime(20 * 100); // resume; still plenty of runway
|
||||
|
||||
expect(ended).toBe(0);
|
||||
expect(player.getState()).toBe("playing");
|
||||
player.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
});
|
||||
+503
-24
@@ -1,8 +1,11 @@
|
||||
import { spawn, execSync, type ChildProcess } from "node:child_process";
|
||||
import { EventEmitter } from "node:events";
|
||||
import { createRequire } from "node:module";
|
||||
import { accessSync, chmodSync, constants } from "node:fs";
|
||||
import { accessSync, chmodSync, constants, mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { createOpusEncoder, PCM_FRAME_BYTES, type Encoder } from "./encoder.js";
|
||||
import type { Readable } from "node:stream";
|
||||
import type { Logger } from "../logger.js";
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
@@ -45,10 +48,104 @@ const resolvedFfmpeg: string = (() => {
|
||||
return "ffmpeg";
|
||||
})();
|
||||
|
||||
function getFfmpegCommand(): string {
|
||||
export function getFfmpegCommand(): string {
|
||||
return resolvedFfmpeg;
|
||||
}
|
||||
|
||||
const BROWSER_UA =
|
||||
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
|
||||
|
||||
// Old jdymusic CDN paths (e.g. /jdymusic/obj/...) RST direct Node-stack
|
||||
// requests on Windows; same URL works when fetched via WinHTTP. Empirically,
|
||||
// /jd-musicrep-ts/ and /ymusic/ paths do not have this restriction.
|
||||
export function shouldUsePowerShellDownload(
|
||||
url: string,
|
||||
platform: string = process.platform,
|
||||
): boolean {
|
||||
return platform === "win32" && url.includes("/jdymusic/");
|
||||
}
|
||||
|
||||
export function cleanupTempDir(dir: string): void {
|
||||
try {
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
} catch {
|
||||
// best-effort
|
||||
}
|
||||
}
|
||||
|
||||
export function buildFfmpegArgs(url: string, seekSeconds: number): string[] {
|
||||
const args: string[] = [];
|
||||
const isHttp = /^https?:\/\//i.test(url);
|
||||
|
||||
if (isHttp && (url.includes("bilivideo") || url.includes("bilibili"))) {
|
||||
args.push(
|
||||
"-headers",
|
||||
`Referer: https://www.bilibili.com\r\nUser-Agent: ${BROWSER_UA}\r\n`,
|
||||
);
|
||||
} else if (isHttp && (url.includes("music.126.net") || url.includes("music.163.com"))) {
|
||||
args.push(
|
||||
"-headers",
|
||||
`Referer: https://music.163.com/\r\nUser-Agent: ${BROWSER_UA}\r\n`,
|
||||
);
|
||||
}
|
||||
|
||||
if (isHttp) {
|
||||
args.push(
|
||||
"-reconnect", "1",
|
||||
// Long B站 streams sit on a CDN whose session/token can close the
|
||||
// connection mid-file (premature EOF). Without this, FFmpeg treats that
|
||||
// EOF as end-of-input and stops ~partway through (see #89); with it, it
|
||||
// re-issues a Range request from the current offset to finish the stream.
|
||||
"-reconnect_at_eof", "1",
|
||||
"-reconnect_streamed", "1",
|
||||
"-reconnect_delay_max", "30",
|
||||
"-reconnect_on_network_error", "1",
|
||||
"-reconnect_on_http_error", "4xx,5xx",
|
||||
);
|
||||
}
|
||||
if (seekSeconds > 0) args.push("-ss", String(seekSeconds));
|
||||
args.push("-i", url, "-f", "s16le", "-ar", "48000", "-ac", "2", "-acodec", "pcm_s16le", "-");
|
||||
|
||||
return args;
|
||||
}
|
||||
|
||||
/**
|
||||
* Decide whether to end the current track when FFmpeg is still alive but has
|
||||
* produced no decodable audio for `emptyAttempts` consecutive frame ticks.
|
||||
*
|
||||
* - Near the song end we end quickly (`maxEmptyAttempts`): a normal EOF.
|
||||
* - Far from the end we wait much longer (`maxStallAttempts`) before giving up,
|
||||
* so a transient buffer underrun on a healthy stream does NOT cause a false
|
||||
* skip — but a genuinely dead stream (e.g. a long B站 stream whose CDN session
|
||||
* expired mid-playback, #89) still recovers by advancing instead of going
|
||||
* permanently silent.
|
||||
*/
|
||||
export function shouldEndOnStall(
|
||||
emptyAttempts: number,
|
||||
isNearEnd: boolean,
|
||||
maxEmptyAttempts: number,
|
||||
maxStallAttempts: number,
|
||||
): boolean {
|
||||
if (isNearEnd && emptyAttempts >= maxEmptyAttempts) return true;
|
||||
if (emptyAttempts >= maxStallAttempts) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Maps a 0-100 volume value to a linear PCM gain factor (#84).
|
||||
*
|
||||
* Continuous and strictly monotonic over [0,100]: 0 at vol 0 and exactly 1.0 at
|
||||
* vol 100. The previous mapping was a two-piece step — gain = (vol/100)*0.2 for
|
||||
* vol<100 (so the whole 0-99 range only spanned 0..0.198, making 80->99 feel
|
||||
* flat) then a raw passthrough at vol===100 (a ~5x jump). This single curve keeps
|
||||
* the low end gentle but ramps smoothly toward full loudness near the top, so the
|
||||
* slider feels proportional with no dead zone and no discontinuity at 100.
|
||||
*/
|
||||
export function volumeToFactor(volume: number): number {
|
||||
const x = Math.max(0, Math.min(100, volume)) / 100;
|
||||
return 0.2 * x + 0.8 * Math.pow(x, 8);
|
||||
}
|
||||
|
||||
export interface PlayerEvents {
|
||||
frame: (opusFrame: Buffer) => void;
|
||||
trackEnd: () => void;
|
||||
@@ -80,6 +177,32 @@ export class AudioPlayer extends EventEmitter {
|
||||
private static readonly MAX_CONSECUTIVE_FAILURES = 3;
|
||||
private healthyFrames = 0;
|
||||
private static readonly HEALTHY_FRAME_RESET = 50; // ~1 second of audio
|
||||
private downloader: ChildProcess | null = null;
|
||||
private currentTempDir: string | null = null;
|
||||
private emptyFrameAttempts = 0;
|
||||
private static readonly MAX_EMPTY_ATTEMPTS = 250; // ~5秒的20ms帧循环(增加容错)
|
||||
// Far-from-end stall watchdog (#89): if FFmpeg is alive but produces no audio
|
||||
// for this many consecutive frame ticks (~60s at 20ms/frame), treat the stream
|
||||
// as dead and advance instead of staying silent forever. Set high so a normal
|
||||
// transient underrun never trips it.
|
||||
private static readonly MAX_STALL_ATTEMPTS = 3000;
|
||||
private currentSongDuration = 0; // 当前歌曲总时长(秒)
|
||||
|
||||
// --- External PCM mode (Stage 2: go-librespot Spotify sidecar) ---
|
||||
// When true, PCM arrives from a long-lived external Readable instead of a
|
||||
// per-URL ffmpeg: this.ffmpeg stays null, and the underrun-driven trackEnd
|
||||
// branches are suppressed (advance is driven by the controller, not EOF).
|
||||
//
|
||||
// CORRECTION C2: externalStream is the backend's LONG-LIVED, SHARED ffmpeg
|
||||
// stdout (one stream reused across every track). Teardown must DETACH (remove
|
||||
// the listeners we added + pause), never destroy it. We keep references to the
|
||||
// exact handler functions so detach can removeListener precisely.
|
||||
private externalMode = false;
|
||||
private externalStream: Readable | null = null;
|
||||
private onExternalEnd: (() => void) | null = null;
|
||||
private externalDataHandler: ((chunk: Buffer) => void) | null = null;
|
||||
private externalEndHandler: (() => void) | null = null;
|
||||
private externalErrorHandler: ((err: Error) => void) | null = null;
|
||||
|
||||
constructor(logger: Logger) {
|
||||
super();
|
||||
@@ -87,7 +210,7 @@ export class AudioPlayer extends EventEmitter {
|
||||
this.logger = logger;
|
||||
}
|
||||
|
||||
play(url: string, seekSeconds = 0): void {
|
||||
play(url: string, seekSeconds = 0, songDuration = 0): void {
|
||||
// 1. 停止当前所有播放,自增 sessionId 屏蔽旧回调 (
|
||||
this.stop();
|
||||
|
||||
@@ -98,6 +221,8 @@ export class AudioPlayer extends EventEmitter {
|
||||
this.healthyFrames = 0;
|
||||
this.ffmpegPaused = false;
|
||||
this.spawnFailed = false;
|
||||
this.emptyFrameAttempts = 0;
|
||||
this.currentSongDuration = songDuration;
|
||||
|
||||
if (this.consecutiveFailures >= AudioPlayer.MAX_CONSECUTIVE_FAILURES) {
|
||||
this.logger.error({ failures: this.consecutiveFailures }, "FFmpeg failures limit reached");
|
||||
@@ -106,13 +231,12 @@ export class AudioPlayer extends EventEmitter {
|
||||
return;
|
||||
}
|
||||
|
||||
const args: string[] = [];
|
||||
if (url.includes("bilivideo") || url.includes("bilibili")) {
|
||||
args.push("-headers", "Referer: https://www.bilibili.com\r\nUser-Agent: Mozilla/5.0...\r\n");
|
||||
if (shouldUsePowerShellDownload(url)) {
|
||||
this.playViaPowerShellDownload(url, seekSeconds, currentSessionId);
|
||||
return;
|
||||
}
|
||||
args.push("-reconnect", "1", "-reconnect_streamed", "1", "-reconnect_delay_max", "5");
|
||||
if (seekSeconds > 0) args.push("-ss", String(seekSeconds));
|
||||
args.push("-i", url, "-f", "s16le", "-ar", "48000", "-ac", "2", "-acodec", "pcm_s16le", "-");
|
||||
|
||||
const args = buildFfmpegArgs(url, seekSeconds);
|
||||
|
||||
const ffmpegBin = getFfmpegCommand();
|
||||
this.ffmpeg = spawn(ffmpegBin, args, { stdio: ["ignore", "pipe", "pipe"] });
|
||||
@@ -128,7 +252,7 @@ export class AudioPlayer extends EventEmitter {
|
||||
if (this.sessionId !== currentSessionId) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
this.pcmBuffer = Buffer.concat([this.pcmBuffer, chunk]);
|
||||
if (this.pcmBuffer.length > AudioPlayer.BUFFER_HIGH_WATER && !this.ffmpegPaused && this.ffmpeg?.stdout) {
|
||||
this.ffmpeg.stdout.pause();
|
||||
@@ -158,6 +282,242 @@ export class AudioPlayer extends EventEmitter {
|
||||
this.startFrameLoop();
|
||||
}
|
||||
|
||||
private playViaPowerShellDownload(url: string, seekSeconds: number, sessionId: number): void {
|
||||
const tempDir = mkdtempSync(join(tmpdir(), "tsbot-jdymusic-"));
|
||||
const tempFile = join(tempDir, "song.audio");
|
||||
this.currentTempDir = tempDir;
|
||||
|
||||
const psScript = [
|
||||
"$ErrorActionPreference = 'Stop'",
|
||||
"$ProgressPreference = 'SilentlyContinue'",
|
||||
"$wc = New-Object System.Net.WebClient",
|
||||
"$wc.Headers.Add('User-Agent', $env:DL_UA)",
|
||||
"$wc.Headers.Add('Referer', $env:DL_REFERER)",
|
||||
"$wc.DownloadFile($env:DL_URL, $env:DL_OUT)",
|
||||
].join("; ");
|
||||
|
||||
this.logger.debug({ sessionId, tempFile }, "Downloading via PowerShell (jdymusic CDN)");
|
||||
|
||||
const ps = spawn(
|
||||
"powershell",
|
||||
["-NoProfile", "-ExecutionPolicy", "Bypass", "-Command", psScript],
|
||||
{
|
||||
env: {
|
||||
...process.env,
|
||||
DL_URL: url,
|
||||
DL_OUT: tempFile,
|
||||
DL_UA: BROWSER_UA,
|
||||
DL_REFERER: "https://music.163.com/",
|
||||
},
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
},
|
||||
);
|
||||
this.downloader = ps;
|
||||
|
||||
let stderrTail = "";
|
||||
ps.stderr!.on("data", (chunk: Buffer) => {
|
||||
stderrTail = (stderrTail + chunk.toString()).slice(-500);
|
||||
});
|
||||
|
||||
ps.on("exit", (code, signal) => {
|
||||
if (this.sessionId !== sessionId) {
|
||||
cleanupTempDir(tempDir);
|
||||
return;
|
||||
}
|
||||
this.downloader = null;
|
||||
if (code !== 0) {
|
||||
this.logger.warn({ code, signal, stderr: stderrTail }, "PowerShell download failed");
|
||||
this.spawnFailed = true;
|
||||
this.consecutiveFailures++;
|
||||
this.state = "idle";
|
||||
cleanupTempDir(tempDir);
|
||||
this.currentTempDir = null;
|
||||
this.emit("error", new Error(`PowerShell download exited ${code}`));
|
||||
return;
|
||||
}
|
||||
this.spawnFfmpegFromFile(tempFile, seekSeconds, sessionId);
|
||||
});
|
||||
|
||||
ps.on("error", (err) => {
|
||||
if (this.sessionId !== sessionId) return;
|
||||
this.downloader = null;
|
||||
this.spawnFailed = true;
|
||||
this.consecutiveFailures++;
|
||||
cleanupTempDir(tempDir);
|
||||
this.currentTempDir = null;
|
||||
this.emit("error", err);
|
||||
});
|
||||
|
||||
// Mark playing but DO NOT start the frame loop here — the loop's
|
||||
// "no ffmpeg + empty buffer → trackEnd" branch would fire on the very
|
||||
// first tick, before the PowerShell download even completes. The
|
||||
// frame loop is started inside spawnFfmpegFromFile() once ffmpeg is
|
||||
// alive and producing PCM.
|
||||
this.state = "playing";
|
||||
}
|
||||
|
||||
private spawnFfmpegFromFile(tempFile: string, seekSeconds: number, sessionId: number): void {
|
||||
if (this.sessionId !== sessionId) {
|
||||
if (this.currentTempDir) {
|
||||
cleanupTempDir(this.currentTempDir);
|
||||
this.currentTempDir = null;
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
const args = buildFfmpegArgs(tempFile, seekSeconds);
|
||||
const ffmpegBin = getFfmpegCommand();
|
||||
this.ffmpeg = spawn(ffmpegBin, args, { stdio: ["ignore", "pipe", "pipe"] });
|
||||
|
||||
const currentPid = this.ffmpeg.pid;
|
||||
if (currentPid) {
|
||||
globalActivePids.add(currentPid);
|
||||
this.logger.debug({ pid: currentPid, sessionId }, "FFmpeg spawned (from temp file)");
|
||||
}
|
||||
const tempDirToCleanup = this.currentTempDir;
|
||||
|
||||
this.ffmpeg.stdout!.on("data", (chunk: Buffer) => {
|
||||
if (this.sessionId !== sessionId) return;
|
||||
this.pcmBuffer = Buffer.concat([this.pcmBuffer, chunk]);
|
||||
if (this.pcmBuffer.length > AudioPlayer.BUFFER_HIGH_WATER && !this.ffmpegPaused && this.ffmpeg?.stdout) {
|
||||
this.ffmpeg.stdout.pause();
|
||||
this.ffmpegPaused = true;
|
||||
}
|
||||
});
|
||||
|
||||
this.ffmpeg.on("exit", (code, signal) => {
|
||||
if (currentPid) globalActivePids.delete(currentPid);
|
||||
this.logger.info({ pid: currentPid, code, signal }, "FFmpeg exited");
|
||||
if (this.sessionId === sessionId) {
|
||||
this.ffmpeg = null;
|
||||
if (this.currentTempDir === tempDirToCleanup) this.currentTempDir = null;
|
||||
}
|
||||
if (tempDirToCleanup) cleanupTempDir(tempDirToCleanup);
|
||||
});
|
||||
|
||||
this.ffmpeg.on("error", (err) => {
|
||||
if (this.sessionId === sessionId) {
|
||||
this.spawnFailed = true;
|
||||
this.consecutiveFailures++;
|
||||
this.emit("error", err);
|
||||
}
|
||||
});
|
||||
|
||||
// Now that ffmpeg is producing PCM, run the frame loop.
|
||||
this.startFrameLoop();
|
||||
}
|
||||
|
||||
/**
|
||||
* External-PCM mode (Stage 2 go-librespot Spotify sidecar).
|
||||
*
|
||||
* Feeds an already-normalized 48kHz/s16le/stereo PCM Readable (the
|
||||
* go-librespot FIFO -> ffmpeg output) straight into the existing pcmBuffer +
|
||||
* 20ms frame loop + Opus encoder + "frame" emission, WITHOUT spawning a
|
||||
* per-URL ffmpeg. The url play() path is left completely untouched.
|
||||
*
|
||||
* Track advance is NOT driven by buffer underrun here (the sidecar stream is
|
||||
* continuous and never EOFs per song); the caller drives advance via the
|
||||
* SpotifyController "trackEnded" WebSocket event. onExternalEnd fires only if
|
||||
* the underlying readable itself ends or errors.
|
||||
*
|
||||
* CORRECTION C2: the readable is the backend's long-lived, SHARED ffmpeg
|
||||
* stdout reused across every track — a gapless track change is just LATER PCM
|
||||
* on this SAME already-attached stream (no re-attach). Teardown DETACHES
|
||||
* (removes our listeners + pauses); it never destroys the shared stream.
|
||||
*/
|
||||
playPcmStream(readable: Readable, opts: { onExternalEnd?: () => void } = {}): void {
|
||||
// 1. Fence current playback: stop() bumps sessionId, clears pcmBuffer, kills
|
||||
// any ffmpeg, and DETACHES (never destroys) any prior external stream.
|
||||
this.stop();
|
||||
|
||||
const currentSessionId = this.sessionId;
|
||||
this.externalMode = true;
|
||||
this.externalStream = readable;
|
||||
this.onExternalEnd = opts.onExternalEnd ?? null;
|
||||
// Leave this.ffmpeg = null; clear currentUrl so seek() cannot respawn ffmpeg.
|
||||
this.currentUrl = "";
|
||||
this.seekOffset = 0;
|
||||
this.framesPlayed = 0;
|
||||
this.healthyFrames = 0;
|
||||
this.ffmpegPaused = false;
|
||||
this.spawnFailed = false;
|
||||
this.emptyFrameAttempts = 0;
|
||||
this.currentSongDuration = 0;
|
||||
|
||||
// Same ingestion + high-water backpressure as the ffmpeg.stdout handler,
|
||||
// but pausing the Readable instead of ffmpeg.stdout. sessionId-guarded so
|
||||
// stale sidecar PCM can't leak into a new track after stop()/skip. Handler
|
||||
// refs are stored so detach can remove exactly these listeners (C2).
|
||||
const onData = (chunk: Buffer): void => {
|
||||
if (this.sessionId !== currentSessionId) return;
|
||||
this.pcmBuffer = Buffer.concat([this.pcmBuffer, chunk]);
|
||||
if (
|
||||
this.pcmBuffer.length > AudioPlayer.BUFFER_HIGH_WATER &&
|
||||
!this.ffmpegPaused &&
|
||||
this.externalStream === readable
|
||||
) {
|
||||
readable.pause();
|
||||
this.ffmpegPaused = true;
|
||||
}
|
||||
};
|
||||
const onEnd = (): void => {
|
||||
if (this.sessionId !== currentSessionId) return;
|
||||
this.onExternalEnd?.();
|
||||
};
|
||||
const onError = (err: Error): void => {
|
||||
if (this.sessionId !== currentSessionId) return;
|
||||
this.logger.warn({ err }, "External PCM stream error");
|
||||
this.onExternalEnd?.();
|
||||
};
|
||||
|
||||
this.externalDataHandler = onData;
|
||||
this.externalEndHandler = onEnd;
|
||||
this.externalErrorHandler = onError;
|
||||
|
||||
readable.on("data", onData);
|
||||
readable.on("end", onEnd);
|
||||
readable.on("error", onError);
|
||||
|
||||
// CORRECTION C1: explicitly resume a re-attached, previously-paused Readable.
|
||||
// The backend's SHARED stdout is reused across every track; a prior non-spotify
|
||||
// advance ran stop() -> detachExternalStream() which pause()d it (state.flowing =
|
||||
// false). Node's Readable.on('data') only auto-resumes when flowing !== false, so
|
||||
// re-attaching a paused stream would leave it stuck: onData never fires, pcmBuffer
|
||||
// stays empty, and a later Spotify track plays only silence. resume() is safe/
|
||||
// idempotent on a first attach (never-paused/already-flowing) stream.
|
||||
readable.resume();
|
||||
|
||||
this.state = "playing";
|
||||
this.startFrameLoop();
|
||||
}
|
||||
|
||||
/**
|
||||
* CORRECTION C2: DETACH, never destroy. The external readable is the backend's
|
||||
* long-lived, SHARED ffmpeg stdout reused across every track; destroying it
|
||||
* would kill the sidecar pipe for all future tracks. Remove only the listeners
|
||||
* WE added and pause the flow so stale PCM stops landing in pcmBuffer, then
|
||||
* clear the external-mode state.
|
||||
*/
|
||||
private detachExternalStream(): void {
|
||||
const stream = this.externalStream;
|
||||
if (stream) {
|
||||
if (this.externalDataHandler) stream.off("data", this.externalDataHandler);
|
||||
if (this.externalEndHandler) stream.off("end", this.externalEndHandler);
|
||||
if (this.externalErrorHandler) stream.off("error", this.externalErrorHandler);
|
||||
try {
|
||||
stream.pause();
|
||||
} catch {
|
||||
/* best-effort: never destroy the shared sidecar stream */
|
||||
}
|
||||
}
|
||||
this.externalDataHandler = null;
|
||||
this.externalEndHandler = null;
|
||||
this.externalErrorHandler = null;
|
||||
this.externalStream = null;
|
||||
this.externalMode = false;
|
||||
this.onExternalEnd = null;
|
||||
}
|
||||
|
||||
stop(): void {
|
||||
// 3. 递增 ID 是最有效的逻辑“隔离墙”
|
||||
this.sessionId++;
|
||||
@@ -169,13 +529,29 @@ export class AudioPlayer extends EventEmitter {
|
||||
if (this.ffmpeg) {
|
||||
const procToKill = this.ffmpeg;
|
||||
const pidToKill = procToKill.pid;
|
||||
this.ffmpeg = null;
|
||||
this.ffmpeg = null;
|
||||
|
||||
if (pidToKill) {
|
||||
this.forceCleanup(procToKill, pidToKill);
|
||||
}
|
||||
}
|
||||
|
||||
if (this.downloader) {
|
||||
const ps = this.downloader;
|
||||
this.downloader = null;
|
||||
try { ps.kill("SIGTERM"); } catch { /* already gone */ }
|
||||
}
|
||||
|
||||
if (this.currentTempDir) {
|
||||
cleanupTempDir(this.currentTempDir);
|
||||
this.currentTempDir = null;
|
||||
}
|
||||
|
||||
// CORRECTION C2: tear down external mode by DETACHING (remove our listeners +
|
||||
// pause) — never destroy the shared, long-lived sidecar stream. The
|
||||
// sessionId++ above already fences the external data/end/error handlers.
|
||||
this.detachExternalStream();
|
||||
|
||||
this.ffmpegPaused = false;
|
||||
this.spawnFailed = false;
|
||||
this.state = "idle";
|
||||
@@ -229,14 +605,79 @@ export class AudioPlayer extends EventEmitter {
|
||||
if (this.state === "playing") this.sendNextFrame();
|
||||
else if (this.state === "paused") this.nextFrameTime = performance.now();
|
||||
|
||||
if (!this.ffmpeg && this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
||||
this.frameLoopRunning = false;
|
||||
if (this.state !== "idle") {
|
||||
// 检测pcmBuffer不足PCM_FRAME_BYTES导致连续循环卡死:
|
||||
// 条件1: FFmpeg仍在运行但缓冲区不足一帧,且连续多次无法获取数据
|
||||
// 条件2: 已播放时间接近歌曲结尾(最后5秒内)或未知时长
|
||||
const elapsed = this.getElapsed();
|
||||
const isNearEnd = this.currentSongDuration > 0
|
||||
? (this.currentSongDuration - elapsed) <= 5 // 距离结尾不足5秒
|
||||
: true; // 未知时长时保守处理
|
||||
|
||||
// External mode: the sidecar PCM stream is continuous and never EOFs per
|
||||
// song; a transient underrun must NOT end the track (advance is driven by
|
||||
// the controller). Skip BOTH drain/stall branches while externalMode.
|
||||
//
|
||||
// R3-4: gate BOTH end-detection branches on state==="playing". While paused
|
||||
// the loop still ticks (so a resumed stream can refill), but it must NOT
|
||||
// accumulate stall attempts or emit trackEnd — otherwise pausing a stalled/
|
||||
// unknown-duration stream would auto-advance ~5s later. Because the if is
|
||||
// now false while paused, the else resets emptyFrameAttempts to 0, so a
|
||||
// resumed healthy stream starts fresh and never ends instantly.
|
||||
if (this.state === "playing" && !this.externalMode && this.ffmpeg !== null && this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
||||
this.emptyFrameAttempts++;
|
||||
|
||||
// End the track when FFmpeg has gone silent: quickly if we're near the
|
||||
// end (normal EOF), or after a much longer stall window if we're not
|
||||
// (a dead/expired stream — #89 — so playback recovers instead of going
|
||||
// permanently silent).
|
||||
if (
|
||||
shouldEndOnStall(
|
||||
this.emptyFrameAttempts,
|
||||
isNearEnd,
|
||||
AudioPlayer.MAX_EMPTY_ATTEMPTS,
|
||||
AudioPlayer.MAX_STALL_ATTEMPTS,
|
||||
)
|
||||
) {
|
||||
this.logger.info({
|
||||
sessionId: this.sessionId,
|
||||
emptyAttempts: this.emptyFrameAttempts,
|
||||
bufferSize: this.pcmBuffer.length,
|
||||
elapsed: Math.round(elapsed),
|
||||
duration: this.currentSongDuration,
|
||||
remaining: Math.round(this.currentSongDuration - elapsed),
|
||||
nearEnd: isNearEnd,
|
||||
}, "FFmpeg stopped outputting data, ending track");
|
||||
this.frameLoopRunning = false;
|
||||
// The outer gate guarantees state==="playing" here, so no !=="idle"
|
||||
// guard is needed: end the track directly.
|
||||
this.state = "idle";
|
||||
if (!this.spawnFailed) {
|
||||
this.consecutiveFailures = 0;
|
||||
this.emit("trackEnd");
|
||||
// 清理FFmpeg进程
|
||||
if (this.ffmpeg) {
|
||||
const procToKill = this.ffmpeg;
|
||||
const pidToKill = procToKill.pid;
|
||||
this.ffmpeg = null;
|
||||
if (pidToKill) {
|
||||
this.forceCleanup(procToKill, pidToKill);
|
||||
}
|
||||
}
|
||||
this.consecutiveFailures = 0;
|
||||
this.emit("trackEnd");
|
||||
return;
|
||||
}
|
||||
} else {
|
||||
// 成功获取数据或FFmpeg已结束,重置计数器
|
||||
this.emptyFrameAttempts = 0;
|
||||
}
|
||||
|
||||
// R3-4: likewise gated on state==="playing" — a drained/EOF'd stream must
|
||||
// not emit trackEnd while paused; end-detection resumes on resume().
|
||||
if (this.state === "playing" && !this.externalMode && !this.ffmpeg && this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
||||
this.frameLoopRunning = false;
|
||||
// Outer gate guarantees state==="playing"; end directly (no !=="idle" guard).
|
||||
this.state = "idle";
|
||||
if (!this.spawnFailed) {
|
||||
this.consecutiveFailures = 0;
|
||||
this.emit("trackEnd");
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -245,13 +686,24 @@ export class AudioPlayer extends EventEmitter {
|
||||
}
|
||||
|
||||
private sendNextFrame(): void {
|
||||
if (this.pcmBuffer.length < PCM_FRAME_BYTES) return;
|
||||
if (this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
||||
// External mode: the sidecar PCM stream is long-lived and must NOT end on
|
||||
// a transient underrun. Emit an encoded silence frame so the 20ms voice
|
||||
// timeline stays continuous instead of returning (which would desync TS).
|
||||
if (this.externalMode) this.emitSilenceFrame();
|
||||
return;
|
||||
}
|
||||
const pcmFrame = this.pcmBuffer.subarray(0, PCM_FRAME_BYTES);
|
||||
this.pcmBuffer = this.pcmBuffer.subarray(PCM_FRAME_BYTES);
|
||||
|
||||
if (this.ffmpegPaused && this.pcmBuffer.length < AudioPlayer.BUFFER_LOW_WATER && this.ffmpeg?.stdout) {
|
||||
this.ffmpeg.stdout.resume();
|
||||
this.ffmpegPaused = false;
|
||||
if (this.ffmpegPaused && this.pcmBuffer.length < AudioPlayer.BUFFER_LOW_WATER) {
|
||||
if (this.externalMode && this.externalStream) {
|
||||
this.externalStream.resume();
|
||||
this.ffmpegPaused = false;
|
||||
} else if (this.ffmpeg?.stdout) {
|
||||
this.ffmpeg.stdout.resume();
|
||||
this.ffmpegPaused = false;
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
@@ -269,9 +721,20 @@ export class AudioPlayer extends EventEmitter {
|
||||
}
|
||||
}
|
||||
|
||||
private emitSilenceFrame(): void {
|
||||
try {
|
||||
const opusFrame = this.encoder.encode(Buffer.alloc(PCM_FRAME_BYTES));
|
||||
this.emit("frame", opusFrame);
|
||||
this.framesPlayed++;
|
||||
} catch (err) {
|
||||
this.emit("error", err as Error);
|
||||
}
|
||||
}
|
||||
|
||||
private applyVolume(pcm: Buffer): Buffer {
|
||||
if (this.volume === 100) return Buffer.from(pcm);
|
||||
const factor = (this.volume / 100) * 0.2;
|
||||
const factor = volumeToFactor(this.volume);
|
||||
// factor === 1 only at volume 100; skip the per-sample loop at full loudness.
|
||||
if (factor >= 1) return Buffer.from(pcm);
|
||||
const out = Buffer.alloc(pcm.length);
|
||||
for (let i = 0; i < pcm.length; i += 2) {
|
||||
let sample = Math.round(pcm.readInt16LE(i) * factor);
|
||||
@@ -280,12 +743,28 @@ export class AudioPlayer extends EventEmitter {
|
||||
return out;
|
||||
}
|
||||
|
||||
// NOTE: in external (Spotify sidecar) mode getElapsed() is frame-count based
|
||||
// (framesPlayed includes silence frames emitted on underrun) and therefore
|
||||
// only APPROXIMATE — the authoritative position is the controller's live
|
||||
// status.track.position. This approximation is acceptable for Spotify.
|
||||
getElapsed(): number { return this.seekOffset + (this.framesPlayed * FRAME_DURATION_MS) / 1000; }
|
||||
seek(seconds: number): void { if (this.currentUrl && Number.isFinite(seconds) && seconds >= 0) this.play(this.currentUrl, seconds); }
|
||||
seek(seconds: number): void {
|
||||
// External (Spotify sidecar) mode: local seek is a no-op. Respawning ffmpeg
|
||||
// on the spotify: sentinel would collide with the continuous PCM source;
|
||||
// transport is delegated to the SpotifyController by the caller (Task 7).
|
||||
if (this.externalMode) return;
|
||||
if (this.currentUrl && Number.isFinite(seconds) && seconds >= 0) {
|
||||
this.play(this.currentUrl, seconds, this.currentSongDuration);
|
||||
}
|
||||
}
|
||||
pause(): void { if (this.state === "playing") this.state = "paused"; }
|
||||
resume(): void { if (this.state === "paused") { this.state = "playing"; this.nextFrameTime = performance.now(); } }
|
||||
resetFailures(): void { this.consecutiveFailures = 0; }
|
||||
setVolume(vol: number): void { this.volume = Math.max(0, Math.min(100, vol)); }
|
||||
getVolume(): number { return this.volume; }
|
||||
getState(): PlayerState { return this.state; }
|
||||
// True only while attached to an external (Spotify sidecar) PCM stream. Used
|
||||
// by the orchestrator to decide whether to re-attach: stop() detaches (sets
|
||||
// externalMode=false) so this is false after any player.stop().
|
||||
isExternalActive(): boolean { return this.externalMode; }
|
||||
}
|
||||
@@ -484,4 +484,84 @@ describe("PlayQueue", () => {
|
||||
expect(promoted?.id).toBe("x");
|
||||
});
|
||||
});
|
||||
|
||||
// Issue #70: 随机循环 (rloop) used true random-with-replacement, so some
|
||||
// songs repeated often while others were starved. It should behave like a
|
||||
// shuffle bag (NetEase/QQ style): play every song once per cycle in random
|
||||
// order, then reshuffle and continue, avoiding an immediate cross-cycle repeat.
|
||||
describe("random-loop shuffle bag (issue #70)", () => {
|
||||
it("plays every song exactly once per cycle before repeating", () => {
|
||||
queue.setMode(PlayMode.RandomLoop);
|
||||
const N = 12;
|
||||
for (let i = 0; i < N; i++) queue.add(makeSong(`s${i}`));
|
||||
queue.play();
|
||||
|
||||
const cycle1 = [queue.current()!.id];
|
||||
for (let i = 0; i < N - 1; i++) cycle1.push(queue.next()!.id);
|
||||
const cycle2: string[] = [];
|
||||
for (let i = 0; i < N; i++) cycle2.push(queue.next()!.id);
|
||||
|
||||
// Each cycle is a full permutation of all N songs — zero repeats within
|
||||
// a cycle, and both cycles cover the same complete set.
|
||||
expect(new Set(cycle1).size).toBe(N);
|
||||
expect(new Set(cycle2).size).toBe(N);
|
||||
expect(new Set(cycle1)).toEqual(new Set(cycle2));
|
||||
});
|
||||
|
||||
it("distributes plays evenly across songs over many cycles (no starvation)", () => {
|
||||
queue.setMode(PlayMode.RandomLoop);
|
||||
const N = 6;
|
||||
const CYCLES = 20;
|
||||
for (let i = 0; i < N; i++) queue.add(makeSong(`s${i}`));
|
||||
queue.play();
|
||||
|
||||
const counts = new Map<string, number>();
|
||||
counts.set(queue.current()!.id, 1);
|
||||
for (let i = 0; i < CYCLES * N - 1; i++) {
|
||||
const id = queue.next()!.id;
|
||||
counts.set(id, (counts.get(id) ?? 0) + 1);
|
||||
}
|
||||
|
||||
// Shuffle bag => each song plays exactly CYCLES times. True random
|
||||
// would skew heavily.
|
||||
for (let i = 0; i < N; i++) {
|
||||
expect(counts.get(`s${i}`)).toBe(CYCLES);
|
||||
}
|
||||
});
|
||||
|
||||
it("does not replay the same song across a cycle boundary", () => {
|
||||
queue.setMode(PlayMode.RandomLoop);
|
||||
const N = 5;
|
||||
for (let i = 0; i < N; i++) queue.add(makeSong(`s${i}`));
|
||||
queue.play();
|
||||
|
||||
// Walk to the last song of cycle 1, then cross into cycle 2.
|
||||
for (let i = 0; i < N - 1; i++) queue.next();
|
||||
const lastOfCycle1 = queue.current()!.id;
|
||||
const firstOfCycle2 = queue.next()!.id;
|
||||
expect(firstOfCycle2).not.toBe(lastOfCycle1);
|
||||
});
|
||||
|
||||
it("includes a song added mid-cycle within the current cycle", () => {
|
||||
queue.setMode(PlayMode.RandomLoop);
|
||||
queue.add(makeSong("A"));
|
||||
queue.add(makeSong("B"));
|
||||
queue.play(); // A
|
||||
queue.next(); // B — both originals now played this cycle
|
||||
queue.add(makeSong("C")); // added mid-cycle, still unplayed
|
||||
// C is the only unplayed song, so it must come next (not a reshuffle).
|
||||
expect(queue.next()?.id).toBe("C");
|
||||
});
|
||||
|
||||
it("keeps looping forever with multiple songs (never returns null)", () => {
|
||||
queue.setMode(PlayMode.RandomLoop);
|
||||
queue.add(makeSong("A"));
|
||||
queue.add(makeSong("B"));
|
||||
queue.add(makeSong("C"));
|
||||
queue.play();
|
||||
for (let i = 0; i < 30; i++) {
|
||||
expect(queue.next()).not.toBeNull();
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
+51
-18
@@ -10,10 +10,11 @@ export interface QueuedSong {
|
||||
name: string;
|
||||
artist: string;
|
||||
album: string;
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube" | "local" | "kugou" | "spotify" | "jellyfin";
|
||||
url?: string; // resolved lazily at play time
|
||||
coverUrl: string;
|
||||
duration: number; // seconds
|
||||
requestedBy?: string;
|
||||
}
|
||||
|
||||
export class PlayQueue {
|
||||
@@ -22,6 +23,7 @@ export class PlayQueue {
|
||||
private mode: PlayMode = PlayMode.Sequential;
|
||||
private playedIndices = new Set<number>();
|
||||
private history: number[] = [];
|
||||
private forwardStack: number[] = [];
|
||||
private static readonly HISTORY_LIMIT = 50;
|
||||
|
||||
private pushHistory(idx: number): void {
|
||||
@@ -100,12 +102,14 @@ export class PlayQueue {
|
||||
this.currentIndex = -1;
|
||||
this.playedIndices.clear();
|
||||
this.history = [];
|
||||
this.forwardStack = [];
|
||||
}
|
||||
|
||||
play(): QueuedSong | null {
|
||||
if (this.songs.length === 0) return null;
|
||||
this.playedIndices.clear();
|
||||
this.history = [];
|
||||
this.forwardStack = [];
|
||||
this.currentIndex = 0;
|
||||
this.playedIndices.add(0);
|
||||
return this.songs[0];
|
||||
@@ -118,6 +122,7 @@ export class PlayQueue {
|
||||
// shuffle from this point. History tracking is independent and
|
||||
// unaffected by this clear.
|
||||
this.playedIndices.clear();
|
||||
this.forwardStack = [];
|
||||
this.currentIndex = index;
|
||||
this.playedIndices.add(index);
|
||||
return this.songs[index];
|
||||
@@ -139,12 +144,48 @@ export class PlayQueue {
|
||||
this.currentIndex = (this.currentIndex + 1) % this.songs.length;
|
||||
return this.songs[this.currentIndex];
|
||||
}
|
||||
case PlayMode.Random: {
|
||||
case PlayMode.Random:
|
||||
case PlayMode.RandomLoop: {
|
||||
// 优先回到前进栈记录的位置(prev 退回的歌)
|
||||
if (this.forwardStack.length > 0) {
|
||||
const target = this.forwardStack.pop()!;
|
||||
if (target !== this.currentIndex) {
|
||||
this.pushHistory(this.currentIndex);
|
||||
this.currentIndex = target;
|
||||
this.playedIndices.add(target);
|
||||
return this.songs[target];
|
||||
}
|
||||
}
|
||||
|
||||
// Shuffle bag: pick uniformly from the songs not yet played this
|
||||
// cycle, so every song plays once before any repeats (NetEase/QQ
|
||||
// style). Songs added mid-cycle aren't in playedIndices, so they're
|
||||
// naturally eligible within the current cycle.
|
||||
const unplayed: number[] = [];
|
||||
for (let i = 0; i < this.songs.length; i++) {
|
||||
if (!this.playedIndices.has(i)) unplayed.push(i);
|
||||
}
|
||||
if (unplayed.length === 0) return null;
|
||||
|
||||
if (unplayed.length === 0) {
|
||||
// Cycle complete.
|
||||
if (this.mode === PlayMode.Random) return null; // 随机:播完即停
|
||||
// 随机循环:reshuffle and keep going forever.
|
||||
if (this.songs.length === 1) {
|
||||
this.pushHistory(this.currentIndex);
|
||||
this.currentIndex = 0;
|
||||
this.playedIndices = new Set([0]);
|
||||
return this.songs[0];
|
||||
}
|
||||
// Start a fresh cycle: every song is eligible again, but exclude
|
||||
// the song that just played from THIS pick only, so it doesn't
|
||||
// repeat back-to-back across the boundary. It stays eligible for
|
||||
// the rest of the new cycle, so every song still plays exactly once.
|
||||
this.playedIndices = new Set();
|
||||
for (let i = 0; i < this.songs.length; i++) {
|
||||
if (i !== this.currentIndex) unplayed.push(i);
|
||||
}
|
||||
}
|
||||
|
||||
const nextIndex =
|
||||
unplayed[Math.floor(Math.random() * unplayed.length)];
|
||||
this.pushHistory(this.currentIndex);
|
||||
@@ -152,33 +193,24 @@ export class PlayQueue {
|
||||
this.playedIndices.add(nextIndex);
|
||||
return this.songs[nextIndex];
|
||||
}
|
||||
case PlayMode.RandomLoop: {
|
||||
if (this.songs.length === 1) {
|
||||
this.pushHistory(this.currentIndex);
|
||||
this.currentIndex = 0;
|
||||
return this.songs[0];
|
||||
}
|
||||
let idx: number;
|
||||
do {
|
||||
idx = Math.floor(Math.random() * this.songs.length);
|
||||
} while (idx === this.currentIndex);
|
||||
this.pushHistory(this.currentIndex);
|
||||
this.currentIndex = idx;
|
||||
return this.songs[idx];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
prev(): QueuedSong | null {
|
||||
if (this.songs.length === 0) return null;
|
||||
|
||||
// 记录当前位置到前进栈,供 next 优先返回
|
||||
if (this.currentIndex >= 0 && this.forwardStack.length < PlayQueue.HISTORY_LIMIT) {
|
||||
this.forwardStack.push(this.currentIndex);
|
||||
}
|
||||
|
||||
// Preferred: pop from the back-stack so prev means "the song I
|
||||
// actually played before this one," not "the previous array slot."
|
||||
while (this.history.length > 0) {
|
||||
const idx = this.history.pop()!;
|
||||
if (idx >= 0 && idx < this.songs.length) {
|
||||
this.currentIndex = idx;
|
||||
this.playedIndices.add(idx);
|
||||
this.playedIndices = new Set([...this.history, this.currentIndex]);
|
||||
return this.songs[idx];
|
||||
}
|
||||
// Stale entry (song removed) — keep popping.
|
||||
@@ -227,6 +259,7 @@ export class PlayQueue {
|
||||
this.mode = mode;
|
||||
this.playedIndices.clear();
|
||||
this.history = [];
|
||||
this.forwardStack = [];
|
||||
if (this.currentIndex >= 0) {
|
||||
this.playedIndices.add(this.currentIndex);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import {
|
||||
decideOccupancyAction,
|
||||
occupancyFromClientList,
|
||||
shouldResumeOnReturn,
|
||||
} from "./auto-pause.js";
|
||||
|
||||
describe("decideOccupancyAction", () => {
|
||||
it("pauses when empty while playing and enabled", () => {
|
||||
expect(decideOccupancyAction("playing", false, true, 0)).toBe("pause");
|
||||
});
|
||||
it("does not pause when the feature is disabled", () => {
|
||||
expect(decideOccupancyAction("playing", false, false, 0)).toBe("none");
|
||||
});
|
||||
it("does not pause when idle (nothing playing)", () => {
|
||||
expect(decideOccupancyAction("idle", false, true, 0)).toBe("none");
|
||||
});
|
||||
it("does not pause when already paused", () => {
|
||||
expect(decideOccupancyAction("paused", false, true, 0)).toBe("none");
|
||||
});
|
||||
it("resumes when re-populated and we auto-paused", () => {
|
||||
expect(decideOccupancyAction("paused", true, true, 2)).toBe("resume");
|
||||
});
|
||||
it("does NOT resume a user-paused track on re-population", () => {
|
||||
expect(decideOccupancyAction("paused", false, true, 2)).toBe("none");
|
||||
});
|
||||
it("does nothing when re-populated and already playing", () => {
|
||||
expect(decideOccupancyAction("playing", false, true, 2)).toBe("none");
|
||||
});
|
||||
it("resume is independent of the enabled flag (we already auto-paused)", () => {
|
||||
expect(decideOccupancyAction("paused", true, false, 1)).toBe("resume");
|
||||
});
|
||||
});
|
||||
|
||||
describe("occupancyFromClientList", () => {
|
||||
it("returns null when the query failed (0 clients — bot itself is always present)", () => {
|
||||
// This is the bug fix: a clientlist timeout makes getClientsInChannel()
|
||||
// return [], which must be treated as "unknown", NOT as an empty channel.
|
||||
expect(occupancyFromClientList(0)).toBeNull();
|
||||
});
|
||||
it("returns 0 other users when only the bot is in the channel", () => {
|
||||
expect(occupancyFromClientList(1)).toBe(0);
|
||||
});
|
||||
it("excludes the bot itself from the count", () => {
|
||||
expect(occupancyFromClientList(2)).toBe(1);
|
||||
expect(occupancyFromClientList(5)).toBe(4);
|
||||
});
|
||||
it("never yields a negative count (guards the -1 that caused false pauses)", () => {
|
||||
expect(occupancyFromClientList(-3)).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("shouldResumeOnReturn (event-driven auto-resume)", () => {
|
||||
it("resumes when we auto-paused and are still paused", () => {
|
||||
// The reported gap: someone returns after an auto-pause. clientlist can't
|
||||
// confirm it (it times out while they're present), so we resume from the
|
||||
// clientEnter event alone.
|
||||
expect(shouldResumeOnReturn(true, "paused")).toBe(true);
|
||||
});
|
||||
it("does NOT resume a track the user paused by hand", () => {
|
||||
expect(shouldResumeOnReturn(false, "paused")).toBe(false);
|
||||
});
|
||||
it("does nothing if already playing (e.g. the bot's own enter at connect)", () => {
|
||||
// autoPaused is cleared to false on connect, so the bot's own clientEnter
|
||||
// is a no-op; this also covers the playing/auto-paused-flag-stale case.
|
||||
expect(shouldResumeOnReturn(false, "playing")).toBe(false);
|
||||
expect(shouldResumeOnReturn(true, "playing")).toBe(false);
|
||||
});
|
||||
it("does nothing when idle (nothing to resume)", () => {
|
||||
expect(shouldResumeOnReturn(true, "idle")).toBe(false);
|
||||
expect(shouldResumeOnReturn(false, "idle")).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,67 @@
|
||||
export type PlayerStateName = "idle" | "playing" | "paused";
|
||||
export type OccupancyAction = "pause" | "resume" | "none";
|
||||
|
||||
/**
|
||||
* Convert a channel client-list length into the number of *other* users, or
|
||||
* `null` when occupancy can't be determined.
|
||||
*
|
||||
* A connected bot is always a member of its own channel, so a valid query
|
||||
* returns at least 1 (the bot itself). A length of 0 therefore does NOT mean
|
||||
* "empty channel" — it means the underlying `clientlist` query failed (e.g. the
|
||||
* full-client `clientlist` command times out when other clients are present,
|
||||
* and `getClientsInChannel()` returns `[]` on error). Treating that failure as
|
||||
* "empty" is what caused playback to auto-pause within seconds whenever a
|
||||
* listener was actually in the channel. When the result is indeterminate we
|
||||
* return `null` so callers skip the auto-pause/idle decision entirely rather
|
||||
* than mis-reading an unknown state as empty.
|
||||
*/
|
||||
export function occupancyFromClientList(clientCount: number): number | null {
|
||||
if (clientCount <= 0) return null; // query failed → occupancy unknown
|
||||
return clientCount - 1; // exclude the bot itself
|
||||
}
|
||||
|
||||
/**
|
||||
* Decide what auto-pause should do given channel occupancy.
|
||||
* - empty (userCount <= 0): pause iff enabled and currently playing.
|
||||
* - re-populated (userCount > 0): resume iff we previously auto-paused and are still paused.
|
||||
* `autoPaused` distinguishes our auto-pause from a user pause, so user pauses are never resumed.
|
||||
*/
|
||||
export function decideOccupancyAction(
|
||||
playerState: PlayerStateName,
|
||||
autoPaused: boolean,
|
||||
enabled: boolean,
|
||||
userCount: number,
|
||||
): OccupancyAction {
|
||||
const empty = userCount <= 0;
|
||||
if (empty) {
|
||||
if (enabled && playerState === "playing") return "pause";
|
||||
return "none";
|
||||
}
|
||||
if (autoPaused && playerState === "paused") return "resume";
|
||||
return "none";
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a client-presence push event (a `clientEnter`) should trigger an
|
||||
* auto-resume, WITHOUT consulting a clientlist query.
|
||||
*
|
||||
* Why event-driven: the full-client `clientlist`/`channellist` commands time
|
||||
* out whenever ≥2 clients are connected to the server (a library limitation) —
|
||||
* which is exactly the moment a listener returns. So occupancy cannot be
|
||||
* re-queried to confirm the return; we must act on the push event itself.
|
||||
* This is sound because the bot only ever auto-pauses while it is alone on the
|
||||
* server (the sole state in which the occupancy query succeeds and pause
|
||||
* fires). Therefore, while `autoPaused` is true, the only way occupancy can
|
||||
* return is a fresh connection — delivered reliably as `clientEnter`.
|
||||
*
|
||||
* Gating on `autoPaused` (not merely "paused") guarantees we never revive a
|
||||
* track the user paused by hand, and makes the bot's own `clientEnter` at
|
||||
* connect a no-op (autoPaused is cleared to false on connect). This predicate
|
||||
* NEVER pauses — pause stays on the authoritative clientlist path.
|
||||
*/
|
||||
export function shouldResumeOnReturn(
|
||||
autoPaused: boolean,
|
||||
playerState: PlayerStateName,
|
||||
): boolean {
|
||||
return autoPaused && playerState === "paused";
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { parseCommand } from "./commands.js";
|
||||
import { parseCommand, canRunCommand, isAdminCommand } from "./commands.js";
|
||||
|
||||
describe("Command Parser", () => {
|
||||
it("parses simple command", () => {
|
||||
@@ -60,3 +60,36 @@ describe("Command Parser", () => {
|
||||
expect(result!.args).toBe("3");
|
||||
});
|
||||
});
|
||||
|
||||
describe("isAdminCommand classification", () => {
|
||||
it("treats stop/clear/remove/move/vol/mode as admin", () => {
|
||||
for (const c of ["stop", "clear", "remove", "move", "vol", "mode"]) {
|
||||
expect(isAdminCommand(c)).toBe(true);
|
||||
}
|
||||
});
|
||||
it("treats follow and play as NOT admin", () => {
|
||||
expect(isAdminCommand("follow")).toBe(false);
|
||||
expect(isAdminCommand("play")).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("canRunCommand", () => {
|
||||
it("allows any public command regardless of groups", () => {
|
||||
expect(canRunCommand("play", [], [6])).toBe(true);
|
||||
expect(canRunCommand("follow", [], [6])).toBe(true);
|
||||
});
|
||||
it("allows admin command when enforcement is off (empty adminGroups)", () => {
|
||||
expect(canRunCommand("stop", [], [])).toBe(true);
|
||||
});
|
||||
it("allows admin command when an invoker group matches (string vs number)", () => {
|
||||
expect(canRunCommand("stop", ["6"], [6])).toBe(true);
|
||||
expect(canRunCommand("stop", [6], [6])).toBe(true);
|
||||
expect(canRunCommand("vol", ["8", "6"], [6])).toBe(true);
|
||||
});
|
||||
it("denies admin command when no invoker group matches", () => {
|
||||
expect(canRunCommand("stop", ["8"], [6])).toBe(false);
|
||||
});
|
||||
it("denies admin command when invoker has no groups and enforcement is on", () => {
|
||||
expect(canRunCommand("clear", [], [6])).toBe(false);
|
||||
});
|
||||
});
|
||||
+27
-7
@@ -5,14 +5,13 @@ export interface ParsedCommand {
|
||||
flags: Set<string>;
|
||||
}
|
||||
|
||||
export const PUBLIC_COMMANDS = new Set([
|
||||
"play", "add", "queue", "list", "now", "lyrics", "vote", "help",
|
||||
"playlist", "album", "fm", "prev", "next", "skip", "pause", "resume",
|
||||
"artist",
|
||||
]);
|
||||
|
||||
/**
|
||||
* The fixed set of "admin" chat commands. This is the SINGLE source of truth
|
||||
* for which commands the permission gate restricts; reclassifying a command is
|
||||
* a one-line edit here. Everything not in this set is public.
|
||||
*/
|
||||
export const ADMIN_COMMANDS = new Set([
|
||||
"stop", "clear", "move", "vol", "mode", "follow", "remove",
|
||||
"stop", "clear", "remove", "move", "vol", "mode",
|
||||
]);
|
||||
|
||||
export function parseCommand(
|
||||
@@ -59,3 +58,24 @@ export function parseCommand(
|
||||
export function isAdminCommand(commandName: string): boolean {
|
||||
return ADMIN_COMMANDS.has(commandName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Decide whether a chat command may run, given the invoker's TS server groups
|
||||
* and the configured admin groups. Pure + synchronous so it is trivially unit
|
||||
* tested and reused by the async gate in BotInstance.
|
||||
*
|
||||
* Allowed iff: (1) it is a public command, OR (2) enforcement is off
|
||||
* (adminGroups empty), OR (3) some invoker group is in adminGroups.
|
||||
* invokerGroups (strings from TS) and adminGroups (numbers) are normalized to
|
||||
* strings before comparison so "6" matches 6.
|
||||
*/
|
||||
export function canRunCommand(
|
||||
commandName: string,
|
||||
invokerGroups: readonly (string | number)[],
|
||||
adminGroups: readonly number[],
|
||||
): boolean {
|
||||
if (!isAdminCommand(commandName)) return true;
|
||||
if (adminGroups.length === 0) return true;
|
||||
const admin = new Set(adminGroups.map((g) => String(g)));
|
||||
return invokerGroups.some((g) => admin.has(String(g)));
|
||||
}
|
||||
@@ -0,0 +1,974 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { BotInstance, COMMAND_DENIED_MESSAGE, spotifyPortsForBotId } from "./instance.js";
|
||||
import type { BotInstanceOptions } from "./instance.js";
|
||||
import type { TS3TextMessage } from "../ts-protocol/client.js";
|
||||
import type { SpotifyController } from "../music/spotify/controller.js";
|
||||
import type { SpotifyOAuth } from "../music/spotify/spotify-oauth.js";
|
||||
import type { MusicProvider } from "../music/provider.js";
|
||||
import type { BotDatabase } from "../data/database.js";
|
||||
import type { AvatarStore } from "../data/avatars.js";
|
||||
import type { BotConfig } from "../data/config.js";
|
||||
|
||||
// Constructing a real BotInstance is heavy (spawns a TS3Client, AudioPlayer,
|
||||
// reads avatars, etc.), and runExclusive only touches a single private field
|
||||
// (`playGate`). So we exercise the ACTUAL shipped method via its prototype,
|
||||
// bound to a minimal object carrying just that field. This proves the real
|
||||
// serializer logic without standing up a full bot.
|
||||
type Gate = { playGate: Promise<unknown> };
|
||||
const runExclusive = BotInstance.prototype.runExclusive as <T>(
|
||||
this: Gate,
|
||||
fn: () => Promise<T>,
|
||||
) => Promise<T>;
|
||||
|
||||
function makeGate(): Gate {
|
||||
return { playGate: Promise.resolve() };
|
||||
}
|
||||
|
||||
/** An explicit, timer-free deferred so ordering is deterministic. */
|
||||
function deferred<T = void>() {
|
||||
let resolve!: (value: T) => void;
|
||||
let reject!: (reason?: unknown) => void;
|
||||
const promise = new Promise<T>((res, rej) => {
|
||||
resolve = res;
|
||||
reject = rej;
|
||||
});
|
||||
return { promise, resolve, reject };
|
||||
}
|
||||
|
||||
describe("BotInstance.runExclusive — serialization", () => {
|
||||
it("does not start fnB until fnA settles", async () => {
|
||||
const gate = makeGate();
|
||||
const order: string[] = [];
|
||||
const gateA = deferred();
|
||||
|
||||
const pA = runExclusive.call(gate, async () => {
|
||||
order.push("A-start");
|
||||
await gateA.promise; // suspend A until we explicitly release it
|
||||
order.push("A-end");
|
||||
});
|
||||
|
||||
const pB = runExclusive.call(gate, async () => {
|
||||
order.push("B-start");
|
||||
order.push("B-end");
|
||||
});
|
||||
|
||||
// Give the microtask queue a chance: B must NOT have started while A is
|
||||
// still suspended on gateA.
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
expect(order).toEqual(["A-start"]);
|
||||
|
||||
gateA.resolve();
|
||||
await pA;
|
||||
await pB;
|
||||
|
||||
expect(order).toEqual(["A-start", "A-end", "B-start", "B-end"]);
|
||||
});
|
||||
|
||||
it("runs fnB even if fnA rejects (chain survives rejection)", async () => {
|
||||
const gate = makeGate();
|
||||
const order: string[] = [];
|
||||
const gateA = deferred();
|
||||
|
||||
const pA = runExclusive.call(gate, async () => {
|
||||
order.push("A-start");
|
||||
await gateA.promise;
|
||||
throw new Error("A blew up");
|
||||
});
|
||||
|
||||
const pB = runExclusive.call(gate, async () => {
|
||||
order.push("B-start");
|
||||
order.push("B-end");
|
||||
return "B-result";
|
||||
});
|
||||
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
expect(order).toEqual(["A-start"]);
|
||||
|
||||
gateA.reject(new Error("A blew up"));
|
||||
await expect(pA).rejects.toThrow("A blew up");
|
||||
|
||||
// B still runs, only after A has fully settled.
|
||||
await expect(pB).resolves.toBe("B-result");
|
||||
expect(order).toEqual(["A-start", "B-start", "B-end"]);
|
||||
});
|
||||
|
||||
it("preserves call order across three serialized tasks", async () => {
|
||||
const gate = makeGate();
|
||||
const order: string[] = [];
|
||||
const tasks = ["X", "Y", "Z"];
|
||||
const promises = tasks.map((t) =>
|
||||
runExclusive.call(gate, async () => {
|
||||
order.push(`${t}-start`);
|
||||
await Promise.resolve();
|
||||
order.push(`${t}-end`);
|
||||
}),
|
||||
);
|
||||
|
||||
await Promise.all(promises);
|
||||
|
||||
expect(order).toEqual([
|
||||
"X-start",
|
||||
"X-end",
|
||||
"Y-start",
|
||||
"Y-end",
|
||||
"Z-start",
|
||||
"Z-end",
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
/** Minimal `this` carrying only what handleTextMessage's gate path touches.
|
||||
* The gate methods live on the prototype and are attached here so calls like
|
||||
* `this.isCommandAllowed(...)` resolve against this same object. */
|
||||
function makeGateCtx(opts: {
|
||||
adminGroups?: number[];
|
||||
lookupGroups?: string[];
|
||||
lookupThrows?: boolean;
|
||||
}) {
|
||||
const ctx: any = {
|
||||
config: { commandPrefix: "!", commandAliases: {}, adminGroups: opts.adminGroups ?? [] },
|
||||
logger: { info: vi.fn(), error: vi.fn() },
|
||||
tsClient: {
|
||||
sendTextMessage: vi.fn(async () => {}),
|
||||
getClientServerGroups: vi.fn(async () => {
|
||||
if (opts.lookupThrows) throw new Error("query failed");
|
||||
return opts.lookupGroups ?? [];
|
||||
}),
|
||||
},
|
||||
executeCommand: vi.fn(async () => null),
|
||||
isCommandAllowed: (BotInstance.prototype as any).isCommandAllowed,
|
||||
lookupInvokerGroups: (BotInstance.prototype as any).lookupInvokerGroups,
|
||||
};
|
||||
return ctx;
|
||||
}
|
||||
|
||||
function makeMsg(message: string, invokerGroups: string[] = [], invokerId = "5"): TS3TextMessage {
|
||||
return { invokerName: "Tester", invokerId, invokerUid: "uid", message, targetMode: 2, invokerGroups };
|
||||
}
|
||||
|
||||
const handleTextMessage = (BotInstance.prototype as any).handleTextMessage as (
|
||||
this: unknown,
|
||||
msg: TS3TextMessage,
|
||||
) => Promise<void>;
|
||||
|
||||
describe("BotInstance.handleTextMessage — command permission gate", () => {
|
||||
it("runs a public command with no group lookup, even under enforcement", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!play 晴天", ["6"]));
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.tsClient.getClientServerGroups).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).not.toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("runs an admin command with no lookup when enforcement is off", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop"));
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.tsClient.getClientServerGroups).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("allows an enforced admin command when the live lookup returns a matching group", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupGroups: ["6"] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop"));
|
||||
expect(ctx.tsClient.getClientServerGroups).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("denies an enforced admin command when the live lookup has no matching group", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupGroups: ["8"] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop"));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("fails closed when the live lookup returns no groups", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupGroups: [] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop"));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("fails closed when the live lookup throws", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupThrows: true });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop"));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("ignores stale event groups: a demoted sender (cached match) is denied by the live lookup", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupGroups: ["8"] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", ["6"]));
|
||||
expect(ctx.executeCommand).not.toHaveBeenCalled();
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith(COMMAND_DENIED_MESSAGE);
|
||||
});
|
||||
|
||||
it("uses live groups, not stale event groups: a freshly-promoted sender is allowed", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupGroups: ["6"] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", ["8"]));
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("resolves out-of-channel senders server-wide: empty event groups but a matching live group → allowed", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [6], lookupGroups: ["6"] });
|
||||
await handleTextMessage.call(ctx, makeMsg("!stop", [], "5"));
|
||||
expect(ctx.tsClient.getClientServerGroups).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.executeCommand).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("BotInstance.getProviderFor — spotify routing", () => {
|
||||
it("getProviderFor routes 'spotify' to the injected spotify provider", () => {
|
||||
const spotify = { platform: "spotify" } as any;
|
||||
const ctx = { spotifyProvider: spotify, neteaseProvider: { platform: "netease" } } as any;
|
||||
expect(BotInstance.prototype.getProviderFor.call(ctx, "spotify" as any)).toBe(spotify);
|
||||
});
|
||||
});
|
||||
|
||||
// --- Spotify orchestration (Task 7 + Correction C4) ------------------------
|
||||
// These drive the REAL prototype methods on a hand-built ctx (the file's
|
||||
// established `.call(ctx)` style) and assert the routing DECISIONS. Live audio
|
||||
// is not testable here. C4 supersedes the brief where they conflict: switching
|
||||
// a URL track -> spotify does NOT call player.stop() (playPcmStream fences the
|
||||
// prior ffmpeg internally), and a spotify -> spotify handoff does NOT re-attach
|
||||
// the persistent PCM stream (playPcmStream is called ONCE across both tracks).
|
||||
|
||||
const resolveAndPlay = BotInstance.prototype.resolveAndPlay as (
|
||||
this: unknown,
|
||||
song: any,
|
||||
) => Promise<boolean>;
|
||||
const setupPlayerEvents = (BotInstance.prototype as any).setupPlayerEvents as (
|
||||
this: unknown,
|
||||
) => void;
|
||||
const cmdPause = (BotInstance.prototype as any).cmdPause as (this: unknown) => string;
|
||||
const cmdResume = (BotInstance.prototype as any).cmdResume as (this: unknown) => string;
|
||||
const cmdStop = (BotInstance.prototype as any).cmdStop as (this: unknown) => string;
|
||||
const handleOccupancy = (BotInstance.prototype as any).handleOccupancy as (
|
||||
this: unknown,
|
||||
userCount: number,
|
||||
) => void;
|
||||
const seek = (BotInstance.prototype as any).seek as (this: unknown, seconds: number) => void;
|
||||
const playNext = (BotInstance.prototype as any).playNext as (
|
||||
this: unknown,
|
||||
maxRetries?: number,
|
||||
) => Promise<boolean>;
|
||||
const cmdRemove = (BotInstance.prototype as any).cmdRemove as (
|
||||
this: unknown,
|
||||
cmd: any,
|
||||
) => Promise<string> | string;
|
||||
|
||||
function makeController() {
|
||||
return {
|
||||
ensureStarted: vi.fn(async () => true),
|
||||
playTrack: vi.fn(async () => true),
|
||||
getPcmStream: vi.fn(() => ({ kind: "pcm" } as any)),
|
||||
pause: vi.fn(async () => {}),
|
||||
resume: vi.fn(async () => {}),
|
||||
seek: vi.fn(async () => {}),
|
||||
stop: vi.fn(() => {}),
|
||||
on: vi.fn(),
|
||||
};
|
||||
}
|
||||
function makePlayer() {
|
||||
// `externalActive` mirrors the real AudioPlayer: playPcmStream attaches the
|
||||
// external stream (true), and both stop() and play() detach it (false). The
|
||||
// re-attach guard reads isExternalActive(), so this must track that state.
|
||||
// `state` mirrors the real player's PlayerState transitions so tests can
|
||||
// observe paused→playing (R3-3): playPcmStream/play → "playing", stop →
|
||||
// "idle", pause → "paused" (only from playing), resume → "playing" (only
|
||||
// from paused). Existing tests never read state, so tracking it is inert
|
||||
// for them.
|
||||
let externalActive = false;
|
||||
let state: "idle" | "playing" | "paused" = "idle";
|
||||
return {
|
||||
play: vi.fn((..._args: any[]) => { externalActive = false; state = "playing"; }),
|
||||
stop: vi.fn(() => { externalActive = false; state = "idle"; }),
|
||||
playPcmStream: vi.fn((..._args: any[]) => { externalActive = true; state = "playing"; }),
|
||||
pause: vi.fn(() => { if (state === "playing") state = "paused"; }),
|
||||
resume: vi.fn(() => { if (state === "paused") state = "playing"; }),
|
||||
seek: vi.fn(),
|
||||
isExternalActive: vi.fn(() => externalActive),
|
||||
getState: vi.fn(() => state),
|
||||
};
|
||||
}
|
||||
function makeResolveCtx(opts: {
|
||||
controller: ReturnType<typeof makeController>;
|
||||
player: ReturnType<typeof makePlayer>;
|
||||
url: string;
|
||||
currentSourceIsSpotify?: boolean;
|
||||
}) {
|
||||
return {
|
||||
connected: true,
|
||||
config: {},
|
||||
id: "bot1",
|
||||
voteSkipUsers: new Set<string>(),
|
||||
autoPaused: false,
|
||||
currentSourceIsSpotify: opts.currentSourceIsSpotify ?? false,
|
||||
effectiveDuration: undefined,
|
||||
logger: { info: vi.fn(), warn: vi.fn(), error: vi.fn(), debug: vi.fn() },
|
||||
tsClient: { sendTextMessage: vi.fn(async () => {}) },
|
||||
database: { addPlayHistory: vi.fn() },
|
||||
spotifyController: opts.controller,
|
||||
player: opts.player,
|
||||
getProviderFor: vi.fn(() => ({ getSongUrl: async () => ({ url: opts.url }) })),
|
||||
syncProfileToSong: vi.fn(async () => {}),
|
||||
emit: vi.fn(),
|
||||
} as any;
|
||||
}
|
||||
function spotifySong() {
|
||||
return {
|
||||
id: "abc",
|
||||
name: "Song",
|
||||
artist: "Artist",
|
||||
album: "Album",
|
||||
platform: "spotify",
|
||||
coverUrl: "c",
|
||||
duration: 200,
|
||||
url: "",
|
||||
};
|
||||
}
|
||||
|
||||
describe("BotInstance.resolveAndPlay — Spotify routing (C4)", () => {
|
||||
it("routes a spotify song to controller.playTrack + player.playPcmStream, not player.play", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({ controller, player, url: "spotify:track:abc" });
|
||||
|
||||
const ok = await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
expect(ok).toBe(true);
|
||||
expect(controller.ensureStarted).toHaveBeenCalledTimes(1);
|
||||
expect(controller.playTrack).toHaveBeenCalledWith("spotify:track:abc");
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1);
|
||||
expect(player.playPcmStream.mock.calls[0][0]).toEqual({ kind: "pcm" });
|
||||
expect(player.play).not.toHaveBeenCalled();
|
||||
// C4: playPcmStream fences the prior url-ffmpeg internally — no player.stop().
|
||||
expect(player.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.currentSourceIsSpotify).toBe(true);
|
||||
expect(ctx.database.addPlayHistory).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.emit).toHaveBeenCalledWith("stateChange");
|
||||
});
|
||||
|
||||
it("returns false + sends the Stage-1 fallback when the backend is unavailable", async () => {
|
||||
const controller = makeController();
|
||||
controller.ensureStarted = vi.fn(async () => false);
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({ controller, player, url: "spotify:track:abc" });
|
||||
|
||||
const ok = await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
expect(ok).toBe(false);
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledTimes(1);
|
||||
expect(controller.playTrack).not.toHaveBeenCalled();
|
||||
expect(player.playPcmStream).not.toHaveBeenCalled();
|
||||
expect(player.play).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("attaches the PCM stream once (no player.stop) when switching URL -> spotify", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({
|
||||
controller, player, url: "spotify:track:abc", currentSourceIsSpotify: false,
|
||||
});
|
||||
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
// C4: NO player.stop() on the URL -> spotify transition.
|
||||
expect(player.stop).not.toHaveBeenCalled();
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does NOT re-attach the stream on a spotify -> spotify handoff (playPcmStream called once across two tracks)", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({
|
||||
controller, player, url: "spotify:track:abc", currentSourceIsSpotify: false,
|
||||
});
|
||||
|
||||
// First spotify track: coming from a URL/idle source -> attach.
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
expect(ctx.currentSourceIsSpotify).toBe(true);
|
||||
// Second spotify track: go-librespot changes tracks into the SAME FIFO.
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1); // NOT re-attached
|
||||
expect(controller.playTrack).toHaveBeenCalledTimes(2); // both tracks played
|
||||
expect(player.stop).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("RE-attaches on a spotify -> (command player.stop) -> spotify sequence (does not stay silent)", async () => {
|
||||
// Regression: command paths (cmdPlay/cmdPlaylist/cmdAlbum/cmdFm) call
|
||||
// player.stop() — which DETACHES the external stream — WITHOUT clearing the
|
||||
// currentSourceIsSpotify flag. Gating re-attach on the stale flag skipped
|
||||
// playPcmStream, silencing the next spotify track. We now gate on the
|
||||
// player's actual external state, so the re-attach happens.
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({
|
||||
controller, player, url: "spotify:track:abc", currentSourceIsSpotify: false,
|
||||
});
|
||||
|
||||
// First spotify track attaches the persistent PCM stream.
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1);
|
||||
expect(player.isExternalActive()).toBe(true);
|
||||
|
||||
// A command path stops the player (detaches the stream) but leaves the
|
||||
// spotify flag stale-true — exactly the state that used to cause silence.
|
||||
player.stop();
|
||||
expect(player.isExternalActive()).toBe(false);
|
||||
expect(ctx.currentSourceIsSpotify).toBe(true); // flag NOT cleared by stop()
|
||||
|
||||
// Next spotify track MUST re-attach (gate on player external state, not flag).
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(2);
|
||||
expect(player.isExternalActive()).toBe(true);
|
||||
});
|
||||
|
||||
it("returns false + sends the fallback when playTrack resolves false (dead/failed sidecar)", async () => {
|
||||
const controller = makeController();
|
||||
controller.playTrack = vi.fn(async () => false);
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({ controller, player, url: "spotify:track:abc" });
|
||||
|
||||
const ok = await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
expect(ok).toBe(false);
|
||||
expect(controller.playTrack).toHaveBeenCalledTimes(1);
|
||||
// Same Stage-1 fallback message as the backend-unavailable path.
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledTimes(1);
|
||||
// Never attach the player to a dead stream.
|
||||
expect(player.playPcmStream).not.toHaveBeenCalled();
|
||||
expect(ctx.currentSourceIsSpotify).toBe(false);
|
||||
});
|
||||
|
||||
it("recovers on mid-session sidecar death: onExternalEnd stops controller+player and clears the flag", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({ controller, player, url: "spotify:track:abc" });
|
||||
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
expect(ctx.currentSourceIsSpotify).toBe(true);
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1);
|
||||
|
||||
// The sidecar PCM stream EOFs mid-session → fire the wired onExternalEnd.
|
||||
const opts = player.playPcmStream.mock.calls[0][1] as { onExternalEnd?: () => void };
|
||||
expect(typeof opts.onExternalEnd).toBe("function");
|
||||
opts.onExternalEnd!();
|
||||
|
||||
// Recovery: controller torn down (next track rebuilds), player stopped
|
||||
// (drops external mode so the next track re-attaches), flag cleared.
|
||||
expect(controller.stop).toHaveBeenCalledTimes(1);
|
||||
expect(player.stop).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.currentSourceIsSpotify).toBe(false);
|
||||
});
|
||||
|
||||
it("pauses the sidecar and clears the flag when switching to a non-spotify track", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const song = { ...spotifySong(), platform: "netease" };
|
||||
const ctx = makeResolveCtx({
|
||||
controller, player, url: "http://cdn/x.mp3", currentSourceIsSpotify: true,
|
||||
});
|
||||
|
||||
const ok = await resolveAndPlay.call(ctx, song);
|
||||
|
||||
expect(ok).toBe(true);
|
||||
expect(controller.pause).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.currentSourceIsSpotify).toBe(false);
|
||||
expect(player.play).toHaveBeenCalledWith("http://cdn/x.mp3", 0, 200);
|
||||
expect(player.playPcmStream).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
// R3-3: spotify A playing → pause → skip to spotify B. The persistent PCM
|
||||
// stream stays attached through the pause, so the re-attach gate skips
|
||||
// playPcmStream (which is what sets state='playing'). Without an explicit
|
||||
// resume the player would sit 'paused' and emit silence while the sidecar
|
||||
// decodes B. The reuse path must force the player back to PLAYING.
|
||||
it("resumes the player when skipping from a PAUSED spotify track to another spotify track (R3-3)", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({
|
||||
controller, player, url: "spotify:track:abc", currentSourceIsSpotify: false,
|
||||
});
|
||||
|
||||
// Spotify A starts → PCM stream attached, player playing.
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
expect(player.getState()).toBe("playing");
|
||||
expect(player.isExternalActive()).toBe(true);
|
||||
|
||||
// User pauses: player paused; the external stream stays attached.
|
||||
player.pause();
|
||||
expect(player.getState()).toBe("paused");
|
||||
expect(player.isExternalActive()).toBe(true);
|
||||
|
||||
// Skip to spotify B via the external-stream-reuse path (playPcmStream skipped).
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
// Player must be PLAYING again (frames would emit), not stuck paused.
|
||||
expect(player.getState()).toBe("playing");
|
||||
// Reuse path — the persistent stream was NOT re-attached.
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1);
|
||||
expect(player.resume).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
// The normal (non-paused) spotify→spotify handoff must be unaffected: resume
|
||||
// on an already-playing player is a no-op, so state stays 'playing'.
|
||||
it("keeps a non-paused spotify→spotify handoff playing (R3-3 no-regression)", async () => {
|
||||
const controller = makeController();
|
||||
const player = makePlayer();
|
||||
const ctx = makeResolveCtx({
|
||||
controller, player, url: "spotify:track:abc", currentSourceIsSpotify: false,
|
||||
});
|
||||
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
await resolveAndPlay.call(ctx, spotifySong());
|
||||
|
||||
expect(player.getState()).toBe("playing");
|
||||
expect(player.playPcmStream).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("BotInstance.setupPlayerEvents — controller trackEnded wiring", () => {
|
||||
function makeEventCtx(currentPlatform: string) {
|
||||
return {
|
||||
spotifyController: { on: vi.fn() },
|
||||
player: { on: vi.fn() },
|
||||
queue: { current: vi.fn(() => ({ platform: currentPlatform })) },
|
||||
logger: { debug: vi.fn(), error: vi.fn() },
|
||||
playNext: vi.fn(async () => true),
|
||||
} as any;
|
||||
}
|
||||
function trackEndedHandler(ctx: any) {
|
||||
const call = ctx.spotifyController.on.mock.calls.find(
|
||||
(c: any[]) => c[0] === "trackEnded",
|
||||
);
|
||||
expect(call).toBeDefined();
|
||||
return call[1] as (e: any) => void;
|
||||
}
|
||||
|
||||
it("advances via playNext when the current song is spotify", () => {
|
||||
const ctx = makeEventCtx("spotify");
|
||||
setupPlayerEvents.call(ctx);
|
||||
trackEndedHandler(ctx)({ uri: "spotify:track:x", reason: "ended" });
|
||||
expect(ctx.playNext).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("ignores controller trackEnded when the current song is not spotify", () => {
|
||||
const ctx = makeEventCtx("netease");
|
||||
setupPlayerEvents.call(ctx);
|
||||
trackEndedHandler(ctx)({ uri: "spotify:track:x", reason: "ended" });
|
||||
expect(ctx.playNext).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("BotInstance transport delegation — spotify current song", () => {
|
||||
function makeCmdCtx(currentPlatform: string) {
|
||||
return {
|
||||
player: { pause: vi.fn(), resume: vi.fn(), stop: vi.fn() },
|
||||
spotifyController: {
|
||||
pause: vi.fn(async () => {}),
|
||||
resume: vi.fn(async () => {}),
|
||||
stop: vi.fn(() => {}),
|
||||
},
|
||||
queue: { current: vi.fn(() => ({ platform: currentPlatform })), clear: vi.fn() },
|
||||
logger: { warn: vi.fn() },
|
||||
emit: vi.fn(),
|
||||
autoPaused: true,
|
||||
currentSourceIsSpotify: true,
|
||||
sweepLocalAudio: vi.fn(),
|
||||
disableFmMode: vi.fn(),
|
||||
profileManager: { onSongChange: vi.fn(async () => {}) },
|
||||
} as any;
|
||||
}
|
||||
|
||||
it("cmdPause delegates to controller.pause when current is spotify", () => {
|
||||
const ctx = makeCmdCtx("spotify");
|
||||
cmdPause.call(ctx);
|
||||
expect(ctx.player.pause).toHaveBeenCalled();
|
||||
expect(ctx.spotifyController.pause).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("cmdResume delegates to controller.resume when current is spotify", () => {
|
||||
const ctx = makeCmdCtx("spotify");
|
||||
cmdResume.call(ctx);
|
||||
expect(ctx.player.resume).toHaveBeenCalled();
|
||||
expect(ctx.spotifyController.resume).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("cmdStop stops the sidecar + player and clears the spotify flag", () => {
|
||||
const ctx = makeCmdCtx("spotify");
|
||||
cmdStop.call(ctx);
|
||||
expect(ctx.spotifyController.stop).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.player.stop).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.queue.clear).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.currentSourceIsSpotify).toBe(false);
|
||||
});
|
||||
|
||||
it("does NOT touch the controller when current is not spotify", () => {
|
||||
const ctx = makeCmdCtx("netease");
|
||||
cmdPause.call(ctx);
|
||||
cmdResume.call(ctx);
|
||||
expect(ctx.spotifyController.pause).not.toHaveBeenCalled();
|
||||
expect(ctx.spotifyController.resume).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
// --- R3-2: removing the currently-playing Spotify track ---------------------
|
||||
// queue.remove() of the current index only decrements currentIndex; it never
|
||||
// stops the player or sidecar. A spotify track has NO player self-EOF advance
|
||||
// path, so leaving the sidecar running while queue.current() is no longer that
|
||||
// track wedges the bot in silence. cmdRemove must reconcile: stop the sidecar
|
||||
// and advance (or stop cleanly) — but ONLY for a current spotify track.
|
||||
describe("BotInstance.cmdRemove — spotify current-track reconciliation (R3-2)", () => {
|
||||
function makeRemoveCtx(opts: {
|
||||
currentIndex: number;
|
||||
currentSourceIsSpotify: boolean;
|
||||
removed: any;
|
||||
}) {
|
||||
return {
|
||||
currentSourceIsSpotify: opts.currentSourceIsSpotify,
|
||||
queue: {
|
||||
getCurrentIndex: vi.fn(() => opts.currentIndex),
|
||||
remove: vi.fn(() => opts.removed),
|
||||
},
|
||||
spotifyController: makeController(),
|
||||
player: makePlayer(),
|
||||
playNext: vi.fn(async () => true),
|
||||
sweepLocalAudio: vi.fn(),
|
||||
emit: vi.fn(),
|
||||
logger: { warn: vi.fn(), info: vi.fn(), error: vi.fn(), debug: vi.fn() },
|
||||
} as any;
|
||||
}
|
||||
|
||||
it("stops the sidecar and advances when removing the CURRENT spotify track", async () => {
|
||||
const ctx = makeRemoveCtx({
|
||||
currentIndex: 0,
|
||||
currentSourceIsSpotify: true,
|
||||
removed: { name: "A", platform: "spotify" },
|
||||
});
|
||||
|
||||
const reply = await cmdRemove.call(ctx, { args: "1" }); // index 0 == current
|
||||
|
||||
expect(reply).toContain("Removed: A");
|
||||
expect(ctx.spotifyController.stop).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.currentSourceIsSpotify).toBe(false);
|
||||
expect(ctx.player.stop).toHaveBeenCalledTimes(1);
|
||||
// Advance to whatever is now current (or stop cleanly if empty).
|
||||
expect(ctx.playNext).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does NOT stop the sidecar when removing a NON-current track", async () => {
|
||||
const ctx = makeRemoveCtx({
|
||||
currentIndex: 0,
|
||||
currentSourceIsSpotify: true,
|
||||
removed: { name: "B", platform: "spotify" },
|
||||
});
|
||||
|
||||
await cmdRemove.call(ctx, { args: "2" }); // index 1 != current (0)
|
||||
|
||||
expect(ctx.spotifyController.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.player.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.playNext).not.toHaveBeenCalled();
|
||||
expect(ctx.currentSourceIsSpotify).toBe(true);
|
||||
});
|
||||
|
||||
it("does NOT stop the sidecar when the current track is NOT spotify (URL self-heals)", async () => {
|
||||
const ctx = makeRemoveCtx({
|
||||
currentIndex: 0,
|
||||
currentSourceIsSpotify: false, // current is a URL track
|
||||
removed: { name: "A", platform: "netease" },
|
||||
});
|
||||
|
||||
await cmdRemove.call(ctx, { args: "1" }); // index 0 == current
|
||||
|
||||
expect(ctx.spotifyController.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.player.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.playNext).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("returns 'Invalid position' without touching the sidecar on a bad index", async () => {
|
||||
const ctx = makeRemoveCtx({
|
||||
currentIndex: 0,
|
||||
currentSourceIsSpotify: true,
|
||||
removed: null, // queue.remove() rejects the index
|
||||
});
|
||||
|
||||
const reply = await cmdRemove.call(ctx, { args: "9" });
|
||||
|
||||
expect(reply).toBe("Invalid position");
|
||||
expect(ctx.spotifyController.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.playNext).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
// --- R3-6: queue exhausts on a spotify track --------------------------------
|
||||
// playNext's exhausted (non-FM) branch only called player.stop(); it left the
|
||||
// sidecar decoding and currentSourceIsSpotify stale — diverging from cmdStop.
|
||||
describe("BotInstance.playNext — spotify teardown on queue exhaust (R3-6)", () => {
|
||||
function makeExhaustCtx(opts: { currentSourceIsSpotify: boolean }) {
|
||||
return {
|
||||
connected: true,
|
||||
isAdvancing: false,
|
||||
isFmMode: false,
|
||||
currentSourceIsSpotify: opts.currentSourceIsSpotify,
|
||||
voteSkipUsers: new Set<string>(),
|
||||
queue: { next: vi.fn(() => null), unplayedCount: vi.fn(() => 0) },
|
||||
player: makePlayer(),
|
||||
spotifyController: makeController(),
|
||||
profileManager: { onSongChange: vi.fn(async () => {}) },
|
||||
resolveAndPlay: vi.fn(async () => true),
|
||||
sweepLocalAudio: vi.fn(),
|
||||
emit: vi.fn(),
|
||||
logger: { warn: vi.fn(), info: vi.fn(), error: vi.fn(), debug: vi.fn() },
|
||||
} as any;
|
||||
}
|
||||
|
||||
it("stops the sidecar and clears the flag when a spotify queue exhausts", async () => {
|
||||
const ctx = makeExhaustCtx({ currentSourceIsSpotify: true });
|
||||
|
||||
const started = await playNext.call(ctx);
|
||||
|
||||
expect(started).toBe(false);
|
||||
expect(ctx.spotifyController.stop).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.currentSourceIsSpotify).toBe(false);
|
||||
expect(ctx.player.stop).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does NOT stop the sidecar when a NON-spotify queue exhausts", async () => {
|
||||
const ctx = makeExhaustCtx({ currentSourceIsSpotify: false });
|
||||
|
||||
const started = await playNext.call(ctx);
|
||||
|
||||
expect(started).toBe(false);
|
||||
expect(ctx.spotifyController.stop).not.toHaveBeenCalled();
|
||||
expect(ctx.player.stop).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("BotInstance.handleOccupancy — spotify auto-pause delegation (C4)", () => {
|
||||
function makeOccupancyCtx(currentPlatform: string, state: string) {
|
||||
return {
|
||||
player: { getState: () => state, pause: vi.fn(), resume: vi.fn() },
|
||||
spotifyController: { pause: vi.fn(async () => {}), resume: vi.fn(async () => {}) },
|
||||
queue: { current: vi.fn(() => ({ platform: currentPlatform })) },
|
||||
config: { autoPauseOnEmpty: true },
|
||||
autoPaused: false,
|
||||
logger: { warn: vi.fn() },
|
||||
emit: vi.fn(),
|
||||
_scheduleIdleCheck: vi.fn(),
|
||||
_cancelIdleTimer: vi.fn(),
|
||||
} as any;
|
||||
}
|
||||
|
||||
it("delegates pause to the controller when auto-pausing a spotify track (empty channel)", () => {
|
||||
const ctx = makeOccupancyCtx("spotify", "playing");
|
||||
handleOccupancy.call(ctx, 0);
|
||||
expect(ctx.player.pause).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.spotifyController.pause).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.autoPaused).toBe(true);
|
||||
});
|
||||
|
||||
it("delegates resume to the controller when a listener returns to a spotify track", () => {
|
||||
const ctx = makeOccupancyCtx("spotify", "paused");
|
||||
ctx.autoPaused = true;
|
||||
handleOccupancy.call(ctx, 1);
|
||||
expect(ctx.player.resume).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.spotifyController.resume).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.autoPaused).toBe(false);
|
||||
});
|
||||
|
||||
it("does NOT touch the controller when auto-pausing a non-spotify track", () => {
|
||||
const ctx = makeOccupancyCtx("netease", "playing");
|
||||
handleOccupancy.call(ctx, 0);
|
||||
expect(ctx.player.pause).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.spotifyController.pause).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("BotInstance.seek — spotify routing (C4)", () => {
|
||||
function makeSeekCtx(currentPlatform: string) {
|
||||
return {
|
||||
queue: { current: vi.fn(() => ({ platform: currentPlatform })) },
|
||||
spotifyController: { seek: vi.fn(async () => {}) },
|
||||
player: { seek: vi.fn() },
|
||||
logger: { warn: vi.fn() },
|
||||
} as any;
|
||||
}
|
||||
|
||||
it("routes seek to the controller for a spotify track, converting seconds -> ms", () => {
|
||||
const ctx = makeSeekCtx("spotify");
|
||||
seek.call(ctx, 30); // 30 seconds
|
||||
// SpotifyController.seek is millisecond-based: 30s -> 30000ms (not 30).
|
||||
expect(ctx.spotifyController.seek).toHaveBeenCalledWith(30000);
|
||||
expect(ctx.player.seek).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("routes seek to the player (seconds-based) for a non-spotify track", () => {
|
||||
const ctx = makeSeekCtx("netease");
|
||||
seek.call(ctx, 30);
|
||||
expect(ctx.player.seek).toHaveBeenCalledWith(30);
|
||||
expect(ctx.spotifyController.seek).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
// --- Spotify OAuth threading (Task 6, C3.1) --------------------------------
|
||||
// The process-wide shared SpotifyOAuth must reach the SpotifyController via the
|
||||
// controller factory. We drive the REAL BotInstance constructor with a fake
|
||||
// controller factory that captures its param object, so the thread is observed
|
||||
// end-to-end (options.spotifyOAuth -> buildController({ oauth })).
|
||||
describe("BotInstance — spotifyOAuth threading to the controller factory (C3.1)", () => {
|
||||
function makeInstanceOptions(over: Partial<BotInstanceOptions> = {}): {
|
||||
options: BotInstanceOptions;
|
||||
captured: { param?: { oauth?: SpotifyOAuth; instanceId?: string } };
|
||||
} {
|
||||
const captured: { param?: { oauth?: SpotifyOAuth; instanceId?: string } } = {};
|
||||
const provider = { platform: "netease" } as unknown as MusicProvider;
|
||||
const logger: any = {
|
||||
info() {}, warn() {}, error() {}, debug() {},
|
||||
child() { return logger; },
|
||||
};
|
||||
const database = {
|
||||
getProfileConfig: () => ({}),
|
||||
getCustomAvatarPath: () => null,
|
||||
} as unknown as BotDatabase;
|
||||
const options: BotInstanceOptions = {
|
||||
id: "bot-oauth-test",
|
||||
name: "OAuthBot",
|
||||
tsOptions: { host: "localhost", port: 9987, queryPort: 10011, nickname: "OAuthBot" } as any,
|
||||
neteaseProvider: provider,
|
||||
qqProvider: provider,
|
||||
bilibiliProvider: provider,
|
||||
youtubeProvider: provider,
|
||||
database,
|
||||
config: { spotify: {} } as unknown as BotConfig,
|
||||
logger,
|
||||
avatarStore: { read: () => null } as unknown as AvatarStore,
|
||||
spotifyControllerFactory: (o) => {
|
||||
captured.param = o;
|
||||
// Only `on` is touched during construction (setupPlayerEvents wires
|
||||
// the "trackEnded" listener); return a minimal fake controller.
|
||||
return { on: () => {} } as unknown as SpotifyController;
|
||||
},
|
||||
...over,
|
||||
};
|
||||
return { options, captured };
|
||||
}
|
||||
|
||||
it("forwards the injected spotifyOAuth to the controller factory as `oauth`", () => {
|
||||
const sentinel = {} as unknown as SpotifyOAuth;
|
||||
const { options, captured } = makeInstanceOptions({ spotifyOAuth: sentinel });
|
||||
// eslint-disable-next-line no-new
|
||||
new BotInstance(options);
|
||||
expect(captured.param).toBeDefined();
|
||||
expect(captured.param?.oauth).toBe(sentinel);
|
||||
});
|
||||
|
||||
it("leaves the factory `oauth` undefined when no spotifyOAuth is supplied (behavior-unchanged)", () => {
|
||||
const { options, captured } = makeInstanceOptions();
|
||||
// eslint-disable-next-line no-new
|
||||
new BotInstance(options);
|
||||
expect(captured.param).toBeDefined();
|
||||
expect(captured.param?.oauth).toBeUndefined();
|
||||
});
|
||||
|
||||
// R2-5: the bot id must reach the controller as `instanceId` so the backend
|
||||
// derives a UNIQUE Spotify Connect device name (<base>-<id>). Without it two
|
||||
// bots share the process-global deviceName and Connect commands misroute.
|
||||
it("forwards the bot id to the controller factory as `instanceId` (corner-case R2-5)", () => {
|
||||
const { options, captured } = makeInstanceOptions({ id: "bot-xyz" });
|
||||
// eslint-disable-next-line no-new
|
||||
new BotInstance(options);
|
||||
expect(captured.param).toBeDefined();
|
||||
expect(captured.param?.instanceId).toBe("bot-xyz");
|
||||
});
|
||||
});
|
||||
|
||||
describe("spotifyPortsForBotId — per-bot go-librespot ports (Fix 3)", () => {
|
||||
it("yields the SAME ports for the same bot id (stable across restarts)", () => {
|
||||
const a = spotifyPortsForBotId("bot-alpha");
|
||||
const b = spotifyPortsForBotId("bot-alpha");
|
||||
expect(a).toEqual(b);
|
||||
});
|
||||
|
||||
it("yields DIFFERENT ports for different bot ids", () => {
|
||||
const a = spotifyPortsForBotId("bot-alpha");
|
||||
const b = spotifyPortsForBotId("bot-beta");
|
||||
expect(a.apiPort).not.toBe(b.apiPort);
|
||||
expect(a.callbackPort).not.toBe(b.callbackPort);
|
||||
});
|
||||
|
||||
it("keeps apiPort and callbackPort in disjoint ranges", () => {
|
||||
for (const id of ["bot-alpha", "bot-beta", "x", "a-very-long-bot-identifier-123"]) {
|
||||
const { apiPort, callbackPort } = spotifyPortsForBotId(id);
|
||||
expect(apiPort).toBeGreaterThanOrEqual(3700);
|
||||
expect(apiPort).toBeLessThan(4700);
|
||||
expect(callbackPort).toBeGreaterThanOrEqual(8700);
|
||||
expect(callbackPort).toBeLessThan(9700);
|
||||
// Same offset within each range → the two never collide with each other.
|
||||
expect(callbackPort - apiPort).toBe(5000);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe("BotInstance.handleTextMessage — response chunking (#116)", () => {
|
||||
it("splits a long command response into multiple sends, each under the byte cap", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [] });
|
||||
const longResponse = Array.from(
|
||||
{ length: 200 },
|
||||
(_, i) => `歌词 line number ${i} with some content`,
|
||||
).join("\n");
|
||||
ctx.executeCommand = vi.fn(async () => longResponse);
|
||||
|
||||
await handleTextMessage.call(ctx, makeMsg("!lyrics"));
|
||||
|
||||
const calls = ctx.tsClient.sendTextMessage.mock.calls;
|
||||
expect(calls.length).toBeGreaterThan(1);
|
||||
for (const [chunk] of calls) {
|
||||
expect(Buffer.byteLength(chunk as string, "utf8")).toBeLessThanOrEqual(900);
|
||||
}
|
||||
});
|
||||
|
||||
it("sends a short command response as a single message", async () => {
|
||||
const ctx = makeGateCtx({ adminGroups: [] });
|
||||
ctx.executeCommand = vi.fn(async () => "short reply");
|
||||
|
||||
await handleTextMessage.call(ctx, makeMsg("!lyrics"));
|
||||
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledTimes(1);
|
||||
expect(ctx.tsClient.sendTextMessage).toHaveBeenCalledWith("short reply");
|
||||
});
|
||||
});
|
||||
|
||||
const cmdLyrics = (BotInstance.prototype as any).cmdLyrics as (
|
||||
this: unknown,
|
||||
) => Promise<string>;
|
||||
|
||||
describe("BotInstance.cmdLyrics — full lyrics (#116)", () => {
|
||||
it("returns ALL lyric lines, not just the first 10", async () => {
|
||||
const lyricLines = Array.from({ length: 30 }, (_, i) => ({
|
||||
time: i,
|
||||
text: `lyric line ${i}`,
|
||||
}));
|
||||
const ctx: any = {
|
||||
queue: { current: () => ({ id: "s1", name: "Song", platform: "netease" }) },
|
||||
getProviderFor: () => ({ getLyrics: vi.fn(async () => lyricLines) }),
|
||||
};
|
||||
|
||||
const out = await cmdLyrics.call(ctx);
|
||||
|
||||
for (const l of lyricLines) {
|
||||
expect(out).toContain(l.text);
|
||||
}
|
||||
expect(out.startsWith("Lyrics for Song:")).toBe(true);
|
||||
});
|
||||
|
||||
it("returns 'No lyrics available' when the provider has none", async () => {
|
||||
const ctx: any = {
|
||||
queue: { current: () => ({ id: "s1", name: "Song", platform: "netease" }) },
|
||||
getProviderFor: () => ({ getLyrics: vi.fn(async () => []) }),
|
||||
};
|
||||
expect(await cmdLyrics.call(ctx)).toBe("No lyrics available");
|
||||
});
|
||||
});
|
||||
+859
-104
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,153 @@
|
||||
import { describe, it, expect, afterEach } from "vitest";
|
||||
import { join } from "node:path";
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { BotManager } from "./manager.js";
|
||||
import { createDatabase, type BotDatabase } from "../data/database.js";
|
||||
import { createPermissionStore } from "../data/permissions.js";
|
||||
import { getDefaultConfig, loadConfig, saveConfig, type BotConfig } from "../data/config.js";
|
||||
import type { Logger } from "../logger.js";
|
||||
import type { MusicProvider } from "../music/provider.js";
|
||||
import type { AvatarStore } from "../data/avatars.js";
|
||||
import type { SpotifyOAuth } from "../music/spotify/spotify-oauth.js";
|
||||
|
||||
// removeBot only calls logger.info; provide the full shape it could touch.
|
||||
const stubLogger = {
|
||||
info() {},
|
||||
warn() {},
|
||||
error() {},
|
||||
debug() {},
|
||||
child() {
|
||||
return stubLogger;
|
||||
},
|
||||
} as unknown as Logger;
|
||||
|
||||
describe("BotManager.removeBot — guest scope pruning", () => {
|
||||
const dirs: string[] = [];
|
||||
let db: BotDatabase;
|
||||
|
||||
function makeTmpConfigPath(): string {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmusicbot-manager-test-"));
|
||||
dirs.push(dir);
|
||||
return join(dir, "config.json");
|
||||
}
|
||||
|
||||
function makeManager(config: BotConfig, configPath: string): BotManager {
|
||||
db = createDatabase(":memory:");
|
||||
const permissions = createPermissionStore(db.db);
|
||||
saveConfig(configPath, config);
|
||||
return new BotManager(
|
||||
{} as unknown as MusicProvider,
|
||||
{} as unknown as MusicProvider,
|
||||
{} as unknown as MusicProvider,
|
||||
db,
|
||||
config,
|
||||
stubLogger,
|
||||
{} as unknown as AvatarStore,
|
||||
permissions,
|
||||
configPath
|
||||
);
|
||||
}
|
||||
|
||||
afterEach(() => {
|
||||
try {
|
||||
db?.close();
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
for (const d of dirs) {
|
||||
rmSync(d, { recursive: true, force: true });
|
||||
}
|
||||
dirs.length = 0;
|
||||
});
|
||||
|
||||
it("prunes a deleted bot from guestMode.bots (array) and persists", async () => {
|
||||
const configPath = makeTmpConfigPath();
|
||||
const config = getDefaultConfig();
|
||||
config.guestMode.bots = ["botA", "botB"];
|
||||
const manager = makeManager(config, configPath);
|
||||
|
||||
await manager.removeBot("botA");
|
||||
|
||||
expect(config.guestMode.bots).toEqual(["botB"]);
|
||||
// Persisted file must also reflect the prune.
|
||||
expect(loadConfig(configPath).guestMode.bots).toEqual(["botB"]);
|
||||
});
|
||||
|
||||
it('leaves guestMode.bots === "all" unchanged (no crash, no change)', async () => {
|
||||
const configPath = makeTmpConfigPath();
|
||||
const config = getDefaultConfig();
|
||||
config.guestMode.bots = "all";
|
||||
const manager = makeManager(config, configPath);
|
||||
|
||||
await manager.removeBot("botA");
|
||||
|
||||
expect(config.guestMode.bots).toBe("all");
|
||||
expect(loadConfig(configPath).guestMode.bots).toBe("all");
|
||||
});
|
||||
});
|
||||
|
||||
// --- Spotify OAuth threading (Task 6, C3.1) --------------------------------
|
||||
// The single process-wide SpotifyOAuth built in index.ts must reach every bot's
|
||||
// SpotifyController: index -> BotManager (trailing positional arg) -> BotInstance
|
||||
// -> controller. createBot() builds a REAL (side-effect-free) SpotifyController,
|
||||
// so we assert the shared instance surfaces via the controller's getOAuth().
|
||||
describe("BotManager — spotifyOAuth threading to bot controllers (C3.1)", () => {
|
||||
const dirs: string[] = [];
|
||||
let db: BotDatabase | undefined;
|
||||
|
||||
afterEach(() => {
|
||||
try {
|
||||
db?.close();
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
db = undefined;
|
||||
for (const d of dirs) {
|
||||
rmSync(d, { recursive: true, force: true });
|
||||
}
|
||||
dirs.length = 0;
|
||||
});
|
||||
|
||||
it("forwards its shared SpotifyOAuth into a created bot's controller", async () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmusicbot-oauth-thread-"));
|
||||
dirs.push(dir);
|
||||
const configPath = join(dir, "config.json");
|
||||
const config = getDefaultConfig();
|
||||
saveConfig(configPath, config);
|
||||
db = createDatabase(":memory:");
|
||||
const permissions = createPermissionStore(db.db);
|
||||
const provider = {} as unknown as MusicProvider;
|
||||
const sentinel = {} as unknown as SpotifyOAuth;
|
||||
|
||||
const manager = new BotManager(
|
||||
provider,
|
||||
provider,
|
||||
provider,
|
||||
db,
|
||||
config,
|
||||
stubLogger,
|
||||
{} as unknown as AvatarStore,
|
||||
permissions,
|
||||
configPath,
|
||||
undefined, // localProvider
|
||||
undefined, // kugouProvider
|
||||
undefined, // spotifyProvider
|
||||
join(dir, "spotify"), // spotifyDataDir
|
||||
sentinel, // spotifyOAuth (the single shared instance)
|
||||
);
|
||||
|
||||
const bot = await manager.createBot({
|
||||
name: "b1",
|
||||
serverAddress: "localhost",
|
||||
serverPort: 9987,
|
||||
nickname: "b1",
|
||||
});
|
||||
|
||||
// Full chain observed: the manager's single shared instance is the exact
|
||||
// one the per-bot controller now owns (getOAuth() returns it unchanged).
|
||||
expect(bot.getSpotifyController().getOAuth()).toBe(sentinel);
|
||||
|
||||
bot.disconnect();
|
||||
});
|
||||
});
|
||||
+86
-4
@@ -1,5 +1,6 @@
|
||||
import crypto from "node:crypto";
|
||||
import { EventEmitter } from "node:events";
|
||||
import path from "node:path";
|
||||
import {
|
||||
BotInstance,
|
||||
type BotInstanceOptions,
|
||||
@@ -7,10 +8,13 @@ import {
|
||||
import type { MusicProvider } from "../music/provider.js";
|
||||
import { YouTubeProvider } from "../music/youtube.js";
|
||||
import type { BotDatabase } from "../data/database.js";
|
||||
import type { BotConfig } from "../data/config.js";
|
||||
import { saveConfig, type BotConfig } from "../data/config.js";
|
||||
import type { Logger } from "../logger.js";
|
||||
|
||||
import type { ServerProtocol } from "../ts-protocol/client.js";
|
||||
import type { AvatarStore } from "../data/avatars.js";
|
||||
import type { PermissionStore } from "../data/permissions.js";
|
||||
import type { SpotifyOAuth } from "../music/spotify/spotify-oauth.js";
|
||||
|
||||
/**
|
||||
* Run bot.connect() with a hard deadline. If the handshake hangs (e.g. the
|
||||
@@ -55,6 +59,7 @@ export interface CreateBotParams {
|
||||
queryPort?: number;
|
||||
nickname: string;
|
||||
defaultChannel?: string;
|
||||
channelId?: string;
|
||||
channelPassword?: string;
|
||||
autoStart?: boolean;
|
||||
/** Force TS3 or TS6 protocol; omit or "unknown" for auto-detect. */
|
||||
@@ -71,9 +76,18 @@ export class BotManager extends EventEmitter {
|
||||
private qqProvider: MusicProvider;
|
||||
private bilibiliProvider: MusicProvider;
|
||||
private youtubeProvider: MusicProvider;
|
||||
private localProvider: MusicProvider;
|
||||
private kugouProvider: MusicProvider;
|
||||
private spotifyProvider: MusicProvider;
|
||||
private jellyfinProvider: MusicProvider;
|
||||
private spotifyDataDir: string;
|
||||
private readonly spotifyOAuth?: SpotifyOAuth;
|
||||
private database: BotDatabase;
|
||||
private config: BotConfig;
|
||||
private logger: Logger;
|
||||
private avatarStore: AvatarStore;
|
||||
private permissions: PermissionStore;
|
||||
private configPath: string;
|
||||
|
||||
constructor(
|
||||
neteaseProvider: MusicProvider,
|
||||
@@ -81,16 +95,40 @@ export class BotManager extends EventEmitter {
|
||||
bilibiliProvider: MusicProvider,
|
||||
database: BotDatabase,
|
||||
config: BotConfig,
|
||||
logger: Logger
|
||||
logger: Logger,
|
||||
avatarStore: AvatarStore,
|
||||
permissions: PermissionStore,
|
||||
configPath: string,
|
||||
localProvider?: MusicProvider,
|
||||
kugouProvider?: MusicProvider,
|
||||
spotifyProvider?: MusicProvider,
|
||||
spotifyDataDir?: string,
|
||||
spotifyOAuth?: SpotifyOAuth,
|
||||
jellyfinProvider?: MusicProvider
|
||||
) {
|
||||
super();
|
||||
this.neteaseProvider = neteaseProvider;
|
||||
this.qqProvider = qqProvider;
|
||||
this.bilibiliProvider = bilibiliProvider;
|
||||
this.youtubeProvider = new YouTubeProvider();
|
||||
this.localProvider = localProvider ?? neteaseProvider;
|
||||
this.kugouProvider = kugouProvider ?? neteaseProvider;
|
||||
this.spotifyProvider = spotifyProvider ?? neteaseProvider;
|
||||
this.jellyfinProvider = jellyfinProvider ?? neteaseProvider;
|
||||
this.spotifyDataDir = spotifyDataDir ?? path.join(process.cwd(), "data", "spotify");
|
||||
this.spotifyOAuth = spotifyOAuth;
|
||||
// Let the local provider see which uploads are still referenced by any
|
||||
// bot's queue, so it never deletes a file another queue/bot still needs.
|
||||
const referenceable = this.localProvider as Partial<{
|
||||
setInUseResolver: (resolver: () => Set<string>) => void;
|
||||
}>;
|
||||
referenceable.setInUseResolver?.(() => this.getReferencedLocalSongIds());
|
||||
this.database = database;
|
||||
this.config = config;
|
||||
this.logger = logger;
|
||||
this.avatarStore = avatarStore;
|
||||
this.permissions = permissions;
|
||||
this.configPath = configPath;
|
||||
}
|
||||
|
||||
async createBot(params: CreateBotParams): Promise<BotInstance> {
|
||||
@@ -105,6 +143,7 @@ export class BotManager extends EventEmitter {
|
||||
queryPort: params.queryPort ?? 10011,
|
||||
nickname: params.nickname,
|
||||
defaultChannel: params.defaultChannel,
|
||||
channelId: params.channelId,
|
||||
channelPassword: params.channelPassword,
|
||||
serverPassword: params.serverPassword,
|
||||
serverProtocol: params.serverProtocol,
|
||||
@@ -114,9 +153,16 @@ export class BotManager extends EventEmitter {
|
||||
qqProvider: this.qqProvider,
|
||||
bilibiliProvider: this.bilibiliProvider,
|
||||
youtubeProvider: this.youtubeProvider,
|
||||
localProvider: this.localProvider,
|
||||
kugouProvider: this.kugouProvider,
|
||||
spotifyProvider: this.spotifyProvider,
|
||||
jellyfinProvider: this.jellyfinProvider,
|
||||
database: this.database,
|
||||
config: this.config,
|
||||
logger: this.logger,
|
||||
avatarStore: this.avatarStore,
|
||||
spotifyDataDir: this.spotifyDataDir,
|
||||
spotifyOAuth: this.spotifyOAuth,
|
||||
});
|
||||
|
||||
this.bots.set(id, bot);
|
||||
@@ -129,6 +175,7 @@ export class BotManager extends EventEmitter {
|
||||
serverPort: params.serverPort,
|
||||
nickname: params.nickname,
|
||||
defaultChannel: params.defaultChannel ?? "",
|
||||
channelId: params.channelId ?? "",
|
||||
channelPassword: params.channelPassword ?? "",
|
||||
autoStart: params.autoStart ?? false,
|
||||
serverProtocol: params.serverProtocol ?? "",
|
||||
@@ -147,6 +194,12 @@ export class BotManager extends EventEmitter {
|
||||
this.bots.delete(id);
|
||||
}
|
||||
this.database.deleteBotInstance(id);
|
||||
this.permissions.pruneBot(id);
|
||||
// Prune the deleted bot from the guest scope allow-list (mirrors permissions.pruneBot).
|
||||
if (Array.isArray(this.config.guestMode.bots) && this.config.guestMode.bots.includes(id)) {
|
||||
this.config.guestMode.bots = this.config.guestMode.bots.filter((b) => b !== id);
|
||||
saveConfig(this.configPath, this.config);
|
||||
}
|
||||
this.emit("botInstanceRemoved", id);
|
||||
this.logger.info({ botId: id }, "Bot instance removed");
|
||||
}
|
||||
@@ -163,6 +216,7 @@ export class BotManager extends EventEmitter {
|
||||
serverPort: params.serverPort ?? existing.serverPort,
|
||||
nickname: params.nickname ?? existing.nickname,
|
||||
defaultChannel: params.defaultChannel ?? existing.defaultChannel,
|
||||
channelId: params.channelId ?? existing.channelId,
|
||||
channelPassword: params.channelPassword ?? existing.channelPassword,
|
||||
serverProtocol: params.serverProtocol ?? existing.serverProtocol,
|
||||
ts6ApiKey: params.ts6ApiKey ?? existing.ts6ApiKey,
|
||||
@@ -188,6 +242,18 @@ export class BotManager extends EventEmitter {
|
||||
return Array.from(this.bots.values());
|
||||
}
|
||||
|
||||
/** Local upload ids still referenced by any bot's queue. The local provider
|
||||
* uses this to avoid deleting a file another queue/bot is still using. */
|
||||
getReferencedLocalSongIds(): Set<string> {
|
||||
const ids = new Set<string>();
|
||||
for (const bot of this.bots.values()) {
|
||||
for (const song of bot.getQueueManager().list()) {
|
||||
if (song.platform === "local") ids.add(song.id);
|
||||
}
|
||||
}
|
||||
return ids;
|
||||
}
|
||||
|
||||
async startBot(id: string): Promise<void> {
|
||||
const oldBot = this.bots.get(id);
|
||||
if (!oldBot) throw new Error(`Bot ${id} not found`);
|
||||
@@ -221,6 +287,7 @@ export class BotManager extends EventEmitter {
|
||||
// each connect and strips all previously granted groups.
|
||||
identity: saved.identity || undefined,
|
||||
defaultChannel: saved.defaultChannel || undefined,
|
||||
channelId: saved.channelId || undefined,
|
||||
channelPassword: saved.channelPassword || undefined,
|
||||
serverPassword: saved.serverPassword || undefined,
|
||||
serverProtocol: proto === "ts3" || proto === "ts6" ? proto : undefined,
|
||||
@@ -229,10 +296,17 @@ export class BotManager extends EventEmitter {
|
||||
neteaseProvider: this.neteaseProvider,
|
||||
qqProvider: this.qqProvider,
|
||||
bilibiliProvider: this.bilibiliProvider,
|
||||
youtubeProvider: this.youtubeProvider,
|
||||
youtubeProvider: this.youtubeProvider,
|
||||
localProvider: this.localProvider,
|
||||
kugouProvider: this.kugouProvider,
|
||||
spotifyProvider: this.spotifyProvider,
|
||||
jellyfinProvider: this.jellyfinProvider,
|
||||
database: this.database,
|
||||
config: this.config,
|
||||
logger: this.logger,
|
||||
avatarStore: this.avatarStore,
|
||||
spotifyDataDir: this.spotifyDataDir,
|
||||
spotifyOAuth: this.spotifyOAuth,
|
||||
});
|
||||
this.bots.set(id, bot);
|
||||
this.emit("botInstance", bot);
|
||||
@@ -271,6 +345,7 @@ export class BotManager extends EventEmitter {
|
||||
nickname: saved.nickname,
|
||||
identity: saved.identity || undefined,
|
||||
defaultChannel: saved.defaultChannel || undefined,
|
||||
channelId: saved.channelId || undefined,
|
||||
channelPassword: saved.channelPassword || undefined,
|
||||
serverPassword: saved.serverPassword || undefined,
|
||||
serverProtocol: proto === "ts3" || proto === "ts6" ? proto : undefined,
|
||||
@@ -279,10 +354,17 @@ export class BotManager extends EventEmitter {
|
||||
neteaseProvider: this.neteaseProvider,
|
||||
qqProvider: this.qqProvider,
|
||||
bilibiliProvider: this.bilibiliProvider,
|
||||
youtubeProvider: this.youtubeProvider,
|
||||
youtubeProvider: this.youtubeProvider,
|
||||
localProvider: this.localProvider,
|
||||
kugouProvider: this.kugouProvider,
|
||||
spotifyProvider: this.spotifyProvider,
|
||||
jellyfinProvider: this.jellyfinProvider,
|
||||
database: this.database,
|
||||
config: this.config,
|
||||
logger: this.logger,
|
||||
avatarStore: this.avatarStore,
|
||||
spotifyDataDir: this.spotifyDataDir,
|
||||
spotifyOAuth: this.spotifyOAuth,
|
||||
});
|
||||
|
||||
this.bots.set(saved.id, bot);
|
||||
|
||||
@@ -0,0 +1,147 @@
|
||||
import { describe, it, expect, beforeEach, vi } from "vitest";
|
||||
import { BotProfileManager } from "./profile.js";
|
||||
import type { TS3Client } from "../ts-protocol/client.js";
|
||||
import type { QueuedSong } from "../audio/queue.js";
|
||||
|
||||
function makeMockTs(): TS3Client & {
|
||||
uploadCalls: Buffer[];
|
||||
clearCalls: number;
|
||||
} {
|
||||
const calls: Buffer[] = [];
|
||||
let clears = 0;
|
||||
const ts: any = {
|
||||
uploadCalls: calls,
|
||||
get clearCalls() { return clears; },
|
||||
getHost: () => "127.0.0.1",
|
||||
getHttpQuery: () => null,
|
||||
fileTransferInitUpload: vi.fn().mockResolvedValue({}),
|
||||
uploadFileData: vi.fn().mockImplementation(async (_h: any, _i: any, stream: any) => {
|
||||
const chunks: Buffer[] = [];
|
||||
for await (const c of stream) chunks.push(c as Buffer);
|
||||
calls.push(Buffer.concat(chunks));
|
||||
}),
|
||||
fileTransferDeleteFile: vi.fn().mockResolvedValue(undefined),
|
||||
sendCommandNoWait: vi.fn().mockImplementation(async (cmd: string) => {
|
||||
if (/client_flag_avatar=$/.test(cmd)) clears++;
|
||||
}),
|
||||
};
|
||||
return ts;
|
||||
}
|
||||
|
||||
const noopLogger: any = { child: () => noopLogger, info: () => {}, debug: () => {}, warn: () => {}, error: () => {} };
|
||||
|
||||
const cfgOn = { avatarEnabled: true, descriptionEnabled: false, nicknameEnabled: false, awayStatusEnabled: false, channelDescEnabled: false, nowPlayingMsgEnabled: false };
|
||||
const cfgOff = { ...cfgOn, avatarEnabled: false };
|
||||
|
||||
const fakeSong: QueuedSong = {
|
||||
id: "1",
|
||||
name: "X",
|
||||
artist: "Y",
|
||||
album: "Z",
|
||||
platform: "netease",
|
||||
url: "u",
|
||||
coverUrl: "c",
|
||||
duration: 100,
|
||||
};
|
||||
|
||||
const flush = () => new Promise((r) => setImmediate(r));
|
||||
|
||||
describe("BotProfileManager custom avatar precedence", () => {
|
||||
let ts: ReturnType<typeof makeMockTs>;
|
||||
beforeEach(() => { ts = makeMockTs(); });
|
||||
|
||||
it("setCustomAvatar uploads immediately on a fresh idle bot (sync on)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([1, 2, 3]));
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(1);
|
||||
expect(ts.uploadCalls[0].equals(Buffer.from([1, 2, 3]))).toBe(true);
|
||||
});
|
||||
|
||||
it("setCustomAvatar uploads immediately when sync is off (always idle)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOff, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([7]));
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(1);
|
||||
});
|
||||
|
||||
it("setCustomAvatar while playing + sync on does NOT push (cover wins)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
// Simulate the bot playing a song. We can't actually run updateAvatar's
|
||||
// full HTTP fetch path, but onSongChange records currentSong before
|
||||
// updateAvatar runs, which is enough for this assertion.
|
||||
void pm.onSongChange(fakeSong);
|
||||
await flush();
|
||||
const uploadsBefore = ts.uploadCalls.length;
|
||||
pm.setCustomAvatar(Buffer.from([42]));
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(uploadsBefore); // no new upload
|
||||
});
|
||||
|
||||
it("setCustomAvatar while playing + sync off DOES push (sync-off is idle)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOff, "Bot");
|
||||
void pm.onSongChange(fakeSong);
|
||||
await flush();
|
||||
const uploadsBefore = ts.uploadCalls.length;
|
||||
pm.setCustomAvatar(Buffer.from([42]));
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(uploadsBefore + 1);
|
||||
});
|
||||
|
||||
it("setCustomAvatar(null) while idle clears the TS3 avatar", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([1]));
|
||||
await flush();
|
||||
const clearsBefore = ts.clearCalls;
|
||||
pm.setCustomAvatar(null);
|
||||
await flush();
|
||||
expect(ts.clearCalls).toBe(clearsBefore + 1);
|
||||
});
|
||||
|
||||
it("on stop with custom avatar set + sync on, restores custom (does not clear)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([1, 2, 3, 4]));
|
||||
await flush();
|
||||
const clearsBefore = ts.clearCalls;
|
||||
await pm.onSongChange(null);
|
||||
expect(ts.uploadCalls.at(-1)?.equals(Buffer.from([1, 2, 3, 4]))).toBe(true);
|
||||
expect(ts.clearCalls).toBe(clearsBefore); // no extra clear
|
||||
});
|
||||
|
||||
it("on stop with no custom avatar, falls back to clear", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
await pm.onSongChange(null);
|
||||
expect(ts.clearCalls).toBe(1);
|
||||
expect(ts.uploadCalls.length).toBe(0);
|
||||
});
|
||||
|
||||
it("on connect with custom avatar set + sync ON, applies custom (spec matrix row 1)", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOn, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([5, 5]));
|
||||
await flush();
|
||||
ts.uploadCalls.length = 0; // reset
|
||||
pm.onConnect();
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(1);
|
||||
expect(ts.uploadCalls[0].equals(Buffer.from([5, 5]))).toBe(true);
|
||||
});
|
||||
|
||||
it("on connect with custom avatar set + sync OFF, applies custom", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOff, "Bot");
|
||||
pm.setCustomAvatar(Buffer.from([9, 9]));
|
||||
await flush();
|
||||
ts.uploadCalls.length = 0;
|
||||
pm.onConnect();
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(1);
|
||||
expect(ts.uploadCalls[0].equals(Buffer.from([9, 9]))).toBe(true);
|
||||
});
|
||||
|
||||
it("on connect with no custom avatar, does not touch avatar", async () => {
|
||||
const pm = new BotProfileManager(ts as any, noopLogger, cfgOff, "Bot");
|
||||
pm.onConnect();
|
||||
await flush();
|
||||
expect(ts.uploadCalls.length).toBe(0);
|
||||
expect(ts.clearCalls).toBe(0);
|
||||
});
|
||||
});
|
||||
+51
-1
@@ -25,6 +25,13 @@ export class BotProfileManager {
|
||||
private logger: Logger;
|
||||
private config: ProfileConfig;
|
||||
private defaultNickname: string;
|
||||
private customAvatar: Buffer | null = null;
|
||||
/**
|
||||
* Tracks the last song handed to onSongChange. null means stopped/idle.
|
||||
* Used by setCustomAvatar to decide whether the new buffer should be
|
||||
* pushed immediately (idle) or wait for the next stop event (playing).
|
||||
*/
|
||||
private currentSong: QueuedSong | null = null;
|
||||
|
||||
/** Per-feature permission-denied flags. Reset on reconnect. */
|
||||
private permDenied = {
|
||||
@@ -58,6 +65,26 @@ export class BotProfileManager {
|
||||
|
||||
// --- Public API ---
|
||||
|
||||
/**
|
||||
* Set/clear the persistent idle avatar. Pass null to remove.
|
||||
*
|
||||
* If the bot is currently in an idle state (no song playing OR
|
||||
* avatarEnabled is off), the new buffer is pushed to TS3 right away;
|
||||
* otherwise the cover-art sync is in charge until the next stop event,
|
||||
* at which point clearAvatar restores from this.customAvatar.
|
||||
*/
|
||||
setCustomAvatar(buffer: Buffer | null): void {
|
||||
this.customAvatar = buffer;
|
||||
const idle = this.currentSong === null || !this.config.avatarEnabled;
|
||||
if (!idle) return;
|
||||
const gen = ++this.generation;
|
||||
if (buffer && buffer.length > 0) {
|
||||
void this.applyIdleAvatar(gen);
|
||||
} else {
|
||||
void this.clearAvatar(gen);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Called when a new song starts playing (song != null) or playback
|
||||
* stops (song == null).
|
||||
@@ -71,6 +98,7 @@ export class BotProfileManager {
|
||||
*/
|
||||
async onSongChange(song: QueuedSong | null): Promise<void> {
|
||||
const gen = ++this.generation;
|
||||
this.currentSong = song;
|
||||
|
||||
// 1. Avatar first — file transfer uses its own response tracker and
|
||||
// must run before sendCommandNoWait calls whose orphaned responses
|
||||
@@ -91,6 +119,7 @@ export class BotProfileManager {
|
||||
/** Reset permission-denied flags and bump generation on new connection. */
|
||||
onConnect(): void {
|
||||
this.generation++;
|
||||
this.currentSong = null;
|
||||
this.permDenied = {
|
||||
avatar: false,
|
||||
description: false,
|
||||
@@ -99,6 +128,12 @@ export class BotProfileManager {
|
||||
channelDesc: false,
|
||||
nowPlayingMsg: false,
|
||||
};
|
||||
// No song is playing on a fresh connect, so the matrix says the
|
||||
// custom avatar should be visible regardless of avatarEnabled.
|
||||
if (this.customAvatar) {
|
||||
const gen = this.generation;
|
||||
void this.applyIdleAvatar(gen);
|
||||
}
|
||||
}
|
||||
|
||||
getConfig(): ProfileConfig {
|
||||
@@ -171,6 +206,10 @@ export class BotProfileManager {
|
||||
}
|
||||
|
||||
private async clearAvatar(gen: number): Promise<void> {
|
||||
if (this.customAvatar && this.customAvatar.length > 0) {
|
||||
await this.applyIdleAvatar(gen);
|
||||
return;
|
||||
}
|
||||
try {
|
||||
await this.withTimeout(
|
||||
this.tsClient.fileTransferDeleteFile(0n, ["/avatar"]),
|
||||
@@ -179,7 +218,6 @@ export class BotProfileManager {
|
||||
} catch {
|
||||
// File may not exist or transfer timed out — that's fine
|
||||
}
|
||||
// Bail if a newer song started while we were deleting
|
||||
if (this.generation !== gen) return;
|
||||
try {
|
||||
await this.tsClient.sendCommandNoWait("clientupdate client_flag_avatar=");
|
||||
@@ -188,6 +226,18 @@ export class BotProfileManager {
|
||||
}
|
||||
}
|
||||
|
||||
private async applyIdleAvatar(gen: number): Promise<void> {
|
||||
if (!this.customAvatar || this.customAvatar.length === 0) return;
|
||||
if (this.permDenied.avatar) return;
|
||||
try {
|
||||
await this.withTimeout(this.doAvatarUpload(this.customAvatar), FILE_TRANSFER_TIMEOUT_MS);
|
||||
if (this.generation !== gen) return;
|
||||
this.logger.info({ bytes: this.customAvatar.length }, "Idle (custom) avatar applied");
|
||||
} catch (err) {
|
||||
this.handleFeatureError("avatar", err);
|
||||
}
|
||||
}
|
||||
|
||||
private async updateDescription(song: QueuedSong | null): Promise<void> {
|
||||
if (!this.config.descriptionEnabled || this.permDenied.description) return;
|
||||
try {
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { parseSongRef, parseSelectionIndex } from "./song-ref.js";
|
||||
|
||||
describe("parseSongRef (#90 exact-song selection)", () => {
|
||||
it("returns null for a plain search term", () => {
|
||||
expect(parseSongRef("Die For You")).toBeNull();
|
||||
expect(parseSongRef("周杰伦 晴天")).toBeNull();
|
||||
expect(parseSongRef("")).toBeNull();
|
||||
// A bare number is NOT treated as an id (a song may be named "2002").
|
||||
expect(parseSongRef("2002")).toBeNull();
|
||||
});
|
||||
|
||||
it("parses an explicit id: prefix with no platform (defer to flags)", () => {
|
||||
expect(parseSongRef("id:185868")).toEqual({ id: "185868", platform: null });
|
||||
expect(parseSongRef("ID: 004Z8Ihr0JIu5s")).toEqual({ id: "004Z8Ihr0JIu5s", platform: null });
|
||||
});
|
||||
|
||||
it("strips trailing punctuation from a pasted id:", () => {
|
||||
expect(parseSongRef("id:185868.")).toEqual({ id: "185868", platform: null });
|
||||
expect(parseSongRef("id:185868)")).toEqual({ id: "185868", platform: null });
|
||||
expect(parseSongRef("id:185868,")).toEqual({ id: "185868", platform: null });
|
||||
});
|
||||
|
||||
it("does NOT treat NetEase collection (playlist/album/artist) URLs as a song id", () => {
|
||||
// These reuse ?id= but are not songs — they should fall through to search,
|
||||
// not misresolve to getSongDetail(collectionId) and error "no song".
|
||||
expect(parseSongRef("https://music.163.com/playlist?id=123456")).toBeNull();
|
||||
expect(parseSongRef("https://music.163.com/#/playlist?id=123456")).toBeNull();
|
||||
expect(parseSongRef("https://music.163.com/album?id=123456")).toBeNull();
|
||||
expect(parseSongRef("https://music.163.com/artist?id=185858")).toBeNull();
|
||||
// A genuine song URL is still parsed.
|
||||
expect(parseSongRef("https://music.163.com/song?id=185868")).toEqual({ id: "185868", platform: "netease" });
|
||||
});
|
||||
|
||||
it("parses NetEase song URLs", () => {
|
||||
expect(parseSongRef("https://music.163.com/song?id=185868")).toEqual({ id: "185868", platform: "netease" });
|
||||
expect(parseSongRef("https://music.163.com/#/song?id=185868&userid=1")).toEqual({ id: "185868", platform: "netease" });
|
||||
expect(parseSongRef("music.163.com/song/185868")).toEqual({ id: "185868", platform: "netease" });
|
||||
});
|
||||
|
||||
it("parses QQ song URLs", () => {
|
||||
expect(parseSongRef("https://y.qq.com/n/ryqq/songDetail/004Z8Ihr0JIu5s")).toEqual({ id: "004Z8Ihr0JIu5s", platform: "qq" });
|
||||
expect(parseSongRef("https://y.qq.com/n/yqq/song/abc.html?songmid=004Z8Ihr0JIu5s")).toEqual({ id: "004Z8Ihr0JIu5s", platform: "qq" });
|
||||
});
|
||||
|
||||
it("parses BiliBili BV ids (bare or in a URL)", () => {
|
||||
expect(parseSongRef("BV1yxHQeYEuE")).toEqual({ id: "BV1yxHQeYEuE", platform: "bilibili" });
|
||||
expect(parseSongRef("https://www.bilibili.com/video/BV1yxHQeYEuE")).toEqual({ id: "BV1yxHQeYEuE", platform: "bilibili" });
|
||||
expect(parseSongRef("https://b23.tv/BV1yxHQeYEuE")).toEqual({ id: "BV1yxHQeYEuE", platform: "bilibili" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("parseSelectionIndex (#90 pick from last search)", () => {
|
||||
it("parses #N tokens (1-based)", () => {
|
||||
expect(parseSelectionIndex("#1")).toBe(1);
|
||||
expect(parseSelectionIndex("#2")).toBe(2);
|
||||
expect(parseSelectionIndex("# 3")).toBe(3);
|
||||
expect(parseSelectionIndex(" #10 ")).toBe(10);
|
||||
});
|
||||
|
||||
it("rejects non-selections", () => {
|
||||
expect(parseSelectionIndex("2")).toBeNull();
|
||||
expect(parseSelectionIndex("#0")).toBeNull();
|
||||
expect(parseSelectionIndex("#-1")).toBeNull();
|
||||
expect(parseSelectionIndex("Die For You")).toBeNull();
|
||||
expect(parseSelectionIndex("#2 extra")).toBeNull();
|
||||
expect(parseSelectionIndex("")).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,73 @@
|
||||
/**
|
||||
* Parsing helpers for picking an EXACT song in a !play / !add / !playnext query,
|
||||
* so same-name songs can be disambiguated instead of always getting the single
|
||||
* most-popular search hit (issue #90).
|
||||
*
|
||||
* Two mechanisms:
|
||||
* - A song reference: an explicit id / platform URL → play that exact song.
|
||||
* - A selection index: "#N" → the Nth result of the previous !search.
|
||||
*/
|
||||
|
||||
export interface SongRef {
|
||||
id: string;
|
||||
/**
|
||||
* Platform inferred from a URL. `null` means the platform wasn't encoded in
|
||||
* the reference (e.g. a bare `id:`), so the caller should fall back to the
|
||||
* command's flags / default provider.
|
||||
*/
|
||||
platform: "netease" | "qq" | "bilibili" | null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect an explicit song reference in a query. Recognizes:
|
||||
* - `id:<id>` → platform from flags/default
|
||||
* - NetEase song URL → music.163.com/song?id=N (also /#/song?id=N, /song/N)
|
||||
* - QQ song URL → y.qq.com/.../songDetail/MID (or ?songmid=MID)
|
||||
* - BiliBili BVID (bare or in a URL) → bilibili.com/video/BVxxxx, b23.tv, or BVxxxx
|
||||
* Returns `null` for a plain search term (the common case).
|
||||
*/
|
||||
export function parseSongRef(raw: string): SongRef | null {
|
||||
const q = (raw ?? "").trim();
|
||||
if (!q) return null;
|
||||
|
||||
// Explicit "id:<id>" — platform decided by the command's flags/default.
|
||||
// Strip trailing punctuation that tags along from a chat paste ("id:12345."
|
||||
// / "id:12345)") — no supported id (numeric / BVID / mid) ends in those.
|
||||
const idPrefix = /^id:\s*(\S+)$/i.exec(q);
|
||||
if (idPrefix) return { id: idPrefix[1].replace(/[.,;)\]]+$/, ""), platform: null };
|
||||
|
||||
// BiliBili BV id, bare or inside a bilibili URL (NetEase ids are numeric, so
|
||||
// a "BV..." token never collides with them).
|
||||
const bv = /BV[0-9A-Za-z]{8,12}/.exec(q);
|
||||
if (bv && (/^BV[0-9A-Za-z]{8,12}$/.test(q) || /bilibili\.com|b23\.tv/i.test(q))) {
|
||||
return { id: bv[0], platform: "bilibili" };
|
||||
}
|
||||
|
||||
// NetEase song URL. Only treat `id=N` as a SONG id when the URL is not a
|
||||
// collection page (playlist/album/artist/toplist/djradio) — those reuse the
|
||||
// same `id=` param but are NOT songs; getSongDetail() would 404 them into a
|
||||
// confusing "no song" error instead of falling back to a normal search.
|
||||
if (/music\.163\.com/i.test(q) && !/(playlist|album|artist|toplist|djradio)/i.test(q)) {
|
||||
const m = /[?&#/]id=(\d+)/.exec(q) ?? /\/song\/(\d+)/.exec(q);
|
||||
if (m) return { id: m[1], platform: "netease" };
|
||||
}
|
||||
|
||||
// QQ song URL.
|
||||
if (/y\.qq\.com/i.test(q)) {
|
||||
const m = /songDetail\/([0-9A-Za-z]+)/.exec(q) ?? /[?&]songmid=([0-9A-Za-z]+)/i.exec(q);
|
||||
if (m) return { id: m[1], platform: "qq" };
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect a "#N" selection token (1-based) referencing the previous !search.
|
||||
* Returns the positive integer, or `null` when the query isn't a selection.
|
||||
*/
|
||||
export function parseSelectionIndex(raw: string): number | null {
|
||||
const m = /^#\s*(\d+)$/.exec((raw ?? "").trim());
|
||||
if (!m) return null;
|
||||
const n = parseInt(m[1], 10);
|
||||
return Number.isFinite(n) && n > 0 ? n : null;
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { splitTextIntoChunks } from "./text-chunk.js";
|
||||
|
||||
const bytes = (s: string) => Buffer.byteLength(s, "utf8");
|
||||
|
||||
describe("splitTextIntoChunks", () => {
|
||||
it("returns a single chunk for a short string", () => {
|
||||
const chunks = splitTextIntoChunks("hello world", 900);
|
||||
expect(chunks).toEqual(["hello world"]);
|
||||
});
|
||||
|
||||
it("splits a multi-line string longer than maxBytes into multiple chunks on line boundaries", () => {
|
||||
const lines = Array.from({ length: 50 }, (_, i) => `line number ${i}`);
|
||||
const text = lines.join("\n");
|
||||
const chunks = splitTextIntoChunks(text, 60);
|
||||
|
||||
expect(chunks.length).toBeGreaterThan(1);
|
||||
for (const c of chunks) {
|
||||
expect(bytes(c)).toBeLessThanOrEqual(60);
|
||||
}
|
||||
// No hard-split of any line occurred, so rejoining with "\n" is lossless.
|
||||
expect(chunks.join("\n")).toBe(text);
|
||||
});
|
||||
|
||||
it("bounds by BYTES not chars: multibyte (Chinese) content stays under the cap", () => {
|
||||
// Each Chinese char is 3 bytes in UTF-8. 40 chars/line = 120 bytes/line.
|
||||
const lines = Array.from({ length: 10 }, () => "歌词".repeat(20));
|
||||
const text = lines.join("\n");
|
||||
const chunks = splitTextIntoChunks(text, 150);
|
||||
|
||||
expect(chunks.length).toBeGreaterThan(1);
|
||||
for (const c of chunks) {
|
||||
expect(bytes(c)).toBeLessThanOrEqual(150);
|
||||
}
|
||||
expect(chunks.join("\n")).toBe(text);
|
||||
});
|
||||
|
||||
it("hard-splits a single over-long line so no chunk exceeds the cap", () => {
|
||||
const longLine = "a".repeat(500);
|
||||
const chunks = splitTextIntoChunks(longLine, 100);
|
||||
|
||||
expect(chunks.length).toBeGreaterThan(1);
|
||||
for (const c of chunks) {
|
||||
expect(bytes(c)).toBeLessThanOrEqual(100);
|
||||
}
|
||||
// Content is preserved (hard-split introduces split points, not \n).
|
||||
expect(chunks.join("")).toBe(longLine);
|
||||
});
|
||||
|
||||
it("never splits a multibyte character across a hard-split boundary", () => {
|
||||
// 200 Chinese chars = 600 bytes on ONE line, cap 40 bytes.
|
||||
const longLine = "歌".repeat(200);
|
||||
const chunks = splitTextIntoChunks(longLine, 40);
|
||||
|
||||
for (const c of chunks) {
|
||||
expect(bytes(c)).toBeLessThanOrEqual(40);
|
||||
// A clean re-decode: every chunk is valid UTF-8 with no replacement char.
|
||||
expect(c.includes("�")).toBe(false);
|
||||
}
|
||||
expect(chunks.join("")).toBe(longLine);
|
||||
});
|
||||
|
||||
it("preserves blank lines within a single chunk", () => {
|
||||
const text = "a\n\nb";
|
||||
expect(splitTextIntoChunks(text, 900)).toEqual([text]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,74 @@
|
||||
/**
|
||||
* Split `text` into chunks whose UTF-8 byte length never exceeds `maxBytes`.
|
||||
*
|
||||
* TeamSpeak enforces a per-message byte cap (~1024 bytes), and the send path
|
||||
* does no chunking, so a long single reply (e.g. full song lyrics) would be
|
||||
* truncated or rejected. This packs whole lines greedily, breaking BETWEEN
|
||||
* lines. When a single line is itself longer than `maxBytes`, it is hard-split
|
||||
* on UTF-8 character boundaries so no chunk ever exceeds the cap and no
|
||||
* multibyte character is ever cut in half.
|
||||
*
|
||||
* Content is preserved on rejoin, modulo the split points: chunks split only on
|
||||
* newline boundaries rejoin losslessly with `chunks.join("\n")`; a hard-split
|
||||
* long line rejoins with `chunks.join("")`.
|
||||
*
|
||||
* @param text The full message text.
|
||||
* @param maxBytes Max UTF-8 bytes per chunk (default 900 — under TS's ~1024 cap
|
||||
* with headroom for protocol framing/escaping).
|
||||
*/
|
||||
export function splitTextIntoChunks(text: string, maxBytes = 900): string[] {
|
||||
const chunks: string[] = [];
|
||||
let current = "";
|
||||
|
||||
const flush = (): void => {
|
||||
if (current !== "") {
|
||||
chunks.push(current);
|
||||
current = "";
|
||||
}
|
||||
};
|
||||
|
||||
for (const rawLine of text.split("\n")) {
|
||||
const pieces =
|
||||
Buffer.byteLength(rawLine, "utf8") > maxBytes
|
||||
? hardSplitByBytes(rawLine, maxBytes)
|
||||
: [rawLine];
|
||||
|
||||
for (const piece of pieces) {
|
||||
const candidate = current === "" ? piece : `${current}\n${piece}`;
|
||||
if (Buffer.byteLength(candidate, "utf8") <= maxBytes) {
|
||||
current = candidate;
|
||||
} else {
|
||||
// current is guaranteed non-empty here: pieces never exceed maxBytes,
|
||||
// so an empty `current` always accepts the next piece above.
|
||||
flush();
|
||||
current = piece;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
flush();
|
||||
return chunks;
|
||||
}
|
||||
|
||||
/**
|
||||
* Break a single line into pieces each ≤ `maxBytes` UTF-8 bytes, never cutting
|
||||
* a character (iterates code points, so surrogate pairs stay intact).
|
||||
*/
|
||||
function hardSplitByBytes(line: string, maxBytes: number): string[] {
|
||||
const pieces: string[] = [];
|
||||
let current = "";
|
||||
let currentBytes = 0;
|
||||
|
||||
for (const ch of line) {
|
||||
const chBytes = Buffer.byteLength(ch, "utf8");
|
||||
if (currentBytes + chBytes > maxBytes && current !== "") {
|
||||
pieces.push(current);
|
||||
current = "";
|
||||
currentBytes = 0;
|
||||
}
|
||||
current += ch;
|
||||
currentBytes += chBytes;
|
||||
}
|
||||
if (current !== "") pieces.push(current);
|
||||
return pieces;
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
||||
import { createDatabase, type BotDatabase } from "./database.js";
|
||||
import { createAuditStore, type AuditStore } from "./audit.js";
|
||||
|
||||
describe("AuditStore", () => {
|
||||
let botDb: BotDatabase;
|
||||
let audit: AuditStore;
|
||||
|
||||
beforeEach(() => {
|
||||
botDb = createDatabase(":memory:");
|
||||
audit = createAuditStore(botDb.db);
|
||||
});
|
||||
|
||||
afterEach(() => botDb.close());
|
||||
|
||||
it("records and lists entries newest-first", async () => {
|
||||
audit.record({
|
||||
actorId: "a1", actorUsername: "alice",
|
||||
targetUserId: "b1", targetUsername: "bob",
|
||||
action: "user.created",
|
||||
});
|
||||
await new Promise((r) => setTimeout(r, 5));
|
||||
audit.record({
|
||||
actorId: "a1", actorUsername: "alice",
|
||||
targetUserId: "b1", targetUsername: "bob",
|
||||
action: "user.deleted",
|
||||
});
|
||||
const list = audit.list(10, 0);
|
||||
expect(list).toHaveLength(2);
|
||||
expect(list[0].action).toBe("user.deleted");
|
||||
expect(list[1].action).toBe("user.created");
|
||||
});
|
||||
|
||||
it("supports limit and offset", () => {
|
||||
for (let i = 0; i < 5; i++) {
|
||||
audit.record({
|
||||
actorId: "a1", actorUsername: "alice",
|
||||
targetUserId: null, targetUsername: null,
|
||||
action: "user.password_changed",
|
||||
});
|
||||
}
|
||||
expect(audit.list(2, 0)).toHaveLength(2);
|
||||
expect(audit.list(2, 4)).toHaveLength(1);
|
||||
expect(audit.list(10, 10)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("stores nullable fields correctly", () => {
|
||||
audit.record({
|
||||
actorId: null, actorUsername: null,
|
||||
targetUserId: "x", targetUsername: "deleted-user",
|
||||
action: "admin.first_created",
|
||||
});
|
||||
const e = audit.list(1, 0)[0];
|
||||
expect(e.actorId).toBeNull();
|
||||
expect(e.actorUsername).toBeNull();
|
||||
expect(e.targetUserId).toBe("x");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,58 @@
|
||||
import type Database from "better-sqlite3";
|
||||
|
||||
export type AuditAction =
|
||||
| "admin.first_created"
|
||||
| "user.created"
|
||||
| "user.deleted"
|
||||
| "user.password_reset"
|
||||
| "user.password_changed"
|
||||
| "user.role_changed"
|
||||
| "user.permissions_changed";
|
||||
|
||||
export interface AuditEntry {
|
||||
id: number;
|
||||
timestamp: number;
|
||||
actorId: string | null;
|
||||
actorUsername: string | null;
|
||||
targetUserId: string | null;
|
||||
targetUsername: string | null;
|
||||
action: AuditAction;
|
||||
}
|
||||
|
||||
export interface AuditRecordInput {
|
||||
actorId: string | null;
|
||||
actorUsername: string | null;
|
||||
targetUserId: string | null;
|
||||
targetUsername: string | null;
|
||||
action: AuditAction;
|
||||
}
|
||||
|
||||
export interface AuditStore {
|
||||
record(input: AuditRecordInput): void;
|
||||
list(limit: number, offset: number): AuditEntry[];
|
||||
}
|
||||
|
||||
export function createAuditStore(db: Database.Database): AuditStore {
|
||||
const insertStmt = db.prepare(
|
||||
"INSERT INTO user_audit (timestamp, actorId, actorUsername, targetUserId, targetUsername, action) VALUES (?, ?, ?, ?, ?, ?)"
|
||||
);
|
||||
const listStmt = db.prepare(
|
||||
"SELECT id, timestamp, actorId, actorUsername, targetUserId, targetUsername, action FROM user_audit ORDER BY timestamp DESC, id DESC LIMIT ? OFFSET ?"
|
||||
);
|
||||
|
||||
return {
|
||||
record(input) {
|
||||
insertStmt.run(
|
||||
Date.now(),
|
||||
input.actorId,
|
||||
input.actorUsername,
|
||||
input.targetUserId,
|
||||
input.targetUsername,
|
||||
input.action
|
||||
);
|
||||
},
|
||||
list(limit, offset) {
|
||||
return listStmt.all(limit, offset) as AuditEntry[];
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
import { describe, it, expect, beforeEach } from "vitest";
|
||||
import { mkdtempSync, rmSync, existsSync, readFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { createAvatarStore } from "./avatars.js";
|
||||
|
||||
let dir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
dir = mkdtempSync(join(tmpdir(), "avatar-test-"));
|
||||
});
|
||||
|
||||
describe("createAvatarStore", () => {
|
||||
it("write returns a relative path under the store dir", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
const buf = Buffer.from("fake-png");
|
||||
const rel = store.write("bot-1", "image/png", buf);
|
||||
expect(rel).toBe("bot-1.png");
|
||||
expect(readFileSync(join(dir, "bot-1.png")).equals(buf)).toBe(true);
|
||||
});
|
||||
|
||||
it("write picks correct extension for jpeg / webp", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
expect(store.write("a", "image/jpeg", Buffer.from(""))).toBe("a.jpg");
|
||||
expect(store.write("b", "image/webp", Buffer.from(""))).toBe("b.webp");
|
||||
});
|
||||
|
||||
it("write rejects unsupported MIME types", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
expect(() => store.write("c", "image/gif", Buffer.from(""))).toThrow(/unsupported/i);
|
||||
});
|
||||
|
||||
it("read returns the bytes for an existing file", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
store.write("bot-1", "image/png", Buffer.from("hello"));
|
||||
const buf = store.read("bot-1.png");
|
||||
expect(buf?.equals(Buffer.from("hello"))).toBe(true);
|
||||
});
|
||||
|
||||
it("read returns null when path is missing", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
expect(store.read("missing.png")).toBeNull();
|
||||
});
|
||||
|
||||
it("remove deletes the file (idempotent)", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
store.write("bot-1", "image/png", Buffer.from("x"));
|
||||
store.remove("bot-1.png");
|
||||
expect(existsSync(join(dir, "bot-1.png"))).toBe(false);
|
||||
expect(() => store.remove("bot-1.png")).not.toThrow();
|
||||
});
|
||||
|
||||
it("write replaces any existing file for the same botId regardless of old extension", () => {
|
||||
const store = createAvatarStore(dir);
|
||||
store.write("bot-1", "image/png", Buffer.from("old"));
|
||||
const rel = store.write("bot-1", "image/jpeg", Buffer.from("new"));
|
||||
expect(rel).toBe("bot-1.jpg");
|
||||
expect(existsSync(join(dir, "bot-1.png"))).toBe(false);
|
||||
expect(existsSync(join(dir, "bot-1.jpg"))).toBe(true);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,43 @@
|
||||
import { mkdirSync, writeFileSync, readFileSync, rmSync, readdirSync, existsSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
|
||||
const MIME_TO_EXT: Record<string, string> = {
|
||||
"image/png": "png",
|
||||
"image/jpeg": "jpg",
|
||||
"image/webp": "webp",
|
||||
};
|
||||
|
||||
export interface AvatarStore {
|
||||
/** Returns the relative path written (e.g. "bot-1.png"). */
|
||||
write(botId: string, mime: string, buffer: Buffer): string;
|
||||
read(relPath: string): Buffer | null;
|
||||
remove(relPath: string): void;
|
||||
getDir(): string;
|
||||
}
|
||||
|
||||
export function createAvatarStore(dir: string): AvatarStore {
|
||||
if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
|
||||
return {
|
||||
write(botId, mime, buffer) {
|
||||
const ext = MIME_TO_EXT[mime];
|
||||
if (!ext) throw new Error(`unsupported avatar MIME: ${mime}`);
|
||||
for (const name of readdirSync(dir)) {
|
||||
if (name.startsWith(`${botId}.`)) rmSync(join(dir, name), { force: true });
|
||||
}
|
||||
const rel = `${botId}.${ext}`;
|
||||
writeFileSync(join(dir, rel), buffer);
|
||||
return rel;
|
||||
},
|
||||
read(relPath) {
|
||||
const full = join(dir, relPath);
|
||||
if (!existsSync(full)) return null;
|
||||
return readFileSync(full);
|
||||
},
|
||||
remove(relPath) {
|
||||
rmSync(join(dir, relPath), { force: true });
|
||||
},
|
||||
getDir() {
|
||||
return dir;
|
||||
},
|
||||
};
|
||||
}
|
||||
+447
-4
@@ -1,8 +1,31 @@
|
||||
import { describe, it, expect, afterEach } from "vitest";
|
||||
import { describe, it, expect, afterEach, beforeEach, vi } from "vitest";
|
||||
import { join } from "node:path";
|
||||
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import {
|
||||
mkdtempSync,
|
||||
rmSync,
|
||||
writeFileSync,
|
||||
existsSync,
|
||||
readFileSync,
|
||||
readdirSync,
|
||||
renameSync,
|
||||
} from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { getDefaultConfig, loadConfig, saveConfig } from "./config.js";
|
||||
import { getDefaultConfig, loadConfig, saveConfig, migrateLegacyConfig, defaultPlatform } from "./config.js";
|
||||
|
||||
// Wrap the fs functions config.ts uses in call-through spies so the atomic-write
|
||||
// and transient-read-error paths can be observed/forced. Everything else (mkdtemp,
|
||||
// rmSync, existsSync, …) is the real implementation via `...actual`, so all other
|
||||
// tests keep their real filesystem behavior. `vi.spyOn` can't be used here because
|
||||
// the node:fs ESM namespace is non-configurable in this setup.
|
||||
vi.mock("node:fs", async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import("node:fs")>();
|
||||
return {
|
||||
...actual,
|
||||
readFileSync: vi.fn(actual.readFileSync),
|
||||
writeFileSync: vi.fn(actual.writeFileSync),
|
||||
renameSync: vi.fn(actual.renameSync),
|
||||
};
|
||||
});
|
||||
|
||||
describe("config", () => {
|
||||
const dirs: string[] = [];
|
||||
@@ -25,6 +48,50 @@ describe("config", () => {
|
||||
expect(config).toEqual(getDefaultConfig());
|
||||
});
|
||||
|
||||
it("defaults to the online sources with jellyfin as opt-in (disabled)", () => {
|
||||
const config = getDefaultConfig();
|
||||
expect(config.enabledProviders).toEqual(["netease", "qq", "bilibili", "youtube", "kugou"]);
|
||||
expect(config.enabledProviders).not.toContain("jellyfin");
|
||||
});
|
||||
|
||||
it("keeps pre-gating behavior for legacy configs without enabledProviders", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
// A config written before enabledProviders existed: no such field.
|
||||
writeFileSync(path, JSON.stringify({ webPort: 4000 }));
|
||||
const config = loadConfig(path);
|
||||
expect(config.enabledProviders).toEqual(["netease", "qq", "bilibili", "youtube", "kugou"]);
|
||||
expect(defaultPlatform(config)).toBe("netease");
|
||||
});
|
||||
|
||||
it("defaultPlatform follows the fixed priority order", () => {
|
||||
const config = getDefaultConfig();
|
||||
expect(defaultPlatform(config)).toBe("netease");
|
||||
|
||||
// Jellyfin ranks after the online music platforms…
|
||||
config.enabledProviders = ["netease", "jellyfin"];
|
||||
expect(defaultPlatform(config)).toBe("netease");
|
||||
// …but ahead of the video sites…
|
||||
config.enabledProviders = ["bilibili", "jellyfin", "youtube"];
|
||||
expect(defaultPlatform(config)).toBe("jellyfin");
|
||||
// …and is the default when it is the only enabled source.
|
||||
config.enabledProviders = ["jellyfin"];
|
||||
expect(defaultPlatform(config)).toBe("jellyfin");
|
||||
// Nothing enabled → netease fallback (the gate then reports it disabled).
|
||||
config.enabledProviders = [];
|
||||
expect(defaultPlatform(config)).toBe("netease");
|
||||
});
|
||||
|
||||
it("respects an explicit jellyfin-only enabledProviders from disk", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
// e.g. a config persisted by the short-lived jellyfin-by-default builds.
|
||||
writeFileSync(path, JSON.stringify({ enabledProviders: ["jellyfin"] }));
|
||||
const config = loadConfig(path);
|
||||
expect(config.enabledProviders).toEqual(["jellyfin"]);
|
||||
expect(defaultPlatform(config)).toBe("jellyfin");
|
||||
});
|
||||
|
||||
it("creates config file on save", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "sub", "config.json");
|
||||
@@ -49,6 +116,382 @@ describe("config", () => {
|
||||
// defaults should fill in the rest
|
||||
expect(loaded.theme).toBe("dark");
|
||||
expect(loaded.commandPrefix).toBe("!");
|
||||
expect(loaded.autoPauseOnEmpty).toBe(true);
|
||||
// auto-pause defaults OFF (occupancy detection is unreliable on some servers)
|
||||
expect(loaded.autoPauseOnEmpty).toBe(false);
|
||||
});
|
||||
|
||||
// --- #86: config.json must live under (and be created in) the persisted data dir ---
|
||||
|
||||
it("first run writes config.json into the data dir and reads it back", () => {
|
||||
const root = makeTmpDir();
|
||||
const dataDir = join(root, "data");
|
||||
const configPath = join(dataDir, "config.json"); // mirrors index.ts CONFIG_PATH
|
||||
|
||||
// Boot sequence: load (missing -> defaults) then save.
|
||||
const config = loadConfig(configPath);
|
||||
saveConfig(configPath, config);
|
||||
|
||||
expect(existsSync(configPath)).toBe(true);
|
||||
// A subsequent hand-edited file under the SAME persisted path is honored.
|
||||
writeFileSync(configPath, JSON.stringify({ webPort: 9999 }), "utf-8");
|
||||
expect(loadConfig(configPath).webPort).toBe(9999);
|
||||
});
|
||||
|
||||
it("migrates a legacy root config into the data dir, preserving values", () => {
|
||||
const root = makeTmpDir();
|
||||
const legacyPath = join(root, "config.json");
|
||||
const newPath = join(root, "data", "config.json");
|
||||
writeFileSync(legacyPath, JSON.stringify({ webPort: 4242, publicUrl: "http://x" }), "utf-8");
|
||||
|
||||
const migrated = migrateLegacyConfig(legacyPath, newPath);
|
||||
|
||||
expect(migrated).toBe(true);
|
||||
expect(existsSync(newPath)).toBe(true);
|
||||
expect(existsSync(legacyPath)).toBe(false); // legacy moved, not duplicated
|
||||
const loaded = loadConfig(newPath);
|
||||
expect(loaded.webPort).toBe(4242);
|
||||
expect(loaded.publicUrl).toBe("http://x");
|
||||
});
|
||||
|
||||
it("does NOT overwrite an existing data-dir config during migration", () => {
|
||||
const root = makeTmpDir();
|
||||
const legacyPath = join(root, "config.json");
|
||||
const newPath = join(root, "data", "config.json");
|
||||
writeFileSync(legacyPath, JSON.stringify({ webPort: 1111 }), "utf-8");
|
||||
saveConfig(newPath, { ...getDefaultConfig(), webPort: 2222 });
|
||||
|
||||
const migrated = migrateLegacyConfig(legacyPath, newPath);
|
||||
|
||||
expect(migrated).toBe(false); // new location wins, untouched
|
||||
expect(loadConfig(newPath).webPort).toBe(2222);
|
||||
expect(existsSync(legacyPath)).toBe(true); // legacy left intact when not migrated
|
||||
});
|
||||
|
||||
it("migration is a no-op when there is no legacy config", () => {
|
||||
const root = makeTmpDir();
|
||||
const migrated = migrateLegacyConfig(join(root, "config.json"), join(root, "data", "config.json"));
|
||||
expect(migrated).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("guestMode config", () => {
|
||||
it("defaults to disabled, all-bots, append-only", () => {
|
||||
const c = getDefaultConfig();
|
||||
expect(c.guestMode.enabled).toBe(false);
|
||||
expect(c.guestMode.bots).toBe("all");
|
||||
expect(c.guestMode.permissions).toEqual({
|
||||
addToQueue: true, playNext: false, playNow: false,
|
||||
skip: false, transport: false, removeClear: false, playMode: false,
|
||||
playCollection: false,
|
||||
});
|
||||
});
|
||||
|
||||
it("deep-merges a partial guestMode so missing sub-keys are back-filled", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-cfg-"));
|
||||
const p = join(dir, "config.json");
|
||||
writeFileSync(p, JSON.stringify({ guestMode: { enabled: true, permissions: { playNext: true } } }));
|
||||
const c = loadConfig(p);
|
||||
expect(c.guestMode.enabled).toBe(true);
|
||||
expect(c.guestMode.bots).toBe("all"); // back-filled
|
||||
expect(c.guestMode.permissions.playNext).toBe(true);
|
||||
expect(c.guestMode.permissions.addToQueue).toBe(true); // back-filled default
|
||||
expect(c.guestMode.permissions.skip).toBe(false); // back-filled default
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
// --- B1: loadConfig must sanitize a hand-edited/legacy/corrupt guestMode ---
|
||||
|
||||
function loadGuestMode(raw: unknown) {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-cfg-"));
|
||||
const p = join(dir, "config.json");
|
||||
writeFileSync(p, JSON.stringify(raw));
|
||||
try {
|
||||
return loadConfig(p).guestMode;
|
||||
} finally {
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
describe("bots normalization", () => {
|
||||
it("a numeric bots value falls back to the default \"all\" (no crash)", () => {
|
||||
const gm = loadGuestMode({ guestMode: { bots: 5 } });
|
||||
expect(gm.bots).toBe("all");
|
||||
});
|
||||
it("an array bots value is filtered to strings only", () => {
|
||||
const gm = loadGuestMode({ guestMode: { bots: ["a", 2, "b"] } });
|
||||
expect(gm.bots).toEqual(["a", "b"]);
|
||||
});
|
||||
it("the literal \"all\" is preserved", () => {
|
||||
const gm = loadGuestMode({ guestMode: { bots: "all" } });
|
||||
expect(gm.bots).toBe("all");
|
||||
});
|
||||
});
|
||||
|
||||
describe("permissions coercion", () => {
|
||||
it("a non-boolean truthy flag is coerced to false; a real true stays true", () => {
|
||||
const gm = loadGuestMode({ guestMode: { permissions: { skip: 1, playNext: true } } });
|
||||
expect(gm.permissions.skip).toBe(false);
|
||||
expect(gm.permissions.playNext).toBe(true);
|
||||
});
|
||||
it("a string permissions value yields defaults with no numeric index keys", () => {
|
||||
const gm = loadGuestMode({ guestMode: { permissions: "hacked" } });
|
||||
// all known flags present at their defaults
|
||||
expect(gm.permissions).toEqual({
|
||||
addToQueue: true, playNext: false, playNow: false,
|
||||
skip: false, transport: false, removeClear: false, playMode: false,
|
||||
playCollection: false,
|
||||
});
|
||||
// no garbage index keys leaked from spreading a string
|
||||
expect((gm.permissions as unknown as Record<string, unknown>)["0"]).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("adminGroups normalization", () => {
|
||||
function loadAdminGroups(raw: unknown) {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-cfg-"));
|
||||
const p = join(dir, "config.json");
|
||||
writeFileSync(p, JSON.stringify(raw));
|
||||
try {
|
||||
return loadConfig(p).adminGroups;
|
||||
} finally {
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
it("defaults to [] when absent", () => {
|
||||
expect(loadAdminGroups({})).toEqual([]);
|
||||
});
|
||||
it("keeps valid non-negative integers", () => {
|
||||
expect(loadAdminGroups({ adminGroups: [6, 8] })).toEqual([6, 8]);
|
||||
});
|
||||
it("filters out negatives, non-integers and non-numbers", () => {
|
||||
expect(loadAdminGroups({ adminGroups: [6, -1, 2.5, "8", null] })).toEqual([6]);
|
||||
});
|
||||
it("a non-array value falls back to the default [] (no crash)", () => {
|
||||
expect(loadAdminGroups({ adminGroups: "6" })).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("spotify config", () => {
|
||||
it("defaults are present and disabled", () => {
|
||||
const c = getDefaultConfig();
|
||||
expect(c.spotify).toEqual({
|
||||
enabled: false,
|
||||
backend: "auto",
|
||||
clientId: "",
|
||||
clientSecret: "",
|
||||
deviceName: "TSMusicBot",
|
||||
bitrate: 320,
|
||||
});
|
||||
});
|
||||
|
||||
it("loadConfig coerces bad spotify values back to safe defaults", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "cfg-"));
|
||||
const p = join(dir, "config.json");
|
||||
writeFileSync(
|
||||
p,
|
||||
JSON.stringify({
|
||||
spotify: { enabled: "yes", backend: "bogus", bitrate: 7, clientId: 5 },
|
||||
})
|
||||
);
|
||||
const c = loadConfig(p);
|
||||
expect(c.spotify.enabled).toBe(false); // non-boolean → false
|
||||
expect(c.spotify.backend).toBe("auto"); // invalid enum → auto
|
||||
expect(c.spotify.bitrate).toBe(320); // invalid → 320
|
||||
expect(c.spotify.clientId).toBe(""); // non-string → ""
|
||||
expect(c.spotify.deviceName).toBe("TSMusicBot"); // missing → default
|
||||
});
|
||||
|
||||
it("loadConfig preserves valid spotify values", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "cfg-"));
|
||||
const p = join(dir, "config.json");
|
||||
writeFileSync(
|
||||
p,
|
||||
JSON.stringify({
|
||||
spotify: {
|
||||
enabled: true,
|
||||
backend: "librespot",
|
||||
clientId: "abc",
|
||||
clientSecret: "def",
|
||||
deviceName: "MyBot",
|
||||
bitrate: 160,
|
||||
},
|
||||
})
|
||||
);
|
||||
const c = loadConfig(p);
|
||||
expect(c.spotify).toEqual({
|
||||
enabled: true,
|
||||
backend: "librespot",
|
||||
clientId: "abc",
|
||||
clientSecret: "def",
|
||||
deviceName: "MyBot",
|
||||
bitrate: 160,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// --- R2-1: saveConfig must write atomically (temp file + rename), never truncate ---
|
||||
|
||||
describe("saveConfig atomic write", () => {
|
||||
const dirs: string[] = [];
|
||||
function makeTmpDir(): string {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-atomic-"));
|
||||
dirs.push(dir);
|
||||
return dir;
|
||||
}
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks(); // reset call history, keep the call-through implementations
|
||||
});
|
||||
afterEach(() => {
|
||||
for (const d of dirs) rmSync(d, { recursive: true, force: true });
|
||||
dirs.length = 0;
|
||||
});
|
||||
|
||||
it("round-trips (save then load equals) and leaves NO .tmp file behind", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
const config = { ...getDefaultConfig(), webPort: 4567, adminPassword: "pw" };
|
||||
|
||||
saveConfig(path, config);
|
||||
|
||||
expect(loadConfig(path)).toEqual(config);
|
||||
// No temp remnants in the target directory.
|
||||
expect(readdirSync(dir).filter((f) => f.includes(".tmp"))).toEqual([]);
|
||||
});
|
||||
|
||||
it("writes via a same-dir temp file then renameSync onto the final path", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
|
||||
saveConfig(path, getDefaultConfig());
|
||||
|
||||
expect(vi.mocked(renameSync)).toHaveBeenCalled();
|
||||
const [from, to] = vi.mocked(renameSync).mock.calls[0] as [string, string];
|
||||
expect(to).toBe(path); // renamed ONTO the real path
|
||||
expect(String(from)).not.toBe(path); // ...from a distinct temp file
|
||||
expect(join(String(from), "..")).toBe(join(path, "..")); // ...in the SAME directory
|
||||
});
|
||||
|
||||
it("does not corrupt a pre-existing valid config when saving over it", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
saveConfig(path, { ...getDefaultConfig(), adminPassword: "first", webPort: 1234 });
|
||||
|
||||
// Overwrite with a different, fully-formed config.
|
||||
saveConfig(path, { ...getDefaultConfig(), adminPassword: "second", webPort: 9999 });
|
||||
|
||||
const loaded = loadConfig(path);
|
||||
expect(loaded.adminPassword).toBe("second");
|
||||
expect(loaded.webPort).toBe(9999);
|
||||
// The on-disk file is a single complete JSON document (no partial/truncated write).
|
||||
expect(() => JSON.parse(readFileSync(path, "utf-8"))).not.toThrow();
|
||||
expect(readdirSync(dir).filter((f) => f.includes(".tmp"))).toEqual([]);
|
||||
});
|
||||
|
||||
it("cleans up the temp file (no .tmp remnant) when the rename fails", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
vi.mocked(renameSync).mockImplementationOnce(() => {
|
||||
throw new Error("rename boom");
|
||||
});
|
||||
|
||||
expect(() => saveConfig(path, getDefaultConfig())).toThrow(/rename boom/);
|
||||
// The failed write left no temp file lying around.
|
||||
expect(readdirSync(dir).filter((f) => f.includes(".tmp"))).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
// --- R2-2: loadConfig must not treat a transient/corrupt read as "missing" ---
|
||||
|
||||
describe("loadConfig error handling", () => {
|
||||
const dirs: string[] = [];
|
||||
function makeTmpDir(): string {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-load-"));
|
||||
dirs.push(dir);
|
||||
return dir;
|
||||
}
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
afterEach(() => {
|
||||
for (const d of dirs) rmSync(d, { recursive: true, force: true });
|
||||
dirs.length = 0;
|
||||
});
|
||||
|
||||
it("(a) ENOENT (missing file) returns defaults — unchanged first-run behavior", () => {
|
||||
const dir = makeTmpDir();
|
||||
expect(loadConfig(join(dir, "config.json"))).toEqual(getDefaultConfig());
|
||||
});
|
||||
|
||||
it("(b) a non-ENOENT read error (EBUSY) rethrows instead of returning defaults", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
// A REAL config exists on disk; a transient lock must NOT collapse to defaults
|
||||
// (the caller would otherwise overwrite this real config with defaults).
|
||||
saveConfig(path, { ...getDefaultConfig(), adminPassword: "keep-me" });
|
||||
vi.mocked(readFileSync).mockImplementationOnce(() => {
|
||||
const err = new Error("EBUSY: resource busy or locked") as NodeJS.ErrnoException;
|
||||
err.code = "EBUSY";
|
||||
throw err;
|
||||
});
|
||||
|
||||
expect(() => loadConfig(path)).toThrow(/EBUSY/);
|
||||
// The on-disk config is untouched and still readable once the lock clears.
|
||||
expect(loadConfig(path).adminPassword).toBe("keep-me");
|
||||
});
|
||||
|
||||
it("(c) corrupt JSON returns defaults AND backs up the original to *.corrupt-*", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
const garbage = "{ not: valid json, ";
|
||||
writeFileSync(path, garbage, "utf-8");
|
||||
|
||||
const loaded = loadConfig(path);
|
||||
|
||||
expect(loaded).toEqual(getDefaultConfig());
|
||||
const backups = readdirSync(dir).filter((f) => f.includes(".corrupt-"));
|
||||
expect(backups.length).toBeGreaterThan(0);
|
||||
// The corrupt original is preserved verbatim (recoverable, never deleted).
|
||||
expect(readFileSync(join(dir, backups[0]), "utf-8")).toBe(garbage);
|
||||
});
|
||||
|
||||
// (d)/(e) Valid JSON that is NOT a non-null object (null / [] / 42 / "str") passes
|
||||
// JSON.parse but would throw a raw TypeError in the per-field sanitize block
|
||||
// (property access on a non-object), bypassing the corrupt-backup path. It must be
|
||||
// treated EXACTLY like corrupt JSON: back up to *.corrupt-* (original preserved),
|
||||
// return defaults — NOT a thrown TypeError, and NOT a silent defaults-with-no-backup.
|
||||
it("(d) a `null` config is treated as corrupt: defaults + *.corrupt-* backup (original preserved)", () => {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
writeFileSync(path, "null", "utf-8");
|
||||
|
||||
let loaded: ReturnType<typeof getDefaultConfig>;
|
||||
expect(() => {
|
||||
loaded = loadConfig(path);
|
||||
}).not.toThrow();
|
||||
|
||||
expect(loaded!).toEqual(getDefaultConfig());
|
||||
const backups = readdirSync(dir).filter((f) => f.includes(".corrupt-"));
|
||||
expect(backups.length).toBeGreaterThan(0);
|
||||
expect(readFileSync(join(dir, backups[0]), "utf-8")).toBe("null");
|
||||
});
|
||||
|
||||
it("(e) a non-object config (`[]` / `42`) is backed up + defaults, not a thrown TypeError", () => {
|
||||
for (const content of ["[]", "42"]) {
|
||||
const dir = makeTmpDir();
|
||||
const path = join(dir, "config.json");
|
||||
writeFileSync(path, content, "utf-8");
|
||||
|
||||
let loaded: ReturnType<typeof getDefaultConfig>;
|
||||
expect(() => {
|
||||
loaded = loadConfig(path);
|
||||
}).not.toThrow();
|
||||
|
||||
expect(loaded!).toEqual(getDefaultConfig());
|
||||
const backups = readdirSync(dir).filter((f) => f.includes(".corrupt-"));
|
||||
expect(backups.length).toBeGreaterThan(0);
|
||||
expect(readFileSync(join(dir, backups[0]), "utf-8")).toBe(content);
|
||||
}
|
||||
});
|
||||
});
|
||||
+334
-6
@@ -1,5 +1,80 @@
|
||||
import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
|
||||
import {
|
||||
readFileSync,
|
||||
writeFileSync,
|
||||
mkdirSync,
|
||||
existsSync,
|
||||
copyFileSync,
|
||||
rmSync,
|
||||
renameSync,
|
||||
} from "node:fs";
|
||||
import { dirname } from "node:path";
|
||||
import type { BotAccess, GuestPermissions } from "./permissions.js";
|
||||
import { GUEST_PERMISSION_FLAGS } from "./permissions.js";
|
||||
|
||||
export interface GuestModeConfig {
|
||||
enabled: boolean;
|
||||
bots: BotAccess; // "all" | string[]
|
||||
permissions: GuestPermissions;
|
||||
}
|
||||
|
||||
export interface SpotifyConfig {
|
||||
enabled: boolean;
|
||||
backend: "auto" | "go-librespot" | "librespot";
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
deviceName: string;
|
||||
bitrate: number;
|
||||
}
|
||||
|
||||
export interface JellyfinConfig {
|
||||
/** Base URL of the Jellyfin server, e.g. "https://jellyfin.example.com". */
|
||||
serverUrl: string;
|
||||
authMode: "userpass" | "apikey";
|
||||
// userpass mode
|
||||
username: string;
|
||||
password: string;
|
||||
// apikey mode: admin API key + the user whose library/favorites/playlists are used
|
||||
apiKey: string;
|
||||
userId: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Providers gated by `enabledProviders`. Not listed here:
|
||||
* - "local" → governed by the existing `localAudioEnabled` flag
|
||||
* - "spotify" → governed by the existing `spotify.enabled` flag
|
||||
*/
|
||||
export const GATEABLE_PROVIDERS = [
|
||||
"jellyfin",
|
||||
"netease",
|
||||
"qq",
|
||||
"bilibili",
|
||||
"youtube",
|
||||
"kugou",
|
||||
] as const;
|
||||
export type GateableProvider = (typeof GATEABLE_PROVIDERS)[number];
|
||||
|
||||
/** Whether a platform may be used for search/playback under the current config. */
|
||||
export function isProviderEnabled(config: BotConfig, platform: string): boolean {
|
||||
if (platform === "local") return config.localAudioEnabled !== false;
|
||||
if (platform === "spotify") return config.spotify.enabled;
|
||||
return config.enabledProviders.includes(platform as GateableProvider);
|
||||
}
|
||||
|
||||
/**
|
||||
* The default platform for !play/!add/!playlist/!album and all REST/WebUI calls:
|
||||
* the first enabled provider in a fixed priority order (netease with the default
|
||||
* config; jellyfin ranks after the online music platforms because it is an
|
||||
* opt-in source, but ahead of the video sites for users who run it as their
|
||||
* only music library). Falls back to "netease" when nothing is enabled so
|
||||
* callers always get a provider — the enabled-gate then produces the friendly
|
||||
* error.
|
||||
*/
|
||||
export function defaultPlatform(config: BotConfig): GateableProvider {
|
||||
for (const p of ["netease", "qq", "kugou", "jellyfin", "bilibili", "youtube"] as const) {
|
||||
if (config.enabledProviders.includes(p)) return p;
|
||||
}
|
||||
return "netease";
|
||||
}
|
||||
|
||||
export interface BotConfig {
|
||||
webPort: number;
|
||||
@@ -14,6 +89,8 @@ export interface BotConfig {
|
||||
autoReturnDelay: number;
|
||||
autoPauseOnEmpty: boolean;
|
||||
idleTimeoutMinutes: number;
|
||||
/** Enable uploading and playback of server-stored local audio files. */
|
||||
localAudioEnabled: boolean;
|
||||
// Public base URL used when generating share links (e.g. the bot专属链接).
|
||||
// Leave empty to use the browser's current origin. Example:
|
||||
// "https://music.example.com" or "http://1.2.3.4:3000"
|
||||
@@ -22,6 +99,17 @@ export interface BotConfig {
|
||||
// (nginx/Caddy/Cloudflare). Required for correct protocol/host detection
|
||||
// behind HTTPS-terminating proxies.
|
||||
trustProxy: boolean;
|
||||
guestMode: GuestModeConfig;
|
||||
spotify: SpotifyConfig;
|
||||
jellyfin: JellyfinConfig;
|
||||
/**
|
||||
* Which gateable providers are active (see GATEABLE_PROVIDERS). Default is
|
||||
* the online sources (NetEase/QQ/Bilibili/YouTube/Kugou); jellyfin is an
|
||||
* opt-in extra that must be listed here (Settings → Jellyfin 音乐库 toggles
|
||||
* it). Sources not listed stay disabled — the NetEase/QQ embedded sidecar
|
||||
* API servers must not start (or bind ports 3001/3200) unless enabled.
|
||||
*/
|
||||
enabledProviders: GateableProvider[];
|
||||
}
|
||||
|
||||
export function getDefaultConfig(): BotConfig {
|
||||
@@ -36,25 +124,265 @@ export function getDefaultConfig(): BotConfig {
|
||||
adminPassword: "",
|
||||
adminGroups: [],
|
||||
autoReturnDelay: 300,
|
||||
autoPauseOnEmpty: true,
|
||||
// Default OFF: occupancy detection relies on the full-client `clientlist`
|
||||
// command, which is unreliable on some servers (it can time out when other
|
||||
// clients are present). Users can opt in from the web UI.
|
||||
autoPauseOnEmpty: false,
|
||||
idleTimeoutMinutes: 0,
|
||||
localAudioEnabled: true,
|
||||
publicUrl: "",
|
||||
trustProxy: false,
|
||||
guestMode: {
|
||||
enabled: false,
|
||||
bots: "all",
|
||||
permissions: {
|
||||
addToQueue: true,
|
||||
playNext: false,
|
||||
playNow: false,
|
||||
skip: false,
|
||||
transport: false,
|
||||
removeClear: false,
|
||||
playMode: false,
|
||||
playCollection: false,
|
||||
},
|
||||
},
|
||||
spotify: {
|
||||
enabled: false,
|
||||
backend: "auto",
|
||||
clientId: "",
|
||||
clientSecret: "",
|
||||
deviceName: "TSMusicBot",
|
||||
bitrate: 320,
|
||||
},
|
||||
jellyfin: {
|
||||
serverUrl: "",
|
||||
authMode: "userpass",
|
||||
username: "",
|
||||
password: "",
|
||||
apiKey: "",
|
||||
userId: "",
|
||||
},
|
||||
enabledProviders: ["netease", "qq", "bilibili", "youtube", "kugou"],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Move an unusable config aside to a timestamped `*.corrupt-*` backup so the data
|
||||
* stays recoverable (it is NEVER deleted), for both the corrupt-JSON case and the
|
||||
* parses-but-not-an-object case. Prefer an atomic same-dir rename; if that fails,
|
||||
* copy instead. If it can't be preserved at all, rethrow rather than let the caller
|
||||
* overwrite unrecoverable data.
|
||||
*/
|
||||
function backupCorruptConfig(path: string): void {
|
||||
const backup = `${path}.corrupt-${Date.now()}`;
|
||||
try {
|
||||
renameSync(path, backup);
|
||||
} catch {
|
||||
try {
|
||||
copyFileSync(path, backup);
|
||||
} catch (backupErr) {
|
||||
throw backupErr;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function loadConfig(path: string): BotConfig {
|
||||
const defaults = getDefaultConfig();
|
||||
|
||||
// Distinguish the three failure modes so a *real* on-disk config is NEVER
|
||||
// silently replaced with defaults (the caller saveConfig()s right after load,
|
||||
// which would otherwise erase spotify creds / adminPassword / adminGroups /
|
||||
// guestMode permanently):
|
||||
// (a) file ABSENT (ENOENT) — normal first run → defaults.
|
||||
// (b) any OTHER read error (EBUSY/EACCES/EPERM/EISDIR/…) on an existing file —
|
||||
// rethrow (fail-fast at boot). A loud crash beats silent credential loss.
|
||||
// (c) file readable but JSON.parse fails (corrupt) — back the file up first
|
||||
// (never delete it), THEN return defaults so boot can proceed.
|
||||
let raw: string;
|
||||
try {
|
||||
const raw = readFileSync(path, "utf-8");
|
||||
const partial = JSON.parse(raw) as Partial<BotConfig>;
|
||||
return { ...defaults, ...partial };
|
||||
raw = readFileSync(path, "utf-8");
|
||||
} catch (err) {
|
||||
if ((err as NodeJS.ErrnoException).code === "ENOENT") {
|
||||
return defaults; // (a) missing file — first run
|
||||
}
|
||||
throw err; // (b) transient/permission error on an existing file — do not clobber it
|
||||
}
|
||||
|
||||
let parsed: unknown;
|
||||
try {
|
||||
parsed = JSON.parse(raw);
|
||||
} catch {
|
||||
// (c) Corrupt content: move the unreadable file aside to a timestamped backup
|
||||
// so the data stays recoverable, then fall back to defaults.
|
||||
backupCorruptConfig(path);
|
||||
return defaults;
|
||||
}
|
||||
|
||||
// (d) Parses cleanly but is NOT a non-null object (e.g. `null`, `42`, `"str"`,
|
||||
// `[]`). The per-field sanitize below assumes an object and would throw a raw
|
||||
// TypeError (or silently spread junk), bypassing the corrupt-backup path. Treat
|
||||
// it EXACTLY like corrupt JSON: back it up (never delete), then return defaults.
|
||||
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
|
||||
backupCorruptConfig(path);
|
||||
return defaults;
|
||||
}
|
||||
const partial = parsed as Partial<BotConfig>;
|
||||
|
||||
{
|
||||
// Normalize/sanitize guestMode on load. The WRITE path (POST /api/bot/settings)
|
||||
// sanitizes too, but a hand-edited/legacy/corrupt config.json reaches the gate
|
||||
// directly — so coerce it here as well, mirroring that write-path logic.
|
||||
const partialGm = (partial.guestMode ?? {}) as Partial<GuestModeConfig>;
|
||||
const gm: GuestModeConfig = {
|
||||
...defaults.guestMode,
|
||||
...partialGm,
|
||||
// bots → "all" | string[]; anything else falls back to the default ("all").
|
||||
bots:
|
||||
partialGm.bots === "all"
|
||||
? "all"
|
||||
: Array.isArray(partialGm.bots)
|
||||
? partialGm.bots.filter((id): id is string => typeof id === "string")
|
||||
: defaults.guestMode.bots,
|
||||
// permissions → defaults, then spread ONLY a plain object, then strict-coerce
|
||||
// each known flag to a boolean (drops index keys + non-boolean values).
|
||||
permissions: { ...defaults.guestMode.permissions },
|
||||
};
|
||||
const partialPerms = partialGm.permissions;
|
||||
if (
|
||||
partialPerms !== null &&
|
||||
typeof partialPerms === "object" &&
|
||||
!Array.isArray(partialPerms)
|
||||
) {
|
||||
Object.assign(gm.permissions, partialPerms);
|
||||
}
|
||||
for (const f of GUEST_PERMISSION_FLAGS) {
|
||||
gm.permissions[f] = gm.permissions[f] === true;
|
||||
}
|
||||
|
||||
// Sanitize adminGroups on load too: the WebUI write path filters it, but a
|
||||
// hand-edited / legacy / corrupt config.json reaches the command gate
|
||||
// directly. Keep only non-negative integers; a non-array falls back to the
|
||||
// default []. Mirrors the guestMode sanitization above.
|
||||
const adminGroups = Array.isArray(partial.adminGroups)
|
||||
? partial.adminGroups.filter(
|
||||
(g): g is number => typeof g === "number" && Number.isInteger(g) && g >= 0,
|
||||
)
|
||||
: defaults.adminGroups;
|
||||
|
||||
const partialSp = (partial.spotify ?? {}) as Partial<SpotifyConfig>;
|
||||
const validBackends = ["auto", "go-librespot", "librespot"] as const;
|
||||
const validBitrates = [96, 160, 320];
|
||||
const spotify: SpotifyConfig = {
|
||||
enabled: partialSp.enabled === true,
|
||||
backend: (validBackends as readonly string[]).includes(partialSp.backend as string)
|
||||
? (partialSp.backend as SpotifyConfig["backend"])
|
||||
: defaults.spotify.backend,
|
||||
clientId: typeof partialSp.clientId === "string" ? partialSp.clientId : defaults.spotify.clientId,
|
||||
clientSecret:
|
||||
typeof partialSp.clientSecret === "string" ? partialSp.clientSecret : defaults.spotify.clientSecret,
|
||||
deviceName:
|
||||
typeof partialSp.deviceName === "string" && partialSp.deviceName.trim()
|
||||
? partialSp.deviceName
|
||||
: defaults.spotify.deviceName,
|
||||
bitrate: validBitrates.includes(partialSp.bitrate as number)
|
||||
? (partialSp.bitrate as number)
|
||||
: defaults.spotify.bitrate,
|
||||
};
|
||||
|
||||
// Sanitize the jellyfin block on load, mirroring the spotify handling: a
|
||||
// hand-edited/legacy config.json must never smuggle wrong shapes past the
|
||||
// gate. Unknown/invalid sub-fields fall back to defaults.
|
||||
const partialJf = (partial.jellyfin ?? {}) as Partial<JellyfinConfig>;
|
||||
const jellyfin: JellyfinConfig = {
|
||||
serverUrl:
|
||||
typeof partialJf.serverUrl === "string"
|
||||
? partialJf.serverUrl.trim().replace(/\/+$/, "")
|
||||
: defaults.jellyfin.serverUrl,
|
||||
authMode:
|
||||
partialJf.authMode === "apikey" ? "apikey" : defaults.jellyfin.authMode,
|
||||
username:
|
||||
typeof partialJf.username === "string" ? partialJf.username : defaults.jellyfin.username,
|
||||
password:
|
||||
typeof partialJf.password === "string" ? partialJf.password : defaults.jellyfin.password,
|
||||
apiKey: typeof partialJf.apiKey === "string" ? partialJf.apiKey : defaults.jellyfin.apiKey,
|
||||
userId: typeof partialJf.userId === "string" ? partialJf.userId : defaults.jellyfin.userId,
|
||||
};
|
||||
|
||||
// enabledProviders → known providers only; a non-array falls back to the
|
||||
// default (online sources, jellyfin off). An explicitly-empty array is
|
||||
// respected (operator chose to disable every gateable source).
|
||||
const enabledProviders = Array.isArray(partial.enabledProviders)
|
||||
? partial.enabledProviders.filter((p): p is GateableProvider =>
|
||||
(GATEABLE_PROVIDERS as readonly string[]).includes(p as string),
|
||||
)
|
||||
: defaults.enabledProviders;
|
||||
|
||||
return {
|
||||
...defaults,
|
||||
...partial,
|
||||
adminGroups,
|
||||
guestMode: gm,
|
||||
spotify,
|
||||
jellyfin,
|
||||
enabledProviders,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
export function saveConfig(path: string, config: BotConfig): void {
|
||||
mkdirSync(dirname(path), { recursive: true });
|
||||
writeFileSync(path, JSON.stringify(config, null, 2), "utf-8");
|
||||
const json = JSON.stringify(config, null, 2);
|
||||
|
||||
// Atomic write: serialize to a sibling temp file in the SAME directory, then
|
||||
// rename it onto the final path. rename is an atomic replace on POSIX and modern
|
||||
// Windows, so a crash / power loss / ENOSPC mid-write can never leave config.json
|
||||
// truncated — a reader always sees either the previous file or the fully-written
|
||||
// new one, never a partial. The temp lives in the same dir so the rename stays on
|
||||
// one filesystem (a cross-device rename would fail); pid + timestamp keep
|
||||
// concurrent writers from colliding on the temp name.
|
||||
const tmp = `${path}.${process.pid}.${Date.now()}.tmp`;
|
||||
try {
|
||||
writeFileSync(tmp, json, "utf-8");
|
||||
renameSync(tmp, path);
|
||||
} catch (err) {
|
||||
// Never leave a partial temp file behind on failure.
|
||||
try {
|
||||
rmSync(tmp, { force: true });
|
||||
} catch {
|
||||
/* best-effort cleanup */
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* One-time migration for the config location fix (#86).
|
||||
*
|
||||
* Older versions wrote config.json to the app/repo ROOT, which is NOT inside the
|
||||
* persisted data directory (the Docker volume is mounted at data/). That meant the
|
||||
* file never landed in the volume on first run and a manually-placed data/config.json
|
||||
* was ignored. config.json now lives under the data dir alongside the DB/cookies/logs.
|
||||
*
|
||||
* If a legacy root-level config exists and the new data-dir config does not yet exist,
|
||||
* move it so existing local installs keep their customized settings. Best-effort:
|
||||
* any failure is swallowed and loadConfig falls back to defaults.
|
||||
*
|
||||
* @returns true if a legacy config was migrated, false otherwise.
|
||||
*/
|
||||
export function migrateLegacyConfig(legacyPath: string, newPath: string): boolean {
|
||||
try {
|
||||
if (legacyPath === newPath) return false;
|
||||
if (existsSync(newPath)) return false; // new location already populated — leave it
|
||||
if (!existsSync(legacyPath)) return false; // nothing to migrate
|
||||
mkdirSync(dirname(newPath), { recursive: true });
|
||||
copyFileSync(legacyPath, newPath); // copy first (works across filesystems)
|
||||
try {
|
||||
rmSync(legacyPath);
|
||||
} catch {
|
||||
/* leave the legacy file if it can't be removed; the new one wins */
|
||||
}
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,9 @@
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
||||
import { createDatabase, type BotDatabase, type BotInstance, type PlayHistoryEntry } from "./database.js";
|
||||
import { createUserStore, GUEST_USER_ID } from "./users.js";
|
||||
|
||||
describe("database", () => {
|
||||
let botDb: BotDatabase;
|
||||
@@ -23,6 +27,30 @@ describe("database", () => {
|
||||
expect(names).toContain("bot_instances");
|
||||
});
|
||||
|
||||
it("creates users and sessions tables on init", () => {
|
||||
const tables = botDb.db
|
||||
.prepare("SELECT name FROM sqlite_master WHERE type='table' ORDER BY name")
|
||||
.all() as Array<{ name: string }>;
|
||||
const names = tables.map((t) => t.name);
|
||||
expect(names).toContain("users");
|
||||
expect(names).toContain("sessions");
|
||||
|
||||
const userCols = botDb.db.prepare("PRAGMA table_info(users)").all() as Array<{ name: string }>;
|
||||
const userColNames = userCols.map((c) => c.name).sort();
|
||||
expect(userColNames).toEqual(["createdAt", "id", "passwordHash", "role", "updatedAt", "username"]);
|
||||
|
||||
const sessionCols = botDb.db.prepare("PRAGMA table_info(sessions)").all() as Array<{ name: string }>;
|
||||
const sessionColNames = sessionCols.map((c) => c.name).sort();
|
||||
expect(sessionColNames).toEqual(["createdAt", "expiresAt", "id", "lastSeenAt", "userId"]);
|
||||
});
|
||||
|
||||
it("creates user_audit table on init", () => {
|
||||
const tables = botDb.db
|
||||
.prepare("SELECT name FROM sqlite_master WHERE type='table' ORDER BY name")
|
||||
.all() as Array<{ name: string }>;
|
||||
expect(tables.map((t) => t.name)).toContain("user_audit");
|
||||
});
|
||||
|
||||
it("records and retrieves play history", () => {
|
||||
botDb.addPlayHistory({
|
||||
botId: "bot1",
|
||||
@@ -32,6 +60,7 @@ describe("database", () => {
|
||||
album: "Test Album",
|
||||
platform: "netease",
|
||||
coverUrl: "https://example.com/cover.jpg",
|
||||
requestedBy: "alice",
|
||||
});
|
||||
|
||||
botDb.addPlayHistory({
|
||||
@@ -48,6 +77,7 @@ describe("database", () => {
|
||||
expect(history).toHaveLength(2);
|
||||
expect(history[0].songName).toBe("Another Song");
|
||||
expect(history[1].songName).toBe("Test Song");
|
||||
expect(history[1].requestedBy).toBe("alice");
|
||||
});
|
||||
|
||||
it("saves and loads bot instances", () => {
|
||||
@@ -58,6 +88,7 @@ describe("database", () => {
|
||||
serverPort: 9987,
|
||||
nickname: "MusicBot",
|
||||
defaultChannel: "Music",
|
||||
channelId: "",
|
||||
channelPassword: "",
|
||||
autoStart: true,
|
||||
serverProtocol: "",
|
||||
@@ -87,6 +118,7 @@ describe("database", () => {
|
||||
serverPort: 9987,
|
||||
nickname: "MusicBot",
|
||||
defaultChannel: "Music",
|
||||
channelId: "",
|
||||
channelPassword: "",
|
||||
autoStart: false,
|
||||
serverProtocol: "",
|
||||
@@ -98,4 +130,52 @@ describe("database", () => {
|
||||
expect(botDb.getBotInstances()).toHaveLength(0);
|
||||
expect(botDb.deleteBotInstance("nonexistent")).toBe(false);
|
||||
});
|
||||
|
||||
it("persists and clears customAvatarPath on a bot instance", () => {
|
||||
const inst = {
|
||||
id: "bot-1",
|
||||
name: "B",
|
||||
serverAddress: "x",
|
||||
serverPort: 9987,
|
||||
nickname: "n",
|
||||
defaultChannel: "",
|
||||
channelId: "",
|
||||
channelPassword: "",
|
||||
autoStart: false,
|
||||
serverProtocol: "",
|
||||
ts6ApiKey: "",
|
||||
serverPassword: "",
|
||||
};
|
||||
botDb.saveBotInstance(inst);
|
||||
expect(botDb.getCustomAvatarPath("bot-1")).toBeNull();
|
||||
botDb.setCustomAvatarPath("bot-1", "avatars/bot-1.png");
|
||||
expect(botDb.getCustomAvatarPath("bot-1")).toBe("avatars/bot-1.png");
|
||||
botDb.setCustomAvatarPath("bot-1", null);
|
||||
expect(botDb.getCustomAvatarPath("bot-1")).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("guest principal migration", () => {
|
||||
it("creates exactly one reserved guest row, idempotently", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-db-"));
|
||||
const p = join(dir, "t.db");
|
||||
const a = createDatabase(p); a.db.close();
|
||||
const b = createDatabase(p); // run again — must not duplicate
|
||||
const row = b.db.prepare("SELECT id, role FROM users WHERE id = ?").get(GUEST_USER_ID) as { id: string; role: string } | undefined;
|
||||
expect(row?.role).toBe("guest");
|
||||
const n = (b.db.prepare("SELECT COUNT(*) AS n FROM users WHERE role='guest'").get() as { n: number }).n;
|
||||
expect(n).toBe(1);
|
||||
b.db.close();
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("guest row does not break first-run detection (countUsers excludes it)", () => {
|
||||
const dir = mkdtempSync(join(tmpdir(), "tsmb-db2-"));
|
||||
const p = join(dir, "t.db");
|
||||
const d = createDatabase(p);
|
||||
const users = createUserStore(d.db);
|
||||
expect(users.countUsers()).toBe(0); // guest excluded → still needs setup
|
||||
d.db.close();
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
});
|
||||
});
|
||||
+196
-6
@@ -1,4 +1,6 @@
|
||||
import Database from "better-sqlite3";
|
||||
import { CAPABILITIES, BOTS_ALL } from "./permissions.js";
|
||||
import { GUEST_USER_ID, GUEST_USERNAME } from "./users.js";
|
||||
|
||||
export interface PlayHistoryEntry {
|
||||
botId: string;
|
||||
@@ -6,8 +8,9 @@ export interface PlayHistoryEntry {
|
||||
songName: string;
|
||||
artist: string;
|
||||
album: string;
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube" | "local" | "kugou" | "spotify" | "jellyfin";
|
||||
coverUrl: string;
|
||||
requestedBy?: string;
|
||||
}
|
||||
|
||||
export interface PlayHistoryRecord extends PlayHistoryEntry {
|
||||
@@ -22,6 +25,7 @@ export interface BotInstance {
|
||||
serverPort: number;
|
||||
nickname: string;
|
||||
defaultChannel: string;
|
||||
channelId: string;
|
||||
channelPassword: string;
|
||||
autoStart: boolean;
|
||||
/** "ts3" | "ts6" | "" (empty = auto-detect) */
|
||||
@@ -51,6 +55,17 @@ export const DEFAULT_PROFILE_CONFIG: ProfileConfig = {
|
||||
nowPlayingMsgEnabled: true,
|
||||
};
|
||||
|
||||
export interface FavoritePlaylist {
|
||||
id: number;
|
||||
userId: string;
|
||||
platform: string;
|
||||
playlistId: string;
|
||||
name: string;
|
||||
coverUrl: string;
|
||||
songCount: number;
|
||||
createdAt: string;
|
||||
}
|
||||
|
||||
export interface BotDatabase {
|
||||
db: Database.Database;
|
||||
addPlayHistory(entry: PlayHistoryEntry): void;
|
||||
@@ -60,6 +75,12 @@ export interface BotDatabase {
|
||||
deleteBotInstance(id: string): boolean;
|
||||
getProfileConfig(botId: string): ProfileConfig;
|
||||
saveProfileConfig(botId: string, config: ProfileConfig): void;
|
||||
getCustomAvatarPath(botId: string): string | null;
|
||||
setCustomAvatarPath(botId: string, path: string | null): void;
|
||||
addFavorite(userId: string, playlist: { platform: string; playlistId: string; name: string; coverUrl: string; songCount: number }): void;
|
||||
removeFavorite(userId: string, playlistId: string, platform: string): boolean;
|
||||
getFavorites(userId: string): FavoritePlaylist[];
|
||||
isFavorited(userId: string, playlistId: string, platform: string): boolean;
|
||||
close(): void;
|
||||
}
|
||||
|
||||
@@ -78,6 +99,9 @@ function migrateSchema(db: Database.Database): void {
|
||||
if (!names.includes("serverPassword")) {
|
||||
db.exec("ALTER TABLE bot_instances ADD COLUMN serverPassword TEXT NOT NULL DEFAULT ''");
|
||||
}
|
||||
if (!names.includes("channelId")) {
|
||||
db.exec("ALTER TABLE bot_instances ADD COLUMN channelId TEXT NOT NULL DEFAULT ''");
|
||||
}
|
||||
// Profile feature flags
|
||||
const profileCols = [
|
||||
"profile_avatar_enabled",
|
||||
@@ -92,6 +116,21 @@ function migrateSchema(db: Database.Database): void {
|
||||
db.exec(`ALTER TABLE bot_instances ADD COLUMN ${col} INTEGER NOT NULL DEFAULT 1`);
|
||||
}
|
||||
}
|
||||
if (!names.includes("custom_avatar_path")) {
|
||||
db.exec("ALTER TABLE bot_instances ADD COLUMN custom_avatar_path TEXT");
|
||||
}
|
||||
|
||||
const userColumns = db.prepare("PRAGMA table_info(users)").all() as Array<{ name: string }>;
|
||||
const userColNames = userColumns.map((c) => c.name);
|
||||
if (!userColNames.includes("role")) {
|
||||
db.exec("ALTER TABLE users ADD COLUMN role TEXT NOT NULL DEFAULT 'admin'");
|
||||
}
|
||||
|
||||
const historyColumns = db.prepare("PRAGMA table_info(play_history)").all() as Array<{ name: string }>;
|
||||
const historyColNames = historyColumns.map((c) => c.name);
|
||||
if (!historyColNames.includes("requestedBy")) {
|
||||
db.exec("ALTER TABLE play_history ADD COLUMN requestedBy TEXT NOT NULL DEFAULT ''");
|
||||
}
|
||||
}
|
||||
|
||||
function initTables(db: Database.Database): void {
|
||||
@@ -105,6 +144,7 @@ function initTables(db: Database.Database): void {
|
||||
album TEXT NOT NULL,
|
||||
platform TEXT NOT NULL,
|
||||
coverUrl TEXT NOT NULL,
|
||||
requestedBy TEXT NOT NULL DEFAULT '',
|
||||
playedAt TEXT NOT NULL DEFAULT (datetime('now'))
|
||||
);
|
||||
|
||||
@@ -115,6 +155,7 @@ function initTables(db: Database.Database): void {
|
||||
serverPort INTEGER NOT NULL,
|
||||
nickname TEXT NOT NULL,
|
||||
defaultChannel TEXT NOT NULL,
|
||||
channelId TEXT NOT NULL DEFAULT '',
|
||||
channelPassword TEXT NOT NULL,
|
||||
autoStart INTEGER NOT NULL DEFAULT 0,
|
||||
serverProtocol TEXT NOT NULL DEFAULT '',
|
||||
@@ -122,18 +163,118 @@ function initTables(db: Database.Database): void {
|
||||
serverPassword TEXT NOT NULL DEFAULT '',
|
||||
identity TEXT
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS users (
|
||||
id TEXT PRIMARY KEY,
|
||||
username TEXT NOT NULL UNIQUE COLLATE NOCASE,
|
||||
passwordHash TEXT NOT NULL,
|
||||
createdAt INTEGER NOT NULL,
|
||||
updatedAt INTEGER NOT NULL,
|
||||
role TEXT NOT NULL DEFAULT 'admin'
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS sessions (
|
||||
id TEXT PRIMARY KEY,
|
||||
userId TEXT NOT NULL,
|
||||
createdAt INTEGER NOT NULL,
|
||||
expiresAt INTEGER NOT NULL,
|
||||
lastSeenAt INTEGER NOT NULL,
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_sessions_userId ON sessions(userId);
|
||||
CREATE INDEX IF NOT EXISTS idx_sessions_expiresAt ON sessions(expiresAt);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS user_audit (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
timestamp INTEGER NOT NULL,
|
||||
actorId TEXT,
|
||||
actorUsername TEXT,
|
||||
targetUserId TEXT,
|
||||
targetUsername TEXT,
|
||||
action TEXT NOT NULL
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_user_audit_timestamp ON user_audit(timestamp DESC);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS favorite_playlists (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
userId TEXT NOT NULL,
|
||||
platform TEXT NOT NULL,
|
||||
playlistId TEXT NOT NULL,
|
||||
name TEXT NOT NULL,
|
||||
coverUrl TEXT NOT NULL DEFAULT '',
|
||||
songCount INTEGER NOT NULL DEFAULT 0,
|
||||
createdAt TEXT NOT NULL DEFAULT (datetime('now')),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE,
|
||||
UNIQUE(userId, platform, playlistId)
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_favorites_userId ON favorite_playlists(userId);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS user_permissions (
|
||||
userId TEXT NOT NULL,
|
||||
permission TEXT NOT NULL,
|
||||
PRIMARY KEY (userId, permission),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE TABLE IF NOT EXISTS user_bot_access (
|
||||
userId TEXT NOT NULL,
|
||||
botId TEXT NOT NULL,
|
||||
PRIMARY KEY (userId, botId),
|
||||
FOREIGN KEY (userId) REFERENCES users(id) ON DELETE CASCADE
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_user_bot_access_userId ON user_bot_access(userId);
|
||||
`);
|
||||
}
|
||||
|
||||
/**
|
||||
* One-time backfill: existing `member` users created before the
|
||||
* account-permissions feature are granted full access (all 5 capabilities +
|
||||
* the `bots.all` marker), exactly once per database. Admins are skipped (they
|
||||
* bypass permission checks). New members created after this runs are not
|
||||
* affected — they get the basic tier via POST /api/users. A marker row in
|
||||
* `schema_meta` makes this idempotent.
|
||||
*/
|
||||
export function backfillMemberPermissions(db: Database.Database): void {
|
||||
db.exec(`CREATE TABLE IF NOT EXISTS schema_meta (key TEXT PRIMARY KEY, value TEXT)`);
|
||||
const done = db.prepare("SELECT value FROM schema_meta WHERE key = 'perm_backfill_done'").get();
|
||||
if (done) return;
|
||||
const members = db.prepare("SELECT id FROM users WHERE role = 'member'").all() as { id: string }[];
|
||||
const insCap = db.prepare("INSERT OR IGNORE INTO user_permissions (userId, permission) VALUES (?, ?)");
|
||||
const tokens = [...CAPABILITIES, BOTS_ALL];
|
||||
const tx = db.transaction(() => {
|
||||
for (const m of members) {
|
||||
for (const t of tokens) insCap.run(m.id, t);
|
||||
}
|
||||
db.prepare("INSERT INTO schema_meta (key, value) VALUES ('perm_backfill_done', ?)").run(String(members.length));
|
||||
});
|
||||
tx();
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensure the reserved guest principal exists. Idempotent via the PK on
|
||||
* `users.id`. This row only backs login-less guest sessions; it is excluded
|
||||
* from countUsers()/listUsers() so it never interferes with first-run setup
|
||||
* or the user-management UI, and holds an unusable password hash.
|
||||
*/
|
||||
export function ensureGuestUser(db: Database.Database): void {
|
||||
const now = Date.now();
|
||||
db.prepare(
|
||||
"INSERT OR IGNORE INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES (?, ?, '!', ?, ?, 'guest')"
|
||||
).run(GUEST_USER_ID, GUEST_USERNAME, now, now);
|
||||
}
|
||||
|
||||
export function createDatabase(dbPath: string): BotDatabase {
|
||||
const db = new Database(dbPath);
|
||||
db.pragma("journal_mode = WAL");
|
||||
db.pragma("foreign_keys = ON");
|
||||
initTables(db);
|
||||
migrateSchema(db);
|
||||
backfillMemberPermissions(db);
|
||||
ensureGuestUser(db);
|
||||
|
||||
const insertHistory = db.prepare(`
|
||||
INSERT INTO play_history (botId, songId, songName, artist, album, platform, coverUrl)
|
||||
VALUES (@botId, @songId, @songName, @artist, @album, @platform, @coverUrl)
|
||||
INSERT INTO play_history (botId, songId, songName, artist, album, platform, coverUrl, requestedBy)
|
||||
VALUES (@botId, @songId, @songName, @artist, @album, @platform, @coverUrl, @requestedBy)
|
||||
`);
|
||||
|
||||
const selectHistory = db.prepare(`
|
||||
@@ -141,14 +282,15 @@ export function createDatabase(dbPath: string): BotDatabase {
|
||||
`);
|
||||
|
||||
const upsertInstance = db.prepare(`
|
||||
INSERT INTO bot_instances (id, name, serverAddress, serverPort, nickname, defaultChannel, channelPassword, autoStart, serverProtocol, ts6ApiKey, serverPassword, identity)
|
||||
VALUES (@id, @name, @serverAddress, @serverPort, @nickname, @defaultChannel, @channelPassword, @autoStart, @serverProtocol, @ts6ApiKey, @serverPassword, @identity)
|
||||
INSERT INTO bot_instances (id, name, serverAddress, serverPort, nickname, defaultChannel, channelId, channelPassword, autoStart, serverProtocol, ts6ApiKey, serverPassword, identity)
|
||||
VALUES (@id, @name, @serverAddress, @serverPort, @nickname, @defaultChannel, @channelId, @channelPassword, @autoStart, @serverProtocol, @ts6ApiKey, @serverPassword, @identity)
|
||||
ON CONFLICT(id) DO UPDATE SET
|
||||
name = excluded.name,
|
||||
serverAddress = excluded.serverAddress,
|
||||
serverPort = excluded.serverPort,
|
||||
nickname = excluded.nickname,
|
||||
defaultChannel = excluded.defaultChannel,
|
||||
channelId = excluded.channelId,
|
||||
channelPassword = excluded.channelPassword,
|
||||
autoStart = excluded.autoStart,
|
||||
serverProtocol = excluded.serverProtocol,
|
||||
@@ -179,11 +321,32 @@ export function createDatabase(dbPath: string): BotDatabase {
|
||||
WHERE id = @id
|
||||
`);
|
||||
|
||||
const selectCustomAvatar = db.prepare(`SELECT custom_avatar_path FROM bot_instances WHERE id = ?`);
|
||||
const updateCustomAvatar = db.prepare(`UPDATE bot_instances SET custom_avatar_path = ? WHERE id = ?`);
|
||||
|
||||
const insertFavorite = db.prepare(`
|
||||
INSERT INTO favorite_playlists (userId, platform, playlistId, name, coverUrl, songCount)
|
||||
VALUES (@userId, @platform, @playlistId, @name, @coverUrl, @songCount)
|
||||
`);
|
||||
|
||||
const deleteFavorite = db.prepare(`
|
||||
DELETE FROM favorite_playlists WHERE userId = ? AND playlistId = ? AND platform = ?
|
||||
`);
|
||||
|
||||
const selectFavorites = db.prepare(`
|
||||
SELECT id, userId, platform, playlistId, name, coverUrl, songCount, createdAt
|
||||
FROM favorite_playlists WHERE userId = ? ORDER BY createdAt DESC
|
||||
`);
|
||||
|
||||
const checkFavorited = db.prepare(`
|
||||
SELECT 1 FROM favorite_playlists WHERE userId = ? AND playlistId = ? AND platform = ?
|
||||
`);
|
||||
|
||||
return {
|
||||
db,
|
||||
|
||||
addPlayHistory(record) {
|
||||
insertHistory.run(record);
|
||||
insertHistory.run({ ...record, requestedBy: record.requestedBy ?? "" });
|
||||
},
|
||||
|
||||
getPlayHistory(botId, limit) {
|
||||
@@ -208,6 +371,7 @@ export function createDatabase(dbPath: string): BotDatabase {
|
||||
serverProtocol: r.serverProtocol ?? "",
|
||||
ts6ApiKey: r.ts6ApiKey ?? "",
|
||||
serverPassword: r.serverPassword ?? "",
|
||||
channelId: r.channelId ?? "",
|
||||
identity: r.identity ?? undefined,
|
||||
}));
|
||||
},
|
||||
@@ -242,6 +406,32 @@ export function createDatabase(dbPath: string): BotDatabase {
|
||||
});
|
||||
},
|
||||
|
||||
getCustomAvatarPath(botId) {
|
||||
const row = selectCustomAvatar.get(botId) as { custom_avatar_path: string | null } | undefined;
|
||||
return row?.custom_avatar_path ?? null;
|
||||
},
|
||||
setCustomAvatarPath(botId, path) {
|
||||
updateCustomAvatar.run(path, botId);
|
||||
},
|
||||
|
||||
addFavorite(userId, playlist) {
|
||||
insertFavorite.run({ userId, ...playlist });
|
||||
},
|
||||
|
||||
removeFavorite(userId, playlistId, platform) {
|
||||
const result = deleteFavorite.run(userId, playlistId, platform);
|
||||
return result.changes > 0;
|
||||
},
|
||||
|
||||
getFavorites(userId) {
|
||||
return selectFavorites.all(userId) as FavoritePlaylist[];
|
||||
},
|
||||
|
||||
isFavorited(userId, playlistId, platform) {
|
||||
const row = checkFavorited.get(userId, playlistId, platform);
|
||||
return row !== undefined;
|
||||
},
|
||||
|
||||
close() {
|
||||
db.close();
|
||||
},
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
import { describe, it, expect, afterEach } from "vitest";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import os from "node:os";
|
||||
import { createDatabase, backfillMemberPermissions, type BotDatabase } from "./database.js";
|
||||
import { createPermissionStore, CAPABILITIES } from "./permissions.js";
|
||||
|
||||
describe("backfillMemberPermissions", () => {
|
||||
let dbFile: string;
|
||||
let db: BotDatabase;
|
||||
function fresh() {
|
||||
dbFile = path.join(os.tmpdir(), `mig-${Date.now()}-${Math.random().toString(36).slice(2)}.db`);
|
||||
db = createDatabase(dbFile);
|
||||
}
|
||||
afterEach(() => {
|
||||
db.close();
|
||||
for (const s of ["", "-wal", "-shm"]) {
|
||||
try {
|
||||
fs.rmSync(dbFile + s, { force: true });
|
||||
} catch {}
|
||||
}
|
||||
});
|
||||
|
||||
it("grants existing members full access + bots.all, skips admins, once", () => {
|
||||
fresh();
|
||||
// simulate a pre-feature DB: clear the marker that createDatabase set, add users, no perm rows
|
||||
db.db.prepare("DELETE FROM schema_meta WHERE key = 'perm_backfill_done'").run();
|
||||
const now = Date.now();
|
||||
const ins = db.db.prepare(
|
||||
"INSERT INTO users (id,username,passwordHash,createdAt,updatedAt,role) VALUES (?,?,?,?,?,?)"
|
||||
);
|
||||
ins.run("m1", "mem", "x", now, now, "member");
|
||||
ins.run("a1", "adm", "x", now, now, "admin");
|
||||
|
||||
backfillMemberPermissions(db.db);
|
||||
|
||||
const store = createPermissionStore(db.db);
|
||||
expect(store.getCapabilities("m1").sort()).toEqual([...CAPABILITIES].sort());
|
||||
expect(store.getBotAccess("m1")).toBe("all");
|
||||
expect(store.getCapabilities("a1")).toEqual([]);
|
||||
expect(store.getBotAccess("a1")).toEqual([]);
|
||||
});
|
||||
|
||||
it("is idempotent — running again does not change or re-grant", () => {
|
||||
fresh();
|
||||
db.db.prepare("DELETE FROM schema_meta WHERE key = 'perm_backfill_done'").run();
|
||||
const now = Date.now();
|
||||
db.db
|
||||
.prepare("INSERT INTO users (id,username,passwordHash,createdAt,updatedAt,role) VALUES (?,?,?,?,?,?)")
|
||||
.run("m1", "mem", "x", now, now, "member");
|
||||
backfillMemberPermissions(db.db);
|
||||
// member restricted afterwards
|
||||
createPermissionStore(db.db).setPermissions("m1", { capabilities: [], bots: [] });
|
||||
// second run must NOT re-grant (marker present)
|
||||
backfillMemberPermissions(db.db);
|
||||
expect(createPermissionStore(db.db).getCapabilities("m1")).toEqual([]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,135 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import os from "node:os";
|
||||
import { createDatabase, type BotDatabase } from "./database.js";
|
||||
import { createPermissionStore } from "./permissions.js";
|
||||
import { CAPABILITIES, BASIC_TIER_CAPABILITIES, resolvePermissionContext } from "./permissions.js";
|
||||
|
||||
describe("PermissionStore", () => {
|
||||
let dbFile: string;
|
||||
let db: BotDatabase;
|
||||
|
||||
beforeEach(() => {
|
||||
dbFile = path.join(os.tmpdir(), `perm-test-${Date.now()}-${Math.random().toString(36).slice(2)}.db`);
|
||||
db = createDatabase(dbFile);
|
||||
db.db.prepare(
|
||||
"INSERT INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES (?,?,?,?,?,?)"
|
||||
).run("u1", "alice", "x", Date.now(), Date.now(), "member");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
db.close();
|
||||
try { fs.rmSync(dbFile, { force: true }); } catch {}
|
||||
try { fs.rmSync(dbFile + "-wal", { force: true }); } catch {}
|
||||
try { fs.rmSync(dbFile + "-shm", { force: true }); } catch {}
|
||||
});
|
||||
|
||||
it("exposes the five capability tokens and a basic tier", () => {
|
||||
expect(CAPABILITIES).toEqual([
|
||||
"player.control", "player.queue", "bot.manage", "platform.auth", "quality",
|
||||
]);
|
||||
expect(BASIC_TIER_CAPABILITIES).toEqual(["player.control", "player.queue"]);
|
||||
});
|
||||
|
||||
it("defaults to no capabilities and no bots", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
expect(store.getCapabilities("u1")).toEqual([]);
|
||||
expect(store.getBotAccess("u1")).toEqual([]);
|
||||
});
|
||||
|
||||
it("round-trips capabilities and a specific bot list", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control", "quality"], bots: ["botA", "botB"] });
|
||||
expect(store.getCapabilities("u1").sort()).toEqual(["player.control", "quality"]);
|
||||
expect(store.getBotAccess("u1")).toEqual(["botA", "botB"]);
|
||||
});
|
||||
|
||||
it("stores the all-bots flag as 'all'", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control"], bots: "all" });
|
||||
expect(store.getBotAccess("u1")).toBe("all");
|
||||
});
|
||||
|
||||
it("setPermissions replaces prior capabilities and bots", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control"], bots: ["botA"] });
|
||||
store.setPermissions("u1", { capabilities: ["quality"], bots: "all" });
|
||||
expect(store.getCapabilities("u1")).toEqual(["quality"]);
|
||||
expect(store.getBotAccess("u1")).toBe("all");
|
||||
});
|
||||
|
||||
it("ignores unknown capability tokens", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control", "bogus" as any], bots: [] });
|
||||
expect(store.getCapabilities("u1")).toEqual(["player.control"]);
|
||||
});
|
||||
|
||||
it("pruneBot removes a bot from every user's allow-list", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: [], bots: ["botA", "botB"] });
|
||||
store.pruneBot("botA");
|
||||
expect(store.getBotAccess("u1")).toEqual(["botB"]);
|
||||
});
|
||||
|
||||
describe("resolvePermissionContext", () => {
|
||||
it("admin gets all capabilities and all bots regardless of stored rows", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
const ctx = resolvePermissionContext("admin", "u1", store);
|
||||
expect([...ctx.capabilities].sort()).toEqual([...CAPABILITIES].sort());
|
||||
expect(ctx.bots).toBe("all");
|
||||
});
|
||||
it("member reflects stored capabilities + bot access", () => {
|
||||
const store = createPermissionStore(db.db);
|
||||
store.setPermissions("u1", { capabilities: ["player.control"], bots: ["b1"] });
|
||||
const ctx = resolvePermissionContext("member", "u1", store);
|
||||
expect([...ctx.capabilities]).toEqual(["player.control"]);
|
||||
expect(ctx.bots).toEqual(new Set(["b1"]));
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
import { GUEST_PERMISSION_FLAGS } from "./permissions.js";
|
||||
|
||||
describe("resolvePermissionContext guest branch", () => {
|
||||
const noStore = {
|
||||
getCapabilities: () => [],
|
||||
getBotAccess: () => [] as string[],
|
||||
setPermissions: () => {},
|
||||
pruneBot: () => {},
|
||||
};
|
||||
|
||||
it("guest has no member capabilities and exposes the guest permissions + bots", () => {
|
||||
const ctx = resolvePermissionContext("guest", "__guest__", noStore, {
|
||||
bots: ["bot1"],
|
||||
permissions: {
|
||||
addToQueue: true, playNext: false, playNow: false,
|
||||
skip: true, transport: false, removeClear: false, playMode: false,
|
||||
playCollection: false,
|
||||
},
|
||||
});
|
||||
expect([...ctx.capabilities]).toEqual([]);
|
||||
expect(ctx.bots).toBeInstanceOf(Set);
|
||||
expect((ctx.bots as Set<string>).has("bot1")).toBe(true);
|
||||
expect(ctx.guest?.addToQueue).toBe(true);
|
||||
expect(ctx.guest?.skip).toBe(true);
|
||||
});
|
||||
|
||||
it("guest with bots:'all' resolves to 'all'", () => {
|
||||
const ctx = resolvePermissionContext("guest", "__guest__", noStore, {
|
||||
bots: "all",
|
||||
permissions: {
|
||||
addToQueue: true, playNext: false, playNow: false,
|
||||
skip: false, transport: false, removeClear: false, playMode: false,
|
||||
playCollection: false,
|
||||
},
|
||||
});
|
||||
expect(ctx.bots).toBe("all");
|
||||
});
|
||||
|
||||
it("exposes the 8 canonical flags", () => {
|
||||
expect([...GUEST_PERMISSION_FLAGS].sort()).toEqual(
|
||||
["addToQueue", "playCollection", "playMode", "playNext", "playNow", "removeClear", "skip", "transport"].sort()
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,123 @@
|
||||
import type Database from "better-sqlite3";
|
||||
|
||||
export const CAPABILITIES = [
|
||||
"player.control",
|
||||
"player.queue",
|
||||
"bot.manage",
|
||||
"platform.auth",
|
||||
"quality",
|
||||
] as const;
|
||||
export type Capability = (typeof CAPABILITIES)[number];
|
||||
|
||||
/** Marker token stored in user_permissions meaning "all bots, incl. future". */
|
||||
export const BOTS_ALL = "bots.all";
|
||||
|
||||
/** Capabilities granted to a newly-created member by default. */
|
||||
export const BASIC_TIER_CAPABILITIES: Capability[] = ["player.control", "player.queue"];
|
||||
|
||||
export function isCapability(x: string): x is Capability {
|
||||
return (CAPABILITIES as readonly string[]).includes(x);
|
||||
}
|
||||
|
||||
export type BotAccess = "all" | string[];
|
||||
|
||||
export interface GuestPermissions {
|
||||
addToQueue: boolean;
|
||||
playNext: boolean;
|
||||
playNow: boolean;
|
||||
skip: boolean;
|
||||
transport: boolean;
|
||||
removeClear: boolean;
|
||||
playMode: boolean;
|
||||
/** Load + play an entire playlist/album (clears the queue). Issue #103. */
|
||||
playCollection: boolean;
|
||||
}
|
||||
|
||||
export const GUEST_PERMISSION_FLAGS = [
|
||||
"addToQueue",
|
||||
"playNext",
|
||||
"playNow",
|
||||
"skip",
|
||||
"transport",
|
||||
"removeClear",
|
||||
"playMode",
|
||||
"playCollection",
|
||||
] as const;
|
||||
export type GuestFlag = (typeof GUEST_PERMISSION_FLAGS)[number];
|
||||
|
||||
export interface PermissionStore {
|
||||
getCapabilities(userId: string): Capability[];
|
||||
getBotAccess(userId: string): BotAccess;
|
||||
setPermissions(userId: string, input: { capabilities: string[]; bots: BotAccess }): void;
|
||||
pruneBot(botId: string): void;
|
||||
}
|
||||
|
||||
export function createPermissionStore(db: Database.Database): PermissionStore {
|
||||
const selCaps = db.prepare("SELECT permission FROM user_permissions WHERE userId = ?");
|
||||
const delCaps = db.prepare("DELETE FROM user_permissions WHERE userId = ?");
|
||||
const insCap = db.prepare("INSERT OR IGNORE INTO user_permissions (userId, permission) VALUES (?, ?)");
|
||||
const selBots = db.prepare("SELECT botId FROM user_bot_access WHERE userId = ?");
|
||||
const delBots = db.prepare("DELETE FROM user_bot_access WHERE userId = ?");
|
||||
const insBot = db.prepare("INSERT OR IGNORE INTO user_bot_access (userId, botId) VALUES (?, ?)");
|
||||
const pruneBotStmt = db.prepare("DELETE FROM user_bot_access WHERE botId = ?");
|
||||
|
||||
return {
|
||||
getCapabilities(userId) {
|
||||
return (selCaps.all(userId) as { permission: string }[])
|
||||
.map((r) => r.permission)
|
||||
.filter((p): p is Capability => isCapability(p));
|
||||
},
|
||||
getBotAccess(userId) {
|
||||
const all = (selCaps.all(userId) as { permission: string }[]).some((r) => r.permission === BOTS_ALL);
|
||||
if (all) return "all";
|
||||
return (selBots.all(userId) as { botId: string }[]).map((r) => r.botId);
|
||||
},
|
||||
setPermissions(userId, input) {
|
||||
const caps = input.capabilities.filter(isCapability);
|
||||
const tx = db.transaction(() => {
|
||||
delCaps.run(userId);
|
||||
delBots.run(userId);
|
||||
for (const c of caps) insCap.run(userId, c);
|
||||
if (input.bots === "all") {
|
||||
insCap.run(userId, BOTS_ALL);
|
||||
} else {
|
||||
for (const b of input.bots) insBot.run(userId, b);
|
||||
}
|
||||
});
|
||||
tx();
|
||||
},
|
||||
pruneBot(botId) {
|
||||
pruneBotStmt.run(botId);
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export interface PermissionContext {
|
||||
capabilities: Set<string>;
|
||||
bots: "all" | Set<string>;
|
||||
guest?: GuestPermissions;
|
||||
}
|
||||
|
||||
export function resolvePermissionContext(
|
||||
role: "admin" | "member" | "guest",
|
||||
userId: string,
|
||||
store: PermissionStore,
|
||||
guest?: { bots: BotAccess; permissions: GuestPermissions }
|
||||
): PermissionContext {
|
||||
if (role === "admin") {
|
||||
return { capabilities: new Set(CAPABILITIES), bots: "all" };
|
||||
}
|
||||
if (role === "guest") {
|
||||
const bots = guest?.bots ?? [];
|
||||
return {
|
||||
capabilities: new Set<string>(),
|
||||
bots: bots === "all" ? "all" : new Set(bots),
|
||||
guest: guest?.permissions,
|
||||
};
|
||||
}
|
||||
const access = store.getBotAccess(userId);
|
||||
return {
|
||||
capabilities: new Set(store.getCapabilities(userId)),
|
||||
bots: access === "all" ? "all" : new Set(access),
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,199 @@
|
||||
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
|
||||
import { createHash } from "node:crypto";
|
||||
import { createDatabase, type BotDatabase } from "./database.js";
|
||||
import { createUserStore, type UserStore } from "./users.js";
|
||||
import { createSessionStore, type SessionStore, SESSION_TTL_MS, SESSION_TOUCH_INTERVAL_MS, MAX_SESSIONS_PER_USER, GUEST_SESSION_TTL_MS } from "./sessions.js";
|
||||
|
||||
function sha256(token: string) {
|
||||
return createHash("sha256").update(token).digest("hex");
|
||||
}
|
||||
|
||||
describe("SessionStore", () => {
|
||||
let botDb: BotDatabase;
|
||||
let users: UserStore;
|
||||
let sessions: SessionStore;
|
||||
let userId: string;
|
||||
|
||||
beforeEach(async () => {
|
||||
botDb = createDatabase(":memory:");
|
||||
users = createUserStore(botDb.db);
|
||||
sessions = createSessionStore(botDb.db);
|
||||
const u = await users.createUser("alice", "pw-alice", "admin");
|
||||
userId = u.id;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
botDb.close();
|
||||
});
|
||||
|
||||
it("createSession returns a raw token whose sha256 matches the DB row id", () => {
|
||||
const { token } = sessions.createSession(userId);
|
||||
const row = botDb.db.prepare("SELECT id FROM sessions").get() as { id: string };
|
||||
expect(row.id).toBe(sha256(token));
|
||||
expect(row.id).not.toBe(token);
|
||||
});
|
||||
|
||||
it("validateAndTouch returns the user for a fresh token", () => {
|
||||
const { token } = sessions.createSession(userId);
|
||||
const result = sessions.validateAndTouch(token);
|
||||
expect(result).not.toBeNull();
|
||||
expect(result!.userId).toBe(userId);
|
||||
expect(result!.username).toBe("alice");
|
||||
expect(result!.role).toBe("admin");
|
||||
});
|
||||
|
||||
it("validateAndTouch returns null and deletes the row for an expired session", () => {
|
||||
vi.useFakeTimers();
|
||||
vi.setSystemTime(new Date("2026-01-01T00:00:00Z"));
|
||||
const { token } = sessions.createSession(userId);
|
||||
vi.setSystemTime(new Date("2026-01-01T00:00:00Z").getTime() + SESSION_TTL_MS + 1000);
|
||||
expect(sessions.validateAndTouch(token)).toBeNull();
|
||||
const remaining = (botDb.db.prepare("SELECT COUNT(*) AS n FROM sessions").get() as { n: number }).n;
|
||||
expect(remaining).toBe(0);
|
||||
});
|
||||
|
||||
it("validateAndTouch does not write the DB if called again within the touch interval", () => {
|
||||
vi.useFakeTimers();
|
||||
vi.setSystemTime(new Date("2026-01-01T00:00:00Z"));
|
||||
const { token } = sessions.createSession(userId);
|
||||
const before = botDb.db.prepare("SELECT lastSeenAt FROM sessions").get() as { lastSeenAt: number };
|
||||
vi.advanceTimersByTime(SESSION_TOUCH_INTERVAL_MS - 1000);
|
||||
sessions.validateAndTouch(token);
|
||||
const after = botDb.db.prepare("SELECT lastSeenAt FROM sessions").get() as { lastSeenAt: number };
|
||||
expect(after.lastSeenAt).toBe(before.lastSeenAt);
|
||||
});
|
||||
|
||||
it("validateAndTouch writes lastSeenAt and extends expiresAt past the touch interval", () => {
|
||||
vi.useFakeTimers();
|
||||
vi.setSystemTime(new Date("2026-01-01T00:00:00Z"));
|
||||
const { token, expiresAt: initialExpiry } = sessions.createSession(userId);
|
||||
vi.advanceTimersByTime(SESSION_TOUCH_INTERVAL_MS + 1000);
|
||||
sessions.validateAndTouch(token);
|
||||
const row = botDb.db.prepare("SELECT lastSeenAt, expiresAt FROM sessions").get() as { lastSeenAt: number; expiresAt: number };
|
||||
expect(row.lastSeenAt).toBe(Date.now());
|
||||
expect(row.expiresAt).toBeGreaterThan(initialExpiry);
|
||||
});
|
||||
|
||||
it("deleteSession removes the row", () => {
|
||||
const { token } = sessions.createSession(userId);
|
||||
sessions.deleteSession(token);
|
||||
const remaining = (botDb.db.prepare("SELECT COUNT(*) AS n FROM sessions").get() as { n: number }).n;
|
||||
expect(remaining).toBe(0);
|
||||
expect(sessions.validateAndTouch(token)).toBeNull();
|
||||
});
|
||||
|
||||
it("deleteAllForUser keeps the exceptToken session", () => {
|
||||
const a = sessions.createSession(userId);
|
||||
const b = sessions.createSession(userId);
|
||||
sessions.deleteAllForUser(userId, a.token);
|
||||
expect(sessions.validateAndTouch(a.token)).not.toBeNull();
|
||||
expect(sessions.validateAndTouch(b.token)).toBeNull();
|
||||
});
|
||||
|
||||
it("cleanupExpired removes only expired rows", () => {
|
||||
vi.useFakeTimers();
|
||||
vi.setSystemTime(new Date("2026-01-01T00:00:00Z"));
|
||||
sessions.createSession(userId); // expires later
|
||||
vi.setSystemTime(new Date("2026-01-01T00:00:00Z").getTime() + SESSION_TTL_MS + 1000);
|
||||
sessions.createSession(userId); // fresh
|
||||
sessions.cleanupExpired();
|
||||
const remaining = (botDb.db.prepare("SELECT COUNT(*) AS n FROM sessions").get() as { n: number }).n;
|
||||
expect(remaining).toBe(1);
|
||||
});
|
||||
|
||||
it("createSession caps concurrent sessions per user at MAX_SESSIONS_PER_USER, evicting oldest", async () => {
|
||||
// Create MAX + 2 sessions for the same user.
|
||||
const tokens: string[] = [];
|
||||
for (let i = 0; i < MAX_SESSIONS_PER_USER + 2; i++) {
|
||||
tokens.push(sessions.createSession(userId).token);
|
||||
await new Promise((r) => setTimeout(r, 2)); // stagger createdAt
|
||||
}
|
||||
const count = (botDb.db.prepare("SELECT COUNT(*) AS n FROM sessions").get() as { n: number }).n;
|
||||
expect(count).toBe(MAX_SESSIONS_PER_USER);
|
||||
// The first two should have been evicted, the last MAX remain
|
||||
expect(sessions.validateAndTouch(tokens[0])).toBeNull();
|
||||
expect(sessions.validateAndTouch(tokens[1])).toBeNull();
|
||||
expect(sessions.validateAndTouch(tokens[tokens.length - 1])).not.toBeNull();
|
||||
});
|
||||
|
||||
it("createSession respects cap under concurrent calls (no 1-over-cap race)", async () => {
|
||||
// better-sqlite3 transactions are serialised at the engine level. Calling
|
||||
// createSession N times sequentially via Promise.all proves atomic check+insert.
|
||||
const N = MAX_SESSIONS_PER_USER + 3;
|
||||
await Promise.all(Array.from({ length: N }, () => Promise.resolve(sessions.createSession(userId))));
|
||||
const count = (botDb.db.prepare("SELECT COUNT(*) AS n FROM sessions").get() as { n: number }).n;
|
||||
expect(count).toBe(MAX_SESSIONS_PER_USER);
|
||||
});
|
||||
});
|
||||
|
||||
describe("guest sessions", () => {
|
||||
let botDb: BotDatabase;
|
||||
let sessions: SessionStore;
|
||||
|
||||
beforeEach(() => {
|
||||
botDb = createDatabase(":memory:");
|
||||
sessions = createSessionStore(botDb.db);
|
||||
// Create the synthetic guest user row to satisfy the sessions FK.
|
||||
botDb.db
|
||||
.prepare("INSERT OR IGNORE INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES ('__guest__','游客','!',?,?, 'guest')")
|
||||
.run(Date.now(), Date.now());
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
botDb.close();
|
||||
});
|
||||
|
||||
it("skipCap lets more than MAX_SESSIONS_PER_USER coexist for one principal", () => {
|
||||
const tokens: string[] = [];
|
||||
for (let i = 0; i < MAX_SESSIONS_PER_USER + 3; i++) {
|
||||
tokens.push(sessions.createSession("__guest__", { ttlMs: GUEST_SESSION_TTL_MS, skipCap: true }).token);
|
||||
}
|
||||
// The first token must STILL validate (not evicted).
|
||||
expect(sessions.validateAndTouch(tokens[0])?.role).toBe("guest");
|
||||
const n = (botDb.db.prepare("SELECT COUNT(*) AS n FROM sessions WHERE userId='__guest__'").get() as { n: number }).n;
|
||||
expect(n).toBe(MAX_SESSIONS_PER_USER + 3);
|
||||
});
|
||||
|
||||
it("ttlMs sets a shorter expiry than the default", () => {
|
||||
const { expiresAt } = sessions.createSession("__guest__", { ttlMs: GUEST_SESSION_TTL_MS, skipCap: true });
|
||||
expect(expiresAt).toBeLessThanOrEqual(Date.now() + GUEST_SESSION_TTL_MS + 50);
|
||||
});
|
||||
|
||||
it("validateAndTouch refreshes a guest session to GUEST_SESSION_TTL_MS (1d), not SESSION_TTL_MS (7d)", () => {
|
||||
const { token } = sessions.createSession("__guest__", { ttlMs: GUEST_SESSION_TTL_MS, skipCap: true });
|
||||
// Force the touch branch: backdate lastSeenAt past the touch interval.
|
||||
botDb.db
|
||||
.prepare("UPDATE sessions SET lastSeenAt = ? WHERE userId = '__guest__'")
|
||||
.run(Date.now() - (SESSION_TOUCH_INTERVAL_MS + 1000));
|
||||
const result = sessions.validateAndTouch(token);
|
||||
expect(result?.role).toBe("guest");
|
||||
const row = botDb.db
|
||||
.prepare("SELECT expiresAt FROM sessions WHERE userId = '__guest__'")
|
||||
.get() as { expiresAt: number };
|
||||
// Should refresh to ~now + 1 day, NOT now + 7 days.
|
||||
expect(row.expiresAt).toBeGreaterThan(Date.now() + GUEST_SESSION_TTL_MS - 5000);
|
||||
expect(row.expiresAt).toBeLessThanOrEqual(Date.now() + GUEST_SESSION_TTL_MS + 5000);
|
||||
// Sanity: well below the 7d window.
|
||||
expect(row.expiresAt).toBeLessThan(Date.now() + SESSION_TTL_MS);
|
||||
});
|
||||
|
||||
it("validateAndTouch still refreshes a non-guest (admin) session to SESSION_TTL_MS (7d) on touch", () => {
|
||||
botDb.db
|
||||
.prepare("INSERT INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES ('admin1','adminuser','!',?,?, 'admin')")
|
||||
.run(Date.now(), Date.now());
|
||||
const { token } = sessions.createSession("admin1");
|
||||
botDb.db
|
||||
.prepare("UPDATE sessions SET lastSeenAt = ? WHERE userId = 'admin1'")
|
||||
.run(Date.now() - (SESSION_TOUCH_INTERVAL_MS + 1000));
|
||||
const result = sessions.validateAndTouch(token);
|
||||
expect(result?.role).toBe("admin");
|
||||
const row = botDb.db
|
||||
.prepare("SELECT expiresAt FROM sessions WHERE userId = 'admin1'")
|
||||
.get() as { expiresAt: number };
|
||||
// Refreshes to ~now + 7 days, NOT the 1d guest window.
|
||||
expect(row.expiresAt).toBeGreaterThan(Date.now() + SESSION_TTL_MS - 5000);
|
||||
expect(row.expiresAt).toBeLessThanOrEqual(Date.now() + SESSION_TTL_MS + 5000);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,110 @@
|
||||
import { createHash, randomBytes } from "node:crypto";
|
||||
import type Database from "better-sqlite3";
|
||||
|
||||
export const SESSION_TTL_MS = 7 * 24 * 60 * 60 * 1000; // 7 days
|
||||
export const GUEST_SESSION_TTL_MS = 24 * 60 * 60 * 1000; // 1 day — guests are short-lived
|
||||
export const SESSION_TOUCH_INTERVAL_MS = 60 * 60 * 1000; // 1 hour
|
||||
export const MAX_SESSIONS_PER_USER = 10;
|
||||
|
||||
export interface SessionValidation {
|
||||
userId: string;
|
||||
username: string;
|
||||
role: "admin" | "member" | "guest";
|
||||
}
|
||||
|
||||
export interface SessionStore {
|
||||
createSession(userId: string, opts?: { ttlMs?: number; skipCap?: boolean }): { token: string; expiresAt: number };
|
||||
validateAndTouch(rawToken: string): SessionValidation | null;
|
||||
deleteSession(rawToken: string): void;
|
||||
deleteAllForUser(userId: string, exceptToken?: string): void;
|
||||
cleanupExpired(): void;
|
||||
}
|
||||
|
||||
function hashToken(token: string): string {
|
||||
return createHash("sha256").update(token).digest("hex");
|
||||
}
|
||||
|
||||
export function createSessionStore(db: Database.Database): SessionStore {
|
||||
const insertStmt = db.prepare(
|
||||
"INSERT INTO sessions (id, userId, createdAt, expiresAt, lastSeenAt) VALUES (?, ?, ?, ?, ?)"
|
||||
);
|
||||
const selectStmt = db.prepare(`
|
||||
SELECT s.id, s.userId, s.expiresAt, s.lastSeenAt, u.username, u.role
|
||||
FROM sessions s INNER JOIN users u ON u.id = s.userId
|
||||
WHERE s.id = ?
|
||||
`);
|
||||
const deleteByIdStmt = db.prepare("DELETE FROM sessions WHERE id = ?");
|
||||
const touchStmt = db.prepare(
|
||||
"UPDATE sessions SET lastSeenAt = ?, expiresAt = ? WHERE id = ?"
|
||||
);
|
||||
const deleteAllForUserStmt = db.prepare("DELETE FROM sessions WHERE userId = ?");
|
||||
const deleteAllForUserExceptStmt = db.prepare(
|
||||
"DELETE FROM sessions WHERE userId = ? AND id != ?"
|
||||
);
|
||||
const cleanupStmt = db.prepare("DELETE FROM sessions WHERE expiresAt < ?");
|
||||
const countForUserStmt = db.prepare("SELECT COUNT(*) AS n FROM sessions WHERE userId = ?");
|
||||
const deleteOldestForUserStmt = db.prepare(
|
||||
"DELETE FROM sessions WHERE id IN (SELECT id FROM sessions WHERE userId = ? ORDER BY createdAt ASC LIMIT ?)"
|
||||
);
|
||||
|
||||
return {
|
||||
createSession(userId, opts) {
|
||||
// Cap concurrent sessions per user — oldest gets evicted on overflow.
|
||||
// Wrap the count → delete → insert in a transaction so concurrent logins
|
||||
// for the same user can't both pass the cap check and both insert,
|
||||
// ending up 1 over cap (race window between count and insert).
|
||||
const token = randomBytes(32).toString("base64url");
|
||||
const id = hashToken(token);
|
||||
const now = Date.now();
|
||||
const expiresAt = now + (opts?.ttlMs ?? SESSION_TTL_MS);
|
||||
const tx = db.transaction(() => {
|
||||
if (!opts?.skipCap) {
|
||||
const existing = (countForUserStmt.get(userId) as { n: number }).n;
|
||||
if (existing >= MAX_SESSIONS_PER_USER) {
|
||||
deleteOldestForUserStmt.run(userId, existing - MAX_SESSIONS_PER_USER + 1);
|
||||
}
|
||||
}
|
||||
insertStmt.run(id, userId, now, expiresAt, now);
|
||||
});
|
||||
tx();
|
||||
return { token, expiresAt };
|
||||
},
|
||||
|
||||
validateAndTouch(rawToken) {
|
||||
if (!rawToken) return null;
|
||||
const id = hashToken(rawToken);
|
||||
const row = selectStmt.get(id) as
|
||||
| { id: string; userId: string; expiresAt: number; lastSeenAt: number; username: string; role: string }
|
||||
| undefined;
|
||||
if (!row) return null;
|
||||
const now = Date.now();
|
||||
if (row.expiresAt < now) {
|
||||
deleteByIdStmt.run(id);
|
||||
return null;
|
||||
}
|
||||
if (now - row.lastSeenAt > SESSION_TOUCH_INTERVAL_MS) {
|
||||
// Refresh against the role's own TTL — guests are short-lived (1d) and
|
||||
// must NOT be bumped to the member/admin 7d window on touch.
|
||||
const ttl = row.role === "guest" ? GUEST_SESSION_TTL_MS : SESSION_TTL_MS;
|
||||
touchStmt.run(now, now + ttl, id);
|
||||
}
|
||||
return { userId: row.userId, username: row.username, role: row.role as "admin" | "member" | "guest" };
|
||||
},
|
||||
|
||||
deleteSession(rawToken) {
|
||||
deleteByIdStmt.run(hashToken(rawToken));
|
||||
},
|
||||
|
||||
deleteAllForUser(userId, exceptToken) {
|
||||
if (exceptToken) {
|
||||
deleteAllForUserExceptStmt.run(userId, hashToken(exceptToken));
|
||||
} else {
|
||||
deleteAllForUserStmt.run(userId);
|
||||
}
|
||||
},
|
||||
|
||||
cleanupExpired() {
|
||||
cleanupStmt.run(Date.now());
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,226 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
||||
import { createDatabase, type BotDatabase } from "./database.js";
|
||||
import { createUserStore, UsernameTakenError, GUEST_USER_ID, GUEST_USERNAME, type UserStore } from "./users.js";
|
||||
|
||||
describe("UserStore", () => {
|
||||
let botDb: BotDatabase;
|
||||
let users: UserStore;
|
||||
|
||||
beforeEach(() => {
|
||||
botDb = createDatabase(":memory:");
|
||||
users = createUserStore(botDb.db);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
botDb.close();
|
||||
});
|
||||
|
||||
it("countUsers is 0 on a fresh db", () => {
|
||||
expect(users.countUsers()).toBe(0);
|
||||
});
|
||||
|
||||
it("createUser stores the user and bumps countUsers", async () => {
|
||||
const u = await users.createUser("alice", "pw-hunter2", "member");
|
||||
expect(u.id).toMatch(/^[0-9a-f-]{36}$/);
|
||||
expect(u.username).toBe("alice");
|
||||
expect(users.countUsers()).toBe(1);
|
||||
});
|
||||
|
||||
it("findByUsername is case-insensitive and returns null for missing", async () => {
|
||||
await users.createUser("Alice", "pw-alice", "member");
|
||||
expect(users.findByUsername("ALICE")).not.toBeNull();
|
||||
expect(users.findByUsername("alice")).not.toBeNull();
|
||||
expect(users.findByUsername("bob")).toBeNull();
|
||||
});
|
||||
|
||||
it("createUser rejects duplicate usernames (case-insensitive)", async () => {
|
||||
await users.createUser("Alice", "pw-alice", "member");
|
||||
await expect(users.createUser("alice", "pw-alice-2", "member")).rejects.toBeInstanceOf(UsernameTakenError);
|
||||
});
|
||||
|
||||
it("verifyPassword accepts correct password and rejects wrong one", async () => {
|
||||
await users.createUser("alice", "correct-horse-battery-staple", "member");
|
||||
const row = users.findByUsername("alice");
|
||||
expect(row).not.toBeNull();
|
||||
expect(await users.verifyPassword("correct-horse-battery-staple", row!.passwordHash)).toBe(true);
|
||||
expect(await users.verifyPassword("wrong", row!.passwordHash)).toBe(false);
|
||||
});
|
||||
|
||||
it("changePassword updates the hash so the old password no longer verifies", async () => {
|
||||
const u = await users.createUser("alice", "old-pw-pw", "member");
|
||||
await users.changePassword(u.id, "new-pw-pw");
|
||||
const row = users.findByUsername("alice");
|
||||
expect(await users.verifyPassword("old-pw-pw", row!.passwordHash)).toBe(false);
|
||||
expect(await users.verifyPassword("new-pw-pw", row!.passwordHash)).toBe(true);
|
||||
});
|
||||
|
||||
it("listUsers returns id+username+createdAt ascending, no password hash", async () => {
|
||||
await users.createUser("alice", "pw-alice", "member");
|
||||
await users.createUser("bob", "pw-bob-bob", "member");
|
||||
const list = users.listUsers();
|
||||
expect(list).toHaveLength(2);
|
||||
expect(list[0].username).toBe("alice");
|
||||
expect(list[1].username).toBe("bob");
|
||||
expect(list[0]).not.toHaveProperty("passwordHash");
|
||||
expect(list[0].id).toMatch(/^[0-9a-f-]{36}$/);
|
||||
expect(typeof list[0].createdAt).toBe("number");
|
||||
});
|
||||
|
||||
it("deleteUser removes the row and returns true; returns false for unknown id", async () => {
|
||||
const u = await users.createUser("alice", "pw-alice", "member");
|
||||
expect(users.deleteUser(u.id)).toBe(true);
|
||||
expect(users.countUsers()).toBe(0);
|
||||
expect(users.deleteUser("not-a-real-id")).toBe(false);
|
||||
});
|
||||
|
||||
it("createFirstUser succeeds on empty db, returns null when a user already exists", async () => {
|
||||
const a = await users.createFirstUser("alice", "pw-alice");
|
||||
expect(a).not.toBeNull();
|
||||
expect(a!.username).toBe("alice");
|
||||
const b = await users.createFirstUser("bob", "pw-bob-bob");
|
||||
expect(b).toBeNull();
|
||||
expect(users.countUsers()).toBe(1);
|
||||
});
|
||||
|
||||
it("createFirstUser is race-safe: concurrent calls produce exactly one user", async () => {
|
||||
const [a, b, c] = await Promise.all([
|
||||
users.createFirstUser("alice", "pw-alice"),
|
||||
users.createFirstUser("bob", "pw-bob-bob"),
|
||||
users.createFirstUser("charlie", "pw-charlie-pw"),
|
||||
]);
|
||||
const created = [a, b, c].filter((u) => u !== null);
|
||||
expect(created).toHaveLength(1);
|
||||
expect(users.countUsers()).toBe(1);
|
||||
});
|
||||
|
||||
it("createFirstUser always creates an admin", async () => {
|
||||
const u = await users.createFirstUser("alice", "pw-alice");
|
||||
expect(u).not.toBeNull();
|
||||
expect(u!.role).toBe("admin");
|
||||
});
|
||||
|
||||
it("countAdmins reflects only role=admin", async () => {
|
||||
await users.createUser("alice", "pw-alice", "admin");
|
||||
await users.createUser("bob", "pw-bob-bob", "member");
|
||||
expect(users.countUsers()).toBe(2);
|
||||
expect(users.countAdmins()).toBe(1);
|
||||
});
|
||||
|
||||
it("setRole changes the role and returns true; false for unknown id", async () => {
|
||||
const u = await users.createUser("alice", "pw-alice", "member");
|
||||
expect(users.setRole(u.id, "admin")).toBe(true);
|
||||
expect(users.findById(u.id)!.role).toBe("admin");
|
||||
expect(users.setRole("nope", "admin")).toBe(false);
|
||||
});
|
||||
|
||||
it("listUsers includes role", async () => {
|
||||
await users.createUser("alice", "pw-alice", "admin");
|
||||
await users.createUser("bob", "pw-bob-bob", "member");
|
||||
const list = users.listUsers();
|
||||
const alice = list.find((u) => u.username === "alice")!;
|
||||
const bob = list.find((u) => u.username === "bob")!;
|
||||
expect(alice.role).toBe("admin");
|
||||
expect(bob.role).toBe("member");
|
||||
});
|
||||
|
||||
it("setRoleIfNotLastAdmin returns 'would_orphan' for the only admin being demoted", async () => {
|
||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
||||
expect(users.setRoleIfNotLastAdmin(alice.id, "member")).toBe("would_orphan");
|
||||
expect(users.findById(alice.id)!.role).toBe("admin"); // unchanged
|
||||
});
|
||||
|
||||
it("setRoleIfNotLastAdmin allows demotion when another admin exists", async () => {
|
||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
||||
await users.createUser("bob", "pw-bob-bob", "admin");
|
||||
expect(users.setRoleIfNotLastAdmin(alice.id, "member")).toBe("ok");
|
||||
expect(users.findById(alice.id)!.role).toBe("member");
|
||||
});
|
||||
|
||||
it("setRoleIfNotLastAdmin returns 'not_found' for unknown id", () => {
|
||||
expect(users.setRoleIfNotLastAdmin("not-a-real-id", "member")).toBe("not_found");
|
||||
});
|
||||
|
||||
it("setRoleIfNotLastAdmin: concurrent demotions of two admins keep one admin", async () => {
|
||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
||||
const bob = await users.createUser("bob", "pw-bob-bob", "admin");
|
||||
// Concurrent demotion of both
|
||||
const [r1, r2] = await Promise.all([
|
||||
Promise.resolve(users.setRoleIfNotLastAdmin(alice.id, "member")),
|
||||
Promise.resolve(users.setRoleIfNotLastAdmin(bob.id, "member")),
|
||||
]);
|
||||
// Exactly one should succeed; the other gets "would_orphan"
|
||||
const oks = [r1, r2].filter((r) => r === "ok").length;
|
||||
const orphans = [r1, r2].filter((r) => r === "would_orphan").length;
|
||||
expect(oks).toBe(1);
|
||||
expect(orphans).toBe(1);
|
||||
// System retains at least one admin
|
||||
expect(users.countAdmins()).toBe(1);
|
||||
});
|
||||
|
||||
it("deleteUserIfNotLastAdmin returns 'would_orphan' for the only admin", async () => {
|
||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
||||
expect(users.deleteUserIfNotLastAdmin(alice.id)).toBe("would_orphan");
|
||||
expect(users.findById(alice.id)).not.toBeNull();
|
||||
});
|
||||
|
||||
it("deleteUserIfNotLastAdmin allows deleting a member at any count", async () => {
|
||||
await users.createUser("alice", "pw-alice", "admin");
|
||||
const bob = await users.createUser("bob", "pw-bob-bob", "member");
|
||||
expect(users.deleteUserIfNotLastAdmin(bob.id)).toBe("ok");
|
||||
expect(users.findById(bob.id)).toBeNull();
|
||||
});
|
||||
|
||||
it("deleteUserIfNotLastAdmin: concurrent deletes of two admins keep one admin", async () => {
|
||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
||||
const bob = await users.createUser("bob", "pw-bob-bob", "admin");
|
||||
const [r1, r2] = await Promise.all([
|
||||
Promise.resolve(users.deleteUserIfNotLastAdmin(alice.id)),
|
||||
Promise.resolve(users.deleteUserIfNotLastAdmin(bob.id)),
|
||||
]);
|
||||
const oks = [r1, r2].filter((r) => r === "ok").length;
|
||||
const orphans = [r1, r2].filter((r) => r === "would_orphan").length;
|
||||
expect(oks).toBe(1);
|
||||
expect(orphans).toBe(1);
|
||||
expect(users.countAdmins()).toBe(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("guest row exclusion", () => {
|
||||
let botDb: BotDatabase;
|
||||
let users: UserStore;
|
||||
|
||||
beforeEach(() => {
|
||||
botDb = createDatabase(":memory:");
|
||||
users = createUserStore(botDb.db);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
botDb.close();
|
||||
});
|
||||
|
||||
it("countUsers and listUsers ignore the reserved guest row", async () => {
|
||||
await users.createUser("alice", "password123", "member");
|
||||
// Insert the reserved guest row directly (mirrors the migration).
|
||||
botDb.db.prepare(
|
||||
"INSERT OR IGNORE INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES (?, ?, ?, ?, ?, 'guest')"
|
||||
).run(GUEST_USER_ID, GUEST_USERNAME, "!", Date.now(), Date.now());
|
||||
|
||||
expect(users.countUsers()).toBe(1); // alice only
|
||||
expect(users.listUsers().some((u) => u.id === GUEST_USER_ID)).toBe(false);
|
||||
});
|
||||
|
||||
it("setRoleIfNotLastAdmin refuses to re-role the reserved guest principal", () => {
|
||||
// The guest row is seeded by createDatabase via ensureGuestUser.
|
||||
expect(users.findById(GUEST_USER_ID)!.role).toBe("guest"); // sanity
|
||||
expect(users.setRoleIfNotLastAdmin(GUEST_USER_ID, "admin")).toBe("not_found");
|
||||
// The guest row's role is unchanged.
|
||||
expect(users.findById(GUEST_USER_ID)!.role).toBe("guest");
|
||||
});
|
||||
|
||||
it("deleteUserIfNotLastAdmin refuses to delete the reserved guest principal", () => {
|
||||
expect(users.findById(GUEST_USER_ID)).not.toBeNull(); // sanity
|
||||
expect(users.deleteUserIfNotLastAdmin(GUEST_USER_ID)).toBe("not_found");
|
||||
// The guest row still exists.
|
||||
expect(users.findById(GUEST_USER_ID)).not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,176 @@
|
||||
import { randomUUID } from "node:crypto";
|
||||
import type Database from "better-sqlite3";
|
||||
import bcrypt from "bcryptjs";
|
||||
|
||||
const BCRYPT_ROUNDS = 12;
|
||||
|
||||
export type UserRole = "admin" | "member" | "guest";
|
||||
|
||||
/** Reserved synthetic principal for login-less guest sessions. The username is
|
||||
* non-ASCII so it can never collide with an API-created account (which is
|
||||
* validated against ^[A-Za-z0-9_\-.]{3,32}$). */
|
||||
export const GUEST_USER_ID = "__guest__";
|
||||
export const GUEST_USERNAME = "游客";
|
||||
|
||||
export interface UserRow {
|
||||
id: string;
|
||||
username: string;
|
||||
passwordHash: string;
|
||||
createdAt: number;
|
||||
updatedAt: number;
|
||||
role: UserRole;
|
||||
}
|
||||
|
||||
export interface UserStore {
|
||||
countUsers(): number;
|
||||
countAdmins(): number;
|
||||
createUser(username: string, password: string, role: UserRole): Promise<UserRow>;
|
||||
createFirstUser(username: string, password: string): Promise<UserRow | null>;
|
||||
findByUsername(username: string): UserRow | null;
|
||||
findById(id: string): UserRow | null;
|
||||
verifyPassword(plain: string, hash: string): Promise<boolean>;
|
||||
changePassword(userId: string, newPassword: string): Promise<void>;
|
||||
setRole(userId: string, role: UserRole): boolean;
|
||||
setRoleIfNotLastAdmin(id: string, newRole: UserRole): "ok" | "not_found" | "would_orphan";
|
||||
deleteUser(id: string): boolean;
|
||||
deleteUserIfNotLastAdmin(id: string): "ok" | "not_found" | "would_orphan";
|
||||
listUsers(): Array<{ id: string; username: string; createdAt: number; role: UserRole }>;
|
||||
}
|
||||
|
||||
export class UsernameTakenError extends Error {
|
||||
constructor(username: string) {
|
||||
super(`username taken: ${username}`);
|
||||
this.name = "UsernameTakenError";
|
||||
}
|
||||
}
|
||||
|
||||
export function createUserStore(db: Database.Database): UserStore {
|
||||
const countStmt = db.prepare("SELECT COUNT(*) AS n FROM users WHERE role != 'guest'");
|
||||
const countAdminsStmt = db.prepare("SELECT COUNT(*) AS n FROM users WHERE role = 'admin'");
|
||||
const insertStmt = db.prepare(
|
||||
"INSERT INTO users (id, username, passwordHash, createdAt, updatedAt, role) VALUES (?, ?, ?, ?, ?, ?)"
|
||||
);
|
||||
const findByUsernameStmt = db.prepare(
|
||||
"SELECT id, username, passwordHash, createdAt, updatedAt, role FROM users WHERE username = ? COLLATE NOCASE"
|
||||
);
|
||||
const findByIdStmt = db.prepare(
|
||||
"SELECT id, username, passwordHash, createdAt, updatedAt, role FROM users WHERE id = ?"
|
||||
);
|
||||
const updatePasswordStmt = db.prepare(
|
||||
"UPDATE users SET passwordHash = ?, updatedAt = ? WHERE id = ?"
|
||||
);
|
||||
const updateRoleStmt = db.prepare(
|
||||
"UPDATE users SET role = ?, updatedAt = ? WHERE id = ?"
|
||||
);
|
||||
const listUsersStmt = db.prepare(
|
||||
"SELECT id, username, createdAt, role FROM users WHERE role != 'guest' ORDER BY createdAt ASC"
|
||||
);
|
||||
const deleteUserStmt = db.prepare("DELETE FROM users WHERE id = ?");
|
||||
|
||||
return {
|
||||
countUsers() {
|
||||
return (countStmt.get() as { n: number }).n;
|
||||
},
|
||||
|
||||
countAdmins() {
|
||||
return (countAdminsStmt.get() as { n: number }).n;
|
||||
},
|
||||
|
||||
async createUser(username, password, role) {
|
||||
const hash = await bcrypt.hash(password, BCRYPT_ROUNDS);
|
||||
const id = randomUUID();
|
||||
const now = Date.now();
|
||||
try {
|
||||
insertStmt.run(id, username, hash, now, now, role);
|
||||
} catch (err) {
|
||||
if (err && typeof err === "object" && (err as { code?: string }).code === "SQLITE_CONSTRAINT_UNIQUE") {
|
||||
throw new UsernameTakenError(username);
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
return { id, username, passwordHash: hash, createdAt: now, updatedAt: now, role };
|
||||
},
|
||||
|
||||
async createFirstUser(username, password) {
|
||||
const hash = await bcrypt.hash(password, BCRYPT_ROUNDS);
|
||||
const id = randomUUID();
|
||||
const now = Date.now();
|
||||
const run = db.transaction(() => {
|
||||
const count = (countStmt.get() as { n: number }).n;
|
||||
if (count !== 0) return null;
|
||||
try {
|
||||
insertStmt.run(id, username, hash, now, now, "admin");
|
||||
} catch (err) {
|
||||
if (err && typeof err === "object" && (err as { code?: string }).code === "SQLITE_CONSTRAINT_UNIQUE") {
|
||||
return null;
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
return { id, username, passwordHash: hash, createdAt: now, updatedAt: now, role: "admin" } as UserRow;
|
||||
});
|
||||
return run();
|
||||
},
|
||||
|
||||
findByUsername(username) {
|
||||
return (findByUsernameStmt.get(username) as UserRow | undefined) ?? null;
|
||||
},
|
||||
|
||||
findById(id) {
|
||||
return (findByIdStmt.get(id) as UserRow | undefined) ?? null;
|
||||
},
|
||||
|
||||
verifyPassword(plain, hash) {
|
||||
return bcrypt.compare(plain, hash);
|
||||
},
|
||||
|
||||
async changePassword(userId, newPassword) {
|
||||
const hash = await bcrypt.hash(newPassword, BCRYPT_ROUNDS);
|
||||
updatePasswordStmt.run(hash, Date.now(), userId);
|
||||
},
|
||||
|
||||
setRole(userId, role) {
|
||||
const result = updateRoleStmt.run(role, Date.now(), userId);
|
||||
return result.changes > 0;
|
||||
},
|
||||
|
||||
setRoleIfNotLastAdmin(id, newRole) {
|
||||
const tx = db.transaction(() => {
|
||||
const row = findByIdStmt.get(id) as UserRow | undefined;
|
||||
if (!row) return "not_found" as const;
|
||||
if (row.role === "guest") return "not_found" as const; // reserved synthetic principal
|
||||
if (row.role === newRole) return "ok" as const; // no-op
|
||||
if (row.role === "admin" && newRole === "member") {
|
||||
const adminCount = (countAdminsStmt.get() as { n: number }).n;
|
||||
if (adminCount <= 1) return "would_orphan" as const;
|
||||
}
|
||||
updateRoleStmt.run(newRole, Date.now(), id);
|
||||
return "ok" as const;
|
||||
});
|
||||
return tx();
|
||||
},
|
||||
|
||||
listUsers() {
|
||||
return listUsersStmt.all() as Array<{ id: string; username: string; createdAt: number; role: UserRole }>;
|
||||
},
|
||||
|
||||
deleteUser(id) {
|
||||
const result = deleteUserStmt.run(id);
|
||||
return result.changes > 0;
|
||||
},
|
||||
|
||||
deleteUserIfNotLastAdmin(id) {
|
||||
const tx = db.transaction(() => {
|
||||
const row = findByIdStmt.get(id) as UserRow | undefined;
|
||||
if (!row) return "not_found" as const;
|
||||
if (row.role === "guest") return "not_found" as const; // reserved synthetic principal
|
||||
if (row.role === "admin") {
|
||||
const adminCount = (countAdminsStmt.get() as { n: number }).n;
|
||||
if (adminCount <= 1) return "would_orphan" as const;
|
||||
}
|
||||
deleteUserStmt.run(id);
|
||||
return "ok" as const;
|
||||
});
|
||||
return tx();
|
||||
},
|
||||
};
|
||||
}
|
||||
+84
-4
@@ -1,26 +1,43 @@
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { loadConfig, saveConfig } from "./data/config.js";
|
||||
import { loadConfig, saveConfig, migrateLegacyConfig, isProviderEnabled } from "./data/config.js";
|
||||
import { createDatabase } from "./data/database.js";
|
||||
import { createLogger } from "./logger.js";
|
||||
import { createApiServerManager } from "./music/api-server.js";
|
||||
import { NeteaseProvider } from "./music/netease.js";
|
||||
import { QQMusicProvider } from "./music/qq.js";
|
||||
import { BiliBiliProvider } from "./music/bilibili.js";
|
||||
import { LocalMusicProvider } from "./music/local.js";
|
||||
import { KugouProvider } from "./music/kugou.js";
|
||||
import { JellyfinProvider } from "./music/jellyfin.js";
|
||||
import { SpotifyProvider } from "./music/spotify/provider.js";
|
||||
import { SpotifyOAuth, createFileOAuthTokenStore } from "./music/spotify/spotify-oauth.js";
|
||||
import { createCookieStore } from "./music/auth.js";
|
||||
import { createAvatarStore } from "./data/avatars.js";
|
||||
import { createPermissionStore } from "./data/permissions.js";
|
||||
import { BotManager } from "./bot/manager.js";
|
||||
import { createWebServer } from "./web/server.js";
|
||||
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
const ROOT_DIR = path.resolve(__dirname, "..");
|
||||
const DATA_DIR = path.join(ROOT_DIR, "data");
|
||||
const CONFIG_PATH = path.join(ROOT_DIR, "config.json");
|
||||
// config.json lives under the persisted data dir (the Docker volume) alongside the
|
||||
// DB/cookies/logs, so it survives container restarts and manual edits take effect
|
||||
// (#86). LEGACY_CONFIG_PATH is the old root-level location we migrate from once.
|
||||
const CONFIG_PATH = path.join(DATA_DIR, "config.json");
|
||||
const LEGACY_CONFIG_PATH = path.join(ROOT_DIR, "config.json");
|
||||
const DB_PATH = path.join(DATA_DIR, "tsmusicbot.db");
|
||||
const LOG_DIR = path.join(DATA_DIR, "logs");
|
||||
const COOKIE_DIR = path.join(DATA_DIR, "cookies");
|
||||
const AVATAR_DIR = path.join(DATA_DIR, "avatars");
|
||||
const LOCAL_AUDIO_DIR = path.join(DATA_DIR, "local-audio");
|
||||
const SPOTIFY_DATA_DIR = path.join(DATA_DIR, "spotify");
|
||||
const STATIC_DIR = path.join(ROOT_DIR, "web", "dist");
|
||||
|
||||
async function main() {
|
||||
// Migrate a pre-#86 root-level config.json into the data dir so existing
|
||||
// installs keep their settings; no-op if already migrated or none exists.
|
||||
migrateLegacyConfig(LEGACY_CONFIG_PATH, CONFIG_PATH);
|
||||
const config = loadConfig(CONFIG_PATH);
|
||||
saveConfig(CONFIG_PATH, config);
|
||||
|
||||
@@ -36,7 +53,14 @@ async function main() {
|
||||
const db = createDatabase(DB_PATH);
|
||||
|
||||
const apiServer = createApiServerManager(
|
||||
{ neteasePort: config.neteaseApiPort, qqMusicPort: config.qqMusicApiPort },
|
||||
{
|
||||
neteasePort: config.neteaseApiPort,
|
||||
qqMusicPort: config.qqMusicApiPort,
|
||||
// Provider gating: a sidecar only starts (and binds 3001/3200) when its
|
||||
// source is listed in enabledProviders — both are on in the default config.
|
||||
neteaseEnabled: isProviderEnabled(config, "netease"),
|
||||
qqEnabled: isProviderEnabled(config, "qq"),
|
||||
},
|
||||
logger
|
||||
);
|
||||
await apiServer.start();
|
||||
@@ -44,14 +68,55 @@ async function main() {
|
||||
const neteaseProvider = new NeteaseProvider(apiServer.getNeteaseBaseUrl());
|
||||
const qqProvider = new QQMusicProvider(apiServer.getQQMusicBaseUrl());
|
||||
const bilibiliProvider = new BiliBiliProvider();
|
||||
const localProvider = new LocalMusicProvider(LOCAL_AUDIO_DIR);
|
||||
const kugouProvider = new KugouProvider();
|
||||
const spotifyProvider = new SpotifyProvider();
|
||||
// Safety gate (spec §7): the source is inert unless EXPLICITLY enabled.
|
||||
// Only feed credentials when enabled — otherwise the provider has no creds,
|
||||
// hasCreds() is false, search returns empty, and getAuthStatus() is loggedIn:false,
|
||||
// so setting a Client ID/Secret alone (enabled:false) never activates Spotify.
|
||||
if (config.spotify.enabled && config.spotify.clientId) {
|
||||
spotifyProvider.setCreds(config.spotify.clientId, config.spotify.clientSecret);
|
||||
}
|
||||
|
||||
const cookieStore = createCookieStore(COOKIE_DIR);
|
||||
const avatarStore = createAvatarStore(AVATAR_DIR);
|
||||
const neteaseCookie = cookieStore.load("netease");
|
||||
if (neteaseCookie) neteaseProvider.setCookie(neteaseCookie);
|
||||
const qqCookie = cookieStore.load("qq");
|
||||
if (qqCookie) qqProvider.setCookie(qqCookie);
|
||||
const bilibiliCookie = cookieStore.load("bilibili");
|
||||
if (bilibiliCookie) bilibiliProvider.setCookie(bilibiliCookie);
|
||||
const kugouCookie = cookieStore.load("kugou");
|
||||
if (kugouCookie) kugouProvider.setCookie(kugouCookie);
|
||||
|
||||
// Jellyfin: admin-configured connection (no QR). The persisted blob carries
|
||||
// AccessToken + User.Id + DeviceId and lives alongside the other platform
|
||||
// cookies; a Jellyfin server that is unreachable at boot must not block
|
||||
// startup — the provider authenticates lazily on first use.
|
||||
const jellyfinProvider = new JellyfinProvider(logger);
|
||||
jellyfinProvider.configure(config.jellyfin);
|
||||
const jellyfinAuth = cookieStore.load("jellyfin");
|
||||
if (jellyfinAuth) jellyfinProvider.setCookie(jellyfinAuth);
|
||||
jellyfinProvider.setPersist((serialized) => cookieStore.save("jellyfin", serialized));
|
||||
|
||||
const permissions = createPermissionStore(db.db);
|
||||
|
||||
// Single process-wide Spotify authorization (one Premium account for Stage 3).
|
||||
// Threaded into BOTH the web OAuth router and every bot's SpotifyController so
|
||||
// a web login immediately authorizes playback (C3.1). Own-app clientId => the
|
||||
// redirect points at this bot's web callback; empty clientId leaves OAuth
|
||||
// disabled (isAuthorized() stays false and the Rust backend never starts).
|
||||
const spotifyOAuthClientId = config.spotify.clientId.trim();
|
||||
const spotifyOAuth = new SpotifyOAuth({
|
||||
clientId: spotifyOAuthClientId || undefined,
|
||||
redirectUri: spotifyOAuthClientId
|
||||
? `http://127.0.0.1:${config.webPort}/api/spotify/callback`
|
||||
: undefined,
|
||||
store: createFileOAuthTokenStore(
|
||||
path.join(SPOTIFY_DATA_DIR, "oauth", "oauth-tokens.json"),
|
||||
),
|
||||
});
|
||||
|
||||
const botManager = new BotManager(
|
||||
neteaseProvider,
|
||||
@@ -59,7 +124,16 @@ async function main() {
|
||||
bilibiliProvider,
|
||||
db,
|
||||
config,
|
||||
logger
|
||||
logger,
|
||||
avatarStore,
|
||||
permissions,
|
||||
CONFIG_PATH,
|
||||
localProvider,
|
||||
kugouProvider,
|
||||
spotifyProvider,
|
||||
SPOTIFY_DATA_DIR,
|
||||
spotifyOAuth,
|
||||
jellyfinProvider
|
||||
);
|
||||
await botManager.loadSavedBots();
|
||||
|
||||
@@ -69,12 +143,18 @@ async function main() {
|
||||
neteaseProvider,
|
||||
qqProvider,
|
||||
bilibiliProvider,
|
||||
localProvider,
|
||||
kugouProvider,
|
||||
spotifyProvider,
|
||||
jellyfinProvider,
|
||||
database: db,
|
||||
avatarStore,
|
||||
config,
|
||||
configPath: CONFIG_PATH,
|
||||
logger,
|
||||
cookieStore,
|
||||
staticDir: STATIC_DIR,
|
||||
spotifyOAuth,
|
||||
});
|
||||
await webServer.start();
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { describeQqApiStartupError } from "./api-server.js";
|
||||
|
||||
describe("describeQqApiStartupError", () => {
|
||||
it("flags ERR_REQUIRE_ESM by error code with version-pin guidance", () => {
|
||||
const hint = describeQqApiStartupError({ code: "ERR_REQUIRE_ESM", message: "..." });
|
||||
expect(hint).toMatch(/ERR_REQUIRE_ESM/);
|
||||
expect(hint).toMatch(/~2\.4\.0/);
|
||||
expect(hint).toMatch(/~2\.2\.10/);
|
||||
});
|
||||
|
||||
it("flags ERR_REQUIRE_ESM by message when the code is absent", () => {
|
||||
const hint = describeQqApiStartupError(
|
||||
new Error("require() of ES Module .../@sansenjian/qq-music-api/dist/index.js not supported")
|
||||
);
|
||||
expect(hint).toMatch(/incompatible @sansenjian\/qq-music-api/);
|
||||
});
|
||||
|
||||
it("flags a Node engine mismatch with a Node-upgrade hint", () => {
|
||||
const hint = describeQqApiStartupError(new Error("Unsupported engine: requires Node >=20.17"));
|
||||
expect(hint).toMatch(/Node >=20\.17/);
|
||||
expect(hint).toMatch(/~2\.2\.10/);
|
||||
});
|
||||
|
||||
it("returns null for an unrelated startup error (falls back to the generic warning)", () => {
|
||||
expect(describeQqApiStartupError(new Error("EADDRINUSE: port in use"))).toBeNull();
|
||||
expect(describeQqApiStartupError(undefined)).toBeNull();
|
||||
expect(describeQqApiStartupError(null)).toBeNull();
|
||||
});
|
||||
});
|
||||
+69
-22
@@ -5,6 +5,10 @@ import type { Server } from "node:http";
|
||||
export interface ApiServerOptions {
|
||||
neteasePort: number;
|
||||
qqMusicPort: number;
|
||||
/** Provider gating (#enabledProviders): when false, the corresponding
|
||||
* embedded sidecar API server is never started and its port never bound. */
|
||||
neteaseEnabled?: boolean;
|
||||
qqEnabled?: boolean;
|
||||
}
|
||||
|
||||
export interface ApiServerManager {
|
||||
@@ -14,6 +18,32 @@ export interface ApiServerManager {
|
||||
getQQMusicBaseUrl(): string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Classify a QQ Music API (@sansenjian/qq-music-api) startup failure into
|
||||
* actionable operator guidance, or null when it isn't a recognised
|
||||
* dependency/runtime mismatch. Exported for testing.
|
||||
*
|
||||
* Background: the package became ESM in 2.3.x. A loose `^` range could pull an
|
||||
* ESM-only build (2.3.0/2.3.1) that throws ERR_REQUIRE_ESM, or a 2.4.x build
|
||||
* that needs Node >=20.17 — either way the embedded server never binds, so
|
||||
* every QQ request fails downstream with ECONNREFUSED on the API port.
|
||||
*/
|
||||
export function describeQqApiStartupError(err: unknown): string | null {
|
||||
const e = (err ?? {}) as { code?: string; message?: string };
|
||||
const code = String(e.code ?? "");
|
||||
const msg = String(e.message ?? "");
|
||||
if (code === "ERR_REQUIRE_ESM" || /ERR_REQUIRE_ESM|require\(\) of ES ?Module/i.test(msg)) {
|
||||
return (
|
||||
"an incompatible @sansenjian/qq-music-api build is installed (ERR_REQUIRE_ESM). " +
|
||||
"Pin it to ~2.4.0 (needs Node >=20.17) or ~2.2.10 in package.json, then reinstall"
|
||||
);
|
||||
}
|
||||
if (/Unsupported engine|EBADENGINE|requires Node|Node\.js version/i.test(msg)) {
|
||||
return "@sansenjian/qq-music-api 2.4.x requires Node >=20.17 (or >=22.9) — upgrade Node, or pin the package to ~2.2.10";
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function isPortFree(port: number): Promise<boolean> {
|
||||
return new Promise((resolve) => {
|
||||
const server = net.createServer();
|
||||
@@ -39,34 +69,43 @@ export function createApiServerManager(
|
||||
|
||||
return {
|
||||
async start(): Promise<void> {
|
||||
// Provider gating: with the jellyfin-only default config neither legacy
|
||||
// sidecar starts, so ports 3001/3200 are never opened.
|
||||
if (options.neteaseEnabled === false && options.qqEnabled === false) {
|
||||
logger.info("NetEase/QQ providers disabled — embedded music API servers not started");
|
||||
return;
|
||||
}
|
||||
logger.info("Starting embedded music API servers...");
|
||||
|
||||
// Start NetEase Cloud Music API
|
||||
try {
|
||||
const portFree = await isPortFree(options.neteasePort);
|
||||
if (!portFree) {
|
||||
logger.info(
|
||||
{ port: options.neteasePort },
|
||||
"NetEase API port already in use — reusing existing instance"
|
||||
);
|
||||
} else {
|
||||
const ncmModule = await import("NeteaseCloudMusicApi") as any;
|
||||
const serverObj = ncmModule.server ?? ncmModule.default?.server;
|
||||
const app = await serverObj.serveNcmApi({ port: options.neteasePort });
|
||||
neteaseServer = app;
|
||||
logger.info(
|
||||
{ port: options.neteasePort },
|
||||
"NetEase Cloud Music API started"
|
||||
);
|
||||
if (options.neteaseEnabled !== false) {
|
||||
try {
|
||||
const portFree = await isPortFree(options.neteasePort);
|
||||
if (!portFree) {
|
||||
logger.info(
|
||||
{ port: options.neteasePort },
|
||||
"NetEase API port already in use — reusing existing instance"
|
||||
);
|
||||
} else {
|
||||
const ncmModule = await import("NeteaseCloudMusicApi") as any;
|
||||
const serverObj = ncmModule.server ?? ncmModule.default?.server;
|
||||
const app = await serverObj.serveNcmApi({ port: options.neteasePort });
|
||||
neteaseServer = app;
|
||||
logger.info(
|
||||
{ port: options.neteasePort },
|
||||
"NetEase Cloud Music API started"
|
||||
);
|
||||
}
|
||||
} catch (err) {
|
||||
logger.error({ err }, "Failed to start NetEase Cloud Music API");
|
||||
}
|
||||
} catch (err) {
|
||||
logger.error({ err }, "Failed to start NetEase Cloud Music API");
|
||||
}
|
||||
|
||||
// Start QQ Music API. Older versions auto-started on import; the
|
||||
// current fork (2.2.11+) only listens when run as `require.main`,
|
||||
// so we explicitly call .listen() on the imported Koa app and keep
|
||||
// the server handle for clean shutdown.
|
||||
if (options.qqEnabled === false) return;
|
||||
try {
|
||||
const portFree = await isPortFree(options.qqMusicPort);
|
||||
if (!portFree) {
|
||||
@@ -100,10 +139,18 @@ export function createApiServerManager(
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
logger.warn(
|
||||
{ err },
|
||||
"QQ Music API not available — QQ Music features may be limited"
|
||||
);
|
||||
const hint = describeQqApiStartupError(err);
|
||||
if (hint) {
|
||||
logger.error(
|
||||
{ err },
|
||||
`QQ Music API failed to start — ${hint}. QQ features (search/play/login) will be unavailable until fixed; port ${options.qqMusicPort} is down.`
|
||||
);
|
||||
} else {
|
||||
logger.warn(
|
||||
{ err },
|
||||
"QQ Music API not available — QQ Music features may be limited"
|
||||
);
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
|
||||
+8
-4
@@ -1,9 +1,13 @@
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
|
||||
/** Platforms with a persisted credential blob. For jellyfin the "cookie" is a
|
||||
* JSON string carrying the access token / userId / deviceId (see jellyfin.ts). */
|
||||
type CookiePlatform = "netease" | "qq" | "bilibili" | "kugou" | "jellyfin";
|
||||
|
||||
export interface CookieStore {
|
||||
save(platform: "netease" | "qq" | "bilibili", cookie: string): void;
|
||||
load(platform: "netease" | "qq" | "bilibili"): string;
|
||||
save(platform: CookiePlatform, cookie: string): void;
|
||||
load(platform: CookiePlatform): string;
|
||||
}
|
||||
|
||||
export function createCookieStore(cookieDir: string): CookieStore {
|
||||
@@ -12,7 +16,7 @@ export function createCookieStore(cookieDir: string): CookieStore {
|
||||
}
|
||||
|
||||
return {
|
||||
save(platform: "netease" | "qq" | "bilibili", cookie: string): void {
|
||||
save(platform: CookiePlatform, cookie: string): void {
|
||||
const filePath = path.join(cookieDir, `${platform}.json`);
|
||||
fs.writeFileSync(
|
||||
filePath,
|
||||
@@ -21,7 +25,7 @@ export function createCookieStore(cookieDir: string): CookieStore {
|
||||
);
|
||||
},
|
||||
|
||||
load(platform: "netease" | "qq" | "bilibili"): string {
|
||||
load(platform: CookiePlatform): string {
|
||||
const filePath = path.join(cookieDir, `${platform}.json`);
|
||||
if (!fs.existsSync(filePath)) return "";
|
||||
try {
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { BiliBiliProvider } from "./bilibili.js";
|
||||
|
||||
describe("BiliBiliProvider.search pagination", () => {
|
||||
function mockProvider() {
|
||||
const p = new BiliBiliProvider();
|
||||
const get = vi.fn().mockResolvedValue({ data: { data: { result: [] } } });
|
||||
// Short-circuit the buvid + wbi bootstrap so search only issues the
|
||||
// /search/type request we want to inspect.
|
||||
(p as any).buvidInitialized = true;
|
||||
(p as any).wbiMixinKey = "0".repeat(32);
|
||||
(p as any).wbiKeyFetchedAt = Date.now();
|
||||
(p as any).api = { get };
|
||||
return { p, get };
|
||||
}
|
||||
|
||||
function searchParams(get: ReturnType<typeof vi.fn>) {
|
||||
const call = get.mock.calls.find(
|
||||
(c: any[]) => c[0] === "/x/web-interface/wbi/search/type"
|
||||
);
|
||||
expect(call, "expected a /search/type call").toBeTruthy();
|
||||
// signWbi stringifies every value.
|
||||
return call![1].params as Record<string, string>;
|
||||
}
|
||||
|
||||
it("adds page (offset/limit+1) alongside page_size", async () => {
|
||||
const { p, get } = mockProvider();
|
||||
await p.search("hello", 20, 20); // page 2
|
||||
const params = searchParams(get);
|
||||
expect(params.page).toBe("2");
|
||||
expect(params.page_size).toBe("20");
|
||||
});
|
||||
|
||||
it("defaults offset to 0 → page 1 (backward compatible)", async () => {
|
||||
const { p, get } = mockProvider();
|
||||
await p.search("hello", 20);
|
||||
expect(searchParams(get).page).toBe("1");
|
||||
});
|
||||
});
|
||||
+74
-9
@@ -1,7 +1,9 @@
|
||||
import { createHash } from "node:crypto";
|
||||
import axios, { type AxiosInstance } from "axios";
|
||||
import type {
|
||||
MusicProvider,
|
||||
Song,
|
||||
SongUrlResult,
|
||||
Playlist,
|
||||
LyricLine,
|
||||
SearchResult,
|
||||
@@ -15,6 +17,16 @@ const BILIBILI_HEADERS = {
|
||||
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
|
||||
};
|
||||
|
||||
// Permutation used by B站 to derive the wbi mixin key from img_key+sub_key.
|
||||
const WBI_MIXIN_KEY_ENC_TAB = [
|
||||
46, 47, 18, 2, 53, 8, 23, 32, 15, 50, 10, 31, 58, 3, 45, 35, 27, 43, 5, 49,
|
||||
33, 9, 42, 19, 29, 28, 14, 39, 12, 38, 41, 13, 37, 48, 7, 16, 24, 55, 40, 61,
|
||||
26, 17, 0, 1, 60, 51, 30, 4, 22, 25, 54, 21, 56, 59, 6, 63, 57, 62, 11, 36,
|
||||
20, 34, 44, 52,
|
||||
];
|
||||
|
||||
const WBI_KEY_TTL_MS = 6 * 60 * 60 * 1000; // wbi keys rotate ~daily; refresh every 6h
|
||||
|
||||
export class BiliBiliProvider implements MusicProvider {
|
||||
readonly platform = "bilibili" as const;
|
||||
private api: AxiosInstance;
|
||||
@@ -24,6 +36,8 @@ export class BiliBiliProvider implements MusicProvider {
|
||||
private cidCache = new Map<string, number>();
|
||||
private buvidCookie = ""; // anonymous session cookie (buvid3) for anti-412
|
||||
private buvidInitialized = false;
|
||||
private wbiMixinKey = "";
|
||||
private wbiKeyFetchedAt = 0;
|
||||
|
||||
constructor() {
|
||||
this.api = axios.create({
|
||||
@@ -62,6 +76,50 @@ export class BiliBiliProvider implements MusicProvider {
|
||||
return combined ? { Cookie: combined } : {};
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch wbi img_key/sub_key from /x/web-interface/nav and derive the
|
||||
* mixin key used to sign search params. Required since B站 moved the
|
||||
* search endpoint behind wbi signing — unsigned /search/type now
|
||||
* returns an anti-bot HTML page.
|
||||
*/
|
||||
private async ensureWbiKeys(): Promise<void> {
|
||||
if (this.wbiMixinKey && Date.now() - this.wbiKeyFetchedAt < WBI_KEY_TTL_MS) {
|
||||
return;
|
||||
}
|
||||
const res = await this.api.get("/x/web-interface/nav", {
|
||||
headers: this.cookieHeaders,
|
||||
validateStatus: () => true, // nav returns -101 when not logged in but still includes wbi_img
|
||||
});
|
||||
const wbi = res.data?.data?.wbi_img;
|
||||
const imgUrl: string = wbi?.img_url ?? "";
|
||||
const subUrl: string = wbi?.sub_url ?? "";
|
||||
const imgKey = imgUrl.split("/").pop()?.split(".")[0] ?? "";
|
||||
const subKey = subUrl.split("/").pop()?.split(".")[0] ?? "";
|
||||
if (!imgKey || !subKey) {
|
||||
throw new Error("Bilibili wbi keys unavailable");
|
||||
}
|
||||
const raw = imgKey + subKey;
|
||||
this.wbiMixinKey = WBI_MIXIN_KEY_ENC_TAB.map((i) => raw[i] ?? "")
|
||||
.join("")
|
||||
.slice(0, 32);
|
||||
this.wbiKeyFetchedAt = Date.now();
|
||||
}
|
||||
|
||||
/** Sign params for wbi-protected endpoints. Returns a new params object including wts and w_rid. */
|
||||
private signWbi(params: Record<string, string | number>): Record<string, string> {
|
||||
const withTs: Record<string, string> = {};
|
||||
for (const [k, v] of Object.entries(params)) withTs[k] = String(v);
|
||||
withTs.wts = String(Math.floor(Date.now() / 1000));
|
||||
const sorted = Object.keys(withTs)
|
||||
.sort()
|
||||
.map((k) => `${encodeURIComponent(k)}=${encodeURIComponent(withTs[k])}`)
|
||||
.join("&");
|
||||
withTs.w_rid = createHash("md5")
|
||||
.update(sorted + this.wbiMixinKey)
|
||||
.digest("hex");
|
||||
return withTs;
|
||||
}
|
||||
|
||||
setQuality(quality: string): void {
|
||||
this.quality = quality;
|
||||
}
|
||||
@@ -89,14 +147,20 @@ export class BiliBiliProvider implements MusicProvider {
|
||||
return fixed;
|
||||
}
|
||||
|
||||
async search(query: string, limit = 20): Promise<SearchResult> {
|
||||
async search(query: string, limit = 20, offset = 0): Promise<SearchResult> {
|
||||
await this.ensureBuvidCookie();
|
||||
const res = await this.api.get("/x/web-interface/search/type", {
|
||||
params: {
|
||||
search_type: "video",
|
||||
keyword: query,
|
||||
page_size: limit,
|
||||
},
|
||||
await this.ensureWbiKeys();
|
||||
// /search/type is page-based; the web pages in limit-aligned steps so
|
||||
// offset is a multiple of page_size.
|
||||
const page = Math.floor(offset / limit) + 1;
|
||||
const signed = this.signWbi({
|
||||
search_type: "video",
|
||||
keyword: query,
|
||||
page,
|
||||
page_size: limit,
|
||||
});
|
||||
const res = await this.api.get("/x/web-interface/wbi/search/type", {
|
||||
params: signed,
|
||||
headers: this.cookieHeaders,
|
||||
});
|
||||
|
||||
@@ -172,7 +236,7 @@ export class BiliBiliProvider implements MusicProvider {
|
||||
return this.cidCache.get(bvid) ?? null;
|
||||
}
|
||||
|
||||
async getSongUrl(songId: string, _quality?: string): Promise<string | null> {
|
||||
async getSongUrl(songId: string, _quality?: string): Promise<SongUrlResult | null> {
|
||||
const cid = await this.getCid(songId);
|
||||
if (!cid) return null;
|
||||
|
||||
@@ -194,7 +258,8 @@ export class BiliBiliProvider implements MusicProvider {
|
||||
(b.bandwidth ?? 0) > (a.bandwidth ?? 0) ? b : a
|
||||
);
|
||||
|
||||
return best.baseUrl ?? best.base_url ?? null;
|
||||
const biliUrl = best.baseUrl ?? best.base_url;
|
||||
return biliUrl ? { url: biliUrl } : null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,386 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import {
|
||||
ticksToSeconds,
|
||||
TICKS_PER_SECOND,
|
||||
buildCoverUrl,
|
||||
buildStreamUrl,
|
||||
buildUniversalUrl,
|
||||
mapJellyfinSong,
|
||||
mapJellyfinAlbum,
|
||||
mapJellyfinPlaylist,
|
||||
mapJellyfinLyrics,
|
||||
describeJellyfinError,
|
||||
JELLYFIN_QUALITY_LEVELS,
|
||||
JellyfinProvider,
|
||||
} from "./jellyfin.js";
|
||||
import type { JellyfinConfig } from "../data/config.js";
|
||||
|
||||
function cfg(partial: Partial<JellyfinConfig> = {}): JellyfinConfig {
|
||||
return {
|
||||
serverUrl: "https://jf.example.com",
|
||||
authMode: "apikey",
|
||||
username: "",
|
||||
password: "",
|
||||
apiKey: "KEY",
|
||||
userId: "user-1",
|
||||
...partial,
|
||||
};
|
||||
}
|
||||
|
||||
/** Provider with a mocked axios instance; returns the request spy. */
|
||||
function mockProvider(config = cfg(), responder?: (req: any) => any) {
|
||||
const p = new JellyfinProvider();
|
||||
p.configure(config);
|
||||
const request = vi.fn(async (req: any) => ({
|
||||
data: responder ? responder(req) : { Items: [] },
|
||||
}));
|
||||
(p as any).api = { request, post: vi.fn() };
|
||||
return { p, request };
|
||||
}
|
||||
|
||||
describe("Jellyfin mapping helpers", () => {
|
||||
it("converts ticks to seconds (1 tick = 100ns)", () => {
|
||||
expect(ticksToSeconds(TICKS_PER_SECOND)).toBe(1);
|
||||
expect(ticksToSeconds(2_275_000_000)).toBeCloseTo(227.5, 3);
|
||||
expect(ticksToSeconds(undefined)).toBe(0);
|
||||
expect(ticksToSeconds(NaN)).toBe(0);
|
||||
});
|
||||
|
||||
it("maps a Jellyfin audio item to Song (GUID id stays a string)", () => {
|
||||
const song = mapJellyfinSong(
|
||||
{
|
||||
Id: "3fa85f6457174562b3fc2c963f66afa6",
|
||||
Name: "Track",
|
||||
Artists: ["A", "B"],
|
||||
AlbumArtist: "A",
|
||||
Album: "The Album",
|
||||
RunTimeTicks: 1_855_000_000,
|
||||
},
|
||||
"https://jf/x.jpg",
|
||||
);
|
||||
expect(song).toEqual({
|
||||
id: "3fa85f6457174562b3fc2c963f66afa6",
|
||||
name: "Track",
|
||||
artist: "A / B",
|
||||
album: "The Album",
|
||||
duration: 186, // 185.5s rounded
|
||||
coverUrl: "https://jf/x.jpg",
|
||||
platform: "jellyfin",
|
||||
});
|
||||
});
|
||||
|
||||
it("falls back to AlbumArtist when Artists is empty", () => {
|
||||
const song = mapJellyfinSong({ Id: "1", Artists: [], AlbumArtist: "Solo" }, "");
|
||||
expect(song.artist).toBe("Solo");
|
||||
});
|
||||
|
||||
it("maps albums and playlists with ChildCount", () => {
|
||||
const album = mapJellyfinAlbum(
|
||||
{ Id: "a1", Name: "LP", AlbumArtist: "X", ChildCount: 10 },
|
||||
"c",
|
||||
);
|
||||
expect(album).toMatchObject({ id: "a1", artist: "X", songCount: 10, platform: "jellyfin" });
|
||||
const pl = mapJellyfinPlaylist({ Id: "p1", Name: "Mix", ChildCount: 7 }, "c");
|
||||
expect(pl).toMatchObject({ id: "p1", songCount: 7, platform: "jellyfin" });
|
||||
});
|
||||
|
||||
it("cover URL prefers the item's Primary image, falls back to the album's", () => {
|
||||
const own = buildCoverUrl("https://jf", "K", {
|
||||
Id: "i1",
|
||||
ImageTags: { Primary: "tag1" },
|
||||
AlbumId: "a1",
|
||||
AlbumPrimaryImageTag: "tag2",
|
||||
});
|
||||
expect(own).toBe("https://jf/Items/i1/Images/Primary?maxWidth=512&tag=tag1&api_key=K");
|
||||
const album = buildCoverUrl("https://jf", "K", {
|
||||
Id: "i1",
|
||||
AlbumId: "a1",
|
||||
AlbumPrimaryImageTag: "tag2",
|
||||
});
|
||||
expect(album).toBe("https://jf/Items/a1/Images/Primary?maxWidth=512&tag=tag2&api_key=K");
|
||||
expect(buildCoverUrl("https://jf", "K", { Id: "i1" })).toBe("");
|
||||
});
|
||||
|
||||
it("builds direct and transcoded stream URLs", () => {
|
||||
expect(buildStreamUrl("https://jf", "K", "i1")).toBe(
|
||||
"https://jf/Audio/i1/stream?static=true&api_key=K",
|
||||
);
|
||||
const url = buildUniversalUrl("https://jf", {
|
||||
apiKey: "K",
|
||||
userId: "u",
|
||||
deviceId: "d",
|
||||
itemId: "i1",
|
||||
kbps: 320,
|
||||
});
|
||||
expect(url).toContain("https://jf/Audio/i1/universal?");
|
||||
expect(url).toContain("maxStreamingBitrate=320000");
|
||||
expect(url).toContain("transcodingContainer=mp3");
|
||||
expect(url).toContain("transcodingProtocol=http");
|
||||
// The container list must be URL-encoded ("|" → %7C)
|
||||
expect(url).toContain("container=mp3%2Caac%2Cm4a%7Caac%2Cflac%2Cwebma%2Cwebm%2Cwav%2Cogg");
|
||||
});
|
||||
|
||||
it("maps lyrics with tick offsets; entries without Start collapse to 0; empty text dropped", () => {
|
||||
const lines = mapJellyfinLyrics({
|
||||
Lyrics: [
|
||||
{ Text: "line two", Start: 125_000_000 },
|
||||
{ Text: "line one", Start: 5_000_000 },
|
||||
{ Text: " ", Start: 1 },
|
||||
{ Text: "untimed" },
|
||||
],
|
||||
});
|
||||
expect(lines).toEqual([
|
||||
{ time: 0, text: "untimed" },
|
||||
{ time: 0.5, text: "line one" },
|
||||
{ time: 12.5, text: "line two" },
|
||||
]);
|
||||
});
|
||||
|
||||
it("mapJellyfinLyrics tolerates junk payloads", () => {
|
||||
expect(mapJellyfinLyrics(null)).toEqual([]);
|
||||
expect(mapJellyfinLyrics({})).toEqual([]);
|
||||
expect(mapJellyfinLyrics({ Lyrics: "nope" })).toEqual([]);
|
||||
});
|
||||
|
||||
it("describes common connection errors in a friendly way", () => {
|
||||
expect(describeJellyfinError({ response: { status: 401 } })).toContain("401");
|
||||
expect(describeJellyfinError({ code: "ECONNREFUSED" })).toContain("无法连接");
|
||||
expect(describeJellyfinError(new Error("boom"))).toBe("boom");
|
||||
});
|
||||
});
|
||||
|
||||
describe("JellyfinProvider", () => {
|
||||
it("quality: defaults to direct, ignores foreign (NetEase) values", () => {
|
||||
const p = new JellyfinProvider();
|
||||
expect(p.getQuality()).toBe("direct");
|
||||
p.setQuality("exhigh"); // NetEase value from the legacy platform-less broadcast
|
||||
expect(p.getQuality()).toBe("direct");
|
||||
p.setQuality("320");
|
||||
expect(p.getQuality()).toBe("320");
|
||||
expect(JELLYFIN_QUALITY_LEVELS[0].value).toBe("direct");
|
||||
});
|
||||
|
||||
it("getSongUrl: direct tier → static stream; 320 tier → universal transcode", async () => {
|
||||
const { p } = mockProvider();
|
||||
p.setCookie(JSON.stringify({ deviceId: "dev-1" }));
|
||||
const direct = await p.getSongUrl("item1");
|
||||
expect(direct?.url).toBe("https://jf.example.com/Audio/item1/stream?static=true&api_key=KEY");
|
||||
|
||||
p.setQuality("320");
|
||||
const transcoded = await p.getSongUrl("item1");
|
||||
expect(transcoded?.url).toContain("/Audio/item1/universal?");
|
||||
expect(transcoded?.url).toContain("maxStreamingBitrate=320000");
|
||||
expect(transcoded?.url).toContain("api_key=KEY");
|
||||
});
|
||||
|
||||
it("search hits /Items for Audio, MusicAlbum and Playlist with paging", async () => {
|
||||
const { p, request } = mockProvider();
|
||||
await p.search("mozart", 30, 60);
|
||||
const types = request.mock.calls.map((c) => c[0].params?.IncludeItemTypes);
|
||||
expect(types).toContain("Audio");
|
||||
expect(types).toContain("MusicAlbum");
|
||||
expect(types).toContain("Playlist");
|
||||
for (const call of request.mock.calls) {
|
||||
expect(call[0].params.Limit).toBe(30);
|
||||
expect(call[0].params.StartIndex).toBe(60);
|
||||
expect(call[0].params.userId).toBe("user-1");
|
||||
expect(call[0].headers["X-Emby-Token"]).toBe("KEY");
|
||||
}
|
||||
});
|
||||
|
||||
it("userpass: authenticates once via AuthenticateByName, persists token, retries once on 401", async () => {
|
||||
const p = new JellyfinProvider();
|
||||
p.configure(cfg({ authMode: "userpass", username: "eric", password: "pw", apiKey: "", userId: "" }));
|
||||
const persisted: string[] = [];
|
||||
p.setPersist((s) => persisted.push(s));
|
||||
|
||||
let tokenCounter = 0;
|
||||
const post = vi.fn(async (..._args: any[]) => ({
|
||||
data: { AccessToken: `tok-${++tokenCounter}`, User: { Id: "u9" } },
|
||||
}));
|
||||
// First data request 401s (expired token), the retry succeeds.
|
||||
let dataCalls = 0;
|
||||
const request = vi.fn(async (req: any) => {
|
||||
dataCalls++;
|
||||
if (dataCalls === 1) {
|
||||
const err: any = new Error("Unauthorized");
|
||||
err.response = { status: 401 };
|
||||
throw err;
|
||||
}
|
||||
return { data: { Items: [{ Id: "s1", Name: "N" }] }, config: req };
|
||||
});
|
||||
(p as any).api = { request, post };
|
||||
|
||||
const songs = await p.getPlaylistSongs("pl1");
|
||||
expect(songs).toHaveLength(1);
|
||||
// login ran twice: initial auth + re-auth after the 401
|
||||
expect(post).toHaveBeenCalledTimes(2);
|
||||
const authHeader = post.mock.calls[0][2].headers.Authorization as string;
|
||||
expect(authHeader).toContain('MediaBrowser Client="TSMusicBot"');
|
||||
expect(authHeader).toContain("DeviceId=");
|
||||
expect(post.mock.calls[0][1]).toEqual({ Username: "eric", Pw: "pw" });
|
||||
// token + userId + deviceId persisted like cookies
|
||||
const last = JSON.parse(persisted[persisted.length - 1]);
|
||||
expect(last.accessToken).toBe("tok-2");
|
||||
expect(last.userId).toBe("u9");
|
||||
expect(last.deviceId).toBeTruthy();
|
||||
});
|
||||
|
||||
it("userpass: surfaces the error when the retry also 401s (single retry only)", async () => {
|
||||
const p = new JellyfinProvider();
|
||||
p.configure(cfg({ authMode: "userpass", username: "eric", password: "bad", apiKey: "" }));
|
||||
const post = vi.fn(async () => ({ data: { AccessToken: "t", User: { Id: "u" } } }));
|
||||
const err: any = new Error("Unauthorized");
|
||||
err.response = { status: 401 };
|
||||
const request = vi.fn(async () => {
|
||||
throw err;
|
||||
});
|
||||
(p as any).api = { request, post };
|
||||
await expect(p.getPlaylistSongs("pl1")).rejects.toThrow("Unauthorized");
|
||||
expect(request).toHaveBeenCalledTimes(2); // original + exactly one retry
|
||||
});
|
||||
|
||||
it("setCookie/getCookie round-trip restores token, userId and deviceId", () => {
|
||||
const p = new JellyfinProvider();
|
||||
p.setCookie(JSON.stringify({ accessToken: "T", userId: "U", deviceId: "D" }));
|
||||
expect(JSON.parse(p.getCookie())).toEqual({ accessToken: "T", userId: "U", deviceId: "D" });
|
||||
p.setCookie("not json"); // junk must not corrupt state
|
||||
expect(JSON.parse(p.getCookie())).toEqual({ accessToken: "T", userId: "U", deviceId: "D" });
|
||||
});
|
||||
|
||||
it("getLyrics: 404 means no lyrics (empty), other errors surface", async () => {
|
||||
const notFound: any = new Error("nf");
|
||||
notFound.response = { status: 404 };
|
||||
const { p } = mockProvider(cfg(), () => {
|
||||
throw notFound;
|
||||
});
|
||||
expect(await p.getLyrics("i1")).toEqual([]);
|
||||
|
||||
const boom: any = new Error("server down");
|
||||
boom.response = { status: 500 };
|
||||
const { p: p2 } = mockProvider(cfg(), () => {
|
||||
throw boom;
|
||||
});
|
||||
await expect(p2.getLyrics("i1")).rejects.toThrow("server down");
|
||||
});
|
||||
|
||||
it("getAuthStatus reflects /System/Info reachability; unconfigured = logged out", async () => {
|
||||
const blank = new JellyfinProvider();
|
||||
expect(await blank.getAuthStatus()).toEqual({ loggedIn: false });
|
||||
|
||||
const { p } = mockProvider(cfg(), () => ({ ServerName: "NAS" }));
|
||||
expect(await p.getAuthStatus()).toEqual({ loggedIn: true, nickname: "API Key@NAS" });
|
||||
|
||||
const { p: down } = mockProvider(cfg(), () => {
|
||||
throw new Error("ECONNREFUSED");
|
||||
});
|
||||
expect(await down.getAuthStatus()).toEqual({ loggedIn: false });
|
||||
});
|
||||
|
||||
it("getPersonalFm seeds InstantMix from a random favorite", async () => {
|
||||
const { p, request } = mockProvider(cfg(), (req: any) => {
|
||||
if (req.url.includes("/InstantMix")) {
|
||||
return { Items: [{ Id: "m1", Name: "Mixed" }] };
|
||||
}
|
||||
if (req.params?.Filters === "IsFavorite") {
|
||||
return { Items: [{ Id: "fav1", Name: "Fav" }] };
|
||||
}
|
||||
return { Items: [] };
|
||||
});
|
||||
const songs = await p.getPersonalFm();
|
||||
expect(songs.map((s) => s.id)).toEqual(["m1"]);
|
||||
const mixCall = request.mock.calls.find((c) => c[0].url.includes("/InstantMix"));
|
||||
expect(mixCall![0].url).toContain("/Items/fav1/InstantMix");
|
||||
});
|
||||
|
||||
it("getPersonalFm falls back: favorites → recently played → random", async () => {
|
||||
const { p, request } = mockProvider(cfg(), (req: any) => {
|
||||
if (req.url.includes("/InstantMix")) return { Items: [{ Id: "m2" }] };
|
||||
if (req.params?.Filters === "IsFavorite") return { Items: [] };
|
||||
if (req.params?.Filters === "IsPlayed") return { Items: [{ Id: "recent1" }] };
|
||||
return { Items: [] };
|
||||
});
|
||||
const songs = await p.getPersonalFm();
|
||||
expect(songs.map((s) => s.id)).toEqual(["m2"]);
|
||||
const mixCall = request.mock.calls.find((c) => c[0].url.includes("/InstantMix"));
|
||||
expect(mixCall![0].url).toContain("/Items/recent1/InstantMix");
|
||||
});
|
||||
|
||||
it("playback reporter posts start/progress/stopped with PositionTicks", async () => {
|
||||
const bodies: { url: string; data: any }[] = [];
|
||||
const { p } = mockProvider(cfg(), () => ({}));
|
||||
((p as any).api.request as ReturnType<typeof vi.fn>).mockImplementation(
|
||||
async (req: any) => {
|
||||
bodies.push({ url: req.url, data: req.data });
|
||||
return { data: {} };
|
||||
},
|
||||
);
|
||||
|
||||
const reporter = p.createPlaybackReporter();
|
||||
reporter.onTrackStart("song1");
|
||||
reporter.onTick("song1", 90.5, false);
|
||||
reporter.onStop();
|
||||
await vi.waitFor(() => expect(bodies).toHaveLength(3));
|
||||
|
||||
expect(bodies[0].url).toContain("/Sessions/Playing");
|
||||
expect(bodies[0].data.ItemId).toBe("song1");
|
||||
const sessionId = bodies[0].data.PlaySessionId;
|
||||
expect(sessionId).toBeTruthy();
|
||||
|
||||
expect(bodies[1].url).toContain("/Sessions/Playing/Progress");
|
||||
expect(bodies[1].data.PositionTicks).toBe(905_000_000);
|
||||
expect(bodies[1].data.PlaySessionId).toBe(sessionId);
|
||||
|
||||
// Stop carries the LAST reported position so a natural track end counts as played.
|
||||
expect(bodies[2].url).toContain("/Sessions/Playing/Stopped");
|
||||
expect(bodies[2].data.PositionTicks).toBe(905_000_000);
|
||||
});
|
||||
|
||||
it("reporter: a new track start closes the previous session; failures are swallowed", async () => {
|
||||
const bodies: { url: string; data: any }[] = [];
|
||||
const { p } = mockProvider(cfg(), () => ({}));
|
||||
((p as any).api.request as ReturnType<typeof vi.fn>).mockImplementation(
|
||||
async (req: any) => {
|
||||
bodies.push({ url: req.url, data: req.data });
|
||||
if (req.url.includes("/Sessions")) throw new Error("reporting endpoint down");
|
||||
return { data: {} };
|
||||
},
|
||||
);
|
||||
|
||||
const reporter = p.createPlaybackReporter();
|
||||
reporter.onTrackStart("a");
|
||||
reporter.onTick("a", 200, false);
|
||||
reporter.onTrackStart("b"); // must post Stopped for "a" at pos 200, then Playing for "b"
|
||||
reporter.onStop();
|
||||
await vi.waitFor(() => expect(bodies.length).toBeGreaterThanOrEqual(5));
|
||||
|
||||
const stopped = bodies.filter((b) => b.url.includes("/Stopped"));
|
||||
expect(stopped[0].data.ItemId).toBe("a");
|
||||
expect(stopped[0].data.PositionTicks).toBe(2_000_000_000);
|
||||
expect(stopped[1].data.ItemId).toBe("b");
|
||||
// ticks for stale items are ignored
|
||||
reporter.onTick("a", 999, false);
|
||||
expect(bodies.filter((b) => b.url.includes("/Progress"))).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("testConnection reports server info on success and friendly errors on failure", async () => {
|
||||
const { p } = mockProvider(cfg(), () => ({ ServerName: "NAS", Version: "10.9.11" }));
|
||||
expect(await p.testConnection()).toEqual({ ok: true, serverName: "NAS", version: "10.9.11" });
|
||||
|
||||
const bad = new JellyfinProvider();
|
||||
bad.configure(cfg({ apiKey: "", userId: "" }));
|
||||
const res = await bad.testConnection();
|
||||
expect(res.ok).toBe(false);
|
||||
expect(res.error).toContain("apiKey");
|
||||
});
|
||||
|
||||
it("configure drops the cached token when credentials change, keeps deviceId", () => {
|
||||
const p = new JellyfinProvider();
|
||||
p.configure(cfg());
|
||||
p.setCookie(JSON.stringify({ accessToken: "T", userId: "U", deviceId: "D" }));
|
||||
p.configure(cfg({ serverUrl: "https://other.example.com" }));
|
||||
const state = JSON.parse(p.getCookie());
|
||||
expect(state.accessToken).toBe("");
|
||||
expect(state.deviceId).toBe("D");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,741 @@
|
||||
import { readFileSync } from "node:fs";
|
||||
import { dirname, join } from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import crypto from "node:crypto";
|
||||
import axios, { type AxiosError, type AxiosInstance } from "axios";
|
||||
import type { JellyfinConfig } from "../data/config.js";
|
||||
import type { Logger } from "../logger.js";
|
||||
import type {
|
||||
MusicProvider,
|
||||
Song,
|
||||
SongUrlResult,
|
||||
Playlist,
|
||||
PlaylistDetail,
|
||||
LyricLine,
|
||||
SearchResult,
|
||||
QrCodeResult,
|
||||
AuthStatus,
|
||||
Album,
|
||||
} from "./provider.js";
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
/** 1 tick = 100 ns → 10,000,000 ticks = 1 second (Jellyfin RunTimeTicks / lyric Start). */
|
||||
export const TICKS_PER_SECOND = 10_000_000;
|
||||
|
||||
export function ticksToSeconds(ticks: number | null | undefined): number {
|
||||
if (typeof ticks !== "number" || !Number.isFinite(ticks)) return 0;
|
||||
return ticks / TICKS_PER_SECOND;
|
||||
}
|
||||
|
||||
const CLIENT_NAME = "TSMusicBot";
|
||||
|
||||
/** Best-effort package version for the MediaBrowser auth header. */
|
||||
const PKG_VERSION = (() => {
|
||||
try {
|
||||
const pkg = JSON.parse(
|
||||
readFileSync(join(__dirname, "..", "..", "package.json"), "utf-8"),
|
||||
) as { version?: string };
|
||||
return pkg.version ?? "0.0.0";
|
||||
} catch {
|
||||
return "0.0.0";
|
||||
}
|
||||
})();
|
||||
|
||||
// Jellyfin quality tiers replace the NetEase labels for this source. "direct"
|
||||
// (default) streams the original file — the bot re-encodes to Opus anyway, so
|
||||
// this is max quality. The transcode tiers exist for remote/low-bandwidth
|
||||
// Jellyfin servers.
|
||||
export const JELLYFIN_QUALITY_LEVELS = [
|
||||
{ value: "direct", label: "原始直传 Direct", bitrate: 0 },
|
||||
{ value: "320", label: "320kbps 转码", bitrate: 320 },
|
||||
{ value: "192", label: "192kbps 转码", bitrate: 192 },
|
||||
{ value: "128", label: "128kbps 转码", bitrate: 128 },
|
||||
] as const;
|
||||
|
||||
/** Subset of Jellyfin's BaseItemDto that this provider consumes. */
|
||||
export interface JellyfinItem {
|
||||
Id: string;
|
||||
Name?: string;
|
||||
Artists?: string[];
|
||||
AlbumArtist?: string;
|
||||
Album?: string;
|
||||
AlbumId?: string;
|
||||
AlbumPrimaryImageTag?: string;
|
||||
RunTimeTicks?: number;
|
||||
ImageTags?: { Primary?: string };
|
||||
ChildCount?: number;
|
||||
SongCount?: number;
|
||||
Overview?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Primary cover art URL for an item; falls back to the parent album's primary
|
||||
* image (AlbumPrimaryImageTag) and finally to "" (the UI renders a placeholder
|
||||
* for missing art). The api_key query param authenticates browser <img> loads
|
||||
* and the TS-avatar download alike.
|
||||
*/
|
||||
export function buildCoverUrl(baseUrl: string, apiKey: string, item: JellyfinItem): string {
|
||||
if (!baseUrl) return "";
|
||||
const key = apiKey ? `&api_key=${encodeURIComponent(apiKey)}` : "";
|
||||
if (item.ImageTags?.Primary) {
|
||||
return `${baseUrl}/Items/${item.Id}/Images/Primary?maxWidth=512&tag=${item.ImageTags.Primary}${key}`;
|
||||
}
|
||||
if (item.AlbumId && item.AlbumPrimaryImageTag) {
|
||||
return `${baseUrl}/Items/${item.AlbumId}/Images/Primary?maxWidth=512&tag=${item.AlbumPrimaryImageTag}${key}`;
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
/** Direct (untranscoded) stream URL — the default playback path. */
|
||||
export function buildStreamUrl(baseUrl: string, apiKey: string, itemId: string): string {
|
||||
const params = new URLSearchParams({ static: "true", api_key: apiKey });
|
||||
return `${baseUrl}/Audio/${itemId}/stream?${params.toString()}`;
|
||||
}
|
||||
|
||||
/** Server-side transcode URL for the 320/192/128 kbps tiers. */
|
||||
export function buildUniversalUrl(
|
||||
baseUrl: string,
|
||||
o: { apiKey: string; userId: string; deviceId: string; itemId: string; kbps: number },
|
||||
): string {
|
||||
const params = new URLSearchParams({
|
||||
userId: o.userId,
|
||||
deviceId: o.deviceId,
|
||||
api_key: o.apiKey,
|
||||
maxStreamingBitrate: String(o.kbps * 1000),
|
||||
container: "mp3,aac,m4a|aac,flac,webma,webm,wav,ogg",
|
||||
transcodingContainer: "mp3",
|
||||
transcodingProtocol: "http",
|
||||
});
|
||||
return `${baseUrl}/Audio/${o.itemId}/universal?${params.toString()}`;
|
||||
}
|
||||
|
||||
export function mapJellyfinSong(item: JellyfinItem, coverUrl: string): Song {
|
||||
return {
|
||||
id: String(item.Id),
|
||||
name: item.Name ?? "",
|
||||
artist: (item.Artists?.length ? item.Artists : [item.AlbumArtist ?? ""])
|
||||
.filter(Boolean)
|
||||
.join(" / "),
|
||||
album: item.Album ?? "",
|
||||
duration: Math.round(ticksToSeconds(item.RunTimeTicks)),
|
||||
coverUrl,
|
||||
platform: "jellyfin",
|
||||
};
|
||||
}
|
||||
|
||||
export function mapJellyfinAlbum(item: JellyfinItem, coverUrl: string): Album {
|
||||
return {
|
||||
id: String(item.Id),
|
||||
name: item.Name ?? "",
|
||||
artist: item.AlbumArtist ?? (item.Artists ?? []).join(" / "),
|
||||
coverUrl,
|
||||
songCount: item.ChildCount ?? item.SongCount ?? 0,
|
||||
platform: "jellyfin",
|
||||
};
|
||||
}
|
||||
|
||||
export function mapJellyfinPlaylist(item: JellyfinItem, coverUrl: string): Playlist {
|
||||
return {
|
||||
id: String(item.Id),
|
||||
name: item.Name ?? "",
|
||||
coverUrl,
|
||||
songCount: item.ChildCount ?? item.SongCount ?? 0,
|
||||
platform: "jellyfin",
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Map `GET /Audio/{id}/Lyrics` → the bot's synced-lyric format. `Start` is in
|
||||
* ticks; entries without Start (plain-text lyrics) collapse to time 0 so the
|
||||
* lyric view still renders them, just without sync. Translation stays empty —
|
||||
* Jellyfin has no translated-lyrics concept.
|
||||
*/
|
||||
export function mapJellyfinLyrics(payload: unknown): LyricLine[] {
|
||||
const lyrics = (payload as { Lyrics?: { Text?: string; Start?: number }[] })?.Lyrics;
|
||||
if (!Array.isArray(lyrics)) return [];
|
||||
return lyrics
|
||||
.filter((l) => typeof l?.Text === "string" && l.Text.trim() !== "")
|
||||
.map((l) => ({ time: ticksToSeconds(l.Start), text: l.Text!.trim() }))
|
||||
.sort((a, b) => a.time - b.time);
|
||||
}
|
||||
|
||||
/** Operator-friendly connection/auth error description (test-connection UI + logs). */
|
||||
export function describeJellyfinError(err: unknown): string {
|
||||
const e = err as AxiosError;
|
||||
if (e?.response) {
|
||||
const s = e.response.status;
|
||||
if (s === 401) return "认证失败:用户名/密码或 API Key 不正确 (401 Unauthorized)";
|
||||
if (s === 403) return "该账号没有访问权限 (403 Forbidden)";
|
||||
if (s === 404) return "接口不存在——请确认地址指向 Jellyfin 根路径 (404 Not Found)";
|
||||
return `Jellyfin 返回 HTTP ${s}`;
|
||||
}
|
||||
const code = (e as { code?: string })?.code;
|
||||
if (code === "ECONNREFUSED") return "无法连接 Jellyfin 服务器 (connection refused)";
|
||||
if (code === "ENOTFOUND" || code === "EAI_AGAIN") return "无法解析服务器地址 (DNS lookup failed)";
|
||||
if (code === "ETIMEDOUT" || code === "ECONNABORTED") return "连接 Jellyfin 超时 (timeout)";
|
||||
return (err as Error)?.message ?? String(err);
|
||||
}
|
||||
|
||||
/**
|
||||
* Per-bot playback reporting handle. One playback session (PlaySessionId) per
|
||||
* track start; the previous session is closed with its last known position so
|
||||
* Jellyfin's played/PlayCount bookkeeping sees natural track ends as ~complete
|
||||
* plays and mid-track skips as partial ones. Every call is fire-and-forget —
|
||||
* reporting must never affect playback.
|
||||
*/
|
||||
export interface JellyfinPlaybackReporter {
|
||||
onTrackStart(itemId: string): void;
|
||||
onTick(itemId: string, positionSec: number, paused: boolean): void;
|
||||
onStop(): void;
|
||||
}
|
||||
|
||||
interface PersistedAuth {
|
||||
accessToken?: string;
|
||||
userId?: string;
|
||||
deviceId?: string;
|
||||
}
|
||||
|
||||
function emptyConfig(): JellyfinConfig {
|
||||
return { serverUrl: "", authMode: "userpass", username: "", password: "", apiKey: "", userId: "" };
|
||||
}
|
||||
|
||||
export class JellyfinProvider implements MusicProvider {
|
||||
readonly platform = "jellyfin" as const;
|
||||
private api: AxiosInstance;
|
||||
private cfg: JellyfinConfig = emptyConfig();
|
||||
private token = "";
|
||||
private userId = "";
|
||||
private deviceId = "";
|
||||
private quality: string = "direct";
|
||||
private loginPromise: Promise<void> | null = null;
|
||||
private persistFn: ((serialized: string) => void) | null = null;
|
||||
private logger: Logger | null = null;
|
||||
|
||||
constructor(logger?: Logger) {
|
||||
this.api = axios.create({ timeout: 10000 });
|
||||
this.logger = logger ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply (or re-apply, on settings save) the admin-configured connection.
|
||||
* Changing any credential-relevant field drops the cached token so the next
|
||||
* request re-authenticates; the stable deviceId survives reconfiguration.
|
||||
*/
|
||||
configure(cfg: JellyfinConfig): void {
|
||||
const prev = this.cfg;
|
||||
this.cfg = { ...cfg, serverUrl: (cfg.serverUrl ?? "").trim().replace(/\/+$/, "") };
|
||||
const credsChanged =
|
||||
prev.serverUrl !== this.cfg.serverUrl ||
|
||||
prev.authMode !== this.cfg.authMode ||
|
||||
prev.username !== this.cfg.username ||
|
||||
prev.password !== this.cfg.password ||
|
||||
prev.apiKey !== this.cfg.apiKey ||
|
||||
prev.userId !== this.cfg.userId;
|
||||
if (credsChanged) {
|
||||
this.token = "";
|
||||
this.userId = "";
|
||||
}
|
||||
}
|
||||
|
||||
isConfigured(): boolean {
|
||||
return this.cfg.serverUrl.length > 0;
|
||||
}
|
||||
|
||||
/** Wire the on-disk persistence used after a successful login (cookie store). */
|
||||
setPersist(fn: (serialized: string) => void): void {
|
||||
this.persistFn = fn;
|
||||
}
|
||||
|
||||
setQuality(quality: string): void {
|
||||
// Ignore foreign values: the legacy platform-less POST /api/music/quality
|
||||
// broadcasts NetEase levels to every provider, which must not clobber the
|
||||
// jellyfin default ("direct").
|
||||
if (JELLYFIN_QUALITY_LEVELS.some((l) => l.value === quality)) {
|
||||
this.quality = quality;
|
||||
}
|
||||
}
|
||||
|
||||
getQuality(): string {
|
||||
return this.quality;
|
||||
}
|
||||
|
||||
// --- Auth ---
|
||||
|
||||
private authHeader(): string {
|
||||
return (
|
||||
`MediaBrowser Client="${CLIENT_NAME}", Device="${CLIENT_NAME}", ` +
|
||||
`DeviceId="${this.deviceId}", Version="${PKG_VERSION}"`
|
||||
);
|
||||
}
|
||||
|
||||
private ensureDeviceId(): void {
|
||||
if (!this.deviceId) {
|
||||
this.deviceId = crypto.randomUUID();
|
||||
this.persistState();
|
||||
}
|
||||
}
|
||||
|
||||
private persistState(): void {
|
||||
try {
|
||||
this.persistFn?.(this.getCookie());
|
||||
} catch (err) {
|
||||
this.logger?.warn({ err }, "Failed to persist Jellyfin auth state");
|
||||
}
|
||||
}
|
||||
|
||||
private async login(): Promise<void> {
|
||||
this.ensureDeviceId();
|
||||
const res = await this.api.post(
|
||||
`${this.cfg.serverUrl}/Users/AuthenticateByName`,
|
||||
{ Username: this.cfg.username, Pw: this.cfg.password },
|
||||
{ headers: { Authorization: this.authHeader() } },
|
||||
);
|
||||
const token = res.data?.AccessToken as string | undefined;
|
||||
const userId = res.data?.User?.Id as string | undefined;
|
||||
if (!token || !userId) {
|
||||
throw new Error("Jellyfin 登录响应缺少 AccessToken/User.Id");
|
||||
}
|
||||
this.token = token;
|
||||
this.userId = userId;
|
||||
this.persistState();
|
||||
this.logger?.info({ userId }, "Jellyfin authenticated");
|
||||
}
|
||||
|
||||
private async ensureAuth(): Promise<void> {
|
||||
if (!this.cfg.serverUrl) {
|
||||
throw new Error("Jellyfin 未配置服务器地址 (server URL not configured)");
|
||||
}
|
||||
if (this.cfg.authMode === "apikey") {
|
||||
if (!this.cfg.apiKey || !this.cfg.userId) {
|
||||
throw new Error("Jellyfin API Key 模式需要 apiKey 和 userId");
|
||||
}
|
||||
this.token = this.cfg.apiKey;
|
||||
this.userId = this.cfg.userId;
|
||||
this.ensureDeviceId();
|
||||
return;
|
||||
}
|
||||
if (this.token && this.userId) return;
|
||||
if (!this.cfg.username) {
|
||||
throw new Error("Jellyfin 未配置用户名/密码 (username not configured)");
|
||||
}
|
||||
if (!this.loginPromise) {
|
||||
this.loginPromise = this.login().finally(() => {
|
||||
this.loginPromise = null;
|
||||
});
|
||||
}
|
||||
return this.loginPromise;
|
||||
}
|
||||
|
||||
/** Authenticated request with a single re-auth retry on 401 (userpass mode). */
|
||||
private async request<T = unknown>(
|
||||
method: "get" | "post",
|
||||
path: string,
|
||||
opts: { params?: Record<string, unknown>; data?: unknown; retried?: boolean } = {},
|
||||
): Promise<T> {
|
||||
await this.ensureAuth();
|
||||
// Callers snapshot `userId: this.userId` while building params, which is
|
||||
// still empty before the first login. ensureAuth() has populated it by
|
||||
// now, so backfill the stale-empty snapshot instead of sending userId="".
|
||||
const params = opts.params ? { ...opts.params } : undefined;
|
||||
if (params && "userId" in params && !params.userId) params.userId = this.userId;
|
||||
try {
|
||||
const res = await this.api.request<T>({
|
||||
method,
|
||||
url: this.cfg.serverUrl + path,
|
||||
params,
|
||||
data: opts.data,
|
||||
headers: { "X-Emby-Token": this.token },
|
||||
});
|
||||
return res.data;
|
||||
} catch (err) {
|
||||
const status = (err as AxiosError).response?.status;
|
||||
if (status === 401 && this.cfg.authMode === "userpass" && !opts.retried) {
|
||||
this.token = "";
|
||||
this.userId = "";
|
||||
return this.request(method, path, { ...opts, retried: true });
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
// --- MusicProvider ---
|
||||
|
||||
private coverFor(item: JellyfinItem): string {
|
||||
return buildCoverUrl(this.cfg.serverUrl, this.token, item);
|
||||
}
|
||||
|
||||
private mapSongs(items: JellyfinItem[] | undefined | null): Song[] {
|
||||
return (items ?? []).map((i) => mapJellyfinSong(i, this.coverFor(i)));
|
||||
}
|
||||
|
||||
async search(query: string, limit = 20, offset = 0): Promise<SearchResult> {
|
||||
const common = {
|
||||
searchTerm: query,
|
||||
Recursive: true,
|
||||
Limit: limit,
|
||||
StartIndex: offset,
|
||||
userId: this.userId,
|
||||
};
|
||||
const [songRes, albumRes, playlistRes] = await Promise.all([
|
||||
this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: { ...common, IncludeItemTypes: "Audio" },
|
||||
}),
|
||||
this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: { ...common, IncludeItemTypes: "MusicAlbum", Fields: "ChildCount" },
|
||||
}),
|
||||
this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: { ...common, IncludeItemTypes: "Playlist", Fields: "ChildCount" },
|
||||
}),
|
||||
]);
|
||||
return {
|
||||
songs: this.mapSongs(songRes?.Items),
|
||||
albums: (albumRes?.Items ?? []).map((i) => mapJellyfinAlbum(i, this.coverFor(i))),
|
||||
playlists: (playlistRes?.Items ?? []).map((i) => mapJellyfinPlaylist(i, this.coverFor(i))),
|
||||
};
|
||||
}
|
||||
|
||||
async getSongUrl(songId: string, quality?: string): Promise<SongUrlResult | null> {
|
||||
await this.ensureAuth();
|
||||
const level = quality ?? this.quality;
|
||||
const tier = JELLYFIN_QUALITY_LEVELS.find((l) => l.value === level);
|
||||
if (!tier || tier.value === "direct") {
|
||||
return { url: buildStreamUrl(this.cfg.serverUrl, this.token, songId) };
|
||||
}
|
||||
return {
|
||||
url: buildUniversalUrl(this.cfg.serverUrl, {
|
||||
apiKey: this.token,
|
||||
userId: this.userId,
|
||||
deviceId: this.deviceId,
|
||||
itemId: songId,
|
||||
kbps: tier.bitrate,
|
||||
}),
|
||||
};
|
||||
}
|
||||
|
||||
async getSongDetail(songId: string): Promise<Song | null> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: { ids: songId, userId: this.userId },
|
||||
});
|
||||
const item = res?.Items?.[0];
|
||||
return item ? mapJellyfinSong(item, this.coverFor(item)) : null;
|
||||
}
|
||||
|
||||
async getPlaylistSongs(playlistId: string): Promise<Song[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>(
|
||||
"get",
|
||||
`/Playlists/${playlistId}/Items`,
|
||||
{ params: { userId: this.userId } },
|
||||
);
|
||||
return this.mapSongs(res?.Items);
|
||||
}
|
||||
|
||||
async getAlbumSongs(albumId: string): Promise<Song[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
parentId: albumId,
|
||||
sortBy: "ParentIndexNumber,IndexNumber",
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return this.mapSongs(res?.Items);
|
||||
}
|
||||
|
||||
async getRecommendPlaylists(): Promise<Playlist[]> {
|
||||
return this.getUserPlaylists();
|
||||
}
|
||||
|
||||
async getUserPlaylists(): Promise<Playlist[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
IncludeItemTypes: "Playlist",
|
||||
Recursive: true,
|
||||
Fields: "ChildCount",
|
||||
SortBy: "SortName",
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return (res?.Items ?? []).map((i) => mapJellyfinPlaylist(i, this.coverFor(i)));
|
||||
}
|
||||
|
||||
async getPlaylistDetail(playlistId: string): Promise<PlaylistDetail | null> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: { ids: playlistId, Fields: "ChildCount,Overview", userId: this.userId },
|
||||
});
|
||||
const item = res?.Items?.[0];
|
||||
if (!item) return null;
|
||||
return {
|
||||
id: String(item.Id),
|
||||
name: item.Name ?? "",
|
||||
description: item.Overview ?? "",
|
||||
coverUrl: this.coverFor(item),
|
||||
songCount: item.ChildCount ?? 0,
|
||||
};
|
||||
}
|
||||
|
||||
async getLyrics(songId: string): Promise<LyricLine[]> {
|
||||
try {
|
||||
const res = await this.request<unknown>("get", `/Audio/${songId}/Lyrics`);
|
||||
return mapJellyfinLyrics(res);
|
||||
} catch (err) {
|
||||
// 404 = the track simply has no lyrics — not an error.
|
||||
if ((err as AxiosError).response?.status === 404) return [];
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
// No QR-code login concept — connection is global and admin-configured.
|
||||
async getQrCode(): Promise<QrCodeResult> {
|
||||
return { qrUrl: "", key: "" };
|
||||
}
|
||||
|
||||
async checkQrCodeStatus(): Promise<"waiting" | "scanned" | "confirmed" | "expired"> {
|
||||
return "expired";
|
||||
}
|
||||
|
||||
setCookie(cookie: string): void {
|
||||
try {
|
||||
const parsed = JSON.parse(cookie) as PersistedAuth;
|
||||
if (parsed && typeof parsed === "object") {
|
||||
if (typeof parsed.accessToken === "string") this.token = parsed.accessToken;
|
||||
if (typeof parsed.userId === "string") this.userId = parsed.userId;
|
||||
if (typeof parsed.deviceId === "string") this.deviceId = parsed.deviceId;
|
||||
}
|
||||
} catch {
|
||||
// Not the JSON blob we persist — ignore rather than corrupt auth state.
|
||||
}
|
||||
}
|
||||
|
||||
getCookie(): string {
|
||||
return JSON.stringify({
|
||||
accessToken: this.token,
|
||||
userId: this.userId,
|
||||
deviceId: this.deviceId,
|
||||
});
|
||||
}
|
||||
|
||||
async getAuthStatus(): Promise<AuthStatus> {
|
||||
if (!this.cfg.serverUrl) return { loggedIn: false };
|
||||
try {
|
||||
const info = await this.request<{ ServerName?: string }>("get", "/System/Info");
|
||||
const who = this.cfg.authMode === "apikey" ? "API Key" : this.cfg.username;
|
||||
return { loggedIn: true, nickname: `${who}@${info?.ServerName ?? "Jellyfin"}` };
|
||||
} catch (err) {
|
||||
this.logger?.debug({ err: describeJellyfinError(err) }, "Jellyfin auth status check failed");
|
||||
return { loggedIn: false };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticated round-trip to /System/Info for the Settings "test connection"
|
||||
* button. `candidate` (when given) tests form values in a throwaway instance
|
||||
* so a failed test never disturbs the live token state.
|
||||
*/
|
||||
async testConnection(
|
||||
candidate?: JellyfinConfig,
|
||||
): Promise<{ ok: boolean; serverName?: string; version?: string; error?: string }> {
|
||||
const probe = candidate ? new JellyfinProvider() : this;
|
||||
if (candidate) probe.configure(candidate);
|
||||
try {
|
||||
const info = await probe.request<{ ServerName?: string; Version?: string }>(
|
||||
"get",
|
||||
"/System/Info",
|
||||
);
|
||||
return { ok: true, serverName: info?.ServerName, version: info?.Version };
|
||||
} catch (err) {
|
||||
return { ok: false, error: describeJellyfinError(err) };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Personal FM = Instant Mix seeded from a random favorite, falling back to a
|
||||
* random recently-played track, then a random library track. A final safety
|
||||
* net returns 50 random tracks when Instant Mix itself yields nothing.
|
||||
*/
|
||||
async getPersonalFm(): Promise<Song[]> {
|
||||
const seed = await this.pickFmSeed();
|
||||
if (seed) {
|
||||
const mix = await this.request<{ Items?: JellyfinItem[] }>(
|
||||
"get",
|
||||
`/Items/${seed}/InstantMix`,
|
||||
{ params: { userId: this.userId, limit: 50 } },
|
||||
);
|
||||
const songs = this.mapSongs(mix?.Items);
|
||||
if (songs.length > 0) return songs;
|
||||
}
|
||||
const random = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
SortBy: "Random",
|
||||
Limit: 50,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return this.mapSongs(random?.Items);
|
||||
}
|
||||
|
||||
private async pickFmSeed(): Promise<string | null> {
|
||||
const favorite = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
Filters: "IsFavorite",
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
SortBy: "Random",
|
||||
Limit: 1,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
if (favorite?.Items?.[0]?.Id) return favorite.Items[0].Id;
|
||||
|
||||
const played = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
Filters: "IsPlayed",
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
SortBy: "DatePlayed",
|
||||
SortOrder: "Descending",
|
||||
Limit: 20,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
const playedItems = played?.Items ?? [];
|
||||
if (playedItems.length > 0) {
|
||||
return playedItems[Math.floor(Math.random() * playedItems.length)].Id;
|
||||
}
|
||||
|
||||
const random = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
SortBy: "Random",
|
||||
Limit: 1,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return random?.Items?.[0]?.Id ?? null;
|
||||
}
|
||||
|
||||
// --- Home sections ---
|
||||
|
||||
async getLatestAlbums(limit = 12): Promise<Album[]> {
|
||||
await this.ensureAuth();
|
||||
const items = await this.request<JellyfinItem[]>(
|
||||
"get",
|
||||
`/Users/${this.userId}/Items/Latest`,
|
||||
{ params: { IncludeItemTypes: "MusicAlbum", Limit: limit, Fields: "ChildCount" } },
|
||||
);
|
||||
return (Array.isArray(items) ? items : []).map((i) =>
|
||||
mapJellyfinAlbum(i, this.coverFor(i)),
|
||||
);
|
||||
}
|
||||
|
||||
async getMostPlayed(limit = 12): Promise<Song[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
SortBy: "PlayCount",
|
||||
SortOrder: "Descending",
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
Filters: "IsPlayed",
|
||||
Limit: limit,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return this.mapSongs(res?.Items);
|
||||
}
|
||||
|
||||
async getFavoriteSongs(limit = 100): Promise<Song[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
Filters: "IsFavorite",
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
SortBy: "SortName",
|
||||
Limit: limit,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return this.mapSongs(res?.Items);
|
||||
}
|
||||
|
||||
async getGenres(limit = 30): Promise<{ id: string; name: string }[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/MusicGenres", {
|
||||
params: { userId: this.userId, Limit: limit, SortBy: "SortName" },
|
||||
});
|
||||
return (res?.Items ?? []).map((i) => ({ id: String(i.Id), name: i.Name ?? "" }));
|
||||
}
|
||||
|
||||
async getGenreSongs(genreId: string, limit = 100): Promise<Song[]> {
|
||||
const res = await this.request<{ Items?: JellyfinItem[] }>("get", "/Items", {
|
||||
params: {
|
||||
GenreIds: genreId,
|
||||
IncludeItemTypes: "Audio",
|
||||
Recursive: true,
|
||||
SortBy: "AlbumArtist,Album,SortName",
|
||||
Limit: limit,
|
||||
userId: this.userId,
|
||||
},
|
||||
});
|
||||
return this.mapSongs(res?.Items);
|
||||
}
|
||||
|
||||
// --- Playback reporting (Sessions API) ---
|
||||
|
||||
private async report(path: string, body: Record<string, unknown>): Promise<void> {
|
||||
try {
|
||||
await this.request("post", path, { data: body });
|
||||
} catch (err) {
|
||||
// Reporting must never affect playback — log and swallow.
|
||||
this.logger?.debug(
|
||||
{ err: describeJellyfinError(err), path },
|
||||
"Jellyfin playback report failed",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
createPlaybackReporter(): JellyfinPlaybackReporter {
|
||||
// One session per track start; remember the last reported position so the
|
||||
// implicit stop on track change carries a sane PositionTicks (a natural
|
||||
// track end reports ~full duration → Jellyfin counts the play).
|
||||
let current: { itemId: string; sessionId: string; lastPosSec: number } | null = null;
|
||||
const report = this.report.bind(this);
|
||||
return {
|
||||
onTrackStart(itemId: string): void {
|
||||
if (current) {
|
||||
void report("/Sessions/Playing/Stopped", {
|
||||
ItemId: current.itemId,
|
||||
PlaySessionId: current.sessionId,
|
||||
PositionTicks: Math.round(current.lastPosSec * TICKS_PER_SECOND),
|
||||
});
|
||||
}
|
||||
current = { itemId, sessionId: crypto.randomUUID(), lastPosSec: 0 };
|
||||
void report("/Sessions/Playing", {
|
||||
ItemId: itemId,
|
||||
PlaySessionId: current.sessionId,
|
||||
PositionTicks: 0,
|
||||
CanSeek: true,
|
||||
});
|
||||
},
|
||||
onTick(itemId: string, positionSec: number, paused: boolean): void {
|
||||
if (!current || current.itemId !== itemId) return;
|
||||
current.lastPosSec = positionSec;
|
||||
void report("/Sessions/Playing/Progress", {
|
||||
ItemId: itemId,
|
||||
PlaySessionId: current.sessionId,
|
||||
PositionTicks: Math.round(positionSec * TICKS_PER_SECOND),
|
||||
IsPaused: paused,
|
||||
});
|
||||
},
|
||||
onStop(): void {
|
||||
if (!current) return;
|
||||
void report("/Sessions/Playing/Stopped", {
|
||||
ItemId: current.itemId,
|
||||
PlaySessionId: current.sessionId,
|
||||
PositionTicks: Math.round(current.lastPosSec * TICKS_PER_SECOND),
|
||||
});
|
||||
current = null;
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,224 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { mapKugouSong, mapKugouSongs, mapKugouAlbums, mapKugouPlaylist, mapKugouPlaylists, krcToLrc, KugouProvider } from "./kugou.js";
|
||||
import { parseLyrics } from "./netease.js";
|
||||
|
||||
describe("mapKugouSongs", () => {
|
||||
it("maps the mobile-search song shape to a Song with platform 'kugou'", () => {
|
||||
// Shape captured live from mobilecdn.kugou.com/api/v3/search/song.
|
||||
const raw = {
|
||||
hash: "B3A52A7A958BF0AED0EBFBA2E9A818B7",
|
||||
album_audio_id: 32100650,
|
||||
album_id: "966846",
|
||||
songname: "晴天",
|
||||
singername: "周杰伦",
|
||||
duration: 269,
|
||||
};
|
||||
const [song] = mapKugouSongs([raw]);
|
||||
expect(song.platform).toBe("kugou");
|
||||
expect(song.name).toBe("晴天");
|
||||
expect(song.artist).toBe("周杰伦");
|
||||
expect(song.duration).toBe(269);
|
||||
// The id must round-trip hash + album_audio_id + album_id so getSongUrl
|
||||
// can resolve a stream from a search result.
|
||||
expect(song.id).toBe("b3a52a7a958bf0aed0ebfba2e9a818b7|32100650|966846");
|
||||
});
|
||||
|
||||
it("treats nested audio_info durations as milliseconds and flat search durations as seconds", () => {
|
||||
// List endpoints: ms under audio_info.
|
||||
expect(mapKugouSong({ audio_info: { hash: "abc", duration: 215000 } }).duration).toBe(215);
|
||||
// Search endpoint: a long-form track's flat `duration` stays seconds (no /1000).
|
||||
expect(mapKugouSong({ hash: "abc", songname: "x", duration: 10800 }).duration).toBe(10800);
|
||||
});
|
||||
|
||||
it("falls back to splitting '歌手 - 歌名' from the filename", () => {
|
||||
const song = mapKugouSong({ FileHash: "deadbeef", filename: "周杰伦 - 稻香", Duration: 200 });
|
||||
expect(song.artist).toBe("周杰伦");
|
||||
expect(song.name).toBe("稻香");
|
||||
});
|
||||
|
||||
it("uses PascalCase fields from the gateway shape and skips entries with no hash", () => {
|
||||
const songs = mapKugouSongs([
|
||||
{ FileHash: "aa", SongName: "n", SingerName: "s", MixSongID: 1, AlbumID: 2 },
|
||||
{ songname: "no hash" } as any,
|
||||
]);
|
||||
expect(songs).toHaveLength(1);
|
||||
expect(songs[0].id).toBe("aa|1|2");
|
||||
});
|
||||
|
||||
it("returns [] for non-array input", () => {
|
||||
expect(mapKugouSongs(undefined)).toEqual([]);
|
||||
});
|
||||
|
||||
it("maps the NESTED album/playlist track shape (base + audio_info)", () => {
|
||||
// Shape captured live from /album/songs (叶惠美).
|
||||
const raw = {
|
||||
base: { album_id: 966846, album_audio_id: 32100648, audio_name: "以父之名", author_name: "周杰伦" },
|
||||
audio_info: { hash: "DBC0207490EB51153EF933EF5A7E98E4", duration: 342047 },
|
||||
};
|
||||
const [song] = mapKugouSongs([raw]);
|
||||
expect(song.name).toBe("以父之名");
|
||||
expect(song.artist).toBe("周杰伦");
|
||||
expect(song.duration).toBe(342); // ms → s
|
||||
expect(song.id).toBe("dbc0207490eb51153ef933ef5a7e98e4|32100648|966846");
|
||||
});
|
||||
});
|
||||
|
||||
describe("krcToLrc", () => {
|
||||
it("converts KRC [startMs,durMs] line timestamps + strips word timings into parseable LRC", () => {
|
||||
// Shape captured live from lyrics.kugou.com (周杰伦 - 晴天).
|
||||
const krc = [
|
||||
"[ti:晴天]",
|
||||
"[ar:周杰伦]",
|
||||
"[0,2250]<0,160,0>晴<160,160,0>天",
|
||||
"[63000,1800]<0,200,0>故<200,200,0>事",
|
||||
].join("\n");
|
||||
const lrc = krcToLrc(krc);
|
||||
expect(lrc).toContain("[00:00.00]晴天");
|
||||
expect(lrc).toContain("[01:03.00]故事");
|
||||
expect(lrc).not.toMatch(/<\d+,\d+,\d+>/); // word timings stripped
|
||||
|
||||
// And the shared LRC parser must now actually produce timed lines.
|
||||
const lines = parseLyrics(lrc);
|
||||
expect(lines.length).toBe(2);
|
||||
expect(lines[0]).toEqual({ time: 0, text: "晴天" });
|
||||
expect(lines[1].time).toBe(63);
|
||||
expect(lines[1].text).toBe("故事");
|
||||
});
|
||||
});
|
||||
|
||||
describe("mapKugouAlbums", () => {
|
||||
it("maps album shape and normalises {size} covers to https", () => {
|
||||
const [album] = mapKugouAlbums([
|
||||
{ album_id: 966846, album_name: "叶惠美", singername: "周杰伦", sizable_cover: "http://imge.kugou.com/x/{size}/abc.jpg", songcount: 11 },
|
||||
]);
|
||||
expect(album.platform).toBe("kugou");
|
||||
expect(album.id).toBe("966846");
|
||||
expect(album.name).toBe("叶惠美");
|
||||
expect(album.coverUrl).toBe("https://imge.kugou.com/x/240/abc.jpg");
|
||||
expect(album.songCount).toBe(11);
|
||||
});
|
||||
});
|
||||
|
||||
describe("mapKugouSong — playlist (get_other_list_file) shape", () => {
|
||||
it("splits the combined `name` and uses `mixsongid` as the audio id", () => {
|
||||
// Shape captured live from /pubsongs/v2/get_other_list_file_nofilt (我喜欢).
|
||||
// The combined "歌手 - 歌名" is in `name`; there is no separate songname.
|
||||
const raw = {
|
||||
name: "KOKIA - ありがとう… (谢谢…)",
|
||||
hash: "E9A08A98614DD992F11A68A5E5F1C79F",
|
||||
album_id: "1491689",
|
||||
mixsongid: 37533796,
|
||||
timelen: 248528, // ms
|
||||
cover: "http://imge.kugou.com/stdmusic/{size}/20210113/x.jpg",
|
||||
};
|
||||
const song = mapKugouSong(raw);
|
||||
expect(song.artist).toBe("KOKIA");
|
||||
expect(song.name).toBe("ありがとう… (谢谢…)");
|
||||
// hash lowercased | mixsongid | album_id — so getSongUrl can resolve it.
|
||||
expect(song.id).toBe("e9a08a98614dd992f11a68a5e5f1c79f|37533796|1491689");
|
||||
expect(song.duration).toBe(249); // timelen ms → s
|
||||
expect(song.coverUrl).toBe("https://imge.kugou.com/stdmusic/240/20210113/x.jpg");
|
||||
});
|
||||
});
|
||||
|
||||
describe("mapKugouSong — cover art per endpoint", () => {
|
||||
it("reads `sizable_cover` (daily/FM shape) and resolves {size}→240, http→https", () => {
|
||||
const song = mapKugouSong({
|
||||
hash: "abc",
|
||||
songname: "x",
|
||||
duration: 200,
|
||||
sizable_cover: "http://imge.kugou.com/stdmusic/{size}/y.jpg",
|
||||
});
|
||||
expect(song.coverUrl).toBe("https://imge.kugou.com/stdmusic/240/y.jpg");
|
||||
});
|
||||
|
||||
it("falls back to `trans_param.union_cover` (search shape, no top-level cover)", () => {
|
||||
const song = mapKugouSong({
|
||||
hash: "abc",
|
||||
songname: "x",
|
||||
duration: 200,
|
||||
trans_param: { union_cover: "http://imge.kugou.com/stdmusic/{size}/z.jpg" },
|
||||
});
|
||||
expect(song.coverUrl).toBe("https://imge.kugou.com/stdmusic/240/z.jpg");
|
||||
});
|
||||
|
||||
it("returns an empty coverUrl when no cover field is present", () => {
|
||||
expect(mapKugouSong({ hash: "abc", songname: "x", duration: 200 }).coverUrl).toBe("");
|
||||
});
|
||||
|
||||
it("skips an empty-string cover field (Kugou returns '') and uses the next non-empty source", () => {
|
||||
const song = mapKugouSong({
|
||||
hash: "abc",
|
||||
songname: "x",
|
||||
duration: 200,
|
||||
sizable_cover: "", // present but empty — must NOT mask the real cover below
|
||||
trans_param: { union_cover: "http://imge.kugou.com/stdmusic/{size}/z.jpg" },
|
||||
});
|
||||
expect(song.coverUrl).toBe("https://imge.kugou.com/stdmusic/240/z.jpg");
|
||||
});
|
||||
});
|
||||
|
||||
describe("mapKugouPlaylists", () => {
|
||||
it("maps the user-playlist shape (/v7/get_all_list info), keying id on global_collection_id", () => {
|
||||
// Shape captured live from /v7/get_all_list (我喜欢).
|
||||
const [pl] = mapKugouPlaylists([
|
||||
{ name: "我喜欢", count: 7, global_collection_id: "collection_3_2526507197_2_0", listid: 2, type: 0 },
|
||||
]);
|
||||
expect(pl.platform).toBe("kugou");
|
||||
expect(pl.name).toBe("我喜欢");
|
||||
expect(pl.songCount).toBe(7);
|
||||
// Must be the global_collection_id — the only id getPlaylistSongs can open.
|
||||
expect(pl.id).toBe("collection_3_2526507197_2_0");
|
||||
});
|
||||
|
||||
it("maps the recommend shape (/v2/special_recommend), preferring global_collection_id over specialid", () => {
|
||||
// Shape captured live from /v2/special_recommend special_list.
|
||||
const pl = mapKugouPlaylist({
|
||||
specialname: "米津玄师:蒙着眼睛也能炸翻全场",
|
||||
specialid: 1154672,
|
||||
global_collection_id: "collection_1_1029965246_1154672_0",
|
||||
pic: "http://imge.kugou.com/specialimg/{size}/a.jpg",
|
||||
percount: 0,
|
||||
});
|
||||
expect(pl.id).toBe("collection_1_1029965246_1154672_0");
|
||||
expect(pl.name).toBe("米津玄师:蒙着眼睛也能炸翻全场");
|
||||
expect(pl.coverUrl).toBe("https://imge.kugou.com/specialimg/240/a.jpg");
|
||||
});
|
||||
|
||||
it("drops entries whose only id is a non-openable specialid/listid (not a global_collection_id)", () => {
|
||||
// getPlaylistSongs can only open a global_collection_id, so a numeric
|
||||
// specialid/listid would be a dead id — such entries must be dropped.
|
||||
expect(mapKugouPlaylists([{ specialname: "x", specialid: 1154672, listid: 9 }])).toHaveLength(0);
|
||||
expect(mapKugouPlaylists([{ name: "no id" }])).toHaveLength(0);
|
||||
expect(mapKugouPlaylists(undefined)).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("KugouProvider.search pagination", () => {
|
||||
function mockProvider() {
|
||||
const p = new KugouProvider();
|
||||
const get = vi.fn().mockResolvedValue({ data: { data: { info: [] } } });
|
||||
(p as any).mobileHttp = { get };
|
||||
return { p, get };
|
||||
}
|
||||
|
||||
function searchParams(get: ReturnType<typeof vi.fn>) {
|
||||
const call = get.mock.calls[0];
|
||||
expect(call, "expected a mobile search call").toBeTruthy();
|
||||
return call[1].params as Record<string, unknown>;
|
||||
}
|
||||
|
||||
it("sets page to offset/limit+1 and keeps pagesize=limit", async () => {
|
||||
const { p, get } = mockProvider();
|
||||
await p.search("hello", 20, 20); // page 2
|
||||
const params = searchParams(get);
|
||||
expect(params.page).toBe(2);
|
||||
expect(params.pagesize).toBe(20);
|
||||
});
|
||||
|
||||
it("defaults offset to 0 → page 1 (backward compatible)", async () => {
|
||||
const { p, get } = mockProvider();
|
||||
await p.search("hello", 20);
|
||||
expect(searchParams(get).page).toBe(1);
|
||||
});
|
||||
});
|
||||
+1031
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,235 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
||||
import { mkdtempSync, rmSync, existsSync, writeFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { LocalMusicProvider } from "./local.js";
|
||||
|
||||
let dir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
dir = mkdtempSync(join(tmpdir(), "local-audio-test-"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
// Seed real files + an index.json so we can exercise the cleanup lifecycle
|
||||
// without invoking the ffmpeg duration probe that uploadAudio runs.
|
||||
function makeRecord(id: string, bytes = 16) {
|
||||
const filePath = join(dir, `${id}.mp3`);
|
||||
writeFileSync(filePath, Buffer.alloc(bytes, 1));
|
||||
return {
|
||||
id,
|
||||
name: id,
|
||||
artist: "本地上传",
|
||||
album: "本地音乐",
|
||||
duration: 0,
|
||||
coverUrl: "",
|
||||
platform: "local" as const,
|
||||
filePath,
|
||||
originalName: `${id}.mp3`,
|
||||
uploadedAt: "1970-01-01T00:00:00.000Z",
|
||||
size: bytes,
|
||||
mimeType: "audio/mpeg",
|
||||
};
|
||||
}
|
||||
|
||||
function seed(records: ReturnType<typeof makeRecord>[]) {
|
||||
writeFileSync(join(dir, "index.json"), JSON.stringify(records), "utf8");
|
||||
}
|
||||
|
||||
describe("LocalMusicProvider cleanup lifecycle", () => {
|
||||
it("sweep keeps referenced and never-played files, deletes only played+unreferenced", async () => {
|
||||
const a = makeRecord("a");
|
||||
const b = makeRecord("b");
|
||||
const c = makeRecord("c");
|
||||
seed([a, b, c]);
|
||||
const p = new LocalMusicProvider(dir);
|
||||
const refs = new Set<string>(["a"]); // "a" still sits in a queue somewhere
|
||||
p.setInUseResolver(() => refs);
|
||||
|
||||
await p.getSongUrl("a"); // played, but referenced
|
||||
await p.getSongUrl("b"); // played and unreferenced
|
||||
// "c" was never played (e.g. uploaded but not queued)
|
||||
|
||||
const deleted = p.sweepUnreferenced();
|
||||
|
||||
expect(deleted).toEqual(["b"]);
|
||||
expect(existsSync(a.filePath)).toBe(true); // referenced → kept
|
||||
expect(existsSync(b.filePath)).toBe(false); // played + unreferenced → deleted
|
||||
expect(existsSync(c.filePath)).toBe(true); // never played → kept
|
||||
});
|
||||
|
||||
it("a played song still in the queue survives the sweep and stays replayable (loop / prev)", async () => {
|
||||
const a = makeRecord("a");
|
||||
seed([a]);
|
||||
const p = new LocalMusicProvider(dir);
|
||||
const refs = new Set<string>(["a"]); // loop queue still references it
|
||||
p.setInUseResolver(() => refs);
|
||||
|
||||
await p.getSongUrl("a"); // first pass plays it
|
||||
p.sweepUnreferenced(); // "playback_finished" sweep
|
||||
|
||||
expect(existsSync(a.filePath)).toBe(true);
|
||||
expect((await p.getSongUrl("a"))?.url).toBe(a.filePath); // next loop pass works
|
||||
});
|
||||
|
||||
it("re-playing a queued local song does not delete it (play-song order)", async () => {
|
||||
const a = makeRecord("a");
|
||||
seed([a]);
|
||||
const p = new LocalMusicProvider(dir);
|
||||
// Mirror the fixed endpoint order: the song is (re)added to the queue
|
||||
// BEFORE the sweep runs, so it is referenced when we sweep.
|
||||
const refs = new Set<string>(["a"]);
|
||||
p.setInUseResolver(() => refs);
|
||||
|
||||
await p.getSongUrl("a"); // played once
|
||||
p.sweepUnreferenced(); // sweep fired after the replay re-queued it
|
||||
expect(existsSync(a.filePath)).toBe(true);
|
||||
expect(await p.getSongUrl("a")).not.toBeNull();
|
||||
});
|
||||
|
||||
it("deletes a played file once it leaves every queue", async () => {
|
||||
const a = makeRecord("a");
|
||||
seed([a]);
|
||||
const p = new LocalMusicProvider(dir);
|
||||
let refs = new Set<string>(["a"]);
|
||||
p.setInUseResolver(() => refs);
|
||||
|
||||
await p.getSongUrl("a");
|
||||
p.sweepUnreferenced();
|
||||
expect(existsSync(a.filePath)).toBe(true); // still queued
|
||||
|
||||
refs = new Set<string>(); // queue cleared
|
||||
p.sweepUnreferenced();
|
||||
expect(existsSync(a.filePath)).toBe(false); // now removed
|
||||
expect(await p.getSongUrl("a")).toBeNull();
|
||||
});
|
||||
|
||||
it("never deletes anything when the reference resolver throws", async () => {
|
||||
const a = makeRecord("a");
|
||||
seed([a]);
|
||||
const p = new LocalMusicProvider(dir);
|
||||
p.setInUseResolver(() => {
|
||||
throw new Error("manager unavailable");
|
||||
});
|
||||
await p.getSongUrl("a");
|
||||
expect(p.sweepUnreferenced()).toEqual([]);
|
||||
expect(existsSync(a.filePath)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("LocalMusicProvider upload validation", () => {
|
||||
it("rejects a spoofed Content-Type with a non-audio extension", async () => {
|
||||
const p = new LocalMusicProvider(dir);
|
||||
await expect(
|
||||
p.uploadAudio({
|
||||
buffer: Buffer.from("malicious"),
|
||||
originalName: "evil.exe",
|
||||
mimeType: "application/octet-stream",
|
||||
}),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
|
||||
it("rejects an unknown extension even when the mime claims audio", async () => {
|
||||
const p = new LocalMusicProvider(dir);
|
||||
await expect(
|
||||
p.uploadAudio({
|
||||
buffer: Buffer.from("x"),
|
||||
originalName: "evil.html",
|
||||
mimeType: "audio/mpeg",
|
||||
}),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
|
||||
it("rejects an empty file", async () => {
|
||||
const p = new LocalMusicProvider(dir);
|
||||
await expect(
|
||||
p.uploadAudio({ buffer: Buffer.alloc(0), originalName: "a.mp3" }),
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe("LocalMusicProvider quota", () => {
|
||||
it("evicts oldest unreferenced uploads beyond maxFiles", async () => {
|
||||
const a = makeRecord("a");
|
||||
const b = makeRecord("b");
|
||||
seed([b, a]); // newest-first: b newer than a
|
||||
const p = new LocalMusicProvider(dir, { maxFiles: 2 });
|
||||
p.setInUseResolver(() => new Set<string>());
|
||||
|
||||
// Upload a third valid file → over the 2-file cap → evict the oldest ("a").
|
||||
await p.uploadAudio({
|
||||
buffer: Buffer.alloc(16, 7),
|
||||
originalName: "c.mp3",
|
||||
mimeType: "audio/mpeg",
|
||||
});
|
||||
|
||||
expect(existsSync(a.filePath)).toBe(false); // oldest evicted
|
||||
expect(existsSync(b.filePath)).toBe(true);
|
||||
const result = await p.search("");
|
||||
expect(result.songs.map((s) => s.id).sort()).not.toContain("a");
|
||||
});
|
||||
|
||||
it("does not evict a referenced upload even when over the cap", async () => {
|
||||
const a = makeRecord("a");
|
||||
const b = makeRecord("b");
|
||||
seed([b, a]);
|
||||
const p = new LocalMusicProvider(dir, { maxFiles: 1 });
|
||||
p.setInUseResolver(() => new Set<string>(["a"])); // "a" is queued
|
||||
|
||||
await p.uploadAudio({
|
||||
buffer: Buffer.alloc(16, 7),
|
||||
originalName: "c.mp3",
|
||||
mimeType: "audio/mpeg",
|
||||
});
|
||||
|
||||
expect(existsSync(a.filePath)).toBe(true); // protected: still queued
|
||||
});
|
||||
|
||||
it("never evicts the just-uploaded file, even when every older file is referenced", async () => {
|
||||
const a = makeRecord("a");
|
||||
seed([a]);
|
||||
const p = new LocalMusicProvider(dir, { maxFiles: 1 });
|
||||
p.setInUseResolver(() => new Set<string>(["a"])); // the only older file is queued
|
||||
|
||||
const song = await p.uploadAudio({
|
||||
buffer: Buffer.alloc(16, 7),
|
||||
originalName: "c.mp3",
|
||||
mimeType: "audio/mpeg",
|
||||
});
|
||||
|
||||
// The returned song must actually exist and be playable — not a phantom.
|
||||
expect(await p.getSongUrl(song.id)).not.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("LocalMusicProvider search pagination", () => {
|
||||
it("slices [offset, offset+limit) instead of the first page", async () => {
|
||||
const recs = ["a", "b", "c", "d"].map((id) => makeRecord(id));
|
||||
seed(recs); // newest-first order preserved: a, b, c, d
|
||||
const p = new LocalMusicProvider(dir);
|
||||
|
||||
const page1 = await p.search("", 2); // offset defaults to 0
|
||||
expect(page1.songs.map((s) => s.id)).toEqual(["a", "b"]);
|
||||
|
||||
const page2 = await p.search("", 2, 2);
|
||||
expect(page2.songs.map((s) => s.id)).toEqual(["c", "d"]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("LocalMusicProvider filename handling", () => {
|
||||
it("accepts a long filename without dropping its extension", async () => {
|
||||
const p = new LocalMusicProvider(dir);
|
||||
const longName = "x".repeat(300) + ".mp3";
|
||||
// Must not throw the "unsupported format" error — the extension survives.
|
||||
const song = await p.uploadAudio({
|
||||
buffer: Buffer.alloc(16, 1),
|
||||
originalName: longName,
|
||||
mimeType: "audio/mpeg",
|
||||
});
|
||||
expect(song.id).toBeTruthy();
|
||||
expect(await p.getSongUrl(song.id)).not.toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,391 @@
|
||||
import { spawn } from "node:child_process";
|
||||
import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { createRequire } from "node:module";
|
||||
import path from "node:path";
|
||||
import crypto from "node:crypto";
|
||||
import type {
|
||||
Album,
|
||||
AuthStatus,
|
||||
LyricLine,
|
||||
MusicProvider,
|
||||
Playlist,
|
||||
PlaylistDetail,
|
||||
QrCodeResult,
|
||||
SearchResult,
|
||||
Song,
|
||||
SongUrlResult,
|
||||
} from "./provider.js";
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
const ffmpegPath: string | null = require("ffmpeg-static");
|
||||
|
||||
const AUDIO_EXTENSIONS = new Set([
|
||||
".mp3",
|
||||
".flac",
|
||||
".wav",
|
||||
".m4a",
|
||||
".aac",
|
||||
".ogg",
|
||||
".opus",
|
||||
".webm",
|
||||
".wma",
|
||||
".alac",
|
||||
".aiff",
|
||||
".ape",
|
||||
]);
|
||||
|
||||
const DEFAULT_MAX_FILES = 200;
|
||||
const DEFAULT_MAX_TOTAL_BYTES = 5 * 1024 * 1024 * 1024; // 5 GiB
|
||||
|
||||
export interface LocalMusicProviderOptions {
|
||||
/** Max number of uploaded files kept on disk (oldest unreferenced evicted). */
|
||||
maxFiles?: number;
|
||||
/** Max total bytes of uploaded files kept on disk. */
|
||||
maxTotalBytes?: number;
|
||||
}
|
||||
|
||||
interface LocalSongRecord extends Song {
|
||||
filePath: string;
|
||||
originalName: string;
|
||||
uploadedAt: string;
|
||||
size: number;
|
||||
mimeType: string;
|
||||
}
|
||||
|
||||
function safeFileName(name: string): string {
|
||||
const base = path.basename(name || "audio")
|
||||
.replace(/[<>:"/\\|?*\x00-\x1F]/g, "_")
|
||||
.replace(/\s+/g, " ")
|
||||
.trim();
|
||||
if (!base) return "audio";
|
||||
// Cap the total length but ALWAYS preserve the extension — truncating the
|
||||
// whole string would drop a trailing ".mp3" on a long filename and make the
|
||||
// file fail extension validation.
|
||||
const ext = path.extname(base);
|
||||
const stem = ext ? base.slice(0, base.length - ext.length) : base;
|
||||
const safeStem = stem.slice(0, Math.max(1, 160 - ext.length)) || "audio";
|
||||
return `${safeStem}${ext}`;
|
||||
}
|
||||
|
||||
function titleFromFileName(name: string): string {
|
||||
return safeFileName(name).replace(/\.[^.]+$/, "") || "本地音频";
|
||||
}
|
||||
|
||||
async function probeDurationSeconds(filePath: string): Promise<number> {
|
||||
return new Promise((resolve) => {
|
||||
const ffmpeg = spawn(ffmpegPath || "ffmpeg", ["-hide_banner", "-i", filePath], {
|
||||
stdio: ["ignore", "ignore", "pipe"],
|
||||
});
|
||||
let stderr = "";
|
||||
const timeout = setTimeout(() => {
|
||||
ffmpeg.kill("SIGKILL");
|
||||
resolve(0);
|
||||
}, 5000);
|
||||
ffmpeg.stderr.on("data", (chunk) => {
|
||||
stderr += chunk.toString("utf8");
|
||||
});
|
||||
ffmpeg.on("error", () => {
|
||||
clearTimeout(timeout);
|
||||
resolve(0);
|
||||
});
|
||||
ffmpeg.on("close", () => {
|
||||
clearTimeout(timeout);
|
||||
const match = stderr.match(/Duration:\s*(\d+):(\d+):(\d+(?:\.\d+)?)/);
|
||||
if (!match) {
|
||||
resolve(0);
|
||||
return;
|
||||
}
|
||||
const hours = Number(match[1]);
|
||||
const minutes = Number(match[2]);
|
||||
const seconds = Number(match[3]);
|
||||
const total = hours * 3600 + minutes * 60 + seconds;
|
||||
resolve(Number.isFinite(total) ? Math.round(total) : 0);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
export class LocalMusicProvider implements MusicProvider {
|
||||
readonly platform = "local" as const;
|
||||
private readonly uploadDir: string;
|
||||
private readonly indexPath: string;
|
||||
private records: LocalSongRecord[] = [];
|
||||
private readonly maxFiles: number;
|
||||
private readonly maxTotalBytes: number;
|
||||
/** Ids that have been resolved for playback at least once; only these are
|
||||
* eligible for reference-aware cleanup, so freshly uploaded files that are
|
||||
* not yet queued/played survive in the search list. */
|
||||
private playedIds = new Set<string>();
|
||||
/** Returns the set of local song ids still referenced by any bot's queue.
|
||||
* Deletion never removes a file whose id this set contains. */
|
||||
private inUseResolver: () => Set<string> = () => new Set<string>();
|
||||
/** Ids with an in-flight retry-delete scheduled (file briefly locked, e.g.
|
||||
* ffmpeg on Windows still releasing a just-stopped track). */
|
||||
private retrying = new Set<string>();
|
||||
|
||||
constructor(uploadDir: string, options: LocalMusicProviderOptions = {}) {
|
||||
this.uploadDir = uploadDir;
|
||||
this.indexPath = path.join(uploadDir, "index.json");
|
||||
this.maxFiles = options.maxFiles ?? DEFAULT_MAX_FILES;
|
||||
this.maxTotalBytes = options.maxTotalBytes ?? DEFAULT_MAX_TOTAL_BYTES;
|
||||
mkdirSync(uploadDir, { recursive: true });
|
||||
this.loadIndex();
|
||||
}
|
||||
|
||||
/** Wire the resolver the BotManager uses to report which uploads are still
|
||||
* queued anywhere. Must be set before any cleanup can delete files. */
|
||||
setInUseResolver(resolver: () => Set<string>): void {
|
||||
this.inUseResolver = resolver;
|
||||
}
|
||||
|
||||
private referencedIds(): Set<string> | null {
|
||||
try {
|
||||
return this.inUseResolver() ?? new Set<string>();
|
||||
} catch {
|
||||
// Resolver failure → references unknown → refuse to delete anything.
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private loadIndex(): void {
|
||||
try {
|
||||
const raw = readFileSync(this.indexPath, "utf8");
|
||||
const parsed = JSON.parse(raw) as LocalSongRecord[];
|
||||
this.records = Array.isArray(parsed)
|
||||
? parsed.filter((r) => r && typeof r.id === "string" && typeof r.filePath === "string")
|
||||
: [];
|
||||
} catch {
|
||||
this.records = [];
|
||||
}
|
||||
}
|
||||
|
||||
private saveIndex(): void {
|
||||
writeFileSync(this.indexPath, JSON.stringify(this.records, null, 2), "utf8");
|
||||
}
|
||||
|
||||
async uploadAudio(input: {
|
||||
buffer: Buffer;
|
||||
originalName: string;
|
||||
mimeType?: string;
|
||||
}): Promise<Song> {
|
||||
const originalName = safeFileName(input.originalName || "audio");
|
||||
const ext = path.extname(originalName).toLowerCase();
|
||||
// Validate by the (sanitised) file extension only — never trust the
|
||||
// client-supplied Content-Type. This also guarantees the STORED extension
|
||||
// is one of the known audio types, so a spoofed header cannot persist an
|
||||
// arbitrary-extension blob on disk.
|
||||
if (!AUDIO_EXTENSIONS.has(ext)) {
|
||||
throw new Error("只支持常见音频文件,如 mp3、flac、wav、m4a、ogg、opus、aac、webm 等");
|
||||
}
|
||||
if (!input.buffer || input.buffer.length === 0) {
|
||||
throw new Error("上传文件为空");
|
||||
}
|
||||
|
||||
const id = crypto.randomUUID();
|
||||
const storedName = `${id}${ext}`;
|
||||
const filePath = path.join(this.uploadDir, storedName);
|
||||
writeFileSync(filePath, input.buffer);
|
||||
|
||||
const duration = await probeDurationSeconds(filePath);
|
||||
const song: LocalSongRecord = {
|
||||
id,
|
||||
name: titleFromFileName(originalName),
|
||||
artist: "本地上传",
|
||||
album: "本地音乐",
|
||||
duration,
|
||||
coverUrl: "",
|
||||
platform: "local",
|
||||
filePath,
|
||||
originalName,
|
||||
uploadedAt: new Date().toISOString(),
|
||||
size: input.buffer.length,
|
||||
mimeType: input.mimeType || "application/octet-stream",
|
||||
};
|
||||
|
||||
this.records.unshift(song);
|
||||
this.saveIndex();
|
||||
// Never evict the file we just accepted, even if every older file is still
|
||||
// queued — returning success for a file we deleted would be a phantom entry.
|
||||
this.enforceQuota(id);
|
||||
return this.toSong(song);
|
||||
}
|
||||
|
||||
private toSong(record: LocalSongRecord): Song {
|
||||
const { filePath: _filePath, originalName: _originalName, uploadedAt: _uploadedAt, size: _size, mimeType: _mimeType, ...song } = record;
|
||||
return song;
|
||||
}
|
||||
|
||||
async search(query: string, limit = 20, offset = 0): Promise<SearchResult> {
|
||||
const q = query.trim().toLowerCase();
|
||||
const songs = this.records
|
||||
.filter((r) => existsSync(r.filePath))
|
||||
.filter((r) => !q || `${r.name} ${r.artist} ${r.album} ${r.originalName}`.toLowerCase().includes(q))
|
||||
.slice(offset, offset + limit)
|
||||
.map((r) => this.toSong(r));
|
||||
return { songs, playlists: [], albums: [] };
|
||||
}
|
||||
|
||||
async getSongUrl(songId: string): Promise<SongUrlResult | null> {
|
||||
const record = this.records.find((r) => r.id === songId);
|
||||
if (!record || !existsSync(record.filePath)) return null;
|
||||
// A song that is actually resolved for playback becomes eligible for
|
||||
// cleanup once it is no longer referenced by any queue.
|
||||
this.playedIds.add(songId);
|
||||
return { url: record.filePath };
|
||||
}
|
||||
|
||||
async getSongDetail(songId: string): Promise<Song | null> {
|
||||
const record = this.records.find((r) => r.id === songId);
|
||||
return record && existsSync(record.filePath) ? this.toSong(record) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reference-aware cleanup: delete only files that have been played at least
|
||||
* once AND are no longer referenced by any bot's queue. Safe to call after
|
||||
* any queue mutation — a file still queued anywhere (loop replay, prev,
|
||||
* the song being re-started, the same upload queued on another bot) is kept.
|
||||
* Returns the ids that were deleted.
|
||||
*/
|
||||
sweepUnreferenced(): string[] {
|
||||
const inUse = this.referencedIds();
|
||||
if (!inUse) return [];
|
||||
const deleted: string[] = [];
|
||||
for (let i = this.records.length - 1; i >= 0; i--) {
|
||||
const r = this.records[i];
|
||||
if (!this.playedIds.has(r.id) || inUse.has(r.id)) continue;
|
||||
if (this.unlinkRecordAt(i)) {
|
||||
deleted.push(r.id);
|
||||
} else {
|
||||
// File still locked (e.g. ffmpeg just-stopped on Windows) — keep the
|
||||
// record and retry shortly; never orphan it or abort the rest.
|
||||
this.scheduleRetry(r.id);
|
||||
}
|
||||
}
|
||||
if (deleted.length) this.saveIndex();
|
||||
return deleted;
|
||||
}
|
||||
|
||||
/** Evict oldest, never-referenced uploads until under the file-count and
|
||||
* total-byte caps. Bounds disk use from uploads that are never played.
|
||||
* `protectId` is never evicted (the file just uploaded in this same call). */
|
||||
private enforceQuota(protectId?: string): void {
|
||||
if (this.records.length <= this.maxFiles &&
|
||||
this.totalBytes() <= this.maxTotalBytes) {
|
||||
return;
|
||||
}
|
||||
const inUse = this.referencedIds();
|
||||
if (!inUse) return; // can't safely evict without knowing references
|
||||
let count = this.records.length;
|
||||
let bytes = this.totalBytes();
|
||||
let changed = false;
|
||||
for (let i = this.records.length - 1;
|
||||
i >= 0 && (count > this.maxFiles || bytes > this.maxTotalBytes);
|
||||
i--) {
|
||||
const r = this.records[i];
|
||||
if (inUse.has(r.id) || r.id === protectId) continue; // never evict these
|
||||
const size = r.size || 0;
|
||||
if (this.unlinkRecordAt(i)) {
|
||||
count--;
|
||||
bytes -= size;
|
||||
changed = true;
|
||||
}
|
||||
}
|
||||
if (changed) this.saveIndex();
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the backing file for records[index] and drop the record from memory.
|
||||
* Deletes the FILE FIRST, then mutates state only on success, so a failed
|
||||
* unlink leaves the record intact (file + index stay consistent) instead of
|
||||
* orphaning the file. Returns true if the file is gone (deleted or already
|
||||
* absent), false if it is still present (locked). Never throws; does NOT
|
||||
* persist the index — callers batch saveIndex().
|
||||
*/
|
||||
private unlinkRecordAt(index: number): boolean {
|
||||
const r = this.records[index];
|
||||
try {
|
||||
rmSync(r.filePath, { force: true });
|
||||
} catch {
|
||||
// rmSync force:true only swallows ENOENT; EBUSY/EPERM/EACCES throw. If
|
||||
// the file genuinely vanished anyway, fall through and drop the record.
|
||||
if (existsSync(r.filePath)) return false;
|
||||
}
|
||||
this.records.splice(index, 1);
|
||||
this.playedIds.delete(r.id);
|
||||
this.retrying.delete(r.id);
|
||||
return true;
|
||||
}
|
||||
|
||||
/** Schedule a bounded, non-blocking retry to delete a briefly-locked file.
|
||||
* Uses unref'd timers so it never keeps the process alive. */
|
||||
private scheduleRetry(id: string, attempt = 1): void {
|
||||
if (attempt === 1 && this.retrying.has(id)) return;
|
||||
this.retrying.add(id);
|
||||
const MAX_ATTEMPTS = 6;
|
||||
const timer = setTimeout(() => {
|
||||
const index = this.records.findIndex((r) => r.id === id);
|
||||
if (index < 0) { this.retrying.delete(id); return; } // already removed
|
||||
const inUse = this.referencedIds();
|
||||
if (!inUse || inUse.has(id)) { this.retrying.delete(id); return; } // unknown or re-queued
|
||||
if (this.unlinkRecordAt(index)) {
|
||||
this.saveIndex();
|
||||
} else if (attempt < MAX_ATTEMPTS) {
|
||||
this.scheduleRetry(id, attempt + 1);
|
||||
} else {
|
||||
this.retrying.delete(id); // give up; next sweep/quota will retry
|
||||
}
|
||||
}, 500 * attempt);
|
||||
if (typeof timer.unref === "function") timer.unref();
|
||||
}
|
||||
|
||||
private totalBytes(): number {
|
||||
return this.records.reduce((n, r) => n + (r.size || 0), 0);
|
||||
}
|
||||
|
||||
setQuality(_quality: string): void {
|
||||
// 本地文件按原始音质播放。
|
||||
}
|
||||
|
||||
getQuality(): string {
|
||||
return "original";
|
||||
}
|
||||
|
||||
async getPlaylistSongs(_playlistId: string): Promise<Song[]> {
|
||||
return [];
|
||||
}
|
||||
|
||||
async getRecommendPlaylists(): Promise<Playlist[]> {
|
||||
return [];
|
||||
}
|
||||
|
||||
async getAlbumSongs(_albumId: string): Promise<Song[]> {
|
||||
return [];
|
||||
}
|
||||
|
||||
async getLyrics(_songId: string): Promise<LyricLine[]> {
|
||||
return [];
|
||||
}
|
||||
|
||||
async getQrCode(): Promise<QrCodeResult> {
|
||||
throw new Error("Local music does not require login");
|
||||
}
|
||||
|
||||
async checkQrCodeStatus(_key: string): Promise<"waiting" | "scanned" | "confirmed" | "expired"> {
|
||||
return "expired";
|
||||
}
|
||||
|
||||
setCookie(_cookie: string): void {
|
||||
// no-op
|
||||
}
|
||||
|
||||
getCookie(): string {
|
||||
return "";
|
||||
}
|
||||
|
||||
async getAuthStatus(): Promise<AuthStatus> {
|
||||
return { loggedIn: true, nickname: "本地音乐" };
|
||||
}
|
||||
|
||||
async getPlaylistDetail(_playlistId: string): Promise<PlaylistDetail | null> {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
+112
-2
@@ -1,5 +1,5 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { parseLyrics } from "./netease.js";
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { parseLyrics, mapNeteaseAlbums, mapNeteaseSongs, parseNeteaseTrial, NeteaseProvider } from "./netease.js";
|
||||
|
||||
describe("NetEase adapter", () => {
|
||||
it("parses LRC format lyrics", () => {
|
||||
@@ -28,4 +28,114 @@ describe("NetEase adapter", () => {
|
||||
expect(lines[0].text).toBe("Hello world");
|
||||
expect(lines[0].translation).toBe("你好世界");
|
||||
});
|
||||
|
||||
it("mapNeteaseAlbums maps raw cloudsearch albums to Album shape", () => {
|
||||
const raw = [
|
||||
{
|
||||
id: 42,
|
||||
name: "Album A",
|
||||
picUrl: "https://x/p.jpg",
|
||||
artists: [{ name: "Artist X" }, { name: "Featured Y" }],
|
||||
size: 12,
|
||||
},
|
||||
{
|
||||
id: 99,
|
||||
name: "Album B",
|
||||
picUrl: "",
|
||||
artists: [],
|
||||
},
|
||||
];
|
||||
expect(mapNeteaseAlbums(raw)).toEqual([
|
||||
{ id: "42", name: "Album A", artist: "Artist X / Featured Y", coverUrl: "https://x/p.jpg", songCount: 12, platform: "netease" },
|
||||
{ id: "99", name: "Album B", artist: "", coverUrl: "", songCount: 0, platform: "netease" },
|
||||
]);
|
||||
});
|
||||
|
||||
it("mapNeteaseAlbums returns [] for empty/null input", () => {
|
||||
expect(mapNeteaseAlbums([])).toEqual([]);
|
||||
expect(mapNeteaseAlbums(null as any)).toEqual([]);
|
||||
expect(mapNeteaseAlbums(undefined as any)).toEqual([]);
|
||||
});
|
||||
|
||||
it("mapNeteaseSongs maps fee to vip flag (1/4 = vip, 0/8 = free)", () => {
|
||||
const raw = [
|
||||
{ id: 1, name: "VIP", ar: [{ name: "A" }], al: { name: "Al", picUrl: "p" }, dt: 180000, fee: 1 },
|
||||
{ id: 2, name: "Album-only", ar: [], al: { name: "Al", picUrl: "" }, dt: 0, fee: 4 },
|
||||
{ id: 3, name: "Free", ar: [], al: {}, dt: 0, fee: 0 },
|
||||
{ id: 4, name: "Free low-quality", ar: [], al: {}, dt: 0, fee: 8 },
|
||||
];
|
||||
const out = mapNeteaseSongs(raw);
|
||||
expect(out[0].vip).toBe(true);
|
||||
expect(out[1].vip).toBe(true);
|
||||
expect(out[2].vip).toBe(false);
|
||||
expect(out[3].vip).toBe(false); // fee=8 plays in full (low quality), NOT vip
|
||||
});
|
||||
|
||||
it("mapNeteaseSongs accepts artists/album/duration aliases (personal_fm shape)", () => {
|
||||
const out = mapNeteaseSongs([
|
||||
{ id: 9, name: "FM", artists: [{ name: "B" }], album: { name: "Al2", picUrl: "p2" }, duration: 200000, fee: 0 },
|
||||
]);
|
||||
expect(out[0]).toMatchObject({ artist: "B", album: "Al2", coverUrl: "p2", vip: false });
|
||||
});
|
||||
|
||||
it("parseNeteaseTrial maps freeTrialInfo to trial seconds", () => {
|
||||
// 无试听(VIP/免费)
|
||||
expect(parseNeteaseTrial({})).toBeUndefined();
|
||||
expect(parseNeteaseTrial({ freeTrialInfo: null })).toBeUndefined();
|
||||
// 标准秒
|
||||
expect(parseNeteaseTrial({ freeTrialInfo: { start: 0, end: 30 } })).toBe(30);
|
||||
expect(parseNeteaseTrial({ freeTrialInfo: { start: 5, end: 35 } })).toBe(30);
|
||||
// 别名容忍 begin/trialBegin
|
||||
expect(parseNeteaseTrial({ freeTrialInfo: { begin: 0, end: 30 } })).toBe(30);
|
||||
// 毫秒兜底(end>1000)
|
||||
expect(parseNeteaseTrial({ freeTrialInfo: { start: 0, end: 30000 } })).toBe(30);
|
||||
// 异常 end<=start
|
||||
expect(parseNeteaseTrial({ freeTrialInfo: { start: 0, end: 0 } })).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("NeteaseProvider.search pagination", () => {
|
||||
function mockProvider() {
|
||||
const p = new NeteaseProvider("http://x");
|
||||
const get = vi.fn().mockResolvedValue({
|
||||
data: { result: { songs: [], playlists: [], albums: [] } },
|
||||
});
|
||||
(p as any).api = { get };
|
||||
return { p, get };
|
||||
}
|
||||
|
||||
/** Find the /cloudsearch call whose params.type matches. */
|
||||
function callByType(get: ReturnType<typeof vi.fn>, type: number) {
|
||||
const call = get.mock.calls.find((c: any[]) => c[1]?.params?.type === type);
|
||||
expect(call, `expected a /cloudsearch call with type=${type}`).toBeTruthy();
|
||||
return call![1].params as Record<string, unknown>;
|
||||
}
|
||||
|
||||
it("forwards offset for songs and uses real limit+offset for playlists/albums", async () => {
|
||||
const { p, get } = mockProvider();
|
||||
await p.search("hello", 20, 20);
|
||||
|
||||
// songs (type 1): offset forwarded, limit unchanged
|
||||
const songs = callByType(get, 1);
|
||||
expect(songs.limit).toBe(20);
|
||||
expect(songs.offset).toBe(20);
|
||||
|
||||
// playlists (type 1000): limit-driven (NOT hardcoded 10) + offset
|
||||
const playlists = callByType(get, 1000);
|
||||
expect(playlists.limit).toBe(20);
|
||||
expect(playlists.offset).toBe(20);
|
||||
|
||||
// albums (type 10): limit-driven (NOT hardcoded 10) + offset
|
||||
const albums = callByType(get, 10);
|
||||
expect(albums.limit).toBe(20);
|
||||
expect(albums.offset).toBe(20);
|
||||
});
|
||||
|
||||
it("defaults offset to 0 (backward compatible)", async () => {
|
||||
const { p, get } = mockProvider();
|
||||
await p.search("hello", 20);
|
||||
expect(callByType(get, 1).offset).toBe(0);
|
||||
expect(callByType(get, 1000).offset).toBe(0);
|
||||
expect(callByType(get, 10).offset).toBe(0);
|
||||
});
|
||||
});
|
||||
+66
-65
@@ -2,12 +2,14 @@ import axios, { type AxiosInstance } from "axios";
|
||||
import type {
|
||||
MusicProvider,
|
||||
Song,
|
||||
SongUrlResult,
|
||||
Playlist,
|
||||
PlaylistDetail,
|
||||
LyricLine,
|
||||
SearchResult,
|
||||
QrCodeResult,
|
||||
AuthStatus,
|
||||
Album,
|
||||
} from "./provider.js";
|
||||
|
||||
export function parseLyrics(lrc: string, tlyric?: string): LyricLine[] {
|
||||
@@ -55,6 +57,45 @@ export function parseLyrics(lrc: string, tlyric?: string): LyricLine[] {
|
||||
return lines.sort((a, b) => a.time - b.time);
|
||||
}
|
||||
|
||||
export function mapNeteaseAlbums(raw: any[] | null | undefined): Album[] {
|
||||
if (!Array.isArray(raw)) return [];
|
||||
return raw.map((a) => ({
|
||||
id: String(a.id),
|
||||
name: a.name ?? "",
|
||||
artist: (a.artists ?? []).map((x: any) => x.name).join(" / "),
|
||||
coverUrl: a.picUrl ?? "",
|
||||
songCount: a.size ?? 0,
|
||||
platform: "netease",
|
||||
}));
|
||||
}
|
||||
|
||||
export function mapNeteaseSongs(raw: any[] | null | undefined): Song[] {
|
||||
if (!Array.isArray(raw)) return [];
|
||||
return raw.map((s: any) => ({
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.ar ?? s.artists ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.al?.name ?? s.album?.name ?? "",
|
||||
duration: Math.round((s.dt ?? s.duration ?? 0) / 1000),
|
||||
coverUrl: s.al?.picUrl ?? s.album?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
// fee: 0=free, 1=VIP, 4=album-only, 8=free low-quality (plays in full, NOT vip)
|
||||
vip: s.fee === 1 || s.fee === 4,
|
||||
}));
|
||||
}
|
||||
|
||||
/** 解析网易云 freeTrialInfo → 试听秒数;无片段(VIP/免费)返回 undefined。
|
||||
* 真实字段 {start,end} 单位秒;容忍 begin/trialBegin 别名 + 毫秒兜底(end>1000)。 */
|
||||
export function parseNeteaseTrial(item: any): number | undefined {
|
||||
const t = item?.freeTrialInfo;
|
||||
if (!t || typeof t !== "object") return undefined;
|
||||
const start = Number(t.start ?? t.begin ?? t.trialBegin ?? 0);
|
||||
const end = Number(t.end ?? t.trialEnd);
|
||||
if (!Number.isFinite(end) || end <= start) return undefined;
|
||||
const secs = end > 1000 ? (end - start) / 1000 : end - start;
|
||||
return Math.round(secs);
|
||||
}
|
||||
|
||||
// NetEase quality levels: standard(128k) higher(192k) exhigh(320k) lossless(flac) hires(hi-res) jyeffect jymaster
|
||||
export const NETEASE_QUALITY_LEVELS = [
|
||||
{ value: "standard", label: "标准 (128kbps)", bitrate: 128 },
|
||||
@@ -90,32 +131,29 @@ export class NeteaseProvider implements MusicProvider {
|
||||
return this.cookie ? { cookie: this.cookie } : {};
|
||||
}
|
||||
|
||||
async search(query: string, limit = 20): Promise<SearchResult> {
|
||||
const [songRes, playlistRes] = await Promise.all([
|
||||
async search(query: string, limit = 20, offset = 0): Promise<SearchResult> {
|
||||
// /cloudsearch supports offset for every type. Songs, playlists (type 1000)
|
||||
// and albums (type 10) are all limit/offset-driven so the web can page past
|
||||
// the first page (playlists/albums were previously hardcoded to limit: 10).
|
||||
const [songRes, playlistRes, albumRes] = await Promise.all([
|
||||
this.api.get("/cloudsearch", {
|
||||
params: { keywords: query, type: 1, limit, ...this.cookieParams },
|
||||
params: { keywords: query, type: 1, limit, offset, ...this.cookieParams },
|
||||
}),
|
||||
this.api.get("/cloudsearch", {
|
||||
params: {
|
||||
keywords: query,
|
||||
type: 1000,
|
||||
limit: 5,
|
||||
limit,
|
||||
offset,
|
||||
...this.cookieParams,
|
||||
},
|
||||
}),
|
||||
this.api.get("/cloudsearch", {
|
||||
params: { keywords: query, type: 10, limit, offset, ...this.cookieParams },
|
||||
}),
|
||||
]);
|
||||
|
||||
const songs: Song[] = (songRes.data?.result?.songs ?? []).map(
|
||||
(s: any) => ({
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.ar ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.al?.name ?? "",
|
||||
duration: Math.round((s.dt ?? 0) / 1000),
|
||||
coverUrl: s.al?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
})
|
||||
);
|
||||
const songs: Song[] = mapNeteaseSongs(songRes.data?.result?.songs);
|
||||
|
||||
const playlists: Playlist[] = (
|
||||
playlistRes.data?.result?.playlists ?? []
|
||||
@@ -127,47 +165,34 @@ export class NeteaseProvider implements MusicProvider {
|
||||
platform: "netease",
|
||||
}));
|
||||
|
||||
return { songs, playlists, albums: [] };
|
||||
const albums = mapNeteaseAlbums(albumRes.data?.result?.albums);
|
||||
|
||||
return { songs, playlists, albums };
|
||||
}
|
||||
|
||||
async getSongUrl(songId: string, quality?: string): Promise<string | null> {
|
||||
async getSongUrl(songId: string, quality?: string): Promise<SongUrlResult | null> {
|
||||
const level = quality ?? this.quality;
|
||||
const res = await this.api.get("/song/url/v1", {
|
||||
params: { id: songId, level, ...this.cookieParams },
|
||||
});
|
||||
return res.data?.data?.[0]?.url ?? null;
|
||||
const item = res.data?.data?.[0];
|
||||
const url = item?.url;
|
||||
if (!url) return null;
|
||||
return { url, trialDuration: parseNeteaseTrial(item) };
|
||||
}
|
||||
|
||||
async getSongDetail(songId: string): Promise<Song | null> {
|
||||
const res = await this.api.get("/song/detail", {
|
||||
params: { ids: songId, ...this.cookieParams },
|
||||
});
|
||||
const s = res.data?.songs?.[0];
|
||||
if (!s) return null;
|
||||
return {
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.ar ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.al?.name ?? "",
|
||||
duration: Math.round((s.dt ?? 0) / 1000),
|
||||
coverUrl: s.al?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
};
|
||||
return mapNeteaseSongs(res.data?.songs)[0] ?? null;
|
||||
}
|
||||
|
||||
async getPlaylistSongs(playlistId: string): Promise<Song[]> {
|
||||
const res = await this.api.get("/playlist/track/all", {
|
||||
params: { id: playlistId, ...this.cookieParams },
|
||||
});
|
||||
return (res.data?.songs ?? []).map((s: any) => ({
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.ar ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.al?.name ?? "",
|
||||
duration: Math.round((s.dt ?? 0) / 1000),
|
||||
coverUrl: s.al?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
}));
|
||||
return mapNeteaseSongs(res.data?.songs);
|
||||
}
|
||||
|
||||
async getRecommendPlaylists(): Promise<Playlist[]> {
|
||||
@@ -187,15 +212,7 @@ export class NeteaseProvider implements MusicProvider {
|
||||
const res = await this.api.get("/album", {
|
||||
params: { id: albumId, ...this.cookieParams },
|
||||
});
|
||||
return (res.data?.songs ?? []).map((s: any) => ({
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.ar ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.al?.name ?? "",
|
||||
duration: Math.round((s.dt ?? 0) / 1000),
|
||||
coverUrl: s.al?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
}));
|
||||
return mapNeteaseSongs(res.data?.songs);
|
||||
}
|
||||
|
||||
async getLyrics(songId: string): Promise<LyricLine[]> {
|
||||
@@ -294,30 +311,14 @@ export class NeteaseProvider implements MusicProvider {
|
||||
const res = await this.api.get("/personal_fm", {
|
||||
params: { ...this.cookieParams },
|
||||
});
|
||||
return (res.data?.data ?? []).map((s: any) => ({
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.artists ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.album?.name ?? "",
|
||||
duration: Math.round((s.duration ?? 0) / 1000),
|
||||
coverUrl: s.album?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
}));
|
||||
return mapNeteaseSongs(res.data?.data);
|
||||
}
|
||||
|
||||
async getDailyRecommendSongs(): Promise<Song[]> {
|
||||
const res = await this.api.get("/recommend/songs", {
|
||||
params: { ...this.cookieParams },
|
||||
});
|
||||
return (res.data?.data?.dailySongs ?? []).map((s: any) => ({
|
||||
id: String(s.id),
|
||||
name: s.name,
|
||||
artist: (s.ar ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.al?.name ?? "",
|
||||
duration: Math.round((s.dt ?? 0) / 1000),
|
||||
coverUrl: s.al?.picUrl ?? "",
|
||||
platform: "netease",
|
||||
}));
|
||||
return mapNeteaseSongs(res.data?.data?.dailySongs);
|
||||
}
|
||||
|
||||
async getPlaylistDetail(playlistId: string): Promise<PlaylistDetail | null> {
|
||||
|
||||
+28
-6
@@ -1,3 +1,15 @@
|
||||
/** All music source platforms. Jellyfin ItemIds are GUID strings — never
|
||||
* assume numeric ids when handling a generic Platform. */
|
||||
export type Platform =
|
||||
| "netease"
|
||||
| "qq"
|
||||
| "bilibili"
|
||||
| "youtube"
|
||||
| "local"
|
||||
| "kugou"
|
||||
| "spotify"
|
||||
| "jellyfin";
|
||||
|
||||
export interface Song {
|
||||
id: string;
|
||||
name: string;
|
||||
@@ -5,19 +17,29 @@ export interface Song {
|
||||
album: string;
|
||||
duration: number; // seconds
|
||||
coverUrl: string;
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
||||
platform: Platform;
|
||||
/** VIP / copyright-restricted: non-VIP users can only play a trial fragment
|
||||
* (NetEase fee=1 VIP / fee=4 album-only, or QQ pay.payplay/paytrackprice=1). */
|
||||
vip?: boolean;
|
||||
}
|
||||
|
||||
export interface SongWithUrl extends Song {
|
||||
url: string;
|
||||
}
|
||||
|
||||
/** getSongUrl 解析结果。trialDuration 缺省 = 完整可播放(VIP 账号 / 免费曲)。 */
|
||||
export interface SongUrlResult {
|
||||
url: string;
|
||||
/** 试听片段时长(秒)。VIP/免费曲为 undefined → 调用方回退完整 duration。 */
|
||||
trialDuration?: number;
|
||||
}
|
||||
|
||||
export interface Playlist {
|
||||
id: string;
|
||||
name: string;
|
||||
coverUrl: string;
|
||||
songCount: number;
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
||||
platform: Platform;
|
||||
}
|
||||
|
||||
export interface PlaylistDetail {
|
||||
@@ -34,7 +56,7 @@ export interface Album {
|
||||
artist: string;
|
||||
coverUrl: string;
|
||||
songCount: number;
|
||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
||||
platform: Platform;
|
||||
}
|
||||
|
||||
export interface LyricLine {
|
||||
@@ -62,10 +84,10 @@ export interface AuthStatus {
|
||||
}
|
||||
|
||||
export interface MusicProvider {
|
||||
readonly platform: "netease" | "qq" | "bilibili" | "youtube";
|
||||
readonly platform: Platform;
|
||||
|
||||
search(query: string, limit?: number): Promise<SearchResult>;
|
||||
getSongUrl(songId: string, quality?: string): Promise<string | null>;
|
||||
search(query: string, limit?: number, offset?: number): Promise<SearchResult>;
|
||||
getSongUrl(songId: string, quality?: string): Promise<SongUrlResult | null>;
|
||||
setQuality(quality: string): void;
|
||||
getQuality(): string;
|
||||
getSongDetail(songId: string): Promise<Song | null>;
|
||||
|
||||
@@ -0,0 +1,174 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
|
||||
// All axios.create(...) instances in qq.ts (qqMusicuApi / qqSearchApi / qqFavApi
|
||||
// and the per-instance api) share this single mock so the search test can
|
||||
// inspect the outgoing params/body regardless of which client issued them.
|
||||
const { mockGet, mockPost } = vi.hoisted(() => ({ mockGet: vi.fn(), mockPost: vi.fn() }));
|
||||
vi.mock("axios", () => ({
|
||||
default: { create: () => ({ get: mockGet, post: mockPost }) },
|
||||
}));
|
||||
|
||||
import { mapQqAlbums, mapQqSongs, parseQqTrial, QQMusicProvider } from "./qq.js";
|
||||
|
||||
describe("QQ adapter", () => {
|
||||
it("mapQqSongs maps QQMusicApi-style song entries", () => {
|
||||
const out = mapQqSongs([
|
||||
{
|
||||
mid: "001abc",
|
||||
name: "Radar Song",
|
||||
singer: [{ name: "Singer A" }, { name: "Singer B" }],
|
||||
album: { name: "Album A", mid: "alb001" },
|
||||
interval: 243,
|
||||
},
|
||||
]);
|
||||
|
||||
expect(out).toEqual([
|
||||
{
|
||||
id: "001abc",
|
||||
name: "Radar Song",
|
||||
artist: "Singer A / Singer B",
|
||||
album: "Album A",
|
||||
duration: 243,
|
||||
coverUrl: "https://y.gtimg.cn/music/photo_new/T002R300x300M000alb001.jpg",
|
||||
platform: "qq",
|
||||
vip: false,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
it("mapQqSongs maps pay field to vip flag", () => {
|
||||
const out = mapQqSongs([
|
||||
{ mid: "v1", name: "VIP playplay", singer: [], album: {}, interval: 100, pay: { payplay: 1, paytrackprice: 0 } },
|
||||
{ mid: "v2", name: "VIP trackprice", singer: [], album: {}, interval: 100, pay: { payplay: 0, paytrackprice: 1 } },
|
||||
{ mid: "f1", name: "Free", singer: [], album: {}, interval: 100, pay: { payplay: 0, paytrackprice: 0 } },
|
||||
{ mid: "f2", name: "No pay field", singer: [], album: {}, interval: 100 },
|
||||
]);
|
||||
expect(out[0].vip).toBe(true);
|
||||
expect(out[1].vip).toBe(true);
|
||||
expect(out[2].vip).toBe(false);
|
||||
expect(out[3].vip).toBe(false);
|
||||
});
|
||||
|
||||
it("parseQqTrial maps isTryout/tryout to trial seconds", () => {
|
||||
// 非试听(VIP/免费)
|
||||
expect(parseQqTrial({ isTryout: 0 })).toBeUndefined();
|
||||
expect(parseQqTrial({})).toBeUndefined();
|
||||
// 试听(秒)
|
||||
expect(parseQqTrial({ isTryout: 1, tryBegin: 0, tryEnd: 30 })).toBe(30);
|
||||
expect(parseQqTrial({ tryout: true, begin: 0, end: 45 })).toBe(45);
|
||||
// 毫秒兜底
|
||||
expect(parseQqTrial({ isTryout: 1, tryBegin: 0, tryEnd: 30000 })).toBe(30);
|
||||
// 异常
|
||||
expect(parseQqTrial({ isTryout: 1, tryEnd: 0 })).toBeUndefined();
|
||||
});
|
||||
|
||||
it("mapQqAlbums maps albumMID-style raw entries", () => {
|
||||
const raw = [
|
||||
{
|
||||
albumMID: "abc",
|
||||
albumName: "Aero",
|
||||
singerName: "Singer A",
|
||||
},
|
||||
{
|
||||
albumMID: "xyz",
|
||||
albumName: "Beta",
|
||||
singer: [{ name: "Singer B" }, { name: "Singer C" }],
|
||||
},
|
||||
];
|
||||
const out = mapQqAlbums(raw);
|
||||
expect(out).toHaveLength(2);
|
||||
expect(out[0]).toMatchObject({
|
||||
id: "abc",
|
||||
name: "Aero",
|
||||
artist: "Singer A",
|
||||
platform: "qq",
|
||||
});
|
||||
expect(out[0].coverUrl).toContain("T002R300x300M000abc.jpg");
|
||||
expect(out[1].artist).toBe("Singer B / Singer C");
|
||||
expect(out[1].coverUrl).toContain("xyz");
|
||||
});
|
||||
|
||||
it("mapQqAlbums returns [] for empty/null input", () => {
|
||||
expect(mapQqAlbums([])).toEqual([]);
|
||||
expect(mapQqAlbums(null as any)).toEqual([]);
|
||||
expect(mapQqAlbums(undefined as any)).toEqual([]);
|
||||
});
|
||||
|
||||
it("mapQqAlbums falls back to albumPic when no albumMID", () => {
|
||||
const raw = [{ albumName: "C", albumPic: "https://x/p.jpg", singerName: "S" }];
|
||||
const out = mapQqAlbums(raw);
|
||||
expect(out[0].coverUrl).toBe("https://x/p.jpg");
|
||||
expect(out[0].id).toBe("");
|
||||
});
|
||||
});
|
||||
|
||||
describe("QQMusicProvider.search pagination", () => {
|
||||
beforeEach(() => {
|
||||
mockGet.mockReset();
|
||||
mockPost.mockReset();
|
||||
});
|
||||
|
||||
/** musicu.fcg returns one song → primary path succeeds. */
|
||||
function musicuOk() {
|
||||
mockGet.mockImplementation(async (url: string) => {
|
||||
if (url === "/cgi-bin/musicu.fcg") {
|
||||
return {
|
||||
data: {
|
||||
req_0: { data: { body: { song: { list: [{ mid: "m1", name: "S", singer: [], album: {}, interval: 100 }] } } } },
|
||||
req_album: { data: { body: { album: { list: [] } } } },
|
||||
req_playlist: { data: { body: { songlist: { list: [] } } } },
|
||||
},
|
||||
};
|
||||
}
|
||||
return { data: {} };
|
||||
});
|
||||
}
|
||||
|
||||
function musicuReqData() {
|
||||
const call = mockGet.mock.calls.find((c: any[]) => c[0] === "/cgi-bin/musicu.fcg");
|
||||
expect(call, "expected a musicu.fcg call").toBeTruthy();
|
||||
return JSON.parse(call![1].params.data);
|
||||
}
|
||||
|
||||
it("adds page_num (offset/limit+1) and limit-driven num_per_page for songs/albums/playlists", async () => {
|
||||
musicuOk();
|
||||
const p = new QQMusicProvider("http://x");
|
||||
await p.search("hello", 20, 20); // page 2
|
||||
|
||||
const d = musicuReqData();
|
||||
expect(d.req_0.param.page_num).toBe(2);
|
||||
expect(d.req_0.param.num_per_page).toBe(20);
|
||||
// Albums/playlists: num_per_page must be limit-driven (NOT hardcoded 10).
|
||||
expect(d.req_album.param.page_num).toBe(2);
|
||||
expect(d.req_album.param.num_per_page).toBe(20);
|
||||
expect(d.req_playlist.param.page_num).toBe(2);
|
||||
expect(d.req_playlist.param.num_per_page).toBe(20);
|
||||
});
|
||||
|
||||
it("defaults offset to 0 → page_num 1 (backward compatible)", async () => {
|
||||
musicuOk();
|
||||
const p = new QQMusicProvider("http://x");
|
||||
await p.search("hello", 20);
|
||||
const d = musicuReqData();
|
||||
expect(d.req_0.param.page_num).toBe(1);
|
||||
});
|
||||
|
||||
it("fallback client_search_cp sets p to the page cursor", async () => {
|
||||
// musicu returns no songs → primary returns null → fallback runs.
|
||||
mockGet.mockImplementation(async (url: string) => {
|
||||
if (url === "/cgi-bin/musicu.fcg") {
|
||||
return { data: { req_0: { data: { body: { song: { list: [] } } } } } };
|
||||
}
|
||||
// client_search_cp
|
||||
return { data: { data: { song: { list: [] }, album: { list: [] } } } };
|
||||
});
|
||||
const p = new QQMusicProvider("http://x");
|
||||
await p.search("hello", 20, 20); // page 2
|
||||
|
||||
const songCall = mockGet.mock.calls.find(
|
||||
(c: any[]) => c[0] === "/soso/fcgi-bin/client_search_cp" && c[1]?.params?.type === 0
|
||||
);
|
||||
expect(songCall, "expected a client_search_cp song call").toBeTruthy();
|
||||
expect(songCall![1].params.p).toBe(2);
|
||||
});
|
||||
});
|
||||
+327
-62
@@ -2,23 +2,36 @@ import axios, { type AxiosInstance } from "axios";
|
||||
import type {
|
||||
MusicProvider,
|
||||
Song,
|
||||
SongUrlResult,
|
||||
Playlist,
|
||||
PlaylistDetail,
|
||||
LyricLine,
|
||||
SearchResult,
|
||||
QrCodeResult,
|
||||
AuthStatus,
|
||||
Album,
|
||||
} from "./provider.js";
|
||||
import { parseLyrics } from "./netease.js";
|
||||
|
||||
// Direct QQ Music API client — bypasses the local API server for search
|
||||
// because @sansenjian/qq-music-api still uses the broken c.y.qq.com endpoint.
|
||||
const qqDirectApi = axios.create({
|
||||
// Primary search client: u.y.qq.com/cgi-bin/musicu.fcg (JSON sub-request
|
||||
// batch). Was broken ca. 2026-05 due to two upstream API changes:
|
||||
// 1. searchid param must NOT be present (causes all lists to be empty)
|
||||
// 2. num_per_page must be >= 10 (lower values return empty)
|
||||
// Both fixes applied per https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/61
|
||||
const qqMusicuApi = axios.create({
|
||||
baseURL: "https://u.y.qq.com",
|
||||
timeout: 10000,
|
||||
headers: { referer: "https://y.qq.com" },
|
||||
});
|
||||
|
||||
// Fallback search client: c.y.qq.com/soso/fcgi-bin/client_search_cp (classic
|
||||
// endpoint, song + album only, no playlist support).
|
||||
const qqSearchApi = axios.create({
|
||||
baseURL: "https://c.y.qq.com",
|
||||
timeout: 10000,
|
||||
headers: { referer: "https://y.qq.com" },
|
||||
});
|
||||
|
||||
// Direct client for c.y.qq.com endpoints (collected playlists / favorites).
|
||||
// The bundled qq-music-api wrapper doesn't expose these endpoints.
|
||||
const qqFavApi = axios.create({
|
||||
@@ -27,6 +40,57 @@ const qqFavApi = axios.create({
|
||||
headers: { referer: "https://y.qq.com/" },
|
||||
});
|
||||
|
||||
export function mapQqSongs(raw: any[] | null | undefined): Song[] {
|
||||
if (!Array.isArray(raw)) return [];
|
||||
return raw.map((s) => {
|
||||
const albumMid = s.album?.mid ?? s.album?.pmid ?? s.albummid ?? s.albumMid ?? "";
|
||||
return {
|
||||
id: String(s.mid ?? s.songmid ?? s.songMID ?? s.id ?? s.songid ?? s.songId ?? ""),
|
||||
name: s.title ?? s.name ?? s.songname ?? "",
|
||||
artist: (s.singer ?? s.singers ?? []).map((a: any) => a.name ?? a.title ?? "").filter(Boolean).join(" / "),
|
||||
album: s.album?.name ?? s.album?.title ?? s.albumname ?? "",
|
||||
duration: s.interval ?? Math.round((s.duration ?? 0) / 1000),
|
||||
coverUrl: albumMid
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${albumMid}.jpg`
|
||||
: "",
|
||||
platform: "qq" as const,
|
||||
vip: s.pay?.payplay === 1 || s.pay?.paytrackprice === 1 || false,
|
||||
};
|
||||
}).filter((s) => s.id);
|
||||
}
|
||||
|
||||
/** 解析 QQ 试听标记 → 试听秒数;非试听(VIP/免费)返回 undefined。
|
||||
* 字段 isTryout===1 / tryout===true + tryBegin/tryEnd;容忍 begin/start 别名 + 毫秒兜底。 */
|
||||
export function parseQqTrial(playUrl: any): number | undefined {
|
||||
if (!playUrl || typeof playUrl !== "object") return undefined;
|
||||
if (playUrl.isTryout !== 1 && playUrl.tryout !== true) return undefined;
|
||||
const begin = Number(playUrl.tryBegin ?? playUrl.begin ?? playUrl.start ?? 0);
|
||||
const end = Number(playUrl.tryEnd ?? playUrl.end);
|
||||
if (!Number.isFinite(end) || end <= begin) return undefined;
|
||||
const secs = end > 1000 ? (end - begin) / 1000 : end - begin;
|
||||
return Math.round(secs);
|
||||
}
|
||||
|
||||
export function mapQqAlbums(raw: any[] | null | undefined): Album[] {
|
||||
if (!Array.isArray(raw)) return [];
|
||||
return raw.map((a) => {
|
||||
const id = String(a.albumMID ?? a.mid ?? a.albumID ?? "");
|
||||
const artist = a.singerName
|
||||
?? (Array.isArray(a.singer) ? a.singer.map((s: any) => s.name).join(" / ") : "");
|
||||
const coverUrl = id
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${id}.jpg`
|
||||
: (a.albumPic ?? "");
|
||||
return {
|
||||
id,
|
||||
name: a.albumName ?? a.title ?? "",
|
||||
artist,
|
||||
coverUrl,
|
||||
songCount: a.song_count ?? a.songCount ?? 0,
|
||||
platform: "qq" as const,
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
function computeGtk(pSkey: string): number {
|
||||
let hash = 5381;
|
||||
for (let i = 0; i < pSkey.length; i++) {
|
||||
@@ -40,6 +104,7 @@ export class QQMusicProvider implements MusicProvider {
|
||||
private api: AxiosInstance;
|
||||
private cookie = "";
|
||||
private quality = "exhigh";
|
||||
private radarPage = 1;
|
||||
|
||||
constructor(baseUrl: string) {
|
||||
this.api = axios.create({
|
||||
@@ -60,46 +125,159 @@ export class QQMusicProvider implements MusicProvider {
|
||||
return this.cookie ? { cookie: this.cookie } : {};
|
||||
}
|
||||
|
||||
async search(query: string, limit = 20): Promise<SearchResult> {
|
||||
const reqData = JSON.stringify({
|
||||
req_0: {
|
||||
module: "music.search.SearchCgiService",
|
||||
method: "DoSearchForQQMusicDesktop",
|
||||
param: {
|
||||
searchid: "1",
|
||||
query,
|
||||
num_per_page: Math.min(limit, 50),
|
||||
},
|
||||
},
|
||||
});
|
||||
const res = await qqDirectApi.get("/cgi-bin/musicu.fcg", {
|
||||
params: { format: "json", data: reqData },
|
||||
});
|
||||
const list: any[] =
|
||||
res.data?.req_0?.data?.body?.song?.list ?? [];
|
||||
|
||||
const songs: Song[] = list.map((s: any) => ({
|
||||
id: String(s.mid ?? s.id),
|
||||
name: s.title ?? s.name ?? "",
|
||||
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.album?.name ?? s.album?.title ?? "",
|
||||
duration: s.interval ?? 0,
|
||||
coverUrl: s.album?.mid
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.album.mid}.jpg`
|
||||
: "",
|
||||
platform: "qq",
|
||||
}));
|
||||
|
||||
return { songs, playlists: [], albums: [] };
|
||||
private get directCookieHeaders(): Record<string, string> {
|
||||
return this.cookie ? { Cookie: this.cookie } : {};
|
||||
}
|
||||
|
||||
async getSongUrl(songId: string, quality?: string): Promise<string | null> {
|
||||
private buildMusicuPayload(module: string, method: string, param: Record<string, unknown>): Record<string, unknown> {
|
||||
const uinMatch = /(?:^|; )(?:uin|qqmusic_uin)=o?0?(\d+)/.exec(this.cookie);
|
||||
const pSkeyMatch = /(?:^|; )p_skey=([^;]+)/.exec(this.cookie);
|
||||
return {
|
||||
comm: {
|
||||
ct: 24,
|
||||
cv: 4747474,
|
||||
platform: "yqq.json",
|
||||
uin: uinMatch ? uinMatch[1] : "0",
|
||||
g_tk: pSkeyMatch ? computeGtk(pSkeyMatch[1]) : 5381,
|
||||
format: "json",
|
||||
inCharset: "utf-8",
|
||||
outCharset: "utf-8",
|
||||
notice: 0,
|
||||
need_new_code: 1,
|
||||
},
|
||||
req_0: { module, method, param },
|
||||
};
|
||||
}
|
||||
|
||||
async search(query: string, limit = 20, offset = 0): Promise<SearchResult> {
|
||||
// Primary: u.y.qq.com/cgi-bin/musicu.fcg — supports songs + albums +
|
||||
// playlists. Fixed per https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/61
|
||||
// (removed searchid, num_per_page >= 10, corrected search_type values).
|
||||
const primary = await this.searchViaMusicuFcg(query, limit, offset);
|
||||
if (primary) return primary;
|
||||
|
||||
// Fallback: c.y.qq.com/soso/fcgi-bin/client_search_cp (song + album,
|
||||
// no playlist support). Kept as redundancy.
|
||||
return this.searchViaClientSearchCp(query, limit, offset);
|
||||
}
|
||||
|
||||
/** Primary search via u.y.qq.com/cgi-bin/musicu.fcg.
|
||||
*
|
||||
* Two upstream API changes (2026-05) required fixes:
|
||||
* 1. Omit `searchid` — its presence now causes all lists to be empty.
|
||||
* 2. `num_per_page` >= 10 — lower values return empty.
|
||||
* 3. `search_type: 2` for albums, `3` for playlists (8 was "user"). */
|
||||
private async searchViaMusicuFcg(
|
||||
query: string,
|
||||
limit: number,
|
||||
offset = 0
|
||||
): Promise<SearchResult | null> {
|
||||
try {
|
||||
// num_per_page must stay >= 10 (lower values return empty). It is now
|
||||
// limit-driven for ALL three lists (albums/playlists were hardcoded to
|
||||
// 10). page_num is the offset cursor; the web always requests in
|
||||
// limit-aligned pages so offset is a multiple of limit.
|
||||
const numPerPage = Math.max(10, Math.min(limit, 50));
|
||||
const pageNum = Math.floor(offset / limit) + 1;
|
||||
const reqData = JSON.stringify({
|
||||
req_0: {
|
||||
module: "music.search.SearchCgiService",
|
||||
method: "DoSearchForQQMusicDesktop",
|
||||
param: { query, num_per_page: numPerPage, page_num: pageNum, search_type: 0 },
|
||||
},
|
||||
req_album: {
|
||||
module: "music.search.SearchCgiService",
|
||||
method: "DoSearchForQQMusicDesktop",
|
||||
param: { query, num_per_page: numPerPage, page_num: pageNum, search_type: 2 },
|
||||
},
|
||||
req_playlist: {
|
||||
module: "music.search.SearchCgiService",
|
||||
method: "DoSearchForQQMusicDesktop",
|
||||
param: { query, num_per_page: numPerPage, page_num: pageNum, search_type: 3 },
|
||||
},
|
||||
});
|
||||
const res = await qqMusicuApi.get("/cgi-bin/musicu.fcg", {
|
||||
params: { format: "json", data: reqData },
|
||||
});
|
||||
|
||||
const songList: any[] =
|
||||
res.data?.req_0?.data?.body?.song?.list ?? [];
|
||||
if (songList.length === 0) return null;
|
||||
|
||||
const songs = mapQqSongs(songList);
|
||||
|
||||
const albumList: any[] = res.data?.req_album?.data?.body?.album?.list ?? [];
|
||||
const albums = mapQqAlbums(albumList);
|
||||
|
||||
const playlistList: any[] = res.data?.req_playlist?.data?.body?.songlist?.list ?? [];
|
||||
const playlists: Playlist[] = playlistList.map((p: any) => ({
|
||||
id: String(p.dissid ?? p.id ?? ""),
|
||||
name: p.dissname ?? p.title ?? "",
|
||||
coverUrl: p.imgurl ?? p.logo ?? "",
|
||||
songCount: p.songnum ?? p.song_count ?? 0,
|
||||
platform: "qq" as const,
|
||||
}));
|
||||
|
||||
return { songs, playlists, albums };
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/** Fallback search via c.y.qq.com/soso/fcgi-bin/client_search_cp */
|
||||
private async searchViaClientSearchCp(
|
||||
query: string,
|
||||
limit: number,
|
||||
offset = 0
|
||||
): Promise<SearchResult> {
|
||||
// `p` is the 1-based page cursor. The web pages in limit-aligned steps so
|
||||
// offset is a multiple of limit.
|
||||
const page = Math.floor(offset / limit) + 1;
|
||||
const songParams = {
|
||||
w: query,
|
||||
format: "json",
|
||||
p: page,
|
||||
n: Math.min(limit, 50),
|
||||
type: 0,
|
||||
cr: 1,
|
||||
};
|
||||
const albumParams = {
|
||||
w: query,
|
||||
format: "json",
|
||||
p: page,
|
||||
n: 5,
|
||||
t: 8,
|
||||
cr: 1,
|
||||
};
|
||||
|
||||
const [songRes, albumRes] = await Promise.allSettled([
|
||||
qqSearchApi.get("/soso/fcgi-bin/client_search_cp", { params: songParams }),
|
||||
qqSearchApi.get("/soso/fcgi-bin/client_search_cp", { params: albumParams }),
|
||||
]);
|
||||
|
||||
const songList: any[] =
|
||||
songRes.status === "fulfilled"
|
||||
? (songRes.value.data?.data?.song?.list ?? [])
|
||||
: [];
|
||||
|
||||
const songs = mapQqSongs(songList);
|
||||
|
||||
const albumList: any[] =
|
||||
albumRes.status === "fulfilled"
|
||||
? (albumRes.value.data?.data?.album?.list ?? [])
|
||||
: [];
|
||||
const albums = mapQqAlbums(albumList);
|
||||
|
||||
return { songs, playlists: [], albums };
|
||||
}
|
||||
|
||||
async getSongUrl(songId: string, quality?: string): Promise<SongUrlResult | null> {
|
||||
try {
|
||||
const res = await this.api.get("/getMusicPlay", {
|
||||
params: { songmid: songId, quality: quality ?? this.quality, ...this.cookieParams },
|
||||
});
|
||||
const playUrl = res.data?.data?.playUrl?.[songId];
|
||||
if (playUrl?.url) return playUrl.url;
|
||||
if (playUrl?.url) return { url: playUrl.url, trialDuration: parseQqTrial(playUrl) };
|
||||
} catch {
|
||||
// try with songid
|
||||
try {
|
||||
@@ -107,7 +285,7 @@ export class QQMusicProvider implements MusicProvider {
|
||||
params: { songid: songId, quality: quality ?? this.quality, ...this.cookieParams },
|
||||
});
|
||||
const playUrl = res.data?.data?.playUrl?.[songId];
|
||||
if (playUrl?.url) return playUrl.url;
|
||||
if (playUrl?.url) return { url: playUrl.url, trialDuration: parseQqTrial(playUrl) };
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
@@ -186,8 +364,18 @@ export class QQMusicProvider implements MusicProvider {
|
||||
};
|
||||
}
|
||||
} catch {
|
||||
// fall through to stub
|
||||
// fall through to musicu.fcg fallback
|
||||
}
|
||||
|
||||
// Fallback: fetch metadata via u.y.qq.com/cgi-bin/musicu.fcg. The bundled
|
||||
// library's /getSongInfo route is broken (upstream code 500001), so the
|
||||
// primary try above almost always falls through here for QQ. Without this,
|
||||
// play-by-id songs carry an empty name → the TS nickname / now-playing
|
||||
// message renders as "♪ 正在播放: - []". This endpoint (same host/shape
|
||||
// as search) reliably returns full track_info without requiring login.
|
||||
const detail = await this.fetchSongDetailViaMusicu(songId);
|
||||
if (detail) return detail;
|
||||
|
||||
// Minimal stub — resolveAndPlay only needs id + platform to fetch a
|
||||
// play URL. Name/artist/album will be empty in play history, but the
|
||||
// song will actually play, which is the important part.
|
||||
@@ -202,25 +390,49 @@ export class QQMusicProvider implements MusicProvider {
|
||||
};
|
||||
}
|
||||
|
||||
/** Fetch a single song's metadata via u.y.qq.com/cgi-bin/musicu.fcg
|
||||
* (module music.pf_song_detail_svr / get_song_detail_yqq). This mirrors the
|
||||
* search path's host + request shape and, unlike the library's /getSongInfo,
|
||||
* actually works against QQ's current API. Returns null on any failure so the
|
||||
* caller can fall back to the minimal stub. */
|
||||
private async fetchSongDetailViaMusicu(songId: string): Promise<Song | null> {
|
||||
try {
|
||||
const reqData = JSON.stringify({
|
||||
req_0: {
|
||||
module: "music.pf_song_detail_svr",
|
||||
method: "get_song_detail_yqq",
|
||||
param: { song_mid: songId, song_type: 0 },
|
||||
},
|
||||
});
|
||||
const res = await qqMusicuApi.get("/cgi-bin/musicu.fcg", {
|
||||
params: { format: "json", data: reqData },
|
||||
});
|
||||
const t = res.data?.req_0?.data?.track_info;
|
||||
if (!t) return null;
|
||||
const albumMid = t.album?.mid ?? t.album?.pmid ?? "";
|
||||
return {
|
||||
id: String(t.mid ?? t.id ?? songId),
|
||||
name: t.name ?? t.title ?? "",
|
||||
artist: (t.singer ?? []).map((a: any) => a.name ?? a.title ?? "").filter(Boolean).join(" / "),
|
||||
album: t.album?.name ?? t.album?.title ?? "",
|
||||
duration: t.interval ?? 0,
|
||||
coverUrl: albumMid
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${albumMid}.jpg`
|
||||
: "",
|
||||
platform: "qq",
|
||||
};
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async getPlaylistSongs(playlistId: string): Promise<Song[]> {
|
||||
const res = await this.api.get("/getSongListDetail", {
|
||||
params: { disstid: playlistId, ...this.cookieParams },
|
||||
});
|
||||
const cdlist = res.data?.response?.cdlist ?? [];
|
||||
if (cdlist.length === 0) return [];
|
||||
return (cdlist[0].songlist ?? []).map((s: any) => ({
|
||||
id: String(s.mid ?? s.songmid ?? s.songid),
|
||||
name: s.songname ?? s.name ?? "",
|
||||
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.albumname ?? "",
|
||||
duration: s.interval ?? 0,
|
||||
coverUrl: s.album?.mid
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.album.mid}.jpg`
|
||||
: s.albummid
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.albummid}.jpg`
|
||||
: "",
|
||||
platform: "qq",
|
||||
}));
|
||||
return mapQqSongs(cdlist[0].songlist ?? []);
|
||||
}
|
||||
|
||||
async getPlaylistDetail(playlistId: string): Promise<PlaylistDetail | null> {
|
||||
@@ -255,17 +467,7 @@ export class QQMusicProvider implements MusicProvider {
|
||||
const res = await this.api.get("/getAlbumInfo", {
|
||||
params: { albummid: albumId, ...this.cookieParams },
|
||||
});
|
||||
return (res.data?.response?.data?.list ?? []).map((s: any) => ({
|
||||
id: String(s.songmid ?? s.songid),
|
||||
name: s.songname ?? "",
|
||||
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
||||
album: s.albumname ?? "",
|
||||
duration: s.interval ?? 0,
|
||||
coverUrl: s.albummid
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.albummid}.jpg`
|
||||
: "",
|
||||
platform: "qq",
|
||||
}));
|
||||
return mapQqSongs(res.data?.response?.data?.list ?? []);
|
||||
}
|
||||
|
||||
async getLyrics(songId: string): Promise<LyricLine[]> {
|
||||
@@ -330,6 +532,9 @@ export class QQMusicProvider implements MusicProvider {
|
||||
|
||||
setCookie(cookie: string): void {
|
||||
this.cookie = cookie;
|
||||
// Reset radar pagination so a re-login (different account) starts from the
|
||||
// first page rather than inheriting the previous account's cursor.
|
||||
this.radarPage = 1;
|
||||
}
|
||||
|
||||
getCookie(): string {
|
||||
@@ -385,12 +590,72 @@ export class QQMusicProvider implements MusicProvider {
|
||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.album.mid}.jpg`
|
||||
: "",
|
||||
platform: "qq",
|
||||
vip: s.pay?.payplay === 1 || s.pay?.paytrackprice === 1 || false,
|
||||
}));
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
async getPersonalFm(): Promise<Song[]> {
|
||||
const radarSongs = await this.getRadarRecommendSongs();
|
||||
if (radarSongs.length > 0) return radarSongs;
|
||||
return this.getGuessRecommendSongs();
|
||||
}
|
||||
|
||||
private async getRadarRecommendSongs(): Promise<Song[]> {
|
||||
try {
|
||||
const page = this.radarPage;
|
||||
const res = await qqMusicuApi.post(
|
||||
"/cgi-bin/musicu.fcg",
|
||||
this.buildMusicuPayload(
|
||||
"music.recommend.TrackRelationServer",
|
||||
"GetRadarSong",
|
||||
{
|
||||
Page: page,
|
||||
ReqType: 0,
|
||||
FavSongs: [],
|
||||
EntranceSongs: [],
|
||||
}
|
||||
),
|
||||
{ headers: { referer: "https://y.qq.com/", ...this.directCookieHeaders } }
|
||||
);
|
||||
const tracks = (res.data?.req_0?.data?.VecSongs ?? [])
|
||||
.map((item: any) => item?.Track)
|
||||
.filter(Boolean);
|
||||
const songs = mapQqSongs(tracks);
|
||||
if (songs.length > 0) {
|
||||
this.radarPage = page + 1;
|
||||
}
|
||||
return songs;
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
private async getGuessRecommendSongs(): Promise<Song[]> {
|
||||
try {
|
||||
const res = await qqMusicuApi.post(
|
||||
"/cgi-bin/musicu.fcg",
|
||||
this.buildMusicuPayload(
|
||||
"music.radioProxy.MbTrackRadioSvr",
|
||||
"get_radio_track",
|
||||
{
|
||||
id: 99,
|
||||
num: 5,
|
||||
from: 0,
|
||||
scene: 0,
|
||||
song_ids: [],
|
||||
}
|
||||
),
|
||||
{ headers: { referer: "https://y.qq.com/", ...this.directCookieHeaders } }
|
||||
);
|
||||
return mapQqSongs(res.data?.req_0?.data?.Tracks ?? []);
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
async getUserPlaylists(): Promise<Playlist[]> {
|
||||
if (!this.cookie) return [];
|
||||
const uinMatch = /(?:^|; )uin=o?0?(\d+)/.exec(this.cookie);
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { resolveSpotifyBackendKind as pick } from "./backend-select.js";
|
||||
describe("resolveSpotifyBackendKind", () => {
|
||||
it("auto: go present -> go-librespot", () => expect(pick("auto", true, true)).toBe("go-librespot"));
|
||||
it("auto: go absent, rust present -> librespot", () => expect(pick("auto", false, true)).toBe("librespot"));
|
||||
it("auto: neither -> null", () => expect(pick("auto", false, false)).toBeNull());
|
||||
it("go-librespot: present -> go-librespot", () => expect(pick("go-librespot", true, true)).toBe("go-librespot"));
|
||||
it("go-librespot: absent -> null even if rust present", () => expect(pick("go-librespot", false, true)).toBeNull());
|
||||
it("librespot: present -> librespot", () => expect(pick("librespot", true, true)).toBe("librespot"));
|
||||
it("librespot: absent -> null even if go present", () => expect(pick("librespot", true, false)).toBeNull());
|
||||
it("auto default fallthrough matches auto", () => expect(pick("auto", true, false)).toBe("go-librespot"));
|
||||
});
|
||||
@@ -0,0 +1,25 @@
|
||||
/** Which concrete backend runs for a given config + host binary availability. */
|
||||
export type SpotifyBackendKind = "go-librespot" | "librespot";
|
||||
|
||||
/**
|
||||
* Pure backend selection shared by SpotifyController.chooseBackend() (per-bot)
|
||||
* and the web /status endpoint (process-wide). Booleans in, no IO — the caller
|
||||
* supplies platform+binary presence.
|
||||
*/
|
||||
export function resolveSpotifyBackendKind(
|
||||
backend: "auto" | "go-librespot" | "librespot",
|
||||
goPresent: boolean,
|
||||
rustPresent: boolean,
|
||||
): SpotifyBackendKind | null {
|
||||
switch (backend) {
|
||||
case "go-librespot":
|
||||
return goPresent ? "go-librespot" : null;
|
||||
case "librespot":
|
||||
return rustPresent ? "librespot" : null;
|
||||
case "auto":
|
||||
default:
|
||||
if (goPresent) return "go-librespot";
|
||||
if (rustPresent) return "librespot";
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
// src/music/spotify/backend.ts
|
||||
// Type contract for the Spotify audio backend (go-librespot sidecar).
|
||||
// Interface-only: this module intentionally contains NO runtime code so it
|
||||
// can be imported for types by go-librespot.ts and controller.ts without
|
||||
// pulling in child_process/ws/ffmpeg at type-check time.
|
||||
|
||||
/** Emitted when the currently playing Spotify track finishes or is stopped. */
|
||||
export interface SpotifyTrackEndedEvent {
|
||||
uri: string;
|
||||
reason: "ended" | "stopped" | "error";
|
||||
}
|
||||
|
||||
/** Now-playing metadata surfaced from the go-librespot "metadata" event. */
|
||||
export interface SpotifyNowPlaying {
|
||||
uri: string;
|
||||
name: string;
|
||||
artist: string;
|
||||
album: string;
|
||||
coverUrl: string;
|
||||
durationMs: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Long-lived Spotify audio source: owns the go-librespot sidecar + FIFO->ffmpeg
|
||||
* PCM pipe and exposes transport control plus a continuous 48kHz s16le stereo
|
||||
* PCM stream to feed AudioPlayer.playPcmStream().
|
||||
*/
|
||||
export interface SpotifyAudioBackend {
|
||||
start(): Promise<void>;
|
||||
stop(): void;
|
||||
isReady(): boolean;
|
||||
playTrack(uri: string): Promise<void>;
|
||||
pause(): Promise<void>;
|
||||
resume(): Promise<void>;
|
||||
seek(ms: number): Promise<void>;
|
||||
getPcmStream(): import("node:stream").Readable;
|
||||
getPositionMs(): number;
|
||||
on(event: "trackEnded", cb: (e: SpotifyTrackEndedEvent) => void): void;
|
||||
on(event: "metadata", cb: (m: SpotifyNowPlaying) => void): void;
|
||||
on(event: "ready" | "error", cb: (arg?: unknown) => void): void;
|
||||
}
|
||||
@@ -0,0 +1,363 @@
|
||||
import { describe, it, expect, vi, afterEach } from "vitest";
|
||||
import { join } from "node:path";
|
||||
import { mkdtempSync, writeFileSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import {
|
||||
isGoLibrespotSupported,
|
||||
pickGoLibrespotPath,
|
||||
findGoLibrespot,
|
||||
checkGoLibrespotAvailable,
|
||||
resetGoLibrespotBinaryCache,
|
||||
__setGoLibrespotVersionProbe,
|
||||
isRustLibrespotSupported,
|
||||
pickLibrespotPath,
|
||||
findLibrespot,
|
||||
checkLibrespotAvailable,
|
||||
resetLibrespotBinaryCache,
|
||||
__setLibrespotVersionProbe,
|
||||
resolveExecutable,
|
||||
isLibrespotPresent,
|
||||
isGoLibrespotPresent,
|
||||
} from "./binary.js";
|
||||
|
||||
const origPlatform = process.platform;
|
||||
function setPlatform(p: NodeJS.Platform): void {
|
||||
Object.defineProperty(process, "platform", { value: p, configurable: true });
|
||||
}
|
||||
|
||||
// Snapshot the PATH env so PATH-resolution tests can point it at temp dirs and
|
||||
// restore afterwards. PATHEXT is optional (undefined on posix); track presence.
|
||||
const origPath = process.env.PATH;
|
||||
const origPathExt = process.env.PATHEXT;
|
||||
const tmpDirs: string[] = [];
|
||||
function mkTmpDir(prefix: string): string {
|
||||
const dir = mkdtempSync(join(tmpdir(), prefix));
|
||||
tmpDirs.push(dir);
|
||||
return dir;
|
||||
}
|
||||
|
||||
afterEach(() => {
|
||||
setPlatform(origPlatform);
|
||||
__setGoLibrespotVersionProbe(null);
|
||||
resetGoLibrespotBinaryCache();
|
||||
__setLibrespotVersionProbe(null);
|
||||
resetLibrespotBinaryCache();
|
||||
process.env.PATH = origPath;
|
||||
if (origPathExt === undefined) delete process.env.PATHEXT;
|
||||
else process.env.PATHEXT = origPathExt;
|
||||
for (const dir of tmpDirs.splice(0)) {
|
||||
try {
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
describe("isGoLibrespotSupported", () => {
|
||||
it("is true only on linux", () => {
|
||||
setPlatform("linux");
|
||||
expect(isGoLibrespotSupported()).toBe(true);
|
||||
setPlatform("win32");
|
||||
expect(isGoLibrespotSupported()).toBe(false);
|
||||
setPlatform("darwin");
|
||||
expect(isGoLibrespotSupported()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("pickGoLibrespotPath (bin/ then PATH ordering)", () => {
|
||||
const binPath = join("some", "root", "bin", "go-librespot");
|
||||
|
||||
it("prefers the bin/ path when the file exists", () => {
|
||||
expect(
|
||||
pickGoLibrespotPath([binPath, "go-librespot"], (p) => p === binPath),
|
||||
).toBe(binPath);
|
||||
});
|
||||
|
||||
it("falls through to the bare PATH name when the bin/ file is missing", () => {
|
||||
expect(pickGoLibrespotPath([binPath, "go-librespot"], () => false)).toBe(
|
||||
"go-librespot",
|
||||
);
|
||||
});
|
||||
|
||||
it("returns bare command names without touching the filesystem", () => {
|
||||
const exists = vi.fn(() => false);
|
||||
expect(pickGoLibrespotPath(["go-librespot"], exists)).toBe("go-librespot");
|
||||
expect(exists).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("findGoLibrespot", () => {
|
||||
it("returns the bare command name when bin/go-librespot is absent", () => {
|
||||
// No go-librespot binary is committed under bin/, so resolution must
|
||||
// fall back to the bare PATH name (execFile resolves it at run time).
|
||||
expect(findGoLibrespot()).toBe("go-librespot");
|
||||
});
|
||||
});
|
||||
|
||||
describe("checkGoLibrespotAvailable", () => {
|
||||
it("returns false immediately on unsupported platforms without probing", async () => {
|
||||
setPlatform("darwin");
|
||||
const probe = vi.fn(async () => {});
|
||||
__setGoLibrespotVersionProbe(probe);
|
||||
expect(await checkGoLibrespotAvailable()).toBe(false);
|
||||
expect(probe).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("returns true when the binary responds to --version on linux", async () => {
|
||||
setPlatform("linux");
|
||||
__setGoLibrespotVersionProbe(async () => {});
|
||||
expect(await checkGoLibrespotAvailable()).toBe(true);
|
||||
});
|
||||
|
||||
it("caches only positive results and probes once", async () => {
|
||||
setPlatform("linux");
|
||||
const probe = vi.fn(async () => {});
|
||||
__setGoLibrespotVersionProbe(probe);
|
||||
expect(await checkGoLibrespotAvailable()).toBe(true);
|
||||
expect(await checkGoLibrespotAvailable()).toBe(true);
|
||||
expect(probe).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does not cache a failed probe (retries on the next call)", async () => {
|
||||
setPlatform("linux");
|
||||
__setGoLibrespotVersionProbe(async () => {
|
||||
throw new Error("ENOENT");
|
||||
});
|
||||
expect(await checkGoLibrespotAvailable()).toBe(false);
|
||||
// A later successful probe must now succeed — negatives are not cached.
|
||||
__setGoLibrespotVersionProbe(async () => {});
|
||||
expect(await checkGoLibrespotAvailable()).toBe(true);
|
||||
});
|
||||
|
||||
it("resetGoLibrespotBinaryCache clears a cached positive", async () => {
|
||||
setPlatform("linux");
|
||||
__setGoLibrespotVersionProbe(async () => {});
|
||||
expect(await checkGoLibrespotAvailable()).toBe(true);
|
||||
resetGoLibrespotBinaryCache();
|
||||
__setGoLibrespotVersionProbe(async () => {
|
||||
throw new Error("gone");
|
||||
});
|
||||
expect(await checkGoLibrespotAvailable()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("isRustLibrespotSupported", () => {
|
||||
it("is true on every platform (pipe->stdout works everywhere)", () => {
|
||||
setPlatform("linux");
|
||||
expect(isRustLibrespotSupported()).toBe(true);
|
||||
setPlatform("win32");
|
||||
expect(isRustLibrespotSupported()).toBe(true);
|
||||
setPlatform("darwin");
|
||||
expect(isRustLibrespotSupported()).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("pickLibrespotPath (bin/ then PATH ordering, win32 exe)", () => {
|
||||
it("prefers the bin/ path when the file exists", () => {
|
||||
const binPath = join("some", "root", "bin", "librespot");
|
||||
expect(
|
||||
pickLibrespotPath([binPath, "librespot"], (p) => p === binPath),
|
||||
).toBe(binPath);
|
||||
});
|
||||
|
||||
it("prefers the bin/librespot.exe path on win32 when it exists", () => {
|
||||
setPlatform("win32");
|
||||
const binExe = join("some", "root", "bin", "librespot.exe");
|
||||
expect(
|
||||
pickLibrespotPath([binExe, "librespot.exe"], (p) => p === binExe),
|
||||
).toBe(binExe);
|
||||
});
|
||||
|
||||
it("falls through to the bare PATH name (librespot) on posix when bin/ is missing", () => {
|
||||
setPlatform("linux");
|
||||
const binPath = join("some", "root", "bin", "librespot");
|
||||
expect(pickLibrespotPath([binPath, "librespot"], () => false)).toBe(
|
||||
"librespot",
|
||||
);
|
||||
});
|
||||
|
||||
it("falls through to librespot.exe on win32 when bin/ is missing", () => {
|
||||
setPlatform("win32");
|
||||
const binExe = join("some", "root", "bin", "librespot.exe");
|
||||
expect(pickLibrespotPath([binExe], () => false)).toBe("librespot.exe");
|
||||
});
|
||||
|
||||
it("returns bare command names without touching the filesystem", () => {
|
||||
const exists = vi.fn(() => false);
|
||||
expect(pickLibrespotPath(["librespot"], exists)).toBe("librespot");
|
||||
expect(exists).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("findLibrespot", () => {
|
||||
it("returns the bare command name when bin/librespot is absent", () => {
|
||||
// No librespot binary is committed under bin/, so resolution must fall
|
||||
// back to the bare PATH name (execFile resolves it at run time).
|
||||
setPlatform("linux");
|
||||
expect(findLibrespot()).toBe("librespot");
|
||||
});
|
||||
|
||||
it("returns librespot.exe on win32 when bin/librespot.exe is absent", () => {
|
||||
setPlatform("win32");
|
||||
expect(findLibrespot()).toBe("librespot.exe");
|
||||
});
|
||||
});
|
||||
|
||||
describe("checkLibrespotAvailable", () => {
|
||||
it("returns true when the binary responds to --version (any platform)", async () => {
|
||||
setPlatform("win32");
|
||||
__setLibrespotVersionProbe(async () => {});
|
||||
expect(await checkLibrespotAvailable()).toBe(true);
|
||||
});
|
||||
|
||||
it("returns true on darwin too (no platform gate)", async () => {
|
||||
setPlatform("darwin");
|
||||
__setLibrespotVersionProbe(async () => {});
|
||||
expect(await checkLibrespotAvailable()).toBe(true);
|
||||
});
|
||||
|
||||
it("caches only positive results and probes once", async () => {
|
||||
setPlatform("linux");
|
||||
const probe = vi.fn(async () => {});
|
||||
__setLibrespotVersionProbe(probe);
|
||||
expect(await checkLibrespotAvailable()).toBe(true);
|
||||
expect(await checkLibrespotAvailable()).toBe(true);
|
||||
expect(probe).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does not cache a failed probe (retries on the next call)", async () => {
|
||||
setPlatform("win32");
|
||||
__setLibrespotVersionProbe(async () => {
|
||||
throw new Error("ENOENT");
|
||||
});
|
||||
expect(await checkLibrespotAvailable()).toBe(false);
|
||||
__setLibrespotVersionProbe(async () => {});
|
||||
expect(await checkLibrespotAvailable()).toBe(true);
|
||||
});
|
||||
|
||||
it("resetLibrespotBinaryCache clears a cached positive", async () => {
|
||||
setPlatform("linux");
|
||||
__setLibrespotVersionProbe(async () => {});
|
||||
expect(await checkLibrespotAvailable()).toBe(true);
|
||||
resetLibrespotBinaryCache();
|
||||
__setLibrespotVersionProbe(async () => {
|
||||
throw new Error("gone");
|
||||
});
|
||||
expect(await checkLibrespotAvailable()).toBe(false);
|
||||
});
|
||||
|
||||
it("de-dupes concurrent in-flight probes", async () => {
|
||||
setPlatform("linux");
|
||||
const probe = vi.fn(async () => {});
|
||||
__setLibrespotVersionProbe(probe);
|
||||
const [a, b] = await Promise.all([
|
||||
checkLibrespotAvailable(),
|
||||
checkLibrespotAvailable(),
|
||||
]);
|
||||
expect(a).toBe(true);
|
||||
expect(b).toBe(true);
|
||||
expect(probe).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("resolveExecutable", () => {
|
||||
it("returns a bin/-style path (contains a separator) that exists, unchanged", () => {
|
||||
const dir = mkTmpDir("tsmb-resolve-");
|
||||
const full = join(dir, "some-binary");
|
||||
writeFileSync(full, "#!/bin/sh\n");
|
||||
// The path contains a separator so it is checked directly, not via PATH.
|
||||
expect(resolveExecutable(full)).toBe(full);
|
||||
});
|
||||
|
||||
it("returns null for a bin/-style path that does not exist", () => {
|
||||
const full = join(tmpdir(), "tsmb-resolve-missing", "nope-binary");
|
||||
expect(resolveExecutable(full)).toBeNull();
|
||||
});
|
||||
|
||||
it("resolves a BARE command name found in a PATH directory (the I3 fix)", () => {
|
||||
// This is the regression the fix targets: a PATH-installed binary (bare
|
||||
// name, no separator) must resolve against $PATH, not process.cwd().
|
||||
const dir = mkTmpDir("tsmb-resolve-path-");
|
||||
const exeName = process.platform === "win32" ? "faketool.exe" : "faketool";
|
||||
const full = join(dir, exeName);
|
||||
writeFileSync(full, "#!/bin/sh\n");
|
||||
process.env.PATH = dir;
|
||||
expect(resolveExecutable(exeName)).toBe(full);
|
||||
});
|
||||
|
||||
it("returns null for a bare name not present in any PATH directory", () => {
|
||||
process.env.PATH = mkTmpDir("tsmb-resolve-empty-");
|
||||
expect(resolveExecutable("definitely-not-a-real-binary-xyz")).toBeNull();
|
||||
});
|
||||
|
||||
it("appends PATHEXT extensions on win32 to resolve a bare (extensionless) name", () => {
|
||||
setPlatform("win32");
|
||||
const dir = mkTmpDir("tsmb-resolve-pathext-");
|
||||
const full = join(dir, "mytool.CMD");
|
||||
writeFileSync(full, "@echo hi\n");
|
||||
process.env.PATH = dir;
|
||||
process.env.PATHEXT = ".EXE;.CMD;.BAT;.COM";
|
||||
// Bare "mytool" has no extension; win32 resolution must try PATHEXT and
|
||||
// find mytool.CMD.
|
||||
expect(resolveExecutable("mytool")).toBe(full);
|
||||
});
|
||||
|
||||
it("does not touch PATH for a bin/-style relative path with a separator", () => {
|
||||
// A candidate with a separator is checked directly even if PATH is empty.
|
||||
process.env.PATH = "";
|
||||
const dir = mkTmpDir("tsmb-resolve-direct-");
|
||||
const full = join(dir, "direct-binary");
|
||||
writeFileSync(full, "#!/bin/sh\n");
|
||||
expect(resolveExecutable(full)).toBe(full);
|
||||
});
|
||||
});
|
||||
|
||||
describe("isLibrespotPresent (PATH-aware, sync)", () => {
|
||||
it("true when the bare librespot name resolves on PATH (posix)", () => {
|
||||
setPlatform("linux");
|
||||
const dir = mkTmpDir("tsmb-librespot-path-");
|
||||
writeFileSync(join(dir, "librespot"), "#!/bin/sh\n");
|
||||
process.env.PATH = dir;
|
||||
expect(isLibrespotPresent()).toBe(true);
|
||||
});
|
||||
|
||||
it("true when librespot.exe resolves on PATH (win32)", () => {
|
||||
setPlatform("win32");
|
||||
const dir = mkTmpDir("tsmb-librespot-win-");
|
||||
writeFileSync(join(dir, "librespot.exe"), "MZ\n");
|
||||
process.env.PATH = dir;
|
||||
process.env.PATHEXT = ".EXE;.CMD;.BAT;.COM";
|
||||
expect(isLibrespotPresent()).toBe(true);
|
||||
});
|
||||
|
||||
it("false when librespot is not on PATH", () => {
|
||||
setPlatform("linux");
|
||||
process.env.PATH = mkTmpDir("tsmb-librespot-empty-");
|
||||
expect(isLibrespotPresent()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("isGoLibrespotPresent (PATH-aware, sync)", () => {
|
||||
it("true when go-librespot resolves on PATH (linux)", () => {
|
||||
setPlatform("linux");
|
||||
const dir = mkTmpDir("tsmb-go-path-");
|
||||
writeFileSync(join(dir, "go-librespot"), "#!/bin/sh\n");
|
||||
process.env.PATH = dir;
|
||||
expect(isGoLibrespotPresent()).toBe(true);
|
||||
});
|
||||
|
||||
it("false on non-linux platforms regardless of PATH (unsupported gate)", () => {
|
||||
setPlatform("win32");
|
||||
const dir = mkTmpDir("tsmb-go-win-");
|
||||
writeFileSync(join(dir, "go-librespot"), "#!/bin/sh\n");
|
||||
process.env.PATH = dir;
|
||||
expect(isGoLibrespotPresent()).toBe(false);
|
||||
});
|
||||
|
||||
it("false on linux when go-librespot is not on PATH", () => {
|
||||
setPlatform("linux");
|
||||
process.env.PATH = mkTmpDir("tsmb-go-empty-");
|
||||
expect(isGoLibrespotPresent()).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,244 @@
|
||||
import { execFile } from "node:child_process";
|
||||
import { promisify } from "node:util";
|
||||
import { existsSync } from "node:fs";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { dirname, join, delimiter } from "node:path";
|
||||
|
||||
const execFileAsync = promisify(execFile);
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
/**
|
||||
* Resolve a command to an existing absolute path, SYNCHRONOUSLY. A candidate
|
||||
* that already contains a path separator (a project bin/ path) is checked
|
||||
* directly; a BARE command name (e.g. "librespot" / "go-librespot") is searched
|
||||
* across the $PATH directories — with PATHEXT extensions appended on win32 — so
|
||||
* a scoop/choco/cargo/apt PATH install resolves. Returns the resolved path, or
|
||||
* null when nothing exists.
|
||||
*
|
||||
* This is the sync counterpart to checkLibrespotAvailable()/…GoLibrespot… and
|
||||
* is what the hot-path presence gates (chooseBackend/isAvailable) rely on: a
|
||||
* bare name must NOT be handed to existsSync() directly, since existsSync
|
||||
* resolves it against process.cwd() rather than PATH (Bug I3/m1).
|
||||
*/
|
||||
export function resolveExecutable(cmd: string): string | null {
|
||||
if (cmd.includes("/") || cmd.includes("\\")) {
|
||||
return existsSync(cmd) ? cmd : null;
|
||||
}
|
||||
const dirs = (process.env.PATH || "").split(delimiter).filter(Boolean);
|
||||
const exts =
|
||||
process.platform === "win32"
|
||||
? (process.env.PATHEXT || ".EXE;.CMD;.BAT;.COM").split(";").filter(Boolean)
|
||||
: [""];
|
||||
for (const dir of dirs) {
|
||||
for (const ext of exts) {
|
||||
const hasExt = ext && cmd.toLowerCase().endsWith(ext.toLowerCase());
|
||||
const full = join(dir, hasExt ? cmd : cmd + ext);
|
||||
if (existsSync(full)) return full;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* True only on Linux. go-librespot ships Linux-only release binaries and the
|
||||
* sidecar relies on a POSIX FIFO (mkfifo), so the Spotify audio backend is
|
||||
* gated to Linux/Docker. Everywhere else the caller falls back to the Stage-1
|
||||
* sentinel-skip message.
|
||||
*/
|
||||
export function isGoLibrespotSupported(): boolean {
|
||||
return process.platform === "linux";
|
||||
}
|
||||
|
||||
/**
|
||||
* Pure resolver core behind findGoLibrespot(). Returns the first candidate
|
||||
* that is either a bare command name (left for execFile to resolve via PATH)
|
||||
* or an existing bin/ file. Exported so tests can inject candidates + a fake
|
||||
* existence predicate and need no real binary on disk.
|
||||
*/
|
||||
export function pickGoLibrespotPath(
|
||||
candidates: string[],
|
||||
exists: (p: string) => boolean,
|
||||
): string {
|
||||
for (const c of candidates) {
|
||||
// bin/ paths only count when the file is actually present; bare names are
|
||||
// returned unconditionally and resolved later via PATH.
|
||||
const isBinPath = c.includes(join("bin", "go-librespot"));
|
||||
if (!isBinPath || exists(c)) return c;
|
||||
}
|
||||
return "go-librespot";
|
||||
}
|
||||
|
||||
/** Resolve the go-librespot binary path: project bin/ dir first, then PATH. */
|
||||
export function findGoLibrespot(): string {
|
||||
// src/music/spotify -> ../../../bin (one level deeper than youtube.ts).
|
||||
const binPath = join(__dirname, "..", "..", "..", "bin", "go-librespot");
|
||||
return pickGoLibrespotPath([binPath, "go-librespot"], existsSync);
|
||||
}
|
||||
|
||||
/**
|
||||
* SYNCHRONOUS presence gate for go-librespot: supported platform (linux) AND
|
||||
* the resolved binary (project bin/ OR a PATH install) actually exists. This is
|
||||
* what chooseBackend()/isAvailable() must use — NOT existsSync(findGoLibrespot())
|
||||
* which cannot see a bare PATH name (Bug I3/m1).
|
||||
*/
|
||||
export function isGoLibrespotPresent(): boolean {
|
||||
return isGoLibrespotSupported() && resolveExecutable(findGoLibrespot()) !== null;
|
||||
}
|
||||
|
||||
// Injectable `--version` probe. Defaults to the real execFile call; tests
|
||||
// override it so checkGoLibrespotAvailable() needs no real binary. Keeps the
|
||||
// public checkGoLibrespotAvailable() signature param-free per the contract.
|
||||
type VersionProbe = (bin: string) => Promise<void>;
|
||||
const realProbe: VersionProbe = async (bin) => {
|
||||
await execFileAsync(bin, ["--version"], { timeout: 5_000, maxBuffer: 1024 });
|
||||
};
|
||||
let versionProbe: VersionProbe = realProbe;
|
||||
|
||||
/** Test hook: override the `--version` probe, or restore the default with null. */
|
||||
export function __setGoLibrespotVersionProbe(
|
||||
probe: VersionProbe | null,
|
||||
): void {
|
||||
versionProbe = probe ?? realProbe;
|
||||
}
|
||||
|
||||
/**
|
||||
* Availability check for go-librespot. Returns false immediately on non-Linux
|
||||
* platforms (unsupported). Otherwise runs `go-librespot --version` (5s timeout)
|
||||
* and caches ONLY the positive result — a missing binary is retried on the
|
||||
* next call so the operator can install it without restarting the server.
|
||||
*/
|
||||
let cachedAvailable = false;
|
||||
let pendingCheck: Promise<boolean> | null = null;
|
||||
export async function checkGoLibrespotAvailable(): Promise<boolean> {
|
||||
if (!isGoLibrespotSupported()) return false;
|
||||
if (cachedAvailable) return true;
|
||||
if (pendingCheck) return pendingCheck;
|
||||
pendingCheck = (async () => {
|
||||
try {
|
||||
await versionProbe(findGoLibrespot());
|
||||
cachedAvailable = true;
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
} finally {
|
||||
pendingCheck = null;
|
||||
}
|
||||
})();
|
||||
return pendingCheck;
|
||||
}
|
||||
|
||||
/** Force re-detection on the next call (for tests). */
|
||||
export function resetGoLibrespotBinaryCache(): void {
|
||||
cachedAvailable = false;
|
||||
pendingCheck = null;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Rust librespot (librespot-org) resolver — mirrors the go-librespot fns
|
||||
// above. Unlike go-librespot, Rust librespot's `--backend pipe` writes PCM to
|
||||
// *stdout* on every platform (no FIFO, no audio device), so it is supported
|
||||
// on Windows/macOS/Linux alike and the binary is named librespot.exe on win32.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* True on ALL platforms. The Rust librespot pipe backend writes raw bytes to
|
||||
* process stdout, which Node's spawned child.stdout receives unmodified on
|
||||
* Windows too — so there is no platform gate here (contrast
|
||||
* isGoLibrespotSupported, which is Linux-only).
|
||||
*/
|
||||
export function isRustLibrespotSupported(): boolean {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pure resolver core behind findLibrespot(). Returns the first candidate that
|
||||
* is either a bare command name (left for execFile to resolve via PATH) or an
|
||||
* existing bin/ file. Exported so tests can inject candidates + a fake
|
||||
* existence predicate and need no real binary on disk. Mirrors
|
||||
* pickGoLibrespotPath but keys off the win32 exe name.
|
||||
*/
|
||||
export function pickLibrespotPath(
|
||||
candidates: string[],
|
||||
exists: (p: string) => boolean,
|
||||
): string {
|
||||
const exe = process.platform === "win32" ? "librespot.exe" : "librespot";
|
||||
for (const c of candidates) {
|
||||
// bin/ paths only count when the file is actually present; bare names are
|
||||
// returned unconditionally and resolved later via PATH.
|
||||
const isBinPath = c.includes(join("bin", "librespot"));
|
||||
if (!isBinPath || exists(c)) return c;
|
||||
}
|
||||
return exe;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the Rust librespot binary path: project bin/ dir first, then PATH.
|
||||
* On win32 both the bin/librespot.exe candidate and the bare "librespot.exe"
|
||||
* fallback are used so a PATH-installed librespot.exe (scoop/choco) resolves.
|
||||
*/
|
||||
export function findLibrespot(): string {
|
||||
const exe = process.platform === "win32" ? "librespot.exe" : "librespot";
|
||||
// src/music/spotify -> ../../../bin (same depth as findGoLibrespot).
|
||||
const binExe = join(__dirname, "..", "..", "..", "bin", exe);
|
||||
const binBare = join(__dirname, "..", "..", "..", "bin", "librespot");
|
||||
return pickLibrespotPath([binExe, binBare, exe], existsSync);
|
||||
}
|
||||
|
||||
/**
|
||||
* SYNCHRONOUS presence gate for Rust librespot: supported everywhere AND the
|
||||
* resolved binary (project bin/ OR a scoop/choco/cargo PATH install) actually
|
||||
* exists. This is what chooseBackend()/isAvailable() must use — NOT
|
||||
* existsSync(findLibrespot()) which cannot see a bare PATH name (Bug I3/m1).
|
||||
*/
|
||||
export function isLibrespotPresent(): boolean {
|
||||
return isRustLibrespotSupported() && resolveExecutable(findLibrespot()) !== null;
|
||||
}
|
||||
|
||||
// Injectable `--version` probe. Defaults to the real execFile call; tests
|
||||
// override it so checkLibrespotAvailable() needs no real binary. Keeps the
|
||||
// public checkLibrespotAvailable() signature param-free per the contract.
|
||||
type LibrespotVersionProbe = (bin: string) => Promise<void>;
|
||||
const realLibrespotProbe: LibrespotVersionProbe = async (bin) => {
|
||||
await execFileAsync(bin, ["--version"], { timeout: 5_000, maxBuffer: 1024 });
|
||||
};
|
||||
let librespotVersionProbe: LibrespotVersionProbe = realLibrespotProbe;
|
||||
|
||||
/** Test hook: override the `--version` probe, or restore the default with null. */
|
||||
export function __setLibrespotVersionProbe(
|
||||
probe: LibrespotVersionProbe | null,
|
||||
): void {
|
||||
librespotVersionProbe = probe ?? realLibrespotProbe;
|
||||
}
|
||||
|
||||
/**
|
||||
* Availability check for Rust librespot. No platform gate (supported
|
||||
* everywhere). Runs `librespot --version` (5s timeout) and caches ONLY the
|
||||
* positive result — a missing binary is retried on the next call so the
|
||||
* operator can install it (cargo/scoop/choco) without restarting the server.
|
||||
*/
|
||||
let rustCachedAvailable = false;
|
||||
let rustPendingCheck: Promise<boolean> | null = null;
|
||||
export async function checkLibrespotAvailable(): Promise<boolean> {
|
||||
if (!isRustLibrespotSupported()) return false;
|
||||
if (rustCachedAvailable) return true;
|
||||
if (rustPendingCheck) return rustPendingCheck;
|
||||
rustPendingCheck = (async () => {
|
||||
try {
|
||||
await librespotVersionProbe(findLibrespot());
|
||||
rustCachedAvailable = true;
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
} finally {
|
||||
rustPendingCheck = null;
|
||||
}
|
||||
})();
|
||||
return rustPendingCheck;
|
||||
}
|
||||
|
||||
/** Force re-detection on the next call (for tests). */
|
||||
export function resetLibrespotBinaryCache(): void {
|
||||
rustCachedAvailable = false;
|
||||
rustPendingCheck = null;
|
||||
}
|
||||
@@ -0,0 +1,396 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import type { AxiosInstance } from "axios";
|
||||
import { SpotifyConnectApi } from "./connect-api.js";
|
||||
|
||||
/** Minimal axios stub: only get/put are exercised by the Connect client. */
|
||||
function makeHttp(overrides?: Partial<Record<"get" | "put", any>>) {
|
||||
return {
|
||||
get: vi.fn().mockResolvedValue({ status: 200, data: {} }),
|
||||
put: vi.fn().mockResolvedValue({ status: 200, data: {} }),
|
||||
...overrides,
|
||||
} as unknown as AxiosInstance;
|
||||
}
|
||||
|
||||
const AUTH = { headers: { Authorization: "Bearer tok123" } };
|
||||
const token = () =>
|
||||
vi.fn<() => Promise<string | null>>().mockResolvedValue("tok123");
|
||||
|
||||
describe("SpotifyConnectApi.getDevices", () => {
|
||||
it("GETs /v1/me/player/devices with the bearer header and maps the list", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({
|
||||
status: 200,
|
||||
data: {
|
||||
devices: [
|
||||
{ id: "dev-1", name: "TS Bot", is_active: true, type: "Speaker" },
|
||||
{ id: "dev-2", name: "Phone", is_active: false },
|
||||
],
|
||||
},
|
||||
}),
|
||||
});
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
const devices = await api.getDevices();
|
||||
expect(http.get).toHaveBeenCalledWith("/v1/me/player/devices", AUTH);
|
||||
expect(devices).toEqual([
|
||||
{ id: "dev-1", name: "TS Bot", is_active: true },
|
||||
{ id: "dev-2", name: "Phone", is_active: false },
|
||||
]);
|
||||
});
|
||||
|
||||
it("returns [] when getToken() is null (unauthorized) without calling http", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(vi.fn().mockResolvedValue(null), { http });
|
||||
await expect(api.getDevices()).resolves.toEqual([]);
|
||||
expect(http.get).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("returns [] on a 401/network rejection (graceful)", async () => {
|
||||
const err: any = new Error("unauthorized");
|
||||
err.response = { status: 401 };
|
||||
const http = makeHttp({ get: vi.fn().mockRejectedValue(err) });
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.getDevices()).resolves.toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyConnectApi.findDeviceByName", () => {
|
||||
it("returns the matching device id", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({
|
||||
status: 200,
|
||||
data: { devices: [{ id: "dev-1", name: "TS Bot", is_active: false }] },
|
||||
}),
|
||||
});
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.findDeviceByName("TS Bot")).resolves.toBe("dev-1");
|
||||
});
|
||||
|
||||
it("returns null when no device name matches", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({
|
||||
status: 200,
|
||||
data: { devices: [{ id: "dev-1", name: "Other", is_active: false }] },
|
||||
}),
|
||||
});
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.findDeviceByName("TS Bot")).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyConnectApi mutating calls", () => {
|
||||
it("transfer() PUTs /v1/me/player with device_ids + play=false default", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.transfer("dev-1");
|
||||
expect(http.put).toHaveBeenCalledWith(
|
||||
"/v1/me/player",
|
||||
{ device_ids: ["dev-1"], play: false },
|
||||
AUTH,
|
||||
);
|
||||
});
|
||||
|
||||
it("transfer(id, true) forwards play=true", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.transfer("dev-1", true);
|
||||
expect(http.put).toHaveBeenCalledWith(
|
||||
"/v1/me/player",
|
||||
{ device_ids: ["dev-1"], play: true },
|
||||
AUTH,
|
||||
);
|
||||
});
|
||||
|
||||
it("play() PUTs /v1/me/player/play?device_id= with the uris body", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.play("dev-1", "spotify:track:abc");
|
||||
expect(http.put).toHaveBeenCalledWith(
|
||||
"/v1/me/player/play",
|
||||
{ uris: ["spotify:track:abc"] },
|
||||
{ headers: { Authorization: "Bearer tok123" }, params: { device_id: "dev-1" } },
|
||||
);
|
||||
});
|
||||
|
||||
it("pause() PUTs /v1/me/player/pause (no params) with no body", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.pause();
|
||||
expect(http.put).toHaveBeenCalledWith("/v1/me/player/pause", undefined, {
|
||||
headers: { Authorization: "Bearer tok123" },
|
||||
params: undefined,
|
||||
});
|
||||
});
|
||||
|
||||
it("pause(id) forwards device_id param", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.pause("dev-1");
|
||||
expect(http.put).toHaveBeenCalledWith("/v1/me/player/pause", undefined, {
|
||||
headers: { Authorization: "Bearer tok123" },
|
||||
params: { device_id: "dev-1" },
|
||||
});
|
||||
});
|
||||
|
||||
it("resume() PUTs /v1/me/player/play with no uris body (resume)", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.resume();
|
||||
expect(http.put).toHaveBeenCalledWith("/v1/me/player/play", undefined, {
|
||||
headers: { Authorization: "Bearer tok123" },
|
||||
params: undefined,
|
||||
});
|
||||
});
|
||||
|
||||
it("resume(id) forwards device_id param", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.resume("dev-1");
|
||||
expect(http.put).toHaveBeenCalledWith("/v1/me/player/play", undefined, {
|
||||
headers: { Authorization: "Bearer tok123" },
|
||||
params: { device_id: "dev-1" },
|
||||
});
|
||||
});
|
||||
|
||||
it("seek() PUTs /v1/me/player/seek?position_ms=", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.seek(42000);
|
||||
expect(http.put).toHaveBeenCalledWith("/v1/me/player/seek", undefined, {
|
||||
headers: { Authorization: "Bearer tok123" },
|
||||
params: { position_ms: 42000 },
|
||||
});
|
||||
});
|
||||
|
||||
it("seek(ms, id) adds device_id param", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await api.seek(1000, "dev-1");
|
||||
expect(http.put).toHaveBeenCalledWith("/v1/me/player/seek", undefined, {
|
||||
headers: { Authorization: "Bearer tok123" },
|
||||
params: { position_ms: 1000, device_id: "dev-1" },
|
||||
});
|
||||
});
|
||||
|
||||
it("mutating calls no-op (no http.put) when unauthorized", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(vi.fn().mockResolvedValue(null), { http });
|
||||
await api.transfer("dev-1");
|
||||
await api.play("dev-1", "spotify:track:x");
|
||||
await api.pause();
|
||||
expect(http.put).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* REQUIRED CORRECTION C3.6: mutating calls must NOT reject up the queue-advance
|
||||
* path. A transient 403 (non-Premium) / 404 (no active device) / 429
|
||||
* (rate-limited) from Spotify must be swallowed (resolve to void), never thrown,
|
||||
* so a failed play() degrades to "couldn't play" instead of an unhandled
|
||||
* rejection that crashes the backend.
|
||||
*/
|
||||
describe("SpotifyConnectApi C3.6 — mutating calls are resilient (no throw)", () => {
|
||||
// S4.6: transient statuses (404/429) now retry with backoff; inject a no-op
|
||||
// sleep so these swallow-guarantee tests stay instant (no real timers). The
|
||||
// no-throw/swallow contract asserted here is unchanged.
|
||||
const noSleep = async () => {};
|
||||
|
||||
function rejectingHttp(status: number) {
|
||||
const err: any = new Error(`http ${status}`);
|
||||
err.response = { status };
|
||||
return makeHttp({ put: vi.fn().mockRejectedValue(err) });
|
||||
}
|
||||
|
||||
it("play() does NOT throw on a 404 (no active device)", async () => {
|
||||
const api = new SpotifyConnectApi(token(), {
|
||||
http: rejectingHttp(404),
|
||||
sleep: noSleep,
|
||||
});
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("play() does NOT throw on a 429 (rate-limited)", async () => {
|
||||
const api = new SpotifyConnectApi(token(), {
|
||||
http: rejectingHttp(429),
|
||||
sleep: noSleep,
|
||||
});
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("transfer() does NOT throw on a 403 (non-Premium)", async () => {
|
||||
const api = new SpotifyConnectApi(token(), { http: rejectingHttp(403) });
|
||||
await expect(api.transfer("dev-1", true)).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("pause/resume/seek do NOT throw on a rejection", async () => {
|
||||
const api = new SpotifyConnectApi(token(), {
|
||||
http: rejectingHttp(404),
|
||||
sleep: noSleep,
|
||||
});
|
||||
await expect(api.pause("dev-1")).resolves.toBeUndefined();
|
||||
await expect(api.resume("dev-1")).resolves.toBeUndefined();
|
||||
await expect(api.seek(1000, "dev-1")).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("play() does NOT throw on a raw network error (no response)", async () => {
|
||||
const http = makeHttp({ put: vi.fn().mockRejectedValue(new Error("ECONNRESET")) });
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Task S4.6: bounded retry/backoff on the mutating Connect commands
|
||||
* (spec §4.3/§13 recovery/watchdog). Transient statuses {404,429,500,502,503}
|
||||
* retry up to MAX_ATTEMPTS (3) with exponential backoff; non-transient statuses
|
||||
* are NOT retried. Every path still preserves C3.6 (swallow, never throw). A
|
||||
* no-op injected `sleep` keeps the tests instant (no real timers).
|
||||
*/
|
||||
describe("SpotifyConnectApi S4.6 — retry/backoff on mutating commands", () => {
|
||||
const MAX_ATTEMPTS = 3;
|
||||
const noSleep = async () => {};
|
||||
|
||||
function rejectStatus(status: number, headers?: Record<string, string>) {
|
||||
const err: any = new Error(`http ${status}`);
|
||||
err.response = { status, headers };
|
||||
return err;
|
||||
}
|
||||
|
||||
it("play() retries a transient 404 then succeeds (2 calls, no throw)", async () => {
|
||||
const put = vi
|
||||
.fn()
|
||||
.mockRejectedValueOnce(rejectStatus(404))
|
||||
.mockResolvedValueOnce({ status: 200, data: {} });
|
||||
const http = makeHttp({ put });
|
||||
const api = new SpotifyConnectApi(token(), { http, sleep: noSleep });
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
expect(put).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it("play() exhausts on a persistent 500 (MAX_ATTEMPTS calls, swallowed, warns once)", async () => {
|
||||
const put = vi.fn().mockRejectedValue(rejectStatus(500));
|
||||
const http = makeHttp({ put });
|
||||
const warn = vi.fn();
|
||||
const logger = { warn } as any;
|
||||
const api = new SpotifyConnectApi(token(), { http, sleep: noSleep, logger });
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
expect(put).toHaveBeenCalledTimes(MAX_ATTEMPTS);
|
||||
expect(warn).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("does NOT retry a non-transient 403 (exactly ONE call, no throw)", async () => {
|
||||
const put = vi.fn().mockRejectedValue(rejectStatus(403));
|
||||
const http = makeHttp({ put });
|
||||
const api = new SpotifyConnectApi(token(), { http, sleep: noSleep });
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
expect(put).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("429 honors a CAPPED Retry-After then succeeds (2 calls, bounded sleep)", async () => {
|
||||
const put = vi
|
||||
.fn()
|
||||
.mockRejectedValueOnce(rejectStatus(429, { "retry-after": "1" }))
|
||||
.mockResolvedValueOnce({ status: 200, data: {} });
|
||||
const http = makeHttp({ put });
|
||||
const sleep = vi.fn<(ms: number) => Promise<void>>(async () => {});
|
||||
const api = new SpotifyConnectApi(token(), { http, sleep });
|
||||
await expect(api.play("dev-1", "spotify:track:abc")).resolves.toBeUndefined();
|
||||
expect(put).toHaveBeenCalledTimes(2);
|
||||
expect(sleep).toHaveBeenCalledTimes(1);
|
||||
const delay = sleep.mock.calls[0][0];
|
||||
expect(delay).toBe(1000);
|
||||
expect(delay).toBeLessThanOrEqual(2000);
|
||||
});
|
||||
|
||||
it("transfer() shares the retry path — 404 then success (2 calls)", async () => {
|
||||
const put = vi
|
||||
.fn()
|
||||
.mockRejectedValueOnce(rejectStatus(404))
|
||||
.mockResolvedValueOnce({ status: 200, data: {} });
|
||||
const http = makeHttp({ put });
|
||||
const api = new SpotifyConnectApi(token(), { http, sleep: noSleep });
|
||||
await expect(api.transfer("dev-1", true)).resolves.toBeUndefined();
|
||||
expect(put).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyConnectApi.getPlaybackState", () => {
|
||||
it("GETs /v1/me/player and maps is_playing/progress/item", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({
|
||||
status: 200,
|
||||
data: {
|
||||
is_playing: true,
|
||||
progress_ms: 12345,
|
||||
item: { uri: "spotify:track:abc", duration_ms: 200000 },
|
||||
},
|
||||
}),
|
||||
});
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
const state = await api.getPlaybackState();
|
||||
expect(http.get).toHaveBeenCalledWith("/v1/me/player", AUTH);
|
||||
expect(state).toEqual({
|
||||
isPlaying: true,
|
||||
progressMs: 12345,
|
||||
trackUri: "spotify:track:abc",
|
||||
durationMs: 200000,
|
||||
});
|
||||
});
|
||||
|
||||
// R4-4 (multi-bot): the account-wide /v1/me/player response names the single
|
||||
// ACTIVE Connect device. Expose it as activeDeviceId so the Rust backend can
|
||||
// tell "our device" from a foreign device another bot stole the session with.
|
||||
it("maps device.id -> activeDeviceId", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({
|
||||
status: 200,
|
||||
data: {
|
||||
is_playing: true,
|
||||
progress_ms: 1000,
|
||||
item: { uri: "spotify:track:abc", duration_ms: 200000 },
|
||||
device: { id: "dev-1", name: "TS Bot", is_active: true },
|
||||
},
|
||||
}),
|
||||
});
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
const state = await api.getPlaybackState();
|
||||
expect(state).toEqual({
|
||||
isPlaying: true,
|
||||
progressMs: 1000,
|
||||
trackUri: "spotify:track:abc",
|
||||
durationMs: 200000,
|
||||
activeDeviceId: "dev-1",
|
||||
});
|
||||
});
|
||||
|
||||
it("returns null on 204 (no active device)", async () => {
|
||||
const http = makeHttp({ get: vi.fn().mockResolvedValue({ status: 204, data: "" }) });
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.getPlaybackState()).resolves.toBeNull();
|
||||
});
|
||||
|
||||
it("returns null when item is missing / trackUri null", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({ status: 200, data: { is_playing: false, progress_ms: 0, item: null } }),
|
||||
});
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.getPlaybackState()).resolves.toEqual({
|
||||
isPlaying: false,
|
||||
progressMs: 0,
|
||||
trackUri: null,
|
||||
durationMs: 0,
|
||||
});
|
||||
});
|
||||
|
||||
it("returns null on rejection (e.g. 401) instead of throwing", async () => {
|
||||
const http = makeHttp({ get: vi.fn().mockRejectedValue(new Error("boom")) });
|
||||
const api = new SpotifyConnectApi(token(), { http });
|
||||
await expect(api.getPlaybackState()).resolves.toBeNull();
|
||||
});
|
||||
|
||||
it("returns null when getToken() is null (unauthorized) without calling http", async () => {
|
||||
const http = makeHttp();
|
||||
const api = new SpotifyConnectApi(vi.fn().mockResolvedValue(null), { http });
|
||||
await expect(api.getPlaybackState()).resolves.toBeNull();
|
||||
expect(http.get).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,205 @@
|
||||
import axios, { type AxiosInstance } from "axios";
|
||||
|
||||
const API_BASE = "https://api.spotify.com";
|
||||
|
||||
/**
|
||||
* Task S4.6 (spec §4.3/§13 recovery/watchdog): transient Connect-command
|
||||
* failures that warrant a bounded retry with exponential backoff. 404 is the
|
||||
* device-visibility latency case (device not yet enumerated), 429 is rate-limit,
|
||||
* 5xx are Spotify-side flakiness. Everything else (401/403/network) is NOT
|
||||
* retried — it is swallowed immediately (C3.6).
|
||||
*/
|
||||
const TRANSIENT = new Set([404, 429, 500, 502, 503]);
|
||||
const MAX_ATTEMPTS = 3;
|
||||
const BASE_DELAY_MS = 150;
|
||||
const MAX_DELAY_MS = 2_000;
|
||||
|
||||
export interface SpotifyDevice {
|
||||
id: string;
|
||||
name: string;
|
||||
is_active: boolean;
|
||||
}
|
||||
|
||||
export interface PlaybackState {
|
||||
isPlaying: boolean;
|
||||
progressMs: number;
|
||||
trackUri: string | null;
|
||||
durationMs: number;
|
||||
/**
|
||||
* R4-4 (multi-bot): the id of the single ACTIVE Connect device the
|
||||
* account-wide GET /v1/me/player is reporting (from `device.id`). Absent when
|
||||
* Spotify omits the device block. The Rust backend uses it to tell "our
|
||||
* device" from a foreign device another bot stole the shared session with, so
|
||||
* it never misattributes that bot's track/stop as ours.
|
||||
*/
|
||||
activeDeviceId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Spotify Web API "Connect" remote-control client. Wraps an axios instance and
|
||||
* attaches a live user Bearer token from getToken() to every request.
|
||||
*
|
||||
* Error policy:
|
||||
* - Read-only calls (getDevices/getPlaybackState) degrade to []/null on error.
|
||||
* - Mutating calls (transfer/play/pause/resume/seek) no-op when unauthorized.
|
||||
* - REQUIRED CORRECTION C3.6: mutating calls ALSO swallow transport errors
|
||||
* (403 non-Premium / 404 no active device / 429 rate-limited / network) and
|
||||
* resolve to void instead of rejecting. The contract keeps the Promise<void>
|
||||
* signatures, so the backend treats a failed play as "couldn't play" and
|
||||
* falls back — a transient Spotify error can never surface as an unhandled
|
||||
* rejection that crashes the queue-advance path.
|
||||
*/
|
||||
export class SpotifyConnectApi {
|
||||
private getToken: () => Promise<string | null>;
|
||||
private http: AxiosInstance;
|
||||
private sleep: (ms: number) => Promise<void>;
|
||||
private logger?: import("pino").Logger;
|
||||
|
||||
constructor(
|
||||
getToken: () => Promise<string | null>,
|
||||
deps?: {
|
||||
http?: AxiosInstance;
|
||||
sleep?: (ms: number) => Promise<void>;
|
||||
logger?: import("pino").Logger;
|
||||
},
|
||||
) {
|
||||
this.getToken = getToken;
|
||||
this.http = deps?.http ?? axios.create({ baseURL: API_BASE, timeout: 15_000 });
|
||||
this.sleep = deps?.sleep ?? ((ms) => new Promise((r) => setTimeout(r, ms)));
|
||||
this.logger = deps?.logger;
|
||||
}
|
||||
|
||||
/** Bearer auth headers, or null when no valid user token is available. */
|
||||
private async authHeaders(): Promise<{ Authorization: string } | null> {
|
||||
const token = await this.getToken();
|
||||
if (!token) return null;
|
||||
return { Authorization: `Bearer ${token}` };
|
||||
}
|
||||
|
||||
/**
|
||||
* S4.6 recovery/watchdog: run a mutating PUT with bounded retry + exponential
|
||||
* backoff on TRANSIENT statuses only. On exhaustion OR a non-transient error
|
||||
* it SWALLOWS and warns once — preserving C3.6 (a mutating command NEVER
|
||||
* rejects up the queue-advance path). Tokens are never logged.
|
||||
*/
|
||||
private async mutateWithRetry(put: () => Promise<unknown>): Promise<void> {
|
||||
for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
|
||||
try {
|
||||
await put();
|
||||
return;
|
||||
} catch (err: any) {
|
||||
const status = err?.response?.status;
|
||||
if (!TRANSIENT.has(status) || attempt === MAX_ATTEMPTS) {
|
||||
// C3.6: never reject up the queue path — swallow, but surface once.
|
||||
this.logger?.warn(
|
||||
{ status },
|
||||
"Spotify Connect command failed (exhausted/non-retryable)",
|
||||
);
|
||||
return;
|
||||
}
|
||||
let delay = Math.min(BASE_DELAY_MS * 2 ** (attempt - 1), MAX_DELAY_MS);
|
||||
if (status === 429) {
|
||||
const ra = Number(err?.response?.headers?.["retry-after"]);
|
||||
if (Number.isFinite(ra) && ra > 0) delay = Math.min(ra * 1000, MAX_DELAY_MS);
|
||||
}
|
||||
await this.sleep(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async getDevices(): Promise<SpotifyDevice[]> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return [];
|
||||
try {
|
||||
const { data } = await this.http.get("/v1/me/player/devices", { headers });
|
||||
const list = Array.isArray(data?.devices) ? data.devices : [];
|
||||
return list.map((d: any) => ({
|
||||
id: d?.id ?? "",
|
||||
name: d?.name ?? "",
|
||||
is_active: Boolean(d?.is_active),
|
||||
}));
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
async findDeviceByName(name: string): Promise<string | null> {
|
||||
const devices = await this.getDevices();
|
||||
const match = devices.find((d) => d.name === name);
|
||||
return match ? match.id : null;
|
||||
}
|
||||
|
||||
async transfer(deviceId: string, play = false): Promise<void> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return;
|
||||
await this.mutateWithRetry(() =>
|
||||
this.http.put("/v1/me/player", { device_ids: [deviceId], play }, { headers }),
|
||||
);
|
||||
}
|
||||
|
||||
async play(deviceId: string, trackUri: string): Promise<void> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return;
|
||||
await this.mutateWithRetry(() =>
|
||||
this.http.put(
|
||||
"/v1/me/player/play",
|
||||
{ uris: [trackUri] },
|
||||
{ headers, params: { device_id: deviceId } },
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
async pause(deviceId?: string): Promise<void> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return;
|
||||
await this.mutateWithRetry(() =>
|
||||
this.http.put("/v1/me/player/pause", undefined, {
|
||||
headers,
|
||||
params: deviceId ? { device_id: deviceId } : undefined,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
async resume(deviceId?: string): Promise<void> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return;
|
||||
await this.mutateWithRetry(() =>
|
||||
this.http.put("/v1/me/player/play", undefined, {
|
||||
headers,
|
||||
params: deviceId ? { device_id: deviceId } : undefined,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
async seek(ms: number, deviceId?: string): Promise<void> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return;
|
||||
const params: Record<string, unknown> = { position_ms: ms };
|
||||
if (deviceId) params.device_id = deviceId;
|
||||
await this.mutateWithRetry(() =>
|
||||
this.http.put("/v1/me/player/seek", undefined, { headers, params }),
|
||||
);
|
||||
}
|
||||
|
||||
async getPlaybackState(): Promise<PlaybackState | null> {
|
||||
const headers = await this.authHeaders();
|
||||
if (!headers) return null;
|
||||
try {
|
||||
const res = await this.http.get("/v1/me/player", { headers });
|
||||
// 204 = no active device / playback; body is empty.
|
||||
if (res.status === 204 || !res.data) return null;
|
||||
const d = res.data;
|
||||
return {
|
||||
isPlaying: Boolean(d.is_playing),
|
||||
progressMs: Number(d.progress_ms ?? 0),
|
||||
trackUri: d.item?.uri ?? null,
|
||||
durationMs: Number(d.item?.duration_ms ?? 0),
|
||||
// R4-4: expose the account's single active device so a foreign steal is
|
||||
// distinguishable from our own device. Left undefined when absent.
|
||||
activeDeviceId: d.device?.id ?? undefined,
|
||||
};
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,709 @@
|
||||
import { describe, it, expect, beforeAll, afterAll, beforeEach, vi } from "vitest";
|
||||
import { EventEmitter } from "node:events";
|
||||
import { Readable } from "node:stream";
|
||||
import { writeFileSync, rmSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
import { tmpdir } from "node:os";
|
||||
import type { Logger } from "pino";
|
||||
import type { SpotifyConfig } from "../../data/config.js";
|
||||
import type {
|
||||
SpotifyAudioBackend,
|
||||
SpotifyTrackEndedEvent,
|
||||
SpotifyNowPlaying,
|
||||
} from "./backend.js";
|
||||
import type { SpotifyOAuth } from "./spotify-oauth.js";
|
||||
|
||||
// Controllable, hoisted so the vi.mock factory can close over it.
|
||||
// go-* keys keep their Stage-2 names (`supported`/`path`) so existing tests are
|
||||
// untouched; rust* keys drive the new librespot selection paths.
|
||||
const bin = vi.hoisted(() => ({
|
||||
supported: true,
|
||||
path: "",
|
||||
rustSupported: true,
|
||||
rustPath: "",
|
||||
}));
|
||||
vi.mock("./binary.js", async () => {
|
||||
// existsSync mirrors the real resolveExecutable(find*()) result for the
|
||||
// bin/-style temp paths this suite uses (existingBin exists, missingBin does
|
||||
// not), keeping the chooseBackend/isAvailable matrix behavior-identical.
|
||||
const { existsSync } = await import("node:fs");
|
||||
return {
|
||||
isGoLibrespotSupported: () => bin.supported,
|
||||
findGoLibrespot: () => bin.path,
|
||||
resetGoLibrespotBinaryCache: () => {},
|
||||
checkGoLibrespotAvailable: async () => bin.supported && !!bin.path,
|
||||
isRustLibrespotSupported: () => bin.rustSupported,
|
||||
findLibrespot: () => bin.rustPath,
|
||||
resetLibrespotBinaryCache: () => {},
|
||||
checkLibrespotAvailable: async () => bin.rustSupported && !!bin.rustPath,
|
||||
// PATH-aware presence gates (Bug I3): supported gate AND the resolved
|
||||
// binary actually exists on disk.
|
||||
isGoLibrespotPresent: () => bin.supported && existsSync(bin.path),
|
||||
isLibrespotPresent: () => bin.rustSupported && existsSync(bin.rustPath),
|
||||
};
|
||||
});
|
||||
|
||||
// Capture options the DEFAULT factory hands to the real GoLibrespotBackend so
|
||||
// we can assert per-bot ports (Fix 3) are threaded through. Every other test
|
||||
// injects its own backendFactory, so this mock is inert for them.
|
||||
const goLibrespotCtor = vi.hoisted(() => vi.fn());
|
||||
vi.mock("./go-librespot.js", async () => {
|
||||
const { EventEmitter } = await import("node:events");
|
||||
return {
|
||||
GoLibrespotBackend: class extends EventEmitter {
|
||||
constructor(opts: any) {
|
||||
super();
|
||||
goLibrespotCtor(opts);
|
||||
}
|
||||
async start(): Promise<void> {}
|
||||
isReady(): boolean {
|
||||
return true;
|
||||
}
|
||||
stop(): void {}
|
||||
async playTrack(): Promise<void> {}
|
||||
async pause(): Promise<void> {}
|
||||
async resume(): Promise<void> {}
|
||||
async seek(): Promise<void> {}
|
||||
getPcmStream(): any {
|
||||
return null;
|
||||
}
|
||||
getPositionMs(): number {
|
||||
return 0;
|
||||
}
|
||||
},
|
||||
};
|
||||
});
|
||||
|
||||
// Import AFTER vi.mock so the mocked binary module is used.
|
||||
const { SpotifyController, perBotDeviceName } = await import("./controller.js");
|
||||
|
||||
const existingBin = join(tmpdir(), `tsmb-golibrespot-${process.pid}`);
|
||||
const missingBin = join(tmpdir(), `tsmb-golibrespot-missing-${process.pid}`);
|
||||
|
||||
beforeAll(() => {
|
||||
writeFileSync(existingBin, "#!/bin/sh\n");
|
||||
});
|
||||
afterAll(() => {
|
||||
try {
|
||||
rmSync(existingBin);
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
});
|
||||
beforeEach(() => {
|
||||
bin.supported = true;
|
||||
bin.path = existingBin;
|
||||
bin.rustSupported = true;
|
||||
bin.rustPath = missingBin;
|
||||
});
|
||||
|
||||
class FakeBackend extends EventEmitter implements SpotifyAudioBackend {
|
||||
startCalls = 0;
|
||||
stopCalls = 0;
|
||||
playCalls: string[] = [];
|
||||
pauseCalls = 0;
|
||||
resumeCalls = 0;
|
||||
seekCalls: number[] = [];
|
||||
ready = false;
|
||||
startShouldReject = false;
|
||||
playShouldReject = false;
|
||||
/** When set, start() awaits this before resolving — lets a test interleave
|
||||
* stop()/error DURING a mid-flight start (Bug I1). */
|
||||
startGate?: Promise<void>;
|
||||
readonly pcm = Readable.from([Buffer.alloc(0)]);
|
||||
|
||||
async start(): Promise<void> {
|
||||
this.startCalls++;
|
||||
if (this.startGate) await this.startGate;
|
||||
if (this.startShouldReject) throw new Error("start boom");
|
||||
this.ready = true;
|
||||
}
|
||||
stop(): void {
|
||||
this.stopCalls++;
|
||||
this.ready = false;
|
||||
}
|
||||
isReady(): boolean {
|
||||
return this.ready;
|
||||
}
|
||||
async playTrack(uri: string): Promise<void> {
|
||||
this.playCalls.push(uri);
|
||||
if (this.playShouldReject) throw new Error("play boom");
|
||||
}
|
||||
async pause(): Promise<void> {
|
||||
this.pauseCalls++;
|
||||
}
|
||||
async resume(): Promise<void> {
|
||||
this.resumeCalls++;
|
||||
}
|
||||
async seek(ms: number): Promise<void> {
|
||||
this.seekCalls.push(ms);
|
||||
}
|
||||
getPcmStream(): Readable {
|
||||
return this.pcm;
|
||||
}
|
||||
getPositionMs(): number {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
const silentLogger = {
|
||||
info() {},
|
||||
error() {},
|
||||
warn() {},
|
||||
debug() {},
|
||||
trace() {},
|
||||
fatal() {},
|
||||
child() {
|
||||
return silentLogger;
|
||||
},
|
||||
} as unknown as Logger;
|
||||
|
||||
function cfg(over: Partial<SpotifyConfig> = {}): SpotifyConfig {
|
||||
return {
|
||||
enabled: true,
|
||||
backend: "auto",
|
||||
clientId: "",
|
||||
clientSecret: "",
|
||||
deviceName: "TSMusicBot",
|
||||
bitrate: 320,
|
||||
...over,
|
||||
};
|
||||
}
|
||||
|
||||
function makeCtrl(over: {
|
||||
config?: Partial<SpotifyConfig>;
|
||||
backendFactory?: () => SpotifyAudioBackend;
|
||||
oauth?: import("./spotify-oauth.js").SpotifyOAuth;
|
||||
} = {}) {
|
||||
const be = new FakeBackend();
|
||||
const ctrl = new SpotifyController({
|
||||
config: cfg(over.config),
|
||||
workDir: "/tmp/work",
|
||||
configDir: "/tmp/cfg",
|
||||
logger: silentLogger,
|
||||
backendFactory: over.backendFactory ?? (() => be),
|
||||
oauth: over.oauth,
|
||||
});
|
||||
return { ctrl, be };
|
||||
}
|
||||
|
||||
function fakeOAuth(
|
||||
authorized: boolean,
|
||||
hooks: { onIsAuthorized?: () => void } = {},
|
||||
): SpotifyOAuth {
|
||||
return {
|
||||
isAuthorized: () => {
|
||||
hooks.onIsAuthorized?.();
|
||||
return authorized;
|
||||
},
|
||||
getAccessToken: async () => (authorized ? "tok" : null),
|
||||
getClientId: () => "cid",
|
||||
getRedirectUri: () => "http://127.0.0.1:5588/login",
|
||||
buildAuthorizeUrl: () => ({ url: "https://accounts.spotify.com/authorize", state: "s" }),
|
||||
handleCallback: async () => true,
|
||||
} as unknown as SpotifyOAuth;
|
||||
}
|
||||
|
||||
describe("SpotifyController.isAvailable", () => {
|
||||
it("true when enabled + supported + binary present", () => {
|
||||
const { ctrl } = makeCtrl();
|
||||
expect(ctrl.isAvailable()).toBe(true);
|
||||
});
|
||||
it("false when config disabled", () => {
|
||||
const { ctrl } = makeCtrl({ config: { enabled: false } });
|
||||
expect(ctrl.isAvailable()).toBe(false);
|
||||
});
|
||||
it("false when platform unsupported", () => {
|
||||
bin.supported = false;
|
||||
const { ctrl } = makeCtrl();
|
||||
expect(ctrl.isAvailable()).toBe(false);
|
||||
});
|
||||
it("false when binary file is absent", () => {
|
||||
bin.path = missingBin;
|
||||
const { ctrl } = makeCtrl();
|
||||
expect(ctrl.isAvailable()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController.ensureStarted", () => {
|
||||
it("starts the backend exactly once across repeated calls", async () => {
|
||||
let built = 0;
|
||||
const be = new FakeBackend();
|
||||
const { ctrl } = makeCtrl({
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return be;
|
||||
},
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(1);
|
||||
expect(be.startCalls).toBe(1);
|
||||
});
|
||||
|
||||
it("is idempotent under concurrent calls (single start)", async () => {
|
||||
let built = 0;
|
||||
const be = new FakeBackend();
|
||||
const { ctrl } = makeCtrl({
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return be;
|
||||
},
|
||||
});
|
||||
const [a, b] = await Promise.all([ctrl.ensureStarted(), ctrl.ensureStarted()]);
|
||||
expect(a).toBe(true);
|
||||
expect(b).toBe(true);
|
||||
expect(built).toBe(1);
|
||||
expect(be.startCalls).toBe(1);
|
||||
});
|
||||
|
||||
it("returns false and does not build a backend when unavailable", async () => {
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
config: { enabled: false },
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return new FakeBackend();
|
||||
},
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(false);
|
||||
expect(built).toBe(0);
|
||||
});
|
||||
|
||||
it("returns false when backend.start() throws, and allows a later retry", async () => {
|
||||
const be = new FakeBackend();
|
||||
be.startShouldReject = true;
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return be;
|
||||
},
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(false);
|
||||
// start failure clears the cached promise so a subsequent call retries.
|
||||
be.startShouldReject = false;
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(2);
|
||||
expect(be.startCalls).toBe(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController.playTrack", () => {
|
||||
it("ensures started then delegates the uri, returning true", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
expect(await ctrl.playTrack("spotify:track:abc")).toBe(true);
|
||||
expect(be.startCalls).toBe(1);
|
||||
expect(be.playCalls).toEqual(["spotify:track:abc"]);
|
||||
});
|
||||
it("returns false when the controller is unavailable", async () => {
|
||||
const { ctrl, be } = makeCtrl({ config: { enabled: false } });
|
||||
expect(await ctrl.playTrack("spotify:track:abc")).toBe(false);
|
||||
expect(be.playCalls).toEqual([]);
|
||||
});
|
||||
it("returns false when backend.playTrack rejects", async () => {
|
||||
const be = new FakeBackend();
|
||||
be.playShouldReject = true;
|
||||
const { ctrl } = makeCtrl({ backendFactory: () => be });
|
||||
expect(await ctrl.playTrack("spotify:track:abc")).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController transport delegation", () => {
|
||||
it("pause/resume/seek forward to the backend after start", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
await ctrl.pause();
|
||||
await ctrl.resume();
|
||||
await ctrl.seek(4200);
|
||||
expect(be.pauseCalls).toBe(1);
|
||||
expect(be.resumeCalls).toBe(1);
|
||||
expect(be.seekCalls).toEqual([4200]);
|
||||
});
|
||||
it("pause/resume/seek are safe no-ops before start", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await expect(ctrl.pause()).resolves.toBeUndefined();
|
||||
await expect(ctrl.resume()).resolves.toBeUndefined();
|
||||
await expect(ctrl.seek(10)).resolves.toBeUndefined();
|
||||
expect(be.pauseCalls).toBe(0);
|
||||
});
|
||||
it("getPcmStream returns the backend stream", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
expect(ctrl.getPcmStream()).toBe(be.pcm);
|
||||
});
|
||||
it("getPcmStream throws before the backend is started", () => {
|
||||
const { ctrl } = makeCtrl();
|
||||
expect(() => ctrl.getPcmStream()).toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
// R4-1: the web progress bar computes seekTime = ratio * duration (fractional
|
||||
// seconds); BotInstance routes Spotify seeks through seek(seconds * 1000),
|
||||
// yielding a NON-integer ms (e.g. 71610.00000000001). go-librespot decodes
|
||||
// `position` into an int64 and Go's encoding/json REJECTS a JSON number with a
|
||||
// decimal point -> HTTP 400 -> the error is swallowed -> the track never seeks.
|
||||
// The controller must round ONCE so BOTH backends get a valid integer ms.
|
||||
describe("SpotifyController.seek integer rounding (R4-1)", () => {
|
||||
it("rounds a fractional seek to an integer ms before forwarding to the backend", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
await ctrl.seek(71610.00000000001);
|
||||
expect(be.seekCalls).toHaveLength(1);
|
||||
expect(Number.isInteger(be.seekCalls[0])).toBe(true);
|
||||
expect(be.seekCalls[0]).toBe(71610);
|
||||
});
|
||||
|
||||
it("clamps a negative seek to 0", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
await ctrl.seek(-5);
|
||||
expect(be.seekCalls).toEqual([0]);
|
||||
});
|
||||
|
||||
it("passes an already-integer seek through unchanged", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
await ctrl.seek(4200);
|
||||
expect(be.seekCalls).toEqual([4200]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController event re-emission", () => {
|
||||
it("re-emits backend trackEnded with the same payload", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
const got: SpotifyTrackEndedEvent[] = [];
|
||||
ctrl.on("trackEnded", (e) => got.push(e));
|
||||
const evt: SpotifyTrackEndedEvent = { uri: "spotify:track:x", reason: "ended" };
|
||||
be.emit("trackEnded", evt);
|
||||
expect(got).toEqual([evt]);
|
||||
});
|
||||
it("re-emits backend metadata with the same payload", async () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
await ctrl.ensureStarted();
|
||||
const got: SpotifyNowPlaying[] = [];
|
||||
ctrl.on("metadata", (m) => got.push(m));
|
||||
const meta: SpotifyNowPlaying = {
|
||||
uri: "spotify:track:x",
|
||||
name: "Song",
|
||||
artist: "Artist",
|
||||
album: "Album",
|
||||
coverUrl: "http://img",
|
||||
durationMs: 1000,
|
||||
};
|
||||
be.emit("metadata", meta);
|
||||
expect(got).toEqual([meta]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController backend error handling (C3)", () => {
|
||||
it("does NOT throw on a backend 'error' with no controller listener, and marks not-ready", async () => {
|
||||
const be1 = new FakeBackend();
|
||||
const be2 = new FakeBackend();
|
||||
const backends = [be1, be2];
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return backends.shift()!;
|
||||
},
|
||||
});
|
||||
await ctrl.ensureStarted();
|
||||
expect(built).toBe(1);
|
||||
// The controller itself has NO "error" listener. A raw re-emit would make
|
||||
// Node throw here; the controller must swallow+log instead.
|
||||
expect(() => be1.emit("error", new Error("sidecar boom"))).not.toThrow();
|
||||
// Marked not-ready: a fresh ensureStarted relaunches a new backend.
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(2);
|
||||
expect(be2.startCalls).toBe(1);
|
||||
});
|
||||
|
||||
it("tears down the errored backend (stop + detach + null) so it is not orphaned", async () => {
|
||||
const be1 = new FakeBackend();
|
||||
const be2 = new FakeBackend();
|
||||
const backends = [be1, be2];
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return backends.shift()!;
|
||||
},
|
||||
});
|
||||
await ctrl.ensureStarted();
|
||||
expect(built).toBe(1);
|
||||
|
||||
// On "error" the controller must stop() the errored backend (cleans its
|
||||
// ffmpeg/go-librespot children + FIFO) and detach ALL its listeners.
|
||||
expect(() => be1.emit("error", new Error("sidecar boom"))).not.toThrow();
|
||||
expect(be1.stopCalls).toBe(1);
|
||||
expect(be1.listenerCount("error")).toBe(0);
|
||||
expect(be1.listenerCount("trackEnded")).toBe(0);
|
||||
expect(be1.listenerCount("metadata")).toBe(0);
|
||||
|
||||
// Internal backend is null: a transport call no-ops (delegates to nothing)
|
||||
// and getPcmStream throws until a rebuild.
|
||||
await ctrl.pause();
|
||||
expect(be1.pauseCalls).toBe(0);
|
||||
expect(() => ctrl.getPcmStream()).toThrow();
|
||||
|
||||
// A fresh ensureStarted builds a NEW backend instance.
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(2);
|
||||
expect(be2.startCalls).toBe(1);
|
||||
expect(ctrl.getPcmStream()).toBe(be2.pcm);
|
||||
});
|
||||
|
||||
it("does not cross-talk: a later error from the ORPHANED backend leaves the healthy rebuilt controller ready", async () => {
|
||||
const be1 = new FakeBackend();
|
||||
const be2 = new FakeBackend();
|
||||
const backends = [be1, be2];
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return backends.shift()!;
|
||||
},
|
||||
});
|
||||
await ctrl.ensureStarted();
|
||||
|
||||
// First error tears down be1 and the controller rebuilds onto healthy be2.
|
||||
be1.emit("error", new Error("sidecar boom"));
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(2);
|
||||
await ctrl.pause();
|
||||
expect(be2.pauseCalls).toBe(1);
|
||||
|
||||
// A SECOND error emitted by the OLD (orphaned) backend must NOT reach the
|
||||
// controller: the healthy be2 stays owned, ready, and untouched.
|
||||
be1.on("error", () => {}); // controller detached; re-arm to avoid unhandled throw
|
||||
expect(() => be1.emit("error", new Error("orphan boom"))).not.toThrow();
|
||||
expect(be2.stopCalls).toBe(0); // healthy backend not torn down
|
||||
// Still ready: ensureStarted returns true without rebuilding a third time.
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(2);
|
||||
await ctrl.pause();
|
||||
expect(be2.pauseCalls).toBe(2);
|
||||
expect(ctrl.getPcmStream()).toBe(be2.pcm);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController.stop", () => {
|
||||
it("stops the backend and tears down state so a later start rebuilds", async () => {
|
||||
const be1 = new FakeBackend();
|
||||
const be2 = new FakeBackend();
|
||||
const backends = [be1, be2];
|
||||
const { ctrl } = makeCtrl({ backendFactory: () => backends.shift()! });
|
||||
await ctrl.ensureStarted();
|
||||
ctrl.stop();
|
||||
expect(be1.stopCalls).toBe(1);
|
||||
// After teardown getPcmStream is invalid again until re-started.
|
||||
expect(() => ctrl.getPcmStream()).toThrow();
|
||||
// A fresh ensureStarted builds a new backend.
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(be2.startCalls).toBe(1);
|
||||
});
|
||||
it("stop before start is a safe no-op", () => {
|
||||
const { ctrl, be } = makeCtrl();
|
||||
expect(() => ctrl.stop()).not.toThrow();
|
||||
expect(be.stopCalls).toBe(0);
|
||||
});
|
||||
|
||||
it("Bug I1: stop() DURING a mid-flight start tears the sidecar down instead of resurrecting it", async () => {
|
||||
// A Deferred the test resolves to complete backend.start() on demand.
|
||||
let resolveStart!: () => void;
|
||||
const startGate = new Promise<void>((res) => {
|
||||
resolveStart = res;
|
||||
});
|
||||
const be = new FakeBackend();
|
||||
be.startGate = startGate;
|
||||
const { ctrl } = makeCtrl({ backendFactory: () => be });
|
||||
|
||||
// Kick off ensureStarted but DO NOT await — start() is parked on the gate.
|
||||
const startedP = ctrl.ensureStarted();
|
||||
// Let the ensureStarted IIFE run up to `await backend.start()`.
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
expect(be.startCalls).toBe(1); // start() was entered and is now pending
|
||||
|
||||
// Caller tears the controller down while start() is still in flight
|
||||
// (a user `!stop`/disconnect). Pre-fix this.backend is still null so this
|
||||
// is a no-op and the spawned sidecar is orphaned.
|
||||
ctrl.stop();
|
||||
|
||||
// Now let start() finally resolve. Pre-fix the IIFE would set this.backend
|
||||
// and started=true, RESURRECTING the sidecar the caller already stopped.
|
||||
resolveStart();
|
||||
const result = await startedP;
|
||||
|
||||
// Post-fix: the mid-flight backend is torn down, not promoted.
|
||||
expect(result).toBe(false);
|
||||
expect(be.stopCalls).toBeGreaterThanOrEqual(1); // the fake WAS stopped
|
||||
expect(be.listenerCount("trackEnded")).toBe(0); // listeners detached
|
||||
expect(() => ctrl.getPcmStream()).toThrow(); // not resurrected
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController per-bot ports (Fix 3)", () => {
|
||||
it("threads apiPort + callbackPort into the default GoLibrespotBackend", async () => {
|
||||
goLibrespotCtor.mockClear();
|
||||
// No injected backendFactory → the controller builds the (mocked) real backend.
|
||||
const ctrl = new SpotifyController({
|
||||
config: cfg(),
|
||||
workDir: "/tmp/work",
|
||||
configDir: "/tmp/cfg",
|
||||
logger: silentLogger,
|
||||
apiPort: 3712,
|
||||
callbackPort: 8712,
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(goLibrespotCtor).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ apiPort: 3712, callbackPort: 8712 }),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("perBotDeviceName (corner-case R2-5)", () => {
|
||||
it("suffixes the base name with the instanceId", () => {
|
||||
expect(perBotDeviceName("TSMusicBot", "bot1")).toBe("TSMusicBot-bot1");
|
||||
});
|
||||
it("returns the base name unchanged when no instanceId is given", () => {
|
||||
expect(perBotDeviceName("TSMusicBot", undefined)).toBe("TSMusicBot");
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController per-bot device name (corner-case R2-5)", () => {
|
||||
it("applies the per-bot suffix to the backend deviceName when instanceId is set", async () => {
|
||||
goLibrespotCtor.mockClear();
|
||||
// No injected backendFactory → the controller builds the (mocked) real backend.
|
||||
const ctrl = new SpotifyController({
|
||||
config: cfg(),
|
||||
workDir: "/tmp/work",
|
||||
configDir: "/tmp/cfg",
|
||||
logger: silentLogger,
|
||||
instanceId: "bot1",
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
// The Connect identity is UNIQUE per bot ("<base>-<id>") so two bots under
|
||||
// one account never register the same name (misroute / false-readiness).
|
||||
expect(goLibrespotCtor).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ deviceName: "TSMusicBot-bot1" }),
|
||||
);
|
||||
});
|
||||
|
||||
it("leaves the base deviceName unchanged when no instanceId (behavior-preserving)", async () => {
|
||||
goLibrespotCtor.mockClear();
|
||||
const ctrl = new SpotifyController({
|
||||
config: cfg(),
|
||||
workDir: "/tmp/work",
|
||||
configDir: "/tmp/cfg",
|
||||
logger: silentLogger,
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(goLibrespotCtor).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ deviceName: "TSMusicBot" }),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController.chooseBackend (platform x config matrix)", () => {
|
||||
function pick(
|
||||
backend: SpotifyConfig["backend"],
|
||||
opts: { go: boolean; goSupported?: boolean; rust: boolean; rustSupported?: boolean },
|
||||
) {
|
||||
bin.supported = opts.goSupported ?? true;
|
||||
bin.path = opts.go ? existingBin : missingBin;
|
||||
bin.rustSupported = opts.rustSupported ?? true;
|
||||
bin.rustPath = opts.rust ? existingBin : missingBin;
|
||||
const { ctrl } = makeCtrl({ config: { backend } });
|
||||
return ctrl.chooseBackend();
|
||||
}
|
||||
|
||||
it("auto: prefers go-librespot when linux + go binary present", () => {
|
||||
expect(pick("auto", { go: true, rust: true })).toBe("go-librespot");
|
||||
});
|
||||
it("auto: falls back to librespot when go unsupported (e.g. Windows) but librespot present", () => {
|
||||
expect(pick("auto", { go: true, goSupported: false, rust: true })).toBe("librespot");
|
||||
});
|
||||
it("auto: falls back to librespot when go binary is absent", () => {
|
||||
expect(pick("auto", { go: false, rust: true })).toBe("librespot");
|
||||
});
|
||||
it("auto: null when neither backend is usable", () => {
|
||||
expect(pick("auto", { go: false, goSupported: false, rust: false })).toBeNull();
|
||||
});
|
||||
it("go-librespot: selected when supported + present", () => {
|
||||
expect(pick("go-librespot", { go: true, rust: true })).toBe("go-librespot");
|
||||
});
|
||||
it("go-librespot: null when unsupported, even if librespot is present", () => {
|
||||
expect(pick("go-librespot", { go: true, goSupported: false, rust: true })).toBeNull();
|
||||
});
|
||||
it("librespot: selected when the librespot binary is present", () => {
|
||||
expect(pick("librespot", { go: true, rust: true })).toBe("librespot");
|
||||
});
|
||||
it("librespot: null when the librespot binary is absent, even if go is present", () => {
|
||||
expect(pick("librespot", { go: true, rust: false })).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("SpotifyController Rust-backend auth gate", () => {
|
||||
it("isAvailable is true for a present librespot binary regardless of auth", () => {
|
||||
bin.rustPath = existingBin;
|
||||
const { ctrl } = makeCtrl({
|
||||
config: { backend: "librespot" },
|
||||
oauth: fakeOAuth(false),
|
||||
});
|
||||
expect(ctrl.isAvailable()).toBe(true);
|
||||
});
|
||||
|
||||
it("ensureStarted returns false (no backend built) when Rust chosen but unauthorized", async () => {
|
||||
bin.rustPath = existingBin;
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
config: { backend: "librespot" },
|
||||
oauth: fakeOAuth(false),
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return new FakeBackend();
|
||||
},
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(false);
|
||||
expect(built).toBe(0);
|
||||
});
|
||||
|
||||
it("ensureStarted starts the Rust backend once authorized", async () => {
|
||||
bin.rustPath = existingBin;
|
||||
const be = new FakeBackend();
|
||||
let built = 0;
|
||||
const { ctrl } = makeCtrl({
|
||||
config: { backend: "librespot" },
|
||||
oauth: fakeOAuth(true),
|
||||
backendFactory: () => {
|
||||
built++;
|
||||
return be;
|
||||
},
|
||||
});
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
expect(built).toBe(1);
|
||||
expect(be.startCalls).toBe(1);
|
||||
});
|
||||
|
||||
it("go-librespot path never consults oauth.isAuthorized()", async () => {
|
||||
// auto + go present -> go-librespot; the auth gate must be skipped so a
|
||||
// throwing isAuthorized() is never reached.
|
||||
const oauth = fakeOAuth(false, {
|
||||
onIsAuthorized: () => {
|
||||
throw new Error("isAuthorized must not be called on the go path");
|
||||
},
|
||||
});
|
||||
const { ctrl } = makeCtrl({ config: { backend: "auto" }, oauth });
|
||||
expect(await ctrl.ensureStarted()).toBe(true);
|
||||
});
|
||||
|
||||
it("exposes the shared oauth + connect instances", () => {
|
||||
const oauth = fakeOAuth(true);
|
||||
const { ctrl } = makeCtrl({ config: { backend: "auto" }, oauth });
|
||||
expect(ctrl.getOAuth()).toBe(oauth);
|
||||
expect(ctrl.getConnect()).toBeDefined();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,405 @@
|
||||
import { EventEmitter } from "node:events";
|
||||
import {
|
||||
existsSync,
|
||||
readFileSync,
|
||||
writeFileSync,
|
||||
mkdirSync,
|
||||
rmSync,
|
||||
} from "node:fs";
|
||||
import { dirname, join } from "node:path";
|
||||
import type { Readable } from "node:stream";
|
||||
import type { Logger } from "pino";
|
||||
import type { SpotifyConfig } from "../../data/config.js";
|
||||
import type {
|
||||
SpotifyAudioBackend,
|
||||
SpotifyTrackEndedEvent,
|
||||
SpotifyNowPlaying,
|
||||
} from "./backend.js";
|
||||
import { isGoLibrespotPresent, isLibrespotPresent } from "./binary.js";
|
||||
import { GoLibrespotBackend } from "./go-librespot.js";
|
||||
import { RustLibrespotBackend } from "./rust-librespot.js";
|
||||
import {
|
||||
SpotifyOAuth,
|
||||
type OAuthTokens,
|
||||
type OAuthTokenStore,
|
||||
} from "./spotify-oauth.js";
|
||||
import { SpotifyConnectApi } from "./connect-api.js";
|
||||
import {
|
||||
resolveSpotifyBackendKind,
|
||||
type SpotifyBackendKind,
|
||||
} from "./backend-select.js";
|
||||
export type { SpotifyBackendKind }; // keep the name exported for existing importers
|
||||
|
||||
/**
|
||||
* Derive the per-bot Spotify Connect device name from the user-configured base.
|
||||
*
|
||||
* `config.spotify` is a single process-wide object shared by every BotInstance,
|
||||
* so `config.spotify.deviceName` is identical for all bots. On the Rust
|
||||
* (librespot) backend each bot would otherwise spawn `librespot --name <base>`
|
||||
* with NO uniqueness, registering TWO Connect devices with the SAME name under
|
||||
* the one shared Premium account — so `findDeviceByName` / `waitForDevice`
|
||||
* (which match by name) could target the OTHER bot's device, misrouting
|
||||
* transfer()+play() and reporting false readiness (corner-case R2-5).
|
||||
*
|
||||
* Suffixing the base with the bot's instanceId makes the Connect identity
|
||||
* unique per bot. Pure + deterministic: same inputs → same name across
|
||||
* restarts. Returns the base unchanged when no instanceId is supplied (keeps
|
||||
* existing single-bot / non-injected behavior byte-for-byte).
|
||||
*/
|
||||
export function perBotDeviceName(base: string, instanceId?: string): string {
|
||||
return instanceId ? `${base}-${instanceId}` : base;
|
||||
}
|
||||
|
||||
/**
|
||||
* Minimal file-backed OAuth token store used when the caller does not inject a
|
||||
* SpotifyOAuth. Persists the rotating refresh-token JSON next to the bot config
|
||||
* (0600). All IO is lazy + guarded so construction never throws and a
|
||||
* missing/corrupt file simply reads as "unauthorized".
|
||||
*/
|
||||
class FileOAuthTokenStore implements OAuthTokenStore {
|
||||
constructor(private readonly file: string) {}
|
||||
load(): OAuthTokens | null {
|
||||
try {
|
||||
if (!existsSync(this.file)) return null;
|
||||
return JSON.parse(readFileSync(this.file, "utf8")) as OAuthTokens;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
save(t: OAuthTokens): void {
|
||||
mkdirSync(dirname(this.file), { recursive: true });
|
||||
writeFileSync(this.file, JSON.stringify(t), { mode: 0o600 });
|
||||
}
|
||||
clear(): void {
|
||||
try {
|
||||
rmSync(this.file, { force: true });
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export interface SpotifyControllerOptions {
|
||||
config: SpotifyConfig;
|
||||
workDir: string;
|
||||
configDir: string;
|
||||
logger: Logger;
|
||||
/** Owning bot's id; suffixed onto the shared base deviceName so each bot's
|
||||
* Spotify Connect identity is unique (avoids multi-bot device collision /
|
||||
* misroute — corner-case R2-5). Omitted → the base name is used unchanged. */
|
||||
instanceId?: string;
|
||||
/** Per-bot go-librespot control-API port (distinct per bot to avoid binds). */
|
||||
apiPort?: number;
|
||||
/** Per-bot go-librespot OAuth callback port (distinct per bot). */
|
||||
callbackPort?: number;
|
||||
/** Injected for tests; when set it overrides the per-kind default builders. */
|
||||
backendFactory?: () => SpotifyAudioBackend;
|
||||
/** Injected for tests; defaults to a file-backed SpotifyOAuth in configDir. */
|
||||
oauth?: SpotifyOAuth;
|
||||
/** Injected for tests; defaults to a SpotifyConnectApi wired to oauth. */
|
||||
connect?: SpotifyConnectApi;
|
||||
}
|
||||
|
||||
/**
|
||||
* Per-bot orchestrator for the Spotify sidecar. Selects a backend for this
|
||||
* host+config (chooseBackend), owns backend lifecycle, gates on availability
|
||||
* (config + platform + binary) plus — for the Rust librespot backend — OAuth
|
||||
* authorization, delegates transport, and re-emits "trackEnded"/"metadata" so
|
||||
* BotInstance can advance the queue exactly as for the ffmpeg path.
|
||||
*
|
||||
* Correction C3 (unchanged): this controller does NOT re-emit a raw "error"
|
||||
* event. It subscribes to the backend's "error", logs it, tears the backend
|
||||
* down, and marks itself not-ready so the next ensureStarted() relaunches a
|
||||
* fresh backend. getPcmStream() proxies the backend's SINGLE persistent stream.
|
||||
*/
|
||||
export class SpotifyController extends EventEmitter {
|
||||
private readonly config: SpotifyConfig;
|
||||
private readonly workDir: string;
|
||||
private readonly configDir: string;
|
||||
private readonly logger: Logger;
|
||||
private readonly instanceId?: string;
|
||||
private readonly apiPort?: number;
|
||||
private readonly callbackPort?: number;
|
||||
private readonly injectedFactory?: () => SpotifyAudioBackend;
|
||||
private readonly oauth: SpotifyOAuth;
|
||||
private readonly connect: SpotifyConnectApi;
|
||||
|
||||
private backend: SpotifyAudioBackend | null = null;
|
||||
// The in-flight backend during a start() that has not yet completed. A
|
||||
// stop()/handleBackendError() DURING start() clears (or replaces) this so the
|
||||
// mid-start sidecar is torn down and a completing start is discarded by the
|
||||
// ensureStarted post-await guard instead of resurrecting a backend the caller
|
||||
// already tore down (Bug I1).
|
||||
private pendingBackend: SpotifyAudioBackend | null = null;
|
||||
private started = false;
|
||||
private startPromise: Promise<boolean> | null = null;
|
||||
|
||||
constructor(o: SpotifyControllerOptions) {
|
||||
super();
|
||||
this.config = o.config;
|
||||
this.workDir = o.workDir;
|
||||
this.configDir = o.configDir;
|
||||
this.logger = o.logger;
|
||||
this.instanceId = o.instanceId;
|
||||
this.apiPort = o.apiPort;
|
||||
this.callbackPort = o.callbackPort;
|
||||
this.injectedFactory = o.backendFactory;
|
||||
// The controller OWNS a shared OAuth + Connect pair (Task 6 web router and
|
||||
// the Rust backend reuse these exact instances). Constructing the defaults
|
||||
// performs no IO/network — the file store loads lazily on first use.
|
||||
this.oauth =
|
||||
o.oauth ??
|
||||
new SpotifyOAuth({
|
||||
store: new FileOAuthTokenStore(
|
||||
join(this.configDir, "spotify-oauth.json"),
|
||||
),
|
||||
});
|
||||
this.connect =
|
||||
o.connect ??
|
||||
new SpotifyConnectApi(() => this.oauth.getAccessToken(), {
|
||||
logger: this.logger,
|
||||
});
|
||||
}
|
||||
|
||||
/** Shared OAuth client (web router + Rust backend reuse this instance). */
|
||||
getOAuth(): SpotifyOAuth {
|
||||
return this.oauth;
|
||||
}
|
||||
|
||||
/** Shared Connect API client (Rust backend reuses this instance). */
|
||||
getConnect(): SpotifyConnectApi {
|
||||
return this.connect;
|
||||
}
|
||||
|
||||
private goPresent(): boolean {
|
||||
// PATH-aware, sync presence gate (Bug I3): a bare PATH-installed binary is
|
||||
// resolved against $PATH, not existsSync()'d against process.cwd().
|
||||
return isGoLibrespotPresent();
|
||||
}
|
||||
|
||||
private rustPresent(): boolean {
|
||||
return isLibrespotPresent();
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve which backend to run for this platform + config, or null when none
|
||||
* is usable (caller falls back to the Stage-1 sentinel message):
|
||||
* "go-librespot" -> GoLibrespot iff supported (linux) + binary present
|
||||
* "librespot" -> Rust iff librespot(.exe) present (all platforms)
|
||||
* "auto" -> GoLibrespot when (linux + go binary), else Rust when
|
||||
* librespot present, else null.
|
||||
*/
|
||||
chooseBackend(): SpotifyBackendKind | null {
|
||||
return resolveSpotifyBackendKind(
|
||||
this.config.backend,
|
||||
this.goPresent(),
|
||||
this.rustPresent(),
|
||||
);
|
||||
}
|
||||
|
||||
/** enabled in config AND a backend is selectable (platform + binary present). */
|
||||
isAvailable(): boolean {
|
||||
return this.config.enabled && this.chooseBackend() !== null;
|
||||
}
|
||||
|
||||
/** Build the concrete backend for the chosen kind (or the injected fake). */
|
||||
private buildBackend(kind: SpotifyBackendKind): SpotifyAudioBackend {
|
||||
if (this.injectedFactory) return this.injectedFactory();
|
||||
// Compute the effective (per-bot-unique) Connect device name ONCE and pass
|
||||
// the SAME value to whichever backend we build, so `librespot --name`,
|
||||
// findDeviceByName(), and waitForDevice() all key on one identity — that
|
||||
// consistency is what prevents the multi-bot misroute / false-readiness
|
||||
// (corner-case R2-5). The user-configured base (config.deviceName) is left
|
||||
// untouched; the suffix is applied only to the backend/Connect identity.
|
||||
const deviceName = perBotDeviceName(this.config.deviceName, this.instanceId);
|
||||
if (kind === "librespot") {
|
||||
return new RustLibrespotBackend({
|
||||
deviceName,
|
||||
bitrate: this.config.bitrate,
|
||||
cacheDir: join(this.workDir, "librespot-cache"),
|
||||
oauth: this.oauth,
|
||||
connect: this.connect,
|
||||
logger: this.logger,
|
||||
});
|
||||
}
|
||||
return new GoLibrespotBackend({
|
||||
deviceName,
|
||||
bitrate: this.config.bitrate,
|
||||
workDir: this.workDir,
|
||||
configDir: this.configDir,
|
||||
apiPort: this.apiPort,
|
||||
callbackPort: this.callbackPort,
|
||||
logger: this.logger,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Idempotently start the selected backend. Returns false (without building a
|
||||
* backend) when unavailable, or — for the Rust backend — when OAuth is not
|
||||
* yet authorized, so callers show the login-needed / fallback message. A
|
||||
* failed start clears the cached promise so a later call can retry.
|
||||
*/
|
||||
async ensureStarted(): Promise<boolean> {
|
||||
if (!this.isAvailable()) return false;
|
||||
const kind = this.chooseBackend();
|
||||
if (!kind) return false;
|
||||
// The Rust librespot device only appears in Spotify Connect once the user
|
||||
// has authorized OAuth; without it, do not spawn a dead sidecar.
|
||||
if (kind === "librespot" && !this.oauth.isAuthorized()) return false;
|
||||
|
||||
if (this.started) {
|
||||
if (this.backend?.isReady()) return true;
|
||||
this.stop();
|
||||
}
|
||||
if (this.startPromise) return this.startPromise;
|
||||
|
||||
this.startPromise = (async () => {
|
||||
const backend = this.buildBackend(kind);
|
||||
// Publish the in-flight backend BEFORE the (potentially ~20s) start()
|
||||
// await so a concurrent stop()/handleBackendError() can reach and tear
|
||||
// down this mid-start sidecar (Bug I1).
|
||||
this.pendingBackend = backend;
|
||||
backend.on("trackEnded", (e: SpotifyTrackEndedEvent) =>
|
||||
this.emit("trackEnded", e),
|
||||
);
|
||||
backend.on("metadata", (m: SpotifyNowPlaying) =>
|
||||
this.emit("metadata", m),
|
||||
);
|
||||
// C3: do NOT re-emit "error". Log and mark not-ready so the next
|
||||
// ensureStarted() relaunches a fresh backend.
|
||||
backend.on("error", (err?: unknown) => this.handleBackendError(err));
|
||||
try {
|
||||
await backend.start();
|
||||
} catch (err) {
|
||||
this.logger.error({ err }, "Spotify backend failed to start");
|
||||
if (this.pendingBackend === backend) this.pendingBackend = null;
|
||||
this.startPromise = null;
|
||||
return false;
|
||||
}
|
||||
// Post-await guard (Bug I1): if teardown ran DURING start() — stop() or
|
||||
// handleBackendError() cleared/replaced pendingBackend — do NOT promote
|
||||
// this backend. Tear the just-started sidecar down so it is neither
|
||||
// leaked nor resurrected, and report failure to the caller.
|
||||
if (this.pendingBackend !== backend) {
|
||||
this.teardownBackend(
|
||||
backend,
|
||||
"Spotify backend stop() threw tearing down a superseded start",
|
||||
);
|
||||
return false;
|
||||
}
|
||||
this.pendingBackend = null;
|
||||
this.backend = backend;
|
||||
this.started = true;
|
||||
return true;
|
||||
})();
|
||||
return this.startPromise;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop a backend and detach ALL its listeners, swallowing+logging any throw
|
||||
* from stop() so teardown never propagates. Shared by the error/stop paths
|
||||
* and the ensureStarted post-await guard.
|
||||
*/
|
||||
private teardownBackend(be: SpotifyAudioBackend, stopMsg: string): void {
|
||||
try {
|
||||
be.stop();
|
||||
} catch (stopErr) {
|
||||
this.logger.error({ err: stopErr }, stopMsg);
|
||||
}
|
||||
(be as unknown as EventEmitter).removeAllListeners();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tear down an in-flight (mid-start) backend so a start() still awaiting is
|
||||
* discarded by ensureStarted's post-await guard rather than promoted, and its
|
||||
* spawned sidecar is killed rather than orphaned (Bug I1).
|
||||
*/
|
||||
private teardownPendingBackend(): void {
|
||||
if (!this.pendingBackend) return;
|
||||
this.teardownBackend(
|
||||
this.pendingBackend,
|
||||
"Spotify backend stop() threw tearing down in-flight start",
|
||||
);
|
||||
this.pendingBackend = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* C3 backend-error handler. Never re-emits "error" (an unhandled "error" on
|
||||
* an EventEmitter throws). Logs, tears the errored backend down, and marks
|
||||
* the controller not-ready so the next ensureStarted() relaunches it.
|
||||
*/
|
||||
private handleBackendError(err: unknown): void {
|
||||
this.logger.error({ err }, "Spotify backend error; marking not-ready");
|
||||
if (this.backend) {
|
||||
this.teardownBackend(
|
||||
this.backend,
|
||||
"Spotify backend stop() threw during error teardown",
|
||||
);
|
||||
}
|
||||
this.backend = null;
|
||||
// Also kill an in-flight start so its post-await guard discards it.
|
||||
this.teardownPendingBackend();
|
||||
this.started = false;
|
||||
this.startPromise = null;
|
||||
}
|
||||
|
||||
/** Ensure started, then play the spotify: URI. False on any failure. */
|
||||
async playTrack(uri: string): Promise<boolean> {
|
||||
const ok = await this.ensureStarted();
|
||||
if (!ok || !this.backend) return false;
|
||||
try {
|
||||
await this.backend.playTrack(uri);
|
||||
return true;
|
||||
} catch (err) {
|
||||
this.logger.error({ err, uri }, "Spotify playTrack failed");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async pause(): Promise<void> {
|
||||
if (this.backend) await this.backend.pause();
|
||||
}
|
||||
|
||||
async resume(): Promise<void> {
|
||||
if (this.backend) await this.backend.resume();
|
||||
}
|
||||
|
||||
async seek(ms: number): Promise<void> {
|
||||
// R4-1: round to an integer ms ONCE here so BOTH backends receive a valid
|
||||
// integer position. The web progress bar computes seekTime = ratio *
|
||||
// duration (fractional seconds), so seek(seconds * 1000) is a NON-integer ms
|
||||
// (e.g. 71610.00000000001). go-librespot decodes `position` into an int64
|
||||
// and Go's encoding/json rejects a JSON number with a decimal point → HTTP
|
||||
// 400 → the error is swallowed → the track never seeks. The Spotify Web API
|
||||
// (Rust path) likewise expects an integer position_ms. Clamp negatives to 0.
|
||||
const position = Math.max(0, Math.round(ms));
|
||||
if (this.backend) await this.backend.seek(position);
|
||||
}
|
||||
|
||||
getPcmStream(): Readable {
|
||||
if (!this.backend) {
|
||||
throw new Error("Spotify backend not started");
|
||||
}
|
||||
return this.backend.getPcmStream();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tear down the backend and reset lifecycle state (safe before start).
|
||||
* Mirrors handleBackendError's teardown so the NEXT ensureStarted() rebuilds
|
||||
* a fresh backend.
|
||||
*/
|
||||
stop(): void {
|
||||
if (this.backend) {
|
||||
this.teardownBackend(
|
||||
this.backend,
|
||||
"Spotify backend stop() threw during teardown",
|
||||
);
|
||||
}
|
||||
this.backend = null;
|
||||
// Also kill an in-flight start so its post-await guard discards it rather
|
||||
// than resurrecting the sidecar this stop() just tore down (Bug I1).
|
||||
this.teardownPendingBackend();
|
||||
this.started = false;
|
||||
this.startPromise = null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,299 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { EventEmitter } from "node:events";
|
||||
import type { AxiosInstance } from "axios";
|
||||
import { GoLibrespotRestClient, GoLibrespotEventClient } from "./go-librespot-api.js";
|
||||
|
||||
/** Minimal axios stub: only get/post are exercised by the client. */
|
||||
function makeHttp(overrides?: Partial<Record<"get" | "post", any>>) {
|
||||
return {
|
||||
get: vi.fn().mockResolvedValue({ status: 200, data: {} }),
|
||||
post: vi.fn().mockResolvedValue({ status: 200, data: {} }),
|
||||
...overrides,
|
||||
} as unknown as AxiosInstance;
|
||||
}
|
||||
|
||||
describe("GoLibrespotRestClient", () => {
|
||||
it("ping() returns true on GET / -> 200", async () => {
|
||||
const http = makeHttp();
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await expect(client.ping()).resolves.toBe(true);
|
||||
expect(http.get).toHaveBeenCalledWith("/");
|
||||
});
|
||||
|
||||
it("ping() returns false when GET / rejects (daemon not up)", async () => {
|
||||
const http = makeHttp({ get: vi.fn().mockRejectedValue(new Error("ECONNREFUSED")) });
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await expect(client.ping()).resolves.toBe(false);
|
||||
});
|
||||
|
||||
it("playTrack() POSTs /player/play with the uri body", async () => {
|
||||
const http = makeHttp();
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await client.playTrack("spotify:track:abc123");
|
||||
expect(http.post).toHaveBeenCalledWith("/player/play", { uri: "spotify:track:abc123" });
|
||||
});
|
||||
|
||||
it("pause/resume/stop POST their bodyless endpoints", async () => {
|
||||
const http = makeHttp();
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await client.pause();
|
||||
await client.resume();
|
||||
await client.stop();
|
||||
expect(http.post).toHaveBeenNthCalledWith(1, "/player/pause");
|
||||
expect(http.post).toHaveBeenNthCalledWith(2, "/player/resume");
|
||||
expect(http.post).toHaveBeenNthCalledWith(3, "/player/stop");
|
||||
});
|
||||
|
||||
it("seek() POSTs /player/seek with position(ms) and relative:false", async () => {
|
||||
const http = makeHttp();
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await client.seek(42000);
|
||||
expect(http.post).toHaveBeenCalledWith("/player/seek", { position: 42000, relative: false });
|
||||
});
|
||||
|
||||
it("playTrack() rejects when the POST fails (surfaced to caller)", async () => {
|
||||
const http = makeHttp({ post: vi.fn().mockRejectedValue(new Error("boom")) });
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await expect(client.playTrack("spotify:track:x")).rejects.toThrow("boom");
|
||||
});
|
||||
|
||||
it("getStatus() normalizes the /status shape (ms position/duration)", async () => {
|
||||
const http = makeHttp({
|
||||
get: vi.fn().mockResolvedValue({
|
||||
status: 200,
|
||||
data: {
|
||||
stopped: false,
|
||||
paused: false,
|
||||
buffering: false,
|
||||
track: {
|
||||
uri: "spotify:track:abc",
|
||||
name: "Song",
|
||||
artist_names: ["A", "B"],
|
||||
album_name: "Alb",
|
||||
album_cover_url: "https://i.scdn.co/c.jpg",
|
||||
position: 12345,
|
||||
duration: 200000,
|
||||
},
|
||||
},
|
||||
}),
|
||||
});
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
const status = await client.getStatus();
|
||||
expect(http.get).toHaveBeenCalledWith("/status");
|
||||
expect(status).toEqual({
|
||||
stopped: false,
|
||||
paused: false,
|
||||
buffering: false,
|
||||
track: {
|
||||
uri: "spotify:track:abc",
|
||||
name: "Song",
|
||||
artist_names: ["A", "B"],
|
||||
album_name: "Alb",
|
||||
album_cover_url: "https://i.scdn.co/c.jpg",
|
||||
position: 12345,
|
||||
duration: 200000,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("getStatus() returns null with a null track when nothing is loaded", async () => {
|
||||
const http = makeHttp({ get: vi.fn().mockResolvedValue({ status: 200, data: { stopped: true, paused: false, buffering: false, track: null } }) });
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
const status = await client.getStatus();
|
||||
expect(status).toEqual({ stopped: true, paused: false, buffering: false, track: null });
|
||||
});
|
||||
|
||||
it("getStatus() returns null when GET /status rejects", async () => {
|
||||
const http = makeHttp({ get: vi.fn().mockRejectedValue(new Error("down")) });
|
||||
const client = new GoLibrespotRestClient("http://127.0.0.1:3678", { http });
|
||||
await expect(client.getStatus()).resolves.toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
/** Fake ws: records instances, lets tests drive open/message/close/error. */
|
||||
class FakeWebSocket extends EventEmitter {
|
||||
static instances: FakeWebSocket[] = [];
|
||||
closed = false;
|
||||
constructor(public url: string) {
|
||||
super();
|
||||
FakeWebSocket.instances.push(this);
|
||||
}
|
||||
close() {
|
||||
this.closed = true;
|
||||
this.emit("close");
|
||||
}
|
||||
}
|
||||
|
||||
function frame(type: string, data: unknown): Buffer {
|
||||
return Buffer.from(JSON.stringify({ type, data }));
|
||||
}
|
||||
|
||||
describe("GoLibrespotEventClient", () => {
|
||||
beforeEach(() => {
|
||||
FakeWebSocket.instances = [];
|
||||
});
|
||||
|
||||
it("emits 'not_playing' (track-end) with its data payload", () => {
|
||||
const client = new GoLibrespotEventClient("ws://127.0.0.1:3678/events", {
|
||||
WebSocketCtor: FakeWebSocket as any,
|
||||
});
|
||||
const onEnded = vi.fn();
|
||||
client.on("not_playing", onEnded);
|
||||
client.start();
|
||||
|
||||
const ws = FakeWebSocket.instances[0];
|
||||
expect(ws.url).toBe("ws://127.0.0.1:3678/events");
|
||||
ws.emit("message", frame("not_playing", { uri: "spotify:track:abc", play_origin: "go-librespot" }));
|
||||
|
||||
expect(onEnded).toHaveBeenCalledTimes(1);
|
||||
expect(onEnded).toHaveBeenCalledWith({ uri: "spotify:track:abc", play_origin: "go-librespot" });
|
||||
client.stop();
|
||||
});
|
||||
|
||||
it("emits 'metadata' with the now-playing object", () => {
|
||||
const client = new GoLibrespotEventClient("ws://127.0.0.1:3678/events", {
|
||||
WebSocketCtor: FakeWebSocket as any,
|
||||
});
|
||||
const onMeta = vi.fn();
|
||||
client.on("metadata", onMeta);
|
||||
client.start();
|
||||
|
||||
FakeWebSocket.instances[0].emit(
|
||||
"message",
|
||||
frame("metadata", { uri: "spotify:track:xyz", name: "Song", artist_names: ["Q"], duration: 200000 }),
|
||||
);
|
||||
|
||||
expect(onMeta).toHaveBeenCalledWith({ uri: "spotify:track:xyz", name: "Song", artist_names: ["Q"], duration: 200000 });
|
||||
client.stop();
|
||||
});
|
||||
|
||||
it("ignores non-JSON frames without throwing", () => {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
const onAny = vi.fn();
|
||||
client.on("metadata", onAny);
|
||||
client.start();
|
||||
expect(() => FakeWebSocket.instances[0].emit("message", Buffer.from("not json"))).not.toThrow();
|
||||
expect(onAny).not.toHaveBeenCalled();
|
||||
client.stop();
|
||||
});
|
||||
|
||||
it("reconnects with backoff after the socket closes", () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
client.start();
|
||||
expect(FakeWebSocket.instances).toHaveLength(1);
|
||||
|
||||
FakeWebSocket.instances[0].emit("close");
|
||||
expect(FakeWebSocket.instances).toHaveLength(1); // not immediate
|
||||
vi.advanceTimersByTime(500);
|
||||
expect(FakeWebSocket.instances).toHaveLength(2); // reconnected
|
||||
client.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it("stop() closes the socket and prevents reconnect", () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
client.start();
|
||||
const ws = FakeWebSocket.instances[0];
|
||||
client.stop();
|
||||
expect(ws.closed).toBe(true);
|
||||
vi.advanceTimersByTime(60000);
|
||||
expect(FakeWebSocket.instances).toHaveLength(1); // no new socket
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it("does not throw on socket 'error' when no error listener is attached", () => {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
client.start();
|
||||
expect(() => FakeWebSocket.instances[0].emit("error", new Error("net"))).not.toThrow();
|
||||
client.stop();
|
||||
});
|
||||
|
||||
// R4-3: a WS drop at a track boundary can lose the not_playing/stopped event.
|
||||
// After a successful RE-open the client emits "reconnected" so the backend can
|
||||
// re-query GET /status and reconcile. The FIRST connect must NOT emit it (there
|
||||
// is nothing to reconcile yet).
|
||||
it("emits 'reconnected' after a reconnect open, but NOT on the initial connect", () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
const onReconnected = vi.fn();
|
||||
client.on("reconnected", onReconnected);
|
||||
client.start();
|
||||
|
||||
FakeWebSocket.instances[0].emit("open"); // initial connect
|
||||
expect(onReconnected).not.toHaveBeenCalled(); // no re-sync on first connect
|
||||
|
||||
FakeWebSocket.instances[0].emit("close");
|
||||
vi.advanceTimersByTime(500);
|
||||
expect(FakeWebSocket.instances).toHaveLength(2); // reconnected socket
|
||||
FakeWebSocket.instances[1].emit("open"); // reconnect open
|
||||
expect(onReconnected).toHaveBeenCalledTimes(1);
|
||||
client.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
// R4-5: a socket that is accepted then immediately closed (a flap) must let the
|
||||
// exponential backoff GROW — the old code reset it to 500ms on every 'open',
|
||||
// pinning reconnects at ~2 Hz.
|
||||
it("grows the reconnect backoff across open→immediate-close flaps (no 500ms pin)", () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
client.start();
|
||||
// Flap #1: accept then immediately drop -> next reconnect at 500ms.
|
||||
FakeWebSocket.instances[0].emit("open");
|
||||
FakeWebSocket.instances[0].emit("close");
|
||||
vi.advanceTimersByTime(500);
|
||||
expect(FakeWebSocket.instances).toHaveLength(2);
|
||||
|
||||
// Flap #2: accept then immediately drop -> backoff has doubled to 1000ms.
|
||||
FakeWebSocket.instances[1].emit("open");
|
||||
FakeWebSocket.instances[1].emit("close");
|
||||
vi.advanceTimersByTime(500);
|
||||
expect(FakeWebSocket.instances).toHaveLength(2); // still 2: 500ms is NOT enough now
|
||||
vi.advanceTimersByTime(500);
|
||||
expect(FakeWebSocket.instances).toHaveLength(3); // reconnects only after 1000ms
|
||||
client.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
// R4-5: once a connection has been STABLE (up for >= STABLE_CONNECTION_MS) the
|
||||
// backoff resets, so a later drop reconnects promptly again.
|
||||
it("resets the reconnect backoff after a stable connection", () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const client = new GoLibrespotEventClient("ws://x/events", { WebSocketCtor: FakeWebSocket as any });
|
||||
client.start();
|
||||
// Flap once to grow the backoff to 1000ms.
|
||||
FakeWebSocket.instances[0].emit("open");
|
||||
FakeWebSocket.instances[0].emit("close");
|
||||
vi.advanceTimersByTime(500);
|
||||
expect(FakeWebSocket.instances).toHaveLength(2);
|
||||
|
||||
// Now a STABLE connection: open and stay up past the stability threshold.
|
||||
FakeWebSocket.instances[1].emit("open");
|
||||
vi.advanceTimersByTime(5000); // >= STABLE_CONNECTION_MS -> backoff reset to 500
|
||||
|
||||
FakeWebSocket.instances[1].emit("close");
|
||||
vi.advanceTimersByTime(499);
|
||||
expect(FakeWebSocket.instances).toHaveLength(2); // not yet
|
||||
vi.advanceTimersByTime(1);
|
||||
expect(FakeWebSocket.instances).toHaveLength(3); // reconnected at 500ms -> backoff was reset
|
||||
client.stop();
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,235 @@
|
||||
import { EventEmitter } from "node:events";
|
||||
import axios, { type AxiosInstance } from "axios";
|
||||
import WebSocket from "ws";
|
||||
|
||||
export interface GoLibrespotStatusTrack {
|
||||
uri: string;
|
||||
name: string;
|
||||
artist_names: string[];
|
||||
album_name: string;
|
||||
album_cover_url: string | null;
|
||||
position: number;
|
||||
duration: number;
|
||||
}
|
||||
|
||||
export interface GoLibrespotStatus {
|
||||
stopped: boolean;
|
||||
paused: boolean;
|
||||
buffering: boolean;
|
||||
track: GoLibrespotStatusTrack | null;
|
||||
}
|
||||
|
||||
export class GoLibrespotRestClient {
|
||||
private http: AxiosInstance;
|
||||
|
||||
constructor(baseUrl: string, deps?: { http?: AxiosInstance }) {
|
||||
this.http =
|
||||
deps?.http ??
|
||||
axios.create({
|
||||
baseURL: baseUrl,
|
||||
timeout: 10000,
|
||||
headers: { "Content-Type": "application/json" },
|
||||
});
|
||||
}
|
||||
|
||||
async ping(): Promise<boolean> {
|
||||
try {
|
||||
const res = await this.http.get("/");
|
||||
return res.status === 200;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async playTrack(uri: string): Promise<void> {
|
||||
await this.http.post("/player/play", { uri });
|
||||
}
|
||||
|
||||
async pause(): Promise<void> {
|
||||
await this.http.post("/player/pause");
|
||||
}
|
||||
|
||||
async resume(): Promise<void> {
|
||||
await this.http.post("/player/resume");
|
||||
}
|
||||
|
||||
async stop(): Promise<void> {
|
||||
await this.http.post("/player/stop");
|
||||
}
|
||||
|
||||
async seek(ms: number): Promise<void> {
|
||||
await this.http.post("/player/seek", { position: ms, relative: false });
|
||||
}
|
||||
|
||||
async getStatus(): Promise<GoLibrespotStatus | null> {
|
||||
try {
|
||||
const res = await this.http.get("/status");
|
||||
const d = res.data ?? {};
|
||||
const t = d.track;
|
||||
return {
|
||||
stopped: Boolean(d.stopped),
|
||||
paused: Boolean(d.paused),
|
||||
buffering: Boolean(d.buffering),
|
||||
track: t
|
||||
? {
|
||||
uri: t.uri ?? "",
|
||||
name: t.name ?? "",
|
||||
artist_names: Array.isArray(t.artist_names) ? t.artist_names : [],
|
||||
album_name: t.album_name ?? "",
|
||||
album_cover_url: t.album_cover_url ?? null,
|
||||
position: t.position ?? 0,
|
||||
duration: t.duration ?? 0,
|
||||
}
|
||||
: null,
|
||||
};
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export type GoLibrespotEventType =
|
||||
| "metadata"
|
||||
| "playing"
|
||||
| "paused"
|
||||
| "not_playing"
|
||||
| "stopped"
|
||||
| "will_play"
|
||||
| "seek"
|
||||
| "active"
|
||||
| "inactive"
|
||||
| "volume"
|
||||
| "playback_ready";
|
||||
|
||||
interface WsLike {
|
||||
on(event: string, cb: (...args: any[]) => void): void;
|
||||
close(): void;
|
||||
}
|
||||
type WebSocketCtor = new (url: string) => WsLike;
|
||||
|
||||
const INITIAL_RECONNECT_MS = 500;
|
||||
const MAX_RECONNECT_MS = 10000;
|
||||
// R4-5: a connection must stay up at least this long before we treat it as
|
||||
// "stable" and reset the reconnect backoff. A socket that is accepted and then
|
||||
// immediately closed (a flap) never reaches this, so the exponential backoff
|
||||
// keeps growing instead of pinning the reconnect interval at INITIAL_RECONNECT_MS.
|
||||
const STABLE_CONNECTION_MS = 5000;
|
||||
|
||||
/**
|
||||
* Emitted (in addition to the go-librespot event types) after the socket has
|
||||
* SUCCESSFULLY re-opened following a drop — never on the very first connect.
|
||||
* Consumers use it to re-query GET /status and reconcile any track-end that was
|
||||
* emitted by go-librespot during the WS-down window (R4-3).
|
||||
*/
|
||||
export type GoLibrespotSyntheticEvent = "reconnected";
|
||||
|
||||
export class GoLibrespotEventClient extends EventEmitter {
|
||||
private wsUrl: string;
|
||||
private WebSocketCtor: WebSocketCtor;
|
||||
private ws: WsLike | null = null;
|
||||
private stopped = false;
|
||||
private reconnectDelay = INITIAL_RECONNECT_MS;
|
||||
private reconnectTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
// R4-3: false until the FIRST successful open. A later open is therefore a
|
||||
// reconnect and warrants a "reconnected" re-sync signal.
|
||||
private hasConnected = false;
|
||||
// R4-5: fires STABLE_CONNECTION_MS after an open; only then is the backoff reset.
|
||||
private stableTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
|
||||
constructor(wsUrl: string, deps?: { WebSocketCtor?: WebSocketCtor }) {
|
||||
super();
|
||||
this.wsUrl = wsUrl;
|
||||
this.WebSocketCtor = deps?.WebSocketCtor ?? (WebSocket as unknown as WebSocketCtor);
|
||||
}
|
||||
|
||||
start(): void {
|
||||
this.stopped = false;
|
||||
this.connect();
|
||||
}
|
||||
|
||||
stop(): void {
|
||||
this.stopped = true;
|
||||
this.clearStableTimer();
|
||||
if (this.reconnectTimer) {
|
||||
clearTimeout(this.reconnectTimer);
|
||||
this.reconnectTimer = null;
|
||||
}
|
||||
if (this.ws) {
|
||||
this.ws.close();
|
||||
this.ws = null;
|
||||
}
|
||||
}
|
||||
|
||||
private connect(): void {
|
||||
if (this.stopped) return;
|
||||
const ws = new this.WebSocketCtor(this.wsUrl);
|
||||
this.ws = ws;
|
||||
ws.on("open", () => this.onOpen());
|
||||
ws.on("message", (buf: unknown) => this.handleMessage(buf));
|
||||
ws.on("close", () => {
|
||||
this.ws = null;
|
||||
// R4-5: the connection is gone — cancel the pending stability reset so a
|
||||
// short-lived (flapping) socket never resets the backoff.
|
||||
this.clearStableTimer();
|
||||
this.scheduleReconnect();
|
||||
});
|
||||
ws.on("error", (err: unknown) => {
|
||||
if (this.listenerCount("error") > 0) this.emit("error", err);
|
||||
});
|
||||
}
|
||||
|
||||
private onOpen(): void {
|
||||
// R4-3: only a RE-open (a socket that had connected before, then dropped)
|
||||
// needs reconciliation; the initial connect has nothing to catch up on.
|
||||
const isReconnect = this.hasConnected;
|
||||
this.hasConnected = true;
|
||||
// R4-5: do NOT reset the backoff here. Arm a timer that resets it only once
|
||||
// the connection has stayed up for STABLE_CONNECTION_MS; a flap that closes
|
||||
// before then leaves the exponential backoff to keep growing.
|
||||
this.armStableTimer();
|
||||
if (isReconnect) this.emit("reconnected");
|
||||
}
|
||||
|
||||
private armStableTimer(): void {
|
||||
this.clearStableTimer();
|
||||
this.stableTimer = setTimeout(() => {
|
||||
this.stableTimer = null;
|
||||
this.reconnectDelay = INITIAL_RECONNECT_MS;
|
||||
}, STABLE_CONNECTION_MS);
|
||||
(this.stableTimer as { unref?: () => void }).unref?.();
|
||||
}
|
||||
|
||||
private clearStableTimer(): void {
|
||||
if (this.stableTimer) {
|
||||
clearTimeout(this.stableTimer);
|
||||
this.stableTimer = null;
|
||||
}
|
||||
}
|
||||
|
||||
private handleMessage(buf: unknown): void {
|
||||
let parsed: unknown;
|
||||
try {
|
||||
const text = Buffer.isBuffer(buf)
|
||||
? buf.toString("utf8")
|
||||
: typeof buf === "string"
|
||||
? buf
|
||||
: String(buf);
|
||||
parsed = JSON.parse(text);
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
if (parsed && typeof (parsed as any).type === "string") {
|
||||
this.emit((parsed as any).type, (parsed as any).data ?? {});
|
||||
}
|
||||
}
|
||||
|
||||
private scheduleReconnect(): void {
|
||||
if (this.stopped || this.reconnectTimer) return;
|
||||
const delay = this.reconnectDelay;
|
||||
this.reconnectDelay = Math.min(delay * 2, MAX_RECONNECT_MS);
|
||||
this.reconnectTimer = setTimeout(() => {
|
||||
this.reconnectTimer = null;
|
||||
this.connect();
|
||||
}, delay);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
// src/music/spotify/go-librespot-config.test.ts
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { renderConfigYml, type GoLibrespotConfigOptions } from "./go-librespot-config.js";
|
||||
|
||||
const OPTS: GoLibrespotConfigOptions = {
|
||||
deviceName: "TeamSpeak Music Bot",
|
||||
bitrate: 320,
|
||||
fifoPath: "/tmp/go-librespot.fifo",
|
||||
apiAddress: "0.0.0.0",
|
||||
apiPort: 3678,
|
||||
callbackPort: 8080,
|
||||
};
|
||||
|
||||
/**
|
||||
* Minimal 2-level YAML reader for the exact shape renderConfigYml emits
|
||||
* (flat scalars + one level of nesting under `server:` / `credentials:`).
|
||||
* Avoids adding a yaml dependency while still proving the output round-trips.
|
||||
*/
|
||||
function parseTinyYaml(src: string): Record<string, unknown> {
|
||||
const root: Record<string, unknown> = {};
|
||||
const stack: Array<{ indent: number; obj: Record<string, unknown> }> = [
|
||||
{ indent: -1, obj: root },
|
||||
];
|
||||
for (const rawLine of src.split("\n")) {
|
||||
if (rawLine.trim() === "") continue;
|
||||
const indent = rawLine.length - rawLine.trimStart().length;
|
||||
const line = rawLine.trim();
|
||||
const idx = line.indexOf(":");
|
||||
const key = line.slice(0, idx).trim();
|
||||
let valRaw = line.slice(idx + 1).trim();
|
||||
while (stack.length > 1 && indent <= stack[stack.length - 1].indent) {
|
||||
stack.pop();
|
||||
}
|
||||
const parent = stack[stack.length - 1].obj;
|
||||
if (valRaw === "") {
|
||||
const child: Record<string, unknown> = {};
|
||||
parent[key] = child;
|
||||
stack.push({ indent, obj: child });
|
||||
continue;
|
||||
}
|
||||
let val: unknown = valRaw;
|
||||
if (valRaw.startsWith('"') && valRaw.endsWith('"')) val = JSON.parse(valRaw);
|
||||
else if (valRaw === "true") val = true;
|
||||
else if (valRaw === "false") val = false;
|
||||
else if (/^-?\d+$/.test(valRaw)) val = Number(valRaw);
|
||||
parent[key] = val;
|
||||
}
|
||||
return root;
|
||||
}
|
||||
|
||||
describe("renderConfigYml", () => {
|
||||
it("emits the exact top-level go-librespot keys/values", () => {
|
||||
const lines = renderConfigYml(OPTS).split("\n");
|
||||
expect(lines).toContain('device_name: "TeamSpeak Music Bot"');
|
||||
expect(lines).toContain("device_type: computer");
|
||||
expect(lines).toContain("bitrate: 320");
|
||||
expect(lines).toContain("audio_backend: pipe");
|
||||
expect(lines).toContain("audio_output_pipe: /tmp/go-librespot.fifo");
|
||||
expect(lines).toContain("audio_output_pipe_format: s16le");
|
||||
});
|
||||
|
||||
it("emits a server block with enabled/address/port set explicitly", () => {
|
||||
const parsed = parseTinyYaml(renderConfigYml(OPTS));
|
||||
expect(parsed.server).toEqual({
|
||||
enabled: true,
|
||||
address: "0.0.0.0",
|
||||
port: 3678,
|
||||
});
|
||||
});
|
||||
|
||||
it("emits interactive OAuth credentials with the callback port", () => {
|
||||
const parsed = parseTinyYaml(renderConfigYml(OPTS));
|
||||
expect(parsed.credentials).toEqual({
|
||||
type: "interactive",
|
||||
interactive: { callback_port: 8080 },
|
||||
});
|
||||
});
|
||||
|
||||
it("full round-trip reflects every provided option", () => {
|
||||
const parsed = parseTinyYaml(renderConfigYml(OPTS));
|
||||
expect(parsed).toEqual({
|
||||
device_name: "TeamSpeak Music Bot",
|
||||
device_type: "computer",
|
||||
bitrate: 320,
|
||||
audio_backend: "pipe",
|
||||
audio_output_pipe: "/tmp/go-librespot.fifo",
|
||||
audio_output_pipe_format: "s16le",
|
||||
server: { enabled: true, address: "0.0.0.0", port: 3678 },
|
||||
credentials: { type: "interactive", interactive: { callback_port: 8080 } },
|
||||
});
|
||||
});
|
||||
|
||||
it("threads distinct option values through unchanged (no hard-coded ports)", () => {
|
||||
const parsed = parseTinyYaml(
|
||||
renderConfigYml({
|
||||
deviceName: "Other Bot",
|
||||
bitrate: 160,
|
||||
fifoPath: "/run/librespot/pipe",
|
||||
apiAddress: "127.0.0.1",
|
||||
apiPort: 4000,
|
||||
callbackPort: 9099,
|
||||
}),
|
||||
);
|
||||
expect(parsed).toMatchObject({
|
||||
device_name: "Other Bot",
|
||||
bitrate: 160,
|
||||
audio_output_pipe: "/run/librespot/pipe",
|
||||
server: { address: "127.0.0.1", port: 4000 },
|
||||
credentials: { interactive: { callback_port: 9099 } },
|
||||
});
|
||||
});
|
||||
|
||||
it("safely quotes device names containing special characters", () => {
|
||||
const yml = renderConfigYml({ ...OPTS, deviceName: 'My "Cool" Bot' });
|
||||
expect(yml.split("\n")).toContain('device_name: "My \\"Cool\\" Bot"');
|
||||
// and still round-trips back to the original string
|
||||
expect(parseTinyYaml(yml).device_name).toBe('My "Cool" Bot');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,42 @@
|
||||
// src/music/spotify/go-librespot-config.ts
|
||||
// Hand-built go-librespot config.yml. Keys/values verified against
|
||||
// devgianlu/go-librespot cmd/daemon/cli_config.go koanf tags. No yaml
|
||||
// dependency is used; the file is a small, fixed-shape document.
|
||||
|
||||
export interface GoLibrespotConfigOptions {
|
||||
deviceName: string;
|
||||
bitrate: number;
|
||||
fifoPath: string;
|
||||
apiAddress: string;
|
||||
apiPort: number;
|
||||
callbackPort: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a headless go-librespot config.yml:
|
||||
* - pipe audio backend writing raw 44.1kHz/s16le stereo PCM to a FIFO,
|
||||
* - HTTP+WebSocket control server enabled (port has NO built-in default,
|
||||
* so it is always written explicitly),
|
||||
* - interactive OAuth credentials (persisted automatically to
|
||||
* <config_dir>/credentials.json after first login).
|
||||
*/
|
||||
export function renderConfigYml(o: GoLibrespotConfigOptions): string {
|
||||
return (
|
||||
[
|
||||
`device_name: ${JSON.stringify(o.deviceName)}`,
|
||||
`device_type: computer`,
|
||||
`bitrate: ${o.bitrate}`,
|
||||
`audio_backend: pipe`,
|
||||
`audio_output_pipe: ${o.fifoPath}`,
|
||||
`audio_output_pipe_format: s16le`,
|
||||
`server:`,
|
||||
` enabled: true`,
|
||||
` address: ${o.apiAddress}`,
|
||||
` port: ${o.apiPort}`,
|
||||
`credentials:`,
|
||||
` type: interactive`,
|
||||
` interactive:`,
|
||||
` callback_port: ${o.callbackPort}`,
|
||||
].join("\n") + "\n"
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,411 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { EventEmitter } from "node:events";
|
||||
import { PassThrough } from "node:stream";
|
||||
import pino from "pino";
|
||||
import { GoLibrespotBackend } from "./go-librespot.js";
|
||||
|
||||
const log = pino({ level: "silent" });
|
||||
|
||||
/** A minimal stand-in for a spawned ChildProcess with real Readable stdout/stderr. */
|
||||
function makeFakeChild() {
|
||||
const child: any = new EventEmitter();
|
||||
child.stdout = new PassThrough();
|
||||
child.stderr = new PassThrough();
|
||||
child.kill = vi.fn();
|
||||
return child;
|
||||
}
|
||||
|
||||
function makeHarness(portOpts: { apiPort?: number; callbackPort?: number } = {}) {
|
||||
const calls: string[] = [];
|
||||
const ffmpegChild = makeFakeChild();
|
||||
const gliChild = makeFakeChild();
|
||||
|
||||
const spawn = vi.fn((cmd: string, ..._rest: any[]) => {
|
||||
const isGli = cmd.includes("go-librespot");
|
||||
calls.push(`spawn:${isGli ? "go-librespot" : cmd}`);
|
||||
return isGli ? gliChild : ffmpegChild;
|
||||
});
|
||||
const execFileSync = vi.fn((cmd: string) => {
|
||||
calls.push(`exec:${cmd}`);
|
||||
return Buffer.from("");
|
||||
});
|
||||
const writeFileSync = vi.fn(() => calls.push("write:config"));
|
||||
const mkdirSync = vi.fn();
|
||||
const unlinkSync = vi.fn(() => calls.push("unlink:fifo"));
|
||||
const existsSync = vi.fn(() => false);
|
||||
|
||||
const rest = {
|
||||
ping: vi.fn(async () => true),
|
||||
playTrack: vi.fn(async () => {}),
|
||||
pause: vi.fn(async () => {}),
|
||||
resume: vi.fn(async () => {}),
|
||||
stop: vi.fn(async () => {}),
|
||||
seek: vi.fn(async () => {}),
|
||||
getStatus: vi.fn(async () => null),
|
||||
};
|
||||
const events: any = new EventEmitter();
|
||||
events.start = vi.fn(() => calls.push("ws:start"));
|
||||
events.stop = vi.fn();
|
||||
|
||||
const backend = new GoLibrespotBackend({
|
||||
deviceName: "Test Bot",
|
||||
bitrate: 320,
|
||||
workDir: "/tmp/work",
|
||||
configDir: "/tmp/cfg",
|
||||
apiPort: portOpts.apiPort ?? 3678,
|
||||
callbackPort: portOpts.callbackPort,
|
||||
logger: log,
|
||||
deps: {
|
||||
spawn,
|
||||
execFileSync,
|
||||
writeFileSync,
|
||||
mkdirSync,
|
||||
unlinkSync,
|
||||
existsSync,
|
||||
// C1: pin the ffmpeg command so the arg-array/order assertions below stay
|
||||
// stable while production resolves ffmpeg via getFfmpegCommand() (which
|
||||
// falls back to bundled ffmpeg-static when `ffmpeg` isn't on PATH).
|
||||
ffmpegCommand: "ffmpeg",
|
||||
findBinary: () => "/bin/go-librespot",
|
||||
makeRest: () => rest,
|
||||
makeEvents: () => events,
|
||||
sleep: async () => {},
|
||||
pollIntervalMs: 1,
|
||||
pollTimeoutMs: 100,
|
||||
} as any,
|
||||
});
|
||||
|
||||
return { backend, calls, spawn, execFileSync, writeFileSync, existsSync, unlinkSync, rest, events, ffmpegChild, gliChild };
|
||||
}
|
||||
|
||||
describe("GoLibrespotBackend.start", () => {
|
||||
it("creates the FIFO with mkfifo before spawning ffmpeg, and spawns ffmpeg BEFORE go-librespot", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
|
||||
expect(h.execFileSync).toHaveBeenCalledWith("mkfifo", ["/tmp/work/go-librespot.fifo"]);
|
||||
expect(h.writeFileSync).toHaveBeenCalled();
|
||||
|
||||
const mkfifoIdx = h.calls.indexOf("exec:mkfifo");
|
||||
const ffmpegIdx = h.calls.indexOf("spawn:ffmpeg");
|
||||
const gliIdx = h.calls.indexOf("spawn:go-librespot");
|
||||
expect(mkfifoIdx).toBeGreaterThanOrEqual(0);
|
||||
expect(ffmpegIdx).toBeGreaterThan(mkfifoIdx); // ffmpeg attaches to the FIFO first
|
||||
expect(gliIdx).toBeGreaterThan(ffmpegIdx); // then the writer (go-librespot)
|
||||
expect(h.calls.indexOf("ws:start")).toBeGreaterThan(gliIdx); // WS connects last
|
||||
});
|
||||
|
||||
it("passes --config_dir to go-librespot using the resolved binary path", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
expect(h.spawn).toHaveBeenCalledWith(
|
||||
"/bin/go-librespot",
|
||||
["--config_dir", "/tmp/cfg"],
|
||||
expect.anything(),
|
||||
);
|
||||
});
|
||||
|
||||
it("uses the 44100->48000 s16le ffmpeg command reading the FIFO", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
const ffmpegArgs = h.spawn.mock.calls.find((c) => c[0] === "ffmpeg")![1] as string[];
|
||||
expect(ffmpegArgs).toEqual([
|
||||
"-hide_banner", "-loglevel", "error",
|
||||
"-f", "s16le", "-ar", "44100", "-ac", "2", "-i", "/tmp/work/go-librespot.fifo",
|
||||
"-f", "s16le", "-ar", "48000", "-ac", "2", "-acodec", "pcm_s16le", "pipe:1",
|
||||
]);
|
||||
});
|
||||
|
||||
it("emits 'ready' and reports isReady() true once the REST ping succeeds", async () => {
|
||||
const h = makeHarness();
|
||||
const ready = vi.fn();
|
||||
h.backend.on("ready", ready);
|
||||
await h.backend.start();
|
||||
expect(h.rest.ping).toHaveBeenCalled();
|
||||
expect(ready).toHaveBeenCalledTimes(1);
|
||||
expect(h.backend.isReady()).toBe(true);
|
||||
});
|
||||
|
||||
it("keeps polling ping() until it returns true", async () => {
|
||||
const h = makeHarness();
|
||||
h.rest.ping.mockResolvedValueOnce(false).mockResolvedValueOnce(false).mockResolvedValue(true);
|
||||
await h.backend.start();
|
||||
expect(h.rest.ping).toHaveBeenCalledTimes(3);
|
||||
expect(h.backend.isReady()).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend config binding (Fix 1 loopback + Fix 3 ports)", () => {
|
||||
function writtenYml(h: ReturnType<typeof makeHarness>): string {
|
||||
const calls = h.writeFileSync.mock.calls as unknown as any[][];
|
||||
const call = calls.find((c) => String(c[0]).endsWith("config.yml"));
|
||||
expect(call).toBeDefined();
|
||||
return call![1] as string;
|
||||
}
|
||||
|
||||
it("binds the control API to loopback (127.0.0.1), never 0.0.0.0", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
const yml = writtenYml(h);
|
||||
expect(yml).toContain("address: 127.0.0.1");
|
||||
expect(yml).not.toContain("0.0.0.0");
|
||||
});
|
||||
|
||||
it("threads apiPort + callbackPort into the rendered config", async () => {
|
||||
const h = makeHarness({ apiPort: 3712, callbackPort: 8712 });
|
||||
await h.backend.start();
|
||||
const yml = writtenYml(h);
|
||||
expect(yml).toContain("port: 3712");
|
||||
expect(yml).toContain("callback_port: 8712");
|
||||
});
|
||||
|
||||
it("defaults callbackPort to 8080 when unset", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
expect(writtenYml(h)).toContain("callback_port: 8080");
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend WebSocket event mapping", () => {
|
||||
it("maps a not_playing event to trackEnded{reason:'ended'}", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
const ended = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.events.emit("not_playing", { uri: "spotify:track:abc" });
|
||||
expect(ended).toHaveBeenCalledWith({ uri: "spotify:track:abc", reason: "ended" });
|
||||
});
|
||||
|
||||
it("maps a stopped event to trackEnded{reason:'stopped'}", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
const ended = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.events.emit("stopped", { uri: "spotify:track:xyz" });
|
||||
expect(ended).toHaveBeenCalledWith({ uri: "spotify:track:xyz", reason: "stopped" });
|
||||
});
|
||||
|
||||
it("maps a metadata event to a SpotifyNowPlaying and updates getPositionMs()", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
const meta = vi.fn();
|
||||
h.backend.on("metadata", meta);
|
||||
h.events.emit("metadata", {
|
||||
uri: "spotify:track:abc",
|
||||
name: "Song",
|
||||
artist_names: ["A", "B"],
|
||||
album_name: "Alb",
|
||||
album_cover_url: "http://x/y.jpg",
|
||||
position: 1234,
|
||||
duration: 200000,
|
||||
});
|
||||
expect(meta).toHaveBeenCalledWith({
|
||||
uri: "spotify:track:abc",
|
||||
name: "Song",
|
||||
artist: "A, B",
|
||||
album: "Alb",
|
||||
coverUrl: "http://x/y.jpg",
|
||||
durationMs: 200000,
|
||||
});
|
||||
expect(h.backend.getPositionMs()).toBe(1234);
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend transport delegation + PCM", () => {
|
||||
it("playTrack delegates to the REST client", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:go");
|
||||
expect(h.rest.playTrack).toHaveBeenCalledWith("spotify:track:go");
|
||||
});
|
||||
|
||||
it("pause/resume/seek delegate to the REST client and seek updates position", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.pause();
|
||||
await h.backend.resume();
|
||||
await h.backend.seek(5000);
|
||||
expect(h.rest.pause).toHaveBeenCalled();
|
||||
expect(h.rest.resume).toHaveBeenCalled();
|
||||
expect(h.rest.seek).toHaveBeenCalledWith(5000);
|
||||
expect(h.backend.getPositionMs()).toBe(5000);
|
||||
});
|
||||
|
||||
it("getPcmStream() returns the ffmpeg stdout Readable", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
expect(h.backend.getPcmStream()).toBe(h.ffmpegChild.stdout);
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend.stop", () => {
|
||||
it("kills ffmpeg + go-librespot, stops the WS, removes the FIFO, and clears ready", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
h.existsSync.mockReturnValue(true); // FIFO now present, so stop() unlinks it
|
||||
h.backend.stop();
|
||||
expect(h.ffmpegChild.kill).toHaveBeenCalled();
|
||||
expect(h.gliChild.kill).toHaveBeenCalled();
|
||||
expect(h.events.stop).toHaveBeenCalled();
|
||||
expect(h.unlinkSync).toHaveBeenCalledWith("/tmp/work/go-librespot.fifo");
|
||||
expect(h.backend.isReady()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend.start failure cleanup", () => {
|
||||
it("tears down ffmpeg, go-librespot, and the FIFO when readiness polling never succeeds", async () => {
|
||||
const h = makeHarness();
|
||||
// ping() never returns true → waitUntilReady() times out → start() rejects
|
||||
// AFTER both processes were spawned and the FIFO was created.
|
||||
h.rest.ping.mockResolvedValue(false);
|
||||
// FIFO present so the cleanup path unlinks it.
|
||||
h.existsSync.mockReturnValue(true);
|
||||
|
||||
await expect(h.backend.start()).rejects.toThrow(/did not become ready/);
|
||||
|
||||
expect(h.ffmpegChild.kill).toHaveBeenCalled(); // ffmpeg killed on failed startup
|
||||
expect(h.gliChild.kill).toHaveBeenCalled(); // go-librespot killed on failed startup
|
||||
expect(h.unlinkSync).toHaveBeenCalledWith("/tmp/work/go-librespot.fifo"); // FIFO removed
|
||||
expect(h.backend.isReady()).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend child-process error handling", () => {
|
||||
it("does not throw when a child 'error' is emitted with no backend 'error' listener attached", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
// No "error" listener on the backend: an unhandled 'error' event would crash
|
||||
// Node, so the backend must swallow+log it instead of re-emitting.
|
||||
expect(h.backend.listenerCount("error")).toBe(0);
|
||||
expect(() => h.ffmpegChild.emit("error", new Error("ffmpeg boom"))).not.toThrow();
|
||||
expect(() => h.gliChild.emit("error", new Error("gli boom"))).not.toThrow();
|
||||
});
|
||||
|
||||
it("re-emits a child 'error' to an attached backend 'error' listener", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
const onErr = vi.fn();
|
||||
h.backend.on("error", onErr);
|
||||
const err = new Error("ffmpeg boom");
|
||||
h.ffmpegChild.emit("error", err);
|
||||
expect(onErr).toHaveBeenCalledWith(err);
|
||||
});
|
||||
});
|
||||
|
||||
// Let queued microtasks (the async reconnect re-sync) settle.
|
||||
const flush = () => new Promise<void>((r) => setTimeout(r, 0));
|
||||
|
||||
describe("GoLibrespotBackend R4-2: unexpected sidecar exit recovery", () => {
|
||||
it("degrades to trackEnded{reason:'error'}, surfaces 'error', and stops the WS on an UNEXPECTED exit", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:cur"); // sets the current uri
|
||||
|
||||
const ended = vi.fn();
|
||||
const onErr = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.backend.on("error", onErr);
|
||||
|
||||
// Sidecar dies under us (nonzero exit, no stop() from us).
|
||||
h.gliChild.emit("exit", 1, null);
|
||||
|
||||
expect(ended).toHaveBeenCalledWith({ uri: "spotify:track:cur", reason: "error" });
|
||||
expect(onErr).toHaveBeenCalledTimes(1); // controller told -> rebuilds on next ensureStarted
|
||||
expect(h.events.stop).toHaveBeenCalled(); // WS reconnect loop stopped (no dead-port hammer)
|
||||
expect(h.backend.isReady()).toBe(false);
|
||||
});
|
||||
|
||||
it("emits trackEnded BEFORE error so a listener that tears down still receives the skip", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:cur");
|
||||
|
||||
const order: string[] = [];
|
||||
h.backend.on("trackEnded", () => order.push("trackEnded"));
|
||||
h.backend.on("error", () => order.push("error"));
|
||||
h.gliChild.emit("exit", null, "SIGKILL");
|
||||
|
||||
expect(order).toEqual(["trackEnded", "error"]);
|
||||
});
|
||||
|
||||
it("a stop()-initiated exit emits NEITHER trackEnded NOR error", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:cur");
|
||||
|
||||
const ended = vi.fn();
|
||||
const onErr = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.backend.on("error", onErr);
|
||||
|
||||
h.backend.stop(); // intentional teardown -> the ensuing 'exit' must be silent
|
||||
h.gliChild.emit("exit", 0, "SIGTERM");
|
||||
|
||||
expect(ended).not.toHaveBeenCalled();
|
||||
expect(onErr).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("GoLibrespotBackend R4-3: WS reconnect re-sync", () => {
|
||||
const notPlaying = { stopped: true, paused: false, buffering: false, track: null };
|
||||
const stillPlaying = {
|
||||
stopped: false,
|
||||
paused: false,
|
||||
buffering: false,
|
||||
track: {
|
||||
uri: "spotify:track:cur",
|
||||
name: "Song",
|
||||
artist_names: ["A"],
|
||||
album_name: "Alb",
|
||||
album_cover_url: null,
|
||||
position: 1000,
|
||||
duration: 200000,
|
||||
},
|
||||
};
|
||||
|
||||
it("re-queries GET /status on reconnect and emits trackEnded when playback is no longer active", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:cur");
|
||||
h.rest.getStatus.mockResolvedValue(notPlaying as any);
|
||||
|
||||
const ended = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.events.emit("reconnected");
|
||||
await flush();
|
||||
|
||||
expect(h.rest.getStatus).toHaveBeenCalled();
|
||||
expect(ended).toHaveBeenCalledWith({ uri: "spotify:track:cur", reason: "ended" });
|
||||
});
|
||||
|
||||
it("does NOT emit a spurious trackEnded on reconnect when status shows still-playing", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:cur");
|
||||
h.rest.getStatus.mockResolvedValue(stillPlaying as any);
|
||||
|
||||
const ended = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.events.emit("reconnected");
|
||||
await flush();
|
||||
|
||||
expect(h.rest.getStatus).toHaveBeenCalled();
|
||||
expect(ended).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("re-sync is idempotent: a reconnect then a live not_playing emits trackEnded only once", async () => {
|
||||
const h = makeHarness();
|
||||
await h.backend.start();
|
||||
await h.backend.playTrack("spotify:track:cur");
|
||||
h.rest.getStatus.mockResolvedValue(notPlaying as any);
|
||||
|
||||
const ended = vi.fn();
|
||||
h.backend.on("trackEnded", ended);
|
||||
h.events.emit("reconnected");
|
||||
await flush();
|
||||
// A duplicate live event for the same track must not double-advance the queue.
|
||||
h.events.emit("not_playing", { uri: "spotify:track:cur" });
|
||||
|
||||
expect(ended).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,402 @@
|
||||
import { EventEmitter } from "node:events";
|
||||
// The go-librespot sidecar is Linux/Docker-gated (mkfifo + Linux-only binary),
|
||||
// so the FIFO and config-dir paths are ALWAYS POSIX. Use posix.join so the
|
||||
// separators are correct on the Linux target regardless of the host OS.
|
||||
import { posix as posixPath } from "node:path";
|
||||
import type { Readable } from "node:stream";
|
||||
import type { ChildProcess } from "node:child_process";
|
||||
import {
|
||||
execFileSync as realExecFileSync,
|
||||
spawn as realSpawn,
|
||||
} from "node:child_process";
|
||||
import {
|
||||
existsSync as realExistsSync,
|
||||
mkdirSync as realMkdirSync,
|
||||
unlinkSync as realUnlinkSync,
|
||||
writeFileSync as realWriteFileSync,
|
||||
} from "node:fs";
|
||||
import type { Logger } from "pino";
|
||||
import type {
|
||||
SpotifyAudioBackend,
|
||||
SpotifyTrackEndedEvent,
|
||||
SpotifyNowPlaying,
|
||||
} from "./backend.js";
|
||||
import { findGoLibrespot } from "./binary.js";
|
||||
import { renderConfigYml } from "./go-librespot-config.js";
|
||||
import { GoLibrespotRestClient, GoLibrespotEventClient } from "./go-librespot-api.js";
|
||||
import { getFfmpegCommand } from "../../audio/player.js";
|
||||
|
||||
export interface GoLibrespotBackendOptions {
|
||||
deviceName: string;
|
||||
bitrate: number;
|
||||
workDir: string;
|
||||
configDir: string;
|
||||
apiPort?: number;
|
||||
callbackPort?: number;
|
||||
logger: Logger;
|
||||
deps?: GoLibrespotBackendDeps;
|
||||
}
|
||||
|
||||
/** Injectable seams so the whole lifecycle is testable without a real binary/FIFO/network. */
|
||||
export interface GoLibrespotBackendDeps {
|
||||
spawn?: typeof realSpawn;
|
||||
execFileSync?: typeof realExecFileSync;
|
||||
existsSync?: typeof realExistsSync;
|
||||
mkdirSync?: typeof realMkdirSync;
|
||||
unlinkSync?: typeof realUnlinkSync;
|
||||
writeFileSync?: typeof realWriteFileSync;
|
||||
findBinary?: () => string;
|
||||
/**
|
||||
* C1: override the ffmpeg command. Production resolves it via
|
||||
* getFfmpegCommand() (bundled ffmpeg-static fallback when `ffmpeg` isn't on
|
||||
* PATH, the Docker case); tests pin it to "ffmpeg" for stable arg assertions.
|
||||
*/
|
||||
ffmpegCommand?: string;
|
||||
makeRest?: (baseUrl: string) => GoLibrespotRestClient;
|
||||
makeEvents?: (wsUrl: string) => GoLibrespotEventClient;
|
||||
sleep?: (ms: number) => Promise<void>;
|
||||
pollIntervalMs?: number;
|
||||
pollTimeoutMs?: number;
|
||||
}
|
||||
|
||||
const DEFAULT_API_PORT = 3678;
|
||||
const DEFAULT_CALLBACK_PORT = 8080;
|
||||
const FIFO_NAME = "go-librespot.fifo";
|
||||
|
||||
export class GoLibrespotBackend extends EventEmitter implements SpotifyAudioBackend {
|
||||
private readonly opts: GoLibrespotBackendOptions;
|
||||
private readonly log: Logger;
|
||||
private readonly deps: GoLibrespotBackendDeps;
|
||||
private readonly apiPort: number;
|
||||
private readonly callbackPort: number;
|
||||
private readonly fifoPath: string;
|
||||
|
||||
private ffmpeg: ChildProcess | null = null;
|
||||
private proc: ChildProcess | null = null;
|
||||
private rest: GoLibrespotRestClient | null = null;
|
||||
private events: GoLibrespotEventClient | null = null;
|
||||
private ready = false;
|
||||
private positionMs = 0;
|
||||
// R4-2: distinguishes an INTENTIONAL teardown (stop()/failed start()) — where a
|
||||
// sidecar exit is expected and must be silent — from an UNEXPECTED death that
|
||||
// must degrade-to-skip + surface an error so the controller relaunches.
|
||||
private stopping = false;
|
||||
// The uri of the track currently loaded in the sidecar (set by playTrack and
|
||||
// refreshed from metadata). Used as the trackEnded uri on an unexpected death
|
||||
// (R4-2) and on reconnect reconciliation (R4-3).
|
||||
private currentUri = "";
|
||||
// At-most-one trackEnded per track. Set when we emit a track-end, cleared when
|
||||
// a new track begins. Keeps the reconnect re-sync (R4-3) from double-emitting
|
||||
// with a live not_playing/stopped event.
|
||||
private endLatched = false;
|
||||
|
||||
constructor(o: GoLibrespotBackendOptions) {
|
||||
super();
|
||||
this.opts = o;
|
||||
this.log = o.logger;
|
||||
this.deps = o.deps ?? {};
|
||||
this.apiPort = o.apiPort ?? DEFAULT_API_PORT;
|
||||
this.callbackPort = o.callbackPort ?? DEFAULT_CALLBACK_PORT;
|
||||
this.fifoPath = posixPath.join(o.workDir, FIFO_NAME);
|
||||
}
|
||||
|
||||
async start(): Promise<void> {
|
||||
// Fresh lifecycle (also covers a start() after a previous stop() on the same
|
||||
// instance): clear the teardown flag and per-track end state.
|
||||
this.stopping = false;
|
||||
this.currentUri = "";
|
||||
this.endLatched = false;
|
||||
const spawn = this.deps.spawn ?? realSpawn;
|
||||
const execFileSync = this.deps.execFileSync ?? realExecFileSync;
|
||||
const existsSync = this.deps.existsSync ?? realExistsSync;
|
||||
const mkdirSync = this.deps.mkdirSync ?? realMkdirSync;
|
||||
const unlinkSync = this.deps.unlinkSync ?? realUnlinkSync;
|
||||
const writeFileSync = this.deps.writeFileSync ?? realWriteFileSync;
|
||||
const findBinary = this.deps.findBinary ?? findGoLibrespot;
|
||||
// C1: resolve ffmpeg via the repo's getFfmpegCommand() (ffmpeg-static
|
||||
// fallback) unless a command is injected for tests.
|
||||
const ffmpegCommand = this.deps.ffmpegCommand ?? getFfmpegCommand();
|
||||
|
||||
// 1. Ensure work + config directories exist.
|
||||
mkdirSync(this.opts.workDir, { recursive: true });
|
||||
mkdirSync(this.opts.configDir, { recursive: true });
|
||||
|
||||
// 2. (Re)create the FIFO — mkfifo fails if the path already exists.
|
||||
if (existsSync(this.fifoPath)) unlinkSync(this.fifoPath);
|
||||
execFileSync("mkfifo", [this.fifoPath]);
|
||||
|
||||
// Everything past this point spawns processes / opens sockets. If any step
|
||||
// throws (e.g. the readiness poll times out), tear down whatever was already
|
||||
// created via stop() (kill ffmpeg + go-librespot, close WS, remove FIFO) so
|
||||
// we don't leak child processes or leave the FIFO on disk, then rethrow.
|
||||
try {
|
||||
// 3. Spawn ffmpeg FIRST so the PCM reader is attached to the FIFO before
|
||||
// go-librespot (the writer) starts pushing raw 44.1k s16le into it.
|
||||
// Opening the FIFO for writing before a reader exists errors with ENXIO.
|
||||
this.ffmpeg = spawn(
|
||||
ffmpegCommand,
|
||||
[
|
||||
"-hide_banner", "-loglevel", "error",
|
||||
"-f", "s16le", "-ar", "44100", "-ac", "2", "-i", this.fifoPath,
|
||||
"-f", "s16le", "-ar", "48000", "-ac", "2", "-acodec", "pcm_s16le", "pipe:1",
|
||||
],
|
||||
{ stdio: ["ignore", "pipe", "pipe"] },
|
||||
);
|
||||
this.ffmpeg.stderr?.on("data", (b: Buffer) =>
|
||||
this.log.debug({ ffmpeg: b.toString().trim() }, "ffmpeg"),
|
||||
);
|
||||
this.ffmpeg.on("error", (err) => this.emitError(err));
|
||||
|
||||
// 4. Render + write config.yml into the config dir.
|
||||
const yml = renderConfigYml({
|
||||
deviceName: this.opts.deviceName,
|
||||
bitrate: this.opts.bitrate,
|
||||
fifoPath: this.fifoPath,
|
||||
// The go-librespot control API is UNAUTHENTICATED and the client only
|
||||
// ever connects via 127.0.0.1; the sidecar runs in the SAME container
|
||||
// as the bot, so bind to loopback rather than exposing it on 0.0.0.0.
|
||||
apiAddress: "127.0.0.1",
|
||||
apiPort: this.apiPort,
|
||||
callbackPort: this.callbackPort,
|
||||
});
|
||||
writeFileSync(posixPath.join(this.opts.configDir, "config.yml"), yml, "utf8");
|
||||
|
||||
// 5. Spawn go-librespot AFTER ffmpeg is listening on the FIFO. Its stdout/
|
||||
// stderr carry the interactive OAuth URL on first run — surface via logger.
|
||||
const bin = findBinary();
|
||||
this.proc = spawn(bin, ["--config_dir", this.opts.configDir], {
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
});
|
||||
const onLog = (b: Buffer) => this.log.info({ golibrespot: b.toString().trim() }, "go-librespot");
|
||||
this.proc.stdout?.on("data", onLog);
|
||||
this.proc.stderr?.on("data", onLog);
|
||||
this.proc.on("error", (err) => this.emitError(err));
|
||||
this.proc.on("exit", (code, signal) => {
|
||||
this.ready = false;
|
||||
this.log.warn({ code, signal }, "go-librespot exited");
|
||||
// R4-2: a stop()-initiated exit is expected — stay silent. Any other exit
|
||||
// is the sidecar dying under us and must be recovered.
|
||||
if (this.stopping) return;
|
||||
this.onUnexpectedExit(code, signal);
|
||||
});
|
||||
|
||||
// 6. REST client, then poll GET / until the HTTP server answers.
|
||||
const baseUrl = `http://127.0.0.1:${this.apiPort}`;
|
||||
this.rest = this.deps.makeRest
|
||||
? this.deps.makeRest(baseUrl)
|
||||
: new GoLibrespotRestClient(baseUrl);
|
||||
await this.waitUntilReady();
|
||||
|
||||
// 7. Connect the WebSocket event stream and wire event mapping.
|
||||
const wsUrl = `ws://127.0.0.1:${this.apiPort}/events`;
|
||||
this.events = this.deps.makeEvents
|
||||
? this.deps.makeEvents(wsUrl)
|
||||
: new GoLibrespotEventClient(wsUrl);
|
||||
this.wireEvents(this.events);
|
||||
this.events.start();
|
||||
|
||||
this.ready = true;
|
||||
this.emit("ready");
|
||||
} catch (e) {
|
||||
this.stop();
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Re-emit a child-process "error" only when a consumer is listening; Node
|
||||
* throws on an unhandled "error" event (can crash the process), so with no
|
||||
* listener we log via the injected logger instead. Mirrors the WS client's
|
||||
* listenerCount("error") gate in go-librespot-api.ts.
|
||||
*/
|
||||
private emitError(err: unknown): void {
|
||||
if (this.listenerCount("error") > 0) {
|
||||
this.emit("error", err);
|
||||
} else {
|
||||
this.log.error({ err }, "go-librespot backend error (no listener)");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* At-most-one track-end per track. The WS not_playing/stopped events, the
|
||||
* unexpected-death degrade (R4-2) and the reconnect re-sync (R4-3) all funnel
|
||||
* through here so a track can only advance the queue once.
|
||||
*/
|
||||
private emitTrackEnded(e: SpotifyTrackEndedEvent): void {
|
||||
if (this.endLatched) return;
|
||||
this.endLatched = true;
|
||||
this.emit("trackEnded", e);
|
||||
}
|
||||
|
||||
/**
|
||||
* R4-2: the go-librespot sidecar died without a stop() from us. Spotify
|
||||
* auto-advance is driven ONLY by the WS trackEnded event (the player-side stall
|
||||
* watchdog is disabled in external mode), so a silent death would stall the
|
||||
* queue forever. Mirror the Rust I4 degrade-to-skip:
|
||||
* (a) emit trackEnded{reason:"error"} so BotInstance advances the queue;
|
||||
* (b) stop the WS reconnect loop so it stops hammering the now-dead API port;
|
||||
* (c) surface via emitError so the controller tears down + relaunches a fresh
|
||||
* backend on the next ensureStarted().
|
||||
* trackEnded MUST be emitted BEFORE emitError: the controller's error handler
|
||||
* removeAllListeners() on teardown, so a trackEnded emitted after would be lost.
|
||||
*/
|
||||
private onUnexpectedExit(code: number | null, signal: NodeJS.Signals | null): void {
|
||||
// (b) Kill the reconnect loop first — the API port is dead.
|
||||
try {
|
||||
this.events?.stop();
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
this.events = null;
|
||||
// (a) Degrade-to-skip only if a track was actually loaded; a death during
|
||||
// startup with nothing playing has no queue item to advance.
|
||||
if (this.currentUri) {
|
||||
this.emitTrackEnded({ uri: this.currentUri, reason: "error" });
|
||||
}
|
||||
// (c) Surface so the controller rebuilds.
|
||||
this.emitError(
|
||||
new Error(
|
||||
`go-librespot exited unexpectedly (code=${code ?? "null"}, signal=${signal ?? "null"})`,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* R4-3: the WS reconnected after a drop. go-librespot only pushes events (it is
|
||||
* never polled after startup), so a not_playing/stopped emitted during the
|
||||
* down window is lost and the queue would stall. Re-query GET /status and, if
|
||||
* playback is no longer active (the track ended in the gap), emit trackEnded so
|
||||
* the queue advances. Idempotent via the end-latch (no double-emit with a live
|
||||
* event). Only fired on a real reconnect — never the initial connect.
|
||||
*/
|
||||
private async reconcileAfterReconnect(): Promise<void> {
|
||||
const rest = this.rest;
|
||||
if (!rest) return;
|
||||
const status = await rest.getStatus();
|
||||
// Couldn't read status — don't guess a track-end.
|
||||
if (!status) return;
|
||||
const active = status.track != null && !status.stopped;
|
||||
if (!active) {
|
||||
this.emitTrackEnded({ uri: this.currentUri, reason: "ended" });
|
||||
}
|
||||
}
|
||||
|
||||
private async waitUntilReady(): Promise<void> {
|
||||
const sleep = this.deps.sleep ?? ((ms: number) => new Promise<void>((r) => setTimeout(r, ms)));
|
||||
const interval = this.deps.pollIntervalMs ?? 200;
|
||||
const timeout = this.deps.pollTimeoutMs ?? 15_000;
|
||||
const deadline = Date.now() + timeout;
|
||||
while (Date.now() < deadline) {
|
||||
if (this.rest && (await this.rest.ping())) return;
|
||||
await sleep(interval);
|
||||
}
|
||||
throw new Error("go-librespot API did not become ready within timeout");
|
||||
}
|
||||
|
||||
private wireEvents(ev: GoLibrespotEventClient): void {
|
||||
ev.on("metadata", (d: any) => {
|
||||
const np: SpotifyNowPlaying = {
|
||||
uri: typeof d?.uri === "string" ? d.uri : "",
|
||||
name: typeof d?.name === "string" ? d.name : "",
|
||||
artist: Array.isArray(d?.artist_names) ? d.artist_names.join(", ") : "",
|
||||
album: typeof d?.album_name === "string" ? d.album_name : "",
|
||||
coverUrl: typeof d?.album_cover_url === "string" ? d.album_cover_url : "",
|
||||
durationMs: typeof d?.duration === "number" ? d.duration : 0,
|
||||
};
|
||||
if (typeof d?.position === "number") this.positionMs = d.position;
|
||||
// A new track is now playing: remember it (for R4-2/R4-3) and clear the
|
||||
// per-track end-latch so its eventual end can advance the queue.
|
||||
if (np.uri && np.uri !== this.currentUri) {
|
||||
this.currentUri = np.uri;
|
||||
this.endLatched = false;
|
||||
}
|
||||
this.emit("metadata", np);
|
||||
});
|
||||
ev.on("seek", (d: any) => {
|
||||
if (typeof d?.position === "number") this.positionMs = d.position;
|
||||
});
|
||||
ev.on("not_playing", (d: any) => {
|
||||
this.emitTrackEnded({ uri: typeof d?.uri === "string" ? d.uri : "", reason: "ended" });
|
||||
});
|
||||
ev.on("stopped", (d: any) => {
|
||||
this.emitTrackEnded({ uri: typeof d?.uri === "string" ? d.uri : "", reason: "stopped" });
|
||||
});
|
||||
// R4-3: reconcile any track-end missed while the WS was down.
|
||||
ev.on("reconnected", () => {
|
||||
void this.reconcileAfterReconnect();
|
||||
});
|
||||
}
|
||||
|
||||
isReady(): boolean {
|
||||
return this.ready;
|
||||
}
|
||||
|
||||
async playTrack(uri: string): Promise<void> {
|
||||
if (!this.rest) throw new Error("go-librespot backend not started");
|
||||
// Track what is loaded so an unexpected death (R4-2) / reconnect re-sync
|
||||
// (R4-3) can advance the queue for the right uri, and reset the end-latch.
|
||||
this.currentUri = uri;
|
||||
this.endLatched = false;
|
||||
await this.rest.playTrack(uri);
|
||||
}
|
||||
|
||||
async pause(): Promise<void> {
|
||||
if (this.rest) await this.rest.pause();
|
||||
}
|
||||
|
||||
async resume(): Promise<void> {
|
||||
if (this.rest) await this.rest.resume();
|
||||
}
|
||||
|
||||
async seek(ms: number): Promise<void> {
|
||||
if (this.rest) await this.rest.seek(ms);
|
||||
this.positionMs = ms;
|
||||
}
|
||||
|
||||
getPcmStream(): Readable {
|
||||
const out = this.ffmpeg?.stdout;
|
||||
if (!out) throw new Error("PCM stream unavailable (go-librespot backend not started)");
|
||||
return out;
|
||||
}
|
||||
|
||||
getPositionMs(): number {
|
||||
return this.positionMs;
|
||||
}
|
||||
|
||||
stop(): void {
|
||||
// R4-2: mark this an INTENTIONAL teardown so the go-librespot 'exit' handler
|
||||
// (fired by the SIGTERM below) stays silent instead of degrading-to-skip.
|
||||
this.stopping = true;
|
||||
this.ready = false;
|
||||
try {
|
||||
this.events?.stop();
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
this.events = null;
|
||||
this.rest = null;
|
||||
if (this.proc) {
|
||||
try {
|
||||
this.proc.kill("SIGTERM");
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
this.proc = null;
|
||||
}
|
||||
if (this.ffmpeg) {
|
||||
try {
|
||||
this.ffmpeg.kill("SIGTERM");
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
this.ffmpeg = null;
|
||||
}
|
||||
const existsSync = this.deps.existsSync ?? realExistsSync;
|
||||
const unlinkSync = this.deps.unlinkSync ?? realUnlinkSync;
|
||||
try {
|
||||
if (existsSync(this.fifoPath)) unlinkSync(this.fifoPath);
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 188 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user