mirror of
https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
synced 2026-10-02 21:12:49 +08:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Claude
|
f8a5dfdf09 |
No files matched your search
@@ -13,12 +13,11 @@
|
|||||||
"mcp__Claude_Preview__*",
|
"mcp__Claude_Preview__*",
|
||||||
"mcp__Claude_in_Chrome__*",
|
"mcp__Claude_in_Chrome__*",
|
||||||
"mcp__scheduled-tasks__*",
|
"mcp__scheduled-tasks__*",
|
||||||
"Bash(npx vitest:*)",
|
"Bash(npx vitest:*)"
|
||||||
"Bash(cp \"C:\\\\Users\\\\saopig1\\\\.claude\\\\projects\\\\C--Users-saopig1-Music-teamspeak-music-bot\\\\b5a64d6f-051e-4b87-966c-ece97d2b879b\\\\tool-results\\\\webfetch-1776569008470-exv7qe.bin\" /tmp/design.gz)",
|
|
||||||
"Bash(gunzip -f /tmp/design.gz)",
|
|
||||||
"Read(//tmp/**)"
|
|
||||||
],
|
],
|
||||||
"deny": [
|
"deny": [
|
||||||
|
"Bash(git push * main)",
|
||||||
|
"Bash(git push * master)",
|
||||||
"Bash(git push --force *)",
|
"Bash(git push --force *)",
|
||||||
"Bash(rm -rf /)"
|
"Bash(rm -rf /)"
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -1,64 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -6,6 +6,3 @@ dist/
|
|||||||
config.json
|
config.json
|
||||||
cookies/
|
cookies/
|
||||||
.superpowers/
|
.superpowers/
|
||||||
.worktrees/
|
|
||||||
/bin/
|
|
||||||
scripts/navbar_bigger.png
|
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://img.shields.io/badge/TeamSpeak-音乐机器人-blue?style=for-the-badge&logo=teamspeak" alt="TSMusicBot" />
|
<img src="https://img.shields.io/badge/TeamSpeak_3-音乐机器人-blue?style=for-the-badge&logo=teamspeak" alt="TSMusicBot" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h1 align="center">TSMusicBot</h1>
|
<h1 align="center">TSMusicBot</h1>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<strong>TeamSpeak 音乐机器人</strong> — 网易云音乐 + QQ 音乐 + 哔哩哔哩 + YouTube（可选），YesPlayMusic 风格 WebUI 控制面板
|
<strong>TeamSpeak 3 音乐机器人</strong> — 网易云音乐 + QQ 音乐 + 哔哩哔哩 三平台，YesPlayMusic 风格 WebUI 控制面板
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@@ -16,16 +16,14 @@
|
|||||||
<img src="https://img.shields.io/badge/FFmpeg-已内置-orange?logo=ffmpeg" />
|
<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/Docker-支持-2496ED?logo=docker&logoColor=white" />
|
||||||
<img src="https://img.shields.io/badge/BiliBili-支持-00a1d6?logo=bilibili&logoColor=white" />
|
<img src="https://img.shields.io/badge/BiliBili-支持-00a1d6?logo=bilibili&logoColor=white" />
|
||||||
<img src="https://img.shields.io/badge/YouTube-可选-FF0000?logo=youtube&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>
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 功能特性
|
## 功能特性
|
||||||
|
|
||||||
- **WebUI 鉴权（必选）** — 用户名 + 密码登录，多用户、两种角色（管理员 / 成员），bcrypt 加密、HttpOnly 会话 Cookie，CSRF 防护，WebSocket 同样鉴权。首次访问引导创建管理员。从无鉴权旧版本升级时请参阅 [更新升级](#更新升级) 章节
|
- **三平台音源** — 网易云音乐 + QQ 音乐 + 哔哩哔哩，统一搜索，结果标注来源
|
||||||
- **多平台音源** — 网易云音乐 + QQ 音乐 + 哔哩哔哩（默认内置），YouTube 可选启用（通过 yt-dlp），统一搜索，结果标注来源
|
- **真实 TS3 客户端协议** — 机器人在 TeamSpeak 中可见（非 ServerQuery 隐身模式），兼容 TS3/TS5/TS6 服务器
|
||||||
- **真实客户端协议 (TS3/TS6 双协议)** — 机器人在 TeamSpeak 中可见（非 ServerQuery 隐身模式），自动检测并适配 TS3 和 TS6 服务器，支持 TS6 HTTP Query API
|
|
||||||
- **YesPlayMusic 风格 WebUI** — 精美界面，支持深色/浅色主题切换
|
- **YesPlayMusic 风格 WebUI** — 精美界面，支持深色/浅色主题切换
|
||||||
- **完整播放控制** — 播放/暂停/上一首/下一首/进度跳转/音量调节
|
- **完整播放控制** — 播放/暂停/上一首/下一首/进度跳转/音量调节
|
||||||
- **四种播放模式** — 顺序播放/循环播放/随机播放/随机循环
|
- **四种播放模式** — 顺序播放/循环播放/随机播放/随机循环
|
||||||
@@ -35,7 +33,6 @@
|
|||||||
- **B站视频音频提取** — 搜索B站视频，自动提取DASH最高码率音频流播放
|
- **B站视频音频提取** — 搜索B站视频，自动提取DASH最高码率音频流播放
|
||||||
- **B站热门推荐** — 首页展示B站热门视频和个性化推荐（登录后更准确）
|
- **B站热门推荐** — 首页展示B站热门视频和个性化推荐（登录后更准确）
|
||||||
- **QR码登录** — 扫码登录网易云/QQ音乐/哔哩哔哩账号，Cookie 自动持久化
|
- **QR码登录** — 扫码登录网易云/QQ音乐/哔哩哔哩账号，Cookie 自动持久化
|
||||||
- **机器人形象自动更新** — 播放时自动更新头像（专辑封面）、昵称（当前歌曲）、描述、Away 状态、频道描述，停止时恢复默认值。每项功能独立可配置，权限不足时自动降级
|
|
||||||
- **多机器人独立播放** — 多个机器人同时在不同服务器或频道播放不同音乐，每个机器人独立的播放队列、进度和音量，WebUI 一键切换控制
|
- **多机器人独立播放** — 多个机器人同时在不同服务器或频道播放不同音乐，每个机器人独立的播放队列、进度和音量，WebUI 一键切换控制
|
||||||
- **播放历史** — 自动记录所有播放过的歌曲
|
- **播放历史** — 自动记录所有播放过的歌曲
|
||||||
- **懒加载机制** — 歌单只存储元数据，播放时才获取链接（避免链接过期）
|
- **懒加载机制** — 歌单只存储元数据，播放时才获取链接（避免链接过期）
|
||||||
@@ -43,8 +40,7 @@
|
|||||||
|
|
||||||
## 截图
|
## 截图
|
||||||
|
|
||||||
> <img width="2568" height="1408" alt="musicbot1" src="https://github.com/user-attachments/assets/47ba4f62-fae3-4c17-a7f7-b53f00885672" />
|
> *截图即将添加*
|
||||||
> <img width="2568" height="1408" alt="musicbot2" src="https://github.com/user-attachments/assets/42f4bef7-d41b-49e3-8c13-b4ce6c822dba" />
|
|
||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
@@ -68,8 +64,8 @@ FFmpeg **已自动内置**，无需手动安装。
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 下载项目
|
# 下载项目
|
||||||
git clone https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
|
git clone https://github.com/ZHANGTIANYAO1/tsmusicbot.git
|
||||||
cd teamspeak-music-bot
|
cd tsmusicbot
|
||||||
|
|
||||||
# 安装依赖
|
# 安装依赖
|
||||||
npm install
|
npm install
|
||||||
@@ -89,8 +85,8 @@ npm start
|
|||||||
所有依赖已内置（Node.js、FFmpeg、Opus 编码器），无需安装任何额外软件。
|
所有依赖已内置（Node.js、FFmpeg、Opus 编码器），无需安装任何额外软件。
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
|
git clone https://github.com/ZHANGTIANYAO1/tsmusicbot.git
|
||||||
cd teamspeak-music-bot/scripts/docker
|
cd tsmusicbot/scripts/docker
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -128,153 +124,14 @@ sudo ./scripts/install.sh
|
|||||||
|
|
||||||
自动安装 Node.js 和依赖，配置 systemd 服务，支持开机自启。
|
自动安装 Node.js 和依赖，配置 systemd 服务，支持开机自启。
|
||||||
|
|
||||||
## 更新升级
|
|
||||||
|
|
||||||
> **⚠️ 从使用 `@honeybbq/teamspeak-client 0.1.x` 的旧版本升级时的重要变更**
|
|
||||||
>
|
|
||||||
> 本项目已将底层 TeamSpeak 协议库升级到 `0.2.x` 并移除了内置的 TS6 兼容层，改用库自带的通用 `clientinit` 协议。这涉及一次**数据库迁移**：
|
|
||||||
>
|
|
||||||
> **旧的身份（identity）不兼容新的加密握手路径。** `0.1.0` 版本的库在生成 TS 客户端身份时存在 P-256 公钥 DER 编码错误，该 bug 在 `0.1.1` 中由本项目维护者 [ZHANGTIANYAO1](https://github.com/HoneyBBQ/teamspeak-js/pull/5) 修复并合并到上游。`0.1.0` 生成的身份与 `0.2.x` 修复后的握手路径**不兼容**：升级后用旧身份连接会卡在 `received initivexpand2` 直到 15 秒超时。
|
|
||||||
>
|
|
||||||
> **解决办法**：升级后清空受影响机器人的 `identity` 字段，下次启动时程序会自动生成新身份并持久化。
|
|
||||||
>
|
|
||||||
> ```bash
|
|
||||||
> # 对每个需要迁移的机器人执行（替换 <bot-id> 为实际 UUID）：
|
|
||||||
> python -c "import sqlite3; db=sqlite3.connect('data/tsmusicbot.db'); \
|
|
||||||
> db.execute(\"UPDATE bot_instances SET identity=NULL WHERE id='<bot-id>'\"); \
|
|
||||||
> db.commit()"
|
|
||||||
>
|
|
||||||
> # 或者清空所有机器人的身份：
|
|
||||||
> python -c "import sqlite3; db=sqlite3.connect('data/tsmusicbot.db'); \
|
|
||||||
> db.execute('UPDATE bot_instances SET identity=NULL'); db.commit()"
|
|
||||||
> ```
|
|
||||||
>
|
|
||||||
> **影响范围**：
|
|
||||||
> - ✅ TS3 服务器 + 旧身份：在多数情况下仍可正常工作（TS3 对 legacy 编码更宽容），可选择不清空
|
|
||||||
> - ❌ TS6 服务器 + 旧身份：**必须**清空身份才能连接
|
|
||||||
> - ⚠️ 清空身份后，TS 服务器会把机器人识别为**全新的客户端**。之前手动赋予机器人的**服务器组需要用新 UID 重新授予一次**，之后每次重启都会自动保留
|
|
||||||
>
|
|
||||||
> **如何判断是否需要迁移**：如果你是全新安装，或者你的机器人数据库中 `identity` 字段已经是空的，则**无需任何操作**。完成上述步骤后，按下面对应的系统升级步骤执行即可。
|
|
||||||
|
|
||||||
### 从 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`：除"用户管理"和"操作审计"外的所有功能（适合给团队成员开通播放权）。
|
|
||||||
- 在 **设置 → 用户管理**（仅管理员）中添加 / 删除 / 重置密码 / 切换角色。
|
|
||||||
- 至少保留一个管理员：系统会阻止删除或降级最后一位管理员。
|
|
||||||
|
|
||||||
**如何重置忘记的管理员密码**：
|
|
||||||
|
|
||||||
如果你忘记了管理员密码，可以直接编辑 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.adminPassword` / `adminGroups`**：这两个配置项在旧版本中预留但从未实际启用（TS-side admin 命令权限的占位字段）。保留以避免破坏旧 `config.json`，但不再影响任何行为。可以放心忽略。
|
|
||||||
|
|
||||||
### Windows 用户
|
|
||||||
|
|
||||||
```
|
|
||||||
1. 双击 scripts\stop.bat 停止运行中的机器人（或手动关闭窗口）
|
|
||||||
2. 在项目目录打开命令行，执行 git pull
|
|
||||||
3. 双击 scripts\setup.bat 重新安装依赖并构建
|
|
||||||
4. 双击 scripts\start.bat 启动
|
|
||||||
```
|
|
||||||
|
|
||||||
### 手动安装用户（所有系统）
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 停止当前运行的机器人（Ctrl+C 或 kill 进程）
|
|
||||||
|
|
||||||
# 拉取最新代码
|
|
||||||
git pull
|
|
||||||
|
|
||||||
# 重新安装依赖（如有新增依赖）
|
|
||||||
npm install
|
|
||||||
cd web && npm install && cd ..
|
|
||||||
|
|
||||||
# 重新构建
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
# 启动
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docker 用户
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd scripts/docker
|
|
||||||
|
|
||||||
# 拉取最新代码
|
|
||||||
git pull
|
|
||||||
|
|
||||||
# 重新构建并启动（数据自动保留）
|
|
||||||
docker-compose up -d --build
|
|
||||||
```
|
|
||||||
|
|
||||||
> 数据（数据库、Cookie、日志）保存在 Docker 命名卷 `tsmusicbot-data` 中，更新不会丢失。
|
|
||||||
|
|
||||||
### Linux systemd 用户
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 停止服务
|
|
||||||
sudo systemctl stop tsmusicbot
|
|
||||||
|
|
||||||
# 拉取最新代码
|
|
||||||
git pull
|
|
||||||
|
|
||||||
# 重新安装依赖并构建
|
|
||||||
npm install
|
|
||||||
cd web && npm install && cd ..
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
# 重新启动服务
|
|
||||||
sudo systemctl start tsmusicbot
|
|
||||||
```
|
|
||||||
|
|
||||||
> **提示：** 更新不会影响你的 `config.json` 配置文件、数据库和登录 Cookie，所有数据会自动保留。但请注意本节开头关于 **身份迁移** 的警告——从 0.1.x 版本升级时需要手动清空旧身份。
|
|
||||||
|
|
||||||
## 使用说明
|
## 使用说明
|
||||||
|
|
||||||
### 首次配置
|
### 首次配置
|
||||||
|
|
||||||
1. 启动机器人后打开 **http://localhost:3000/**
|
1. 打开 **http://localhost:3000/setup** 进入设置向导
|
||||||
- 全新部署：自动跳转 `/first-run`，填写用户名（3-32 字符）和密码（≥8 位）创建首位**管理员**账号
|
2. 填写 TeamSpeak 服务器地址（默认端口：9987）
|
||||||
- 之后所有 WebUI 操作都需要登录，登录态保持 7 天（活动会滚动续期）
|
3. 设置机器人昵称
|
||||||
2. 在 **设置 → 机器人管理** 中点击"创建新实例"，填写：
|
4. （可选）扫码登录网易云/QQ音乐账号以播放 VIP 歌曲
|
||||||
- TeamSpeak 服务器地址（无端口，仅主机名，例如 `ts.example.com`）
|
|
||||||
- 端口（默认 9987，自托管或非标准端口请填写实际值）
|
|
||||||
- 机器人昵称
|
|
||||||
- 可选：服务器密码、默认频道
|
|
||||||
3. 在 **设置 → 音乐账号** 扫码登录网易云 / QQ 音乐 / B 站账号（可选，登录后可播放 VIP 歌曲）
|
|
||||||
4. 在 **设置 → 用户管理**（仅管理员可见）按需添加成员，成员账号可以控制播放但无法管理其他用户
|
|
||||||
|
|
||||||
### WebUI 页面说明
|
### WebUI 页面说明
|
||||||
|
|
||||||
@@ -285,7 +142,7 @@ sudo systemctl start tsmusicbot
|
|||||||
| **歌单** | 查看歌单详情，播放全部（根据当前播放模式选择首歌） |
|
| **歌单** | 查看歌单详情，播放全部（根据当前播放模式选择首歌） |
|
||||||
| **歌词** | 全屏歌词页，实时同步滚动，模糊专辑封面背景 |
|
| **歌词** | 全屏歌词页，实时同步滚动，模糊专辑封面背景 |
|
||||||
| **历史** | 播放历史记录 |
|
| **历史** | 播放历史记录 |
|
||||||
| **设置** | 账户（修改自己密码） / 主题切换 / 机器人管理 / 三平台账号登录 / 音质选择 / 命令前缀 / 用户管理（仅管理员）/ 操作审计（仅管理员） |
|
| **设置** | 主题切换、机器人管理、三平台账号登录、音质选择、命令前缀 |
|
||||||
|
|
||||||
### TeamSpeak 文字命令
|
### TeamSpeak 文字命令
|
||||||
|
|
||||||
@@ -296,20 +153,16 @@ sudo systemctl start tsmusicbot
|
|||||||
| `!play <歌名>` | 搜索并播放 |
|
| `!play <歌名>` | 搜索并播放 |
|
||||||
| `!play -q <歌名>` | 从 QQ 音乐搜索 |
|
| `!play -q <歌名>` | 从 QQ 音乐搜索 |
|
||||||
| `!play -b <关键词>` | 从哔哩哔哩搜索视频并播放音频 |
|
| `!play -b <关键词>` | 从哔哩哔哩搜索视频并播放音频 |
|
||||||
| `!play -y <关键词>` | 从 YouTube 搜索并播放（需要安装 [yt-dlp](#可选youtube-音源)）|
|
|
||||||
| `!add <歌名>` | 添加到播放队列 |
|
| `!add <歌名>` | 添加到播放队列 |
|
||||||
| `!pause` / `!resume` | 暂停 / 恢复播放 |
|
| `!pause` / `!resume` | 暂停 / 恢复播放 |
|
||||||
| `!next` / `!prev` | 下一首 / 上一首 |
|
| `!next` / `!prev` | 下一首 / 上一首 |
|
||||||
| `!stop` | 停止播放并清空队列 |
|
| `!stop` | 停止播放并清空队列 |
|
||||||
| `!vol <0-100>` | 设置音量 |
|
| `!vol <0-100>` | 设置音量 |
|
||||||
| `!queue` | 查看播放队列 |
|
| `!queue` | 查看播放队列 |
|
||||||
| `!remove <位置>` | 从队列中删除指定位置的歌曲（位置从 1 开始，见 `!queue`） |
|
|
||||||
| `!mode <seq\|loop\|random\|rloop>` | 切换播放模式 |
|
| `!mode <seq\|loop\|random\|rloop>` | 切换播放模式 |
|
||||||
| `!playlist <歌单名或ID>` | 加载歌单（支持名称模糊搜索和 ID） |
|
| `!playlist <ID>` | 加载歌单 |
|
||||||
| `!playlist -q <歌单名>` | 从 QQ 音乐搜索并加载歌单 |
|
|
||||||
| `!album <ID>` | 加载专辑 |
|
| `!album <ID>` | 加载专辑 |
|
||||||
| `!artist <歌手名>` | 按歌手循环播放（支持 `-q`/`-b`/`-y`） |
|
| `!fm` | 私人 FM（网易云） |
|
||||||
| `!fm` | 私人 FM（网易云，自动续播） |
|
|
||||||
| `!lyrics` | 显示当前歌词 |
|
| `!lyrics` | 显示当前歌词 |
|
||||||
| `!now` | 当前播放信息 |
|
| `!now` | 当前播放信息 |
|
||||||
| `!vote` | 投票跳过当前歌曲 |
|
| `!vote` | 投票跳过当前歌曲 |
|
||||||
@@ -334,7 +187,7 @@ sudo systemctl start tsmusicbot
|
|||||||
## 项目架构
|
## 项目架构
|
||||||
|
|
||||||
```
|
```
|
||||||
teamspeak-music-bot/
|
tsmusicbot/
|
||||||
├── src/ # 后端源码 (TypeScript)
|
├── src/ # 后端源码 (TypeScript)
|
||||||
│ ├── audio/ # 音频管线：FFmpeg → PCM → Opus → 20ms 帧
|
│ ├── audio/ # 音频管线：FFmpeg → PCM → Opus → 20ms 帧
|
||||||
│ │ ├── encoder.ts # Opus 编码器 (@discordjs/opus)
|
│ │ ├── encoder.ts # Opus 编码器 (@discordjs/opus)
|
||||||
@@ -343,8 +196,7 @@ teamspeak-music-bot/
|
|||||||
│ ├── bot/ # 机器人核心
|
│ ├── bot/ # 机器人核心
|
||||||
│ │ ├── commands.ts # 文字命令解析器（前缀、别名、权限）
|
│ │ ├── commands.ts # 文字命令解析器（前缀、别名、权限）
|
||||||
│ │ ├── instance.ts # Bot 实例（绑定 TS3 + 播放器 + 音源）
|
│ │ ├── instance.ts # Bot 实例（绑定 TS3 + 播放器 + 音源）
|
||||||
│ │ ├── manager.ts # 多实例生命周期管理
|
│ │ └── manager.ts # 多实例生命周期管理
|
||||||
│ │ └── profile.ts # 机器人形象管理（头像/昵称/描述/Away/频道描述）
|
|
||||||
│ ├── data/ # 数据层
|
│ ├── data/ # 数据层
|
||||||
│ │ ├── config.ts # JSON 配置文件
|
│ │ ├── config.ts # JSON 配置文件
|
||||||
│ │ └── database.ts # SQLite 数据库（播放历史、实例持久化）
|
│ │ └── database.ts # SQLite 数据库（播放历史、实例持久化）
|
||||||
@@ -353,14 +205,10 @@ teamspeak-music-bot/
|
|||||||
│ │ ├── netease.ts # 网易云音乐适配器
|
│ │ ├── netease.ts # 网易云音乐适配器
|
||||||
│ │ ├── qq.ts # QQ 音乐适配器
|
│ │ ├── qq.ts # QQ 音乐适配器
|
||||||
│ │ ├── bilibili.ts # 哔哩哔哩适配器（视频音频提取）
|
│ │ ├── bilibili.ts # 哔哩哔哩适配器（视频音频提取）
|
||||||
│ │ ├── youtube.ts # YouTube 适配器（可选，依赖 yt-dlp）
|
|
||||||
│ │ ├── auth.ts # Cookie 持久化存储
|
│ │ ├── auth.ts # Cookie 持久化存储
|
||||||
│ │ └── api-server.ts # 嵌入式 API 服务（自动启动）
|
│ │ └── api-server.ts # 嵌入式 API 服务（自动启动）
|
||||||
│ ├── ts-protocol/ # TeamSpeak 客户端协议（TS3/TS6 双协议）
|
│ ├── ts-protocol/ # TS3 客户端协议
|
||||||
│ │ ├── client.ts # 完整客户端（ECDH + AES-EAX 加密协议）
|
│ │ └── client.ts # 完整客户端（ECDH + AES-EAX 加密协议）
|
||||||
│ │ ├── protocol-detect.ts # 服务器协议自动检测（TS3 vs TS6）
|
|
||||||
│ │ ├── http-query.ts # TS6 HTTP Query 客户端（替代 TS3 ServerQuery）
|
|
||||||
│ │ └── ts6-compat.ts # TS6 兼容中间件（版本升级 + 签名）
|
|
||||||
│ ├── web/ # Web 后端
|
│ ├── web/ # Web 后端
|
||||||
│ │ ├── server.ts # Express + WebSocket 服务
|
│ │ ├── server.ts # Express + WebSocket 服务
|
||||||
│ │ ├── websocket.ts # 实时状态广播
|
│ │ ├── websocket.ts # 实时状态广播
|
||||||
@@ -398,7 +246,7 @@ teamspeak-music-bot/
|
|||||||
| **后端框架** | Express 4, WebSocket (ws) |
|
| **后端框架** | Express 4, WebSocket (ws) |
|
||||||
| **数据库** | better-sqlite3 (SQLite) |
|
| **数据库** | better-sqlite3 (SQLite) |
|
||||||
| **音频处理** | FFmpeg (ffmpeg-static 内置), @discordjs/opus |
|
| **音频处理** | FFmpeg (ffmpeg-static 内置), @discordjs/opus |
|
||||||
| **TS 协议** | @honeybbq/teamspeak-client（完整客户端协议）+ 自研 TS6 协议适配层 |
|
| **TS 协议** | @honeybbq/teamspeak-client（完整客户端协议，兼容 TS3/TS5/TS6） |
|
||||||
| **网易云 API** | NeteaseCloudMusicApi |
|
| **网易云 API** | NeteaseCloudMusicApi |
|
||||||
| **QQ 音乐 API** | @sansenjian/qq-music-api |
|
| **QQ 音乐 API** | @sansenjian/qq-music-api |
|
||||||
| **哔哩哔哩** | BiliBili Web API（搜索、DASH 音频流、QR 登录） |
|
| **哔哩哔哩** | BiliBili Web API（搜索、DASH 音频流、QR 登录） |
|
||||||
@@ -407,55 +255,6 @@ teamspeak-music-bot/
|
|||||||
| **图标** | @iconify/vue |
|
| **图标** | @iconify/vue |
|
||||||
| **日志** | pino |
|
| **日志** | pino |
|
||||||
|
|
||||||
## 可选：YouTube 音源
|
|
||||||
|
|
||||||
YouTube 是**可选**的音源，默认**未启用**，需要安装 [yt-dlp](https://github.com/yt-dlp/yt-dlp) 才能使用。启用后可通过聊天命令 `!play -y <关键词>` 或 WebUI 的 YouTube 平台选项搜索/播放 YouTube 视频的音频流。
|
|
||||||
|
|
||||||
### 启用方式（任选其一）
|
|
||||||
|
|
||||||
**方式一：项目本地 `bin/` 目录（推荐）**
|
|
||||||
|
|
||||||
将 `yt-dlp` 可执行文件放到项目根目录下的 `bin/` 文件夹，程序会优先使用此路径。该目录已被 `.gitignore` 忽略，不会影响代码更新。
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Windows（PowerShell 或 Git Bash）
|
|
||||||
mkdir bin
|
|
||||||
curl -L -o bin/yt-dlp.exe https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe
|
|
||||||
|
|
||||||
# Linux / macOS
|
|
||||||
mkdir -p bin
|
|
||||||
curl -L -o bin/yt-dlp https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp
|
|
||||||
chmod +x bin/yt-dlp
|
|
||||||
```
|
|
||||||
|
|
||||||
**方式二：系统级安装（让 `yt-dlp` 在 `PATH` 中可用）**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Windows
|
|
||||||
winget install yt-dlp
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
brew install yt-dlp
|
|
||||||
|
|
||||||
# Debian/Ubuntu
|
|
||||||
sudo apt install yt-dlp
|
|
||||||
|
|
||||||
# 通用（Python 环境下）
|
|
||||||
pip install -U yt-dlp
|
|
||||||
```
|
|
||||||
|
|
||||||
### 验证是否可用
|
|
||||||
|
|
||||||
重启机器人程序，在 WebUI 或 `!play -y lofi` 测试搜索。若 `bin/` 和 `PATH` 中都找不到 `yt-dlp`，YouTube 搜索会静默返回空结果（不会影响其他音源），其余功能正常。
|
|
||||||
|
|
||||||
### 注意事项
|
|
||||||
|
|
||||||
- YouTube 音源通过 `yt-dlp` 本地调用实现，不依赖 API Key，也无需登录
|
|
||||||
- 播放的是视频的最佳音频流（`bestaudio[ext=webm]/bestaudio[ext=m4a]/bestaudio`），由 FFmpeg 解码
|
|
||||||
- 音质由源视频决定，不受音质设置影响
|
|
||||||
- 受 YouTube 风控/地域限制，部分视频可能无法播放
|
|
||||||
- `yt-dlp` 更新较频繁，如果播放失败，先尝试升级 `yt-dlp` 到最新版本
|
|
||||||
|
|
||||||
## 配置文件
|
## 配置文件
|
||||||
|
|
||||||
`config.json` 在首次运行时自动生成，可手动编辑：
|
`config.json` 在首次运行时自动生成，可手动编辑：
|
||||||
@@ -476,23 +275,8 @@ pip install -U yt-dlp
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
> **关于 `adminPassword` 和 `adminGroups`**：这两个字段保留是为了兼容旧 `config.json`，但当前版本未使用。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 吗？**
|
|
||||||
A：支持。本项目内置 TS3/TS6 双协议支持，连接时会自动检测服务器类型。如果自动检测失败（例如 Query 端口被防火墙屏蔽），可以在创建机器人时手动指定 `serverProtocol: "ts6"`。TS6 Server 的 HTTP Query API（端口 10080）也已适配，需要时可配置 `ts6ApiKey`。
|
|
||||||
|
|
||||||
**Q：机器人连接了但 TeamSpeak 中听不到音乐？**
|
**Q：机器人连接了但 TeamSpeak 中听不到音乐？**
|
||||||
A：确保机器人和你在同一个频道。检查音量（`!vol 75`）。部分 VIP 歌曲需要先登录账号。
|
A：确保机器人和你在同一个频道。检查音量（`!vol 75`）。部分 VIP 歌曲需要先登录账号。
|
||||||
|
|
||||||
@@ -521,27 +305,9 @@ A：原生模块（opus、sqlite3）需要编译工具，Dockerfile 已包含。
|
|||||||
**Q：B站视频搜索不到结果？**
|
**Q：B站视频搜索不到结果？**
|
||||||
A：B站搜索需要 buvid3 匿名 Cookie（程序启动时自动获取）。如果失败，重启程序即可。登录B站账号后搜索效果更好。
|
A：B站搜索需要 buvid3 匿名 Cookie（程序启动时自动获取）。如果失败，重启程序即可。登录B站账号后搜索效果更好。
|
||||||
|
|
||||||
**Q：YouTube 平台搜索返回空结果？**
|
|
||||||
A：YouTube 是可选音源，需要手动安装 `yt-dlp`。详见 [可选：YouTube 音源](#可选youtube-音源) 章节。快速验证：在项目根目录执行 `bin/yt-dlp --version`（或系统 `yt-dlp --version`），能打印版本号即可。若 yt-dlp 已安装但仍搜索失败，通常是网络/地域问题或 yt-dlp 版本过旧（执行 `yt-dlp -U` 升级）。
|
|
||||||
|
|
||||||
**Q：如何更新到新版本？**
|
**Q：如何更新到新版本？**
|
||||||
A：`git pull` 拉取最新代码，然后 `npm install && npm run build && npm start` 重新构建启动。Docker 用户执行 `docker-compose up -d --build`。
|
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：成员可以：管理机器人（启动/停止/创建/编辑）、控制播放（搜索/播放/队列）、登录音乐平台账号、修改自己的密码。成员**不能**：管理其他用户、查看操作审计日志、降级或删除管理员。
|
|
||||||
|
|
||||||
**Q：如何把某个用户从成员升级为管理员？**
|
|
||||||
A：管理员登录后进入 **设置 → 用户管理**，点击对应用户的"提升管理员"按钮即可。降级同理（"降为成员"按钮）。系统会阻止降级最后一位管理员。
|
|
||||||
|
|
||||||
**Q：登录之后多久会自动退出？**
|
|
||||||
A：登录态有效期 7 天，活跃使用会滚动续期（每次受保护请求都会刷新过期时间）。同一账号最多保持 10 个并发会话（多设备登录时超过的会自动剔除最旧的会话）。
|
|
||||||
|
|
||||||
**Q：部署到公网后如何防止暴力登录？**
|
|
||||||
A：本项目内置 `/login` 限流（每 IP 每分钟 5 次），但生产部署建议同时在反向代理（nginx `limit_req` / Caddy 等）层加一层限流，并启用 HTTPS。反向代理部署务必设置 `"trustProxy": true`（详见 [反向代理部署注意事项](#反向代理部署注意事项)）。
|
|
||||||
|
|
||||||
## 参与贡献
|
## 参与贡献
|
||||||
|
|
||||||
1. Fork 本仓库
|
1. Fork 本仓库
|
||||||
@@ -550,103 +316,12 @@ A：本项目内置 `/login` 限流（每 IP 每分钟 5 次），但生产部
|
|||||||
4. 推送分支 (`git push origin feature/新功能`)
|
4. 推送分支 (`git push origin feature/新功能`)
|
||||||
5. 提交 Pull Request
|
5. 提交 Pull Request
|
||||||
|
|
||||||
## 更新日志
|
|
||||||
|
|
||||||
> 完整历史请查看 [git log](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/commits/main) 或 [Releases](https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/releases)。这里只列出重要变更和面向用户的破坏性改动。
|
|
||||||
|
|
||||||
### 最新版本
|
|
||||||
|
|
||||||
**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'`（防点击劫持）。
|
|
||||||
- **配置变更**：反向代理部署务必 `"trustProxy": true`（详见 [反向代理部署注意事项](#反向代理部署注意事项)）。`config.adminPassword` / `adminGroups` 字段保留以兼容旧 `config.json`，但不再影响任何行为。
|
|
||||||
|
|
||||||
### v0.x — Bot Profile 自动更新与协议层升级
|
|
||||||
|
|
||||||
**机器人形象自动更新（Bot Profile）**
|
|
||||||
|
|
||||||
- **播放时自动更新 TS 形象**：头像（专辑封面缩略图）、昵称（`♪ 歌名 - 歌手 - 原昵称`）、描述（歌曲信息）、Away 状态、频道描述、"正在播放"频道消息，全部随歌曲切换自动更新。
|
|
||||||
- **停止播放时恢复默认**：头像清除、昵称恢复、Away 显示"等待播放"、描述和频道描述清空。
|
|
||||||
- **权限安全**：每项功能独立检测权限，权限不足时自动禁用该功能（不影响其他功能和播放），重连后重试。
|
|
||||||
- **独立可配置**：6 项功能可通过 REST API（`GET/PUT /api/player/:botId/profile`）独立开关，配置持久化到数据库。
|
|
||||||
- **竞争条件防护**：generation 计数器防止快速切歌时旧头像覆盖新头像；UTF-8 字节长度截断中文昵称；文件传输操作带超时保护。
|
|
||||||
- **TS3 适配**：描述通过 `clientedit`（非 `clientupdate`）设置，需要 `b_client_modify_description` 权限；昵称和 Away 通过合并的单条 `clientupdate` 避免命令队列超时。
|
|
||||||
|
|
||||||
**新命令 & FM 修复**
|
|
||||||
|
|
||||||
- **新增 `!artist <歌手名>` 命令**：搜索指定歌手的歌曲并循环播放，支持 `-q`（QQ 音乐）/ `-b`（B站）/ `-y`（YouTube）平台切换。一次加载最多 50 首，自动按歌手名过滤并设为 Loop 模式。
|
|
||||||
- **歌单模糊搜索**：`!playlist` 现在支持歌单名称模糊搜索（如 `!playlist 华语经典`），自动匹配公开歌单 + 个人歌单（网易云 + QQ）。纯数字 ID 和 URL 解析保持兼容。
|
|
||||||
- **修复 `!fm` 播放中断**：私人 FM 几首歌后静音的 bug 已修复。新增自动续播机制（队列低位自动拉取新歌），播放器健康帧追踪防止临时 URL 失败导致永久静音。
|
|
||||||
- **QQ 音乐个人歌单**：QQ Music provider 新增 `getUserPlaylists` 支持，登录后可通过 `!playlist -q <名称>` 模糊搜索个人歌单。
|
|
||||||
|
|
||||||
**协议层 & 稳定性**
|
|
||||||
|
|
||||||
- **升级 `@honeybbq/teamspeak-client` 到 `0.2.1`**，移除内置 TS6 兼容层（`ts6-compat.ts`），改用库自带的通用 `clientinit` 协议（`3.?.? [Build: 5680278000]`），TS3/TS6 单一代码路径。
|
|
||||||
- ⚠️ **破坏性**：`0.1.0` 生成的旧身份与新握手路径不兼容，升级时需要迁移。详见 [更新升级](#更新升级) 章节顶部的警告。
|
|
||||||
- **修复 `startBot` 与 `stopBot` 之间的竞态**：mid-handshake 被替换的 BotInstance 不再泄漏 TS 会话，`disconnect()` 被 `connect()` 的 await 插队时不再错误地把 `connected` 翻回 `true`。
|
|
||||||
- **修复播放条自动刷新 bug**：BotManager 现在在创建新 BotInstance 时 emit `botInstance` 事件，WebSocket 监听器会立即重新挂接到新实例，播放状态变化无需手动刷新页面。
|
|
||||||
- **`connect()` 增加 15 秒超时**：握手卡住时会清理掉挂起的实例并返回 500，不再无限阻塞 HTTP 请求和 UI。
|
|
||||||
- **识别持久化修复**：`startBot` 现在会从数据库读取 `identity` 传给新 BotInstance，服务器组在机器人重启后能保留。
|
|
||||||
|
|
||||||
**HTTP API 加固**
|
|
||||||
|
|
||||||
- 新增输入校验，拒绝无效值并返回 **400**（之前会返回 200 包装 usage-text 字符串）：
|
|
||||||
- `/volume`：非数字、`NaN`/`Infinity`、超出 `[0,100]`
|
|
||||||
- `/mode`：不在 `{seq, loop, random, rloop}` 中的值
|
|
||||||
- `/seek`：`NaN`/`Infinity`、负数、字符串
|
|
||||||
- `/play-at`：索引越界（**先**校验再停止当前播放，避免误杀正在播的歌）
|
|
||||||
- **修复 YouTube 平台路由**：`/play`、`/add`、`/playlist`、`/play-by-id`、`/add-by-id`、`/play-playlist` 现在都正确处理 `platform=youtube`（之前会静默回退到网易云）。
|
|
||||||
- **修复 `/auth/status?platform=youtube` 数据泄漏**：之前会回退到网易云并返回网易云用户的昵称 + 头像 URL，现在正确路由到 YouTube provider 并报告 `yt-dlp` 的实际可用状态。
|
|
||||||
- **`/auth/cookie` 拒绝 `platform=youtube`**，防止意外覆盖网易云 cookie。
|
|
||||||
|
|
||||||
**连接状态一致性**
|
|
||||||
|
|
||||||
- 断开连接时，音频命令（`play`/`add`/`next`/`prev`/`playlist`/`album`/`fm`）返回 **400 "Bot is not connected to TeamSpeak"**；配置类命令（`volume`/`mode`/`clear`/`stop`/`queue`/`now`/`lyrics`）仍可正常工作，保持 UI 可用。
|
|
||||||
- `resolveAndPlay` 在网络请求（URL 解析）前后都会检查 `this.connected`，防止在解析期间被 `stop()` 中断后仍然启动 ffmpeg。
|
|
||||||
- `tsClient` 的 `disconnected` 事件处理器现在总是清理播放器状态，不再因为 `connect()` 从未完成而遗留 `playing=true` 的僵尸状态。
|
|
||||||
|
|
||||||
**功能改进**
|
|
||||||
|
|
||||||
- **YouTube 音源（可选）**：新增基于 `yt-dlp` 的 YouTube provider，通过 `!play -y <关键词>` 或 WebUI 平台选项使用。未安装 `yt-dlp` 时静默降级、返回空结果，不影响其他音源。详见 [可选：YouTube 音源](#可选youtube-音源)。
|
|
||||||
- **Bot Selector UI**：
|
|
||||||
- 始终可见（不再只有 ≥2 个机器人时才显示）
|
|
||||||
- 尺寸放大（更大的按钮、字体、状态图标）
|
|
||||||
- 每行增加 **电源按键**（一键启动/停止对应机器人，带禁用态与播放状态高亮）
|
|
||||||
- 每行增加 **链接按钮**（复制机器人专属 URL）
|
|
||||||
- 新路由 `/bot/:id`，打开后自动切换到对应机器人
|
|
||||||
- **服务器密码登录**：`serverPassword` 字段已加入数据库与 Settings UI，支持加入需要密码的 TS 服务器。
|
|
||||||
- **`!add` 一键开播**：在连接状态下向空队列 `!add` 歌曲时自动开始播放（之前只会入队，需要再 `!play` 或 `!next`）。
|
|
||||||
- **WebSocket 新增 `botRemoved` 事件**：删除机器人后 UI 会立即从列表中移除（之前需要手动刷新页面）。
|
|
||||||
|
|
||||||
**内部修复**
|
|
||||||
|
|
||||||
- **`PlayQueue.remove()` 当前歌曲移除 bug**：移除正在播放的歌曲时，`next()` 不再跳过紧跟其后的那首歌。
|
|
||||||
- **投票跳过**：需要的票数现在至少为 1（避免 `needed=0` 时单人"全票通过"的边界情况）；投票计数会在每首新歌开始时自动清零，不再跨歌曲泄漏。
|
|
||||||
- 多处输入边界修复：`seek` 防止 `NaN` 毒化 `seekOffset` 导致 `getElapsed()` 永久返回 `NaN`；`play-at` 越界时不再误杀当前播放。
|
|
||||||
|
|
||||||
### 历史重要变更
|
|
||||||
|
|
||||||
更早的变更请查阅 git log。主要里程碑：
|
|
||||||
|
|
||||||
- **初始 TS3/TS6 双协议支持**：自动协议检测（TS3 port 10011 vs TS6 port 10080）、TS6 HTTP Query 客户端、数据库持久化 `serverProtocol` / `ts6ApiKey`。
|
|
||||||
- **多机器人架构**：支持同一进程中运行多个机器人实例，独立队列、进度、音量；WebUI 一键切换。
|
|
||||||
- **网易云 / QQ 音乐 / 哔哩哔哩**：三平台原生音源，QR 码登录，Cookie 持久化。
|
|
||||||
- **Docker & systemd 部署**：一键部署脚本，数据卷持久化，自动重启支持。
|
|
||||||
|
|
||||||
## 致谢
|
## 致谢
|
||||||
|
|
||||||
感谢以下项目和开发者：
|
感谢以下项目和开发者：
|
||||||
|
|
||||||
| 项目 | 说明 |
|
| 项目 | 说明 |
|
||||||
|------|------|
|
|------|------|
|
||||||
| [yichen11818/NeteaseTSBot](https://github.com/yichen11818/NeteaseTSBot) | TS6 协议兼容参考（vendored tsproto 补丁） |
|
|
||||||
| [Splamy/TS3AudioBot](https://github.com/Splamy/TS3AudioBot) | 优秀的 TeamSpeak 音频机器人框架 |
|
| [Splamy/TS3AudioBot](https://github.com/Splamy/TS3AudioBot) | 优秀的 TeamSpeak 音频机器人框架 |
|
||||||
| [TS3AudioBot-BiliBiliPlugin](https://github.com/xxmod/TS3AudioBot-BiliBiliPlugin) | 提供插件开发参考 |
|
| [TS3AudioBot-BiliBiliPlugin](https://github.com/xxmod/TS3AudioBot-BiliBiliPlugin) | 提供插件开发参考 |
|
||||||
| [TS3AudioBot-NetEaseCloudmusic-plugin](https://github.com/ZHANGTIANYAO1/TS3AudioBot-NetEaseCloudmusic-plugin) | 提供插件开发参考和懒加载设计参考 |
|
| [TS3AudioBot-NetEaseCloudmusic-plugin](https://github.com/ZHANGTIANYAO1/TS3AudioBot-NetEaseCloudmusic-plugin) | 提供插件开发参考和懒加载设计参考 |
|
||||||
|
|||||||
@@ -1,517 +0,0 @@
|
|||||||
# FM Bug Fix + Artist Loop + Playlist Fuzzy Search — 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:** Fix FM audio dropout bug, add `!artist` command for artist-based loop playback, and support playlist name fuzzy search in `!playlist`.
|
|
||||||
|
|
||||||
**Architecture:** All changes stay within existing files. The FM fix adds auto-refill logic and a success-tracking mechanism in the player. Playlist search reuses the existing `provider.search()` API that already returns playlists. The `!artist` command is a new command method following the same pattern as `cmdPlay`/`cmdFm`.
|
|
||||||
|
|
||||||
**Tech Stack:** TypeScript, Node.js, ffmpeg-static, @honeybbq/teamspeak-client
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## File Map
|
|
||||||
|
|
||||||
| File | Change | Purpose |
|
|
||||||
|------|--------|---------|
|
|
||||||
| `src/bot/instance.ts` | Modify | Add `isFmMode`, `refillFm()`, fix `cmdFm()`, modify `cmdPlaylist()`, add `cmdArtist()`, modify `playNext()` to trigger FM refill |
|
|
||||||
| `src/bot/commands.ts` | Modify | Register `artist` in PUBLIC_COMMANDS, update help text |
|
|
||||||
| `src/audio/player.ts` | Modify | Track healthy frame count, reset `consecutiveFailures` after sustained successful playback |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Task 1: Fix FM — Track healthy playback in AudioPlayer
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `src/audio/player.ts:62-82` (add field)
|
|
||||||
- Modify: `src/audio/player.ts:243-261` (sendNextFrame — track healthy frames)
|
|
||||||
|
|
||||||
- [ ] **Step 1: Add healthy frame counter field**
|
|
||||||
|
|
||||||
In `src/audio/player.ts`, after the `consecutiveFailures` field (line ~80), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private healthyFrames = 0;
|
|
||||||
private static readonly HEALTHY_FRAME_RESET = 50; // ~1 second of audio
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 2: Track healthy frames and reset failures in sendNextFrame**
|
|
||||||
|
|
||||||
In `src/audio/player.ts`, in the `sendNextFrame()` method, after line 257 (`this.framesPlayed++;`), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.healthyFrames++;
|
|
||||||
if (this.healthyFrames >= AudioPlayer.HEALTHY_FRAME_RESET) {
|
|
||||||
this.consecutiveFailures = 0;
|
|
||||||
this.healthyFrames = 0;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 3: Reset healthyFrames in play() and stop()**
|
|
||||||
|
|
||||||
In `play()`, after `this.framesPlayed = 0;` (line ~95), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.healthyFrames = 0;
|
|
||||||
```
|
|
||||||
|
|
||||||
In `stop()`, after `this.framesPlayed = 0;` (line ~181), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.healthyFrames = 0;
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 4: Commit**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git add src/audio/player.ts
|
|
||||||
git commit -m "fix(player): reset consecutiveFailures after sustained healthy playback"
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Task 2: Fix FM — Add auto-refill logic in BotInstance
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `src/bot/instance.ts:62-66` (add fields)
|
|
||||||
- Modify: `src/bot/instance.ts:557-573` (cmdFm)
|
|
||||||
- Modify: `src/bot/instance.ts:642-673` (playNext — add refill trigger)
|
|
||||||
|
|
||||||
- [ ] **Step 1: Add isFmMode field**
|
|
||||||
|
|
||||||
In `src/bot/instance.ts`, after `private profileManager: BotProfileManager;` (line ~66), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private isFmMode = false;
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 2: Add refillFm method**
|
|
||||||
|
|
||||||
In `src/bot/instance.ts`, before the `cmdVote` method (after `cmdFm`'s closing brace), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private async refillFm(): Promise<void> {
|
|
||||||
if (!this.isFmMode || !this.neteaseProvider.getPersonalFm) return;
|
|
||||||
try {
|
|
||||||
const songs = await this.neteaseProvider.getPersonalFm();
|
|
||||||
if (songs.length === 0) return;
|
|
||||||
for (const song of songs) {
|
|
||||||
this.queue.add({ ...song, platform: "netease" });
|
|
||||||
}
|
|
||||||
this.logger.debug({ count: songs.length }, "FM queue refilled");
|
|
||||||
} catch (err) {
|
|
||||||
this.logger.error({ err }, "Failed to refill FM queue");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 3: Modify cmdFm to set isFmMode and use RandomLoop**
|
|
||||||
|
|
||||||
Replace the existing `cmdFm` method (lines 557-573) with:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private async cmdFm(): Promise<string> {
|
|
||||||
if (!this.neteaseProvider.getPersonalFm) {
|
|
||||||
return "Personal FM is only available for NetEase Cloud Music";
|
|
||||||
}
|
|
||||||
const songs = await this.neteaseProvider.getPersonalFm();
|
|
||||||
if (songs.length === 0)
|
|
||||||
return "No FM songs available (need to login first)";
|
|
||||||
|
|
||||||
this.queue.clear();
|
|
||||||
for (const song of songs) {
|
|
||||||
this.queue.add({ ...song, platform: "netease" });
|
|
||||||
}
|
|
||||||
this.queue.setMode(PlayMode.RandomLoop);
|
|
||||||
this.isFmMode = true;
|
|
||||||
this.player.resetFailures();
|
|
||||||
|
|
||||||
const first = this.queue.play();
|
|
||||||
if (first) await this.resolveAndPlay(first);
|
|
||||||
this.emit("stateChange");
|
|
||||||
return `Personal FM started: ${first?.name ?? "unknown"} - ${first?.artist ?? ""}`;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 4: Modify playNext to trigger FM refill and check isFmMode**
|
|
||||||
|
|
||||||
In `playNext()`, replace the `else` branch (lines 665-668) that handles `queue.next() === null`:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
} else {
|
|
||||||
// FM mode: try to refill instead of stopping
|
|
||||||
if (this.isFmMode) {
|
|
||||||
await this.refillFm();
|
|
||||||
const refillNext = this.queue.next();
|
|
||||||
if (refillNext) {
|
|
||||||
const started = await this.resolveAndPlay(refillNext);
|
|
||||||
if (!started) {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
this.emit("stateChange");
|
|
||||||
} else {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Also add a proactive refill after successful advance. At the end of the `if (next)` block, after `this.emit("stateChange");` is handled outside the if/else, add this right after `resolveAndPlay` succeeds (inside the `if (next)` block, after the retry loop):
|
|
||||||
|
|
||||||
After the `if (!started)` block and before the closing `}` of `if (next)`, insert:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Proactive FM refill when running low
|
|
||||||
if (this.isFmMode && this.queue.size() - (this.queue.getCurrentIndex()) <= 3) {
|
|
||||||
this.refillFm().catch(err => this.logger.error({ err }, "Proactive FM refill failed"));
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Wait — `this.emit("stateChange")` is outside the `if (next)` block. Let me re-read the original code structure...
|
|
||||||
|
|
||||||
The original `playNext()` structure is:
|
|
||||||
```
|
|
||||||
if (next) {
|
|
||||||
let started = await resolveAndPlay(next)
|
|
||||||
if (!started) { retry loop... }
|
|
||||||
if (!started) { stop }
|
|
||||||
} else {
|
|
||||||
stop
|
|
||||||
}
|
|
||||||
emit("stateChange")
|
|
||||||
```
|
|
||||||
|
|
||||||
So I need to add the proactive refill inside the `if (next)` block, right after `resolveAndPlay` succeeds. Let me write this more carefully:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private async playNext(): Promise<void> {
|
|
||||||
if (this.isAdvancing || !this.connected) return;
|
|
||||||
this.isAdvancing = true;
|
|
||||||
try {
|
|
||||||
this.voteSkipUsers.clear();
|
|
||||||
const next = this.queue.next();
|
|
||||||
if (next) {
|
|
||||||
let started = await this.resolveAndPlay(next);
|
|
||||||
if (!started) {
|
|
||||||
for (let i = 0; i < 3 && this.connected; i++) {
|
|
||||||
const retry = this.queue.next();
|
|
||||||
if (!retry) break;
|
|
||||||
if (await this.resolveAndPlay(retry)) {
|
|
||||||
started = true;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (!started) {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
} else if (this.isFmMode && this.queue.size() - this.queue.getCurrentIndex() <= 3) {
|
|
||||||
// Proactive refill: when queue is running low, fetch more FM songs
|
|
||||||
this.refillFm().catch(err => this.logger.error({ err }, "Proactive FM refill failed"));
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Queue exhausted — in FM mode, refill instead of stopping
|
|
||||||
if (this.isFmMode) {
|
|
||||||
await this.refillFm();
|
|
||||||
const refillNext = this.queue.next();
|
|
||||||
if (refillNext) {
|
|
||||||
await this.resolveAndPlay(refillNext);
|
|
||||||
} else {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
this.emit("stateChange");
|
|
||||||
} finally {
|
|
||||||
this.isAdvancing = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
OK this is getting complex. Let me simplify the plan — I'll structure it more clearly.
|
|
||||||
|
|
||||||
Also I need to clear `isFmMode` when user issues stop/clear or manually plays something else.
|
|
||||||
|
|
||||||
- [ ] **Step 5: Clear isFmMode in stop/clear/play commands**
|
|
||||||
|
|
||||||
In `cmdStop()`, after `this.queue.clear();`, add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.isFmMode = false;
|
|
||||||
```
|
|
||||||
|
|
||||||
In `cmdClear()` (same line), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.isFmMode = false;
|
|
||||||
```
|
|
||||||
|
|
||||||
In `cmdPlay()`, after `this.queue.clear();`, add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.isFmMode = false;
|
|
||||||
```
|
|
||||||
|
|
||||||
In `cmdPlaylist()`, after `this.queue.clear();`, add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.isFmMode = false;
|
|
||||||
```
|
|
||||||
|
|
||||||
In `cmdAlbum()`, after `this.queue.clear();`, add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
this.isFmMode = false;
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 6: Commit**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git add src/bot/instance.ts
|
|
||||||
git commit -m "fix: FM auto-refill to prevent audio dropout after initial batch"
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Task 3: Playlist Fuzzy Search
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `src/bot/instance.ts:524-539` (cmdPlaylist)
|
|
||||||
|
|
||||||
- [ ] **Step 1: Modify cmdPlaylist to support name search**
|
|
||||||
|
|
||||||
Replace the `cmdPlaylist` method (lines 524-539) with:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private async cmdPlaylist(cmd: ParsedCommand): Promise<string> {
|
|
||||||
if (!cmd.args) return "Usage: !playlist <playlist name or ID>";
|
|
||||||
const provider = this.getProvider(cmd.flags);
|
|
||||||
|
|
||||||
// Determine if input is a numeric ID or a name search
|
|
||||||
const id = this.extractId(cmd.args);
|
|
||||||
const isNumericId = /^\d+$/.test(cmd.args.trim());
|
|
||||||
|
|
||||||
let playlistId: string;
|
|
||||||
|
|
||||||
if (isNumericId || id !== cmd.args) {
|
|
||||||
// Input is a numeric ID or URL containing an ID — use existing logic
|
|
||||||
playlistId = id;
|
|
||||||
} else {
|
|
||||||
// Name-based search
|
|
||||||
const result = await provider.search(cmd.args);
|
|
||||||
let playlists = result.playlists ?? [];
|
|
||||||
|
|
||||||
// Also search user's personal playlists if logged in
|
|
||||||
if (provider.getUserPlaylists) {
|
|
||||||
try {
|
|
||||||
const userPlaylists = await provider.getUserPlaylists();
|
|
||||||
const query = cmd.args.toLowerCase();
|
|
||||||
const matched = userPlaylists.filter(
|
|
||||||
p => p.name.toLowerCase().includes(query)
|
|
||||||
);
|
|
||||||
// Merge: public results first (API-ranked), then user matches
|
|
||||||
playlists = [...playlists, ...matched];
|
|
||||||
} catch {
|
|
||||||
// User playlists unavailable — continue with public results
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (playlists.length === 0)
|
|
||||||
return `No playlists found for: ${cmd.args}`;
|
|
||||||
playlistId = playlists[0].id;
|
|
||||||
}
|
|
||||||
|
|
||||||
const songs = await provider.getPlaylistSongs(playlistId);
|
|
||||||
if (songs.length === 0) return "Playlist is empty or not found";
|
|
||||||
|
|
||||||
this.queue.clear();
|
|
||||||
this.isFmMode = false;
|
|
||||||
for (const song of songs) {
|
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
|
||||||
}
|
|
||||||
const first = this.queue.play();
|
|
||||||
if (first) await this.resolveAndPlay(first);
|
|
||||||
this.emit("stateChange");
|
|
||||||
return `Loaded ${songs.length} songs. Now playing: ${first?.name ?? "unknown"}`;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 2: Update help text to reflect new usage**
|
|
||||||
|
|
||||||
In `cmdHelp()` (line ~633), change the playlist line from:
|
|
||||||
|
|
||||||
```
|
|
||||||
`${p}playlist <id> — Load playlist`
|
|
||||||
```
|
|
||||||
|
|
||||||
to:
|
|
||||||
|
|
||||||
```
|
|
||||||
`${p}playlist <name or id> — Load playlist by name or ID`
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 3: Commit**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git add src/bot/instance.ts
|
|
||||||
git commit -m "feat: support playlist name fuzzy search in !playlist command"
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Task 4: Artist Loop Command
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `src/bot/commands.ts:8-11` (PUBLIC_COMMANDS)
|
|
||||||
- Modify: `src/bot/commands.ts:248-260` (AUDIO_COMMANDS in instance.ts — actually in instance.ts)
|
|
||||||
- Modify: `src/bot/instance.ts:244-314` (executeCommand switch + add cmdArtist)
|
|
||||||
|
|
||||||
Wait, AUDIO_COMMANDS is in instance.ts executeCommand. Let me check...
|
|
||||||
|
|
||||||
Actually looking back at instance.ts, the AUDIO_COMMANDS set is local to executeCommand. I don't need to add artist there since it will be handled in the switch.
|
|
||||||
|
|
||||||
- [ ] **Step 1: Register `artist` in PUBLIC_COMMANDS**
|
|
||||||
|
|
||||||
In `src/bot/commands.ts`, line 9, add `"artist"` to the PUBLIC_COMMANDS set:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
export const PUBLIC_COMMANDS = new Set([
|
|
||||||
"play", "add", "queue", "list", "now", "lyrics", "vote", "help",
|
|
||||||
"playlist", "album", "fm", "prev", "next", "skip", "pause", "resume",
|
|
||||||
"artist",
|
|
||||||
]);
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 2: Add `artist` to the AUDIO_COMMANDS set in executeCommand**
|
|
||||||
|
|
||||||
In `src/bot/instance.ts`, in the `executeCommand` method, add `"artist"` to the AUDIO_COMMANDS set (line ~253):
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const AUDIO_COMMANDS = new Set([
|
|
||||||
"play", "add", "next", "skip", "prev", "playlist", "album", "fm",
|
|
||||||
"artist",
|
|
||||||
]);
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 3: Add `artist` case to the switch in executeCommand**
|
|
||||||
|
|
||||||
In `src/bot/instance.ts`, after the `case "fm":` block (line ~300), add:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
case "artist":
|
|
||||||
return this.cmdArtist(cmd);
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 4: Implement cmdArtist method**
|
|
||||||
|
|
||||||
Add the `cmdArtist` method in `src/bot/instance.ts`, after `cmdFm()`:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
private async cmdArtist(cmd: ParsedCommand): Promise<string> {
|
|
||||||
if (!cmd.args) return "Usage: !artist <artist name>";
|
|
||||||
const provider = this.getProvider(cmd.flags);
|
|
||||||
const result = await provider.search(cmd.args, 50);
|
|
||||||
if (result.songs.length === 0)
|
|
||||||
return `No results found for artist: ${cmd.args}`;
|
|
||||||
|
|
||||||
const query = cmd.args.toLowerCase();
|
|
||||||
let filtered = result.songs.filter(
|
|
||||||
s => s.artist.toLowerCase().includes(query)
|
|
||||||
);
|
|
||||||
|
|
||||||
// Fallback to unfiltered results if filtering drops everything
|
|
||||||
if (filtered.length === 0) {
|
|
||||||
filtered = result.songs.slice(0, 20);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.queue.clear();
|
|
||||||
this.isFmMode = false;
|
|
||||||
for (const song of filtered) {
|
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
|
||||||
}
|
|
||||||
this.queue.setMode(PlayMode.Loop);
|
|
||||||
this.player.resetFailures();
|
|
||||||
|
|
||||||
const first = this.queue.play();
|
|
||||||
if (first) await this.resolveAndPlay(first);
|
|
||||||
this.emit("stateChange");
|
|
||||||
return `Artist mode: ${cmd.args} — ${filtered.length} songs loaded. Now playing: ${first?.name ?? "unknown"}`;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 5: Update help text**
|
|
||||||
|
|
||||||
In `cmdHelp()`, add the artist help line after the fm line:
|
|
||||||
|
|
||||||
```
|
|
||||||
`${p}artist <name> — Play songs by artist (loop)`
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 6: Commit**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git add src/bot/commands.ts src/bot/instance.ts
|
|
||||||
git commit -m "feat: add !artist command for artist-based loop playback"
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Task 5: Type-check and verify
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- All modified files
|
|
||||||
|
|
||||||
- [ ] **Step 1: Run type check**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd /home/proxxy/project/teamspeak-music-bot && npm run typecheck
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: No errors.
|
|
||||||
|
|
||||||
- [ ] **Step 2: Verify command parsing**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd /home/proxxy/project/teamspeak-music-bot && node --loader ts-node/esm -e "
|
|
||||||
const { parseCommand } = await import('./src/bot/commands.ts');
|
|
||||||
console.log(parseCommand('!artist 周杰伦', '!'));
|
|
||||||
console.log(parseCommand('!artist 周杰伦 -q', '!'));
|
|
||||||
console.log(parseCommand('!playlist 华语经典', '!'));
|
|
||||||
console.log(parseCommand('!playlist 123456', '!'));
|
|
||||||
"
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: All parse correctly; `artist` with args "周杰伦", `playlist` with args "华语经典" and "123456".
|
|
||||||
|
|
||||||
- [ ] **Step 3: Commit any fixes from type check**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git add -A && git commit -m "chore: type fixes from final verification"
|
|
||||||
```
|
|
||||||
(Only if there were issues)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Self-Review Checklist
|
|
||||||
|
|
||||||
1. **Spec coverage:**
|
|
||||||
- FM bug fix → Tasks 1, 2 (healthy frame tracking + auto-refill)
|
|
||||||
- Playlist fuzzy search → Task 3
|
|
||||||
- Artist loop → Task 4
|
|
||||||
- Verification → Task 5
|
|
||||||
|
|
||||||
2. **No placeholders** — all steps have exact code.
|
|
||||||
|
|
||||||
3. **Type consistency:**
|
|
||||||
- `isFmMode: boolean` — used in cmdFm, cmdStop, cmdClear, cmdPlay, cmdPlaylist, cmdAlbum, playNext, refillFm ✓
|
|
||||||
- `refillFm(): Promise<void>` — called from cmdFm (indirectly via playNext trigger), playNext ✓
|
|
||||||
- `healthyFrames: number`, `HEALTHY_FRAME_RESET: 50` — used in play(), stop(), sendNextFrame() ✓
|
|
||||||
@@ -1,911 +0,0 @@
|
|||||||
# Music Source Tabs 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:** Add NetEase / QQ source-switcher tabs to Home (推荐歌单 / 每日推荐 / 我的歌单) and Library (我的歌单), with per-section persistence and graceful degradation when only one source is logged in.
|
|
||||||
|
|
||||||
**Architecture:** A single shared `<SourceTabs>` Vue component handles the tab UI and self-hides when fewer than 2 sources are available. The Pinia store splits the affected fields into `{ netease, qq }` objects, fetches from both platforms in `fetchHomeData()` based on `authStatus`, and consumers select with a reactive `activeSource` ref persisted to localStorage.
|
|
||||||
|
|
||||||
**Tech Stack:** Vue 3 (Composition API + `<script setup>`), Pinia, TypeScript, SCSS (CSS variables from `web/src/styles/variables.scss`).
|
|
||||||
|
|
||||||
**Spec:** `docs/superpowers/specs/2026-05-06-music-source-tabs-design.md`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## File Structure
|
|
||||||
|
|
||||||
**New:**
|
|
||||||
- `web/src/components/SourceTabs.vue` — shared tab UI (presentational, no store deps)
|
|
||||||
|
|
||||||
**Modified:**
|
|
||||||
- `web/src/stores/player.ts` — state shape change + `authStatus` + `fetchHomeData` rewrite
|
|
||||||
- `web/src/views/Home.vue` — 3 sections wired to SourceTabs
|
|
||||||
- `web/src/views/Library.vue` — 1 section wired; remove dead `liked` block
|
|
||||||
|
|
||||||
**Unchanged:**
|
|
||||||
- Backend (already supports `?platform=qq`)
|
|
||||||
- All other web pages
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 1: Build the SourceTabs component
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Create: `web/src/components/SourceTabs.vue`
|
|
||||||
|
|
||||||
This task is fully independent of store changes — the component is presentational, takes typed props, and emits an update event. It can land and be committed alone (build will pass; component is just unused until later tasks).
|
|
||||||
|
|
||||||
- [ ] **Step 1.1: Create the component file**
|
|
||||||
|
|
||||||
Write `web/src/components/SourceTabs.vue`:
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<template>
|
|
||||||
<div v-if="sources.length >= 2" class="source-tabs">
|
|
||||||
<button
|
|
||||||
v-for="src in sources"
|
|
||||||
:key="src"
|
|
||||||
type="button"
|
|
||||||
class="source-tab"
|
|
||||||
:class="{ active: src === modelValue }"
|
|
||||||
@click="$emit('update:modelValue', src)"
|
|
||||||
>
|
|
||||||
{{ LABELS[src] }}
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<script setup lang="ts">
|
|
||||||
type Source = 'netease' | 'qq';
|
|
||||||
|
|
||||||
const LABELS: Record<Source, string> = {
|
|
||||||
netease: '网易云',
|
|
||||||
qq: 'QQ',
|
|
||||||
};
|
|
||||||
|
|
||||||
defineProps<{
|
|
||||||
modelValue: Source;
|
|
||||||
sources: Source[];
|
|
||||||
}>();
|
|
||||||
|
|
||||||
defineEmits<{
|
|
||||||
'update:modelValue': [value: Source];
|
|
||||||
}>();
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<style lang="scss" scoped>
|
|
||||||
.source-tabs {
|
|
||||||
display: inline-flex;
|
|
||||||
gap: 4px;
|
|
||||||
margin-left: 12px;
|
|
||||||
align-items: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
.source-tab {
|
|
||||||
padding: 4px 10px;
|
|
||||||
min-height: 28px;
|
|
||||||
font-size: var(--fs-sm);
|
|
||||||
font-weight: var(--fw-medium);
|
|
||||||
color: var(--text-secondary);
|
|
||||||
background: transparent;
|
|
||||||
border: none;
|
|
||||||
border-radius: var(--radius-sm);
|
|
||||||
cursor: pointer;
|
|
||||||
transition: color var(--transition-fast), background var(--transition-fast);
|
|
||||||
|
|
||||||
&:hover {
|
|
||||||
color: var(--text-primary);
|
|
||||||
background: var(--hover-bg);
|
|
||||||
}
|
|
||||||
|
|
||||||
&.active {
|
|
||||||
color: var(--color-primary);
|
|
||||||
background: var(--color-primary-12);
|
|
||||||
font-weight: var(--fw-semi);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@media (max-width: 768px) {
|
|
||||||
.source-tabs {
|
|
||||||
margin-left: 8px;
|
|
||||||
gap: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.source-tab {
|
|
||||||
padding: 6px 10px;
|
|
||||||
min-height: 36px; // larger touch target on mobile
|
|
||||||
font-size: var(--fs-xs);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
```
|
|
||||||
|
|
||||||
Why these choices:
|
|
||||||
- `v-if="sources.length >= 2"` — auto-hide when only one source available; parent doesn't need wrapper logic
|
|
||||||
- Min-height 28px desktop / 36px mobile — comfortable touch on phones
|
|
||||||
- `--color-primary-12` (12% primary tint) — matches existing active-state pattern in the codebase
|
|
||||||
- No `--brand-netease/qq` in active state — keeps tab visually consistent regardless of which platform; brand colors are reserved for SongCard platform badges where they identify content origin
|
|
||||||
|
|
||||||
- [ ] **Step 1.2: Verify it imports cleanly via type check**
|
|
||||||
|
|
||||||
Run from project root:
|
|
||||||
|
|
||||||
```
|
|
||||||
npx tsc --noEmit
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: exit code 0, no output.
|
|
||||||
|
|
||||||
Then verify the web project also type-checks:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd web && npx vue-tsc --noEmit && cd ..
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: exit code 0, no output.
|
|
||||||
|
|
||||||
- [ ] **Step 1.3: Commit**
|
|
||||||
|
|
||||||
```
|
|
||||||
git add web/src/components/SourceTabs.vue
|
|
||||||
git commit -m "feat(web): add SourceTabs component for platform switcher
|
|
||||||
|
|
||||||
Presentational component for switching between netease and qq music
|
|
||||||
sources. Auto-hides when fewer than 2 sources are passed in. Mobile
|
|
||||||
breakpoint enlarges touch target to 36px.
|
|
||||||
|
|
||||||
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>"
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 2: Refactor the store (state + fetchHomeData)
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `web/src/stores/player.ts`
|
|
||||||
|
|
||||||
This task changes types, which will break Home.vue and Library.vue at compile time. **Do not run tsc/build between Task 2 and Task 4** — they are migrated in a single coherent commit. After Task 4, type-check confirms the whole change.
|
|
||||||
|
|
||||||
- [ ] **Step 2.1: Add the `Source` type alias and update state shape**
|
|
||||||
|
|
||||||
In `web/src/stores/player.ts`, locate the `state: () => ({ ... })` block (around line 47-63).
|
|
||||||
|
|
||||||
**Find:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
// Home page cache
|
|
||||||
recommendPlaylists: [] as PlaylistItem[],
|
|
||||||
dailySongs: [] as Song[],
|
|
||||||
userPlaylists: [] as PlaylistItem[],
|
|
||||||
bilibiliPopular: [] as Song[],
|
|
||||||
lastFetchTime: 0,
|
|
||||||
```
|
|
||||||
|
|
||||||
**Replace with:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
// Home page cache, split by source
|
|
||||||
recommendPlaylists: { netease: [] as PlaylistItem[], qq: [] as PlaylistItem[] },
|
|
||||||
dailySongs: { netease: [] as Song[], qq: [] as Song[] },
|
|
||||||
userPlaylists: { netease: [] as PlaylistItem[], qq: [] as PlaylistItem[] },
|
|
||||||
bilibiliPopular: [] as Song[],
|
|
||||||
authStatus: { netease: false, qq: false },
|
|
||||||
lastFetchTime: 0,
|
|
||||||
```
|
|
||||||
|
|
||||||
Also add this exported type at the top of the file, right after the existing `Song` interface (around line 12):
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export type Source = 'netease' | 'qq';
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 2.2: Rewrite `fetchHomeData()`**
|
|
||||||
|
|
||||||
In the same file, find the `fetchHomeData` action (around line 352-378).
|
|
||||||
|
|
||||||
**Replace the entire action body with:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
async fetchHomeData() {
|
|
||||||
if (this.lastFetchTime > 0 && Date.now() - this.lastFetchTime < HOME_CACHE_TTL) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// 1. Fetch auth status for both platforms first.
|
|
||||||
const [neAuthRes, qqAuthRes] = await Promise.allSettled([
|
|
||||||
axios.get('/api/auth/status', { params: { platform: 'netease' } }),
|
|
||||||
axios.get('/api/auth/status', { params: { platform: 'qq' } }),
|
|
||||||
]);
|
|
||||||
this.authStatus.netease =
|
|
||||||
neAuthRes.status === 'fulfilled' && !!neAuthRes.value.data?.loggedIn;
|
|
||||||
this.authStatus.qq =
|
|
||||||
qqAuthRes.status === 'fulfilled' && !!qqAuthRes.value.data?.loggedIn;
|
|
||||||
|
|
||||||
// 2. NetEase data: recommend playlists work anonymously; daily/user
|
|
||||||
// playlists need login but Promise.allSettled isolates failures.
|
|
||||||
const neteasePromises = [
|
|
||||||
axios.get('/api/music/recommend/playlists', { params: { platform: 'netease' } }),
|
|
||||||
axios.get('/api/music/recommend/songs', { params: { platform: 'netease' } }),
|
|
||||||
axios.get('/api/music/user/playlists', { params: { platform: 'netease' } }),
|
|
||||||
];
|
|
||||||
|
|
||||||
// 3. QQ data: only fetch when QQ is logged in. When not logged in,
|
|
||||||
// resolve to empty payloads so the same indexed handling works.
|
|
||||||
const emptyPlaylists = { data: { playlists: [] } };
|
|
||||||
const emptySongs = { data: { songs: [] } };
|
|
||||||
const qqPromises = this.authStatus.qq
|
|
||||||
? [
|
|
||||||
axios.get('/api/music/recommend/playlists', { params: { platform: 'qq' } }),
|
|
||||||
axios.get('/api/music/recommend/songs', { params: { platform: 'qq' } }),
|
|
||||||
axios.get('/api/music/user/playlists', { params: { platform: 'qq' } }),
|
|
||||||
]
|
|
||||||
: [
|
|
||||||
Promise.resolve(emptyPlaylists),
|
|
||||||
Promise.resolve(emptySongs),
|
|
||||||
Promise.resolve(emptyPlaylists),
|
|
||||||
];
|
|
||||||
|
|
||||||
const biliPromise = axios.get('/api/music/bilibili/popular?limit=12');
|
|
||||||
|
|
||||||
const results = await Promise.allSettled([
|
|
||||||
...neteasePromises,
|
|
||||||
...qqPromises,
|
|
||||||
biliPromise,
|
|
||||||
]);
|
|
||||||
|
|
||||||
const [neRecPL, neDaily, neUserPL, qqRecPL, qqDaily, qqUserPL, bili] = results;
|
|
||||||
|
|
||||||
if (neRecPL.status === 'fulfilled') {
|
|
||||||
this.recommendPlaylists.netease = neRecPL.value.data.playlists ?? [];
|
|
||||||
}
|
|
||||||
if (neDaily.status === 'fulfilled') {
|
|
||||||
this.dailySongs.netease = neDaily.value.data.songs ?? [];
|
|
||||||
}
|
|
||||||
if (neUserPL.status === 'fulfilled') {
|
|
||||||
this.userPlaylists.netease = neUserPL.value.data.playlists ?? [];
|
|
||||||
}
|
|
||||||
if (qqRecPL.status === 'fulfilled') {
|
|
||||||
this.recommendPlaylists.qq = qqRecPL.value.data.playlists ?? [];
|
|
||||||
}
|
|
||||||
if (qqDaily.status === 'fulfilled') {
|
|
||||||
this.dailySongs.qq = qqDaily.value.data.songs ?? [];
|
|
||||||
}
|
|
||||||
if (qqUserPL.status === 'fulfilled') {
|
|
||||||
this.userPlaylists.qq = qqUserPL.value.data.playlists ?? [];
|
|
||||||
}
|
|
||||||
if (bili.status === 'fulfilled') {
|
|
||||||
this.bilibiliPopular = bili.value.data.songs ?? [];
|
|
||||||
}
|
|
||||||
|
|
||||||
this.lastFetchTime = Date.now();
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
**Do NOT type-check yet** — Home/Library still reference the old shape. They'll be migrated in Tasks 3 and 4.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 3: Migrate Home.vue to multi-source tabs
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `web/src/views/Home.vue`
|
|
||||||
|
|
||||||
- [ ] **Step 3.1: Add a localStorage helper module**
|
|
||||||
|
|
||||||
Create `web/src/stores/sourceTabs.ts`:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import type { Source } from './player.js';
|
|
||||||
|
|
||||||
const STORAGE_KEY = 'source-tabs';
|
|
||||||
|
|
||||||
export type TabKey =
|
|
||||||
| 'home.recommend'
|
|
||||||
| 'home.daily'
|
|
||||||
| 'home.user'
|
|
||||||
| 'library.user';
|
|
||||||
|
|
||||||
function readAll(): Partial<Record<TabKey, Source>> {
|
|
||||||
try {
|
|
||||||
const raw = localStorage.getItem(STORAGE_KEY);
|
|
||||||
if (!raw) return {};
|
|
||||||
const parsed = JSON.parse(raw);
|
|
||||||
return typeof parsed === 'object' && parsed !== null ? parsed : {};
|
|
||||||
} catch {
|
|
||||||
return {};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function loadTabSource(key: TabKey, fallback: Source = 'netease'): Source {
|
|
||||||
const all = readAll();
|
|
||||||
const v = all[key];
|
|
||||||
return v === 'netease' || v === 'qq' ? v : fallback;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function saveTabSource(key: TabKey, value: Source): void {
|
|
||||||
try {
|
|
||||||
const all = readAll();
|
|
||||||
all[key] = value;
|
|
||||||
localStorage.setItem(STORAGE_KEY, JSON.stringify(all));
|
|
||||||
} catch {
|
|
||||||
// localStorage may be unavailable (private browsing); silently no-op
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This is a separate file rather than inline so Library can reuse it without duplication.
|
|
||||||
|
|
||||||
- [ ] **Step 3.2: Update Home.vue template**
|
|
||||||
|
|
||||||
Replace the three `<section>` blocks (推荐歌单 / 每日推荐 / 我的歌单) and the `<script setup>` block.
|
|
||||||
|
|
||||||
**Find** the entire `<template>` 推荐歌单 section (currently around lines 53-67):
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<!-- 推荐歌单 -->
|
|
||||||
<section class="section" v-if="store.recommendPlaylists.length > 0">
|
|
||||||
<h2 class="section-title">推荐歌单</h2>
|
|
||||||
<div class="playlist-grid">
|
|
||||||
<RouterLink
|
|
||||||
v-for="playlist in store.recommendPlaylists"
|
|
||||||
:key="playlist.id"
|
|
||||||
:to="`/playlist/${playlist.id}?platform=${playlist.platform}`"
|
|
||||||
class="playlist-card hover-scale"
|
|
||||||
>
|
|
||||||
<CoverArt :url="playlist.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="playlist-name">{{ playlist.name }}</div>
|
|
||||||
</RouterLink>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Replace with:**
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<!-- 推荐歌单 -->
|
|
||||||
<section class="section" v-if="recommendAvailable.length > 0">
|
|
||||||
<h2 class="section-title">
|
|
||||||
推荐歌单
|
|
||||||
<SourceTabs v-model="recommendSource" :sources="recommendAvailable" />
|
|
||||||
</h2>
|
|
||||||
<div class="playlist-grid">
|
|
||||||
<RouterLink
|
|
||||||
v-for="playlist in (store.recommendPlaylists[recommendSourceSafe] ?? [])"
|
|
||||||
:key="playlist.id"
|
|
||||||
:to="`/playlist/${playlist.id}?platform=${playlist.platform}`"
|
|
||||||
class="playlist-card hover-scale"
|
|
||||||
>
|
|
||||||
<CoverArt :url="playlist.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="playlist-name">{{ playlist.name }}</div>
|
|
||||||
</RouterLink>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Find** the 每日推荐 section (currently around lines 36-51):
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<!-- 每日推荐 -->
|
|
||||||
<section class="section" v-if="store.dailySongs.length > 0">
|
|
||||||
<h2 class="section-title">每日推荐</h2>
|
|
||||||
<div class="daily-grid">
|
|
||||||
<div
|
|
||||||
v-for="song in store.dailySongs.slice(0, 12)"
|
|
||||||
:key="song.id"
|
|
||||||
class="daily-card hover-scale"
|
|
||||||
@click="store.playSong(song)"
|
|
||||||
>
|
|
||||||
<CoverArt :url="song.coverUrl" :size="120" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="daily-name">{{ song.name }}</div>
|
|
||||||
<div class="daily-artist">{{ song.artist }}</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Replace with:**
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<!-- 每日推荐 -->
|
|
||||||
<section class="section" v-if="dailyAvailable.length > 0">
|
|
||||||
<h2 class="section-title">
|
|
||||||
每日推荐
|
|
||||||
<SourceTabs v-model="dailySource" :sources="dailyAvailable" />
|
|
||||||
</h2>
|
|
||||||
<div class="daily-grid">
|
|
||||||
<div
|
|
||||||
v-for="song in (store.dailySongs[dailySourceSafe] ?? []).slice(0, 12)"
|
|
||||||
:key="song.id"
|
|
||||||
class="daily-card hover-scale"
|
|
||||||
@click="store.playSong(song)"
|
|
||||||
>
|
|
||||||
<CoverArt :url="song.coverUrl" :size="120" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="daily-name">{{ song.name }}</div>
|
|
||||||
<div class="daily-artist">{{ song.artist }}</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Find** the 我的歌单 section (currently around lines 69-95):
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<!-- 我的歌单 -->
|
|
||||||
<section class="section" v-if="store.userPlaylists.length > 0">
|
|
||||||
<h2 class="section-title">
|
|
||||||
我的歌单
|
|
||||||
<span class="section-count">{{ store.userPlaylists.length }}</span>
|
|
||||||
</h2>
|
|
||||||
<div class="playlist-grid">
|
|
||||||
<RouterLink
|
|
||||||
v-for="pl in visibleUserPlaylists"
|
|
||||||
:key="pl.id"
|
|
||||||
:to="`/playlist/${pl.id}?platform=${pl.platform}`"
|
|
||||||
class="playlist-card hover-scale"
|
|
||||||
>
|
|
||||||
<CoverArt :url="pl.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="playlist-name">{{ pl.name }}</div>
|
|
||||||
<div class="playlist-count">{{ pl.songCount }} 首</div>
|
|
||||||
</RouterLink>
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
v-if="store.userPlaylists.length > USER_PLAYLIST_LIMIT"
|
|
||||||
class="expand-btn"
|
|
||||||
@click="userPlaylistsExpanded = !userPlaylistsExpanded"
|
|
||||||
>
|
|
||||||
<Icon :icon="userPlaylistsExpanded ? 'mdi:chevron-up' : 'mdi:chevron-down'" />
|
|
||||||
{{ userPlaylistsExpanded ? '收起' : `展开全部 ${store.userPlaylists.length} 个歌单` }}
|
|
||||||
</button>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Replace with:**
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<!-- 我的歌单 -->
|
|
||||||
<section class="section" v-if="userAvailable.length > 0">
|
|
||||||
<h2 class="section-title">
|
|
||||||
我的歌单
|
|
||||||
<span class="section-count">{{ currentUserPlaylists.length }}</span>
|
|
||||||
<SourceTabs v-model="userSource" :sources="userAvailable" />
|
|
||||||
</h2>
|
|
||||||
<div class="playlist-grid">
|
|
||||||
<RouterLink
|
|
||||||
v-for="pl in visibleUserPlaylists"
|
|
||||||
:key="pl.id"
|
|
||||||
:to="`/playlist/${pl.id}?platform=${pl.platform}`"
|
|
||||||
class="playlist-card hover-scale"
|
|
||||||
>
|
|
||||||
<CoverArt :url="pl.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="playlist-name">{{ pl.name }}</div>
|
|
||||||
<div class="playlist-count">{{ pl.songCount }} 首</div>
|
|
||||||
</RouterLink>
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
v-if="currentUserPlaylists.length > USER_PLAYLIST_LIMIT"
|
|
||||||
class="expand-btn"
|
|
||||||
@click="userPlaylistsExpanded = !userPlaylistsExpanded"
|
|
||||||
>
|
|
||||||
<Icon :icon="userPlaylistsExpanded ? 'mdi:chevron-up' : 'mdi:chevron-down'" />
|
|
||||||
{{ userPlaylistsExpanded ? '收起' : `展开全部 ${currentUserPlaylists.length} 个歌单` }}
|
|
||||||
</button>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 3.3: Update Home.vue `<script setup>`**
|
|
||||||
|
|
||||||
**Find** the `<script setup lang="ts">` block (currently around lines 119-153):
|
|
||||||
|
|
||||||
```ts
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ref, computed, onMounted } from 'vue';
|
|
||||||
import { Icon } from '@iconify/vue';
|
|
||||||
import axios from 'axios';
|
|
||||||
import { usePlayerStore, type Song } from '../stores/player.js';
|
|
||||||
import CoverArt from '../components/CoverArt.vue';
|
|
||||||
|
|
||||||
const store = usePlayerStore();
|
|
||||||
const USER_PLAYLIST_LIMIT = 20;
|
|
||||||
const userPlaylistsExpanded = ref(false);
|
|
||||||
const visibleUserPlaylists = computed(() =>
|
|
||||||
userPlaylistsExpanded.value
|
|
||||||
? store.userPlaylists
|
|
||||||
: store.userPlaylists.slice(0, USER_PLAYLIST_LIMIT)
|
|
||||||
);
|
|
||||||
|
|
||||||
async function playFm() {
|
|
||||||
try {
|
|
||||||
const res = await axios.get('/api/music/personal/fm');
|
|
||||||
const songs: Song[] = res.data.songs;
|
|
||||||
if (songs.length > 0) {
|
|
||||||
await store.play(songs[0].name, songs[0].platform);
|
|
||||||
for (let i = 1; i < songs.length; i++) {
|
|
||||||
await store.addToQueue(songs[i].name, songs[i].platform);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch {
|
|
||||||
// Ignore
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
onMounted(() => {
|
|
||||||
store.fetchHomeData();
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Replace with:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ref, computed, watch, onMounted } from 'vue';
|
|
||||||
import { Icon } from '@iconify/vue';
|
|
||||||
import axios from 'axios';
|
|
||||||
import { usePlayerStore, type Song, type Source } from '../stores/player.js';
|
|
||||||
import { loadTabSource, saveTabSource } from '../stores/sourceTabs.js';
|
|
||||||
import CoverArt from '../components/CoverArt.vue';
|
|
||||||
import SourceTabs from '../components/SourceTabs.vue';
|
|
||||||
|
|
||||||
const store = usePlayerStore();
|
|
||||||
const USER_PLAYLIST_LIMIT = 20;
|
|
||||||
const userPlaylistsExpanded = ref(false);
|
|
||||||
|
|
||||||
// Available sources per section. Recommend playlists are public for both
|
|
||||||
// platforms — netease always; qq only when logged in. Daily and user
|
|
||||||
// playlists need login on both sides.
|
|
||||||
const recommendAvailable = computed<Source[]>(() => {
|
|
||||||
const s: Source[] = ['netease'];
|
|
||||||
if (store.authStatus.qq) s.push('qq');
|
|
||||||
return s;
|
|
||||||
});
|
|
||||||
const dailyAvailable = computed<Source[]>(() => {
|
|
||||||
const s: Source[] = [];
|
|
||||||
if (store.authStatus.netease) s.push('netease');
|
|
||||||
if (store.authStatus.qq) s.push('qq');
|
|
||||||
return s;
|
|
||||||
});
|
|
||||||
const userAvailable = computed<Source[]>(() => {
|
|
||||||
const s: Source[] = [];
|
|
||||||
if (store.authStatus.netease) s.push('netease');
|
|
||||||
if (store.authStatus.qq) s.push('qq');
|
|
||||||
return s;
|
|
||||||
});
|
|
||||||
|
|
||||||
// Persisted active source per section.
|
|
||||||
const recommendSource = ref<Source>(loadTabSource('home.recommend'));
|
|
||||||
const dailySource = ref<Source>(loadTabSource('home.daily'));
|
|
||||||
const userSource = ref<Source>(loadTabSource('home.user'));
|
|
||||||
|
|
||||||
watch(recommendSource, (v) => saveTabSource('home.recommend', v));
|
|
||||||
watch(dailySource, (v) => saveTabSource('home.daily', v));
|
|
||||||
watch(userSource, (v) => saveTabSource('home.user', v));
|
|
||||||
|
|
||||||
// Fallback when persisted source is no longer available (e.g. user logged
|
|
||||||
// out of QQ since last visit). We render against `*Safe` but never write
|
|
||||||
// back, so the user's preference is preserved for when they log in again.
|
|
||||||
const recommendSourceSafe = computed<Source>(() =>
|
|
||||||
recommendAvailable.value.includes(recommendSource.value)
|
|
||||||
? recommendSource.value
|
|
||||||
: recommendAvailable.value[0] ?? 'netease'
|
|
||||||
);
|
|
||||||
const dailySourceSafe = computed<Source>(() =>
|
|
||||||
dailyAvailable.value.includes(dailySource.value)
|
|
||||||
? dailySource.value
|
|
||||||
: dailyAvailable.value[0] ?? 'netease'
|
|
||||||
);
|
|
||||||
const userSourceSafe = computed<Source>(() =>
|
|
||||||
userAvailable.value.includes(userSource.value)
|
|
||||||
? userSource.value
|
|
||||||
: userAvailable.value[0] ?? 'netease'
|
|
||||||
);
|
|
||||||
|
|
||||||
const currentUserPlaylists = computed(() => store.userPlaylists[userSourceSafe.value] ?? []);
|
|
||||||
const visibleUserPlaylists = computed(() =>
|
|
||||||
userPlaylistsExpanded.value
|
|
||||||
? currentUserPlaylists.value
|
|
||||||
: currentUserPlaylists.value.slice(0, USER_PLAYLIST_LIMIT)
|
|
||||||
);
|
|
||||||
|
|
||||||
async function playFm() {
|
|
||||||
try {
|
|
||||||
const res = await axios.get('/api/music/personal/fm');
|
|
||||||
const songs: Song[] = res.data.songs;
|
|
||||||
if (songs.length > 0) {
|
|
||||||
await store.play(songs[0].name, songs[0].platform);
|
|
||||||
for (let i = 1; i < songs.length; i++) {
|
|
||||||
await store.addToQueue(songs[i].name, songs[i].platform);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch {
|
|
||||||
// Ignore
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
onMounted(() => {
|
|
||||||
store.fetchHomeData();
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: The 我的歌单 template uses `userSource` (not `userSourceSafe`) on the `<SourceTabs>` v-model so the user's click maps directly to the persisted ref. The grid below the tabs uses `currentUserPlaylists` which derives from `userSourceSafe`, so even if `userSource` points at an unavailable platform momentarily, the grid still renders something sensible. Same pattern for 推荐歌单 / 每日推荐.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 4: Migrate Library.vue and remove dead code
|
|
||||||
|
|
||||||
**Files:**
|
|
||||||
- Modify: `web/src/views/Library.vue`
|
|
||||||
|
|
||||||
- [ ] **Step 4.1: Replace the template**
|
|
||||||
|
|
||||||
**Find** the `<template>` block (currently lines 1-64) and **replace the entire template with:**
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<template>
|
|
||||||
<div class="library-page">
|
|
||||||
<h1 class="page-title">音乐库</h1>
|
|
||||||
|
|
||||||
<!-- 我的歌单 -->
|
|
||||||
<section class="section" v-if="userAvailable.length > 0">
|
|
||||||
<h2 class="section-title">
|
|
||||||
我的歌单
|
|
||||||
<span class="section-count">{{ currentUserPlaylists.length }}</span>
|
|
||||||
<SourceTabs v-model="userSource" :sources="userAvailable" />
|
|
||||||
</h2>
|
|
||||||
<div class="playlist-grid">
|
|
||||||
<RouterLink
|
|
||||||
v-for="pl in currentUserPlaylists"
|
|
||||||
:key="pl.id"
|
|
||||||
:to="`/playlist/${pl.id}?platform=${pl.platform}`"
|
|
||||||
class="playlist-card hover-scale"
|
|
||||||
>
|
|
||||||
<CoverArt :url="pl.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="playlist-name">{{ pl.name }}</div>
|
|
||||||
<div class="playlist-count">{{ pl.songCount }} 首</div>
|
|
||||||
</RouterLink>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<!-- 最近播放 -->
|
|
||||||
<section class="section">
|
|
||||||
<h2 class="section-title">最近播放</h2>
|
|
||||||
<div v-if="historyLoading" class="loading">加载中...</div>
|
|
||||||
<div v-else-if="history.length === 0" class="empty">暂无播放记录</div>
|
|
||||||
<div v-else class="song-list">
|
|
||||||
<SongCard
|
|
||||||
v-for="(song, i) in history.slice(0, 10)"
|
|
||||||
:key="`hist-${song.id}-${i}`"
|
|
||||||
:song="song"
|
|
||||||
:index="i + 1"
|
|
||||||
:active="store.currentSong?.id === song.id"
|
|
||||||
@play="store.play(song.name, song.platform)"
|
|
||||||
@add="store.addToQueue(song.name, song.platform)"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<div v-if="!historyLoading && userAvailable.length === 0 && history.length === 0" class="empty-state">
|
|
||||||
<Icon icon="mdi:music-box-outline" class="empty-icon" />
|
|
||||||
<div>登录网易云或QQ音乐后，这里将显示你的歌单和播放记录</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
Changes from the previous version:
|
|
||||||
- "我的歌单" section: same data binding pattern as Home (`userAvailable`, `currentUserPlaylists`, `<SourceTabs>`)
|
|
||||||
- "我的收藏" section: removed entirely (the `/api/music/user/liked` endpoint never existed)
|
|
||||||
- Empty state condition: replaced `liked.length === 0` with `userAvailable.length === 0`
|
|
||||||
|
|
||||||
- [ ] **Step 4.2: Replace the script block**
|
|
||||||
|
|
||||||
**Find** the `<script setup lang="ts">` block (currently lines 66-105) and **replace with:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
<script setup lang="ts">
|
|
||||||
import { ref, computed, watch, onMounted } from 'vue';
|
|
||||||
import { Icon } from '@iconify/vue';
|
|
||||||
import axios from 'axios';
|
|
||||||
import { usePlayerStore, type Song, type Source } from '../stores/player.js';
|
|
||||||
import { loadTabSource, saveTabSource } from '../stores/sourceTabs.js';
|
|
||||||
import CoverArt from '../components/CoverArt.vue';
|
|
||||||
import SongCard from '../components/SongCard.vue';
|
|
||||||
import SourceTabs from '../components/SourceTabs.vue';
|
|
||||||
|
|
||||||
const store = usePlayerStore();
|
|
||||||
|
|
||||||
const history = ref<Song[]>([]);
|
|
||||||
const historyLoading = ref(true);
|
|
||||||
|
|
||||||
const userAvailable = computed<Source[]>(() => {
|
|
||||||
const s: Source[] = [];
|
|
||||||
if (store.authStatus.netease) s.push('netease');
|
|
||||||
if (store.authStatus.qq) s.push('qq');
|
|
||||||
return s;
|
|
||||||
});
|
|
||||||
|
|
||||||
const userSource = ref<Source>(loadTabSource('library.user'));
|
|
||||||
watch(userSource, (v) => saveTabSource('library.user', v));
|
|
||||||
|
|
||||||
const userSourceSafe = computed<Source>(() =>
|
|
||||||
userAvailable.value.includes(userSource.value)
|
|
||||||
? userSource.value
|
|
||||||
: userAvailable.value[0] ?? 'netease'
|
|
||||||
);
|
|
||||||
|
|
||||||
const currentUserPlaylists = computed(() => store.userPlaylists[userSourceSafe.value] ?? []);
|
|
||||||
|
|
||||||
onMounted(async () => {
|
|
||||||
if (!store.activeBotId) {
|
|
||||||
await store.fetchBots();
|
|
||||||
}
|
|
||||||
|
|
||||||
store.fetchHomeData();
|
|
||||||
|
|
||||||
if (store.activeBotId) {
|
|
||||||
try {
|
|
||||||
const res = await axios.get(`/api/player/${store.activeBotId}/history`);
|
|
||||||
history.value = res.data.history ?? [];
|
|
||||||
} catch {
|
|
||||||
// API may not be ready
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
historyLoading.value = false;
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
- Removed `liked` ref and the `/api/music/user/liked` axios call
|
|
||||||
- Added auth-driven `userAvailable`, persisted `userSource`, and `currentUserPlaylists` computed
|
|
||||||
- Imports `Source` type and `SourceTabs` component
|
|
||||||
|
|
||||||
- [ ] **Step 4.3: Style — `.section-title` already supports inline children**
|
|
||||||
|
|
||||||
The existing `.section-title` style (Library.vue and Home.vue both) already uses `display: flex; align-items: center; gap: 8px;`. SourceTabs uses `display: inline-flex` with its own `margin-left`, so it sits inline with the title and count. **No style changes are required in either Home.vue or Library.vue.**
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 5: Verify the build and types
|
|
||||||
|
|
||||||
- [ ] **Step 5.1: Run TypeScript backend type check**
|
|
||||||
|
|
||||||
```
|
|
||||||
npx tsc --noEmit
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: exit code 0, no output. (No backend files were touched.)
|
|
||||||
|
|
||||||
- [ ] **Step 5.2: Run web type check + production build**
|
|
||||||
|
|
||||||
```
|
|
||||||
npm run build:web
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: build completes with `✓ built in N.NNs` and no TypeScript errors. The script runs `vue-tsc --noEmit && vite build`, so failures here mean a type or template error in our changes.
|
|
||||||
|
|
||||||
- [ ] **Step 5.3: Run the existing test suite to confirm no regression**
|
|
||||||
|
|
||||||
```
|
|
||||||
npm test
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected: same baseline as before this feature (`Test Files 2 failed | 26 passed (28)`, `Tests 2 failed | 161 passed (163)`). The 2 pre-existing failures are in `dist/` and `.claude/worktrees/` and are unrelated to our changes — they should remain at exactly 2.
|
|
||||||
|
|
||||||
If any **source-tree** test fails (anything not in `dist/` or `.claude/worktrees/`), stop and investigate.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 6: Manual smoke test on the dev server
|
|
||||||
|
|
||||||
This task verifies behavior the type system can't catch.
|
|
||||||
|
|
||||||
- [ ] **Step 6.1: Start the dev server**
|
|
||||||
|
|
||||||
```
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Wait for `Web server started` and `WebUI: http://localhost:3000` log lines.
|
|
||||||
|
|
||||||
- [ ] **Step 6.2: Test scenario A — only NetEase logged in**
|
|
||||||
|
|
||||||
Open http://localhost:3000 in a browser. Confirm:
|
|
||||||
|
|
||||||
- 推荐歌单 section displays NetEase playlists, **no tab bar visible** (single source, SourceTabs auto-hidden)
|
|
||||||
- 每日推荐 section: visible only if NetEase login provides daily songs; **no tab bar**
|
|
||||||
- 我的歌单 section: visible if NetEase has user playlists; **no tab bar**
|
|
||||||
- Navigate to `/library`: 我的歌单 section: same — no tab bar, NetEase playlists shown
|
|
||||||
|
|
||||||
Open DevTools → Application → Local Storage → `localhost:3000` → `source-tabs` should be absent or `{}` (no clicks happened).
|
|
||||||
|
|
||||||
- [ ] **Step 6.3: Test scenario B — both NetEase and QQ logged in**
|
|
||||||
|
|
||||||
If QQ is not logged in, log in via Settings → QQ Music → 扫码登录.
|
|
||||||
|
|
||||||
Hard reload the browser (Cmd/Ctrl+Shift+R) to bypass the 5-min `lastFetchTime` cache.
|
|
||||||
|
|
||||||
Confirm:
|
|
||||||
|
|
||||||
- 推荐歌单: tab bar shows `[网易云] [QQ]`, NetEase active by default
|
|
||||||
- Click `QQ` — playlist grid switches to QQ data, no flicker (data already in store)
|
|
||||||
- Click `网易云` — back to NetEase
|
|
||||||
- Same for 每日推荐 and 我的歌单
|
|
||||||
- Navigate to `/library`, confirm 我的歌单 has its own tab bar with independent state
|
|
||||||
- Reload the page — Home tabs and Library tab persist their last-selected source independently
|
|
||||||
|
|
||||||
Check `localStorage['source-tabs']`: should contain JSON with up to 4 keys (`home.recommend`, `home.daily`, `home.user`, `library.user`).
|
|
||||||
|
|
||||||
- [ ] **Step 6.4: Test scenario C — fallback when persisted source becomes unavailable**
|
|
||||||
|
|
||||||
While logged into both:
|
|
||||||
1. On Home, switch 推荐歌单 to `QQ`. Confirm `localStorage['source-tabs']['home.recommend'] === 'qq'`.
|
|
||||||
2. Go to Settings → log out of QQ.
|
|
||||||
3. Hard-reload Home.
|
|
||||||
|
|
||||||
Confirm:
|
|
||||||
- 推荐歌单 tab bar disappears (only NetEase available)
|
|
||||||
- Grid shows NetEase playlists (graceful fallback via `recommendSourceSafe`)
|
|
||||||
- `localStorage['source-tabs']['home.recommend']` is **still `'qq'`** (preference preserved)
|
|
||||||
4. Log back into QQ → reload → 推荐歌单 grid is QQ again (preference restored)
|
|
||||||
|
|
||||||
- [ ] **Step 6.5: Test mobile layout**
|
|
||||||
|
|
||||||
Open DevTools → Toggle device toolbar → set width to 375px (iPhone SE).
|
|
||||||
|
|
||||||
Confirm on Home and Library:
|
|
||||||
- Section title + tab bar fit on the same line without overflow
|
|
||||||
- Tab buttons are at least 36px tall (use Inspect → check computed `min-height`)
|
|
||||||
- Tabs are tappable (clicking still switches sources)
|
|
||||||
|
|
||||||
- [ ] **Step 6.6: Stop the dev server**
|
|
||||||
|
|
||||||
Kill the `npm run dev` process.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Task 7: Final commit
|
|
||||||
|
|
||||||
- [ ] **Step 7.1: Stage and commit Task 2 + 3 + 4 changes**
|
|
||||||
|
|
||||||
```
|
|
||||||
git add web/src/stores/player.ts web/src/stores/sourceTabs.ts web/src/views/Home.vue web/src/views/Library.vue
|
|
||||||
git status
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected `git status` output: 4 modified/new files staged, working tree otherwise clean (apart from pre-existing `.claude/worktrees/` and `test-ts6-version.cjs` untracked).
|
|
||||||
|
|
||||||
```
|
|
||||||
git commit -m "feat(web): per-platform source tabs on Home and Library
|
|
||||||
|
|
||||||
Recommend playlists, daily songs, and user playlists on Home now show
|
|
||||||
a [网易云][QQ] tab when both platforms are logged in. Library 我的歌单
|
|
||||||
gets the same tab. Selection persists per-section in localStorage and
|
|
||||||
falls back gracefully when the persisted source becomes unavailable
|
|
||||||
(e.g., user logged out). Removes dead 我的收藏 block from Library that
|
|
||||||
referenced a non-existent /api/music/user/liked endpoint.
|
|
||||||
|
|
||||||
Spec: docs/superpowers/specs/2026-05-06-music-source-tabs-design.md
|
|
||||||
|
|
||||||
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>"
|
|
||||||
```
|
|
||||||
|
|
||||||
- [ ] **Step 7.2: Verify commit landed**
|
|
||||||
|
|
||||||
```
|
|
||||||
git log --oneline -3
|
|
||||||
```
|
|
||||||
|
|
||||||
Expected:
|
|
||||||
```
|
|
||||||
<sha> feat(web): per-platform source tabs on Home and Library
|
|
||||||
<sha> feat(web): add SourceTabs component for platform switcher
|
|
||||||
<sha> docs: spec for multi-source tabs on Home and Library
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Done
|
|
||||||
|
|
||||||
The branch should now have 3 new commits on top of the merge commit, all green builds and tests, and the feature working in dev mode.
|
|
||||||
File diff suppressed because it is too large.
Load diff
@@ -1,520 +0,0 @@
|
|||||||
# 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)
|
|
||||||
@@ -1,903 +0,0 @@
|
|||||||
# 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
@@ -1,124 +0,0 @@
|
|||||||
# Bot Profile Manager — Design Spec
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
When the bot plays a song, automatically update its TeamSpeak presence (avatar, description, nickname, away status, channel description) and send a "now playing" chat message. When playback stops, restore all values to defaults. Each feature is independently configurable and permission-safe — if the bot lacks a required server permission, that feature silently disables itself until the next reconnect.
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
| # | Feature | Update on song | Restore on stop | TS3 mechanism | TS6 mechanism |
|
|
||||||
|---|---------|---------------|-----------------|---------------|---------------|
|
|
||||||
| 1 | Avatar | Album cover art | Delete avatar | File transfer upload + `clientupdate client_flag_avatar=<md5>` | Same (file transfer is protocol-level) |
|
|
||||||
| 2 | Description | `歌名 - 歌手 [专辑]` | Clear (empty string) | `clientupdate client_description=...` | `httpQuery.clientUpdate(...)` |
|
|
||||||
| 3 | Nickname | `♪ 歌名 - 歌手 \| 原昵称` (max 30 chars) | Restore `defaultNickname` | `clientupdate client_nickname=...` | `httpQuery.clientUpdate(...)` |
|
|
||||||
| 4 | Away status | `client_away=1`, message = `正在播放: 歌名 - 歌手` | `client_away=0` | `clientupdate client_away=...` | `httpQuery.clientUpdate(...)` |
|
|
||||||
| 5 | Channel description | `正在播放: 歌名 - 歌手\n专辑: xxx\n平台: xxx` | Clear | `channeledit cid=... channel_description=...` | `httpQuery.request("POST", "/1/channeledit", ...)` |
|
|
||||||
| 6 | Now-playing message | `♪ 正在播放: 歌名 - 歌手 [专辑]` | (not sent on stop) | `sendTextMessage` (existing) | `sendTextMessage` (existing) |
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
```
|
|
||||||
resolveAndPlay() success / stop / clear / playNext exhausted
|
|
||||||
↓
|
|
||||||
BotInstance → BotProfileManager.onSongChange(song | null)
|
|
||||||
├─ updateAvatar(coverUrl | null) [fire-and-forget]
|
|
||||||
├─ updateDescription(song | null)
|
|
||||||
├─ updateNickname(song | null)
|
|
||||||
├─ updateAwayStatus(song | null)
|
|
||||||
├─ updateChannelDescription(song | null)
|
|
||||||
└─ sendNowPlayingMessage(song) [only when song != null]
|
|
||||||
|
|
||||||
BotInstance.connect() → profileManager.onConnect() // reset perm flags, restore defaults
|
|
||||||
BotInstance.disconnect() → (no action needed, server cleans up)
|
|
||||||
```
|
|
||||||
|
|
||||||
## File Changes
|
|
||||||
|
|
||||||
| File | Change |
|
|
||||||
|------|--------|
|
|
||||||
| `src/bot/profile.ts` | **New** — `BotProfileManager` class |
|
|
||||||
| `src/ts-protocol/client.ts` | Add `execCommand`, `execCommandWithResponse`, file transfer methods, `escapeTS3()` |
|
|
||||||
| `src/bot/instance.ts` | Create & hold `BotProfileManager`, call at lifecycle points |
|
|
||||||
| `src/data/database.ts` | Add 6 profile config columns via ALTER TABLE migration |
|
|
||||||
| `src/web/api/player.ts` | Add `GET/PUT /api/player/:botId/profile` endpoints |
|
|
||||||
|
|
||||||
## TS3Client Layer Extensions
|
|
||||||
|
|
||||||
New methods on `TS3Client` (all delegate to underlying `@honeybbq/teamspeak-client` Client):
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
execCommand(cmd: string): Promise<void>
|
|
||||||
execCommandWithResponse(cmd: string): Promise<Record<string, string>[]>
|
|
||||||
fileTransferInitUpload(channelID: bigint, path: string, password: string,
|
|
||||||
size: bigint, overwrite?: boolean): Promise<FileUploadInfo>
|
|
||||||
uploadFileData(host: string, info: FileUploadInfo, data: Readable): Promise<void>
|
|
||||||
fileTransferDeleteFile(channelID: bigint, paths: string[]): Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
Utility: `escapeTS3(str: string): string` — escapes spaces (`\s`), backslashes (`\\`), pipes (`\p`), slashes (`\/`).
|
|
||||||
|
|
||||||
## BotProfileManager Detail
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
interface ProfileConfig {
|
|
||||||
avatarEnabled: boolean; // default true
|
|
||||||
descriptionEnabled: boolean; // default true
|
|
||||||
nicknameEnabled: boolean; // default true
|
|
||||||
awayStatusEnabled: boolean; // default true
|
|
||||||
channelDescEnabled: boolean; // default true
|
|
||||||
nowPlayingMsgEnabled: boolean; // default true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Permission Handling
|
|
||||||
|
|
||||||
- Each feature has an independent `permDenied: boolean` flag.
|
|
||||||
- On first failure where error message contains "permission" or "insufficient" → set flag, skip subsequent calls.
|
|
||||||
- On `onConnect()` → reset all flags (new connection may have different permissions).
|
|
||||||
- Non-permission errors (network timeout, etc.) do NOT set the flag — next song change will retry.
|
|
||||||
|
|
||||||
### Nickname Truncation
|
|
||||||
|
|
||||||
- Format: `♪ {songInfo} | {defaultNickname}`
|
|
||||||
- TS3 max nickname: 30 characters
|
|
||||||
- If total > 30: truncate songInfo, keep defaultNickname
|
|
||||||
- If `♪ | {defaultNickname}` alone > 30: skip nickname update entirely
|
|
||||||
|
|
||||||
### Avatar Upload Flow (TS3)
|
|
||||||
|
|
||||||
1. Download cover image via axios (HTTP GET coverUrl) → Buffer
|
|
||||||
2. `fileTransferInitUpload(0n, "/avatar", "", BigInt(buffer.length), true)`
|
|
||||||
3. `uploadFileData(host, info, Readable.from(buffer))`
|
|
||||||
4. Compute MD5: `crypto.createHash('md5').update(buffer).digest('hex')`
|
|
||||||
5. `execCommand("clientupdate client_flag_avatar=" + md5)`
|
|
||||||
|
|
||||||
To clear: `fileTransferDeleteFile(0n, ["/avatar"])` + `execCommand("clientupdate client_flag_avatar=")`
|
|
||||||
|
|
||||||
### Fire-and-Forget
|
|
||||||
|
|
||||||
Avatar download/upload is slow. `onSongChange()` launches all updates concurrently via `Promise.allSettled()` — failures are logged but never block playback.
|
|
||||||
|
|
||||||
## Database Migration
|
|
||||||
|
|
||||||
```sql
|
|
||||||
ALTER TABLE bot_instances ADD COLUMN profile_avatar_enabled INTEGER DEFAULT 1;
|
|
||||||
ALTER TABLE bot_instances ADD COLUMN profile_description_enabled INTEGER DEFAULT 1;
|
|
||||||
ALTER TABLE bot_instances ADD COLUMN profile_nickname_enabled INTEGER DEFAULT 1;
|
|
||||||
ALTER TABLE bot_instances ADD COLUMN profile_away_enabled INTEGER DEFAULT 1;
|
|
||||||
ALTER TABLE bot_instances ADD COLUMN profile_channel_desc_enabled INTEGER DEFAULT 1;
|
|
||||||
ALTER TABLE bot_instances ADD COLUMN profile_now_playing_enabled INTEGER DEFAULT 1;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Web API
|
|
||||||
|
|
||||||
```
|
|
||||||
GET /api/player/:botId/profile → { avatarEnabled, descriptionEnabled, ... }
|
|
||||||
PUT /api/player/:botId/profile → body: Partial<ProfileConfig> → 200 OK
|
|
||||||
```
|
|
||||||
|
|
||||||
## Constraints
|
|
||||||
|
|
||||||
- All profile operations are async, never block playback
|
|
||||||
- Uses existing `axios` dependency for image download
|
|
||||||
- MD5 via Node.js built-in `crypto`
|
|
||||||
- No new npm dependencies required
|
|
||||||
@@ -1,125 +0,0 @@
|
|||||||
# Design: FM Bug Fix + Artist Loop + Playlist Fuzzy Search
|
|
||||||
|
|
||||||
Date: 2026-04-27
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Three features for the TeamSpeak Music Bot:
|
|
||||||
1. New `!artist <name>` command — loop playback filtered by artist
|
|
||||||
2. Fuzzy playlist name search in existing `!playlist` command
|
|
||||||
3. Fix `!fm` audio dropout bug (no sound after a few songs but status shows playing)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Feature 1: `!artist` Command
|
|
||||||
|
|
||||||
### Behavior
|
|
||||||
|
|
||||||
`!artist <歌手名> [-q|-b|-y]` searches for songs by the artist, loads them into the queue, sets the queue mode to `Loop`, and starts playing.
|
|
||||||
|
|
||||||
### Flow
|
|
||||||
|
|
||||||
1. Parse command with optional platform flags (`-q`, `-b`, `-y`)
|
|
||||||
2. Call `provider.search(歌手名, 50)` to get up to 50 results
|
|
||||||
3. Filter results: only keep songs where `song.artist` contains the search query (case-insensitive)
|
|
||||||
4. If filtered list is empty, fall back to unfiltered search results (up to 20)
|
|
||||||
5. Clear current queue, add filtered songs, set mode to `Loop`
|
|
||||||
6. Play first song via `resolveAndPlay`
|
|
||||||
|
|
||||||
### Key Decisions
|
|
||||||
|
|
||||||
- **Why Loop mode?** The user said "循环播放" (loop playback). After the artist's songs are exhausted, they should restart.
|
|
||||||
- **Why filter client-side?** The search API doesn't support artist-only filtering. We search broadly then narrow down.
|
|
||||||
- **Why 50 results?** The default limit is 20, but for prolific artists we want more coverage. 50 balances API response size with coverage.
|
|
||||||
|
|
||||||
### Files Changed
|
|
||||||
|
|
||||||
- `src/bot/commands.ts`: Register `artist` in PUBLIC_COMMANDS, update help text
|
|
||||||
- `src/bot/instance.ts`: New `cmdArtist()` method
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Feature 2: Playlist Fuzzy Search
|
|
||||||
|
|
||||||
### Behavior
|
|
||||||
|
|
||||||
`!playlist <name or ID>` now accepts both playlist IDs and playlist names. When the input is not a pure numeric ID, it searches for matching playlists and uses the top result.
|
|
||||||
|
|
||||||
### Flow
|
|
||||||
|
|
||||||
1. Parse input — if it's a pure numeric ID or contains a URL with an ID, use existing logic
|
|
||||||
2. Otherwise, call `provider.search(input)` which already returns `playlists[]` in the result
|
|
||||||
3. Also call `provider.getUserPlaylists()` if the provider supports it (logged-in state)
|
|
||||||
4. Client-side fuzzy match user playlists: `playlist.name` contains input (case-insensitive)
|
|
||||||
5. Merge results: public search results first (sorted by API relevance), then user matches
|
|
||||||
6. Take the first playlist, load its songs, play
|
|
||||||
|
|
||||||
### Key Decisions
|
|
||||||
|
|
||||||
- **Why public search first?** It's already sorted by relevance from the API. User playlists are a secondary source.
|
|
||||||
- **Why client-side matching for user playlists?** The `getUserPlaylists()` API returns all user playlists without a search parameter, so we must filter locally.
|
|
||||||
- **Backward compatibility:** Numeric IDs and URL parsing are unchanged.
|
|
||||||
|
|
||||||
### Files Changed
|
|
||||||
|
|
||||||
- `src/bot/instance.ts`: Modify `cmdPlaylist()` to add search fallback
|
|
||||||
- `src/bot/commands.ts`: Update help text
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Feature 3: FM Bug Fix
|
|
||||||
|
|
||||||
### Root Cause Analysis
|
|
||||||
|
|
||||||
The `!fm` bug manifests as: audio stops after a few songs, but `!now` shows a playing song and the song name keeps changing.
|
|
||||||
|
|
||||||
`getPersonalFm()` returns only ~3 songs per API call. After those are consumed:
|
|
||||||
- In `Sequential` mode: `queue.next()` returns null → `player.stop()` is called → playback stops entirely. This does NOT match "歌还在轮播" (songs still rotating).
|
|
||||||
- In `Loop` mode (if user changed mode): the same 3 songs loop, but URLs may expire, causing silent playback failures.
|
|
||||||
|
|
||||||
The most likely scenario for "no audio but status shows playing + song names changing":
|
|
||||||
1. FM songs have URLs that resolve but don't produce playable audio (copyright/region restrictions)
|
|
||||||
2. ffmpeg spawns, connects to the URL, gets an HTTP error or silent stream
|
|
||||||
3. ffmpeg exits quickly (clean exit or error)
|
|
||||||
4. The frame loop detects ffmpeg gone + buffer empty → emits `trackEnd`
|
|
||||||
5. `playNext()` advances to the next song
|
|
||||||
6. This rapid cycle (spawn → fail → advance) makes it appear that songs are "playing and rotating" but with no audio
|
|
||||||
7. After 3 consecutive ffmpeg spawn failures, `consecutiveFailures >= MAX_CONSECUTIVE_FAILURES` → player refuses to spawn new ffmpeg processes
|
|
||||||
8. After that, `resolveAndPlay` still sets state via `player.play()` which immediately emits "error" → `playNext()` skips to next → cycle continues with no ffmpeg at all
|
|
||||||
|
|
||||||
### Fix Strategy
|
|
||||||
|
|
||||||
**Fix 1 — FM auto-refill (primary fix):**
|
|
||||||
- In `cmdFm()`, set queue mode to `RandomLoop` so the queue never "runs out"
|
|
||||||
- Add a `refillFm()` method that fetches more FM songs and appends to queue
|
|
||||||
- Hook into the `trackEnd` flow: when queue has ≤ 2 songs remaining and we're in FM mode, trigger a refill
|
|
||||||
- Track FM state with a boolean flag `isFmMode` on the instance
|
|
||||||
|
|
||||||
**Fix 2 — Reset consecutive failures on successful playback (safety net):**
|
|
||||||
- Reset `consecutiveFailures` when a track plays successfully for at least N frames (e.g., 50 frames = 1 second)
|
|
||||||
- This prevents transient URL failures from accumulating toward the hard limit
|
|
||||||
|
|
||||||
**Fix 3 — FM refill before queue exhaustion:**
|
|
||||||
- After `playNext()` successfully starts a song, check if `isFmMode` and `queue.size() - currentIndex <= 2`
|
|
||||||
- If so, fire an async refill (don't block playback)
|
|
||||||
|
|
||||||
### Files Changed
|
|
||||||
|
|
||||||
- `src/bot/instance.ts`: Modify `cmdFm()`, add `refillFm()`, add FM state tracking, modify `playNext()` to check for FM refill
|
|
||||||
- `src/audio/player.ts`: Add `framesPlayed` threshold check to reset `consecutiveFailures`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Implementation Order
|
|
||||||
|
|
||||||
1. **FM bug fix** first — it's a bug fix affecting current users
|
|
||||||
2. **Playlist fuzzy search** — small change, quick win
|
|
||||||
3. **Artist loop** — new feature, depends on queue/player being stable
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
- FM: Verify songs keep playing beyond the initial 3-song batch, verify auto-refill works
|
|
||||||
- Playlist: Test with numeric ID (backward compat), test with playlist name (fuzzy search)
|
|
||||||
- Artist: Test with known artist names, test edge case (no results), test with platform flags
|
|
||||||
@@ -1,189 +0,0 @@
|
|||||||
# Multi-Source Tabs for Recommend / User Playlists / Daily Songs
|
|
||||||
|
|
||||||
**Date:** 2026-05-06
|
|
||||||
**Status:** Spec — pending implementation
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
Home 和 Library 页面的"推荐歌单 / 每日推荐 / 我的歌单"这三类内容当前硬编码只走网易云。当用户同时登录了网易云和 QQ 音乐时，无法在 Web UI 上看到 QQ 侧的对应内容、也无法切换查看。
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
在以下 4 个 section 上提供"网易云 / QQ"来源切换 tab，桌面端和移动端均可用：
|
|
||||||
|
|
||||||
- `Home.vue` — 推荐歌单
|
|
||||||
- `Home.vue` — 每日推荐
|
|
||||||
- `Home.vue` — 我的歌单
|
|
||||||
- `Library.vue` — 我的歌单
|
|
||||||
|
|
||||||
切换为纯前端动作（数据已预先 fetch），无加载闪烁。各 section 的选择独立持久化。
|
|
||||||
|
|
||||||
## Out of Scope
|
|
||||||
|
|
||||||
- 私人 FM（QQ 无对应概念）
|
|
||||||
- B 站热门（独立第三来源，不属于网易/QQ 切换语义）
|
|
||||||
- 最近播放（bot 维度的播放历史，与音乐源无关）
|
|
||||||
- Library 现有的"我的收藏"段落 —— 当前调用的 `/api/music/user/liked` 端点不存在，是死代码，本次顺手移除
|
|
||||||
- 登录状态实时同步（用户在 Settings 登录后需手动刷新 Home/Library 才能看到 QQ tab）
|
|
||||||
- Tab 排序、隐藏、拖动等高级配置
|
|
||||||
|
|
||||||
## Non-functional Constraints
|
|
||||||
|
|
||||||
- 桌面端（>768px）和移动端（≤768px）布局均可用，tab 与 section title 同行排布；空间不足时允许 flex-wrap
|
|
||||||
- Tab 触控区域有效高度 ≥36px
|
|
||||||
- 现有 5 分钟 home data cache 行为保留
|
|
||||||
- 不引入新的后端端点（后端已通过 `?platform=` 参数支持多源）
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### 数据层（`web/src/stores/player.ts`）
|
|
||||||
|
|
||||||
字段从单平台改为按 platform 切分：
|
|
||||||
|
|
||||||
```ts
|
|
||||||
// 前
|
|
||||||
recommendPlaylists: PlaylistItem[]
|
|
||||||
userPlaylists: PlaylistItem[]
|
|
||||||
dailySongs: Song[]
|
|
||||||
|
|
||||||
// 后
|
|
||||||
recommendPlaylists: { netease: PlaylistItem[]; qq: PlaylistItem[] }
|
|
||||||
userPlaylists: { netease: PlaylistItem[]; qq: PlaylistItem[] }
|
|
||||||
dailySongs: { netease: Song[]; qq: Song[] }
|
|
||||||
|
|
||||||
// 新增
|
|
||||||
authStatus: { netease: boolean; qq: boolean }
|
|
||||||
```
|
|
||||||
|
|
||||||
`fetchHomeData()` 改写：
|
|
||||||
|
|
||||||
1. 并发调用 `/api/auth/status?platform=netease` 与 `?platform=qq`，写入 `authStatus`
|
|
||||||
2. 网易云的三类数据照常 fetch（推荐歌单匿名可访问；每日推荐和我的歌单需登录，未登录时 API 自然返回空或失败，`Promise.allSettled` 已隔离）
|
|
||||||
3. QQ 的三类数据**仅在 QQ 登录时** fetch，未登录则为空数组
|
|
||||||
4. B 站热门保持原样
|
|
||||||
5. 5 分钟缓存 TTL 不变
|
|
||||||
|
|
||||||
### UI 组件
|
|
||||||
|
|
||||||
新增 `web/src/components/SourceTabs.vue`：
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<SourceTabs v-model="activeSource" :sources="availableSources" />
|
|
||||||
```
|
|
||||||
|
|
||||||
Props：
|
|
||||||
- `sources: ('netease' | 'qq')[]` — 由父组件根据 auth 状态过滤后传入
|
|
||||||
- `modelValue: 'netease' | 'qq'` — v-model 绑定
|
|
||||||
|
|
||||||
行为：
|
|
||||||
- `sources.length < 2` 时组件**自身不渲染**（返回空），父组件无需 v-if 包装
|
|
||||||
- 文字标签：`{ netease: '网易云', qq: 'QQ' }`
|
|
||||||
- 视觉：水平排列，激活态用主色（`var(--color-primary)`）下划线 + 加粗，未激活态使用次要文字色
|
|
||||||
- 紧贴 section-title 右侧，使用 `display: inline-flex`，移动端 padding/font-size 缩小
|
|
||||||
|
|
||||||
### 各 section 接入模板
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<section v-if="recommendAvailable.length > 0" class="section">
|
|
||||||
<h2 class="section-title">
|
|
||||||
推荐歌单
|
|
||||||
<SourceTabs v-model="recommendSource" :sources="recommendAvailable" />
|
|
||||||
</h2>
|
|
||||||
<div class="playlist-grid">
|
|
||||||
<RouterLink
|
|
||||||
v-for="pl in store.recommendPlaylists[recommendSource]"
|
|
||||||
:key="pl.id"
|
|
||||||
:to="`/playlist/${pl.id}?platform=${pl.platform}`"
|
|
||||||
class="playlist-card hover-scale"
|
|
||||||
>
|
|
||||||
<CoverArt :url="pl.coverUrl" :size="160" :radius="10" :show-shadow="true" />
|
|
||||||
<div class="playlist-name">{{ pl.name }}</div>
|
|
||||||
</RouterLink>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
```
|
|
||||||
|
|
||||||
每个 section 在 `<script setup>` 维护两个值：
|
|
||||||
|
|
||||||
- `recommendSource: Ref<'netease' | 'qq'>` — 当前选中
|
|
||||||
- `recommendAvailable: ComputedRef<('netease' | 'qq')[]>` — 该 section 在当前登录状态下有哪些 source 可选
|
|
||||||
|
|
||||||
`recommendAvailable` 计算规则：
|
|
||||||
|
|
||||||
| Section | netease 加入条件 | qq 加入条件 |
|
|
||||||
|---|---|---|
|
|
||||||
| Home 推荐歌单 | 总是（公开数据） | `authStatus.qq` |
|
|
||||||
| Home 每日推荐 | `authStatus.netease` | `authStatus.qq` |
|
|
||||||
| Home 我的歌单 | `authStatus.netease` | `authStatus.qq` |
|
|
||||||
| Library 我的歌单 | `authStatus.netease` | `authStatus.qq` |
|
|
||||||
|
|
||||||
#### "我的歌单"展开按钮兼容
|
|
||||||
|
|
||||||
Home 的"我的歌单"现有 `USER_PLAYLIST_LIMIT = 20` 折叠/展开。改造后：
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const visibleUserPlaylists = computed(() => {
|
|
||||||
const all = store.userPlaylists[userSource.value] ?? [];
|
|
||||||
return userPlaylistsExpanded.value ? all : all.slice(0, USER_PLAYLIST_LIMIT);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
切换 source 时折叠态保留（不需 reset）。
|
|
||||||
|
|
||||||
### 持久化
|
|
||||||
|
|
||||||
localStorage 键统一为一个 JSON：
|
|
||||||
|
|
||||||
```
|
|
||||||
key: "source-tabs"
|
|
||||||
value: {
|
|
||||||
"home.recommend": "qq",
|
|
||||||
"home.daily": "netease",
|
|
||||||
"home.user": "qq",
|
|
||||||
"library.user": "netease"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
读：组件 mount 时一次性读 + 解析。
|
|
||||||
写：在 v-model 的 setter 里 `watch` 一次写回。
|
|
||||||
不存在的键 / 解析失败 / 老用户没这个 key —— 默认值 `"netease"`。
|
|
||||||
|
|
||||||
### 边界与回退
|
|
||||||
|
|
||||||
| 情况 | 行为 |
|
|
||||||
|---|---|
|
|
||||||
| 选的 source 不在 `available` 里（例：选了 QQ，登出后回到页面） | 渲染时 fallback 到 `available[0]`，不修改 localStorage（保留用户偏好，下次登回来仍生效） |
|
|
||||||
| `recommendPlaylists.qq` 为空数组（API 失败 or 无数据） | tab 仍可切，切过去显示空 grid（无错误提示，符合现有"空数据隐藏 section"语义；section 顶层 v-if 检查的是 `available.length > 0`，单 platform 数据为空不影响 section 显隐） |
|
|
||||||
| QQ provider 不支持 `getDailyRecommendSongs`（501） | `Promise.allSettled` 已捕获，`dailySongs.qq` 保持 `[]`，等同上一行 |
|
|
||||||
| 用户在 Settings 登录 QQ 后切回 Home | 不自动 refetch / 不自动出 tab —— 用户需手动刷新页面（保留 5 分钟缓存语义） |
|
|
||||||
| 网易云和 QQ 都没登录 | `available` 为空时 section 隐藏（沿用现有逻辑） |
|
|
||||||
| Library "我的收藏" 段落 | 整段移除（含 template、script 中的 `liked` ref、对应 axios 调用） |
|
|
||||||
|
|
||||||
## 修改文件清单
|
|
||||||
|
|
||||||
新增：
|
|
||||||
- `web/src/components/SourceTabs.vue` — 共享 tab 组件
|
|
||||||
|
|
||||||
修改：
|
|
||||||
- `web/src/stores/player.ts` — 多平台 state、`authStatus`、`fetchHomeData` 重写
|
|
||||||
- `web/src/views/Home.vue` — 三个 section 接入 SourceTabs，对应 ref + computed
|
|
||||||
- `web/src/views/Library.vue` — 我的歌单接入 SourceTabs；移除我的收藏死代码
|
|
||||||
|
|
||||||
不改：
|
|
||||||
- 后端（API 已支持 `?platform=`）
|
|
||||||
- `Search.vue` / `Playlist.vue` / `Settings.vue` 等其他页面
|
|
||||||
|
|
||||||
## 测试方案
|
|
||||||
|
|
||||||
- 手动：在两种登录组合下访问 Home 和 Library，验证 tab 显隐、切换、刷新后持久化
|
|
||||||
- 仅网易登录 → 不显示 tab
|
|
||||||
- 两边登录 → 显示 tab，切换后刷新页面来源不变
|
|
||||||
- QQ 登录 → 网易登出 → 网易 tab 消失，若上次选的是网易则 fallback 到 QQ
|
|
||||||
- 移动端（DevTools 768px 以下）：tab 与 section-title 同行不溢出，触控区域可点
|
|
||||||
- TypeScript 类型检查通过：`npx tsc --noEmit` + `npm run build:web`
|
|
||||||
- 单元测试：现有 vitest 套件不应回归（store 改动不破坏其他用法）
|
|
||||||
|
|
||||||
## 风险
|
|
||||||
|
|
||||||
- store 字段类型变更（数组 → 对象）会影响所有读取这三个字段的地方。需 grep 确认没有遗漏的消费者。
|
|
||||||
- localStorage 解析失败的容错必须周全，避免一次脏数据导致整个页面白屏。
|
|
||||||
@@ -1,226 +0,0 @@
|
|||||||
# History-aware `prev` + "Play Next" Insert
|
|
||||||
|
|
||||||
**Date:** 2026-05-06
|
|
||||||
**Status:** Spec — pending implementation
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
Two queue/playback gaps surfaced in real use:
|
|
||||||
|
|
||||||
1. In `PlayMode.Random` and `PlayMode.RandomLoop`, `!prev` does not play the
|
|
||||||
actually-previously-played song. It just walks `currentIndex - 1` in the
|
|
||||||
underlying array — but in random modes `currentIndex` jumps non-sequentially,
|
|
||||||
so the "previous" array slot has no relationship to play history.
|
|
||||||
|
|
||||||
2. `!add` / web "添加到队列" appends to the queue tail. There is no way to
|
|
||||||
say "play this song right after the current one." Users want a "下一首
|
|
||||||
播放" affordance comparable to Spotify "Add to Queue (next up)" or Apple
|
|
||||||
Music "Play Next".
|
|
||||||
|
|
||||||
## Goals
|
|
||||||
|
|
||||||
- `prev` walks back through the actual play history regardless of mode.
|
|
||||||
- A new "Play Next" path inserts a song at `currentIndex + 1`, available
|
|
||||||
via web UI button and TS3 chat command.
|
|
||||||
- Both features are usable on desktop and mobile web.
|
|
||||||
|
|
||||||
## Out of Scope
|
|
||||||
|
|
||||||
- Forward/redo through prev'd songs (user would need to push next manually,
|
|
||||||
which picks a fresh random in random modes — acceptable simplification).
|
|
||||||
- Reordering songs already in the queue ("move to next" inside Queue.vue).
|
|
||||||
- Persisting play history across bot restarts (in-memory only).
|
|
||||||
|
|
||||||
## Non-functional Constraints
|
|
||||||
|
|
||||||
- History capped at 50 entries to bound memory.
|
|
||||||
- `addNext` must keep `playedIndices` and `history` index references valid
|
|
||||||
after insertion (shift all indices > current by +1).
|
|
||||||
- New Toast UX from the previous round still applies (failures surface).
|
|
||||||
- TypeScript and existing test suite must not regress.
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### A. History-aware `prev`
|
|
||||||
|
|
||||||
**`src/audio/queue.ts`** — `PlayQueue` gains a back-stack:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
private history: number[] = [];
|
|
||||||
private static readonly HISTORY_LIMIT = 50;
|
|
||||||
|
|
||||||
private pushHistory(idx: number): void {
|
|
||||||
if (idx < 0) return;
|
|
||||||
this.history.push(idx);
|
|
||||||
if (this.history.length > PlayQueue.HISTORY_LIMIT) {
|
|
||||||
this.history.shift();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Mutators call `pushHistory(this.currentIndex)` **before** changing `currentIndex`:
|
|
||||||
|
|
||||||
| Method | History action |
|
|
||||||
|---|---|
|
|
||||||
| `play()` | `this.history = []` (fresh playback) |
|
|
||||||
| `playAt(idx)` | `pushHistory(currentIndex)`, then set `currentIndex = idx` |
|
|
||||||
| `next()` | `pushHistory(currentIndex)`, then advance per mode |
|
|
||||||
| `prev()` | **Pop** from history → `currentIndex = popped`. If empty, fall back to existing `currentIndex - 1` (which keeps Sequential's wrap behavior; Random returns null). `prev` itself does NOT push to history. |
|
|
||||||
| `clear()` | `this.history = []` |
|
|
||||||
| `setMode(m)` | `this.history = []` (mode change resets context) |
|
|
||||||
| `remove(idx)` | Drop matching entries from history; shift any entry `> idx` by `-1`. Same logic as the existing `playedIndices` rebuild. |
|
|
||||||
|
|
||||||
**`prev()` rewrite:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
prev(): QueuedSong | null {
|
|
||||||
if (this.songs.length === 0) return null;
|
|
||||||
// History-driven path (preferred when we have one)
|
|
||||||
while (this.history.length > 0) {
|
|
||||||
const idx = this.history.pop()!;
|
|
||||||
if (idx >= 0 && idx < this.songs.length) {
|
|
||||||
this.currentIndex = idx;
|
|
||||||
this.playedIndices.add(idx);
|
|
||||||
return this.songs[idx];
|
|
||||||
}
|
|
||||||
// popped index is stale (song removed) — keep popping
|
|
||||||
}
|
|
||||||
// Fallback: old index-based prev
|
|
||||||
const prevIndex = this.currentIndex - 1;
|
|
||||||
if (prevIndex < 0) {
|
|
||||||
if (this.mode === PlayMode.Sequential) return null;
|
|
||||||
this.currentIndex = this.songs.length - 1;
|
|
||||||
} else {
|
|
||||||
this.currentIndex = prevIndex;
|
|
||||||
}
|
|
||||||
this.playedIndices.add(this.currentIndex);
|
|
||||||
return this.songs[this.currentIndex];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### B. Play Next (insert after current)
|
|
||||||
|
|
||||||
**`PlayQueue.addNext(song)`:**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
addNext(song: QueuedSong): void {
|
|
||||||
if (this.currentIndex < 0 || this.songs.length === 0) {
|
|
||||||
this.songs.push(song);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const insertAt = this.currentIndex + 1;
|
|
||||||
this.songs.splice(insertAt, 0, song);
|
|
||||||
// Shift any tracked index > currentIndex by +1
|
|
||||||
const shifted = new Set<number>();
|
|
||||||
for (const i of this.playedIndices) {
|
|
||||||
shifted.add(i > this.currentIndex ? i + 1 : i);
|
|
||||||
}
|
|
||||||
this.playedIndices = shifted;
|
|
||||||
this.history = this.history.map((i) => (i > this.currentIndex ? i + 1 : i));
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Backend endpoint** — `src/web/api/player.ts`:
|
|
||||||
|
|
||||||
```
|
|
||||||
POST /api/player/:botId/play-next-song
|
|
||||||
body: { song: Song }
|
|
||||||
```
|
|
||||||
|
|
||||||
Behavior:
|
|
||||||
- If queue is empty or `currentIndex < 0`: `queue.addNext(song)` (which falls
|
|
||||||
through to plain push), then `queue.play()`, then `resolveAndPlay`. Same
|
|
||||||
semantics as a successful `/play-song` — message: "正在播放：…"
|
|
||||||
- Otherwise: `queue.addNext(song)`, no resolveAndPlay. Message: "已加入下一首：…"
|
|
||||||
- Returns `{ ok: boolean, message: string }` matching the convention
|
|
||||||
established in the previous round.
|
|
||||||
|
|
||||||
**Bot command** — `src/bot/instance.ts`:
|
|
||||||
|
|
||||||
Register `!playnext <query>` (alias `!pn`):
|
|
||||||
- Mirror of `cmdPlay`'s search step
|
|
||||||
- On match: `queue.addNext(song)`. If no current playback, fall through to
|
|
||||||
`resolveAndPlay`.
|
|
||||||
- Reply with `已加入下一首：<name>` or `正在播放：<name>` accordingly
|
|
||||||
|
|
||||||
**Frontend store action** — `web/src/stores/player.ts`:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
async playNextSong(song: Song) {
|
|
||||||
if (!this.activeBotId) return;
|
|
||||||
const res = await axios.post(`/api/player/${this.activeBotId}/play-next-song`, { song });
|
|
||||||
if (res.data?.message) {
|
|
||||||
this.notify(res.data.message, res.data.ok === false ? 'error' : 'info');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Frontend SongCard** — `web/src/components/SongCard.vue`:
|
|
||||||
|
|
||||||
Add a third action button between the existing "play" and "add to queue":
|
|
||||||
|
|
||||||
```vue
|
|
||||||
<button class="action-btn" @click.stop="$emit('playNext')" title="下一首播放">
|
|
||||||
<Icon icon="mdi:playlist-play" />
|
|
||||||
</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
Add `playNext: []` to `defineEmits`.
|
|
||||||
|
|
||||||
**Caller updates** — `Home.vue`, `Library.vue`, `Search.vue`, `History.vue`,
|
|
||||||
`Playlist.vue`: each `<SongCard>` usage adds
|
|
||||||
`@playNext="store.playNextSong(song)"`.
|
|
||||||
|
|
||||||
**Queue.vue** is intentionally **not** updated — clicking "play next" on a
|
|
||||||
song already in the queue would create a confusing duplicate.
|
|
||||||
|
|
||||||
## Edge Cases
|
|
||||||
|
|
||||||
| Case | Behavior |
|
|
||||||
|---|---|
|
|
||||||
| `prev` with empty history in Sequential mode | Walks `currentIndex - 1`; returns null at index 0 (existing) |
|
|
||||||
| `prev` with empty history in Random/RandomLoop | Returns null (no past to recover) |
|
|
||||||
| Repeated `prev` past start of history | Pops what's there, then falls back to index walk; eventually null |
|
|
||||||
| `addNext` while `currentIndex == -1` (nothing played yet) | Falls through to push; queue.play() will pick it as first |
|
|
||||||
| `addNext` while playing and queue size = 1 | Inserts at index 1; current index unchanged; next() will advance to it |
|
|
||||||
| `remove` removes a song whose index is in history | Entry dropped; shifted accordingly |
|
|
||||||
| Mode switched mid-playback | History cleared (intentional — mode change is a context boundary) |
|
|
||||||
| `addNext` then `prev` | Inserted song was never played → not in history; prev pops the previously-played song, NOT the just-inserted one |
|
|
||||||
|
|
||||||
## Files Touched
|
|
||||||
|
|
||||||
- `src/audio/queue.ts` — history field, `pushHistory`, `addNext`, rewritten `prev`, mutator updates
|
|
||||||
- `src/audio/queue.test.ts` (or add if missing) — unit tests for history behavior + addNext shift logic
|
|
||||||
- `src/bot/instance.ts` — register `!playnext` / `!pn` command handler
|
|
||||||
- `src/web/api/player.ts` — new `/play-next-song` route
|
|
||||||
- `web/src/stores/player.ts` — `playNextSong` action
|
|
||||||
- `web/src/components/SongCard.vue` — third action button + emit
|
|
||||||
- `web/src/views/Home.vue` — wire `@playNext`
|
|
||||||
- `web/src/views/Library.vue` — wire `@playNext`
|
|
||||||
- `web/src/views/Search.vue` — wire `@playNext`
|
|
||||||
- `web/src/views/History.vue` — wire `@playNext`
|
|
||||||
- `web/src/views/Playlist.vue` — wire `@playNext`
|
|
||||||
|
|
||||||
## Test Plan
|
|
||||||
|
|
||||||
**Unit (vitest, `queue.test.ts`):**
|
|
||||||
- prev with empty history in Sequential: walks back, null at index 0
|
|
||||||
- prev with empty history in Random: returns null
|
|
||||||
- next → next → next → prev pops correctly; prev again pops earlier
|
|
||||||
- prev after `clear()` returns null (history reset)
|
|
||||||
- prev after `setMode()` returns null (history reset)
|
|
||||||
- `remove(idx)` drops from history and shifts entries > idx
|
|
||||||
- `addNext` while empty: appends
|
|
||||||
- `addNext` while playing index 2 in a 5-song queue: ends up at index 3, currentIndex still 2, queue size 6
|
|
||||||
- `addNext` then `next()`: plays the inserted song
|
|
||||||
- `addNext` shifts existing playedIndices and history correctly
|
|
||||||
|
|
||||||
**Integration (manual smoke):**
|
|
||||||
- Random mode: play 4 songs, hit `prev` 3 times → walks back through history
|
|
||||||
- Click "下一首播放" on a search result → next song after current is the chosen one
|
|
||||||
- `!playnext 七里香` → bot replies "已加入下一首：..."; current keeps playing; next song is 七里香
|
|
||||||
- `!playnext` while idle → starts playing immediately
|
|
||||||
|
|
||||||
**Regression:**
|
|
||||||
- Existing 161 source-tree tests still pass.
|
|
||||||
- TypeScript `tsc --noEmit` and `npm run build:web` clean.
|
|
||||||
@@ -1,149 +0,0 @@
|
|||||||
# 自定义机器人头像 + 专辑搜索/播放
|
|
||||||
|
|
||||||
**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 以内"**，简单可控
|
|
||||||
@@ -1,360 +0,0 @@
|
|||||||
# 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）—— 这是预期行为。
|
|
||||||
Generated
+349
-565
File diff suppressed because it is too large.
Load diff
+3
-11
@@ -8,21 +8,18 @@
|
|||||||
"build": "tsc && npm run build:web",
|
"build": "tsc && npm run build:web",
|
||||||
"build:web": "cd web && npm run build",
|
"build:web": "cd web && npm run build",
|
||||||
"start": "node dist/index.js",
|
"start": "node dist/index.js",
|
||||||
"play": "node dist/index.js",
|
|
||||||
"test": "vitest run",
|
"test": "vitest run",
|
||||||
"test:watch": "vitest"
|
"test:watch": "vitest"
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@discordjs/opus": "^0.10.0",
|
"@discordjs/opus": "^0.10.0",
|
||||||
"@honeybbq/teamspeak-client": "^0.2.1",
|
"@honeybbq/teamspeak-client": "^0.1.0",
|
||||||
"@koa/router": "^15.4.0",
|
"@koa/router": "^15.4.0",
|
||||||
"@sansenjian/qq-music-api": "^2.2.10",
|
"@sansenjian/qq-music-api": "^2.2.9",
|
||||||
"axios": "^1.14.0",
|
"axios": "^1.14.0",
|
||||||
"bcryptjs": "^2.4.3",
|
|
||||||
"better-sqlite3": "^12.8.0",
|
"better-sqlite3": "^12.8.0",
|
||||||
"chalk": "^5.6.2",
|
"chalk": "^5.6.2",
|
||||||
"cookie-parser": "^1.4.7",
|
|
||||||
"express": "^5.2.1",
|
"express": "^5.2.1",
|
||||||
"ffmpeg-static": "^5.3.0",
|
"ffmpeg-static": "^5.3.0",
|
||||||
"koa": "^3.2.0",
|
"koa": "^3.2.0",
|
||||||
@@ -32,18 +29,13 @@
|
|||||||
"pino": "^10.3.1",
|
"pino": "^10.3.1",
|
||||||
"ts3-nodejs-library": "^3.5.1",
|
"ts3-nodejs-library": "^3.5.1",
|
||||||
"tweetnacl": "^1.0.3",
|
"tweetnacl": "^1.0.3",
|
||||||
"ws": "^8.20.0",
|
"ws": "^8.20.0"
|
||||||
"yt-dlp-wrap": "^2.3.12"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/bcryptjs": "^2.4.6",
|
|
||||||
"@types/better-sqlite3": "^7.6.13",
|
"@types/better-sqlite3": "^7.6.13",
|
||||||
"@types/cookie-parser": "^1.4.10",
|
|
||||||
"@types/express": "^5.0.6",
|
"@types/express": "^5.0.6",
|
||||||
"@types/node": "^25.5.0",
|
"@types/node": "^25.5.0",
|
||||||
"@types/supertest": "^6.0.3",
|
|
||||||
"@types/ws": "^8.18.1",
|
"@types/ws": "^8.18.1",
|
||||||
"supertest": "^7.2.2",
|
|
||||||
"tsx": "^4.21.0",
|
"tsx": "^4.21.0",
|
||||||
"typescript": "^6.0.2",
|
"typescript": "^6.0.2",
|
||||||
"vitest": "^4.1.2"
|
"vitest": "^4.1.2"
|
||||||
|
|||||||
+13
-10
@@ -25,27 +25,30 @@ RUN cd web && npm ci
|
|||||||
COPY . .
|
COPY . .
|
||||||
RUN npm run build
|
RUN npm run build
|
||||||
|
|
||||||
# Install production dependencies (with native addons compiled) in the builder
|
|
||||||
# so we don't need build tools in the production image.
|
|
||||||
RUN rm -rf node_modules && npm ci --production && npm cache clean --force
|
|
||||||
|
|
||||||
# --- Stage 2: Production image ---
|
# --- Stage 2: Production image ---
|
||||||
FROM node:20-slim
|
FROM node:20-slim
|
||||||
|
|
||||||
# Install system FFmpeg — the ffmpeg-static npm package bundles a pre-compiled
|
# Install only runtime native build tools (needed for native module rebuild)
|
||||||
# binary that can SIGSEGV inside Docker (incompatible glibc / missing libs).
|
|
||||||
# System-installed FFmpeg is always compatible with the container runtime.
|
|
||||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||||
ffmpeg && \
|
python3 make g++ && \
|
||||||
rm -rf /var/lib/apt/lists/*
|
rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# Copy built output and pre-compiled production node_modules from builder
|
# Copy built output
|
||||||
COPY --from=builder /app/dist ./dist
|
COPY --from=builder /app/dist ./dist
|
||||||
COPY --from=builder /app/web/dist ./web/dist
|
COPY --from=builder /app/web/dist ./web/dist
|
||||||
COPY --from=builder /app/package*.json ./
|
COPY --from=builder /app/package*.json ./
|
||||||
COPY --from=builder /app/node_modules ./node_modules
|
|
||||||
|
# Install production dependencies (includes ffmpeg-static, opus, sqlite3)
|
||||||
|
# These need to compile native addons inside the container
|
||||||
|
RUN npm ci --production && npm cache clean --force
|
||||||
|
|
||||||
|
# Remove build tools to reduce image size
|
||||||
|
RUN apt-get purge -y python3 make g++ && apt-get autoremove -y && \
|
||||||
|
rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# FFmpeg is bundled via ffmpeg-static — no system ffmpeg needed
|
||||||
|
|
||||||
# Data directory for database, cookies, logs
|
# Data directory for database, cookies, logs
|
||||||
RUN mkdir -p /app/data
|
RUN mkdir -p /app/data
|
||||||
|
|||||||
@@ -1,16 +1,14 @@
|
|||||||
# TSMusicBot — Docker Compose
|
# TSMusicBot — Docker Compose
|
||||||
# 一键部署：docker-compose pull && docker-compose up -d
|
# 一键部署：docker-compose up -d
|
||||||
#
|
#
|
||||||
# 默认从 GitHub Container Registry 拉取预构建镜像（amd64 + arm64），
|
# 所有依赖已内置（Node.js, FFmpeg, Opus 编码器）
|
||||||
# 无需本地编译，无需 Node.js / 构建工具链。
|
# 无需安装任何额外软件
|
||||||
# 镜像内置：Node.js, FFmpeg, Opus 编码器，原生模块均已交叉编译。
|
|
||||||
#
|
|
||||||
# 如需指定版本，把 :latest 换成具体 tag（例如 :1.4.0）。
|
|
||||||
# 如需本地构建（开发或 fork），见底部注释。
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
tsmusicbot:
|
tsmusicbot:
|
||||||
image: ghcr.io/zhangtianyao1/teamspeak-music-bot:latest
|
build:
|
||||||
|
context: ../..
|
||||||
|
dockerfile: scripts/docker/Dockerfile
|
||||||
container_name: tsmusicbot
|
container_name: tsmusicbot
|
||||||
# Use host network so the bot can reach TS3 server on LAN
|
# Use host network so the bot can reach TS3 server on LAN
|
||||||
# If your TS3 server is on the same machine, this is required
|
# If your TS3 server is on the same machine, this is required
|
||||||
@@ -29,12 +27,3 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
tsmusicbot-data:
|
tsmusicbot-data:
|
||||||
driver: local
|
driver: local
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# 本地构建（仅开发 / fork 场景使用）：
|
|
||||||
# 把上面的 `image:` 行删掉，换成下面的 build 块即可。
|
|
||||||
#
|
|
||||||
# build:
|
|
||||||
# context: ../..
|
|
||||||
# dockerfile: scripts/docker/Dockerfile
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
@@ -1,161 +0,0 @@
|
|||||||
#!/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);
|
|
||||||
}
|
|
||||||
|
|
||||||
+17
-41
@@ -6,19 +6,9 @@ echo "║ TSMusicBot Installer ║"
|
|||||||
echo "╚══════════════════════════════════════╝"
|
echo "╚══════════════════════════════════════╝"
|
||||||
echo ""
|
echo ""
|
||||||
|
|
||||||
# Resolve script location → project root
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
||||||
PROJECT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
|
|
||||||
INSTALL_DIR="/opt/tsmusicbot"
|
INSTALL_DIR="/opt/tsmusicbot"
|
||||||
SERVICE_NAME="tsmusicbot"
|
SERVICE_NAME="tsmusicbot"
|
||||||
|
|
||||||
# Verify we're in a valid project directory
|
|
||||||
if [ ! -f "$PROJECT_DIR/package.json" ]; then
|
|
||||||
echo "Error: Cannot find package.json in $PROJECT_DIR"
|
|
||||||
echo "Please run this script from the TSMusicBot project directory."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Detect OS
|
# Detect OS
|
||||||
if [ -f /etc/os-release ]; then
|
if [ -f /etc/os-release ]; then
|
||||||
. /etc/os-release
|
. /etc/os-release
|
||||||
@@ -28,57 +18,44 @@ else
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "[1/6] Installing system dependencies..."
|
echo "[1/5] Installing system dependencies..."
|
||||||
case $OS in
|
case $OS in
|
||||||
ubuntu|debian)
|
ubuntu|debian)
|
||||||
sudo apt-get update -qq
|
sudo apt-get update -qq
|
||||||
sudo apt-get install -y -qq curl build-essential python3
|
sudo apt-get install -y -qq curl ffmpeg
|
||||||
;;
|
;;
|
||||||
centos|rhel|fedora)
|
centos|rhel|fedora)
|
||||||
sudo yum install -y curl gcc gcc-c++ make python3
|
sudo yum install -y curl ffmpeg
|
||||||
;;
|
;;
|
||||||
arch|manjaro)
|
arch|manjaro)
|
||||||
sudo pacman -S --noconfirm curl base-devel python
|
sudo pacman -S --noconfirm curl ffmpeg
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
echo "Unsupported OS: $OS. Please install Node.js 20, build tools, and FFmpeg manually."
|
echo "Unsupported OS: $OS. Please install Node.js 20 and FFmpeg manually."
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
echo "[2/6] Installing Node.js 20 LTS..."
|
echo "[2/5] Installing Node.js 20 LTS..."
|
||||||
if ! command -v node &> /dev/null || [[ $(node -v | cut -d. -f1 | tr -d 'v') -lt 20 ]]; then
|
if ! command -v node &> /dev/null || [[ $(node -v | cut -d. -f1 | tr -d 'v') -lt 20 ]]; then
|
||||||
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
|
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
|
||||||
sudo apt-get install -y -qq nodejs 2>/dev/null || sudo yum install -y nodejs 2>/dev/null
|
sudo apt-get install -y -qq nodejs 2>/dev/null || sudo yum install -y nodejs 2>/dev/null
|
||||||
fi
|
fi
|
||||||
echo "Node.js $(node -v) installed"
|
echo "Node.js $(node -v) installed"
|
||||||
|
|
||||||
echo "[3/6] Installing dependencies..."
|
echo "[3/5] Downloading TSMusicBot..."
|
||||||
cd "$PROJECT_DIR"
|
|
||||||
npm install
|
|
||||||
if [ -d "$PROJECT_DIR/web/package.json" ] || [ -f "$PROJECT_DIR/web/package.json" ]; then
|
|
||||||
(cd "$PROJECT_DIR/web" && npm install)
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "[4/6] Building project..."
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
echo "[5/6] Copying to $INSTALL_DIR..."
|
|
||||||
sudo mkdir -p "$INSTALL_DIR"
|
sudo mkdir -p "$INSTALL_DIR"
|
||||||
sudo cp -r "$PROJECT_DIR/dist" "$INSTALL_DIR/"
|
if [ -d "$(pwd)/dist" ]; then
|
||||||
sudo cp -r "$PROJECT_DIR/node_modules" "$INSTALL_DIR/"
|
sudo cp -r "$(pwd)"/* "$INSTALL_DIR/"
|
||||||
sudo cp "$PROJECT_DIR/package.json" "$INSTALL_DIR/"
|
else
|
||||||
# Copy web frontend if built
|
echo "Please run this script from the TSMusicBot source directory after building."
|
||||||
if [ -d "$PROJECT_DIR/web/dist" ]; then
|
exit 1
|
||||||
sudo mkdir -p "$INSTALL_DIR/web"
|
|
||||||
sudo cp -r "$PROJECT_DIR/web/dist" "$INSTALL_DIR/web/"
|
|
||||||
fi
|
fi
|
||||||
# Copy scripts for future use
|
|
||||||
sudo mkdir -p "$INSTALL_DIR/scripts"
|
|
||||||
sudo cp -r "$PROJECT_DIR/scripts/"* "$INSTALL_DIR/scripts/" 2>/dev/null || true
|
|
||||||
# Create data directory
|
|
||||||
sudo mkdir -p "$INSTALL_DIR/data"
|
|
||||||
|
|
||||||
echo "[6/6] Creating systemd service..."
|
echo "[4/5] Installing npm dependencies..."
|
||||||
|
cd "$INSTALL_DIR"
|
||||||
|
sudo npm install --production
|
||||||
|
|
||||||
|
echo "[5/5] Creating systemd service..."
|
||||||
sudo tee /etc/systemd/system/${SERVICE_NAME}.service > /dev/null <<EOL
|
sudo tee /etc/systemd/system/${SERVICE_NAME}.service > /dev/null <<EOL
|
||||||
[Unit]
|
[Unit]
|
||||||
Description=TSMusicBot - TeamSpeak Music Bot
|
Description=TSMusicBot - TeamSpeak Music Bot
|
||||||
@@ -111,5 +88,4 @@ echo "║ Commands: ║"
|
|||||||
echo "║ systemctl status tsmusicbot ║"
|
echo "║ systemctl status tsmusicbot ║"
|
||||||
echo "║ systemctl restart tsmusicbot ║"
|
echo "║ systemctl restart tsmusicbot ║"
|
||||||
echo "║ systemctl stop tsmusicbot ║"
|
echo "║ systemctl stop tsmusicbot ║"
|
||||||
echo "║ journalctl -u tsmusicbot -f ║"
|
|
||||||
echo "╚══════════════════════════════════════╝"
|
echo "╚══════════════════════════════════════╝"
|
||||||
@@ -1,212 +0,0 @@
|
|||||||
"""Open a real Chromium browser at y.qq.com, let the user log in via any
|
|
||||||
method (password / QR / QQ connect), then extract the resulting cookie
|
|
||||||
set and save it to data/cookies/qq.json. Also tests whether the cookie
|
|
||||||
actually unlocks a known VIP track (Jay Chou 稻香) against the local
|
|
||||||
QQ Music API before declaring success.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
"C:/Users/saopig1/miniforge3/python.exe" scripts/qq_browser_login.py
|
|
||||||
|
|
||||||
Steps:
|
|
||||||
1. A visible Chromium window opens at y.qq.com/n/ryqq/player
|
|
||||||
2. Click the login button in the top right and log in with your
|
|
||||||
real QQ Music account (the one that has VIP)
|
|
||||||
3. The script POLLS cookies in the background and auto-detects
|
|
||||||
successful login by watching for the `uin` cookie to appear
|
|
||||||
4. Once detected, cookies are captured, tested against
|
|
||||||
/getMusicPlay for 稻香, and saved on success
|
|
||||||
5. If VIP still fails, cookies are NOT saved — your existing bot
|
|
||||||
cookie stays untouched
|
|
||||||
|
|
||||||
No terminal input required — the script exits on its own when login
|
|
||||||
is detected (or after the configured timeout).
|
|
||||||
"""
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import json
|
|
||||||
import re
|
|
||||||
import time
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import requests
|
|
||||||
from playwright.sync_api import sync_playwright
|
|
||||||
|
|
||||||
BOT_ROOT = Path(r"C:\Users\saopig1\Music\teamspeak music bot")
|
|
||||||
COOKIE_FILE = BOT_ROOT / "data" / "cookies" / "qq.json"
|
|
||||||
QQ_API = "http://localhost:3200"
|
|
||||||
VIP_TEST_SONGMID = "003aAYrm3GE0Ac" # 稻香 周杰伦
|
|
||||||
|
|
||||||
# How long to wait for the user to finish logging in
|
|
||||||
LOGIN_TIMEOUT_S = 300 # 5 minutes
|
|
||||||
POLL_INTERVAL_S = 1.0
|
|
||||||
# After detecting login, wait a bit for extra cookies (e.g. qqmusic_key)
|
|
||||||
SETTLE_DELAY_S = 4.0
|
|
||||||
|
|
||||||
|
|
||||||
def qq_cookies(ctx) -> list[dict]:
|
|
||||||
wanted_suffixes = (".qq.com", "y.qq.com", ".music.qq.com")
|
|
||||||
return [
|
|
||||||
c for c in ctx.cookies()
|
|
||||||
if any(c.get("domain", "").endswith(s) or c.get("domain", "") == s.lstrip(".")
|
|
||||||
for s in wanted_suffixes)
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def cookies_to_header(cookies: list[dict]) -> str:
|
|
||||||
return "; ".join(f"{c['name']}={c['value']}" for c in cookies)
|
|
||||||
|
|
||||||
|
|
||||||
def cookie_has_uin(cookies: list[dict]) -> str | None:
|
|
||||||
for c in cookies:
|
|
||||||
if c["name"] == "uin" and c["value"]:
|
|
||||||
return c["value"]
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def test_vip_unlock(cookie_header: str) -> tuple[bool, dict]:
|
|
||||||
try:
|
|
||||||
r = requests.get(
|
|
||||||
f"{QQ_API}/getMusicPlay",
|
|
||||||
params={"songmid": VIP_TEST_SONGMID, "cookie": cookie_header},
|
|
||||||
timeout=10,
|
|
||||||
proxies={"http": None, "https": None},
|
|
||||||
)
|
|
||||||
body = r.json()
|
|
||||||
play = body.get("data", {}).get("playUrl", {}).get(VIP_TEST_SONGMID, {})
|
|
||||||
url = play.get("url", "")
|
|
||||||
return (
|
|
||||||
bool(url),
|
|
||||||
{
|
|
||||||
"url_length": len(url),
|
|
||||||
"url_prefix": url[:120] if url else "",
|
|
||||||
"error": play.get("error", ""),
|
|
||||||
},
|
|
||||||
)
|
|
||||||
except Exception as e:
|
|
||||||
return False, {"error": f"request failed: {e}"}
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
print("[setup] launching visible Chromium — look for the window on your desktop")
|
|
||||||
print("[setup] goto https://y.qq.com/n/ryqq/player")
|
|
||||||
print()
|
|
||||||
print("action required:")
|
|
||||||
print(" 1. Click the 登录 button (top-right) in the browser window")
|
|
||||||
print(" 2. Log in with your VIP QQ Music account (QR / password / WeChat)")
|
|
||||||
print(" 3. Do NOTHING in this terminal — the script detects login itself")
|
|
||||||
print()
|
|
||||||
|
|
||||||
with sync_playwright() as p:
|
|
||||||
browser = p.chromium.launch(headless=False)
|
|
||||||
ctx = browser.new_context(
|
|
||||||
viewport={"width": 1280, "height": 820},
|
|
||||||
user_agent=(
|
|
||||||
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) "
|
|
||||||
"AppleWebKit/537.36 (KHTML, like Gecko) "
|
|
||||||
"Chrome/132.0.0.0 Safari/537.36"
|
|
||||||
),
|
|
||||||
)
|
|
||||||
page = ctx.new_page()
|
|
||||||
try:
|
|
||||||
page.goto("https://y.qq.com/n/ryqq/player", wait_until="domcontentloaded", timeout=30_000)
|
|
||||||
except Exception as e:
|
|
||||||
print(f"[warn] initial navigation slow: {e}")
|
|
||||||
|
|
||||||
print(f"[wait] polling every {POLL_INTERVAL_S}s for login (timeout {LOGIN_TIMEOUT_S}s)")
|
|
||||||
deadline = time.time() + LOGIN_TIMEOUT_S
|
|
||||||
uin_detected: str | None = None
|
|
||||||
last_report = 0.0
|
|
||||||
while time.time() < deadline:
|
|
||||||
cks = qq_cookies(ctx)
|
|
||||||
uin = cookie_has_uin(cks)
|
|
||||||
if uin:
|
|
||||||
uin_detected = uin
|
|
||||||
print(f"[detect] uin cookie appeared: {uin}")
|
|
||||||
break
|
|
||||||
now = time.time()
|
|
||||||
if now - last_report >= 15:
|
|
||||||
remaining = int(deadline - now)
|
|
||||||
n = len(cks)
|
|
||||||
print(f"[wait] still waiting... {n} qq.com cookies so far, {remaining}s left")
|
|
||||||
last_report = now
|
|
||||||
time.sleep(POLL_INTERVAL_S)
|
|
||||||
|
|
||||||
if not uin_detected:
|
|
||||||
print("[abort] login not detected within timeout")
|
|
||||||
browser.close()
|
|
||||||
return 1
|
|
||||||
|
|
||||||
print(f"[settle] waiting {SETTLE_DELAY_S}s for session cookies to populate")
|
|
||||||
time.sleep(SETTLE_DELAY_S)
|
|
||||||
|
|
||||||
cks = qq_cookies(ctx)
|
|
||||||
cookie_header = cookies_to_header(cks)
|
|
||||||
print(f"[capture] {len(cks)} cookies, {len(cookie_header)} char header")
|
|
||||||
|
|
||||||
qm_key = next((c["value"] for c in cks if c["name"] == "qqmusic_key"), "")
|
|
||||||
qm_keyst = next((c["value"] for c in cks if c["name"] == "qm_keyst"), "")
|
|
||||||
p_skey = next((c["value"] for c in cks if c["name"] == "p_skey"), "")
|
|
||||||
print(f"[capture] qqmusic_key: {'present (' + qm_key[:20] + '...)' if qm_key else '(absent)'}")
|
|
||||||
print(f"[capture] qm_keyst : {'present (' + qm_keyst[:20] + '...)' if qm_keyst else '(absent)'}")
|
|
||||||
print(f"[capture] p_skey : {'present' if p_skey else '(absent)'}")
|
|
||||||
|
|
||||||
print("\n[test] calling /getMusicPlay for 稻香 with captured cookie...")
|
|
||||||
unlocked, details = test_vip_unlock(cookie_header)
|
|
||||||
print(f"[test] unlocked: {unlocked}")
|
|
||||||
print(f"[test] details: {details}")
|
|
||||||
|
|
||||||
if not unlocked:
|
|
||||||
print(
|
|
||||||
"\n[result] VIP did NOT unlock even with browser-extracted cookies.\n"
|
|
||||||
" Existing cookie file is UNTOUCHED.\n"
|
|
||||||
" Diagnosis: the login flow is not the bottleneck — the\n"
|
|
||||||
" account likely lacks entitlement for this specific track,\n"
|
|
||||||
" OR QQ requires additional session setup (gateway handshake)\n"
|
|
||||||
" beyond what's in the cookie itself.\n"
|
|
||||||
)
|
|
||||||
# Dump the full cookie set for inspection
|
|
||||||
dump_path = BOT_ROOT / "data" / "cookies" / "qq.browser-capture.json"
|
|
||||||
dump_path.write_text(
|
|
||||||
json.dumps(
|
|
||||||
{"cookie": cookie_header, "cookieList": cks, "capturedAt": time.strftime("%Y-%m-%dT%H:%M:%SZ")},
|
|
||||||
ensure_ascii=False,
|
|
||||||
indent=2,
|
|
||||||
),
|
|
||||||
encoding="utf-8",
|
|
||||||
)
|
|
||||||
print(f"[dump] full browser cookies written to {dump_path}")
|
|
||||||
print(" (for side-by-side comparison with OAuth-derived cookies)")
|
|
||||||
browser.close()
|
|
||||||
return 2
|
|
||||||
|
|
||||||
print("\n[save] VIP unlocked. Writing cookie to bot...")
|
|
||||||
COOKIE_FILE.write_text(
|
|
||||||
json.dumps(
|
|
||||||
{"cookie": cookie_header, "updatedAt": time.strftime("%Y-%m-%dT%H:%M:%SZ")},
|
|
||||||
ensure_ascii=False,
|
|
||||||
),
|
|
||||||
encoding="utf-8",
|
|
||||||
)
|
|
||||||
print(f"[save] wrote {COOKIE_FILE}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
r = requests.post(
|
|
||||||
"http://localhost:3000/api/auth/cookie",
|
|
||||||
json={"platform": "qq", "cookie": cookie_header},
|
|
||||||
timeout=5,
|
|
||||||
proxies={"http": None, "https": None},
|
|
||||||
)
|
|
||||||
print(f"[notify] /api/auth/cookie POST: {r.status_code}")
|
|
||||||
except Exception as e:
|
|
||||||
print(f"[notify] failed to push cookie to bot: {e}")
|
|
||||||
print(" Restart the bot to pick up the new cookie from disk.")
|
|
||||||
|
|
||||||
print("\n[done] VIP should now work through the bot. Try playing 稻香!")
|
|
||||||
browser.close()
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
import sys
|
|
||||||
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
"""Open a visible browser at y.qq.com so the user can manually verify
|
|
||||||
whether their VIP account can play 稻香 (Jay Chou) in the real QQ Music
|
|
||||||
web player.
|
|
||||||
|
|
||||||
If the browser plays the song → entitlement exists and our 104003 is a
|
|
||||||
request-signing issue.
|
|
||||||
If the browser refuses / shows a VIP modal / silently fails → the
|
|
||||||
account doesn't have entitlement OR QQ's web player hits the same wall.
|
|
||||||
"""
|
|
||||||
import sys
|
|
||||||
import time
|
|
||||||
from playwright.sync_api import sync_playwright
|
|
||||||
|
|
||||||
# Force line-buffered stdout so logs actually reach the output file
|
|
||||||
sys.stdout.reconfigure(line_buffering=True)
|
|
||||||
|
|
||||||
START_URL = "https://y.qq.com/n/ryqq/player"
|
|
||||||
SONG_URL = "https://y.qq.com/n/ryqq/songDetail/003aAYrm3GE0Ac"
|
|
||||||
|
|
||||||
|
|
||||||
def log(msg: str) -> None:
|
|
||||||
print(msg, flush=True)
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
log("[setup] launching visible Chromium")
|
|
||||||
log(f"[setup] start URL: {START_URL}")
|
|
||||||
log(f"[setup] song URL: {SONG_URL}")
|
|
||||||
log("")
|
|
||||||
log("action required:")
|
|
||||||
log(" 1. The browser opens at the player page")
|
|
||||||
log(" 2. Make sure your VIP account is logged in (top-right avatar)")
|
|
||||||
log(" — if not, log in now, the script will wait")
|
|
||||||
log(" 3. Once logged in, the browser will auto-navigate to 稻香")
|
|
||||||
log(" 4. Click the PLAY button and report what happens:")
|
|
||||||
log(" (a) song plays → account has entitlement, issue is request signing")
|
|
||||||
log(" (b) VIP modal → account needs higher tier / digital album purchase")
|
|
||||||
log(" (c) silent failure → QQ web player has same 104003 wall")
|
|
||||||
log("")
|
|
||||||
log("[wait] browser stays open for 5 minutes")
|
|
||||||
log("")
|
|
||||||
|
|
||||||
with sync_playwright() as p:
|
|
||||||
try:
|
|
||||||
browser = p.chromium.launch(headless=False)
|
|
||||||
except Exception as e:
|
|
||||||
log(f"[fatal] failed to launch Chromium: {e}")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
ctx = browser.new_context(
|
|
||||||
viewport={"width": 1400, "height": 900},
|
|
||||||
user_agent=(
|
|
||||||
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) "
|
|
||||||
"AppleWebKit/537.36 (KHTML, like Gecko) "
|
|
||||||
"Chrome/132.0.0.0 Safari/537.36"
|
|
||||||
),
|
|
||||||
)
|
|
||||||
page = ctx.new_page()
|
|
||||||
|
|
||||||
# Log every navigation so we can see if pages fail
|
|
||||||
page.on("framenavigated", lambda f: log(f"[nav] {f.url[:120]}") if f == page.main_frame else None)
|
|
||||||
page.on("pageerror", lambda e: log(f"[js-error] {str(e)[:200]}"))
|
|
||||||
|
|
||||||
# Step 1: open the player page (known working)
|
|
||||||
log(f"[goto] {START_URL}")
|
|
||||||
try:
|
|
||||||
page.goto(START_URL, wait_until="domcontentloaded", timeout=30_000)
|
|
||||||
log(f"[ok] loaded: {page.url}")
|
|
||||||
except Exception as e:
|
|
||||||
log(f"[warn] initial goto failed: {e}")
|
|
||||||
log("[warn] browser stays open, try manual navigation")
|
|
||||||
|
|
||||||
# Wait briefly for auth state to settle
|
|
||||||
time.sleep(3)
|
|
||||||
|
|
||||||
# Check if the user is logged in via the uin cookie
|
|
||||||
cookies = ctx.cookies()
|
|
||||||
uin = next((c["value"] for c in cookies if c["name"] == "uin" and c["value"]), None)
|
|
||||||
if uin:
|
|
||||||
log(f"[auth] logged in as uin={uin}")
|
|
||||||
else:
|
|
||||||
log("[auth] not logged in yet — please log in via the top-right avatar")
|
|
||||||
log("[auth] waiting up to 2 minutes for login...")
|
|
||||||
end = time.time() + 120
|
|
||||||
while time.time() < end:
|
|
||||||
time.sleep(1)
|
|
||||||
cookies = ctx.cookies()
|
|
||||||
uin = next((c["value"] for c in cookies if c["name"] == "uin" and c["value"]), None)
|
|
||||||
if uin:
|
|
||||||
log(f"[auth] detected login: uin={uin}")
|
|
||||||
break
|
|
||||||
if not uin:
|
|
||||||
log("[abort] no login detected within 2 minutes")
|
|
||||||
time.sleep(30) # keep browser visible
|
|
||||||
browser.close()
|
|
||||||
return 2
|
|
||||||
|
|
||||||
# Step 2: navigate to the song page
|
|
||||||
log(f"[goto] {SONG_URL}")
|
|
||||||
try:
|
|
||||||
page.goto(SONG_URL, wait_until="domcontentloaded", timeout=30_000)
|
|
||||||
log(f"[ok] loaded: {page.url}")
|
|
||||||
except Exception as e:
|
|
||||||
log(f"[warn] song navigation failed: {e}")
|
|
||||||
log(f"[info] current page: {page.url}")
|
|
||||||
|
|
||||||
log("")
|
|
||||||
log("===========================================================")
|
|
||||||
log("browser is open on the song page — click PLAY and observe.")
|
|
||||||
log("keeping browser open for 5 more minutes")
|
|
||||||
log("===========================================================")
|
|
||||||
|
|
||||||
time.sleep(300)
|
|
||||||
browser.close()
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
from playwright.sync_api import sync_playwright
|
|
||||||
|
|
||||||
with sync_playwright() as p:
|
|
||||||
browser = p.chromium.launch(headless=True)
|
|
||||||
page = browser.new_page(viewport={"width": 1440, "height": 900})
|
|
||||||
page.goto("http://localhost:3000")
|
|
||||||
page.wait_for_load_state("networkidle")
|
|
||||||
page.wait_for_timeout(800)
|
|
||||||
page.locator(".navbar").screenshot(path="scripts/navbar_bigger.png")
|
|
||||||
rect = page.locator(".bot-selector-btn").bounding_box()
|
|
||||||
print("bot-selector-btn bbox:", rect)
|
|
||||||
browser.close()
|
|
||||||
+55
-258
@@ -1,294 +1,91 @@
|
|||||||
@echo off
|
@echo off
|
||||||
setlocal enabledelayedexpansion
|
|
||||||
chcp 65001 >nul
|
|
||||||
title TSMusicBot Setup
|
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 ============================================
|
||||||
echo TSMusicBot - First-Time Setup (Windows)
|
echo TSMusicBot - First-Time Setup (Windows)
|
||||||
echo Version %SCRIPT_VERSION%
|
|
||||||
echo ============================================
|
echo ============================================
|
||||||
echo.
|
echo.
|
||||||
echo Log file: %LOG_FILE%
|
|
||||||
echo.
|
|
||||||
|
|
||||||
:: ============================================================
|
:: Resolve project root (one level up from scripts/)
|
||||||
:: Step 1: Check Node.js
|
cd /d "%~dp0.."
|
||||||
:: ============================================================
|
|
||||||
call :step "1/7" "Checking Node.js"
|
|
||||||
|
|
||||||
|
:: ---- Step 1: Check / install Node.js ----
|
||||||
where node >nul 2>&1
|
where node >nul 2>&1
|
||||||
if not errorlevel 1 goto :check_node_version
|
if %errorlevel% neq 0 (
|
||||||
|
echo Node.js not found. Attempting automatic installation...
|
||||||
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.
|
||||||
echo [INFO] Using China mirror (npmmirror.com)
|
|
||||||
call :log "Switching to npmmirror.com"
|
:: Try winget first (available on Windows 10 1709+ and Windows 11)
|
||||||
set "MIRROR_REGISTRY=https://registry.npmmirror.com"
|
where winget >nul 2>&1
|
||||||
set "CDN_MIRROR=https://cdn.npmmirror.com/binaries"
|
if %errorlevel% equ 0 (
|
||||||
|
echo Installing Node.js via winget...
|
||||||
|
winget install OpenJS.NodeJS.LTS --accept-source-agreements --accept-package-agreements
|
||||||
|
if %errorlevel% neq 0 (
|
||||||
|
echo winget installation failed. Please install Node.js manually from https://nodejs.org
|
||||||
|
pause
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
:: Refresh PATH so node is available in this session
|
||||||
|
call refreshenv >nul 2>&1
|
||||||
|
:: If refreshenv is not available, ask user to restart
|
||||||
|
where node >nul 2>&1
|
||||||
|
if %errorlevel% neq 0 (
|
||||||
|
echo.
|
||||||
|
echo Node.js was installed but is not yet available in this terminal.
|
||||||
|
echo Please close this window and run setup.bat again.
|
||||||
|
pause
|
||||||
|
exit /b 0
|
||||||
|
)
|
||||||
|
) else (
|
||||||
|
echo winget is not available on this system.
|
||||||
|
echo Please install Node.js 20 LTS manually from https://nodejs.org
|
||||||
|
echo After installing, close this window and run setup.bat again.
|
||||||
|
pause
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
) else (
|
) else (
|
||||||
set "CDN_MIRROR="
|
echo [OK] Node.js found.
|
||||||
|
node --version
|
||||||
)
|
)
|
||||||
echo.
|
echo.
|
||||||
|
|
||||||
:: ============================================================
|
:: ---- Step 2: Install npm dependencies ----
|
||||||
:: Step 4: Install backend dependencies (跳过二进制)
|
echo Installing dependencies (this may take a few minutes)...
|
||||||
:: ============================================================
|
call npm install
|
||||||
call :step "4/7" "Installing backend dependencies"
|
if %errorlevel% neq 0 (
|
||||||
|
echo.
|
||||||
if exist "node_modules\.package-lock.json" (
|
echo npm install failed. Check the error messages above.
|
||||||
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
|
pause
|
||||||
exit /b 1
|
exit /b 1
|
||||||
)
|
)
|
||||||
echo [OK] Backend dependencies installed.
|
echo [OK] Dependencies installed.
|
||||||
echo.
|
echo.
|
||||||
|
|
||||||
:: ============================================================
|
:: ---- Step 3: Build the project ----
|
||||||
:: Step 4b: Download native binaries from CDN
|
echo Building TypeScript project...
|
||||||
:: ============================================================
|
call npx tsc
|
||||||
call :step "4b/7" "Downloading native binaries"
|
if %errorlevel% neq 0 (
|
||||||
|
echo.
|
||||||
node scripts/download-binaries.mjs %CDN_MIRROR% >>"%LOG_FILE%" 2>&1
|
echo Build failed. Check the error messages above.
|
||||||
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
|
pause
|
||||||
exit /b 1
|
exit /b 1
|
||||||
)
|
)
|
||||||
echo [OK] Build succeeded.
|
echo [OK] Build succeeded.
|
||||||
echo.
|
echo.
|
||||||
|
|
||||||
:: ============================================================
|
:: ---- Step 4: Create default config if missing ----
|
||||||
:: 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" (
|
if not exist "config.json" (
|
||||||
echo [INFO] config.json will be auto-generated on first launch.
|
echo Creating default config.json...
|
||||||
|
echo Please edit config.json with your TeamSpeak server details before starting the bot.
|
||||||
) else (
|
) else (
|
||||||
echo [OK] config.json already exists.
|
echo [OK] config.json already exists.
|
||||||
)
|
)
|
||||||
echo.
|
echo.
|
||||||
|
|
||||||
:: ============================================================
|
:: ---- Done ----
|
||||||
:: Done
|
|
||||||
:: ============================================================
|
|
||||||
call :log "Setup completed successfully at %date% %time%"
|
|
||||||
|
|
||||||
echo ============================================
|
echo ============================================
|
||||||
echo Setup Complete!
|
echo Setup complete!
|
||||||
echo ============================================
|
echo ============================================
|
||||||
echo.
|
echo.
|
||||||
echo Next steps:
|
echo To start the bot, run: scripts\start.bat
|
||||||
echo 1. Run: scripts\start.bat
|
|
||||||
echo 2. Open: http://localhost:3000
|
|
||||||
echo.
|
|
||||||
echo Setup log: %LOG_FILE%
|
|
||||||
echo.
|
echo.
|
||||||
pause
|
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
|
|
||||||
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
#!/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 ""
|
|
||||||
|
|
||||||
+23
-20
@@ -7,7 +7,7 @@ echo.
|
|||||||
where node >nul 2>&1
|
where node >nul 2>&1
|
||||||
if %errorlevel% neq 0 (
|
if %errorlevel% neq 0 (
|
||||||
echo Node.js is not installed.
|
echo Node.js is not installed.
|
||||||
echo Run scripts\setup.bat first.
|
echo Run scripts\setup.bat for automatic installation, or install Node.js 20+ from https://nodejs.org
|
||||||
pause
|
pause
|
||||||
exit /b 1
|
exit /b 1
|
||||||
)
|
)
|
||||||
@@ -15,30 +15,33 @@ if %errorlevel% neq 0 (
|
|||||||
:: Resolve project root (one level up from scripts/)
|
:: Resolve project root (one level up from scripts/)
|
||||||
cd /d "%~dp0.."
|
cd /d "%~dp0.."
|
||||||
|
|
||||||
:: Check if dependencies are installed
|
:: Install dependencies if needed
|
||||||
if not exist "node_modules" (
|
if not exist "node_modules" (
|
||||||
echo Dependencies not found. Please run scripts\setup.bat first.
|
echo Installing dependencies...
|
||||||
pause
|
call npm install --production
|
||||||
exit /b 1
|
if %errorlevel% neq 0 (
|
||||||
)
|
echo Failed to install dependencies.
|
||||||
|
pause
|
||||||
:: Check if build output exists
|
exit /b 1
|
||||||
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\"
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
:: 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
|
:: Start the application
|
||||||
node dist/index.js
|
node dist/index.js
|
||||||
|
|
||||||
pause
|
pause
|
||||||
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
"""Regression: DELETE /api/bot/:id must broadcast botRemoved so the UI drops the row.
|
|
||||||
|
|
||||||
Creates an ephemeral bot, opens the dropdown, deletes the bot via API, and
|
|
||||||
asserts the row disappears without any page reload. Does not touch any
|
|
||||||
existing user bot.
|
|
||||||
"""
|
|
||||||
import time
|
|
||||||
import requests
|
|
||||||
from playwright.sync_api import sync_playwright
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
EPHEMERAL_NAME = "rmbot_test"
|
|
||||||
EPHEMERAL_NICK = "RmBotTest"
|
|
||||||
|
|
||||||
|
|
||||||
def api(path, method="GET", **kw):
|
|
||||||
r = getattr(requests, method.lower())(f"{BASE}{path}", timeout=10, **kw)
|
|
||||||
r.raise_for_status()
|
|
||||||
return r.json() if r.text else None
|
|
||||||
|
|
||||||
|
|
||||||
def cleanup():
|
|
||||||
for b in api("/api/bot/")["bots"]:
|
|
||||||
if b["name"] == EPHEMERAL_NAME:
|
|
||||||
try:
|
|
||||||
api(f"/api/bot/{b['id']}", method="DELETE")
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
cleanup()
|
|
||||||
new = api(
|
|
||||||
"/api/bot/",
|
|
||||||
method="POST",
|
|
||||||
json={
|
|
||||||
"name": EPHEMERAL_NAME,
|
|
||||||
"serverAddress": "127.0.0.1",
|
|
||||||
"serverPort": 9987,
|
|
||||||
"nickname": EPHEMERAL_NICK,
|
|
||||||
"autoStart": False,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
bot_id = new["id"]
|
|
||||||
print(f"[setup] created ephemeral bot {bot_id[:8]}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
with sync_playwright() as p:
|
|
||||||
browser = p.chromium.launch(headless=True)
|
|
||||||
try:
|
|
||||||
page = browser.new_page(viewport={"width": 1440, "height": 900})
|
|
||||||
page.goto(BASE)
|
|
||||||
page.wait_for_load_state("networkidle")
|
|
||||||
time.sleep(0.8)
|
|
||||||
|
|
||||||
# Open dropdown and confirm the new bot row is present
|
|
||||||
page.locator(".bot-selector-btn").click()
|
|
||||||
page.wait_for_selector(".bot-dropdown")
|
|
||||||
rows_before = page.locator(".bot-dropdown-row").count()
|
|
||||||
print(f"[ui] dropdown rows before remove: {rows_before}")
|
|
||||||
|
|
||||||
# Match the ephemeral row by its name text
|
|
||||||
present = (
|
|
||||||
page.locator(".bot-dropdown-row", has_text=EPHEMERAL_NAME).count()
|
|
||||||
)
|
|
||||||
assert present == 1, f"ephemeral row not found (got {present})"
|
|
||||||
|
|
||||||
# Delete via API
|
|
||||||
api(f"/api/bot/{bot_id}", method="DELETE")
|
|
||||||
print("[api] deleted bot")
|
|
||||||
|
|
||||||
# Wait up to 4s for UI to drop the row
|
|
||||||
removed = False
|
|
||||||
for _ in range(40):
|
|
||||||
if (
|
|
||||||
page.locator(
|
|
||||||
".bot-dropdown-row", has_text=EPHEMERAL_NAME
|
|
||||||
).count()
|
|
||||||
== 0
|
|
||||||
):
|
|
||||||
removed = True
|
|
||||||
break
|
|
||||||
time.sleep(0.1)
|
|
||||||
|
|
||||||
rows_after = page.locator(".bot-dropdown-row").count()
|
|
||||||
print(f"[ui] dropdown rows after remove: {rows_after}")
|
|
||||||
assert removed, "ephemeral row did not disappear from UI after DELETE"
|
|
||||||
assert rows_after == rows_before - 1, (
|
|
||||||
f"row count mismatch: before={rows_before} after={rows_after}"
|
|
||||||
)
|
|
||||||
print("[PASS] bot removal propagates to UI via WS")
|
|
||||||
finally:
|
|
||||||
browser.close()
|
|
||||||
finally:
|
|
||||||
cleanup()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
"""Corner case regressions that go beyond Bugs A/B/C.
|
|
||||||
|
|
||||||
A. Race — disconnect() called during connect()'s awaited handshake must
|
|
||||||
NOT leave the bot reporting connected=true afterwards.
|
|
||||||
|
|
||||||
B. Config-only commands (vol, mode, clear) must work even when the bot is
|
|
||||||
disconnected (UI should stay usable while the bot is offline).
|
|
||||||
|
|
||||||
C. After a disconnect mid-playback, the player must not be able to
|
|
||||||
auto-advance to the next queued song (trackEnd → resolveAndPlay).
|
|
||||||
"""
|
|
||||||
import time
|
|
||||||
import threading
|
|
||||||
import requests
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
|
|
||||||
|
|
||||||
def api(path, method="GET", **kw):
|
|
||||||
return getattr(requests, method.lower())(f"{BASE}{path}", timeout=30, **kw)
|
|
||||||
|
|
||||||
|
|
||||||
def get_bot(bot_id):
|
|
||||||
return next(b for b in api("/api/bot/").json()["bots"] if b["id"] == bot_id)
|
|
||||||
|
|
||||||
|
|
||||||
def wait_connected(bot_id, want, timeout=15):
|
|
||||||
end = time.time() + timeout
|
|
||||||
while time.time() < end:
|
|
||||||
if get_bot(bot_id)["connected"] is want:
|
|
||||||
return True
|
|
||||||
time.sleep(0.1)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_commands_when_disconnected(bot_id):
|
|
||||||
"""B. vol/mode/clear should succeed while bot is disconnected."""
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
|
|
||||||
# volume is the simplest config-only command
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json={"volume": 60},
|
|
||||||
)
|
|
||||||
assert r.status_code == 200, f"volume failed while disconnected: {r.status_code} {r.text[:100]}"
|
|
||||||
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/mode",
|
|
||||||
method="POST",
|
|
||||||
json={"mode": "seq"},
|
|
||||||
)
|
|
||||||
assert r.status_code == 200, f"mode failed while disconnected: {r.status_code} {r.text[:100]}"
|
|
||||||
|
|
||||||
r = api(f"/api/player/{bot_id}/clear", method="POST")
|
|
||||||
assert r.status_code == 200, f"clear failed while disconnected: {r.status_code} {r.text[:100]}"
|
|
||||||
|
|
||||||
print("[PASS] config commands (vol/mode/clear) work when disconnected")
|
|
||||||
|
|
||||||
|
|
||||||
def test_play_rejected_when_disconnected(bot_id):
|
|
||||||
"""B (negative). play/add/next/prev should still be rejected."""
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "test", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert r.status_code >= 400, f"play should fail while disconnected"
|
|
||||||
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/add",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "test", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert r.status_code >= 400, f"add should fail while disconnected"
|
|
||||||
|
|
||||||
r = api(f"/api/player/{bot_id}/next", method="POST")
|
|
||||||
assert r.status_code >= 400, f"next should fail while disconnected"
|
|
||||||
|
|
||||||
print("[PASS] audio commands (play/add/next) rejected when disconnected")
|
|
||||||
|
|
||||||
|
|
||||||
def test_disconnect_during_connect_race(bot_id):
|
|
||||||
"""A. disconnect() called while connect() is awaiting must win the race.
|
|
||||||
|
|
||||||
Fires a stop 200ms into a start call; after things settle the bot's
|
|
||||||
connected state must be stable (either cleanly disconnected, or cleanly
|
|
||||||
connected if the stop happened after connect completed). It must NOT
|
|
||||||
end up in a weird state where connected=true but a subsequent query
|
|
||||||
shows inconsistent data.
|
|
||||||
"""
|
|
||||||
# Ensure disconnected first
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
time.sleep(1) # give TS server a moment to forget us
|
|
||||||
|
|
||||||
def delayed_stop():
|
|
||||||
time.sleep(0.2)
|
|
||||||
try:
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
|
|
||||||
threading.Thread(target=delayed_stop, daemon=True).start()
|
|
||||||
try:
|
|
||||||
r = api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
except Exception as e:
|
|
||||||
r = None
|
|
||||||
print(f"[info] start threw: {e}")
|
|
||||||
|
|
||||||
# Wait for all state transitions to settle
|
|
||||||
time.sleep(2)
|
|
||||||
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
# The key invariant: if connected is false, playing must also be false;
|
|
||||||
# if connected is true, the transport is actually up (we can issue
|
|
||||||
# another command without error).
|
|
||||||
assert not (b["connected"] is False and b["playing"] is True), (
|
|
||||||
f"inconsistent state: connected={b['connected']} playing={b['playing']}"
|
|
||||||
)
|
|
||||||
print(
|
|
||||||
f"[PASS] disconnect-during-connect race — final state consistent "
|
|
||||||
f"(connected={b['connected']} playing={b['playing']})"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_resolve_guard(bot_id):
|
|
||||||
"""C. resolveAndPlay on a disconnected bot is a no-op.
|
|
||||||
|
|
||||||
We can't directly invoke resolveAndPlay from the API, but we can
|
|
||||||
verify by checking that after a stop, the bot stays idle even if we
|
|
||||||
wait for a trackEnd-like event to fire.
|
|
||||||
"""
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
time.sleep(1.5) # more than a frame cycle
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not b["playing"], (
|
|
||||||
f"player should stay stopped after disconnect: {b}"
|
|
||||||
)
|
|
||||||
print("[PASS] player stays idle after disconnect (no ghost autoplay)")
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
bots = api("/api/bot/").json()["bots"]
|
|
||||||
if not bots:
|
|
||||||
print("[skip] no bots")
|
|
||||||
return
|
|
||||||
bot_id = bots[0]["id"]
|
|
||||||
initial = bots[0]["connected"]
|
|
||||||
print(f"[init] bot={bot_id[:8]} initial connected={initial}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
test_config_commands_when_disconnected(bot_id)
|
|
||||||
test_play_rejected_when_disconnected(bot_id)
|
|
||||||
test_resolve_guard(bot_id)
|
|
||||||
test_disconnect_during_connect_race(bot_id)
|
|
||||||
print("ALL GREEN")
|
|
||||||
finally:
|
|
||||||
if initial:
|
|
||||||
api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
wait_connected(bot_id, True)
|
|
||||||
else:
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
print(f"[restore] connected={get_bot(bot_id)['connected']}")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,852 +0,0 @@
|
|||||||
"""Comprehensive feature + corner-case test for TSMusicBot against a
|
|
||||||
local TeamSpeak 3 server.
|
|
||||||
|
|
||||||
Exercises every major HTTP endpoint, the WebSocket state-broadcast path,
|
|
||||||
all music providers, bot lifecycle transitions, and a handful of races
|
|
||||||
that have burned us in the past. Designed to be safe to run against a
|
|
||||||
real installation: captures the target bot's initial connected/volume/
|
|
||||||
mode settings and restores them in `finally`.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
"C:/Users/saopig1/miniforge3/python.exe" scripts/test_full_feature.py
|
|
||||||
|
|
||||||
Exit code: 0 if every non-skipped test passed, 1 otherwise.
|
|
||||||
"""
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import json
|
|
||||||
import threading
|
|
||||||
import time
|
|
||||||
from dataclasses import dataclass
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
import requests
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
POLL_INTERVAL = 0.15
|
|
||||||
CONNECT_TIMEOUT = 20 # tolerate occasional TS3 anti-flood grace
|
|
||||||
ANTIFLOOD_BREATHER = 1.5 # gap between rapid cycles so TS3 stays happy
|
|
||||||
|
|
||||||
|
|
||||||
# ----------------------------- HTTP helpers ---------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def api(path: str, method: str = "GET", json_body: Any = None):
|
|
||||||
"""Return (status_code, body). Never raises."""
|
|
||||||
try:
|
|
||||||
fn = getattr(requests, method.lower())
|
|
||||||
r = fn(f"{BASE}{path}", json=json_body, timeout=30)
|
|
||||||
try:
|
|
||||||
return r.status_code, r.json()
|
|
||||||
except Exception:
|
|
||||||
return r.status_code, r.text
|
|
||||||
except Exception as e:
|
|
||||||
return None, f"<{type(e).__name__}: {e}>"
|
|
||||||
|
|
||||||
|
|
||||||
def get_bot(bot_id: str) -> dict | None:
|
|
||||||
_, data = api("/api/bot/")
|
|
||||||
if not isinstance(data, dict):
|
|
||||||
return None
|
|
||||||
return next((b for b in data.get("bots", []) if b["id"] == bot_id), None)
|
|
||||||
|
|
||||||
|
|
||||||
def wait_connected(bot_id: str, want: bool, timeout: float = CONNECT_TIMEOUT) -> bool:
|
|
||||||
end = time.time() + timeout
|
|
||||||
while time.time() < end:
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
if b is not None and b["connected"] is want:
|
|
||||||
return True
|
|
||||||
time.sleep(POLL_INTERVAL)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def start_and_wait(bot_id: str, retries: int = 2) -> bool:
|
|
||||||
"""Start the bot, tolerating transient TS3 anti-flood by retrying with
|
|
||||||
exponential backoff. Returns True only when the bot reports connected."""
|
|
||||||
for attempt in range(retries + 1):
|
|
||||||
s, _ = api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
if s == 200 and wait_connected(bot_id, True):
|
|
||||||
return True
|
|
||||||
# If /start returned an error (e.g. connect timeout from our 15s
|
|
||||||
# deadline), back off and retry — TS3 server-side anti-flood
|
|
||||||
# usually clears in a few seconds.
|
|
||||||
if attempt < retries:
|
|
||||||
time.sleep(3.0 * (attempt + 1))
|
|
||||||
# Make sure we're fully stopped before the next attempt so
|
|
||||||
# oldBot.disconnect() doesn't double-fire
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False, timeout=5)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def stop_and_wait(bot_id: str) -> bool:
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
return wait_connected(bot_id, False)
|
|
||||||
|
|
||||||
|
|
||||||
def assert_started(bot_id: str):
|
|
||||||
"""Helper that raises with a clear message when start fails so test
|
|
||||||
output points at 'could not connect' rather than an empty assertion."""
|
|
||||||
if not start_and_wait(bot_id):
|
|
||||||
raise AssertionError(
|
|
||||||
"could not bring bot online (TS3 server may be anti-flooding "
|
|
||||||
"or unreachable)"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# ----------------------------- test runner ----------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class TestResult:
|
|
||||||
name: str
|
|
||||||
status: str # PASS / FAIL / ERROR / SKIP
|
|
||||||
detail: str = ""
|
|
||||||
|
|
||||||
|
|
||||||
passed = 0
|
|
||||||
failed = 0
|
|
||||||
skipped = 0
|
|
||||||
results: list[TestResult] = []
|
|
||||||
|
|
||||||
|
|
||||||
def run(name: str, fn):
|
|
||||||
global passed, failed
|
|
||||||
try:
|
|
||||||
fn()
|
|
||||||
print(f" [PASS] {name}")
|
|
||||||
passed += 1
|
|
||||||
results.append(TestResult(name, "PASS"))
|
|
||||||
except AssertionError as e:
|
|
||||||
print(f" [FAIL] {name}: {e}")
|
|
||||||
failed += 1
|
|
||||||
results.append(TestResult(name, "FAIL", str(e)))
|
|
||||||
except Exception as e:
|
|
||||||
print(f" [ERROR] {name}: {type(e).__name__}: {e}")
|
|
||||||
failed += 1
|
|
||||||
results.append(TestResult(name, "ERROR", f"{type(e).__name__}: {e}"))
|
|
||||||
|
|
||||||
|
|
||||||
def skip(name: str, reason: str):
|
|
||||||
global skipped
|
|
||||||
print(f" [SKIP] {name} ({reason})")
|
|
||||||
skipped += 1
|
|
||||||
results.append(TestResult(name, "SKIP", reason))
|
|
||||||
|
|
||||||
|
|
||||||
# ----------------------------- test groups ----------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def group_infrastructure(bot_id: str):
|
|
||||||
print("\n== infrastructure ==")
|
|
||||||
|
|
||||||
def t_health():
|
|
||||||
s, d = api("/api/health")
|
|
||||||
assert s == 200, f"health returned {s}"
|
|
||||||
assert d.get("status") == "ok"
|
|
||||||
run("GET /api/health", t_health)
|
|
||||||
|
|
||||||
def t_list_bots():
|
|
||||||
s, d = api("/api/bot/")
|
|
||||||
assert s == 200
|
|
||||||
assert isinstance(d.get("bots"), list)
|
|
||||||
assert any(b["id"] == bot_id for b in d["bots"])
|
|
||||||
run("GET /api/bot/ lists target bot", t_list_bots)
|
|
||||||
|
|
||||||
def t_bot_config():
|
|
||||||
s, d = api(f"/api/bot/{bot_id}/config")
|
|
||||||
assert s == 200
|
|
||||||
assert d["id"] == bot_id
|
|
||||||
assert "identity" in d
|
|
||||||
assert "serverAddress" in d and "nickname" in d
|
|
||||||
assert "serverPassword" in d, "serverPassword field missing"
|
|
||||||
run("GET /api/bot/:id/config returns all fields", t_bot_config)
|
|
||||||
|
|
||||||
def t_404_on_unknown_bot():
|
|
||||||
s, _ = api("/api/bot/does-not-exist/config")
|
|
||||||
assert s == 404
|
|
||||||
run("404 on unknown bot id", t_404_on_unknown_bot)
|
|
||||||
|
|
||||||
def t_quality_shape():
|
|
||||||
s, d = api("/api/music/quality")
|
|
||||||
assert s == 200
|
|
||||||
for p in ("netease", "qq", "bilibili"):
|
|
||||||
assert p in d, f"{p} missing from quality response"
|
|
||||||
run("GET /api/music/quality shape", t_quality_shape)
|
|
||||||
|
|
||||||
|
|
||||||
def group_auth_status():
|
|
||||||
print("\n== auth status per platform ==")
|
|
||||||
|
|
||||||
def t_netease_ok():
|
|
||||||
s, d = api("/api/auth/status?platform=netease")
|
|
||||||
assert s == 200
|
|
||||||
assert d.get("platform") == "netease"
|
|
||||||
assert "loggedIn" in d
|
|
||||||
run("auth status netease", t_netease_ok)
|
|
||||||
|
|
||||||
def t_qq_ok():
|
|
||||||
s, d = api("/api/auth/status?platform=qq")
|
|
||||||
assert s == 200
|
|
||||||
assert d.get("platform") == "qq"
|
|
||||||
run("auth status qq", t_qq_ok)
|
|
||||||
|
|
||||||
def t_bilibili_ok():
|
|
||||||
s, d = api("/api/auth/status?platform=bilibili")
|
|
||||||
assert s == 200
|
|
||||||
assert d.get("platform") == "bilibili"
|
|
||||||
run("auth status bilibili", t_bilibili_ok)
|
|
||||||
|
|
||||||
def t_youtube_routed():
|
|
||||||
# Regression: /auth/status?platform=youtube used to fall through
|
|
||||||
# to NetEase and leak the NetEase user's nickname/avatar.
|
|
||||||
s, d = api("/api/auth/status?platform=youtube")
|
|
||||||
assert s == 200
|
|
||||||
assert d.get("platform") == "youtube", (
|
|
||||||
f"youtube auth status leaked to {d.get('platform')}"
|
|
||||||
)
|
|
||||||
run("auth status youtube routes correctly", t_youtube_routed)
|
|
||||||
|
|
||||||
def t_youtube_cookie_rejected():
|
|
||||||
s, d = api(
|
|
||||||
"/api/auth/cookie",
|
|
||||||
method="POST",
|
|
||||||
json_body={"platform": "youtube", "cookie": "fake"},
|
|
||||||
)
|
|
||||||
assert s == 400, f"youtube cookie should be rejected, got {s}: {d}"
|
|
||||||
run("POST /auth/cookie rejects youtube", t_youtube_cookie_rejected)
|
|
||||||
|
|
||||||
|
|
||||||
def group_search():
|
|
||||||
print("\n== multi-platform search ==")
|
|
||||||
|
|
||||||
def search(platform: str, query: str = "test"):
|
|
||||||
return api(f"/api/music/search?q={query}&platform={platform}&limit=1")
|
|
||||||
|
|
||||||
def t_netease():
|
|
||||||
s, d = search("netease")
|
|
||||||
assert s == 200
|
|
||||||
assert isinstance(d.get("songs"), list)
|
|
||||||
run("netease search", t_netease)
|
|
||||||
|
|
||||||
def t_qq():
|
|
||||||
s, d = search("qq")
|
|
||||||
assert s == 200
|
|
||||||
# QQ may return 0 results if no cookie, but shouldn't error
|
|
||||||
assert isinstance(d.get("songs"), list)
|
|
||||||
run("qq search (empty ok)", t_qq)
|
|
||||||
|
|
||||||
def t_bilibili():
|
|
||||||
s, d = search("bilibili")
|
|
||||||
assert s == 200
|
|
||||||
assert isinstance(d.get("songs"), list)
|
|
||||||
run("bilibili search", t_bilibili)
|
|
||||||
|
|
||||||
def t_missing_query():
|
|
||||||
s, _ = api("/api/music/search?platform=netease")
|
|
||||||
assert s == 400, "missing q should 400"
|
|
||||||
run("400 on missing query", t_missing_query)
|
|
||||||
|
|
||||||
_, auth = api("/api/auth/status?platform=youtube")
|
|
||||||
youtube_available = isinstance(auth, dict) and auth.get("loggedIn") is True
|
|
||||||
|
|
||||||
if youtube_available:
|
|
||||||
def t_youtube():
|
|
||||||
s, d = search("youtube", "lofi")
|
|
||||||
assert s == 200
|
|
||||||
songs = d.get("songs", [])
|
|
||||||
assert len(songs) >= 1, "expected at least 1 YouTube result"
|
|
||||||
assert songs[0]["platform"] == "youtube"
|
|
||||||
run("youtube search (yt-dlp installed)", t_youtube)
|
|
||||||
else:
|
|
||||||
skip("youtube search", "yt-dlp not installed")
|
|
||||||
|
|
||||||
|
|
||||||
def group_lifecycle(bot_id: str):
|
|
||||||
print("\n== connection lifecycle ==")
|
|
||||||
|
|
||||||
def t_stop_from_any_state():
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
assert wait_connected(bot_id, False), "bot did not stop"
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not b["playing"], "playing should be false after stop"
|
|
||||||
run("stop from any state \u2192 disconnected+idle", t_stop_from_any_state)
|
|
||||||
|
|
||||||
def t_start_completes_quickly():
|
|
||||||
t0 = time.time()
|
|
||||||
s, d = api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
elapsed = time.time() - t0
|
|
||||||
assert s == 200, f"start failed: {d}"
|
|
||||||
assert elapsed < 10, f"start took {elapsed:.1f}s (expected <10s)"
|
|
||||||
assert wait_connected(bot_id, True)
|
|
||||||
run("start completes well under 15s deadline", t_start_completes_quickly)
|
|
||||||
|
|
||||||
def t_identity_persists():
|
|
||||||
assert_started(bot_id)
|
|
||||||
_, cfg1 = api(f"/api/bot/{bot_id}/config")
|
|
||||||
id1 = cfg1["identity"]
|
|
||||||
assert id1, "identity empty after first start"
|
|
||||||
assert stop_and_wait(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
assert_started(bot_id)
|
|
||||||
_, cfg2 = api(f"/api/bot/{bot_id}/config")
|
|
||||||
assert cfg2["identity"] == id1, (
|
|
||||||
f"identity changed across restart: {id1} \u2192 {cfg2['identity']}"
|
|
||||||
)
|
|
||||||
run("identity preserved across stop/start", t_identity_persists)
|
|
||||||
|
|
||||||
|
|
||||||
def group_playback(bot_id: str):
|
|
||||||
print("\n== playback ==")
|
|
||||||
|
|
||||||
# Bring the bot online ONCE for the whole playback group, then only
|
|
||||||
# toggle player state (play/pause/stop) between tests. This keeps the
|
|
||||||
# TS3 reconnect count for this group at exactly 1.
|
|
||||||
assert_started(bot_id)
|
|
||||||
|
|
||||||
def t_play_song():
|
|
||||||
s, d = api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert s == 200, f"play failed: {d}"
|
|
||||||
time.sleep(1.2)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["playing"] is True, f"not playing after /play: {b}"
|
|
||||||
assert b["currentSong"] is not None
|
|
||||||
run("play netease song \u2192 playing=true", t_play_song)
|
|
||||||
|
|
||||||
def t_pause_resume():
|
|
||||||
# Previous test left a song playing
|
|
||||||
api(f"/api/player/{bot_id}/pause", method="POST")
|
|
||||||
time.sleep(0.4)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["paused"] is True, f"pause failed: {b}"
|
|
||||||
api(f"/api/player/{bot_id}/resume", method="POST")
|
|
||||||
time.sleep(0.4)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["paused"] is False and b["playing"] is True, f"resume failed: {b}"
|
|
||||||
run("pause \u2192 paused, resume \u2192 playing", t_pause_resume)
|
|
||||||
|
|
||||||
def t_volume_change():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": 42},
|
|
||||||
)
|
|
||||||
assert s == 200
|
|
||||||
time.sleep(0.2)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["volume"] == 42, f"volume not applied: {b['volume']}"
|
|
||||||
run("volume change", t_volume_change)
|
|
||||||
|
|
||||||
def t_mode_cycle():
|
|
||||||
for m in ("seq", "loop", "random", "rloop"):
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/mode", method="POST", json_body={"mode": m}
|
|
||||||
)
|
|
||||||
assert s == 200
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["playMode"] == m, f"mode {m} not applied: {b['playMode']}"
|
|
||||||
run("all four play modes apply", t_mode_cycle)
|
|
||||||
|
|
||||||
def t_queue_endpoint():
|
|
||||||
s, d = api(f"/api/player/{bot_id}/queue")
|
|
||||||
assert s == 200
|
|
||||||
assert isinstance(d.get("queue"), list)
|
|
||||||
assert "status" in d
|
|
||||||
run("GET /player/:id/queue returns queue+status", t_queue_endpoint)
|
|
||||||
|
|
||||||
def t_elapsed_endpoint():
|
|
||||||
s, d = api(f"/api/player/{bot_id}/elapsed")
|
|
||||||
assert s == 200
|
|
||||||
elapsed = d.get("elapsed")
|
|
||||||
assert isinstance(elapsed, (int, float)) and elapsed >= 0, (
|
|
||||||
f"elapsed should be non-negative number: {elapsed}"
|
|
||||||
)
|
|
||||||
run("GET /player/:id/elapsed returns finite number", t_elapsed_endpoint)
|
|
||||||
|
|
||||||
def t_add_autoplay_on_idle():
|
|
||||||
# This specific test needs an IDLE bot — stop first (but keep
|
|
||||||
# connected), then add and confirm auto-play.
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
time.sleep(0.4)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not b["playing"] and b["queueSize"] == 0, f"setup failed: {b}"
|
|
||||||
s, d = api(
|
|
||||||
f"/api/player/{bot_id}/add",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert s == 200
|
|
||||||
msg = d.get("message", "") if isinstance(d, dict) else ""
|
|
||||||
assert "Now playing" in msg, (
|
|
||||||
f"add on idle bot should auto-play, got: {msg!r}"
|
|
||||||
)
|
|
||||||
time.sleep(0.8)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["playing"] is True, f"not playing after add: {b}"
|
|
||||||
run("add on idle bot auto-plays", t_add_autoplay_on_idle)
|
|
||||||
|
|
||||||
# Leave the bot in a clean state for the next group
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
|
|
||||||
|
|
||||||
def group_queue_ops(bot_id: str):
|
|
||||||
print("\n== queue operations ==")
|
|
||||||
assert_started(bot_id)
|
|
||||||
|
|
||||||
def t_clear():
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(0.8)
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/add",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "lemon tree", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(0.6)
|
|
||||||
b_before = get_bot(bot_id)
|
|
||||||
assert b_before["queueSize"] >= 2, f"expected \u22652 songs: {b_before}"
|
|
||||||
api(f"/api/player/{bot_id}/clear", method="POST")
|
|
||||||
time.sleep(0.4)
|
|
||||||
b_after = get_bot(bot_id)
|
|
||||||
assert b_after["queueSize"] == 0
|
|
||||||
run("clear queue empties it", t_clear)
|
|
||||||
|
|
||||||
def t_play_at_invalid_preserves_playback():
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(1.2)
|
|
||||||
assert get_bot(bot_id)["playing"]
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/play-at",
|
|
||||||
method="POST",
|
|
||||||
json_body={"index": 9999},
|
|
||||||
)
|
|
||||||
assert s == 400, f"invalid index should 400, got {s}"
|
|
||||||
time.sleep(0.4)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["playing"], "invalid play-at killed the current song"
|
|
||||||
run("invalid play-at preserves current playback", t_play_at_invalid_preserves_playback)
|
|
||||||
|
|
||||||
def t_play_at_negative_rejected():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/play-at",
|
|
||||||
method="POST",
|
|
||||||
json_body={"index": -1},
|
|
||||||
)
|
|
||||||
assert s == 400
|
|
||||||
run("play-at with negative index rejected", t_play_at_negative_rejected)
|
|
||||||
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
|
|
||||||
|
|
||||||
def group_input_validation(bot_id: str):
|
|
||||||
print("\n== HTTP input validation ==")
|
|
||||||
|
|
||||||
def t_volume_out_of_range():
|
|
||||||
for bad in (150, -10, 1000, -1):
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": bad},
|
|
||||||
)
|
|
||||||
assert s == 400, f"volume={bad} should 400, got {s}"
|
|
||||||
run("volume out-of-range rejected (400)", t_volume_out_of_range)
|
|
||||||
|
|
||||||
def t_volume_wrong_type():
|
|
||||||
for bad in ("50", None, [50], {"v": 50}):
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": bad},
|
|
||||||
)
|
|
||||||
assert s == 400, f"volume={bad!r} should 400, got {s}"
|
|
||||||
run("volume wrong-type rejected (400)", t_volume_wrong_type)
|
|
||||||
|
|
||||||
def t_volume_missing():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume", method="POST", json_body={}
|
|
||||||
)
|
|
||||||
assert s == 400
|
|
||||||
run("volume missing rejected (400)", t_volume_missing)
|
|
||||||
|
|
||||||
def t_volume_valid():
|
|
||||||
for good in (0, 1, 50, 100):
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": good},
|
|
||||||
)
|
|
||||||
assert s == 200, f"volume={good} should succeed, got {s}"
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["volume"] == good, f"volume not applied: {b['volume']}"
|
|
||||||
run("valid volumes apply", t_volume_valid)
|
|
||||||
|
|
||||||
def t_mode_invalid():
|
|
||||||
for bad in ("bogus", "", None, 1, "SEQ"):
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/mode",
|
|
||||||
method="POST",
|
|
||||||
json_body={"mode": bad},
|
|
||||||
)
|
|
||||||
assert s == 400, f"mode={bad!r} should 400, got {s}"
|
|
||||||
run("mode invalid rejected (400)", t_mode_invalid)
|
|
||||||
|
|
||||||
def t_mode_missing():
|
|
||||||
s, _ = api(f"/api/player/{bot_id}/mode", method="POST", json_body={})
|
|
||||||
assert s == 400
|
|
||||||
run("mode missing rejected (400)", t_mode_missing)
|
|
||||||
|
|
||||||
|
|
||||||
def group_disconnect_corners(bot_id: str):
|
|
||||||
print("\n== disconnected-bot corners ==")
|
|
||||||
|
|
||||||
def t_play_rejected():
|
|
||||||
assert stop_and_wait(bot_id)
|
|
||||||
s, d = api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "x", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert s >= 400
|
|
||||||
err = (d.get("error") or "") if isinstance(d, dict) else ""
|
|
||||||
assert "not connected" in err.lower(), f"expected 'not connected' error: {d}"
|
|
||||||
run("play rejected while disconnected", t_play_rejected)
|
|
||||||
|
|
||||||
def t_add_rejected():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/add",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "x", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert s >= 400
|
|
||||||
run("add rejected while disconnected", t_add_rejected)
|
|
||||||
|
|
||||||
def t_next_rejected():
|
|
||||||
s, _ = api(f"/api/player/{bot_id}/next", method="POST")
|
|
||||||
assert s >= 400
|
|
||||||
run("next rejected while disconnected", t_next_rejected)
|
|
||||||
|
|
||||||
def t_volume_allowed():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": 60},
|
|
||||||
)
|
|
||||||
assert s == 200, "volume should work while disconnected"
|
|
||||||
run("volume allowed while disconnected", t_volume_allowed)
|
|
||||||
|
|
||||||
def t_mode_allowed():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/mode", method="POST", json_body={"mode": "random"}
|
|
||||||
)
|
|
||||||
assert s == 200, "mode should work while disconnected"
|
|
||||||
run("mode allowed while disconnected", t_mode_allowed)
|
|
||||||
|
|
||||||
def t_clear_allowed():
|
|
||||||
s, _ = api(f"/api/player/{bot_id}/clear", method="POST")
|
|
||||||
assert s == 200, "clear should work while disconnected"
|
|
||||||
run("clear allowed while disconnected", t_clear_allowed)
|
|
||||||
|
|
||||||
def t_player_state_clean():
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not b["playing"] and not b["paused"], f"state leak: {b}"
|
|
||||||
run("no player state leak while disconnected", t_player_state_clean)
|
|
||||||
|
|
||||||
|
|
||||||
def group_seek(bot_id: str):
|
|
||||||
print("\n== seek validation ==")
|
|
||||||
|
|
||||||
def t_negative():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/seek", method="POST", json_body={"position": -5}
|
|
||||||
)
|
|
||||||
assert s == 400
|
|
||||||
run("negative seek rejected", t_negative)
|
|
||||||
|
|
||||||
def t_string():
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/seek",
|
|
||||||
method="POST",
|
|
||||||
json_body={"position": "abc"},
|
|
||||||
)
|
|
||||||
assert s == 400
|
|
||||||
run("string seek rejected", t_string)
|
|
||||||
|
|
||||||
def t_nan_literal():
|
|
||||||
r = requests.post(
|
|
||||||
f"{BASE}/api/player/{bot_id}/seek",
|
|
||||||
data='{"position": NaN}',
|
|
||||||
headers={"Content-Type": "application/json"},
|
|
||||||
timeout=10,
|
|
||||||
)
|
|
||||||
assert r.status_code >= 400, f"NaN literal accepted: {r.status_code}"
|
|
||||||
run("NaN literal seek rejected", t_nan_literal)
|
|
||||||
|
|
||||||
def t_valid_seek():
|
|
||||||
# Seek needs a live connection + playing song. The disconnect-
|
|
||||||
# corners group right before this one left the bot disconnected.
|
|
||||||
assert_started(bot_id)
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(1.5)
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/seek",
|
|
||||||
method="POST",
|
|
||||||
json_body={"position": 25},
|
|
||||||
)
|
|
||||||
assert s == 200
|
|
||||||
time.sleep(0.5)
|
|
||||||
_, d = api(f"/api/player/{bot_id}/elapsed")
|
|
||||||
elapsed = d.get("elapsed")
|
|
||||||
assert isinstance(elapsed, (int, float)) and 24 <= elapsed < 40, (
|
|
||||||
f"elapsed after seek(25) wrong: {elapsed}"
|
|
||||||
)
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
run("valid seek produces finite elapsed", t_valid_seek)
|
|
||||||
|
|
||||||
|
|
||||||
def group_races(bot_id: str):
|
|
||||||
print("\n== race conditions ==")
|
|
||||||
|
|
||||||
def t_disconnect_during_connect():
|
|
||||||
assert stop_and_wait(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
|
|
||||||
def delayed_stop():
|
|
||||||
time.sleep(0.2)
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
|
|
||||||
threading.Thread(target=delayed_stop, daemon=True).start()
|
|
||||||
api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
time.sleep(2)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not (b["connected"] is False and b["playing"] is True), (
|
|
||||||
f"inconsistent state: {b}"
|
|
||||||
)
|
|
||||||
run("disconnect during connect", t_disconnect_during_connect)
|
|
||||||
|
|
||||||
def t_stop_during_url_resolve():
|
|
||||||
assert stop_and_wait(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
assert_started(bot_id)
|
|
||||||
|
|
||||||
def delayed_stop():
|
|
||||||
time.sleep(0.15)
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
|
|
||||||
threading.Thread(target=delayed_stop, daemon=True).start()
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(3)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not (b["connected"] is False and b["playing"] is True), (
|
|
||||||
f"inconsistent state: {b}"
|
|
||||||
)
|
|
||||||
run("stop during URL resolve", t_stop_during_url_resolve)
|
|
||||||
|
|
||||||
def t_rapid_volume_change():
|
|
||||||
# Volume is a config-only command and works while disconnected,
|
|
||||||
# so this test deliberately doesn't call assert_started — we're
|
|
||||||
# validating the API's last-write-wins behavior, not the TS
|
|
||||||
# transport. That also spares the TS3 anti-flood budget.
|
|
||||||
for v in (10, 25, 50, 75, 100, 1):
|
|
||||||
s, _ = api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": v},
|
|
||||||
)
|
|
||||||
assert s == 200, f"volume POST failed: {s}"
|
|
||||||
time.sleep(0.3)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["volume"] == 1, f"final volume wrong: {b['volume']}"
|
|
||||||
run("rapid volume changes converge", t_rapid_volume_change)
|
|
||||||
|
|
||||||
|
|
||||||
def group_websocket(bot_id: str):
|
|
||||||
print("\n== websocket broadcasts ==")
|
|
||||||
try:
|
|
||||||
from websocket import create_connection
|
|
||||||
except Exception as e:
|
|
||||||
skip("websocket state broadcasts", f"websocket lib unavailable: {e}")
|
|
||||||
return
|
|
||||||
|
|
||||||
try:
|
|
||||||
ws = create_connection("ws://localhost:3000/ws", timeout=5)
|
|
||||||
except Exception as e:
|
|
||||||
skip("websocket state broadcasts", f"connect failed: {e}")
|
|
||||||
return
|
|
||||||
|
|
||||||
ws.settimeout(0.3)
|
|
||||||
messages: list[dict] = []
|
|
||||||
stop_reader = threading.Event()
|
|
||||||
|
|
||||||
def reader():
|
|
||||||
while not stop_reader.is_set():
|
|
||||||
try:
|
|
||||||
raw = ws.recv()
|
|
||||||
if not raw:
|
|
||||||
break
|
|
||||||
try:
|
|
||||||
messages.append(json.loads(raw))
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
except Exception:
|
|
||||||
# recv() timeout or closed — keep trying until stop_reader
|
|
||||||
if stop_reader.is_set():
|
|
||||||
break
|
|
||||||
continue
|
|
||||||
|
|
||||||
reader_thread = threading.Thread(target=reader, daemon=True)
|
|
||||||
reader_thread.start()
|
|
||||||
|
|
||||||
try:
|
|
||||||
def t_init():
|
|
||||||
time.sleep(0.6)
|
|
||||||
types = [m.get("type") for m in messages]
|
|
||||||
assert "init" in types, f"no init message; got: {types}"
|
|
||||||
run("init message on connect", t_init)
|
|
||||||
|
|
||||||
def t_state_change_on_play():
|
|
||||||
assert_started(bot_id)
|
|
||||||
messages.clear()
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json_body={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(1.5)
|
|
||||||
types = [m.get("type") for m in messages]
|
|
||||||
assert "stateChange" in types, (
|
|
||||||
f"no stateChange after play; got types: {types}"
|
|
||||||
)
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
run("stateChange broadcast on play", t_state_change_on_play)
|
|
||||||
|
|
||||||
def t_bot_disconnected_event():
|
|
||||||
assert_started(bot_id)
|
|
||||||
messages.clear()
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
time.sleep(1.5)
|
|
||||||
types = [m.get("type") for m in messages]
|
|
||||||
assert "botDisconnected" in types or "stateChange" in types, (
|
|
||||||
f"no disconnect event; got: {types}"
|
|
||||||
)
|
|
||||||
run("botDisconnected event on stop", t_bot_disconnected_event)
|
|
||||||
finally:
|
|
||||||
stop_reader.set()
|
|
||||||
try:
|
|
||||||
ws.close()
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
# ----------------------------- main ----------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
_, data = api("/api/bot/")
|
|
||||||
if not isinstance(data, dict) or not data.get("bots"):
|
|
||||||
print("[fatal] no bots registered — create one via the WebUI first")
|
|
||||||
return 2
|
|
||||||
|
|
||||||
target = data["bots"][0]
|
|
||||||
bot_id = target["id"]
|
|
||||||
initial_connected = target["connected"]
|
|
||||||
initial_volume = target["volume"]
|
|
||||||
initial_mode = target["playMode"]
|
|
||||||
|
|
||||||
print(f"[init] target bot = {bot_id[:8]} ({target['name']})")
|
|
||||||
print(
|
|
||||||
f"[init] initial state: connected={initial_connected} "
|
|
||||||
f"volume={initial_volume} mode={initial_mode}"
|
|
||||||
)
|
|
||||||
|
|
||||||
try:
|
|
||||||
# Read-only / no-lifecycle groups first — they don't consume TS3
|
|
||||||
# anti-flood budget.
|
|
||||||
group_infrastructure(bot_id)
|
|
||||||
group_auth_status()
|
|
||||||
group_search()
|
|
||||||
|
|
||||||
# Lifecycle-heavy groups — interleave with small breathers so the
|
|
||||||
# TS3 server's per-IP reconnect limit doesn't start throttling us.
|
|
||||||
group_lifecycle(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
|
|
||||||
group_playback(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
|
|
||||||
group_queue_ops(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
|
|
||||||
group_input_validation(bot_id)
|
|
||||||
group_disconnect_corners(bot_id)
|
|
||||||
group_seek(bot_id)
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER)
|
|
||||||
|
|
||||||
group_races(bot_id)
|
|
||||||
# Extra breather before websocket group — races is the heaviest
|
|
||||||
# consumer of TS3 reconnect budget (disconnect-during-connect and
|
|
||||||
# stop-during-url-resolve each burn one cycle), and the websocket
|
|
||||||
# group needs a clean reconnect to observe live state broadcasts.
|
|
||||||
time.sleep(ANTIFLOOD_BREATHER * 3)
|
|
||||||
|
|
||||||
group_websocket(bot_id)
|
|
||||||
finally:
|
|
||||||
# Restore initial state — this runs even if a test raised
|
|
||||||
try:
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/volume",
|
|
||||||
method="POST",
|
|
||||||
json_body={"volume": initial_volume},
|
|
||||||
)
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/mode",
|
|
||||||
method="POST",
|
|
||||||
json_body={"mode": initial_mode},
|
|
||||||
)
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
if initial_connected:
|
|
||||||
start_and_wait(bot_id)
|
|
||||||
else:
|
|
||||||
stop_and_wait(bot_id)
|
|
||||||
except Exception as e:
|
|
||||||
print(f"[warn] restore failed: {e}")
|
|
||||||
|
|
||||||
print()
|
|
||||||
print("=" * 60)
|
|
||||||
print(f" PASSED: {passed}")
|
|
||||||
print(f" FAILED: {failed}")
|
|
||||||
print(f" SKIPPED: {skipped}")
|
|
||||||
print("=" * 60)
|
|
||||||
|
|
||||||
if failed > 0:
|
|
||||||
print("\nFailed tests:")
|
|
||||||
for r in results:
|
|
||||||
if r.status in ("FAIL", "ERROR"):
|
|
||||||
print(f" [{r.status}] {r.name}: {r.detail}")
|
|
||||||
|
|
||||||
return 0 if failed == 0 else 1
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
import sys
|
|
||||||
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
// 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"}`,
|
|
||||||
);
|
|
||||||
@@ -1,166 +0,0 @@
|
|||||||
"""More corner-case regressions.
|
|
||||||
|
|
||||||
A. resolveAndPlay disconnect-during-URL-resolve race
|
|
||||||
The bot checks !this.connected at the top of resolveAndPlay, but the
|
|
||||||
URL-resolve await can take several seconds. If stop is called during
|
|
||||||
that window, playback would previously start on a disconnected bot.
|
|
||||||
|
|
||||||
B. /seek NaN/Infinity rejection
|
|
||||||
typeof NaN === "number" and NaN < 0 is false, so a plain range check
|
|
||||||
leaks NaN through and corrupts seekOffset / getElapsed.
|
|
||||||
"""
|
|
||||||
import threading
|
|
||||||
import time
|
|
||||||
import requests
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
|
|
||||||
|
|
||||||
def api(path, method="GET", **kw):
|
|
||||||
return getattr(requests, method.lower())(f"{BASE}{path}", timeout=30, **kw)
|
|
||||||
|
|
||||||
|
|
||||||
def get_bot(bot_id):
|
|
||||||
return next(b for b in api("/api/bot/").json()["bots"] if b["id"] == bot_id)
|
|
||||||
|
|
||||||
|
|
||||||
def wait_connected(bot_id, want, timeout=15):
|
|
||||||
end = time.time() + timeout
|
|
||||||
while time.time() < end:
|
|
||||||
if get_bot(bot_id)["connected"] is want:
|
|
||||||
return True
|
|
||||||
time.sleep(0.15)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def test_resolve_play_stop_race(bot_id):
|
|
||||||
"""Fire stopBot during the /play call's URL resolve window."""
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
time.sleep(1)
|
|
||||||
api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
wait_connected(bot_id, True)
|
|
||||||
|
|
||||||
# Schedule a stop 150ms into the play call — that lands inside the
|
|
||||||
# provider.getSongUrl await, which is where the race lives.
|
|
||||||
def delayed_stop():
|
|
||||||
time.sleep(0.15)
|
|
||||||
try:
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
|
|
||||||
threading.Thread(target=delayed_stop, daemon=True).start()
|
|
||||||
|
|
||||||
try:
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
|
|
||||||
# Give both calls time to settle fully
|
|
||||||
time.sleep(3)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
# Key invariant: we never want connected=false AND playing=true. That
|
|
||||||
# pair is the exact Bug C symptom and would indicate the resolveAndPlay
|
|
||||||
# post-await check didn't fire.
|
|
||||||
assert not (b["connected"] is False and b["playing"] is True), (
|
|
||||||
f"inconsistent state after race: {b}"
|
|
||||||
)
|
|
||||||
print(
|
|
||||||
f"[PASS] resolveAndPlay stop-race — final state consistent "
|
|
||||||
f"(connected={b['connected']} playing={b['playing']})"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_seek_nan_rejected(bot_id):
|
|
||||||
"""Verify that NaN and Infinity seek positions are rejected at the API
|
|
||||||
layer (instead of poisoning seekOffset)."""
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
wait_connected(bot_id, True)
|
|
||||||
|
|
||||||
# Start a real song so there is an active playback to seek against
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
time.sleep(1.2)
|
|
||||||
|
|
||||||
# JSON spec doesn't allow NaN/Infinity literals, but Python's json
|
|
||||||
# encoder emits them as bare tokens when allow_nan=True (the default).
|
|
||||||
# Express's body-parser rejects them as invalid JSON, which itself is
|
|
||||||
# a form of rejection. We additionally verify that sending a string
|
|
||||||
# "NaN" or a negative value is also rejected with a clean 400.
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/seek",
|
|
||||||
method="POST",
|
|
||||||
json={"position": -5},
|
|
||||||
)
|
|
||||||
assert r.status_code == 400, f"negative seek should be rejected, got {r.status_code}"
|
|
||||||
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/seek",
|
|
||||||
method="POST",
|
|
||||||
json={"position": "fifty"},
|
|
||||||
)
|
|
||||||
assert r.status_code == 400, f"string seek should be rejected, got {r.status_code}"
|
|
||||||
|
|
||||||
# Directly send NaN in raw body (body-parser will likely 400 it)
|
|
||||||
r = requests.post(
|
|
||||||
f"{BASE}/api/player/{bot_id}/seek",
|
|
||||||
data='{"position": NaN}',
|
|
||||||
headers={"Content-Type": "application/json"},
|
|
||||||
timeout=10,
|
|
||||||
)
|
|
||||||
assert r.status_code >= 400, f"NaN seek should be rejected, got {r.status_code}"
|
|
||||||
|
|
||||||
# After the junk attempts, a valid seek still works and the elapsed
|
|
||||||
# time is a finite number (not NaN).
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/seek",
|
|
||||||
method="POST",
|
|
||||||
json={"position": 30},
|
|
||||||
)
|
|
||||||
assert r.status_code == 200, f"valid seek failed: {r.text[:120]}"
|
|
||||||
|
|
||||||
elapsed_resp = api(f"/api/player/{bot_id}/elapsed")
|
|
||||||
elapsed = elapsed_resp.json().get("elapsed")
|
|
||||||
assert elapsed is not None and isinstance(elapsed, (int, float)), (
|
|
||||||
f"elapsed should be a number, got {elapsed}"
|
|
||||||
)
|
|
||||||
# Could be exactly 30 or a tiny bit more if a frame has advanced
|
|
||||||
assert 29 <= elapsed < 40, f"elapsed after seek(30) out of range: {elapsed}"
|
|
||||||
print(f"[PASS] seek NaN/Infinity rejected; valid seek produces finite elapsed={elapsed:.2f}")
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
bots = api("/api/bot/").json()["bots"]
|
|
||||||
if not bots:
|
|
||||||
print("[skip] no bots")
|
|
||||||
return
|
|
||||||
bot_id = bots[0]["id"]
|
|
||||||
initial = bots[0]["connected"]
|
|
||||||
print(f"[init] bot={bot_id[:8]} initial connected={initial}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
test_resolve_play_stop_race(bot_id)
|
|
||||||
test_seek_nan_rejected(bot_id)
|
|
||||||
print("ALL GREEN")
|
|
||||||
finally:
|
|
||||||
if initial:
|
|
||||||
api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
wait_connected(bot_id, True)
|
|
||||||
else:
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
print(f"[restore] connected={get_bot(bot_id)['connected']}")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,212 +0,0 @@
|
|||||||
"""Stress-test two bots playing music concurrently on the same TS server.
|
|
||||||
|
|
||||||
Creates two temporary bots (or reuses existing named ones), starts them,
|
|
||||||
plays music on both, and polls /api/bot/ every 2 seconds to detect when
|
|
||||||
(if) either bot disconnects or stops playing. Cleans up on exit.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
python scripts/test_multibot.py --minutes 3
|
|
||||||
python scripts/test_multibot.py --minutes 10 --host 127.0.0.1 --port 9987
|
|
||||||
"""
|
|
||||||
import argparse
|
|
||||||
import sys
|
|
||||||
import time
|
|
||||||
from dataclasses import dataclass
|
|
||||||
|
|
||||||
import requests
|
|
||||||
|
|
||||||
API = "http://localhost:3000"
|
|
||||||
POLL_INTERVAL = 2.0
|
|
||||||
TEST_BOT_NAMES = ("mbtest1", "mbtest2")
|
|
||||||
TEST_BOT_NICKS = ("MBTest1", "MBTest2")
|
|
||||||
QUERIES = ("the mass", "lofi") # one different song per bot
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class BotSnapshot:
|
|
||||||
t: float
|
|
||||||
connected: bool
|
|
||||||
playing: bool
|
|
||||||
song: str | None
|
|
||||||
|
|
||||||
|
|
||||||
def api_get(path: str):
|
|
||||||
r = requests.get(f"{API}{path}", timeout=5)
|
|
||||||
r.raise_for_status()
|
|
||||||
return r.json()
|
|
||||||
|
|
||||||
|
|
||||||
def api_post(path: str, json=None):
|
|
||||||
r = requests.post(f"{API}{path}", json=json, timeout=15)
|
|
||||||
r.raise_for_status()
|
|
||||||
return r.json()
|
|
||||||
|
|
||||||
|
|
||||||
def api_delete(path: str):
|
|
||||||
r = requests.delete(f"{API}{path}", timeout=10)
|
|
||||||
r.raise_for_status()
|
|
||||||
return r.json()
|
|
||||||
|
|
||||||
|
|
||||||
def cleanup_existing(names: tuple[str, ...]) -> None:
|
|
||||||
bots = api_get("/api/bot/")["bots"]
|
|
||||||
for b in bots:
|
|
||||||
if b["name"] in names:
|
|
||||||
try:
|
|
||||||
api_post(f"/api/player/{b['id']}/stop")
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
try:
|
|
||||||
api_delete(f"/api/bot/{b['id']}")
|
|
||||||
print(f"[cleanup] removed existing bot {b['name']} ({b['id']})")
|
|
||||||
except Exception as e:
|
|
||||||
print(f"[cleanup] failed to remove {b['name']}: {e}")
|
|
||||||
|
|
||||||
|
|
||||||
def create_bot(name: str, nickname: str, host: str, port: int) -> str:
|
|
||||||
res = api_post(
|
|
||||||
"/api/bot/",
|
|
||||||
json={
|
|
||||||
"name": name,
|
|
||||||
"serverAddress": host,
|
|
||||||
"serverPort": port,
|
|
||||||
"nickname": nickname,
|
|
||||||
"autoStart": False,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
bot_id = res["id"]
|
|
||||||
print(f"[create] {name} -> {bot_id}")
|
|
||||||
return bot_id
|
|
||||||
|
|
||||||
|
|
||||||
def start_bot(bot_id: str) -> None:
|
|
||||||
api_post(f"/api/bot/{bot_id}/start")
|
|
||||||
|
|
||||||
|
|
||||||
def play(bot_id: str, query: str) -> None:
|
|
||||||
api_post(f"/api/player/{bot_id}/play", json={"query": query, "platform": "netease"})
|
|
||||||
|
|
||||||
|
|
||||||
def snapshot(bot_id: str, t0: float) -> BotSnapshot:
|
|
||||||
bots = api_get("/api/bot/")["bots"]
|
|
||||||
b = next((x for x in bots if x["id"] == bot_id), None)
|
|
||||||
if not b:
|
|
||||||
return BotSnapshot(time.time() - t0, False, False, None)
|
|
||||||
song = b["currentSong"]["name"] if b.get("currentSong") else None
|
|
||||||
return BotSnapshot(time.time() - t0, b["connected"], b["playing"], song)
|
|
||||||
|
|
||||||
|
|
||||||
def run(minutes: float, host: str, port: int) -> int:
|
|
||||||
print(f"[setup] duration={minutes}min host={host}:{port}")
|
|
||||||
|
|
||||||
cleanup_existing(TEST_BOT_NAMES)
|
|
||||||
|
|
||||||
bot_ids = [
|
|
||||||
create_bot(TEST_BOT_NAMES[0], TEST_BOT_NICKS[0], host, port),
|
|
||||||
create_bot(TEST_BOT_NAMES[1], TEST_BOT_NICKS[1], host, port),
|
|
||||||
]
|
|
||||||
|
|
||||||
# Start both, allowing a small stagger to avoid handshake collision
|
|
||||||
for i, bid in enumerate(bot_ids):
|
|
||||||
start_bot(bid)
|
|
||||||
print(f"[start] bot{i+1} started")
|
|
||||||
time.sleep(1.5)
|
|
||||||
|
|
||||||
# Wait until both are connected (or bail after 15s)
|
|
||||||
deadline = time.time() + 15
|
|
||||||
while time.time() < deadline:
|
|
||||||
bots = {b["id"]: b for b in api_get("/api/bot/")["bots"]}
|
|
||||||
if all(bots[b]["connected"] for b in bot_ids):
|
|
||||||
print("[start] both bots connected")
|
|
||||||
break
|
|
||||||
time.sleep(0.5)
|
|
||||||
else:
|
|
||||||
print("[fatal] bots did not both come online in 15s")
|
|
||||||
cleanup_existing(TEST_BOT_NAMES)
|
|
||||||
return 2
|
|
||||||
|
|
||||||
# Kick off playback on both
|
|
||||||
for i, bid in enumerate(bot_ids):
|
|
||||||
play(bid, QUERIES[i])
|
|
||||||
print(f"[play] bot{i+1} -> {QUERIES[i]!r}")
|
|
||||||
|
|
||||||
t0 = time.time()
|
|
||||||
end = t0 + minutes * 60
|
|
||||||
first_drop: dict[str, float] = {}
|
|
||||||
last_state: dict[str, BotSnapshot] = {}
|
|
||||||
|
|
||||||
print(f"[monitor] polling every {POLL_INTERVAL}s for {minutes} min...")
|
|
||||||
print(f"{'time':>7} {'bot1':<40} {'bot2':<40}")
|
|
||||||
|
|
||||||
def fmt(snap: BotSnapshot) -> str:
|
|
||||||
flag = ("C" if snap.connected else "-") + ("P" if snap.playing else "-")
|
|
||||||
song = (snap.song or "").replace("\n", " ")[:30]
|
|
||||||
return f"{flag} {song}"
|
|
||||||
|
|
||||||
try:
|
|
||||||
while time.time() < end:
|
|
||||||
snaps = [snapshot(bid, t0) for bid in bot_ids]
|
|
||||||
elapsed = int(time.time() - t0)
|
|
||||||
row = f"{elapsed:>6}s {fmt(snaps[0]):<40} {fmt(snaps[1]):<40}"
|
|
||||||
# Only print when state changes or every 10s
|
|
||||||
changed = False
|
|
||||||
for bid, s in zip(bot_ids, snaps):
|
|
||||||
prev = last_state.get(bid)
|
|
||||||
if (prev is None
|
|
||||||
or prev.connected != s.connected
|
|
||||||
or prev.playing != s.playing
|
|
||||||
or prev.song != s.song):
|
|
||||||
changed = True
|
|
||||||
last_state[bid] = s
|
|
||||||
if not s.connected and bid not in first_drop:
|
|
||||||
first_drop[bid] = s.t
|
|
||||||
if changed or elapsed % 10 == 0:
|
|
||||||
print(row)
|
|
||||||
|
|
||||||
# If both stopped playing but are still connected, re-queue the same song
|
|
||||||
for i, (bid, s) in enumerate(zip(bot_ids, snaps)):
|
|
||||||
if s.connected and not s.playing:
|
|
||||||
try:
|
|
||||||
play(bid, QUERIES[i])
|
|
||||||
except Exception as e:
|
|
||||||
print(f"[warn] re-play bot{i+1} failed: {e}")
|
|
||||||
|
|
||||||
time.sleep(POLL_INTERVAL)
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
print("\n[abort] interrupted")
|
|
||||||
|
|
||||||
# Summary
|
|
||||||
total = time.time() - t0
|
|
||||||
print()
|
|
||||||
print("=" * 60)
|
|
||||||
print(f"Total observed time: {total:.1f}s")
|
|
||||||
for i, bid in enumerate(bot_ids):
|
|
||||||
drop = first_drop.get(bid)
|
|
||||||
if drop is None:
|
|
||||||
print(f" bot{i+1} ({TEST_BOT_NICKS[i]}): stayed connected the whole run")
|
|
||||||
else:
|
|
||||||
print(f" bot{i+1} ({TEST_BOT_NICKS[i]}): FIRST DISCONNECT at t+{drop:.1f}s")
|
|
||||||
print("=" * 60)
|
|
||||||
|
|
||||||
# Cleanup
|
|
||||||
cleanup_existing(TEST_BOT_NAMES)
|
|
||||||
print("[cleanup] done")
|
|
||||||
|
|
||||||
return 0 if not first_drop else 1
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
p = argparse.ArgumentParser()
|
|
||||||
p.add_argument("--minutes", type=float, default=3.0)
|
|
||||||
p.add_argument("--host", default="127.0.0.1")
|
|
||||||
p.add_argument("--port", type=int, default=9987)
|
|
||||||
args = p.parse_args()
|
|
||||||
try:
|
|
||||||
return run(args.minutes, args.host, args.port)
|
|
||||||
except requests.HTTPError as e:
|
|
||||||
print(f"[http-error] {e} body={e.response.text[:200] if e.response else ''}")
|
|
||||||
return 3
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
// 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)" : "??"}`);
|
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
"""Reproduce / regression-check the player-bar-not-appearing bug.
|
|
||||||
|
|
||||||
Captures the bot's initial playback state and restores it on exit so the
|
|
||||||
test never leaves the user with surprise music or a cleared queue.
|
|
||||||
"""
|
|
||||||
import time
|
|
||||||
import requests
|
|
||||||
from playwright.sync_api import sync_playwright
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
|
|
||||||
|
|
||||||
def api(path, method="GET", **kw):
|
|
||||||
fn = getattr(requests, method.lower())
|
|
||||||
r = fn(f"{BASE}{path}", timeout=10, **kw)
|
|
||||||
r.raise_for_status()
|
|
||||||
return r.json() if r.text else None
|
|
||||||
|
|
||||||
|
|
||||||
def get_bot(bot_id):
|
|
||||||
return next(b for b in api("/api/bot/")["bots"] if b["id"] == bot_id)
|
|
||||||
|
|
||||||
|
|
||||||
def capture_state(bot_id):
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
return {
|
|
||||||
"playing": b["playing"],
|
|
||||||
"paused": b["paused"],
|
|
||||||
"song": (b["currentSong"] or {}).get("name"),
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
bots = api("/api/bot/")["bots"]
|
|
||||||
if not bots:
|
|
||||||
print("[skip] no bots")
|
|
||||||
return
|
|
||||||
bot_id = bots[0]["id"]
|
|
||||||
initial = capture_state(bot_id)
|
|
||||||
print(f"[init] initial state: {initial}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
# Clear slate
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
time.sleep(0.6)
|
|
||||||
|
|
||||||
with sync_playwright() as p:
|
|
||||||
browser = p.chromium.launch(headless=True)
|
|
||||||
try:
|
|
||||||
ctx = browser.new_context()
|
|
||||||
ctx.add_init_script(
|
|
||||||
"""
|
|
||||||
(() => {
|
|
||||||
const OrigWS = window.WebSocket;
|
|
||||||
window.__wsMessages = [];
|
|
||||||
window.WebSocket = function(...args) {
|
|
||||||
const ws = new OrigWS(...args);
|
|
||||||
ws.addEventListener('message', (ev) => {
|
|
||||||
try {
|
|
||||||
const d = JSON.parse(ev.data);
|
|
||||||
window.__wsMessages.push({type: d.type, botId: d.botId});
|
|
||||||
} catch(e) {}
|
|
||||||
});
|
|
||||||
return ws;
|
|
||||||
};
|
|
||||||
Object.assign(window.WebSocket, OrigWS);
|
|
||||||
})();
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
page = ctx.new_page()
|
|
||||||
page.goto(BASE)
|
|
||||||
page.wait_for_load_state("networkidle")
|
|
||||||
time.sleep(0.8)
|
|
||||||
|
|
||||||
assert page.locator(".player-wrapper").count() == 0, (
|
|
||||||
"player bar should be hidden before playback"
|
|
||||||
)
|
|
||||||
|
|
||||||
# Trigger play via API (simulates any play trigger)
|
|
||||||
api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
|
|
||||||
# Poll for up to 6s to see if player bar appears automatically
|
|
||||||
appeared_at = None
|
|
||||||
for i in range(60):
|
|
||||||
if page.locator(".player-wrapper").count() > 0:
|
|
||||||
appeared_at = i * 0.1
|
|
||||||
break
|
|
||||||
page.wait_for_timeout(100)
|
|
||||||
|
|
||||||
if appeared_at is None:
|
|
||||||
msgs = page.evaluate("() => window.__wsMessages")
|
|
||||||
print(f"[FAIL] player bar never appeared; WS msgs: {msgs}")
|
|
||||||
raise AssertionError("player bar did not auto-show on stateChange")
|
|
||||||
print(f"[PASS] player bar appeared after {appeared_at:.1f}s")
|
|
||||||
finally:
|
|
||||||
browser.close()
|
|
||||||
finally:
|
|
||||||
# Restore: stop the "test" song we triggered, then re-apply initial
|
|
||||||
# state as best we can. We can't re-queue the user's previous song,
|
|
||||||
# but we can at least stop ours and leave the bot idle if it was idle.
|
|
||||||
try:
|
|
||||||
api(f"/api/player/{bot_id}/stop", method="POST")
|
|
||||||
except Exception as e:
|
|
||||||
print(f"[warn] failed to stop test song on cleanup: {e}")
|
|
||||||
post = capture_state(bot_id)
|
|
||||||
print(f"[restore] bot now idle (was playing={initial['playing']} song={initial['song']!r})")
|
|
||||||
if initial["playing"] and initial["song"]:
|
|
||||||
print(
|
|
||||||
f"[note] initial bot was playing {initial['song']!r}; "
|
|
||||||
"this test cannot resume arbitrary tracks — you may need to restart playback"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
"""E2E: the new power button in the Bot Selector dropdown toggles bot connected state.
|
|
||||||
|
|
||||||
Captures the target bot's initial connected state and restores it on exit
|
|
||||||
(including on assertion failure), so running this test never pollutes the
|
|
||||||
user's current bot setup.
|
|
||||||
"""
|
|
||||||
import time
|
|
||||||
import requests
|
|
||||||
from playwright.sync_api import sync_playwright
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
|
|
||||||
|
|
||||||
def get_bot(bot_id):
|
|
||||||
return next(b for b in requests.get(f"{BASE}/api/bot/").json()["bots"] if b["id"] == bot_id)
|
|
||||||
|
|
||||||
|
|
||||||
def wait_for_connected(bot_id, want: bool, timeout_s: float = 12.0) -> bool:
|
|
||||||
deadline = time.time() + timeout_s
|
|
||||||
while time.time() < deadline:
|
|
||||||
if get_bot(bot_id)["connected"] is want:
|
|
||||||
return True
|
|
||||||
time.sleep(0.2)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def set_connected(bot_id, want: bool) -> None:
|
|
||||||
"""Force the bot into the given connected state via API."""
|
|
||||||
current = get_bot(bot_id)["connected"]
|
|
||||||
if current == want:
|
|
||||||
return
|
|
||||||
endpoint = "start" if want else "stop"
|
|
||||||
requests.post(f"{BASE}/api/bot/{bot_id}/{endpoint}")
|
|
||||||
wait_for_connected(bot_id, want)
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
bots = requests.get(f"{BASE}/api/bot/").json()["bots"]
|
|
||||||
if not bots:
|
|
||||||
print("[skip] no bots registered, nothing to test")
|
|
||||||
return
|
|
||||||
target = bots[0]
|
|
||||||
bot_id = target["id"]
|
|
||||||
initial_connected = target["connected"]
|
|
||||||
print(f"[init] target bot {target['name']} ({bot_id[:8]}), initial connected={initial_connected}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
# Force bot disconnected before the test
|
|
||||||
set_connected(bot_id, False)
|
|
||||||
assert not get_bot(bot_id)["connected"], "bot should be disconnected at start"
|
|
||||||
|
|
||||||
with sync_playwright() as p:
|
|
||||||
browser = p.chromium.launch(headless=True)
|
|
||||||
try:
|
|
||||||
page = browser.new_page(viewport={"width": 1440, "height": 900})
|
|
||||||
page.goto(BASE)
|
|
||||||
page.wait_for_load_state("networkidle")
|
|
||||||
time.sleep(0.6)
|
|
||||||
|
|
||||||
# Open dropdown
|
|
||||||
page.locator(".bot-selector-btn").click()
|
|
||||||
page.wait_for_selector(".bot-power-btn")
|
|
||||||
|
|
||||||
# Click the power button to start
|
|
||||||
page.locator(".bot-power-btn").first.click()
|
|
||||||
print("[ui] clicked power (start)")
|
|
||||||
|
|
||||||
assert wait_for_connected(bot_id, True), "bot should be connected after clicking start"
|
|
||||||
print("[api] bot connected = True")
|
|
||||||
|
|
||||||
# Let UI catch up via WS then re-open the dropdown to re-check class
|
|
||||||
time.sleep(1.0)
|
|
||||||
page.locator(".bot-selector-btn").click() # close
|
|
||||||
time.sleep(0.2)
|
|
||||||
page.locator(".bot-selector-btn").click() # reopen
|
|
||||||
page.wait_for_selector(".bot-power-btn.online", timeout=3000)
|
|
||||||
print("[ui] power button now shows .online class")
|
|
||||||
|
|
||||||
# Click again to stop
|
|
||||||
page.locator(".bot-power-btn.online").first.click()
|
|
||||||
print("[ui] clicked power (stop)")
|
|
||||||
|
|
||||||
assert wait_for_connected(bot_id, False), "bot should be disconnected after clicking stop"
|
|
||||||
print("[api] bot connected = False")
|
|
||||||
|
|
||||||
print("[PASS] power button toggles bot connection")
|
|
||||||
finally:
|
|
||||||
browser.close()
|
|
||||||
finally:
|
|
||||||
# Always restore the initial state so the test never leaves the bot
|
|
||||||
# in an unexpected place
|
|
||||||
set_connected(bot_id, initial_connected)
|
|
||||||
final = get_bot(bot_id)["connected"]
|
|
||||||
print(f"[restore] bot connected={final} (initial was {initial_connected})")
|
|
||||||
if final != initial_connected:
|
|
||||||
print("[warn] failed to restore initial connected state")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,130 +0,0 @@
|
|||||||
"""Regression for the 'connected=False but playing=True' stuck-state bug.
|
|
||||||
|
|
||||||
After rapid disconnect/reconnect, the library could drop the connection
|
|
||||||
(TS3 server anti-flood or a hung handshake). The bot then ended up in an
|
|
||||||
inconsistent state: player.state='playing' but tsClient disconnected.
|
|
||||||
|
|
||||||
This test verifies three fixes:
|
|
||||||
Bug A — startBot() has a 15s timeout instead of hanging forever on a
|
|
||||||
stalled handshake. /start returns a clean 500 instead of blocking.
|
|
||||||
Bug B — play/add/etc commands are rejected when the bot is not connected.
|
|
||||||
Bug C — the tsClient 'disconnected' handler always clears player state,
|
|
||||||
even when connect() never completed (so !this.connected).
|
|
||||||
|
|
||||||
We also sanity-check that the bot recovers (can start a fresh cycle) after
|
|
||||||
a transient failure.
|
|
||||||
"""
|
|
||||||
import time
|
|
||||||
import requests
|
|
||||||
|
|
||||||
BASE = "http://localhost:3000"
|
|
||||||
|
|
||||||
|
|
||||||
def api(path, method="GET", **kw):
|
|
||||||
return getattr(requests, method.lower())(f"{BASE}{path}", timeout=30, **kw)
|
|
||||||
|
|
||||||
|
|
||||||
def get_bot(bot_id):
|
|
||||||
return next(b for b in api("/api/bot/").json()["bots"] if b["id"] == bot_id)
|
|
||||||
|
|
||||||
|
|
||||||
def wait_connected(bot_id, want, timeout=15):
|
|
||||||
end = time.time() + timeout
|
|
||||||
while time.time() < end:
|
|
||||||
if get_bot(bot_id)["connected"] is want:
|
|
||||||
return True
|
|
||||||
time.sleep(0.15)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
bots = api("/api/bot/").json()["bots"]
|
|
||||||
if not bots:
|
|
||||||
print("[skip] no bots")
|
|
||||||
return
|
|
||||||
bot_id = bots[0]["id"]
|
|
||||||
initial_connected = bots[0]["connected"]
|
|
||||||
print(f"[init] bot={bot_id[:8]} initial connected={initial_connected}")
|
|
||||||
|
|
||||||
try:
|
|
||||||
# Start from a clean slate
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
|
|
||||||
# --- Bug B: play while disconnected must be rejected ---
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "rejection test", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert r.status_code >= 400, (
|
|
||||||
f"play while disconnected should fail, got {r.status_code} {r.text[:120]}"
|
|
||||||
)
|
|
||||||
assert "not connected" in r.text.lower(), (
|
|
||||||
f"expected 'not connected' error, got: {r.text[:200]}"
|
|
||||||
)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not b["playing"], f"player shouldn't be playing after rejected /play: {b}"
|
|
||||||
print("[PASS] Bug B — /play rejected while bot disconnected; state untouched")
|
|
||||||
|
|
||||||
# --- Bug C: normal start→play→stop leaves player state clean ---
|
|
||||||
r = api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
assert r.status_code == 200, f"start failed {r.text[:120]}"
|
|
||||||
assert wait_connected(bot_id, True), "bot did not connect within 15s"
|
|
||||||
|
|
||||||
r = api(
|
|
||||||
f"/api/player/{bot_id}/play",
|
|
||||||
method="POST",
|
|
||||||
json={"query": "the mass", "platform": "netease"},
|
|
||||||
)
|
|
||||||
assert r.status_code == 200, f"play failed {r.text[:120]}"
|
|
||||||
time.sleep(1.2)
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert b["connected"] and b["playing"], f"should be connected+playing: {b}"
|
|
||||||
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
assert wait_connected(bot_id, False, timeout=5), "bot did not disconnect"
|
|
||||||
b = get_bot(bot_id)
|
|
||||||
assert not b["playing"], (
|
|
||||||
f"player should have stopped after bot disconnect (Bug C): {b}"
|
|
||||||
)
|
|
||||||
print("[PASS] Bug C — stop clears both connected and playing state")
|
|
||||||
|
|
||||||
# --- Bug A: startBot has a deadline and returns a clean error if connect hangs ---
|
|
||||||
# We can't easily force a hang in-process, but we can sanity-check that
|
|
||||||
# startBot returns promptly (well under the 15s cap) on a normal run.
|
|
||||||
t0 = time.time()
|
|
||||||
r = api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
elapsed = time.time() - t0
|
|
||||||
assert r.status_code == 200, f"start failed {r.text[:120]}"
|
|
||||||
assert elapsed < 10, f"start should be prompt, took {elapsed:.1f}s"
|
|
||||||
assert wait_connected(bot_id, True), "bot did not connect"
|
|
||||||
print(
|
|
||||||
f"[PASS] Bug A — startBot completed in {elapsed:.2f}s "
|
|
||||||
"(deadline is 15s, would throw on hang)"
|
|
||||||
)
|
|
||||||
|
|
||||||
# --- Recovery: after any failure, another start should work ---
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
# Give TS3 server a moment to forget us (anti-flood grace)
|
|
||||||
time.sleep(2)
|
|
||||||
r = api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
assert r.status_code == 200, f"recovery start failed {r.text[:120]}"
|
|
||||||
assert wait_connected(bot_id, True), "bot did not recover"
|
|
||||||
print("[PASS] recovery — bot reconnects cleanly after a cycle")
|
|
||||||
|
|
||||||
print("ALL GREEN")
|
|
||||||
|
|
||||||
finally:
|
|
||||||
if initial_connected:
|
|
||||||
api(f"/api/bot/{bot_id}/start", method="POST")
|
|
||||||
wait_connected(bot_id, True)
|
|
||||||
else:
|
|
||||||
api(f"/api/bot/{bot_id}/stop", method="POST")
|
|
||||||
wait_connected(bot_id, False)
|
|
||||||
print(f"[restore] bot connected={get_bot(bot_id)['connected']} (was {initial_connected})")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,135 +0,0 @@
|
|||||||
import { describe, it, expect } from "vitest";
|
|
||||||
import { mkdtempSync, writeFileSync, existsSync } from "node:fs";
|
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import { buildFfmpegArgs, shouldUsePowerShellDownload, cleanupTempDir } from "./player.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("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_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("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();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+150
-369
@@ -1,18 +1,15 @@
|
|||||||
import { spawn, execSync, type ChildProcess } from "node:child_process";
|
import { spawn, execSync, type ChildProcess } from "node:child_process";
|
||||||
import { EventEmitter } from "node:events";
|
import { EventEmitter } from "node:events";
|
||||||
import { createRequire } from "node:module";
|
import { createRequire } from "node:module";
|
||||||
import { accessSync, chmodSync, constants, mkdtempSync, rmSync } from "node:fs";
|
import { accessSync, chmodSync, constants } from "node:fs";
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import { createOpusEncoder, PCM_FRAME_BYTES, type Encoder } from "./encoder.js";
|
import { createOpusEncoder, PCM_FRAME_BYTES, type Encoder } from "./encoder.js";
|
||||||
import type { Logger } from "../logger.js";
|
import type { Logger } from "../logger.js";
|
||||||
|
|
||||||
|
// ffmpeg-static is a CJS module that exports the path to the bundled ffmpeg binary.
|
||||||
const require = createRequire(import.meta.url);
|
const require = createRequire(import.meta.url);
|
||||||
const ffmpegPath: string | null = require("ffmpeg-static");
|
const ffmpegPath: string | null = require("ffmpeg-static");
|
||||||
|
|
||||||
/** 全局 PID 追踪器，防止进程在类实例切换时沦为孤儿进程 （ */
|
/** Ensure the given binary has execute permission. */
|
||||||
const globalActivePids = new Set<number>();
|
|
||||||
|
|
||||||
function isExecutable(binPath: string): boolean {
|
function isExecutable(binPath: string): boolean {
|
||||||
try {
|
try {
|
||||||
accessSync(binPath, constants.X_OK);
|
accessSync(binPath, constants.X_OK);
|
||||||
@@ -28,6 +25,7 @@ function isExecutable(binPath: string): boolean {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Test if an ffmpeg binary actually works by running -version. */
|
||||||
function ffmpegWorks(bin: string): boolean {
|
function ffmpegWorks(bin: string): boolean {
|
||||||
try {
|
try {
|
||||||
execSync(`"${bin}" -version`, { timeout: 5000, stdio: "pipe" });
|
execSync(`"${bin}" -version`, { timeout: 5000, stdio: "pipe" });
|
||||||
@@ -37,72 +35,24 @@ function ffmpegWorks(bin: string): boolean {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Resolved once at module load — prefer bundled ffmpeg-static, fall back to system. */
|
||||||
const resolvedFfmpeg: string = (() => {
|
const resolvedFfmpeg: string = (() => {
|
||||||
if (ffmpegWorks("ffmpeg")) return "ffmpeg";
|
if (ffmpegPath && isExecutable(ffmpegPath) && ffmpegWorks(ffmpegPath)) {
|
||||||
const isWinPath = ffmpegPath ? /\\/.test(ffmpegPath) || ffmpegPath.endsWith(".exe") : false;
|
return ffmpegPath;
|
||||||
const onWindows = process.platform === "win32";
|
|
||||||
if (ffmpegPath && (onWindows === isWinPath)) {
|
|
||||||
if (isExecutable(ffmpegPath) && ffmpegWorks(ffmpegPath)) return ffmpegPath;
|
|
||||||
}
|
}
|
||||||
return "ffmpeg";
|
// Fall back to system ffmpeg
|
||||||
|
if (ffmpegWorks("ffmpeg")) {
|
||||||
|
return "ffmpeg";
|
||||||
|
}
|
||||||
|
// Last resort: return whatever we have, will fail at runtime with clear error
|
||||||
|
return ffmpegPath ?? "ffmpeg";
|
||||||
})();
|
})();
|
||||||
|
|
||||||
|
/** Resolve ffmpeg binary: prefer bundled ffmpeg-static, fall back to system PATH. */
|
||||||
function getFfmpegCommand(): string {
|
function getFfmpegCommand(): string {
|
||||||
return resolvedFfmpeg;
|
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",
|
|
||||||
"-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;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface PlayerEvents {
|
export interface PlayerEvents {
|
||||||
frame: (opusFrame: Buffer) => void;
|
frame: (opusFrame: Buffer) => void;
|
||||||
trackEnd: () => void;
|
trackEnd: () => void;
|
||||||
@@ -124,21 +74,11 @@ export class AudioPlayer extends EventEmitter {
|
|||||||
private nextFrameTime = 0;
|
private nextFrameTime = 0;
|
||||||
private currentUrl = "";
|
private currentUrl = "";
|
||||||
private seekOffset = 0;
|
private seekOffset = 0;
|
||||||
private framesPlayed = 0;
|
private framesPlayed = 0; // ground truth: number of 20ms frames sent
|
||||||
private sessionId = 0;
|
private sessionId = 0;
|
||||||
private static readonly BUFFER_HIGH_WATER = 640 * 1024;
|
private static readonly BUFFER_HIGH_WATER = 960 * 1024; // ~5s of PCM at 48kHz stereo
|
||||||
private static readonly BUFFER_LOW_WATER = 256 * 1024;
|
private static readonly BUFFER_LOW_WATER = 480 * 1024; // ~2.5s
|
||||||
private ffmpegPaused = false;
|
private ffmpegPaused = false;
|
||||||
private spawnFailed = false;
|
|
||||||
private consecutiveFailures = 0;
|
|
||||||
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帧循环（增加容错）
|
|
||||||
private currentSongDuration = 0; // 当前歌曲总时长（秒）
|
|
||||||
|
|
||||||
constructor(logger: Logger) {
|
constructor(logger: Logger) {
|
||||||
super();
|
super();
|
||||||
@@ -146,263 +86,89 @@ export class AudioPlayer extends EventEmitter {
|
|||||||
this.logger = logger;
|
this.logger = logger;
|
||||||
}
|
}
|
||||||
|
|
||||||
play(url: string, seekSeconds = 0, songDuration = 0): void {
|
play(url: string, seekSeconds = 0): void {
|
||||||
// 1. 停止当前所有播放，自增 sessionId 屏蔽旧回调 （
|
|
||||||
this.stop();
|
this.stop();
|
||||||
|
this.sessionId++;
|
||||||
const currentSessionId = this.sessionId;
|
const playSessionId = this.sessionId;
|
||||||
this.currentUrl = url;
|
this.currentUrl = url;
|
||||||
this.seekOffset = seekSeconds;
|
this.seekOffset = seekSeconds;
|
||||||
this.framesPlayed = 0;
|
this.framesPlayed = 0;
|
||||||
this.healthyFrames = 0;
|
|
||||||
this.ffmpegPaused = false;
|
this.ffmpegPaused = false;
|
||||||
this.spawnFailed = false;
|
|
||||||
this.emptyFrameAttempts = 0;
|
|
||||||
this.currentSongDuration = songDuration;
|
|
||||||
|
|
||||||
if (this.consecutiveFailures >= AudioPlayer.MAX_CONSECUTIVE_FAILURES) {
|
this.logger.info({ url: url.slice(0, 80), seek: seekSeconds }, "Starting playback");
|
||||||
this.logger.error({ failures: this.consecutiveFailures }, "FFmpeg failures limit reached");
|
|
||||||
this.state = "idle";
|
const args: string[] = [];
|
||||||
this.emit("error", new Error("ffmpeg unavailable"));
|
|
||||||
return;
|
// BiliBili CDN requires Referer header for audio playback
|
||||||
|
if (url.includes("bilivideo") || url.includes("bilibili")) {
|
||||||
|
args.push(
|
||||||
|
"-headers",
|
||||||
|
"Referer: https://www.bilibili.com\r\nUser-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36\r\n"
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (shouldUsePowerShellDownload(url)) {
|
args.push(
|
||||||
this.playViaPowerShellDownload(url, seekSeconds, currentSessionId);
|
"-reconnect", "1",
|
||||||
return;
|
"-reconnect_streamed", "1",
|
||||||
}
|
"-reconnect_delay_max", "5",
|
||||||
|
|
||||||
const args = buildFfmpegArgs(url, 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: currentSessionId }, "FFmpeg spawned");
|
|
||||||
}
|
|
||||||
|
|
||||||
this.ffmpeg.stdout!.on("data", (chunk: Buffer) => {
|
|
||||||
// 2. 严格校验 sessionId，防止老进程的数据混入新播放请求 （
|
|
||||||
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();
|
|
||||||
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 === currentSessionId) {
|
|
||||||
this.ffmpeg = null;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
this.ffmpeg.on("error", (err) => {
|
|
||||||
if (this.sessionId === currentSessionId) {
|
|
||||||
this.spawnFailed = true;
|
|
||||||
this.consecutiveFailures++;
|
|
||||||
this.emit("error", err);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
this.state = "playing";
|
|
||||||
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;
|
if (seekSeconds > 0) {
|
||||||
|
args.push("-ss", String(seekSeconds));
|
||||||
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;
|
|
||||||
}
|
}
|
||||||
|
args.push(
|
||||||
|
"-i", url,
|
||||||
|
"-f", "s16le",
|
||||||
|
"-ar", "48000",
|
||||||
|
"-ac", "2",
|
||||||
|
"-acodec", "pcm_s16le",
|
||||||
|
"-",
|
||||||
|
);
|
||||||
|
|
||||||
const args = buildFfmpegArgs(tempFile, seekSeconds);
|
|
||||||
const ffmpegBin = getFfmpegCommand();
|
const ffmpegBin = getFfmpegCommand();
|
||||||
|
this.logger.info({ ffmpeg: ffmpegBin }, "Using ffmpeg binary");
|
||||||
this.ffmpeg = spawn(ffmpegBin, args, { stdio: ["ignore", "pipe", "pipe"] });
|
this.ffmpeg = spawn(ffmpegBin, args, { stdio: ["ignore", "pipe", "pipe"] });
|
||||||
|
|
||||||
const currentPid = this.ffmpeg.pid;
|
let gotFirstData = false;
|
||||||
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) => {
|
this.ffmpeg.stdout!.on("data", (chunk: Buffer) => {
|
||||||
if (this.sessionId !== sessionId) return;
|
if (!gotFirstData) {
|
||||||
|
gotFirstData = true;
|
||||||
|
this.logger.info({ bytes: chunk.length }, "FFmpeg: first PCM data received");
|
||||||
|
}
|
||||||
this.pcmBuffer = Buffer.concat([this.pcmBuffer, chunk]);
|
this.pcmBuffer = Buffer.concat([this.pcmBuffer, chunk]);
|
||||||
|
// Backpressure: pause FFmpeg stdout when buffer is too large
|
||||||
if (this.pcmBuffer.length > AudioPlayer.BUFFER_HIGH_WATER && !this.ffmpegPaused && this.ffmpeg?.stdout) {
|
if (this.pcmBuffer.length > AudioPlayer.BUFFER_HIGH_WATER && !this.ffmpegPaused && this.ffmpeg?.stdout) {
|
||||||
this.ffmpeg.stdout.pause();
|
this.ffmpeg.stdout.pause();
|
||||||
this.ffmpegPaused = true;
|
this.ffmpegPaused = true;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
this.ffmpeg.on("exit", (code, signal) => {
|
this.ffmpeg.on("close", (code, signal) => {
|
||||||
if (currentPid) globalActivePids.delete(currentPid);
|
this.logger.info({ exitCode: code, signal, gotData: gotFirstData, framesPlayed: this.framesPlayed }, "FFmpeg process closed");
|
||||||
this.logger.info({ pid: currentPid, code, signal }, "FFmpeg exited");
|
if (this.sessionId === playSessionId) {
|
||||||
if (this.sessionId === sessionId) {
|
this.ffmpeg = null; // Signal frame loop that no more data is coming
|
||||||
this.ffmpeg = null;
|
|
||||||
if (this.currentTempDir === tempDirToCleanup) this.currentTempDir = null;
|
|
||||||
}
|
}
|
||||||
if (tempDirToCleanup) cleanupTempDir(tempDirToCleanup);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
this.ffmpeg.on("error", (err) => {
|
this.ffmpeg.on("error", (err) => {
|
||||||
if (this.sessionId === sessionId) {
|
this.logger.error({ err }, "FFmpeg error");
|
||||||
this.spawnFailed = true;
|
if (this.sessionId === playSessionId) {
|
||||||
this.consecutiveFailures++;
|
|
||||||
this.emit("error", err);
|
this.emit("error", err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Now that ffmpeg is producing PCM, run the frame loop.
|
// Log FFmpeg stderr at info level for debugging playback issues
|
||||||
this.startFrameLoop();
|
this.ffmpeg.stderr!.on("data", (data: Buffer) => {
|
||||||
}
|
const msg = data.toString().trimEnd();
|
||||||
|
// Log important FFmpeg messages at info level
|
||||||
stop(): void {
|
if (msg.includes("Error") || msg.includes("error") || msg.includes("HTTP") || msg.includes("Opening") || msg.includes("Stream")) {
|
||||||
// 3. 递增 ID 是最有效的逻辑“隔离墙”
|
this.logger.info({ ffmpegStderr: msg }, "FFmpeg stderr");
|
||||||
this.sessionId++;
|
} else {
|
||||||
this.frameLoopRunning = false;
|
this.logger.debug({ stderr: msg }, "FFmpeg stderr");
|
||||||
|
|
||||||
// 立即清空缓冲区，确保切歌瞬间静音 （
|
|
||||||
this.pcmBuffer = Buffer.alloc(0);
|
|
||||||
|
|
||||||
if (this.ffmpeg) {
|
|
||||||
const procToKill = this.ffmpeg;
|
|
||||||
const pidToKill = procToKill.pid;
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.ffmpegPaused = false;
|
|
||||||
this.spawnFailed = false;
|
|
||||||
this.state = "idle";
|
|
||||||
this.currentUrl = "";
|
|
||||||
this.seekOffset = 0;
|
|
||||||
this.framesPlayed = 0;
|
|
||||||
this.healthyFrames = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
private forceCleanup(proc: ChildProcess, pid: number): void {
|
|
||||||
if (!globalActivePids.has(pid)) return;
|
|
||||||
|
|
||||||
try {
|
|
||||||
proc.kill("SIGTERM");
|
|
||||||
} catch (e) { /* ignore */ }
|
|
||||||
|
|
||||||
const killTimeout = setTimeout(() => {
|
|
||||||
try {
|
|
||||||
process.kill(pid, 0);
|
|
||||||
process.kill(pid, "SIGKILL");
|
|
||||||
} catch (e) {
|
|
||||||
} finally {
|
|
||||||
globalActivePids.delete(pid);
|
|
||||||
}
|
|
||||||
}, 1500);
|
|
||||||
|
|
||||||
proc.unref();
|
|
||||||
proc.once("exit", () => {
|
|
||||||
clearTimeout(killTimeout);
|
|
||||||
globalActivePids.delete(pid);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
|
this.state = "playing";
|
||||||
|
this.startFrameLoop();
|
||||||
}
|
}
|
||||||
|
|
||||||
private startFrameLoop(): void {
|
private startFrameLoop(): void {
|
||||||
@@ -414,80 +180,44 @@ export class AudioPlayer extends EventEmitter {
|
|||||||
|
|
||||||
private scheduleNextFrame(): void {
|
private scheduleNextFrame(): void {
|
||||||
if (!this.frameLoopRunning) return;
|
if (!this.frameLoopRunning) return;
|
||||||
|
|
||||||
const loopSessionId = this.sessionId;
|
const loopSessionId = this.sessionId;
|
||||||
|
|
||||||
this.nextFrameTime += FRAME_DURATION_MS;
|
this.nextFrameTime += FRAME_DURATION_MS;
|
||||||
const delay = Math.max(0, this.nextFrameTime - performance.now());
|
const now = performance.now();
|
||||||
|
const delay = Math.max(0, this.nextFrameTime - now);
|
||||||
|
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
// 这里的校验能防止旧的定时器回调处理新 Session 的逻辑 （
|
// Discard callback from a stale play session
|
||||||
if (loopSessionId !== this.sessionId || !this.frameLoopRunning) return;
|
if (loopSessionId !== this.sessionId) return;
|
||||||
|
if (!this.frameLoopRunning) return;
|
||||||
|
|
||||||
if (this.state === "playing") this.sendNextFrame();
|
if (this.state === "playing") {
|
||||||
else if (this.state === "paused") this.nextFrameTime = performance.now();
|
this.sendNextFrame();
|
||||||
|
} else if (this.state === "paused") {
|
||||||
// 检测pcmBuffer不足PCM_FRAME_BYTES导致连续循环卡死：
|
this.nextFrameTime = performance.now();
|
||||||
// 条件1: FFmpeg仍在运行但缓冲区不足一帧，且连续多次无法获取数据
|
|
||||||
// 条件2: 已播放时间接近歌曲结尾（最后5秒内）或未知时长
|
|
||||||
const elapsed = this.getElapsed();
|
|
||||||
const isNearEnd = this.currentSongDuration > 0
|
|
||||||
? (this.currentSongDuration - elapsed) <= 5 // 距离结尾不足5秒
|
|
||||||
: true; // 未知时长时保守处理
|
|
||||||
|
|
||||||
if (this.ffmpeg !== null && this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
|
||||||
this.emptyFrameAttempts++;
|
|
||||||
|
|
||||||
// 只有同时满足：达到空帧阈值 + 接近结尾，才判定为播放结束
|
|
||||||
if (this.emptyFrameAttempts >= AudioPlayer.MAX_EMPTY_ATTEMPTS && isNearEnd) {
|
|
||||||
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)
|
|
||||||
}, "FFmpeg stopped outputting data near end, ending track");
|
|
||||||
this.frameLoopRunning = false;
|
|
||||||
if (this.state !== "idle") {
|
|
||||||
this.state = "idle";
|
|
||||||
// 清理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;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!this.ffmpeg && this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
if (!this.ffmpeg && this.pcmBuffer.length < PCM_FRAME_BYTES) {
|
||||||
this.frameLoopRunning = false;
|
this.frameLoopRunning = false;
|
||||||
if (this.state !== "idle") {
|
if (this.state !== "idle") {
|
||||||
this.state = "idle";
|
this.state = "idle";
|
||||||
if (!this.spawnFailed) {
|
this.emit("trackEnd");
|
||||||
this.consecutiveFailures = 0;
|
|
||||||
this.emit("trackEnd");
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
this.scheduleNextFrame();
|
this.scheduleNextFrame();
|
||||||
}, delay);
|
}, delay);
|
||||||
}
|
}
|
||||||
|
|
||||||
private sendNextFrame(): void {
|
private sendNextFrame(): void {
|
||||||
if (this.pcmBuffer.length < PCM_FRAME_BYTES) return;
|
if (this.pcmBuffer.length < PCM_FRAME_BYTES) return;
|
||||||
|
|
||||||
const pcmFrame = this.pcmBuffer.subarray(0, PCM_FRAME_BYTES);
|
const pcmFrame = this.pcmBuffer.subarray(0, PCM_FRAME_BYTES);
|
||||||
this.pcmBuffer = this.pcmBuffer.subarray(PCM_FRAME_BYTES);
|
this.pcmBuffer = this.pcmBuffer.subarray(PCM_FRAME_BYTES);
|
||||||
|
|
||||||
|
// Backpressure: resume FFmpeg stdout when buffer drains below low-water mark
|
||||||
if (this.ffmpegPaused && this.pcmBuffer.length < AudioPlayer.BUFFER_LOW_WATER && this.ffmpeg?.stdout) {
|
if (this.ffmpegPaused && this.pcmBuffer.length < AudioPlayer.BUFFER_LOW_WATER && this.ffmpeg?.stdout) {
|
||||||
this.ffmpeg.stdout.resume();
|
this.ffmpeg.stdout.resume();
|
||||||
this.ffmpegPaused = false;
|
this.ffmpegPaused = false;
|
||||||
@@ -498,37 +228,88 @@ export class AudioPlayer extends EventEmitter {
|
|||||||
const opusFrame = this.encoder.encode(adjusted);
|
const opusFrame = this.encoder.encode(adjusted);
|
||||||
this.emit("frame", opusFrame);
|
this.emit("frame", opusFrame);
|
||||||
this.framesPlayed++;
|
this.framesPlayed++;
|
||||||
this.healthyFrames++;
|
|
||||||
if (this.healthyFrames >= AudioPlayer.HEALTHY_FRAME_RESET) {
|
if (this.framesPlayed === 1) {
|
||||||
this.consecutiveFailures = 0;
|
this.logger.info({ opusBytes: opusFrame.length }, "First audio frame encoded and emitted");
|
||||||
this.healthyFrames = 0;
|
}
|
||||||
|
// Log every ~10 seconds (500 frames * 20ms = 10s)
|
||||||
|
if (this.framesPlayed % 500 === 0) {
|
||||||
|
this.logger.debug({ framesPlayed: this.framesPlayed, elapsed: this.getElapsed() }, "Playback progress");
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
this.logger.error({ err }, "Error encoding/sending audio frame");
|
||||||
this.emit("error", err as Error);
|
this.emit("error", err as Error);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private applyVolume(pcm: Buffer): Buffer {
|
private applyVolume(pcm: Buffer): Buffer {
|
||||||
if (this.volume === 100) return Buffer.from(pcm);
|
if (this.volume === 100) return Buffer.from(pcm);
|
||||||
const factor = (this.volume / 100) * 0.2;
|
const factor = this.volume / 100;
|
||||||
const out = Buffer.alloc(pcm.length);
|
const out = Buffer.alloc(pcm.length);
|
||||||
for (let i = 0; i < pcm.length; i += 2) {
|
for (let i = 0; i < pcm.length; i += 2) {
|
||||||
let sample = Math.round(pcm.readInt16LE(i) * factor);
|
let sample = pcm.readInt16LE(i);
|
||||||
out.writeInt16LE(Math.max(-32768, Math.min(32767, sample)), i);
|
sample = Math.round(sample * factor);
|
||||||
|
if (sample > 32767) sample = 32767;
|
||||||
|
else if (sample < -32768) sample = -32768;
|
||||||
|
out.writeInt16LE(sample, i);
|
||||||
}
|
}
|
||||||
return out;
|
return out;
|
||||||
}
|
}
|
||||||
|
|
||||||
getElapsed(): number { return this.seekOffset + (this.framesPlayed * FRAME_DURATION_MS) / 1000; }
|
/** Actual elapsed time in seconds (ground truth from frame count) */
|
||||||
|
getElapsed(): number {
|
||||||
|
return this.seekOffset + (this.framesPlayed * FRAME_DURATION_MS) / 1000;
|
||||||
|
}
|
||||||
|
|
||||||
seek(seconds: number): void {
|
seek(seconds: number): void {
|
||||||
if (this.currentUrl && Number.isFinite(seconds) && seconds >= 0) {
|
if (!this.currentUrl) return;
|
||||||
this.play(this.currentUrl, seconds, this.currentSongDuration);
|
this.logger.info({ seek: seconds }, "Seeking");
|
||||||
|
this.play(this.currentUrl, seconds);
|
||||||
|
}
|
||||||
|
|
||||||
|
getSeekOffset(): number {
|
||||||
|
return this.seekOffset;
|
||||||
|
}
|
||||||
|
|
||||||
|
pause(): void {
|
||||||
|
if (this.state === "playing") {
|
||||||
|
this.state = "paused";
|
||||||
|
this.logger.debug("Playback paused");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
pause(): void { if (this.state === "playing") this.state = "paused"; }
|
|
||||||
resume(): void { if (this.state === "paused") { this.state = "playing"; this.nextFrameTime = performance.now(); } }
|
resume(): void {
|
||||||
resetFailures(): void { this.consecutiveFailures = 0; }
|
if (this.state === "paused") {
|
||||||
setVolume(vol: number): void { this.volume = Math.max(0, Math.min(100, vol)); }
|
this.state = "playing";
|
||||||
getVolume(): number { return this.volume; }
|
this.nextFrameTime = performance.now();
|
||||||
getState(): PlayerState { return this.state; }
|
this.logger.debug("Playback resumed");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
stop(): void {
|
||||||
|
this.sessionId++;
|
||||||
|
this.frameLoopRunning = false;
|
||||||
|
if (this.ffmpeg) {
|
||||||
|
this.ffmpeg.kill("SIGTERM");
|
||||||
|
this.ffmpeg = null;
|
||||||
|
}
|
||||||
|
this.pcmBuffer = Buffer.alloc(0);
|
||||||
|
this.ffmpegPaused = false;
|
||||||
|
this.state = "idle";
|
||||||
|
this.currentUrl = "";
|
||||||
|
this.seekOffset = 0;
|
||||||
|
this.framesPlayed = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
setVolume(vol: number): void {
|
||||||
|
this.volume = Math.max(0, Math.min(100, vol));
|
||||||
|
}
|
||||||
|
|
||||||
|
getVolume(): number {
|
||||||
|
return this.volume;
|
||||||
|
}
|
||||||
|
|
||||||
|
getState(): PlayerState {
|
||||||
|
return this.state;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -89,49 +89,6 @@ describe("PlayQueue", () => {
|
|||||||
expect(queue.list()[1].id).toBe("3");
|
expect(queue.list()[1].id).toBe("3");
|
||||||
});
|
});
|
||||||
|
|
||||||
it("removing a song before current shifts current index", () => {
|
|
||||||
queue.setMode(PlayMode.Sequential);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.add(makeSong("C"));
|
|
||||||
queue.playAt(2); // playing C at index 2
|
|
||||||
queue.remove(0); // remove A (before current)
|
|
||||||
expect(queue.current()?.id).toBe("C"); // still on C
|
|
||||||
expect(queue.getCurrentIndex()).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removing the currently-playing song lets next() advance to the shifted song", () => {
|
|
||||||
queue.setMode(PlayMode.Sequential);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.add(makeSong("C"));
|
|
||||||
queue.add(makeSong("D"));
|
|
||||||
queue.playAt(2); // playing C
|
|
||||||
queue.remove(2); // remove C — D shifts into slot 2
|
|
||||||
// Before the fix this returned null (D was silently skipped)
|
|
||||||
expect(queue.next()?.id).toBe("D");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removing the only song clears the queue", () => {
|
|
||||||
queue.add(makeSong("only"));
|
|
||||||
queue.playAt(0);
|
|
||||||
queue.remove(0);
|
|
||||||
expect(queue.size()).toBe(0);
|
|
||||||
expect(queue.current()).toBeNull();
|
|
||||||
expect(queue.next()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removing the last song while playing it advances to null in sequential mode", () => {
|
|
||||||
queue.setMode(PlayMode.Sequential);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.playAt(1); // playing B (last)
|
|
||||||
queue.remove(1);
|
|
||||||
expect(queue.size()).toBe(1);
|
|
||||||
// currentIndex moved to 0, so next() should try to advance past the end
|
|
||||||
expect(queue.next()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("clears all songs", () => {
|
it("clears all songs", () => {
|
||||||
queue.add(makeSong("1"));
|
queue.add(makeSong("1"));
|
||||||
queue.add(makeSong("2"));
|
queue.add(makeSong("2"));
|
||||||
@@ -150,101 +107,6 @@ describe("PlayQueue", () => {
|
|||||||
expect(next).not.toBeNull();
|
expect(next).not.toBeNull();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("random mode with single song returns null on next", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("1"));
|
|
||||||
queue.play();
|
|
||||||
expect(queue.next()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("random mode plays each song exactly once then stops", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.add(makeSong("C"));
|
|
||||||
queue.play();
|
|
||||||
const played = new Set<string>();
|
|
||||||
played.add(queue.current()!.id);
|
|
||||||
for (let i = 0; i < 3; i++) {
|
|
||||||
const song = queue.next();
|
|
||||||
if (!song) break;
|
|
||||||
played.add(song.id);
|
|
||||||
}
|
|
||||||
// All 3 songs should have been played
|
|
||||||
expect(played).toEqual(new Set(["A", "B", "C"]));
|
|
||||||
// next() after all played should return null
|
|
||||||
expect(queue.next()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("random mode: removing currently-playing song does not skip others", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.add(makeSong("C"));
|
|
||||||
queue.add(makeSong("D"));
|
|
||||||
queue.play(); // plays A (index 0)
|
|
||||||
const second = queue.next()!; // plays some song
|
|
||||||
// Remove the currently-playing song
|
|
||||||
const curIdx = queue.getCurrentIndex();
|
|
||||||
queue.remove(curIdx);
|
|
||||||
// Remaining songs (excluding A and the removed song) should all be reachable
|
|
||||||
const played = new Set<string>();
|
|
||||||
played.add("A"); // already played via play()
|
|
||||||
played.add(second.id); // played and then removed
|
|
||||||
let song = queue.next();
|
|
||||||
while (song) {
|
|
||||||
played.add(song.id);
|
|
||||||
song = queue.next();
|
|
||||||
}
|
|
||||||
// All 4 original songs should have been played or accounted for
|
|
||||||
expect(played).toEqual(new Set(["A", "B", "C", "D"]));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("random mode: prev does not cause duplicate plays", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.add(makeSong("C"));
|
|
||||||
queue.play(); // plays A
|
|
||||||
queue.next(); // plays B or C
|
|
||||||
queue.prev(); // go back — this song is now marked as played
|
|
||||||
// Exhaust remaining songs
|
|
||||||
const ids: string[] = [];
|
|
||||||
let song = queue.next();
|
|
||||||
while (song) {
|
|
||||||
ids.push(song.id);
|
|
||||||
song = queue.next();
|
|
||||||
}
|
|
||||||
// No song ID should appear more than once across the entire session
|
|
||||||
expect(new Set(ids).size).toBe(ids.length);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("random mode: adding song mid-playback includes the new song", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.play(); // plays A
|
|
||||||
queue.next(); // plays B
|
|
||||||
// Add a new song while all existing songs have been played
|
|
||||||
queue.add(makeSong("C"));
|
|
||||||
const song = queue.next();
|
|
||||||
expect(song).not.toBeNull();
|
|
||||||
expect(song!.id).toBe("C");
|
|
||||||
// After C, should stop
|
|
||||||
expect(queue.next()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("random mode: setMode preserves current song as played", () => {
|
|
||||||
queue.add(makeSong("A"));
|
|
||||||
queue.add(makeSong("B"));
|
|
||||||
queue.play(); // plays A in sequential mode
|
|
||||||
queue.setMode(PlayMode.Random); // switch to random — A should be marked played
|
|
||||||
// next() should only return B, never A again
|
|
||||||
const song = queue.next();
|
|
||||||
expect(song?.id).toBe("B");
|
|
||||||
expect(queue.next()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("random-loop mode never returns null", () => {
|
it("random-loop mode never returns null", () => {
|
||||||
queue.setMode(PlayMode.RandomLoop);
|
queue.setMode(PlayMode.RandomLoop);
|
||||||
queue.add(makeSong("1"));
|
queue.add(makeSong("1"));
|
||||||
@@ -261,227 +123,4 @@ describe("PlayQueue", () => {
|
|||||||
queue.playAt(2);
|
queue.playAt(2);
|
||||||
expect(queue.current()?.id).toBe("3");
|
expect(queue.current()?.id).toBe("3");
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("history-aware prev", () => {
|
|
||||||
it("walks back through played indices in random mode", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.add(makeSong("d"));
|
|
||||||
queue.add(makeSong("e"));
|
|
||||||
|
|
||||||
// Force a deterministic random sequence: a → c → e
|
|
||||||
queue.playAt(0);
|
|
||||||
queue.playAt(2);
|
|
||||||
queue.playAt(4);
|
|
||||||
expect(queue.current()?.id).toBe("e");
|
|
||||||
|
|
||||||
// prev pops back through history: e → c → a
|
|
||||||
expect(queue.prev()?.id).toBe("c");
|
|
||||||
expect(queue.prev()?.id).toBe("a");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("returns null when history is empty in random mode", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.playAt(0);
|
|
||||||
// No further moves → history is empty (only 'a' is current, never pushed)
|
|
||||||
expect(queue.prev()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("preserves sequential prev when history is empty", () => {
|
|
||||||
queue.setMode(PlayMode.Sequential);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.play();
|
|
||||||
queue.next(); // currentIndex = 1
|
|
||||||
// Sequential next() pushed 0 to history → prev pops back to 0
|
|
||||||
expect(queue.prev()?.id).toBe("a");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("clears history on play()", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.playAt(0);
|
|
||||||
queue.playAt(1);
|
|
||||||
queue.play(); // resets to index 0 and clears history
|
|
||||||
expect(queue.prev()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("clears history on clear()", () => {
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.play();
|
|
||||||
queue.next();
|
|
||||||
queue.clear();
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.play();
|
|
||||||
// History was wiped — no prev path available beyond index 0
|
|
||||||
expect(queue.prev()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("clears history on setMode()", () => {
|
|
||||||
queue.setMode(PlayMode.Sequential);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.play();
|
|
||||||
queue.next();
|
|
||||||
// Mode change resets context
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
expect(queue.prev()).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("drops history entries pointing at a removed song", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.playAt(0);
|
|
||||||
queue.playAt(1); // history: [0]
|
|
||||||
queue.playAt(2); // history: [0, 1]
|
|
||||||
// Remove song at index 1 → history entry 1 dropped
|
|
||||||
queue.remove(1);
|
|
||||||
// queue is now [a, c], history should be [0]
|
|
||||||
// current was at 2 → after remove shifts to 1 → song "c"
|
|
||||||
expect(queue.current()?.id).toBe("c");
|
|
||||||
expect(queue.prev()?.id).toBe("a");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not push to history on prev itself", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.playAt(0);
|
|
||||||
queue.playAt(1);
|
|
||||||
queue.playAt(2); // history: [0, 1]
|
|
||||||
queue.prev(); // pops 1, history: [0]
|
|
||||||
queue.prev(); // pops 0, history: []
|
|
||||||
expect(queue.prev()).toBeNull(); // no fallback target in random mode
|
|
||||||
});
|
|
||||||
|
|
||||||
it("caps history at HISTORY_LIMIT (50) entries, dropping oldest", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
// Build a queue large enough to overflow HISTORY_LIMIT
|
|
||||||
for (let i = 0; i < 60; i++) queue.add(makeSong(`s${i}`));
|
|
||||||
// Walk through 60 explicit picks → 59 pushes to history
|
|
||||||
// (playAt pushes the previous currentIndex; first call has -1
|
|
||||||
// which pushHistory rejects). After 60 playAts, history holds
|
|
||||||
// the last 50 of those 59 entries.
|
|
||||||
for (let i = 0; i < 60; i++) queue.playAt(i);
|
|
||||||
|
|
||||||
// Walk back through history. The first prev returns whatever the
|
|
||||||
// 50th-most-recent push was (= index 9, since pushes 0..58 happened
|
|
||||||
// and the oldest 9 fell off). We can verify by counting prevs that
|
|
||||||
// succeed before history exhausts and prev returns null in random.
|
|
||||||
let count = 0;
|
|
||||||
while (queue.prev() !== null) {
|
|
||||||
count++;
|
|
||||||
if (count > 100) break; // safety
|
|
||||||
}
|
|
||||||
expect(count).toBe(50);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("addNext", () => {
|
|
||||||
it("appends when queue is empty (no current)", () => {
|
|
||||||
queue.addNext(makeSong("a"));
|
|
||||||
expect(queue.size()).toBe(1);
|
|
||||||
expect(queue.list()[0].id).toBe("a");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("appends when nothing is currently playing (currentIndex < 0)", () => {
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
// No play() yet → currentIndex still -1
|
|
||||||
queue.addNext(makeSong("c"));
|
|
||||||
expect(queue.list().map((s) => s.id)).toEqual(["a", "b", "c"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("inserts at currentIndex+1 mid-queue", () => {
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.add(makeSong("d"));
|
|
||||||
queue.play(); // current = 0 (a)
|
|
||||||
queue.next(); // current = 1 (b)
|
|
||||||
queue.addNext(makeSong("x"));
|
|
||||||
expect(queue.list().map((s) => s.id)).toEqual(["a", "b", "x", "c", "d"]);
|
|
||||||
expect(queue.current()?.id).toBe("b"); // current unchanged
|
|
||||||
});
|
|
||||||
|
|
||||||
it("makes the inserted song play next when next() is called", () => {
|
|
||||||
queue.setMode(PlayMode.Sequential);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.play(); // current = 0 (a)
|
|
||||||
queue.addNext(makeSong("x"));
|
|
||||||
expect(queue.next()?.id).toBe("x");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("shifts playedIndices entries > currentIndex by +1", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.add(makeSong("d"));
|
|
||||||
queue.playAt(2); // current = 2 (c), played = {2}
|
|
||||||
queue.playAt(3); // current = 3 (d), played = {2, 3}
|
|
||||||
queue.playAt(2); // current = 2 (c), played = {2, 3}
|
|
||||||
// Now insert after c — d's index 3 should become 4
|
|
||||||
queue.addNext(makeSong("x"));
|
|
||||||
expect(queue.list().map((s) => s.id)).toEqual(["a", "b", "c", "x", "d"]);
|
|
||||||
// After addNext: currentIndex still 2; played should be {2, 4}
|
|
||||||
// (the previously-played 'd' is now at index 4)
|
|
||||||
// Verify by removing 'x' (index 3) — d should remain played at index 3
|
|
||||||
queue.remove(3);
|
|
||||||
expect(queue.list().map((s) => s.id)).toEqual(["a", "b", "c", "d"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("shifts history entries > currentIndex by +1", () => {
|
|
||||||
queue.setMode(PlayMode.Random);
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.add(makeSong("d"));
|
|
||||||
queue.playAt(0); // current = 0
|
|
||||||
queue.playAt(3); // current = 3 (d), history = [0]
|
|
||||||
queue.playAt(1); // current = 1 (b), history = [0, 3]
|
|
||||||
queue.addNext(makeSong("x"));
|
|
||||||
// Insert at index 2 → entries > 1 shift +1 → history becomes [0, 4]
|
|
||||||
// queue: [a, b, x, c, d]; d is now at index 4
|
|
||||||
// prev → pop 4 → song at index 4 = d
|
|
||||||
expect(queue.prev()?.id).toBe("d");
|
|
||||||
// prev again → pop 0 → song at index 0 = a
|
|
||||||
expect(queue.prev()?.id).toBe("a");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("idle player + stale currentIndex: insertion target is currentIndex+1, not size-1", () => {
|
|
||||||
// Reproduces the scenario where the player has gone idle but the
|
|
||||||
// queue still has a non-negative currentIndex (e.g., after natural
|
|
||||||
// track end without queue.clear()).
|
|
||||||
queue.add(makeSong("a"));
|
|
||||||
queue.add(makeSong("b"));
|
|
||||||
queue.add(makeSong("c"));
|
|
||||||
queue.add(makeSong("d"));
|
|
||||||
queue.play(); // current = 0 (a)
|
|
||||||
queue.next(); // current = 1 (b)
|
|
||||||
// Simulate idle-with-stale-currentIndex: the player has gone idle
|
|
||||||
// but queue still points at b.
|
|
||||||
// Caller pre-captures insertedAt:
|
|
||||||
const insertedAt = queue.getCurrentIndex() + 1; // = 2
|
|
||||||
queue.addNext(makeSong("x"));
|
|
||||||
// queue is now [a, b, x, c, d]
|
|
||||||
// size-1 would be 4 (d) — WRONG.
|
|
||||||
// insertedAt is 2 (x) — RIGHT.
|
|
||||||
expect(queue.list().map((s) => s.id)).toEqual(["a", "b", "x", "c", "d"]);
|
|
||||||
expect(queue.size() - 1).toBe(4); // proves size-1 strategy would pick d
|
|
||||||
const promoted = queue.playAt(insertedAt);
|
|
||||||
expect(promoted?.id).toBe("x");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
+23
-145
@@ -10,7 +10,7 @@ export interface QueuedSong {
|
|||||||
name: string;
|
name: string;
|
||||||
artist: string;
|
artist: string;
|
||||||
album: string;
|
album: string;
|
||||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
platform: "netease" | "qq" | "bilibili";
|
||||||
url?: string; // resolved lazily at play time
|
url?: string; // resolved lazily at play time
|
||||||
coverUrl: string;
|
coverUrl: string;
|
||||||
duration: number; // seconds
|
duration: number; // seconds
|
||||||
@@ -20,18 +20,6 @@ export class PlayQueue {
|
|||||||
private songs: QueuedSong[] = [];
|
private songs: QueuedSong[] = [];
|
||||||
private currentIndex = -1;
|
private currentIndex = -1;
|
||||||
private mode: PlayMode = PlayMode.Sequential;
|
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 {
|
|
||||||
if (idx < 0 || idx >= this.songs.length) return;
|
|
||||||
this.history.push(idx);
|
|
||||||
if (this.history.length > PlayQueue.HISTORY_LIMIT) {
|
|
||||||
this.history.shift();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
add(song: QueuedSong): void {
|
add(song: QueuedSong): void {
|
||||||
this.songs.push(song);
|
this.songs.push(song);
|
||||||
@@ -41,34 +29,6 @@ export class PlayQueue {
|
|||||||
this.songs.push(...songs);
|
this.songs.push(...songs);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Insert a song to play immediately after the current one. Falls
|
|
||||||
* through to plain push when nothing is playing yet (currentIndex < 0
|
|
||||||
* or queue empty), so the existing "add → idle bot starts playing"
|
|
||||||
* flow continues to work.
|
|
||||||
*
|
|
||||||
* Shifts playedIndices and history entries > currentIndex by +1 so
|
|
||||||
* their references stay valid after the splice.
|
|
||||||
*/
|
|
||||||
addNext(song: QueuedSong): void {
|
|
||||||
if (this.currentIndex < 0 || this.songs.length === 0) {
|
|
||||||
this.songs.push(song);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const insertAt = this.currentIndex + 1;
|
|
||||||
this.songs.splice(insertAt, 0, song);
|
|
||||||
|
|
||||||
const shifted = new Set<number>();
|
|
||||||
for (const i of this.playedIndices) {
|
|
||||||
shifted.add(i > this.currentIndex ? i + 1 : i);
|
|
||||||
}
|
|
||||||
this.playedIndices = shifted;
|
|
||||||
|
|
||||||
this.history = this.history.map((i) =>
|
|
||||||
i > this.currentIndex ? i + 1 : i,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
remove(index: number): QueuedSong | null {
|
remove(index: number): QueuedSong | null {
|
||||||
if (index < 0 || index >= this.songs.length) return null;
|
if (index < 0 || index >= this.songs.length) return null;
|
||||||
const [removed] = this.songs.splice(index, 1);
|
const [removed] = this.songs.splice(index, 1);
|
||||||
@@ -76,54 +36,28 @@ export class PlayQueue {
|
|||||||
if (index < this.currentIndex) {
|
if (index < this.currentIndex) {
|
||||||
this.currentIndex--;
|
this.currentIndex--;
|
||||||
} else if (index === this.currentIndex) {
|
} else if (index === this.currentIndex) {
|
||||||
this.currentIndex--;
|
if (this.currentIndex >= this.songs.length) {
|
||||||
|
this.currentIndex = this.songs.length - 1;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Rebuild playedIndices to account for shifted indices
|
|
||||||
const newPlayed = new Set<number>();
|
|
||||||
for (const idx of this.playedIndices) {
|
|
||||||
if (idx === index) continue;
|
|
||||||
newPlayed.add(idx > index ? idx - 1 : idx);
|
|
||||||
}
|
|
||||||
this.playedIndices = newPlayed;
|
|
||||||
|
|
||||||
// Same shift logic for history — drop entries pointing at the
|
|
||||||
// removed song; shift entries > index down by 1.
|
|
||||||
this.history = this.history
|
|
||||||
.filter((idx) => idx !== index)
|
|
||||||
.map((idx) => (idx > index ? idx - 1 : idx));
|
|
||||||
|
|
||||||
return removed;
|
return removed;
|
||||||
}
|
}
|
||||||
|
|
||||||
clear(): void {
|
clear(): void {
|
||||||
this.songs = [];
|
this.songs = [];
|
||||||
this.currentIndex = -1;
|
this.currentIndex = -1;
|
||||||
this.playedIndices.clear();
|
|
||||||
this.history = [];
|
|
||||||
this.forwardStack = [];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
play(): QueuedSong | null {
|
play(): QueuedSong | null {
|
||||||
if (this.songs.length === 0) return null;
|
if (this.songs.length === 0) return null;
|
||||||
this.playedIndices.clear();
|
|
||||||
this.history = [];
|
|
||||||
this.forwardStack = [];
|
|
||||||
this.currentIndex = 0;
|
this.currentIndex = 0;
|
||||||
this.playedIndices.add(0);
|
|
||||||
return this.songs[0];
|
return this.songs[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
playAt(index: number): QueuedSong | null {
|
playAt(index: number): QueuedSong | null {
|
||||||
if (index < 0 || index >= this.songs.length) return null;
|
if (index < 0 || index >= this.songs.length) return null;
|
||||||
this.pushHistory(this.currentIndex);
|
|
||||||
// Reset the Random-mode "unplayed" pool — explicit picks restart
|
|
||||||
// shuffle from this point. History tracking is independent and
|
|
||||||
// unaffected by this clear.
|
|
||||||
this.playedIndices.clear();
|
|
||||||
this.forwardStack = [];
|
|
||||||
this.currentIndex = index;
|
this.currentIndex = index;
|
||||||
this.playedIndices.add(index);
|
|
||||||
return this.songs[index];
|
return this.songs[index];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -134,92 +68,47 @@ export class PlayQueue {
|
|||||||
case PlayMode.Sequential: {
|
case PlayMode.Sequential: {
|
||||||
const nextIndex = this.currentIndex + 1;
|
const nextIndex = this.currentIndex + 1;
|
||||||
if (nextIndex >= this.songs.length) return null;
|
if (nextIndex >= this.songs.length) return null;
|
||||||
this.pushHistory(this.currentIndex);
|
|
||||||
this.currentIndex = nextIndex;
|
this.currentIndex = nextIndex;
|
||||||
return this.songs[nextIndex];
|
return this.songs[nextIndex];
|
||||||
}
|
}
|
||||||
case PlayMode.Loop: {
|
case PlayMode.Loop: {
|
||||||
this.pushHistory(this.currentIndex);
|
|
||||||
this.currentIndex = (this.currentIndex + 1) % this.songs.length;
|
this.currentIndex = (this.currentIndex + 1) % this.songs.length;
|
||||||
return this.songs[this.currentIndex];
|
return this.songs[this.currentIndex];
|
||||||
}
|
}
|
||||||
case PlayMode.Random:
|
case PlayMode.Random: {
|
||||||
|
if (this.songs.length === 1) return this.songs[0];
|
||||||
|
let nextIndex: number;
|
||||||
|
do {
|
||||||
|
nextIndex = Math.floor(Math.random() * this.songs.length);
|
||||||
|
} while (nextIndex === this.currentIndex && this.songs.length > 1);
|
||||||
|
this.currentIndex = nextIndex;
|
||||||
|
return this.songs[nextIndex];
|
||||||
|
}
|
||||||
case PlayMode.RandomLoop: {
|
case PlayMode.RandomLoop: {
|
||||||
// 优先回到前进栈记录的位置（prev 退回的歌）
|
if (this.songs.length === 1) {
|
||||||
if (this.forwardStack.length > 0) {
|
this.currentIndex = 0;
|
||||||
const target = this.forwardStack.pop()!;
|
return this.songs[0];
|
||||||
if (target !== this.currentIndex) {
|
|
||||||
this.pushHistory(this.currentIndex);
|
|
||||||
this.currentIndex = target;
|
|
||||||
this.playedIndices.add(target);
|
|
||||||
return this.songs[target];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// 前进栈为空，走纯随机逻辑
|
|
||||||
if (this.mode === PlayMode.Random) {
|
|
||||||
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;
|
|
||||||
const nextIndex =
|
|
||||||
unplayed[Math.floor(Math.random() * unplayed.length)];
|
|
||||||
this.pushHistory(this.currentIndex);
|
|
||||||
this.currentIndex = nextIndex;
|
|
||||||
this.playedIndices.add(nextIndex);
|
|
||||||
return this.songs[nextIndex];
|
|
||||||
} else {
|
|
||||||
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];
|
|
||||||
}
|
}
|
||||||
|
let idx: number;
|
||||||
|
do {
|
||||||
|
idx = Math.floor(Math.random() * this.songs.length);
|
||||||
|
} while (idx === this.currentIndex);
|
||||||
|
this.currentIndex = idx;
|
||||||
|
return this.songs[idx];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
prev(): QueuedSong | null {
|
prev(): QueuedSong | null {
|
||||||
if (this.songs.length === 0) return 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 = new Set([...this.history, this.currentIndex]);
|
|
||||||
return this.songs[idx];
|
|
||||||
}
|
|
||||||
// Stale entry (song removed) — keep popping.
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fallback: no history to walk back through. In Sequential we
|
|
||||||
// can still meaningfully step the index backward; in random
|
|
||||||
// modes there's nothing useful to return.
|
|
||||||
if (this.mode === PlayMode.Random || this.mode === PlayMode.RandomLoop) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
const prevIndex = this.currentIndex - 1;
|
const prevIndex = this.currentIndex - 1;
|
||||||
if (prevIndex < 0) {
|
if (prevIndex < 0) {
|
||||||
|
// In Sequential mode, don't wrap around
|
||||||
if (this.mode === PlayMode.Sequential) return null;
|
if (this.mode === PlayMode.Sequential) return null;
|
||||||
this.currentIndex = this.songs.length - 1;
|
this.currentIndex = this.songs.length - 1;
|
||||||
} else {
|
} else {
|
||||||
this.currentIndex = prevIndex;
|
this.currentIndex = prevIndex;
|
||||||
}
|
}
|
||||||
this.playedIndices.add(this.currentIndex);
|
|
||||||
return this.songs[this.currentIndex];
|
return this.songs[this.currentIndex];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -247,20 +136,9 @@ export class PlayQueue {
|
|||||||
|
|
||||||
setMode(mode: PlayMode): void {
|
setMode(mode: PlayMode): void {
|
||||||
this.mode = mode;
|
this.mode = mode;
|
||||||
this.playedIndices.clear();
|
|
||||||
this.history = [];
|
|
||||||
this.forwardStack = [];
|
|
||||||
if (this.currentIndex >= 0) {
|
|
||||||
this.playedIndices.add(this.currentIndex);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
getCurrentIndex(): number {
|
getCurrentIndex(): number {
|
||||||
return this.currentIndex;
|
return this.currentIndex;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Number of songs not yet played in Random mode. */
|
|
||||||
unplayedCount(): number {
|
|
||||||
return this.songs.length - this.playedIndices.size;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -8,7 +8,6 @@ export interface ParsedCommand {
|
|||||||
export const PUBLIC_COMMANDS = new Set([
|
export const PUBLIC_COMMANDS = new Set([
|
||||||
"play", "add", "queue", "list", "now", "lyrics", "vote", "help",
|
"play", "add", "queue", "list", "now", "lyrics", "vote", "help",
|
||||||
"playlist", "album", "fm", "prev", "next", "skip", "pause", "resume",
|
"playlist", "album", "fm", "prev", "next", "skip", "pause", "resume",
|
||||||
"artist",
|
|
||||||
]);
|
]);
|
||||||
|
|
||||||
export const ADMIN_COMMANDS = new Set([
|
export const ADMIN_COMMANDS = new Set([
|
||||||
|
|||||||
Executable → Regular
+55
-398
@@ -13,10 +13,8 @@ import {
|
|||||||
type ParsedCommand,
|
type ParsedCommand,
|
||||||
} from "./commands.js";
|
} from "./commands.js";
|
||||||
import type { Logger } from "../logger.js";
|
import type { Logger } from "../logger.js";
|
||||||
import type { BotDatabase, ProfileConfig } from "../data/database.js";
|
import type { BotDatabase } from "../data/database.js";
|
||||||
import type { BotConfig } from "../data/config.js";
|
import type { BotConfig } from "../data/config.js";
|
||||||
import { BotProfileManager } from "./profile.js";
|
|
||||||
import type { AvatarStore } from "../data/avatars.js";
|
|
||||||
|
|
||||||
export interface BotInstanceOptions {
|
export interface BotInstanceOptions {
|
||||||
id: string;
|
id: string;
|
||||||
@@ -25,11 +23,9 @@ export interface BotInstanceOptions {
|
|||||||
neteaseProvider: MusicProvider;
|
neteaseProvider: MusicProvider;
|
||||||
qqProvider: MusicProvider;
|
qqProvider: MusicProvider;
|
||||||
bilibiliProvider: MusicProvider;
|
bilibiliProvider: MusicProvider;
|
||||||
youtubeProvider: MusicProvider;
|
|
||||||
database: BotDatabase;
|
database: BotDatabase;
|
||||||
config: BotConfig;
|
config: BotConfig;
|
||||||
logger: Logger;
|
logger: Logger;
|
||||||
avatarStore: AvatarStore;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface BotStatus {
|
export interface BotStatus {
|
||||||
@@ -55,19 +51,12 @@ export class BotInstance extends EventEmitter {
|
|||||||
private neteaseProvider: MusicProvider;
|
private neteaseProvider: MusicProvider;
|
||||||
private qqProvider: MusicProvider;
|
private qqProvider: MusicProvider;
|
||||||
private bilibiliProvider: MusicProvider;
|
private bilibiliProvider: MusicProvider;
|
||||||
private youtubeProvider: MusicProvider;
|
|
||||||
private database: BotDatabase;
|
private database: BotDatabase;
|
||||||
private config: BotConfig;
|
private config: BotConfig;
|
||||||
private logger: Logger;
|
private logger: Logger;
|
||||||
private avatarStore: AvatarStore;
|
|
||||||
private connected = false;
|
private connected = false;
|
||||||
private disconnectEmitted = false;
|
|
||||||
private voteSkipUsers = new Set<string>();
|
private voteSkipUsers = new Set<string>();
|
||||||
private isAdvancing = false;
|
private isAdvancing = false;
|
||||||
private idleTimer: ReturnType<typeof setTimeout> | null = null;
|
|
||||||
private channelUserCount = 0;
|
|
||||||
private profileManager: BotProfileManager;
|
|
||||||
private isFmMode = false;
|
|
||||||
|
|
||||||
constructor(options: BotInstanceOptions) {
|
constructor(options: BotInstanceOptions) {
|
||||||
super();
|
super();
|
||||||
@@ -76,35 +65,14 @@ export class BotInstance extends EventEmitter {
|
|||||||
this.neteaseProvider = options.neteaseProvider;
|
this.neteaseProvider = options.neteaseProvider;
|
||||||
this.qqProvider = options.qqProvider;
|
this.qqProvider = options.qqProvider;
|
||||||
this.bilibiliProvider = options.bilibiliProvider;
|
this.bilibiliProvider = options.bilibiliProvider;
|
||||||
this.youtubeProvider = options.youtubeProvider;
|
|
||||||
this.database = options.database;
|
this.database = options.database;
|
||||||
this.config = options.config;
|
this.config = options.config;
|
||||||
this.logger = options.logger.child({ botId: this.id });
|
this.logger = options.logger.child({ botId: this.id });
|
||||||
this.avatarStore = options.avatarStore;
|
|
||||||
|
|
||||||
this.tsClient = new TS3Client(options.tsOptions, this.logger);
|
this.tsClient = new TS3Client(options.tsOptions, this.logger);
|
||||||
this.player = new AudioPlayer(this.logger);
|
this.player = new AudioPlayer(this.logger);
|
||||||
this.queue = new PlayQueue();
|
this.queue = new PlayQueue();
|
||||||
|
|
||||||
const profileConfig = this.database.getProfileConfig(this.id);
|
|
||||||
this.profileManager = new BotProfileManager(
|
|
||||||
this.tsClient,
|
|
||||||
this.logger,
|
|
||||||
profileConfig,
|
|
||||||
options.tsOptions.nickname,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Best-effort: a corrupted/locked avatar file must not block bot startup.
|
|
||||||
try {
|
|
||||||
const relPath = this.database.getCustomAvatarPath(this.id);
|
|
||||||
if (relPath) {
|
|
||||||
const buf = this.avatarStore.read(relPath);
|
|
||||||
if (buf) this.profileManager.setCustomAvatar(buf);
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
this.logger.warn({ err }, "Failed to load custom avatar — skipping");
|
|
||||||
}
|
|
||||||
|
|
||||||
this.setupPlayerEvents();
|
this.setupPlayerEvents();
|
||||||
this.setupTsEvents();
|
this.setupTsEvents();
|
||||||
}
|
}
|
||||||
@@ -131,96 +99,27 @@ export class BotInstance extends EventEmitter {
|
|||||||
|
|
||||||
private setupTsEvents(): void {
|
private setupTsEvents(): void {
|
||||||
this.tsClient.on("textMessage", (msg: TS3TextMessage) => {
|
this.tsClient.on("textMessage", (msg: TS3TextMessage) => {
|
||||||
this.handleTextMessage(msg).catch((err) => {
|
this.handleTextMessage(msg);
|
||||||
this.logger.error({ err }, "Unhandled error in text message handler");
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
this.tsClient.on("disconnected", () => {
|
this.tsClient.on("disconnected", () => {
|
||||||
// Always reset local state — covers the case where connect() never
|
|
||||||
// completed (hanging handshake → 60s library idle timeout) and
|
|
||||||
// this.connected was never flipped to true. Previously this handler
|
|
||||||
// short-circuited on !this.connected, leaving player stuck as "playing".
|
|
||||||
this.connected = false;
|
this.connected = false;
|
||||||
this.player.stop();
|
this.player.stop();
|
||||||
// Only emit externally once per lifecycle so clients don't see a
|
|
||||||
// duplicate "disconnected" after an explicit disconnect() call.
|
|
||||||
if (this.disconnectEmitted) return;
|
|
||||||
this.disconnectEmitted = true;
|
|
||||||
this.emit("disconnected");
|
this.emit("disconnected");
|
||||||
});
|
});
|
||||||
|
|
||||||
this.tsClient.on("connected", () => {
|
|
||||||
this._startIdlePoller();
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async connect(): Promise<void> {
|
async connect(): Promise<void> {
|
||||||
this.disconnectEmitted = false;
|
|
||||||
await this.tsClient.connect();
|
await this.tsClient.connect();
|
||||||
// Race guard: if disconnect() was called while the handshake was
|
|
||||||
// awaiting, don't flip connected back to true — that would leave the
|
|
||||||
// bot in an inconsistent state (externally "connected" but the tsClient
|
|
||||||
// has already been torn down).
|
|
||||||
if (this.disconnectEmitted) {
|
|
||||||
throw new Error("Connect aborted by concurrent disconnect");
|
|
||||||
}
|
|
||||||
this.connected = true;
|
this.connected = true;
|
||||||
this.profileManager.onConnect();
|
|
||||||
this.emit("connected");
|
this.emit("connected");
|
||||||
}
|
}
|
||||||
|
|
||||||
disconnect(): void {
|
disconnect(): void {
|
||||||
this._cancelIdleTimer();
|
|
||||||
this.player.stop();
|
this.player.stop();
|
||||||
this.connected = false;
|
|
||||||
if (!this.disconnectEmitted) {
|
|
||||||
this.disconnectEmitted = true;
|
|
||||||
this.emit("disconnected");
|
|
||||||
}
|
|
||||||
this.tsClient.disconnect();
|
this.tsClient.disconnect();
|
||||||
}
|
this.connected = false;
|
||||||
|
this.emit("disconnected");
|
||||||
/** 外部更新 idleTimeoutMinutes（由 API 保存时调用） */
|
|
||||||
updateIdleTimeout(minutes: number): void {
|
|
||||||
this.config.idleTimeoutMinutes = minutes;
|
|
||||||
if (minutes === 0) this._cancelIdleTimer();
|
|
||||||
}
|
|
||||||
|
|
||||||
private _startIdlePoller(): void {
|
|
||||||
// 每 30 秒检查一次频道人数
|
|
||||||
const poll = async () => {
|
|
||||||
if (!this.connected) return;
|
|
||||||
try {
|
|
||||||
const clients = await this.tsClient.getClientsInChannel();
|
|
||||||
const userCount = clients.length - 1; // 排除 bot 自身
|
|
||||||
if (userCount <= 0) {
|
|
||||||
this._scheduleIdleCheck();
|
|
||||||
} else {
|
|
||||||
this._cancelIdleTimer();
|
|
||||||
}
|
|
||||||
} catch { /* ignore */ }
|
|
||||||
setTimeout(poll, 30_000);
|
|
||||||
};
|
|
||||||
setTimeout(poll, 30_000);
|
|
||||||
}
|
|
||||||
|
|
||||||
private _scheduleIdleCheck(): void {
|
|
||||||
if (this.idleTimer !== null) return; // 已经在倒计时，不重复创建
|
|
||||||
const minutes = this.config.idleTimeoutMinutes ?? 0;
|
|
||||||
if (!this.connected || minutes <= 0) return;
|
|
||||||
this.idleTimer = setTimeout(() => {
|
|
||||||
if (!this.connected) return;
|
|
||||||
this.logger.info({ idleMinutes: minutes }, "Channel empty, disconnecting due to idle timeout");
|
|
||||||
this.disconnect();
|
|
||||||
}, minutes * 60 * 1000);
|
|
||||||
}
|
|
||||||
|
|
||||||
private _cancelIdleTimer(): void {
|
|
||||||
if (this.idleTimer) {
|
|
||||||
clearTimeout(this.idleTimer);
|
|
||||||
this.idleTimer = null;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private async handleTextMessage(msg: TS3TextMessage): Promise<void> {
|
private async handleTextMessage(msg: TS3TextMessage): Promise<void> {
|
||||||
@@ -245,12 +144,13 @@ export class BotInstance extends EventEmitter {
|
|||||||
if (response) {
|
if (response) {
|
||||||
await this.tsClient.sendTextMessage(response);
|
await this.tsClient.sendTextMessage(response);
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err: any) {
|
||||||
this.logger.error({ err, command: parsed.name }, "Command execution error");
|
this.logger.error({ err, command: parsed.name }, "Command execution error");
|
||||||
|
const friendlyMsg = err?.code === "ECONNREFUSED"
|
||||||
|
? "Error: Music API server is not reachable. Please check if the service is running."
|
||||||
|
: `Error: ${(err as Error).message}`;
|
||||||
try {
|
try {
|
||||||
await this.tsClient.sendTextMessage(
|
await this.tsClient.sendTextMessage(friendlyMsg);
|
||||||
`Error: ${(err as Error).message}`
|
|
||||||
);
|
|
||||||
} catch (sendErr) {
|
} catch (sendErr) {
|
||||||
this.logger.error({ err: sendErr }, "Failed to send error message to chat");
|
this.logger.error({ err: sendErr }, "Failed to send error message to chat");
|
||||||
}
|
}
|
||||||
@@ -261,35 +161,11 @@ export class BotInstance extends EventEmitter {
|
|||||||
cmd: ParsedCommand,
|
cmd: ParsedCommand,
|
||||||
msg?: TS3TextMessage
|
msg?: TS3TextMessage
|
||||||
): Promise<string | null> {
|
): Promise<string | null> {
|
||||||
// Reject commands that would push audio when the bot isn't connected:
|
|
||||||
// otherwise ffmpeg spawns and voice goes to a half-initialized or
|
|
||||||
// torn-down TS client, leaving player.state="playing" on a disconnected
|
|
||||||
// bot. Config-only commands (vol, mode, clear, stop, queue, now) are
|
|
||||||
// still allowed so the UI stays usable while the bot is offline.
|
|
||||||
const AUDIO_COMMANDS = new Set([
|
|
||||||
"play",
|
|
||||||
"add",
|
|
||||||
"playnext",
|
|
||||||
"pn",
|
|
||||||
"next",
|
|
||||||
"skip",
|
|
||||||
"prev",
|
|
||||||
"playlist",
|
|
||||||
"album",
|
|
||||||
"fm",
|
|
||||||
"artist",
|
|
||||||
]);
|
|
||||||
if (!this.connected && AUDIO_COMMANDS.has(cmd.name)) {
|
|
||||||
throw new Error("Bot is not connected to TeamSpeak");
|
|
||||||
}
|
|
||||||
switch (cmd.name) {
|
switch (cmd.name) {
|
||||||
case "play":
|
case "play":
|
||||||
return this.cmdPlay(cmd);
|
return this.cmdPlay(cmd);
|
||||||
case "add":
|
case "add":
|
||||||
return this.cmdAdd(cmd);
|
return this.cmdAdd(cmd);
|
||||||
case "playnext":
|
|
||||||
case "pn":
|
|
||||||
return this.cmdPlayNext(cmd);
|
|
||||||
case "pause":
|
case "pause":
|
||||||
return this.cmdPause();
|
return this.cmdPause();
|
||||||
case "resume":
|
case "resume":
|
||||||
@@ -320,8 +196,6 @@ export class BotInstance extends EventEmitter {
|
|||||||
return this.cmdAlbum(cmd);
|
return this.cmdAlbum(cmd);
|
||||||
case "fm":
|
case "fm":
|
||||||
return this.cmdFm();
|
return this.cmdFm();
|
||||||
case "artist":
|
|
||||||
return this.cmdArtist(cmd);
|
|
||||||
case "vote":
|
case "vote":
|
||||||
return this.cmdVote(msg);
|
return this.cmdVote(msg);
|
||||||
case "lyrics":
|
case "lyrics":
|
||||||
@@ -337,29 +211,19 @@ export class BotInstance extends EventEmitter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
getProviderFor(platform: "netease" | "qq" | "bilibili" | "youtube"): MusicProvider {
|
getProviderFor(platform: "netease" | "qq" | "bilibili"): MusicProvider {
|
||||||
if (platform === "bilibili") return this.bilibiliProvider;
|
if (platform === "bilibili") return this.bilibiliProvider;
|
||||||
if (platform === "youtube") return this.youtubeProvider;
|
|
||||||
return platform === "qq" ? this.qqProvider : this.neteaseProvider;
|
return platform === "qq" ? this.qqProvider : this.neteaseProvider;
|
||||||
}
|
}
|
||||||
|
|
||||||
private getProvider(flags: Set<string>): MusicProvider {
|
private getProvider(flags: Set<string>): MusicProvider {
|
||||||
if (flags.has("b")) return this.bilibiliProvider;
|
if (flags.has("b")) return this.bilibiliProvider;
|
||||||
if (flags.has("q")) return this.qqProvider;
|
if (flags.has("q")) return this.qqProvider;
|
||||||
if (flags.has("y")) return this.youtubeProvider;
|
|
||||||
return this.neteaseProvider;
|
return this.neteaseProvider;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Resolve URL for a song and start playing it. Skips to next if URL fails. */
|
/** Resolve URL for a song and start playing it. Skips to next if URL fails. */
|
||||||
async resolveAndPlay(song: QueuedSong): Promise<boolean> {
|
async resolveAndPlay(song: QueuedSong): Promise<boolean> {
|
||||||
if (!this.connected) {
|
|
||||||
this.logger.warn({ songId: song.id, name: song.name }, "resolveAndPlay called on disconnected bot — skipping");
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
// Clear any accumulated skip votes — every fresh track starts with a
|
|
||||||
// clean slate, regardless of which code path loaded it (cmdPlay,
|
|
||||||
// cmdPlaylist, cmdAlbum, cmdFm, trackEnd auto-advance, etc.).
|
|
||||||
this.voteSkipUsers.clear();
|
|
||||||
const provider = this.getProviderFor(song.platform);
|
const provider = this.getProviderFor(song.platform);
|
||||||
try {
|
try {
|
||||||
const url = await provider.getSongUrl(song.id);
|
const url = await provider.getSongUrl(song.id);
|
||||||
@@ -367,20 +231,8 @@ export class BotInstance extends EventEmitter {
|
|||||||
this.logger.warn({ songId: song.id, name: song.name }, "No URL available, skipping");
|
this.logger.warn({ songId: song.id, name: song.name }, "No URL available, skipping");
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
// Re-check connection state AFTER the network round-trip — the URL
|
|
||||||
// resolve can take multiple seconds and the user may have called stop
|
|
||||||
// during that window. Without this, we'd spawn ffmpeg on a
|
|
||||||
// disconnected bot and land back in the same "connected=false but
|
|
||||||
// playing=true" inconsistency that Bug C was about.
|
|
||||||
if (!this.connected) {
|
|
||||||
this.logger.warn(
|
|
||||||
{ songId: song.id, name: song.name },
|
|
||||||
"bot disconnected during URL resolve — aborting playback",
|
|
||||||
);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
song.url = url;
|
song.url = url;
|
||||||
this.player.play(url, 0, song.duration);
|
this.player.play(url);
|
||||||
this.database.addPlayHistory({
|
this.database.addPlayHistory({
|
||||||
botId: this.id,
|
botId: this.id,
|
||||||
songId: song.id,
|
songId: song.id,
|
||||||
@@ -390,10 +242,6 @@ export class BotInstance extends EventEmitter {
|
|||||||
platform: song.platform,
|
platform: song.platform,
|
||||||
coverUrl: song.coverUrl,
|
coverUrl: song.coverUrl,
|
||||||
});
|
});
|
||||||
// Update bot presence (fire-and-forget — never blocks playback)
|
|
||||||
this.profileManager.onSongChange(song).catch((err) => {
|
|
||||||
this.logger.warn({ err }, "Profile update failed after song change");
|
|
||||||
});
|
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
return true;
|
return true;
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -405,18 +253,26 @@ export class BotInstance extends EventEmitter {
|
|||||||
private async cmdPlay(cmd: ParsedCommand): Promise<string> {
|
private async cmdPlay(cmd: ParsedCommand): Promise<string> {
|
||||||
if (!cmd.args) return "Usage: !play <song name or URL>";
|
if (!cmd.args) return "Usage: !play <song name or URL>";
|
||||||
const provider = this.getProvider(cmd.flags);
|
const provider = this.getProvider(cmd.flags);
|
||||||
const result = await provider.search(cmd.args, 1);
|
|
||||||
|
let result;
|
||||||
|
try {
|
||||||
|
result = await provider.search(cmd.args, 1);
|
||||||
|
} catch (err: any) {
|
||||||
|
if (err?.code === "ECONNREFUSED") {
|
||||||
|
this.logger.error({ err, platform: provider.platform }, "Music API server is not reachable");
|
||||||
|
return `Music API server for ${provider.platform} is not running. Please check the service.`;
|
||||||
|
}
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
|
||||||
if (result.songs.length === 0)
|
if (result.songs.length === 0)
|
||||||
return `No results found for: ${cmd.args}`;
|
return `No results found for: ${cmd.args}`;
|
||||||
|
|
||||||
const song = result.songs[0];
|
const song = result.songs[0];
|
||||||
this.queue.clear();
|
this.queue.clear();
|
||||||
this.isFmMode = false;
|
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
this.queue.add({ ...song, platform: provider.platform });
|
||||||
this.queue.play();
|
this.queue.play();
|
||||||
|
|
||||||
// Reset failure counter on user-initiated play
|
|
||||||
this.player.resetFailures();
|
|
||||||
const ok = await this.resolveAndPlay(this.queue.current()!);
|
const ok = await this.resolveAndPlay(this.queue.current()!);
|
||||||
if (!ok) return `Cannot play: ${song.name}`;
|
if (!ok) return `Cannot play: ${song.name}`;
|
||||||
return `Now playing: ${song.name} - ${song.artist}`;
|
return `Now playing: ${song.name} - ${song.artist}`;
|
||||||
@@ -425,62 +281,27 @@ export class BotInstance extends EventEmitter {
|
|||||||
private async cmdAdd(cmd: ParsedCommand): Promise<string> {
|
private async cmdAdd(cmd: ParsedCommand): Promise<string> {
|
||||||
if (!cmd.args) return "Usage: !add <song name>";
|
if (!cmd.args) return "Usage: !add <song name>";
|
||||||
const provider = this.getProvider(cmd.flags);
|
const provider = this.getProvider(cmd.flags);
|
||||||
const result = await provider.search(cmd.args, 1);
|
|
||||||
|
let result;
|
||||||
|
try {
|
||||||
|
result = await provider.search(cmd.args, 1);
|
||||||
|
} catch (err: any) {
|
||||||
|
if (err?.code === "ECONNREFUSED") {
|
||||||
|
this.logger.error({ err, platform: provider.platform }, "Music API server is not reachable");
|
||||||
|
return `Music API server for ${provider.platform} is not running. Please check the service.`;
|
||||||
|
}
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
|
||||||
if (result.songs.length === 0)
|
if (result.songs.length === 0)
|
||||||
return `No results found for: ${cmd.args}`;
|
return `No results found for: ${cmd.args}`;
|
||||||
|
|
||||||
const song = result.songs[0];
|
const song = result.songs[0];
|
||||||
const wasIdle = this.player.getState() === "idle";
|
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
this.queue.add({ ...song, platform: provider.platform });
|
||||||
|
|
||||||
// If nothing was playing, start this newly-added song immediately.
|
|
||||||
// Matches /api/player/:id/add-by-id behavior so both add paths feel
|
|
||||||
// the same to the user (add to idle bot → plays now).
|
|
||||||
if (wasIdle) {
|
|
||||||
this.queue.playAt(this.queue.size() - 1);
|
|
||||||
this.player.resetFailures();
|
|
||||||
await this.resolveAndPlay(this.queue.current()!);
|
|
||||||
this.emit("stateChange");
|
|
||||||
return `Now playing: ${song.name} - ${song.artist}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
return `Added to queue: ${song.name} - ${song.artist} (position ${this.queue.size()})`;
|
return `Added to queue: ${song.name} - ${song.artist} (position ${this.queue.size()})`;
|
||||||
}
|
}
|
||||||
|
|
||||||
private async cmdPlayNext(cmd: ParsedCommand): Promise<string> {
|
|
||||||
if (!cmd.args) return "Usage: !playnext <song name>";
|
|
||||||
const provider = this.getProvider(cmd.flags);
|
|
||||||
const result = await provider.search(cmd.args, 1);
|
|
||||||
if (result.songs.length === 0)
|
|
||||||
return `No results found for: ${cmd.args}`;
|
|
||||||
|
|
||||||
const song = result.songs[0];
|
|
||||||
const wasIdle = this.player.getState() === "idle";
|
|
||||||
// Capture the slot addNext WILL insert at, before mutating the queue.
|
|
||||||
// addNext pushes when currentIndex<0 (slot = size); otherwise splices
|
|
||||||
// at currentIndex+1. Using size-1 after addNext was wrong when the
|
|
||||||
// queue had stale currentIndex>=0 while the player was idle (e.g.,
|
|
||||||
// after natural track end without queue.clear()).
|
|
||||||
const insertedAt =
|
|
||||||
this.queue.getCurrentIndex() < 0
|
|
||||||
? this.queue.size()
|
|
||||||
: this.queue.getCurrentIndex() + 1;
|
|
||||||
this.queue.addNext({ ...song, platform: provider.platform });
|
|
||||||
|
|
||||||
if (wasIdle) {
|
|
||||||
this.queue.playAt(insertedAt);
|
|
||||||
this.player.resetFailures();
|
|
||||||
const ok = await this.resolveAndPlay(this.queue.current()!);
|
|
||||||
this.emit("stateChange");
|
|
||||||
if (!ok) return `Cannot play: ${song.name}`;
|
|
||||||
return `Now playing: ${song.name} - ${song.artist}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.emit("stateChange");
|
|
||||||
return `Up next: ${song.name} - ${song.artist}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
private cmdPause(): string {
|
private cmdPause(): string {
|
||||||
this.player.pause();
|
this.player.pause();
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
@@ -496,10 +317,6 @@ export class BotInstance extends EventEmitter {
|
|||||||
private cmdStop(): string {
|
private cmdStop(): string {
|
||||||
this.player.stop();
|
this.player.stop();
|
||||||
this.queue.clear();
|
this.queue.clear();
|
||||||
this.isFmMode = false;
|
|
||||||
this.profileManager.onSongChange(null).catch((err) => {
|
|
||||||
this.logger.warn({ err }, "Profile restore failed on stop");
|
|
||||||
});
|
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
return "Stopped and queue cleared";
|
return "Stopped and queue cleared";
|
||||||
}
|
}
|
||||||
@@ -513,17 +330,13 @@ export class BotInstance extends EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private async cmdPrev(): Promise<string> {
|
private async cmdPrev(): Promise<string> {
|
||||||
// Retry-skip up to 4 attempts: history can include failed songs
|
const prev = this.queue.prev();
|
||||||
// that playNext's auto-advance retry-skipped past, so a single
|
if (prev) {
|
||||||
// prev would otherwise land on an unplayable song and leave the
|
|
||||||
// queue's currentIndex stuck mid-failure.
|
|
||||||
for (let i = 0; i < 4; i++) {
|
|
||||||
const prev = this.queue.prev();
|
|
||||||
if (!prev) return "No previous song";
|
|
||||||
const ok = await this.resolveAndPlay(prev);
|
const ok = await this.resolveAndPlay(prev);
|
||||||
if (ok) return `Now playing: ${prev.name} - ${prev.artist}`;
|
if (!ok) return "Cannot play previous song";
|
||||||
|
return `Now playing: ${prev.name} - ${prev.artist}`;
|
||||||
}
|
}
|
||||||
return "Cannot play any previous songs (all failed to resolve)";
|
return "No previous song";
|
||||||
}
|
}
|
||||||
|
|
||||||
private cmdVol(cmd: ParsedCommand): string {
|
private cmdVol(cmd: ParsedCommand): string {
|
||||||
@@ -554,10 +367,6 @@ export class BotInstance extends EventEmitter {
|
|||||||
private cmdClear(): string {
|
private cmdClear(): string {
|
||||||
this.player.stop();
|
this.player.stop();
|
||||||
this.queue.clear();
|
this.queue.clear();
|
||||||
this.isFmMode = false;
|
|
||||||
this.profileManager.onSongChange(null).catch((err) => {
|
|
||||||
this.logger.warn({ err }, "Profile restore failed on clear");
|
|
||||||
});
|
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
return "Queue cleared";
|
return "Queue cleared";
|
||||||
}
|
}
|
||||||
@@ -586,48 +395,13 @@ export class BotInstance extends EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private async cmdPlaylist(cmd: ParsedCommand): Promise<string> {
|
private async cmdPlaylist(cmd: ParsedCommand): Promise<string> {
|
||||||
if (!cmd.args) return "Usage: !playlist <playlist name or ID>";
|
if (!cmd.args) return "Usage: !playlist <playlist ID or URL>";
|
||||||
const provider = this.getProvider(cmd.flags);
|
const provider = this.getProvider(cmd.flags);
|
||||||
|
|
||||||
// Determine if input is a numeric ID or a name search
|
|
||||||
const id = this.extractId(cmd.args);
|
const id = this.extractId(cmd.args);
|
||||||
const isNumericId = /^\d+$/.test(cmd.args.trim());
|
const songs = await provider.getPlaylistSongs(id);
|
||||||
|
|
||||||
let playlistId: string;
|
|
||||||
|
|
||||||
if (isNumericId || id !== cmd.args) {
|
|
||||||
// Input is a numeric ID or URL containing an ID — use existing logic
|
|
||||||
playlistId = id;
|
|
||||||
} else {
|
|
||||||
// Name-based search
|
|
||||||
const result = await provider.search(cmd.args);
|
|
||||||
let playlists = result.playlists ?? [];
|
|
||||||
|
|
||||||
// Also search user's personal playlists if logged in
|
|
||||||
if (provider.getUserPlaylists) {
|
|
||||||
try {
|
|
||||||
const userPlaylists = await provider.getUserPlaylists();
|
|
||||||
const query = cmd.args.toLowerCase();
|
|
||||||
const matched = userPlaylists.filter(
|
|
||||||
p => p.name.toLowerCase().includes(query)
|
|
||||||
);
|
|
||||||
// Merge: public results first (API-ranked), then user matches
|
|
||||||
playlists = [...playlists, ...matched];
|
|
||||||
} catch {
|
|
||||||
// User playlists unavailable — continue with public results
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (playlists.length === 0)
|
|
||||||
return `No playlists found for: ${cmd.args}`;
|
|
||||||
playlistId = playlists[0].id;
|
|
||||||
}
|
|
||||||
|
|
||||||
const songs = await provider.getPlaylistSongs(playlistId);
|
|
||||||
if (songs.length === 0) return "Playlist is empty or not found";
|
if (songs.length === 0) return "Playlist is empty or not found";
|
||||||
|
|
||||||
this.queue.clear();
|
this.queue.clear();
|
||||||
this.isFmMode = false;
|
|
||||||
for (const song of songs) {
|
for (const song of songs) {
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
this.queue.add({ ...song, platform: provider.platform });
|
||||||
}
|
}
|
||||||
@@ -638,31 +412,12 @@ export class BotInstance extends EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private async cmdAlbum(cmd: ParsedCommand): Promise<string> {
|
private async cmdAlbum(cmd: ParsedCommand): Promise<string> {
|
||||||
if (!cmd.args) return "Usage: !album <album name or ID>";
|
if (!cmd.args) return "Usage: !album <album ID>";
|
||||||
const provider = this.getProvider(cmd.flags);
|
const provider = this.getProvider(cmd.flags);
|
||||||
|
const songs = await provider.getAlbumSongs(cmd.args);
|
||||||
const id = this.extractId(cmd.args);
|
|
||||||
const isNumericId = /^\d+$/.test(cmd.args.trim());
|
|
||||||
|
|
||||||
let albumId: string;
|
|
||||||
|
|
||||||
if (isNumericId || id !== cmd.args) {
|
|
||||||
// Input is a numeric ID or URL containing an ID — use directly
|
|
||||||
albumId = id;
|
|
||||||
} else {
|
|
||||||
// Name-based search
|
|
||||||
const result = await provider.search(cmd.args);
|
|
||||||
const albums = result.albums ?? [];
|
|
||||||
if (albums.length === 0)
|
|
||||||
return `No albums found for: ${cmd.args}`;
|
|
||||||
albumId = albums[0].id;
|
|
||||||
}
|
|
||||||
|
|
||||||
const songs = await provider.getAlbumSongs(albumId);
|
|
||||||
if (songs.length === 0) return "Album is empty or not found";
|
if (songs.length === 0) return "Album is empty or not found";
|
||||||
|
|
||||||
this.queue.clear();
|
this.queue.clear();
|
||||||
this.isFmMode = false;
|
|
||||||
for (const song of songs) {
|
for (const song of songs) {
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
this.queue.add({ ...song, platform: provider.platform });
|
||||||
}
|
}
|
||||||
@@ -684,70 +439,18 @@ export class BotInstance extends EventEmitter {
|
|||||||
for (const song of songs) {
|
for (const song of songs) {
|
||||||
this.queue.add({ ...song, platform: "netease" });
|
this.queue.add({ ...song, platform: "netease" });
|
||||||
}
|
}
|
||||||
this.queue.setMode(PlayMode.Random);
|
|
||||||
this.isFmMode = true;
|
|
||||||
this.player.resetFailures();
|
|
||||||
|
|
||||||
const first = this.queue.play();
|
const first = this.queue.play();
|
||||||
if (first) await this.resolveAndPlay(first);
|
if (first) await this.resolveAndPlay(first);
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
return `Personal FM started: ${first?.name ?? "unknown"} - ${first?.artist ?? ""}`;
|
return `Personal FM started: ${first?.name ?? "unknown"} - ${first?.artist ?? ""}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
private async cmdArtist(cmd: ParsedCommand): Promise<string> {
|
|
||||||
if (!cmd.args) return "Usage: !artist <artist name>";
|
|
||||||
const provider = this.getProvider(cmd.flags);
|
|
||||||
const result = await provider.search(cmd.args, 50);
|
|
||||||
if (result.songs.length === 0)
|
|
||||||
return `No results found for artist: ${cmd.args}`;
|
|
||||||
|
|
||||||
const query = cmd.args.toLowerCase();
|
|
||||||
let filtered = result.songs.filter(
|
|
||||||
s => s.artist.toLowerCase().includes(query)
|
|
||||||
);
|
|
||||||
|
|
||||||
// Fallback to unfiltered results if filtering drops everything
|
|
||||||
if (filtered.length === 0) {
|
|
||||||
filtered = result.songs.slice(0, 20);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.queue.clear();
|
|
||||||
this.isFmMode = false;
|
|
||||||
for (const song of filtered) {
|
|
||||||
this.queue.add({ ...song, platform: provider.platform });
|
|
||||||
}
|
|
||||||
this.queue.setMode(PlayMode.Loop);
|
|
||||||
this.player.resetFailures();
|
|
||||||
|
|
||||||
const first = this.queue.play();
|
|
||||||
if (first) await this.resolveAndPlay(first);
|
|
||||||
this.emit("stateChange");
|
|
||||||
return `Artist mode: ${cmd.args} — ${filtered.length} songs loaded. Now playing: ${first?.name ?? "unknown"}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
private async refillFm(): Promise<void> {
|
|
||||||
if (!this.isFmMode || !this.neteaseProvider.getPersonalFm) return;
|
|
||||||
try {
|
|
||||||
const songs = await this.neteaseProvider.getPersonalFm();
|
|
||||||
if (songs.length === 0) return;
|
|
||||||
for (const song of songs) {
|
|
||||||
this.queue.add({ ...song, platform: "netease" });
|
|
||||||
}
|
|
||||||
this.logger.debug({ count: songs.length }, "FM queue refilled");
|
|
||||||
} catch (err) {
|
|
||||||
this.logger.error({ err }, "Failed to refill FM queue");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private async cmdVote(msg?: TS3TextMessage): Promise<string> {
|
private async cmdVote(msg?: TS3TextMessage): Promise<string> {
|
||||||
if (!msg) return "Vote can only be used in TeamSpeak";
|
if (!msg) return "Vote can only be used in TeamSpeak";
|
||||||
this.voteSkipUsers.add(msg.invokerUid);
|
this.voteSkipUsers.add(msg.invokerUid);
|
||||||
const clients = await this.tsClient.getClientsInChannel();
|
const clients = await this.tsClient.getClientsInChannel();
|
||||||
const totalUsers = clients.length - 1; // exclude the bot itself
|
const totalUsers = clients.length - 1;
|
||||||
// At least 1 vote is always required — otherwise a single voter in an
|
const needed = Math.ceil(totalUsers / 2);
|
||||||
// otherwise empty channel (or a transient clients.length=1 race) could
|
|
||||||
// unanimously "win" with needed=0.
|
|
||||||
const needed = Math.max(1, Math.ceil(totalUsers / 2));
|
|
||||||
const votes = this.voteSkipUsers.size;
|
const votes = this.voteSkipUsers.size;
|
||||||
|
|
||||||
if (votes >= needed) {
|
if (votes >= needed) {
|
||||||
@@ -788,22 +491,16 @@ export class BotInstance extends EventEmitter {
|
|||||||
`${p}play <song> — Search and play`,
|
`${p}play <song> — Search and play`,
|
||||||
`${p}play -q <song> — Search from QQ Music`,
|
`${p}play -q <song> — Search from QQ Music`,
|
||||||
`${p}play -b <song> — Search from BiliBili`,
|
`${p}play -b <song> — Search from BiliBili`,
|
||||||
`${p}play -y <song> — Search from YouTube (yt-dlp)`,
|
|
||||||
`${p}add <song> — Add to queue`,
|
`${p}add <song> — Add to queue`,
|
||||||
`${p}playnext <song> — Insert as next song (alias: ${p}pn)`,
|
|
||||||
`${p}pause/resume — Pause/resume`,
|
`${p}pause/resume — Pause/resume`,
|
||||||
`${p}next/prev — Next/previous`,
|
`${p}next/prev — Next/previous`,
|
||||||
`${p}stop — Stop and clear queue`,
|
`${p}stop — Stop and clear queue`,
|
||||||
`${p}vol <0-100> — Set volume`,
|
`${p}vol <0-100> — Set volume`,
|
||||||
`${p}queue — Show queue`,
|
`${p}queue — Show queue`,
|
||||||
`${p}remove <pos> — Remove song at position (see ${p}queue)`,
|
|
||||||
`${p}mode <seq|loop|random|rloop> — Play mode`,
|
`${p}mode <seq|loop|random|rloop> — Play mode`,
|
||||||
`${p}playlist <name or id> — Load playlist by name or ID`,
|
`${p}playlist <id> — Load playlist`,
|
||||||
`${p}playlist -q <name or id> — Load playlist from QQ Music`,
|
|
||||||
`${p}album <id> — Load album`,
|
`${p}album <id> — Load album`,
|
||||||
`${p}fm — Personal FM (NetEase)`,
|
`${p}fm — Personal FM (NetEase)`,
|
||||||
`${p}artist <name> — Play songs by artist (loop)`,
|
|
||||||
`${p}artist -q <name> — Artist loop from QQ Music`,
|
|
||||||
`${p}vote — Vote to skip`,
|
`${p}vote — Vote to skip`,
|
||||||
`${p}lyrics — Show lyrics`,
|
`${p}lyrics — Show lyrics`,
|
||||||
`${p}now — Current song info`,
|
`${p}now — Current song info`,
|
||||||
@@ -811,59 +508,27 @@ export class BotInstance extends EventEmitter {
|
|||||||
].join("\n");
|
].join("\n");
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
private async playNext(): Promise<void> {
|
||||||
* Advance the queue and play the next song. If the resolved URL fails
|
if (this.isAdvancing) return;
|
||||||
* (e.g., copyright/region restrictions for QQ), skips up to `maxRetries`
|
|
||||||
* more songs looking for a playable one. Public so REST endpoints that
|
|
||||||
* seed the queue can fall back to this retry-skip behavior.
|
|
||||||
*
|
|
||||||
* Returns true if a song actually started playing, false otherwise.
|
|
||||||
*/
|
|
||||||
async playNext(maxRetries = 3): Promise<boolean> {
|
|
||||||
if (this.isAdvancing || !this.connected) return false;
|
|
||||||
this.isAdvancing = true;
|
this.isAdvancing = true;
|
||||||
try {
|
try {
|
||||||
this.voteSkipUsers.clear();
|
this.voteSkipUsers.clear();
|
||||||
const next = this.queue.next();
|
const next = this.queue.next();
|
||||||
let started = false;
|
|
||||||
if (next) {
|
if (next) {
|
||||||
started = await this.resolveAndPlay(next);
|
const ok = await this.resolveAndPlay(next);
|
||||||
if (!started) {
|
if (!ok) {
|
||||||
for (let i = 0; i < maxRetries && this.connected; i++) {
|
// Skip to next if URL resolve fails (up to 3 retries)
|
||||||
|
for (let i = 0; i < 3; i++) {
|
||||||
const retry = this.queue.next();
|
const retry = this.queue.next();
|
||||||
if (!retry) break;
|
if (!retry) break;
|
||||||
if (await this.resolveAndPlay(retry)) {
|
if (await this.resolveAndPlay(retry)) break;
|
||||||
started = true;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
if (!started) {
|
|
||||||
this.player.stop();
|
this.player.stop();
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
} else if (this.isFmMode && this.queue.unplayedCount() <= 3) {
|
|
||||||
// Proactive refill: when queue is running low, fetch more FM songs
|
|
||||||
this.refillFm().catch(err => this.logger.error({ err }, "Proactive FM refill failed"));
|
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// Queue exhausted — in FM Random mode, refill and continue
|
this.player.stop();
|
||||||
if (this.isFmMode) {
|
|
||||||
await this.refillFm();
|
|
||||||
const refillNext = this.queue.next();
|
|
||||||
if (refillNext) {
|
|
||||||
started = await this.resolveAndPlay(refillNext);
|
|
||||||
}
|
|
||||||
if (!started) {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
this.player.stop();
|
|
||||||
this.profileManager.onSongChange(null).catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
this.emit("stateChange");
|
this.emit("stateChange");
|
||||||
return started;
|
|
||||||
} finally {
|
} finally {
|
||||||
this.isAdvancing = false;
|
this.isAdvancing = false;
|
||||||
}
|
}
|
||||||
@@ -907,12 +572,4 @@ export class BotInstance extends EventEmitter {
|
|||||||
isConnected(): boolean {
|
isConnected(): boolean {
|
||||||
return this.connected;
|
return this.connected;
|
||||||
}
|
}
|
||||||
|
|
||||||
getProfileManager(): BotProfileManager {
|
|
||||||
return this.profileManager;
|
|
||||||
}
|
|
||||||
|
|
||||||
getIdentityExport(): string | undefined {
|
|
||||||
return this.tsClient.getIdentityExport();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
+15
-166
@@ -1,54 +1,13 @@
|
|||||||
import crypto from "node:crypto";
|
import crypto from "node:crypto";
|
||||||
import { EventEmitter } from "node:events";
|
|
||||||
import {
|
import {
|
||||||
BotInstance,
|
BotInstance,
|
||||||
type BotInstanceOptions,
|
type BotInstanceOptions,
|
||||||
} from "./instance.js";
|
} from "./instance.js";
|
||||||
import type { MusicProvider } from "../music/provider.js";
|
import type { MusicProvider } from "../music/provider.js";
|
||||||
import { YouTubeProvider } from "../music/youtube.js";
|
|
||||||
import type { BotDatabase } from "../data/database.js";
|
import type { BotDatabase } from "../data/database.js";
|
||||||
import type { BotConfig } from "../data/config.js";
|
import type { BotConfig } from "../data/config.js";
|
||||||
import type { Logger } from "../logger.js";
|
import type { Logger } from "../logger.js";
|
||||||
|
|
||||||
import type { ServerProtocol } from "../ts-protocol/client.js";
|
|
||||||
import type { AvatarStore } from "../data/avatars.js";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Run bot.connect() with a hard deadline. If the handshake hangs (e.g. the
|
|
||||||
* server silently drops the connection after initivexpand2), we tear the
|
|
||||||
* instance down instead of waiting for the library's 60s idle timeout, so
|
|
||||||
* the HTTP /start call returns promptly and the UI doesn't lock up.
|
|
||||||
*/
|
|
||||||
async function connectWithTimeout(
|
|
||||||
bot: BotInstance,
|
|
||||||
ms: number,
|
|
||||||
logger: Logger
|
|
||||||
): Promise<void> {
|
|
||||||
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
||||||
const timeout = new Promise<never>((_, reject) => {
|
|
||||||
timer = setTimeout(
|
|
||||||
() => reject(new Error(`connect timeout after ${ms}ms`)),
|
|
||||||
ms
|
|
||||||
);
|
|
||||||
});
|
|
||||||
try {
|
|
||||||
await Promise.race([bot.connect(), timeout]);
|
|
||||||
} catch (err) {
|
|
||||||
logger.warn(
|
|
||||||
{ err, botId: bot.id },
|
|
||||||
"Connect failed or timed out — tearing down instance"
|
|
||||||
);
|
|
||||||
try {
|
|
||||||
bot.disconnect();
|
|
||||||
} catch {
|
|
||||||
// ignore teardown errors
|
|
||||||
}
|
|
||||||
throw err;
|
|
||||||
} finally {
|
|
||||||
if (timer) clearTimeout(timer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CreateBotParams {
|
export interface CreateBotParams {
|
||||||
name: string;
|
name: string;
|
||||||
serverAddress: string;
|
serverAddress: string;
|
||||||
@@ -58,24 +17,16 @@ export interface CreateBotParams {
|
|||||||
defaultChannel?: string;
|
defaultChannel?: string;
|
||||||
channelPassword?: string;
|
channelPassword?: string;
|
||||||
autoStart?: boolean;
|
autoStart?: boolean;
|
||||||
/** Force TS3 or TS6 protocol; omit or "unknown" for auto-detect. */
|
|
||||||
serverProtocol?: ServerProtocol;
|
|
||||||
/** API key for TS6 HTTP Query (port 10080/10443). */
|
|
||||||
ts6ApiKey?: string;
|
|
||||||
/** Password required to join the TS server. */
|
|
||||||
serverPassword?: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export class BotManager extends EventEmitter {
|
export class BotManager {
|
||||||
private bots = new Map<string, BotInstance>();
|
private bots = new Map<string, BotInstance>();
|
||||||
private neteaseProvider: MusicProvider;
|
private neteaseProvider: MusicProvider;
|
||||||
private qqProvider: MusicProvider;
|
private qqProvider: MusicProvider;
|
||||||
private bilibiliProvider: MusicProvider;
|
private bilibiliProvider: MusicProvider;
|
||||||
private youtubeProvider: MusicProvider;
|
|
||||||
private database: BotDatabase;
|
private database: BotDatabase;
|
||||||
private config: BotConfig;
|
private config: BotConfig;
|
||||||
private logger: Logger;
|
private logger: Logger;
|
||||||
private avatarStore: AvatarStore;
|
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
neteaseProvider: MusicProvider,
|
neteaseProvider: MusicProvider,
|
||||||
@@ -83,18 +34,14 @@ export class BotManager extends EventEmitter {
|
|||||||
bilibiliProvider: MusicProvider,
|
bilibiliProvider: MusicProvider,
|
||||||
database: BotDatabase,
|
database: BotDatabase,
|
||||||
config: BotConfig,
|
config: BotConfig,
|
||||||
logger: Logger,
|
logger: Logger
|
||||||
avatarStore: AvatarStore
|
|
||||||
) {
|
) {
|
||||||
super();
|
|
||||||
this.neteaseProvider = neteaseProvider;
|
this.neteaseProvider = neteaseProvider;
|
||||||
this.qqProvider = qqProvider;
|
this.qqProvider = qqProvider;
|
||||||
this.bilibiliProvider = bilibiliProvider;
|
this.bilibiliProvider = bilibiliProvider;
|
||||||
this.youtubeProvider = new YouTubeProvider();
|
|
||||||
this.database = database;
|
this.database = database;
|
||||||
this.config = config;
|
this.config = config;
|
||||||
this.logger = logger;
|
this.logger = logger;
|
||||||
this.avatarStore = avatarStore;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async createBot(params: CreateBotParams): Promise<BotInstance> {
|
async createBot(params: CreateBotParams): Promise<BotInstance> {
|
||||||
@@ -110,22 +57,16 @@ export class BotManager extends EventEmitter {
|
|||||||
nickname: params.nickname,
|
nickname: params.nickname,
|
||||||
defaultChannel: params.defaultChannel,
|
defaultChannel: params.defaultChannel,
|
||||||
channelPassword: params.channelPassword,
|
channelPassword: params.channelPassword,
|
||||||
serverPassword: params.serverPassword,
|
|
||||||
serverProtocol: params.serverProtocol,
|
|
||||||
ts6ApiKey: params.ts6ApiKey,
|
|
||||||
},
|
},
|
||||||
neteaseProvider: this.neteaseProvider,
|
neteaseProvider: this.neteaseProvider,
|
||||||
qqProvider: this.qqProvider,
|
qqProvider: this.qqProvider,
|
||||||
bilibiliProvider: this.bilibiliProvider,
|
bilibiliProvider: this.bilibiliProvider,
|
||||||
youtubeProvider: this.youtubeProvider,
|
|
||||||
database: this.database,
|
database: this.database,
|
||||||
config: this.config,
|
config: this.config,
|
||||||
logger: this.logger,
|
logger: this.logger,
|
||||||
avatarStore: this.avatarStore,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
this.bots.set(id, bot);
|
this.bots.set(id, bot);
|
||||||
this.emit("botInstance", bot);
|
|
||||||
|
|
||||||
this.database.saveBotInstance({
|
this.database.saveBotInstance({
|
||||||
id,
|
id,
|
||||||
@@ -136,9 +77,6 @@ export class BotManager extends EventEmitter {
|
|||||||
defaultChannel: params.defaultChannel ?? "",
|
defaultChannel: params.defaultChannel ?? "",
|
||||||
channelPassword: params.channelPassword ?? "",
|
channelPassword: params.channelPassword ?? "",
|
||||||
autoStart: params.autoStart ?? false,
|
autoStart: params.autoStart ?? false,
|
||||||
serverProtocol: params.serverProtocol ?? "",
|
|
||||||
ts6ApiKey: params.ts6ApiKey ?? "",
|
|
||||||
serverPassword: params.serverPassword ?? "",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
this.logger.info({ botId: id, name: params.name }, "Bot instance created");
|
this.logger.info({ botId: id, name: params.name }, "Bot instance created");
|
||||||
@@ -152,7 +90,6 @@ export class BotManager extends EventEmitter {
|
|||||||
this.bots.delete(id);
|
this.bots.delete(id);
|
||||||
}
|
}
|
||||||
this.database.deleteBotInstance(id);
|
this.database.deleteBotInstance(id);
|
||||||
this.emit("botInstanceRemoved", id);
|
|
||||||
this.logger.info({ botId: id }, "Bot instance removed");
|
this.logger.info({ botId: id }, "Bot instance removed");
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -169,9 +106,6 @@ export class BotManager extends EventEmitter {
|
|||||||
nickname: params.nickname ?? existing.nickname,
|
nickname: params.nickname ?? existing.nickname,
|
||||||
defaultChannel: params.defaultChannel ?? existing.defaultChannel,
|
defaultChannel: params.defaultChannel ?? existing.defaultChannel,
|
||||||
channelPassword: params.channelPassword ?? existing.channelPassword,
|
channelPassword: params.channelPassword ?? existing.channelPassword,
|
||||||
serverProtocol: params.serverProtocol ?? existing.serverProtocol,
|
|
||||||
ts6ApiKey: params.ts6ApiKey ?? existing.ts6ApiKey,
|
|
||||||
serverPassword: params.serverPassword ?? existing.serverPassword,
|
|
||||||
});
|
});
|
||||||
// Update in-memory name immediately (other fields need reconnect)
|
// Update in-memory name immediately (other fields need reconnect)
|
||||||
const bot = this.bots.get(id);
|
const bot = this.bots.get(id);
|
||||||
@@ -194,131 +128,53 @@ export class BotManager extends EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async startBot(id: string): Promise<void> {
|
async startBot(id: string): Promise<void> {
|
||||||
const oldBot = this.bots.get(id);
|
const bot = this.bots.get(id);
|
||||||
if (!oldBot) throw new Error(`Bot ${id} not found`);
|
if (!bot) throw new Error(`Bot ${id} not found`);
|
||||||
|
await bot.connect();
|
||||||
// Always tear down the outgoing instance before creating a replacement.
|
|
||||||
// Covers three cases:
|
|
||||||
// 1. oldBot is fully connected (manual restart)
|
|
||||||
// 2. oldBot is mid-handshake from a prior rapid start (isConnected()
|
|
||||||
// still returns false but the library client is live and will leak
|
|
||||||
// a TS session if we abandon it)
|
|
||||||
// 3. oldBot was just created by createBot but never connected — the
|
|
||||||
// disconnect call is a cheap no-op here.
|
|
||||||
// Calling disconnect() is idempotent (disconnectEmitted guards event
|
|
||||||
// emission), so this is safe in all states.
|
|
||||||
oldBot.disconnect();
|
|
||||||
|
|
||||||
// Reload config from database so updated settings (channel, nickname, etc.) take effect
|
|
||||||
const saved = this.database.getBotInstances().find((i) => i.id === id);
|
|
||||||
if (saved) {
|
|
||||||
const proto = saved.serverProtocol as "ts3" | "ts6" | "" | undefined;
|
|
||||||
const bot = new BotInstance({
|
|
||||||
id: saved.id,
|
|
||||||
name: saved.name,
|
|
||||||
tsOptions: {
|
|
||||||
host: saved.serverAddress,
|
|
||||||
port: saved.serverPort,
|
|
||||||
queryPort: proto === "ts6" ? 10080 : 10011,
|
|
||||||
nickname: saved.nickname,
|
|
||||||
// Reuse the stored identity so server groups assigned to this bot
|
|
||||||
// survive restarts — without this the TS server sees a new UID
|
|
||||||
// each connect and strips all previously granted groups.
|
|
||||||
identity: saved.identity || undefined,
|
|
||||||
defaultChannel: saved.defaultChannel || undefined,
|
|
||||||
channelPassword: saved.channelPassword || undefined,
|
|
||||||
serverPassword: saved.serverPassword || undefined,
|
|
||||||
serverProtocol: proto === "ts3" || proto === "ts6" ? proto : undefined,
|
|
||||||
ts6ApiKey: saved.ts6ApiKey || undefined,
|
|
||||||
},
|
|
||||||
neteaseProvider: this.neteaseProvider,
|
|
||||||
qqProvider: this.qqProvider,
|
|
||||||
bilibiliProvider: this.bilibiliProvider,
|
|
||||||
youtubeProvider: this.youtubeProvider,
|
|
||||||
database: this.database,
|
|
||||||
config: this.config,
|
|
||||||
logger: this.logger,
|
|
||||||
avatarStore: this.avatarStore,
|
|
||||||
});
|
|
||||||
this.bots.set(id, bot);
|
|
||||||
this.emit("botInstance", bot);
|
|
||||||
await connectWithTimeout(bot, 15_000, this.logger);
|
|
||||||
// Mark as autoStart so it reconnects on Docker restart, and persist identity
|
|
||||||
this.database.saveBotInstance({ ...saved, autoStart: true });
|
|
||||||
this.persistBotIdentity(saved, bot);
|
|
||||||
} else {
|
|
||||||
await connectWithTimeout(oldBot, 15_000, this.logger);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
stopBot(id: string): void {
|
stopBot(id: string): void {
|
||||||
const bot = this.bots.get(id);
|
const bot = this.bots.get(id);
|
||||||
if (!bot) throw new Error(`Bot ${id} not found`);
|
if (!bot) throw new Error(`Bot ${id} not found`);
|
||||||
bot.disconnect();
|
bot.disconnect();
|
||||||
|
|
||||||
// Mark as not autoStart so it stays stopped on Docker restart
|
|
||||||
const saved = this.database.getBotInstances().find((i) => i.id === id);
|
|
||||||
if (saved) {
|
|
||||||
this.database.saveBotInstance({ ...saved, autoStart: false });
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async loadSavedBots(): Promise<void> {
|
async loadSavedBots(): Promise<void> {
|
||||||
const savedInstances = this.database.getBotInstances();
|
const savedInstances = this.database.getBotInstances();
|
||||||
for (const saved of savedInstances) {
|
for (const saved of savedInstances) {
|
||||||
const proto = saved.serverProtocol as "ts3" | "ts6" | "" | undefined;
|
|
||||||
const bot = new BotInstance({
|
const bot = new BotInstance({
|
||||||
id: saved.id,
|
id: saved.id,
|
||||||
name: saved.name,
|
name: saved.name,
|
||||||
tsOptions: {
|
tsOptions: {
|
||||||
host: saved.serverAddress,
|
host: saved.serverAddress,
|
||||||
port: saved.serverPort,
|
port: saved.serverPort,
|
||||||
queryPort: proto === "ts6" ? 10080 : 10011,
|
queryPort: 10011,
|
||||||
nickname: saved.nickname,
|
nickname: saved.nickname,
|
||||||
identity: saved.identity || undefined,
|
|
||||||
defaultChannel: saved.defaultChannel || undefined,
|
defaultChannel: saved.defaultChannel || undefined,
|
||||||
channelPassword: saved.channelPassword || undefined,
|
channelPassword: saved.channelPassword || undefined,
|
||||||
serverPassword: saved.serverPassword || undefined,
|
|
||||||
serverProtocol: proto === "ts3" || proto === "ts6" ? proto : undefined,
|
|
||||||
ts6ApiKey: saved.ts6ApiKey || undefined,
|
|
||||||
},
|
},
|
||||||
neteaseProvider: this.neteaseProvider,
|
neteaseProvider: this.neteaseProvider,
|
||||||
qqProvider: this.qqProvider,
|
qqProvider: this.qqProvider,
|
||||||
bilibiliProvider: this.bilibiliProvider,
|
bilibiliProvider: this.bilibiliProvider,
|
||||||
youtubeProvider: this.youtubeProvider,
|
|
||||||
database: this.database,
|
database: this.database,
|
||||||
config: this.config,
|
config: this.config,
|
||||||
logger: this.logger,
|
logger: this.logger,
|
||||||
avatarStore: this.avatarStore,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
this.bots.set(saved.id, bot);
|
this.bots.set(saved.id, bot);
|
||||||
this.emit("botInstance", bot);
|
|
||||||
|
|
||||||
// Only auto-connect bots that have autoStart enabled
|
// Auto-connect in background (non-blocking, won't affect other bots)
|
||||||
if (saved.autoStart) {
|
bot.connect().then(() => {
|
||||||
bot.connect().then(() => {
|
|
||||||
// Persist identity after successful connection for future restarts
|
|
||||||
this.persistBotIdentity(saved, bot);
|
|
||||||
this.logger.info(
|
|
||||||
{ botId: saved.id, name: saved.name },
|
|
||||||
"Auto-connected saved bot"
|
|
||||||
);
|
|
||||||
}).catch((err) => {
|
|
||||||
this.logger.error(
|
|
||||||
{ err, botId: saved.id, name: saved.name },
|
|
||||||
"Failed to auto-connect bot (start manually from Settings)"
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Stagger connections to avoid overwhelming the TS server
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, 1000));
|
|
||||||
} else {
|
|
||||||
this.logger.info(
|
this.logger.info(
|
||||||
{ botId: saved.id, name: saved.name },
|
{ botId: saved.id, name: saved.name },
|
||||||
"Loaded bot (autoStart disabled, not connecting)"
|
"Auto-connected saved bot"
|
||||||
);
|
);
|
||||||
}
|
}).catch((err) => {
|
||||||
|
this.logger.error(
|
||||||
|
{ err, botId: saved.id, name: saved.name },
|
||||||
|
"Failed to auto-connect bot (start manually from Settings)"
|
||||||
|
);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
this.logger.info(
|
this.logger.info(
|
||||||
@@ -327,13 +183,6 @@ export class BotManager extends EventEmitter {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
private persistBotIdentity(saved: import("../data/database.js").BotInstance, bot: BotInstance): void {
|
|
||||||
const identity = bot.getIdentityExport();
|
|
||||||
if (identity && identity !== saved.identity) {
|
|
||||||
this.database.saveBotInstance({ ...saved, identity });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
shutdown(): void {
|
shutdown(): void {
|
||||||
for (const bot of this.bots.values()) {
|
for (const bot of this.bots.values()) {
|
||||||
bot.disconnect();
|
bot.disconnect();
|
||||||
|
|||||||
@@ -1,147 +0,0 @@
|
|||||||
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);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,500 +0,0 @@
|
|||||||
import { createHash } from "node:crypto";
|
|
||||||
import { Readable } from "node:stream";
|
|
||||||
import axios from "axios";
|
|
||||||
import { TS3Client, escapeTS3 } from "../ts-protocol/client.js";
|
|
||||||
import { HttpQueryError } from "../ts-protocol/http-query.js";
|
|
||||||
import type { ProfileConfig } from "../data/database.js";
|
|
||||||
import type { QueuedSong } from "../audio/queue.js";
|
|
||||||
import type { Logger } from "../logger.js";
|
|
||||||
|
|
||||||
const TS3_NICKNAME_MAX = 30;
|
|
||||||
/** TS3 avatar max size — server default is ~300 KB. Use 200 KB to be safe. */
|
|
||||||
const AVATAR_MAX_BYTES = 200 * 1024;
|
|
||||||
/** Timeout for file-transfer operations (upload / delete). */
|
|
||||||
const FILE_TRANSFER_TIMEOUT_MS = 6000;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Manages the bot's TeamSpeak presence (avatar, description, nickname,
|
|
||||||
* away status, channel description, now-playing messages).
|
|
||||||
*
|
|
||||||
* Every update is permission-safe: if a feature fails due to insufficient
|
|
||||||
* server permissions, it silently disables itself until the next reconnect.
|
|
||||||
*/
|
|
||||||
export class BotProfileManager {
|
|
||||||
private tsClient: TS3Client;
|
|
||||||
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 = {
|
|
||||||
avatar: false,
|
|
||||||
description: false,
|
|
||||||
nickname: false,
|
|
||||||
awayStatus: false,
|
|
||||||
channelDesc: false,
|
|
||||||
nowPlayingMsg: false,
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Monotonically increasing generation counter. Incremented on every
|
|
||||||
* onSongChange / onConnect call. Long-running operations (avatar
|
|
||||||
* download/upload) check this before committing their result — if
|
|
||||||
* the generation changed, a newer update has superseded them.
|
|
||||||
*/
|
|
||||||
private generation = 0;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
tsClient: TS3Client,
|
|
||||||
logger: Logger,
|
|
||||||
config: ProfileConfig,
|
|
||||||
defaultNickname: string,
|
|
||||||
) {
|
|
||||||
this.tsClient = tsClient;
|
|
||||||
this.logger = logger.child({ component: "profile" });
|
|
||||||
this.config = { ...config };
|
|
||||||
this.defaultNickname = defaultNickname;
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- 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).
|
|
||||||
*
|
|
||||||
* Commands are serialized to avoid overwhelming the TS3 command queue.
|
|
||||||
* Nickname + away status are merged into a single `clientupdate` call.
|
|
||||||
*
|
|
||||||
* A generation counter guards against stale updates: if a newer
|
|
||||||
* onSongChange fires while the avatar is still downloading, the old
|
|
||||||
* update is discarded.
|
|
||||||
*/
|
|
||||||
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
|
|
||||||
// could confuse the command matcher.
|
|
||||||
await this.updateAvatar(song?.coverUrl ?? null, gen);
|
|
||||||
if (this.generation !== gen) return; // superseded
|
|
||||||
|
|
||||||
// 2. Combined clientupdate (nickname + away in one fire-and-forget)
|
|
||||||
await this.updateClientProperties(song);
|
|
||||||
// 3. Description (clientedit on TS3, httpQuery on TS6)
|
|
||||||
await this.updateDescription(song);
|
|
||||||
// 4. Channel description (fire-and-forget channeledit)
|
|
||||||
await this.updateChannelDescription(song);
|
|
||||||
// 5. Now-playing chat message
|
|
||||||
if (song) await this.sendNowPlayingMessage(song);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Reset permission-denied flags and bump generation on new connection. */
|
|
||||||
onConnect(): void {
|
|
||||||
this.generation++;
|
|
||||||
this.currentSong = null;
|
|
||||||
this.permDenied = {
|
|
||||||
avatar: false,
|
|
||||||
description: false,
|
|
||||||
nickname: false,
|
|
||||||
awayStatus: false,
|
|
||||||
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 {
|
|
||||||
return { ...this.config };
|
|
||||||
}
|
|
||||||
|
|
||||||
updateConfig(partial: Partial<ProfileConfig>): void {
|
|
||||||
Object.assign(this.config, partial);
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Internal update methods ---
|
|
||||||
|
|
||||||
private async updateAvatar(coverUrl: string | null, gen: number): Promise<void> {
|
|
||||||
if (!this.config.avatarEnabled || this.permDenied.avatar) return;
|
|
||||||
try {
|
|
||||||
if (!coverUrl) {
|
|
||||||
await this.clearAvatar(gen);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Request a thumbnail from the CDN to stay within TS3's avatar size limit.
|
|
||||||
const thumbUrl = this.thumbnailUrl(coverUrl);
|
|
||||||
const imageBuffer = await this.downloadImage(thumbUrl);
|
|
||||||
|
|
||||||
// Check generation after the slow download — bail if superseded.
|
|
||||||
if (this.generation !== gen) return;
|
|
||||||
|
|
||||||
if (!imageBuffer || imageBuffer.length === 0) return;
|
|
||||||
if (imageBuffer.length > AVATAR_MAX_BYTES) {
|
|
||||||
this.logger.warn(
|
|
||||||
{ bytes: imageBuffer.length, max: AVATAR_MAX_BYTES },
|
|
||||||
"Cover image still too large after resize — skipping avatar update",
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wrap the file-transfer sequence with a timeout — the TS3
|
|
||||||
// full-client file transfer can silently hang.
|
|
||||||
const start = Date.now();
|
|
||||||
await this.withTimeout(this.doAvatarUpload(imageBuffer), FILE_TRANSFER_TIMEOUT_MS);
|
|
||||||
this.logger.info(
|
|
||||||
{ bytes: imageBuffer.length, elapsedMs: Date.now() - start },
|
|
||||||
"Avatar updated",
|
|
||||||
);
|
|
||||||
} catch (err) {
|
|
||||||
this.handleFeatureError("avatar", err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Three-step upload. Each step is logged so the log can tell us whether
|
|
||||||
* a broken/loading avatar on the client is from:
|
|
||||||
* (a) init failing (no permission)
|
|
||||||
* (b) file transfer hanging on TCP 30033
|
|
||||||
* (c) client_flag_avatar not applying
|
|
||||||
* If (b) happens, the avatar MD5 would still be set in the past — leaving
|
|
||||||
* clients showing a placeholder. The flag is now only set after the TCP
|
|
||||||
* transfer resolves.
|
|
||||||
*/
|
|
||||||
private async doAvatarUpload(imageBuffer: Buffer): Promise<void> {
|
|
||||||
const host = this.tsClient.getHost();
|
|
||||||
this.logger.debug({ bytes: imageBuffer.length, host }, "Avatar: init file transfer");
|
|
||||||
const info = await this.tsClient.fileTransferInitUpload(
|
|
||||||
0n, "/avatar", "", BigInt(imageBuffer.length), true,
|
|
||||||
);
|
|
||||||
this.logger.debug({ bytes: imageBuffer.length }, "Avatar: uploading file data");
|
|
||||||
await this.tsClient.uploadFileData(host, info, Readable.from(imageBuffer));
|
|
||||||
const md5 = createHash("md5").update(imageBuffer).digest("hex");
|
|
||||||
this.logger.debug({ md5 }, "Avatar: setting client_flag_avatar");
|
|
||||||
await this.tsClient.sendCommandNoWait(`clientupdate client_flag_avatar=${escapeTS3(md5)}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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 {
|
|
||||||
const text = song
|
|
||||||
? `${song.name} - ${song.artist} [${song.album}]`
|
|
||||||
: "";
|
|
||||||
const httpQuery = this.tsClient.getHttpQuery();
|
|
||||||
if (httpQuery) {
|
|
||||||
// TS6 HTTP API: send the raw (unescaped) text. clientUpdate
|
|
||||||
// throws HttpQueryError on non-2xx so a silent 400/403 cannot
|
|
||||||
// be misreported as success.
|
|
||||||
const result = await httpQuery.clientUpdate({ client_description: text });
|
|
||||||
this.logger.info({ status: result.status }, "Description updated");
|
|
||||||
} else {
|
|
||||||
// clientupdate rejects client_description (error 1538).
|
|
||||||
// Use clientedit on our own clid instead — this is what
|
|
||||||
// TS3AudioBot does via TSLib's ChangeDescription().
|
|
||||||
const clid = this.tsClient.getClientId();
|
|
||||||
if (clid <= 0) return;
|
|
||||||
// Use a 5s timeout — if clientedit hangs, don't block the
|
|
||||||
// remaining profile updates (channeledit, now-playing msg).
|
|
||||||
await this.withTimeout(
|
|
||||||
this.tsClient.execCommand(
|
|
||||||
`clientedit clid=${clid} client_description=${escapeTS3(text)}`,
|
|
||||||
),
|
|
||||||
5000,
|
|
||||||
);
|
|
||||||
this.logger.info("Description updated");
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
this.handleFeatureError("description", err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Build and send a single `clientupdate` command that sets nickname
|
|
||||||
* and away status together, avoiding multiple round-trips that can
|
|
||||||
* cause command-queue timeouts on the TS3 protocol.
|
|
||||||
*
|
|
||||||
* Values are collected as raw strings/numbers. The TS6 HTTP path
|
|
||||||
* forwards them as JSON (the server expects real spaces, not `\s`);
|
|
||||||
* the TS3 wire path escapes them on the fly. Previously the code
|
|
||||||
* escaped upfront and then split the escaped string to build the
|
|
||||||
* JSON body, so TS6 received literal backslashes and silently
|
|
||||||
* rejected the update.
|
|
||||||
*/
|
|
||||||
private async updateClientProperties(song: QueuedSong | null): Promise<void> {
|
|
||||||
const rawProps: Record<string, string | number> = {};
|
|
||||||
|
|
||||||
// --- Nickname ---
|
|
||||||
if (this.config.nicknameEnabled && !this.permDenied.nickname) {
|
|
||||||
if (!song) {
|
|
||||||
rawProps.client_nickname = this.defaultNickname;
|
|
||||||
} else {
|
|
||||||
const nickname = this.buildNickname(song);
|
|
||||||
if (nickname) {
|
|
||||||
rawProps.client_nickname = nickname;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Away status ---
|
|
||||||
if (this.config.awayStatusEnabled && !this.permDenied.awayStatus) {
|
|
||||||
if (song) {
|
|
||||||
rawProps.client_away = 0;
|
|
||||||
} else {
|
|
||||||
rawProps.client_away = 1;
|
|
||||||
rawProps.client_away_message = "\u7B49\u5F85\u64AD\u653E";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (Object.keys(rawProps).length === 0) return;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const httpQuery = this.tsClient.getHttpQuery();
|
|
||||||
if (httpQuery) {
|
|
||||||
// TS6: send raw values as JSON. Throws HttpQueryError on 4xx/5xx.
|
|
||||||
const result = await httpQuery.clientUpdate(rawProps);
|
|
||||||
this.logger.info(
|
|
||||||
{ status: result.status, props: Object.keys(rawProps) },
|
|
||||||
"Client properties updated (nickname + away)",
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
// TS3 wire protocol: escape string values inline.
|
|
||||||
// sendCommandNoWait: the TS3 full-client protocol often
|
|
||||||
// doesn't return a timely error response for clientupdate,
|
|
||||||
// causing execCommand to time out after 10s.
|
|
||||||
const parts = Object.entries(rawProps).map(([k, v]) =>
|
|
||||||
typeof v === "string" ? `${k}=${escapeTS3(v)}` : `${k}=${v}`,
|
|
||||||
);
|
|
||||||
await this.tsClient.sendCommandNoWait(`clientupdate ${parts.join(" ")}`);
|
|
||||||
this.logger.info(
|
|
||||||
{ props: Object.keys(rawProps) },
|
|
||||||
"Client properties updated (nickname + away)",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
// Flag both features on permission error
|
|
||||||
this.handleFeatureError("nickname", err);
|
|
||||||
this.handleFeatureError("awayStatus", err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Build a nickname string that fits within TS3_NICKNAME_MAX.
|
|
||||||
* Uses UTF-8 byte length for the limit since TS3 counts bytes,
|
|
||||||
* not characters.
|
|
||||||
*/
|
|
||||||
private buildNickname(song: QueuedSong): string | null {
|
|
||||||
const songInfo = `${song.name} - ${song.artist}`;
|
|
||||||
const prefix = "\u266A "; // ♪
|
|
||||||
const sep = " - ";
|
|
||||||
const suffix = `${sep}${this.defaultNickname}`;
|
|
||||||
|
|
||||||
const overheadBytes = Buffer.byteLength(prefix, "utf8") + Buffer.byteLength(suffix, "utf8");
|
|
||||||
if (overheadBytes >= TS3_NICKNAME_MAX) {
|
|
||||||
// Default nickname alone is too long with decoration — skip
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
const maxSongBytes = TS3_NICKNAME_MAX - overheadBytes;
|
|
||||||
const truncated = this.truncateUtf8(songInfo, maxSongBytes);
|
|
||||||
return `${prefix}${truncated}${suffix}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Truncate a string so its UTF-8 byte length does not exceed maxBytes.
|
|
||||||
* Appends an ellipsis if truncation occurred, taking its byte cost
|
|
||||||
* into account. Never splits a multi-byte character.
|
|
||||||
*/
|
|
||||||
private truncateUtf8(str: string, maxBytes: number): string {
|
|
||||||
if (Buffer.byteLength(str, "utf8") <= maxBytes) return str;
|
|
||||||
const ellipsis = "\u2026"; // …
|
|
||||||
const ellipsisBytes = Buffer.byteLength(ellipsis, "utf8"); // 3
|
|
||||||
const target = maxBytes - ellipsisBytes;
|
|
||||||
if (target <= 0) return ellipsis;
|
|
||||||
// Walk characters, accumulating byte length
|
|
||||||
let byteLen = 0;
|
|
||||||
let end = 0;
|
|
||||||
for (const ch of str) {
|
|
||||||
const chBytes = Buffer.byteLength(ch, "utf8");
|
|
||||||
if (byteLen + chBytes > target) break;
|
|
||||||
byteLen += chBytes;
|
|
||||||
end += ch.length; // ch.length handles surrogate pairs
|
|
||||||
}
|
|
||||||
return str.slice(0, end) + ellipsis;
|
|
||||||
}
|
|
||||||
|
|
||||||
private async updateChannelDescription(song: QueuedSong | null): Promise<void> {
|
|
||||||
if (!this.config.channelDescEnabled || this.permDenied.channelDesc) return;
|
|
||||||
try {
|
|
||||||
const channelId = this.tsClient.getChannelId();
|
|
||||||
if (channelId === 0n) return; // unknown channel
|
|
||||||
|
|
||||||
if (!song) {
|
|
||||||
await this.tsClient.sendCommandNoWait(
|
|
||||||
`channeledit cid=${channelId} channel_description=`,
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const lines = [
|
|
||||||
`\u266A \u6B63\u5728\u64AD\u653E: ${song.name} - ${song.artist}`, // ♪ 正在播放:
|
|
||||||
`\u4E13\u8F91: ${song.album}`, // 专辑:
|
|
||||||
`\u5E73\u53F0: ${song.platform}`, // 平台:
|
|
||||||
];
|
|
||||||
const desc = lines.join("\\n");
|
|
||||||
await this.tsClient.sendCommandNoWait(
|
|
||||||
`channeledit cid=${channelId} channel_description=${escapeTS3(desc)}`,
|
|
||||||
);
|
|
||||||
} catch (err) {
|
|
||||||
this.handleFeatureError("channelDesc", err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private async sendNowPlayingMessage(song: QueuedSong): Promise<void> {
|
|
||||||
if (!this.config.nowPlayingMsgEnabled || this.permDenied.nowPlayingMsg) return;
|
|
||||||
try {
|
|
||||||
const text = `\u266A \u6B63\u5728\u64AD\u653E: ${song.name} - ${song.artist} [${song.album}]`;
|
|
||||||
await this.tsClient.sendTextMessage(text);
|
|
||||||
} catch (err) {
|
|
||||||
this.handleFeatureError("nowPlayingMsg", err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Helpers ---
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Append CDN resize parameters to get a thumbnail suitable for TS3 avatars.
|
|
||||||
* NetEase and QQ Music CDNs support URL-based image resizing.
|
|
||||||
* BiliBili and YouTube covers fall through to the size-check guard.
|
|
||||||
*/
|
|
||||||
private thumbnailUrl(url: string): string {
|
|
||||||
if (url.includes("music.126.net") || url.includes("netease")) {
|
|
||||||
return url.includes("?") ? url : `${url}?param=200y200`;
|
|
||||||
}
|
|
||||||
if (url.includes("qqmusic") || url.includes("qq.com")) {
|
|
||||||
return url.replace(/\/\d+$/, "/200");
|
|
||||||
}
|
|
||||||
if (url.includes("bilivideo") || url.includes("hdslb")) {
|
|
||||||
// BiliBili CDN supports @<w>w_<h>h suffix
|
|
||||||
return url.includes("@") ? url : `${url}@200w_200h`;
|
|
||||||
}
|
|
||||||
return url;
|
|
||||||
}
|
|
||||||
|
|
||||||
private async downloadImage(url: string): Promise<Buffer | null> {
|
|
||||||
try {
|
|
||||||
const resp = await axios.get(url, {
|
|
||||||
responseType: "arraybuffer",
|
|
||||||
timeout: 8000,
|
|
||||||
maxContentLength: 2 * 1024 * 1024, // 2 MB cap
|
|
||||||
});
|
|
||||||
return Buffer.from(resp.data);
|
|
||||||
} catch (err) {
|
|
||||||
this.logger.warn({ err, url }, "Failed to download cover image");
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Race a promise against a timeout. */
|
|
||||||
private withTimeout<T>(promise: Promise<T>, ms: number): Promise<T> {
|
|
||||||
return Promise.race([
|
|
||||||
promise,
|
|
||||||
new Promise<never>((_, reject) =>
|
|
||||||
setTimeout(() => reject(new Error(`Timed out after ${ms}ms`)), ms),
|
|
||||||
),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
private handleFeatureError(
|
|
||||||
feature: keyof typeof this.permDenied,
|
|
||||||
err: unknown,
|
|
||||||
): void {
|
|
||||||
const msg = err instanceof Error ? err.message.toLowerCase() : String(err).toLowerCase();
|
|
||||||
const status = err instanceof HttpQueryError ? err.status : undefined;
|
|
||||||
const body = err instanceof HttpQueryError ? err.body : undefined;
|
|
||||||
// Disable the feature for this session on unrecoverable errors:
|
|
||||||
// - permission / insufficient → server denies the action
|
|
||||||
// - invalid parameter → command not supported by this protocol
|
|
||||||
// - HTTP 401/403 → TS6 server rejects the API key/role
|
|
||||||
// - HTTP 400 → bad parameter; retrying on every song change is wasteful
|
|
||||||
const isUnrecoverable =
|
|
||||||
msg.includes("permission") ||
|
|
||||||
msg.includes("insufficient") ||
|
|
||||||
msg.includes("invalid parameter") ||
|
|
||||||
status === 400 ||
|
|
||||||
status === 401 ||
|
|
||||||
status === 403;
|
|
||||||
if (isUnrecoverable) {
|
|
||||||
this.permDenied[feature] = true;
|
|
||||||
this.logger.info(
|
|
||||||
{ feature, status, body, reason: msg },
|
|
||||||
"Feature disabled for this session (will retry after reconnect)",
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
this.logger.warn({ feature, status, body, err }, "Profile update failed");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
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");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
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";
|
|
||||||
|
|
||||||
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[];
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
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);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
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;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
Executable → Regular
-12
@@ -13,15 +13,6 @@ export interface BotConfig {
|
|||||||
adminGroups: number[];
|
adminGroups: number[];
|
||||||
autoReturnDelay: number;
|
autoReturnDelay: number;
|
||||||
autoPauseOnEmpty: boolean;
|
autoPauseOnEmpty: boolean;
|
||||||
idleTimeoutMinutes: number;
|
|
||||||
// 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"
|
|
||||||
publicUrl: string;
|
|
||||||
// When true, Express trusts X-Forwarded-* headers from a reverse proxy
|
|
||||||
// (nginx/Caddy/Cloudflare). Required for correct protocol/host detection
|
|
||||||
// behind HTTPS-terminating proxies.
|
|
||||||
trustProxy: boolean;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getDefaultConfig(): BotConfig {
|
export function getDefaultConfig(): BotConfig {
|
||||||
@@ -37,9 +28,6 @@ export function getDefaultConfig(): BotConfig {
|
|||||||
adminGroups: [],
|
adminGroups: [],
|
||||||
autoReturnDelay: 300,
|
autoReturnDelay: 300,
|
||||||
autoPauseOnEmpty: true,
|
autoPauseOnEmpty: true,
|
||||||
idleTimeoutMinutes: 0,
|
|
||||||
publicUrl: "",
|
|
||||||
trustProxy: false,
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -23,30 +23,6 @@ describe("database", () => {
|
|||||||
expect(names).toContain("bot_instances");
|
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", () => {
|
it("records and retrieves play history", () => {
|
||||||
botDb.addPlayHistory({
|
botDb.addPlayHistory({
|
||||||
botId: "bot1",
|
botId: "bot1",
|
||||||
@@ -84,15 +60,12 @@ describe("database", () => {
|
|||||||
defaultChannel: "Music",
|
defaultChannel: "Music",
|
||||||
channelPassword: "",
|
channelPassword: "",
|
||||||
autoStart: true,
|
autoStart: true,
|
||||||
serverProtocol: "",
|
|
||||||
ts6ApiKey: "",
|
|
||||||
serverPassword: "",
|
|
||||||
};
|
};
|
||||||
|
|
||||||
botDb.saveBotInstance(instance);
|
botDb.saveBotInstance(instance);
|
||||||
const instances = botDb.getBotInstances();
|
const instances = botDb.getBotInstances();
|
||||||
expect(instances).toHaveLength(1);
|
expect(instances).toHaveLength(1);
|
||||||
expect(instances[0]).toMatchObject(instance);
|
expect(instances[0]).toEqual(instance);
|
||||||
expect(instances[0].autoStart).toBe(true);
|
expect(instances[0].autoStart).toBe(true);
|
||||||
|
|
||||||
// Test upsert
|
// Test upsert
|
||||||
@@ -113,35 +86,10 @@ describe("database", () => {
|
|||||||
defaultChannel: "Music",
|
defaultChannel: "Music",
|
||||||
channelPassword: "",
|
channelPassword: "",
|
||||||
autoStart: false,
|
autoStart: false,
|
||||||
serverProtocol: "",
|
|
||||||
ts6ApiKey: "",
|
|
||||||
serverPassword: "",
|
|
||||||
});
|
});
|
||||||
|
|
||||||
expect(botDb.deleteBotInstance("bot1")).toBe(true);
|
expect(botDb.deleteBotInstance("bot1")).toBe(true);
|
||||||
expect(botDb.getBotInstances()).toHaveLength(0);
|
expect(botDb.getBotInstances()).toHaveLength(0);
|
||||||
expect(botDb.deleteBotInstance("nonexistent")).toBe(false);
|
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: "",
|
|
||||||
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();
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
+7
-180
@@ -6,7 +6,7 @@ export interface PlayHistoryEntry {
|
|||||||
songName: string;
|
songName: string;
|
||||||
artist: string;
|
artist: string;
|
||||||
album: string;
|
album: string;
|
||||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
platform: "netease" | "qq" | "bilibili";
|
||||||
coverUrl: string;
|
coverUrl: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -24,33 +24,8 @@ export interface BotInstance {
|
|||||||
defaultChannel: string;
|
defaultChannel: string;
|
||||||
channelPassword: string;
|
channelPassword: string;
|
||||||
autoStart: boolean;
|
autoStart: boolean;
|
||||||
/** "ts3" | "ts6" | "" (empty = auto-detect) */
|
|
||||||
serverProtocol: string;
|
|
||||||
/** API key for TS6 HTTP Query */
|
|
||||||
ts6ApiKey: string;
|
|
||||||
/** Password to join the TS server (server password) */
|
|
||||||
serverPassword: string;
|
|
||||||
identity?: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ProfileConfig {
|
|
||||||
avatarEnabled: boolean;
|
|
||||||
descriptionEnabled: boolean;
|
|
||||||
nicknameEnabled: boolean;
|
|
||||||
awayStatusEnabled: boolean;
|
|
||||||
channelDescEnabled: boolean;
|
|
||||||
nowPlayingMsgEnabled: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const DEFAULT_PROFILE_CONFIG: ProfileConfig = {
|
|
||||||
avatarEnabled: true,
|
|
||||||
descriptionEnabled: true,
|
|
||||||
nicknameEnabled: true,
|
|
||||||
awayStatusEnabled: true,
|
|
||||||
channelDescEnabled: true,
|
|
||||||
nowPlayingMsgEnabled: true,
|
|
||||||
};
|
|
||||||
|
|
||||||
export interface BotDatabase {
|
export interface BotDatabase {
|
||||||
db: Database.Database;
|
db: Database.Database;
|
||||||
addPlayHistory(entry: PlayHistoryEntry): void;
|
addPlayHistory(entry: PlayHistoryEntry): void;
|
||||||
@@ -58,53 +33,9 @@ export interface BotDatabase {
|
|||||||
saveBotInstance(instance: BotInstance): void;
|
saveBotInstance(instance: BotInstance): void;
|
||||||
getBotInstances(): BotInstance[];
|
getBotInstances(): BotInstance[];
|
||||||
deleteBotInstance(id: string): boolean;
|
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;
|
|
||||||
close(): void;
|
close(): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
function migrateSchema(db: Database.Database): void {
|
|
||||||
const columns = db.prepare("PRAGMA table_info(bot_instances)").all() as Array<{ name: string }>;
|
|
||||||
const names = columns.map((c) => c.name);
|
|
||||||
if (!names.includes("identity")) {
|
|
||||||
db.exec("ALTER TABLE bot_instances ADD COLUMN identity TEXT");
|
|
||||||
}
|
|
||||||
if (!names.includes("serverProtocol")) {
|
|
||||||
db.exec("ALTER TABLE bot_instances ADD COLUMN serverProtocol TEXT NOT NULL DEFAULT ''");
|
|
||||||
}
|
|
||||||
if (!names.includes("ts6ApiKey")) {
|
|
||||||
db.exec("ALTER TABLE bot_instances ADD COLUMN ts6ApiKey TEXT NOT NULL DEFAULT ''");
|
|
||||||
}
|
|
||||||
if (!names.includes("serverPassword")) {
|
|
||||||
db.exec("ALTER TABLE bot_instances ADD COLUMN serverPassword TEXT NOT NULL DEFAULT ''");
|
|
||||||
}
|
|
||||||
// Profile feature flags
|
|
||||||
const profileCols = [
|
|
||||||
"profile_avatar_enabled",
|
|
||||||
"profile_description_enabled",
|
|
||||||
"profile_nickname_enabled",
|
|
||||||
"profile_away_enabled",
|
|
||||||
"profile_channel_desc_enabled",
|
|
||||||
"profile_now_playing_enabled",
|
|
||||||
];
|
|
||||||
for (const col of profileCols) {
|
|
||||||
if (!names.includes(col)) {
|
|
||||||
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'");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function initTables(db: Database.Database): void {
|
function initTables(db: Database.Database): void {
|
||||||
db.exec(`
|
db.exec(`
|
||||||
CREATE TABLE IF NOT EXISTS play_history (
|
CREATE TABLE IF NOT EXISTS play_history (
|
||||||
@@ -127,53 +58,15 @@ function initTables(db: Database.Database): void {
|
|||||||
nickname TEXT NOT NULL,
|
nickname TEXT NOT NULL,
|
||||||
defaultChannel TEXT NOT NULL,
|
defaultChannel TEXT NOT NULL,
|
||||||
channelPassword TEXT NOT NULL,
|
channelPassword TEXT NOT NULL,
|
||||||
autoStart INTEGER NOT NULL DEFAULT 0,
|
autoStart INTEGER NOT NULL DEFAULT 0
|
||||||
serverProtocol TEXT NOT NULL DEFAULT '',
|
|
||||||
ts6ApiKey TEXT NOT NULL DEFAULT '',
|
|
||||||
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);
|
|
||||||
`);
|
`);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function createDatabase(dbPath: string): BotDatabase {
|
export function createDatabase(dbPath: string): BotDatabase {
|
||||||
const db = new Database(dbPath);
|
const db = new Database(dbPath);
|
||||||
db.pragma("journal_mode = WAL");
|
db.pragma("journal_mode = WAL");
|
||||||
db.pragma("foreign_keys = ON");
|
|
||||||
initTables(db);
|
initTables(db);
|
||||||
migrateSchema(db);
|
|
||||||
|
|
||||||
const insertHistory = db.prepare(`
|
const insertHistory = db.prepare(`
|
||||||
INSERT INTO play_history (botId, songId, songName, artist, album, platform, coverUrl)
|
INSERT INTO play_history (botId, songId, songName, artist, album, platform, coverUrl)
|
||||||
@@ -185,8 +78,8 @@ export function createDatabase(dbPath: string): BotDatabase {
|
|||||||
`);
|
`);
|
||||||
|
|
||||||
const upsertInstance = db.prepare(`
|
const upsertInstance = db.prepare(`
|
||||||
INSERT INTO bot_instances (id, name, serverAddress, serverPort, nickname, defaultChannel, channelPassword, autoStart, serverProtocol, ts6ApiKey, serverPassword, identity)
|
INSERT INTO bot_instances (id, name, serverAddress, serverPort, nickname, defaultChannel, channelPassword, autoStart)
|
||||||
VALUES (@id, @name, @serverAddress, @serverPort, @nickname, @defaultChannel, @channelPassword, @autoStart, @serverProtocol, @ts6ApiKey, @serverPassword, @identity)
|
VALUES (@id, @name, @serverAddress, @serverPort, @nickname, @defaultChannel, @channelPassword, @autoStart)
|
||||||
ON CONFLICT(id) DO UPDATE SET
|
ON CONFLICT(id) DO UPDATE SET
|
||||||
name = excluded.name,
|
name = excluded.name,
|
||||||
serverAddress = excluded.serverAddress,
|
serverAddress = excluded.serverAddress,
|
||||||
@@ -194,38 +87,13 @@ export function createDatabase(dbPath: string): BotDatabase {
|
|||||||
nickname = excluded.nickname,
|
nickname = excluded.nickname,
|
||||||
defaultChannel = excluded.defaultChannel,
|
defaultChannel = excluded.defaultChannel,
|
||||||
channelPassword = excluded.channelPassword,
|
channelPassword = excluded.channelPassword,
|
||||||
autoStart = excluded.autoStart,
|
autoStart = excluded.autoStart
|
||||||
serverProtocol = excluded.serverProtocol,
|
|
||||||
ts6ApiKey = excluded.ts6ApiKey,
|
|
||||||
serverPassword = excluded.serverPassword,
|
|
||||||
identity = excluded.identity
|
|
||||||
`);
|
`);
|
||||||
|
|
||||||
const selectInstances = db.prepare(`SELECT * FROM bot_instances`);
|
const selectInstances = db.prepare(`SELECT * FROM bot_instances`);
|
||||||
|
|
||||||
const deleteInstance = db.prepare(`DELETE FROM bot_instances WHERE id = ?`);
|
const deleteInstance = db.prepare(`DELETE FROM bot_instances WHERE id = ?`);
|
||||||
|
|
||||||
const selectProfileConfig = db.prepare(`
|
|
||||||
SELECT profile_avatar_enabled, profile_description_enabled,
|
|
||||||
profile_nickname_enabled, profile_away_enabled,
|
|
||||||
profile_channel_desc_enabled, profile_now_playing_enabled
|
|
||||||
FROM bot_instances WHERE id = ?
|
|
||||||
`);
|
|
||||||
|
|
||||||
const updateProfileConfig = db.prepare(`
|
|
||||||
UPDATE bot_instances SET
|
|
||||||
profile_avatar_enabled = @avatar,
|
|
||||||
profile_description_enabled = @description,
|
|
||||||
profile_nickname_enabled = @nickname,
|
|
||||||
profile_away_enabled = @away,
|
|
||||||
profile_channel_desc_enabled = @channelDesc,
|
|
||||||
profile_now_playing_enabled = @nowPlaying
|
|
||||||
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 = ?`);
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
db,
|
db,
|
||||||
|
|
||||||
@@ -241,22 +109,14 @@ export function createDatabase(dbPath: string): BotDatabase {
|
|||||||
upsertInstance.run({
|
upsertInstance.run({
|
||||||
...instance,
|
...instance,
|
||||||
autoStart: instance.autoStart ? 1 : 0,
|
autoStart: instance.autoStart ? 1 : 0,
|
||||||
identity: instance.identity ?? null,
|
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
|
|
||||||
getBotInstances() {
|
getBotInstances() {
|
||||||
const rows = selectInstances.all() as Array<
|
const rows = selectInstances.all() as Array<
|
||||||
Omit<BotInstance, "autoStart" | "identity"> & { autoStart: number; identity: string | null }
|
Omit<BotInstance, "autoStart"> & { autoStart: number }
|
||||||
>;
|
>;
|
||||||
return rows.map((r) => ({
|
return rows.map((r) => ({ ...r, autoStart: r.autoStart === 1 }));
|
||||||
...r,
|
|
||||||
autoStart: r.autoStart === 1,
|
|
||||||
serverProtocol: r.serverProtocol ?? "",
|
|
||||||
ts6ApiKey: r.ts6ApiKey ?? "",
|
|
||||||
serverPassword: r.serverPassword ?? "",
|
|
||||||
identity: r.identity ?? undefined,
|
|
||||||
}));
|
|
||||||
},
|
},
|
||||||
|
|
||||||
deleteBotInstance(id) {
|
deleteBotInstance(id) {
|
||||||
@@ -264,39 +124,6 @@ export function createDatabase(dbPath: string): BotDatabase {
|
|||||||
return result.changes > 0;
|
return result.changes > 0;
|
||||||
},
|
},
|
||||||
|
|
||||||
getProfileConfig(botId) {
|
|
||||||
const row = selectProfileConfig.get(botId) as Record<string, number> | undefined;
|
|
||||||
if (!row) return { ...DEFAULT_PROFILE_CONFIG };
|
|
||||||
return {
|
|
||||||
avatarEnabled: row.profile_avatar_enabled === 1,
|
|
||||||
descriptionEnabled: row.profile_description_enabled === 1,
|
|
||||||
nicknameEnabled: row.profile_nickname_enabled === 1,
|
|
||||||
awayStatusEnabled: row.profile_away_enabled === 1,
|
|
||||||
channelDescEnabled: row.profile_channel_desc_enabled === 1,
|
|
||||||
nowPlayingMsgEnabled: row.profile_now_playing_enabled === 1,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
|
|
||||||
saveProfileConfig(botId, config) {
|
|
||||||
updateProfileConfig.run({
|
|
||||||
id: botId,
|
|
||||||
avatar: config.avatarEnabled ? 1 : 0,
|
|
||||||
description: config.descriptionEnabled ? 1 : 0,
|
|
||||||
nickname: config.nicknameEnabled ? 1 : 0,
|
|
||||||
away: config.awayStatusEnabled ? 1 : 0,
|
|
||||||
channelDesc: config.channelDescEnabled ? 1 : 0,
|
|
||||||
nowPlaying: config.nowPlayingMsgEnabled ? 1 : 0,
|
|
||||||
});
|
|
||||||
},
|
|
||||||
|
|
||||||
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);
|
|
||||||
},
|
|
||||||
|
|
||||||
close() {
|
close() {
|
||||||
db.close();
|
db.close();
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,128 +0,0 @@
|
|||||||
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 } 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);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
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 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";
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface SessionStore {
|
|
||||||
createSession(userId: string): { 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) {
|
|
||||||
// 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 + SESSION_TTL_MS;
|
|
||||||
const tx = db.transaction(() => {
|
|
||||||
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) {
|
|
||||||
touchStmt.run(now, now + SESSION_TTL_MS, id);
|
|
||||||
}
|
|
||||||
return { userId: row.userId, username: row.username, role: row.role as "admin" | "member" };
|
|
||||||
},
|
|
||||||
|
|
||||||
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());
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,186 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import { createDatabase, type BotDatabase } from "./database.js";
|
|
||||||
import { createUserStore, UsernameTakenError, 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);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,168 +0,0 @@
|
|||||||
import { randomUUID } from "node:crypto";
|
|
||||||
import type Database from "better-sqlite3";
|
|
||||||
import bcrypt from "bcryptjs";
|
|
||||||
|
|
||||||
const BCRYPT_ROUNDS = 12;
|
|
||||||
|
|
||||||
export type UserRole = "admin" | "member";
|
|
||||||
|
|
||||||
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");
|
|
||||||
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 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 === 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 === "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();
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
Executable → Regular
+2
-19
@@ -8,7 +8,6 @@ import { NeteaseProvider } from "./music/netease.js";
|
|||||||
import { QQMusicProvider } from "./music/qq.js";
|
import { QQMusicProvider } from "./music/qq.js";
|
||||||
import { BiliBiliProvider } from "./music/bilibili.js";
|
import { BiliBiliProvider } from "./music/bilibili.js";
|
||||||
import { createCookieStore } from "./music/auth.js";
|
import { createCookieStore } from "./music/auth.js";
|
||||||
import { createAvatarStore } from "./data/avatars.js";
|
|
||||||
import { BotManager } from "./bot/manager.js";
|
import { BotManager } from "./bot/manager.js";
|
||||||
import { createWebServer } from "./web/server.js";
|
import { createWebServer } from "./web/server.js";
|
||||||
|
|
||||||
@@ -19,7 +18,6 @@ const CONFIG_PATH = path.join(ROOT_DIR, "config.json");
|
|||||||
const DB_PATH = path.join(DATA_DIR, "tsmusicbot.db");
|
const DB_PATH = path.join(DATA_DIR, "tsmusicbot.db");
|
||||||
const LOG_DIR = path.join(DATA_DIR, "logs");
|
const LOG_DIR = path.join(DATA_DIR, "logs");
|
||||||
const COOKIE_DIR = path.join(DATA_DIR, "cookies");
|
const COOKIE_DIR = path.join(DATA_DIR, "cookies");
|
||||||
const AVATAR_DIR = path.join(DATA_DIR, "avatars");
|
|
||||||
const STATIC_DIR = path.join(ROOT_DIR, "web", "dist");
|
const STATIC_DIR = path.join(ROOT_DIR, "web", "dist");
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
@@ -27,14 +25,6 @@ async function main() {
|
|||||||
saveConfig(CONFIG_PATH, config);
|
saveConfig(CONFIG_PATH, config);
|
||||||
|
|
||||||
const logger = createLogger(LOG_DIR);
|
const logger = createLogger(LOG_DIR);
|
||||||
|
|
||||||
// Prevent unhandled errors from crashing the process
|
|
||||||
process.on("uncaughtException", (err) => {
|
|
||||||
logger.error({ err }, "Uncaught exception");
|
|
||||||
});
|
|
||||||
process.on("unhandledRejection", (reason) => {
|
|
||||||
logger.error({ reason }, "Unhandled promise rejection");
|
|
||||||
});
|
|
||||||
const db = createDatabase(DB_PATH);
|
const db = createDatabase(DB_PATH);
|
||||||
|
|
||||||
const apiServer = createApiServerManager(
|
const apiServer = createApiServerManager(
|
||||||
@@ -48,7 +38,6 @@ async function main() {
|
|||||||
const bilibiliProvider = new BiliBiliProvider();
|
const bilibiliProvider = new BiliBiliProvider();
|
||||||
|
|
||||||
const cookieStore = createCookieStore(COOKIE_DIR);
|
const cookieStore = createCookieStore(COOKIE_DIR);
|
||||||
const avatarStore = createAvatarStore(AVATAR_DIR);
|
|
||||||
const neteaseCookie = cookieStore.load("netease");
|
const neteaseCookie = cookieStore.load("netease");
|
||||||
if (neteaseCookie) neteaseProvider.setCookie(neteaseCookie);
|
if (neteaseCookie) neteaseProvider.setCookie(neteaseCookie);
|
||||||
const qqCookie = cookieStore.load("qq");
|
const qqCookie = cookieStore.load("qq");
|
||||||
@@ -62,8 +51,7 @@ async function main() {
|
|||||||
bilibiliProvider,
|
bilibiliProvider,
|
||||||
db,
|
db,
|
||||||
config,
|
config,
|
||||||
logger,
|
logger
|
||||||
avatarStore
|
|
||||||
);
|
);
|
||||||
await botManager.loadSavedBots();
|
await botManager.loadSavedBots();
|
||||||
|
|
||||||
@@ -74,9 +62,7 @@ async function main() {
|
|||||||
qqProvider,
|
qqProvider,
|
||||||
bilibiliProvider,
|
bilibiliProvider,
|
||||||
database: db,
|
database: db,
|
||||||
avatarStore,
|
|
||||||
config,
|
config,
|
||||||
configPath: CONFIG_PATH,
|
|
||||||
logger,
|
logger,
|
||||||
cookieStore,
|
cookieStore,
|
||||||
staticDir: STATIC_DIR,
|
staticDir: STATIC_DIR,
|
||||||
@@ -84,10 +70,7 @@ async function main() {
|
|||||||
await webServer.start();
|
await webServer.start();
|
||||||
|
|
||||||
logger.info({ webPort: config.webPort }, "TSMusicBot started");
|
logger.info({ webPort: config.webPort }, "TSMusicBot started");
|
||||||
const publicUrl = (config.publicUrl ?? "").trim().replace(/\/+$/, "");
|
logger.info(`WebUI: http://localhost:${config.webPort}`);
|
||||||
logger.info(
|
|
||||||
`WebUI: ${publicUrl || `http://localhost:${config.webPort}`}`
|
|
||||||
);
|
|
||||||
|
|
||||||
const shutdown = () => {
|
const shutdown = () => {
|
||||||
logger.info("Shutting down...");
|
logger.info("Shutting down...");
|
||||||
|
|||||||
+7
-35
@@ -17,9 +17,7 @@ export interface ApiServerManager {
|
|||||||
function isPortFree(port: number): Promise<boolean> {
|
function isPortFree(port: number): Promise<boolean> {
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
const server = net.createServer();
|
const server = net.createServer();
|
||||||
server.once("error", () => {
|
server.once("error", () => resolve(false));
|
||||||
server.close(() => resolve(false));
|
|
||||||
});
|
|
||||||
server.once("listening", () => {
|
server.once("listening", () => {
|
||||||
server.close(() => resolve(true));
|
server.close(() => resolve(true));
|
||||||
});
|
});
|
||||||
@@ -32,7 +30,6 @@ export function createApiServerManager(
|
|||||||
logger: Logger
|
logger: Logger
|
||||||
): ApiServerManager {
|
): ApiServerManager {
|
||||||
let neteaseServer: Server | null = null;
|
let neteaseServer: Server | null = null;
|
||||||
let qqMusicServer: Server | null = null;
|
|
||||||
|
|
||||||
const neteaseBaseUrl = `http://127.0.0.1:${options.neteasePort}`;
|
const neteaseBaseUrl = `http://127.0.0.1:${options.neteasePort}`;
|
||||||
const qqMusicBaseUrl = `http://127.0.0.1:${options.qqMusicPort}`;
|
const qqMusicBaseUrl = `http://127.0.0.1:${options.qqMusicPort}`;
|
||||||
@@ -63,10 +60,7 @@ export function createApiServerManager(
|
|||||||
logger.error({ err }, "Failed to start NetEase Cloud Music API");
|
logger.error({ err }, "Failed to start NetEase Cloud Music API");
|
||||||
}
|
}
|
||||||
|
|
||||||
// Start QQ Music API. Older versions auto-started on import; the
|
// Start QQ Music API (auto-starts on import)
|
||||||
// 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.
|
|
||||||
try {
|
try {
|
||||||
const portFree = await isPortFree(options.qqMusicPort);
|
const portFree = await isPortFree(options.qqMusicPort);
|
||||||
if (!portFree) {
|
if (!portFree) {
|
||||||
@@ -75,29 +69,11 @@ export function createApiServerManager(
|
|||||||
"QQ Music API port already in use — reusing existing instance"
|
"QQ Music API port already in use — reusing existing instance"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
const qqModule = (await import("@sansenjian/qq-music-api")) as any;
|
await import("@sansenjian/qq-music-api");
|
||||||
// The module's export structure varies between versions:
|
logger.info(
|
||||||
// 2.2.11+: default → Koa app (has .listen)
|
{ port: options.qqMusicPort },
|
||||||
// 2.2.10: default → wrapper object whose .default is the Koa app
|
"QQ Music API started"
|
||||||
// older: module itself may be the Koa app
|
);
|
||||||
const candidate = qqModule.default ?? qqModule;
|
|
||||||
const koaApp = typeof candidate.listen === "function"
|
|
||||||
? candidate
|
|
||||||
: candidate.default ?? null;
|
|
||||||
if (koaApp && typeof koaApp.listen === "function") {
|
|
||||||
qqMusicServer = await new Promise<Server>((resolve, reject) => {
|
|
||||||
const srv = koaApp.listen(options.qqMusicPort, "127.0.0.1", () =>
|
|
||||||
resolve(srv)
|
|
||||||
);
|
|
||||||
srv.on("error", reject);
|
|
||||||
});
|
|
||||||
logger.info(
|
|
||||||
{ port: options.qqMusicPort },
|
|
||||||
"QQ Music API started"
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
logger.warn("QQ Music API module does not expose a Koa app");
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.warn(
|
logger.warn(
|
||||||
@@ -113,10 +89,6 @@ export function createApiServerManager(
|
|||||||
(neteaseServer as any).close();
|
(neteaseServer as any).close();
|
||||||
}
|
}
|
||||||
neteaseServer = null;
|
neteaseServer = null;
|
||||||
if (qqMusicServer && typeof (qqMusicServer as any).close === "function") {
|
|
||||||
(qqMusicServer as any).close();
|
|
||||||
}
|
|
||||||
qqMusicServer = null;
|
|
||||||
},
|
},
|
||||||
|
|
||||||
getNeteaseBaseUrl(): string {
|
getNeteaseBaseUrl(): string {
|
||||||
|
|||||||
+6
-65
@@ -1,4 +1,3 @@
|
|||||||
import { createHash } from "node:crypto";
|
|
||||||
import axios, { type AxiosInstance } from "axios";
|
import axios, { type AxiosInstance } from "axios";
|
||||||
import type {
|
import type {
|
||||||
MusicProvider,
|
MusicProvider,
|
||||||
@@ -16,16 +15,6 @@ 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",
|
"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 {
|
export class BiliBiliProvider implements MusicProvider {
|
||||||
readonly platform = "bilibili" as const;
|
readonly platform = "bilibili" as const;
|
||||||
private api: AxiosInstance;
|
private api: AxiosInstance;
|
||||||
@@ -35,8 +24,6 @@ export class BiliBiliProvider implements MusicProvider {
|
|||||||
private cidCache = new Map<string, number>();
|
private cidCache = new Map<string, number>();
|
||||||
private buvidCookie = ""; // anonymous session cookie (buvid3) for anti-412
|
private buvidCookie = ""; // anonymous session cookie (buvid3) for anti-412
|
||||||
private buvidInitialized = false;
|
private buvidInitialized = false;
|
||||||
private wbiMixinKey = "";
|
|
||||||
private wbiKeyFetchedAt = 0;
|
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
this.api = axios.create({
|
this.api = axios.create({
|
||||||
@@ -75,50 +62,6 @@ export class BiliBiliProvider implements MusicProvider {
|
|||||||
return combined ? { Cookie: combined } : {};
|
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 {
|
setQuality(quality: string): void {
|
||||||
this.quality = quality;
|
this.quality = quality;
|
||||||
}
|
}
|
||||||
@@ -148,14 +91,12 @@ export class BiliBiliProvider implements MusicProvider {
|
|||||||
|
|
||||||
async search(query: string, limit = 20): Promise<SearchResult> {
|
async search(query: string, limit = 20): Promise<SearchResult> {
|
||||||
await this.ensureBuvidCookie();
|
await this.ensureBuvidCookie();
|
||||||
await this.ensureWbiKeys();
|
const res = await this.api.get("/x/web-interface/search/type", {
|
||||||
const signed = this.signWbi({
|
params: {
|
||||||
search_type: "video",
|
search_type: "video",
|
||||||
keyword: query,
|
keyword: query,
|
||||||
page_size: limit,
|
page_size: limit,
|
||||||
});
|
},
|
||||||
const res = await this.api.get("/x/web-interface/wbi/search/type", {
|
|
||||||
params: signed,
|
|
||||||
headers: this.cookieHeaders,
|
headers: this.cookieHeaders,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { describe, it, expect } from "vitest";
|
import { describe, it, expect } from "vitest";
|
||||||
import { parseLyrics, mapNeteaseAlbums } from "./netease.js";
|
import { parseLyrics } from "./netease.js";
|
||||||
|
|
||||||
describe("NetEase adapter", () => {
|
describe("NetEase adapter", () => {
|
||||||
it("parses LRC format lyrics", () => {
|
it("parses LRC format lyrics", () => {
|
||||||
@@ -28,32 +28,4 @@ describe("NetEase adapter", () => {
|
|||||||
expect(lines[0].text).toBe("Hello world");
|
expect(lines[0].text).toBe("Hello world");
|
||||||
expect(lines[0].translation).toBe("你好世界");
|
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([]);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
+3
-37
@@ -3,12 +3,10 @@ import type {
|
|||||||
MusicProvider,
|
MusicProvider,
|
||||||
Song,
|
Song,
|
||||||
Playlist,
|
Playlist,
|
||||||
PlaylistDetail,
|
|
||||||
LyricLine,
|
LyricLine,
|
||||||
SearchResult,
|
SearchResult,
|
||||||
QrCodeResult,
|
QrCodeResult,
|
||||||
AuthStatus,
|
AuthStatus,
|
||||||
Album,
|
|
||||||
} from "./provider.js";
|
} from "./provider.js";
|
||||||
|
|
||||||
export function parseLyrics(lrc: string, tlyric?: string): LyricLine[] {
|
export function parseLyrics(lrc: string, tlyric?: string): LyricLine[] {
|
||||||
@@ -56,18 +54,6 @@ export function parseLyrics(lrc: string, tlyric?: string): LyricLine[] {
|
|||||||
return lines.sort((a, b) => a.time - b.time);
|
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",
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
// NetEase quality levels: standard(128k) higher(192k) exhigh(320k) lossless(flac) hires(hi-res) jyeffect jymaster
|
// NetEase quality levels: standard(128k) higher(192k) exhigh(320k) lossless(flac) hires(hi-res) jyeffect jymaster
|
||||||
export const NETEASE_QUALITY_LEVELS = [
|
export const NETEASE_QUALITY_LEVELS = [
|
||||||
{ value: "standard", label: "标准 (128kbps)", bitrate: 128 },
|
{ value: "standard", label: "标准 (128kbps)", bitrate: 128 },
|
||||||
@@ -104,7 +90,7 @@ export class NeteaseProvider implements MusicProvider {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async search(query: string, limit = 20): Promise<SearchResult> {
|
async search(query: string, limit = 20): Promise<SearchResult> {
|
||||||
const [songRes, playlistRes, albumRes] = await Promise.all([
|
const [songRes, playlistRes] = await Promise.all([
|
||||||
this.api.get("/cloudsearch", {
|
this.api.get("/cloudsearch", {
|
||||||
params: { keywords: query, type: 1, limit, ...this.cookieParams },
|
params: { keywords: query, type: 1, limit, ...this.cookieParams },
|
||||||
}),
|
}),
|
||||||
@@ -112,13 +98,10 @@ export class NeteaseProvider implements MusicProvider {
|
|||||||
params: {
|
params: {
|
||||||
keywords: query,
|
keywords: query,
|
||||||
type: 1000,
|
type: 1000,
|
||||||
limit: 10,
|
limit: 5,
|
||||||
...this.cookieParams,
|
...this.cookieParams,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
this.api.get("/cloudsearch", {
|
|
||||||
params: { keywords: query, type: 10, limit: 10, ...this.cookieParams },
|
|
||||||
}),
|
|
||||||
]);
|
]);
|
||||||
|
|
||||||
const songs: Song[] = (songRes.data?.result?.songs ?? []).map(
|
const songs: Song[] = (songRes.data?.result?.songs ?? []).map(
|
||||||
@@ -143,9 +126,7 @@ export class NeteaseProvider implements MusicProvider {
|
|||||||
platform: "netease",
|
platform: "netease",
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const albums = mapNeteaseAlbums(albumRes.data?.result?.albums);
|
return { songs, playlists, albums: [] };
|
||||||
|
|
||||||
return { songs, playlists, albums };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async getSongUrl(songId: string, quality?: string): Promise<string | null> {
|
async getSongUrl(songId: string, quality?: string): Promise<string | null> {
|
||||||
@@ -338,21 +319,6 @@ export class NeteaseProvider implements MusicProvider {
|
|||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
async getPlaylistDetail(playlistId: string): Promise<PlaylistDetail | null> {
|
|
||||||
const res = await this.api.get("/playlist/detail", {
|
|
||||||
params: { id: playlistId, ...this.cookieParams },
|
|
||||||
});
|
|
||||||
const p = res.data?.playlist;
|
|
||||||
if (!p) return null;
|
|
||||||
return {
|
|
||||||
id: String(p.id),
|
|
||||||
name: p.name ?? "",
|
|
||||||
description: p.description ?? "",
|
|
||||||
coverUrl: p.coverImgUrl ?? "",
|
|
||||||
songCount: p.trackCount ?? 0,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async getUserPlaylists(): Promise<Playlist[]> {
|
async getUserPlaylists(): Promise<Playlist[]> {
|
||||||
// First get user ID from login status
|
// First get user ID from login status
|
||||||
const statusRes = await this.api.get("/login/status", {
|
const statusRes = await this.api.get("/login/status", {
|
||||||
|
|||||||
+4
-13
@@ -5,7 +5,7 @@ export interface Song {
|
|||||||
album: string;
|
album: string;
|
||||||
duration: number; // seconds
|
duration: number; // seconds
|
||||||
coverUrl: string;
|
coverUrl: string;
|
||||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
platform: "netease" | "qq" | "bilibili";
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface SongWithUrl extends Song {
|
export interface SongWithUrl extends Song {
|
||||||
@@ -17,15 +17,7 @@ export interface Playlist {
|
|||||||
name: string;
|
name: string;
|
||||||
coverUrl: string;
|
coverUrl: string;
|
||||||
songCount: number;
|
songCount: number;
|
||||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
platform: "netease" | "qq" | "bilibili";
|
||||||
}
|
|
||||||
|
|
||||||
export interface PlaylistDetail {
|
|
||||||
id: string;
|
|
||||||
name: string;
|
|
||||||
description: string;
|
|
||||||
coverUrl: string;
|
|
||||||
songCount: number;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Album {
|
export interface Album {
|
||||||
@@ -34,7 +26,7 @@ export interface Album {
|
|||||||
artist: string;
|
artist: string;
|
||||||
coverUrl: string;
|
coverUrl: string;
|
||||||
songCount: number;
|
songCount: number;
|
||||||
platform: "netease" | "qq" | "bilibili" | "youtube";
|
platform: "netease" | "qq" | "bilibili";
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface LyricLine {
|
export interface LyricLine {
|
||||||
@@ -62,7 +54,7 @@ export interface AuthStatus {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export interface MusicProvider {
|
export interface MusicProvider {
|
||||||
readonly platform: "netease" | "qq" | "bilibili" | "youtube";
|
readonly platform: "netease" | "qq" | "bilibili";
|
||||||
|
|
||||||
search(query: string, limit?: number): Promise<SearchResult>;
|
search(query: string, limit?: number): Promise<SearchResult>;
|
||||||
getSongUrl(songId: string, quality?: string): Promise<string | null>;
|
getSongUrl(songId: string, quality?: string): Promise<string | null>;
|
||||||
@@ -85,5 +77,4 @@ export interface MusicProvider {
|
|||||||
getPersonalFm?(): Promise<Song[]>;
|
getPersonalFm?(): Promise<Song[]>;
|
||||||
getDailyRecommendSongs?(): Promise<Song[]>;
|
getDailyRecommendSongs?(): Promise<Song[]>;
|
||||||
getUserPlaylists?(): Promise<Playlist[]>;
|
getUserPlaylists?(): Promise<Playlist[]>;
|
||||||
getPlaylistDetail?(playlistId: string): Promise<PlaylistDetail | null>;
|
|
||||||
}
|
}
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
import { describe, it, expect } from "vitest";
|
|
||||||
import { mapQqAlbums } from "./qq.js";
|
|
||||||
|
|
||||||
describe("QQ adapter", () => {
|
|
||||||
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("");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+43
-449
@@ -3,70 +3,13 @@ import type {
|
|||||||
MusicProvider,
|
MusicProvider,
|
||||||
Song,
|
Song,
|
||||||
Playlist,
|
Playlist,
|
||||||
PlaylistDetail,
|
|
||||||
LyricLine,
|
LyricLine,
|
||||||
SearchResult,
|
SearchResult,
|
||||||
QrCodeResult,
|
QrCodeResult,
|
||||||
AuthStatus,
|
AuthStatus,
|
||||||
Album,
|
|
||||||
} from "./provider.js";
|
} from "./provider.js";
|
||||||
import { parseLyrics } from "./netease.js";
|
import { parseLyrics } from "./netease.js";
|
||||||
|
|
||||||
// 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({
|
|
||||||
baseURL: "https://c.y.qq.com",
|
|
||||||
timeout: 10000,
|
|
||||||
headers: { referer: "https://y.qq.com/" },
|
|
||||||
});
|
|
||||||
|
|
||||||
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++) {
|
|
||||||
hash = (hash + (hash << 5) + pSkey.charCodeAt(i)) | 0;
|
|
||||||
}
|
|
||||||
return hash & 0x7fffffff;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class QQMusicProvider implements MusicProvider {
|
export class QQMusicProvider implements MusicProvider {
|
||||||
readonly platform = "qq" as const;
|
readonly platform = "qq" as const;
|
||||||
private api: AxiosInstance;
|
private api: AxiosInstance;
|
||||||
@@ -93,210 +36,37 @@ export class QQMusicProvider implements MusicProvider {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async search(query: string, limit = 20): Promise<SearchResult> {
|
async search(query: string, limit = 20): Promise<SearchResult> {
|
||||||
// Primary: u.y.qq.com/cgi-bin/musicu.fcg — supports songs + albums +
|
const res = await this.api.get("/getSearchByKey", {
|
||||||
// playlists. Fixed per https://github.com/ZHANGTIANYAO1/teamspeak-music-bot/issues/61
|
params: { key: query, pageSize: limit, ...this.cookieParams },
|
||||||
// (removed searchid, num_per_page >= 10, corrected search_type values).
|
});
|
||||||
const primary = await this.searchViaMusicuFcg(query, limit);
|
|
||||||
if (primary) return primary;
|
|
||||||
|
|
||||||
// Fallback: c.y.qq.com/soso/fcgi-bin/client_search_cp (song + album,
|
const songs: Song[] = (res.data?.response?.data?.song?.list ?? []).map(
|
||||||
// no playlist support). Kept as redundancy.
|
(s: any) => ({
|
||||||
return this.searchViaClientSearchCp(query, limit);
|
id: String(s.songmid ?? s.songid),
|
||||||
}
|
name: s.songname ?? "",
|
||||||
|
|
||||||
/** 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
|
|
||||||
): Promise<SearchResult | null> {
|
|
||||||
try {
|
|
||||||
const numPerPage = Math.max(10, Math.min(limit, 50));
|
|
||||||
const reqData = JSON.stringify({
|
|
||||||
req_0: {
|
|
||||||
module: "music.search.SearchCgiService",
|
|
||||||
method: "DoSearchForQQMusicDesktop",
|
|
||||||
param: { query, num_per_page: numPerPage, search_type: 0 },
|
|
||||||
},
|
|
||||||
req_album: {
|
|
||||||
module: "music.search.SearchCgiService",
|
|
||||||
method: "DoSearchForQQMusicDesktop",
|
|
||||||
param: { query, num_per_page: 10, search_type: 2 },
|
|
||||||
},
|
|
||||||
req_playlist: {
|
|
||||||
module: "music.search.SearchCgiService",
|
|
||||||
method: "DoSearchForQQMusicDesktop",
|
|
||||||
param: { query, num_per_page: 10, 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: Song[] = songList.map((s: any) => ({
|
|
||||||
id: String(s.mid ?? s.id),
|
|
||||||
name: s.title ?? s.name ?? "",
|
|
||||||
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
||||||
album: s.album?.name ?? s.album?.title ?? "",
|
album: s.albumname ?? "",
|
||||||
duration: s.interval ?? 0,
|
duration: s.interval ?? 0,
|
||||||
coverUrl: s.album?.mid
|
coverUrl: s.albummid
|
||||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.album.mid}.jpg`
|
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.albummid}.jpg`
|
||||||
: "",
|
: "",
|
||||||
platform: "qq",
|
platform: "qq",
|
||||||
}));
|
})
|
||||||
|
);
|
||||||
|
|
||||||
const albumList: any[] = res.data?.req_album?.data?.body?.album?.list ?? [];
|
return { songs, playlists: [], albums: [] };
|
||||||
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 */
|
async getSongUrl(songId: string, _quality?: string): Promise<string | null> {
|
||||||
private async searchViaClientSearchCp(
|
const res = await this.api.get("/getMusicPlay", {
|
||||||
query: string,
|
params: { songmid: songId, ...this.cookieParams },
|
||||||
limit: number
|
});
|
||||||
): Promise<SearchResult> {
|
const playUrl = res.data?.data?.playUrl?.[songId];
|
||||||
const songParams = {
|
return playUrl?.url || null;
|
||||||
w: query,
|
|
||||||
format: "json",
|
|
||||||
p: 1,
|
|
||||||
n: Math.min(limit, 50),
|
|
||||||
type: 0,
|
|
||||||
cr: 1,
|
|
||||||
};
|
|
||||||
const albumParams = {
|
|
||||||
w: query,
|
|
||||||
format: "json",
|
|
||||||
p: 1,
|
|
||||||
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: Song[] = songList.map((s: any) => ({
|
|
||||||
id: String(s.songmid ?? s.songid ?? ""),
|
|
||||||
name: s.songname ?? s.name ?? "",
|
|
||||||
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
|
||||||
album: s.albumname ?? s.album?.name ?? "",
|
|
||||||
duration: s.interval ?? 0,
|
|
||||||
coverUrl: s.albummid
|
|
||||||
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.albummid}.jpg`
|
|
||||||
: "",
|
|
||||||
platform: "qq",
|
|
||||||
}));
|
|
||||||
|
|
||||||
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<string | 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;
|
|
||||||
} catch {
|
|
||||||
// try with songid
|
|
||||||
try {
|
|
||||||
const res = await this.api.get("/getMusicPlay", {
|
|
||||||
params: { songid: songId, quality: quality ?? this.quality, ...this.cookieParams },
|
|
||||||
});
|
|
||||||
const playUrl = res.data?.data?.playUrl?.[songId];
|
|
||||||
if (playUrl?.url) return playUrl.url;
|
|
||||||
} catch {
|
|
||||||
// ignore
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Batch-check which song mids are actually streamable. QQ playlists
|
|
||||||
* (especially collected ones) frequently contain a majority of songs
|
|
||||||
* that return result=104003 ("no copyright/region restricted") for the
|
|
||||||
* current user — a sequential retry loop wastes time guessing.
|
|
||||||
*
|
|
||||||
* The wrapper's /getMusicPlay accepts a comma-separated songmid list
|
|
||||||
* and resolves all of them in a single upstream call. We chunk to keep
|
|
||||||
* the URL well under typical 8KB query-string limits and to keep per-
|
|
||||||
* request latency bounded (~2-3s per 100 mids).
|
|
||||||
*
|
|
||||||
* Returns:
|
|
||||||
* - non-null Set: authoritative result. Empty Set means all songs are
|
|
||||||
* unplayable; non-empty means filter to those mids.
|
|
||||||
* - null: every chunk failed. Caller should fall back to sequential
|
|
||||||
* retry rather than treating as "all unplayable".
|
|
||||||
*/
|
|
||||||
async getPlayableSongIds(songIds: string[]): Promise<Set<string> | null> {
|
|
||||||
if (songIds.length === 0) return new Set();
|
|
||||||
|
|
||||||
const CHUNK = 100; // ~14 chars/mid * 100 + commas ≈ 1.5KB
|
|
||||||
const playable = new Set<string>();
|
|
||||||
let allChunksFailed = true;
|
|
||||||
for (let i = 0; i < songIds.length; i += CHUNK) {
|
|
||||||
const slice = songIds.slice(i, i + CHUNK);
|
|
||||||
try {
|
|
||||||
const res = await this.api.get("/getMusicPlay", {
|
|
||||||
params: { songmid: slice.join(","), quality: this.quality, ...this.cookieParams },
|
|
||||||
});
|
|
||||||
const playUrlMap: Record<string, { url?: string }> | undefined =
|
|
||||||
res.data?.data?.playUrl;
|
|
||||||
if (!playUrlMap) continue; // chunk-level failure, try next
|
|
||||||
allChunksFailed = false;
|
|
||||||
for (const [mid, info] of Object.entries(playUrlMap)) {
|
|
||||||
if (info?.url) playable.add(mid);
|
|
||||||
}
|
|
||||||
} catch {
|
|
||||||
// chunk-level failure — keep going so a transient error on one
|
|
||||||
// chunk doesn't poison the whole batch.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return allChunksFailed ? null : playable;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async getSongDetail(songId: string): Promise<Song | null> {
|
async getSongDetail(songId: string): Promise<Song | null> {
|
||||||
// Try /getSongInfo for full metadata, but fall through to a minimal
|
// getSongInfo requires cookie; use search as fallback
|
||||||
// stub if the library endpoint fails (current @sansenjian/qq-music-api
|
|
||||||
// returns upstream code 500001 for this route — the param format it
|
|
||||||
// sends doesn't match QQ's current API). The bot's resolveAndPlay path
|
|
||||||
// only needs `id` and `platform` to fetch a play URL, and the fallback
|
|
||||||
// stub is sufficient to let /play-by-id and /add-by-id flows succeed.
|
|
||||||
try {
|
try {
|
||||||
const res = await this.api.get("/getSongInfo", {
|
const res = await this.api.get("/getSongInfo", {
|
||||||
params: { songmid: songId, ...this.cookieParams },
|
params: { songmid: songId, ...this.cookieParams },
|
||||||
@@ -317,20 +87,9 @@ export class QQMusicProvider implements MusicProvider {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
} catch {
|
} catch {
|
||||||
// fall through to stub
|
// fallback: search by songmid (less reliable)
|
||||||
}
|
}
|
||||||
// Minimal stub — resolveAndPlay only needs id + platform to fetch a
|
return null;
|
||||||
// play URL. Name/artist/album will be empty in play history, but the
|
|
||||||
// song will actually play, which is the important part.
|
|
||||||
return {
|
|
||||||
id: songId,
|
|
||||||
name: "",
|
|
||||||
artist: "",
|
|
||||||
album: "",
|
|
||||||
duration: 0,
|
|
||||||
coverUrl: "",
|
|
||||||
platform: "qq",
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async getPlaylistSongs(playlistId: string): Promise<Song[]> {
|
async getPlaylistSongs(playlistId: string): Promise<Song[]> {
|
||||||
@@ -340,35 +99,18 @@ export class QQMusicProvider implements MusicProvider {
|
|||||||
const cdlist = res.data?.response?.cdlist ?? [];
|
const cdlist = res.data?.response?.cdlist ?? [];
|
||||||
if (cdlist.length === 0) return [];
|
if (cdlist.length === 0) return [];
|
||||||
return (cdlist[0].songlist ?? []).map((s: any) => ({
|
return (cdlist[0].songlist ?? []).map((s: any) => ({
|
||||||
id: String(s.mid ?? s.songmid ?? s.songid),
|
id: String(s.songmid ?? s.songid),
|
||||||
name: s.songname ?? s.name ?? "",
|
name: s.songname ?? s.name ?? "",
|
||||||
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
artist: (s.singer ?? []).map((a: any) => a.name).join(" / "),
|
||||||
album: s.albumname ?? "",
|
album: s.albumname ?? "",
|
||||||
duration: s.interval ?? 0,
|
duration: s.interval ?? 0,
|
||||||
coverUrl: s.album?.mid
|
coverUrl: s.albummid
|
||||||
? `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`
|
? `https://y.gtimg.cn/music/photo_new/T002R300x300M000${s.albummid}.jpg`
|
||||||
: "",
|
: "",
|
||||||
platform: "qq",
|
platform: "qq",
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
async getPlaylistDetail(playlistId: string): Promise<PlaylistDetail | null> {
|
|
||||||
const res = await this.api.get("/getSongListDetail", {
|
|
||||||
params: { disstid: playlistId, ...this.cookieParams },
|
|
||||||
});
|
|
||||||
const cd = res.data?.response?.cdlist?.[0];
|
|
||||||
if (!cd) return null;
|
|
||||||
return {
|
|
||||||
id: String(cd.disstid ?? cd.dissid ?? ""),
|
|
||||||
name: cd.dissname ?? "",
|
|
||||||
description: cd.desc ?? "",
|
|
||||||
coverUrl: cd.logo ?? "",
|
|
||||||
songCount: cd.songnum ?? cd.total_song_num ?? 0,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async getRecommendPlaylists(): Promise<Playlist[]> {
|
async getRecommendPlaylists(): Promise<Playlist[]> {
|
||||||
const res = await this.api.get("/getSongLists", {
|
const res = await this.api.get("/getSongLists", {
|
||||||
params: { categoryId: 10000000, pageSize: 10, ...this.cookieParams },
|
params: { categoryId: 10000000, pageSize: 10, ...this.cookieParams },
|
||||||
@@ -410,53 +152,30 @@ export class QQMusicProvider implements MusicProvider {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async getQrCode(): Promise<QrCodeResult> {
|
async getQrCode(): Promise<QrCodeResult> {
|
||||||
// @sansenjian/qq-music-api 2.x returns { img, qrsig, ptqrtoken } via
|
|
||||||
// customResponse (no { response: ... } wrapping). /checkQQLoginQr
|
|
||||||
// requires BOTH qrsig AND ptqrtoken — passing only one gives a 400
|
|
||||||
// "参数错误". Pack both into the opaque `key` field so the polling
|
|
||||||
// endpoint can split them back out. Separator "|" is safe: QQ tokens
|
|
||||||
// are alphanumeric.
|
|
||||||
const res = await this.api.get("/getQQLoginQr");
|
const res = await this.api.get("/getQQLoginQr");
|
||||||
const qrsig: string = res.data?.qrsig ?? "";
|
|
||||||
const ptqrtoken: string = String(res.data?.ptqrtoken ?? "");
|
|
||||||
return {
|
return {
|
||||||
qrUrl: "",
|
qrUrl: "",
|
||||||
qrImg: res.data?.img ?? "",
|
qrImg: res.data?.img ?? "",
|
||||||
key: `${qrsig}|${ptqrtoken}`,
|
key: res.data?.qrsig ?? res.data?.ptqrtoken ?? "",
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
async checkQrCodeStatus(
|
async checkQrCodeStatus(
|
||||||
key: string
|
key: string
|
||||||
): Promise<"waiting" | "scanned" | "confirmed" | "expired"> {
|
): Promise<"waiting" | "scanned" | "confirmed" | "expired"> {
|
||||||
const [qrsig, ptqrtoken] = key.split("|");
|
const res = await this.api.get("/checkQQLoginQr", {
|
||||||
if (!qrsig || !ptqrtoken) return "expired";
|
params: { qrsig: key },
|
||||||
|
});
|
||||||
// NOTE: /checkQQLoginQr is registered as POST only in
|
const code = res.data?.code ?? res.data?.response?.code;
|
||||||
// @sansenjian/qq-music-api 2.x. GET returns 405 Method Not Allowed.
|
if (code === 0) {
|
||||||
let res;
|
if (res.data?.cookie) {
|
||||||
try {
|
this.cookie = res.data.cookie;
|
||||||
res = await this.api.post("/checkQQLoginQr", null, {
|
}
|
||||||
params: { qrsig, ptqrtoken },
|
|
||||||
});
|
|
||||||
} catch {
|
|
||||||
return "expired";
|
|
||||||
}
|
|
||||||
|
|
||||||
// customResponse shape:
|
|
||||||
// success: { isOk: true, message: '登录成功', session: { cookie, ... } }
|
|
||||||
// scanning: { isOk: false, refresh: false, message: '未扫描二维码' }
|
|
||||||
// expired: { isOk: false, refresh: true, message: '二维码已失效' }
|
|
||||||
const body = res.data;
|
|
||||||
if (body?.isOk === true) {
|
|
||||||
const cookie: string = body.session?.cookie ?? "";
|
|
||||||
if (cookie) this.cookie = cookie;
|
|
||||||
return "confirmed";
|
return "confirmed";
|
||||||
}
|
}
|
||||||
if (body?.refresh === true) return "expired";
|
if (code === 1) return "scanned";
|
||||||
if (typeof body?.message === "string" && body.message.includes("未扫描"))
|
if (code === 2) return "waiting";
|
||||||
return "waiting";
|
return "expired";
|
||||||
return "waiting";
|
|
||||||
}
|
}
|
||||||
|
|
||||||
setCookie(cookie: string): void {
|
setCookie(cookie: string): void {
|
||||||
@@ -469,145 +188,20 @@ export class QQMusicProvider implements MusicProvider {
|
|||||||
|
|
||||||
async getAuthStatus(): Promise<AuthStatus> {
|
async getAuthStatus(): Promise<AuthStatus> {
|
||||||
if (!this.cookie) return { loggedIn: false };
|
if (!this.cookie) return { loggedIn: false };
|
||||||
// /getUserAvatar in @sansenjian/qq-music-api 2.x is NOT registered on
|
|
||||||
// the main router; the real endpoint is /user/getUserAvatar, and even
|
|
||||||
// that just builds a static URL from a uin without validating the
|
|
||||||
// cookie against QQ. Round-trip through /user/getUserPlaylists which
|
|
||||||
// actually hits QQ Music with the cookie; if the upstream returns
|
|
||||||
// code=0, the cookie is valid.
|
|
||||||
//
|
|
||||||
// IMPORTANT: /user/getUserPlaylists requires `uin` as a query param —
|
|
||||||
// the library 400s with "缺少 uin 参数" otherwise. Parse it out of the
|
|
||||||
// cookie (uin=<qq>; comes after the various *uin prefixed names, which
|
|
||||||
// is why the regex anchors on a word boundary).
|
|
||||||
const uinMatch = /(?:^|; )uin=o?0?(\d+)/.exec(this.cookie);
|
|
||||||
const uin = uinMatch ? uinMatch[1] : "";
|
|
||||||
if (!uin) return { loggedIn: false };
|
|
||||||
try {
|
try {
|
||||||
const res = await this.api.get("/user/getUserPlaylists", {
|
const res = await this.api.get("/getUserAvatar", {
|
||||||
params: { uin, ...this.cookieParams },
|
|
||||||
});
|
|
||||||
if (res.data?.response?.code !== 0) return { loggedIn: false };
|
|
||||||
return {
|
|
||||||
loggedIn: true,
|
|
||||||
nickname: `QQ ${uin}`,
|
|
||||||
avatarUrl: `https://q.qlogo.cn/headimg_dl?dst_uin=${uin}&spec=100`,
|
|
||||||
};
|
|
||||||
} catch {
|
|
||||||
return { loggedIn: false };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async getDailyRecommendSongs(): Promise<Song[]> {
|
|
||||||
// QQ has no per-user daily list; use newsong.NewSongServer (新歌速递)
|
|
||||||
// as the closest analogue. Returns ~20 newly-released songs.
|
|
||||||
try {
|
|
||||||
const res = await this.api.get("/getNewSongs", {
|
|
||||||
params: { ...this.cookieParams },
|
params: { ...this.cookieParams },
|
||||||
});
|
});
|
||||||
const list: any[] = res.data?.response?.new_song?.data?.songlist ?? [];
|
if (res.data?.response?.data) {
|
||||||
return 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",
|
|
||||||
}));
|
|
||||||
} catch {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async getUserPlaylists(): Promise<Playlist[]> {
|
|
||||||
if (!this.cookie) return [];
|
|
||||||
const uinMatch = /(?:^|; )uin=o?0?(\d+)/.exec(this.cookie);
|
|
||||||
const uin = uinMatch ? uinMatch[1] : "";
|
|
||||||
if (!uin) return [];
|
|
||||||
|
|
||||||
// Created and collected playlists come from two separate QQ endpoints.
|
|
||||||
// Run them in parallel and concatenate (created first, then collected),
|
|
||||||
// matching the order shown in the QQ Music desktop app.
|
|
||||||
const [created, collected] = await Promise.all([
|
|
||||||
this.fetchCreatedPlaylists(uin),
|
|
||||||
this.fetchCollectedPlaylists(uin),
|
|
||||||
]);
|
|
||||||
return [...created, ...collected];
|
|
||||||
}
|
|
||||||
|
|
||||||
private async fetchCreatedPlaylists(uin: string): Promise<Playlist[]> {
|
|
||||||
try {
|
|
||||||
const res = await this.api.get("/user/getUserPlaylists", {
|
|
||||||
params: { uin, ...this.cookieParams },
|
|
||||||
});
|
|
||||||
if (res.data?.response?.code !== 0) return [];
|
|
||||||
return (res.data?.response?.data?.playlists ?? []).map((p: any) => {
|
|
||||||
// fcg_get_profile_homepage returns title/picurl/subtitle ("X首 Y次播放").
|
|
||||||
const subtitle: string = p.subtitle ?? "";
|
|
||||||
const songCountFromSubtitle = parseInt(subtitle.match(/(\d+)\s*首/)?.[1] ?? "0", 10);
|
|
||||||
return {
|
return {
|
||||||
id: String(p.dissid ?? p.id ?? ""),
|
loggedIn: true,
|
||||||
name: p.title ?? p.dissname ?? p.name ?? "",
|
nickname: res.data.response.data.nickname,
|
||||||
coverUrl: p.picurl ?? p.imgurl ?? p.coverUrl ?? "",
|
avatarUrl: res.data.response.data.headpic,
|
||||||
songCount: p.song_count ?? p.listennum ?? songCountFromSubtitle,
|
|
||||||
platform: "qq",
|
|
||||||
};
|
};
|
||||||
});
|
|
||||||
} catch {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private async fetchCollectedPlaylists(uin: string): Promise<Playlist[]> {
|
|
||||||
// c.y.qq.com fav endpoint: reqtype=3 returns collected playlists (cdlist).
|
|
||||||
// Requires g_tk derived from the p_skey cookie.
|
|
||||||
const pSkeyMatch = /(?:^|; )p_skey=([^;]+)/.exec(this.cookie);
|
|
||||||
if (!pSkeyMatch) return [];
|
|
||||||
const gtk = computeGtk(pSkeyMatch[1]);
|
|
||||||
|
|
||||||
const PAGE_SIZE = 30;
|
|
||||||
const MAX_PAGES = 10; // 300-playlist hard cap; should cover any sane user
|
|
||||||
const all: Playlist[] = [];
|
|
||||||
try {
|
|
||||||
for (let page = 0; page < MAX_PAGES; page++) {
|
|
||||||
const sin = page * PAGE_SIZE;
|
|
||||||
const ein = sin + PAGE_SIZE - 1;
|
|
||||||
const res = await qqFavApi.get("/fav/fcgi-bin/fcg_get_profile_order_asset.fcg", {
|
|
||||||
params: {
|
|
||||||
ct: 20,
|
|
||||||
cid: 205360956,
|
|
||||||
userid: uin,
|
|
||||||
reqtype: 3,
|
|
||||||
sin,
|
|
||||||
ein,
|
|
||||||
g_tk: gtk,
|
|
||||||
format: "json",
|
|
||||||
},
|
|
||||||
headers: { Cookie: this.cookie },
|
|
||||||
});
|
|
||||||
if (res.data?.code !== 0) break;
|
|
||||||
const list: any[] = res.data?.data?.cdlist ?? [];
|
|
||||||
for (const p of list) {
|
|
||||||
all.push({
|
|
||||||
id: String(p.dissid ?? ""),
|
|
||||||
name: p.dissname ?? "",
|
|
||||||
coverUrl: p.logo ?? "",
|
|
||||||
songCount: p.songnum ?? 0,
|
|
||||||
platform: "qq",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
// Stop when upstream signals no more pages, or when this page is
|
|
||||||
// short (also indicates end). has_more is the canonical signal.
|
|
||||||
const hasMore = res.data?.data?.has_more === 1 || res.data?.data?.has_more === true;
|
|
||||||
if (!hasMore || list.length < PAGE_SIZE) break;
|
|
||||||
}
|
}
|
||||||
} catch {
|
} catch {
|
||||||
// Return whatever we got so far on partial failure rather than dropping
|
// ignore
|
||||||
// earlier pages.
|
|
||||||
}
|
}
|
||||||
return all;
|
return { loggedIn: false };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,232 +0,0 @@
|
|||||||
import { execFile } from "node:child_process";
|
|
||||||
import { promisify } from "node:util";
|
|
||||||
import { existsSync } from "node:fs";
|
|
||||||
import { fileURLToPath } from "node:url";
|
|
||||||
import { dirname, join } from "node:path";
|
|
||||||
import type {
|
|
||||||
MusicProvider,
|
|
||||||
Song,
|
|
||||||
SongWithUrl,
|
|
||||||
Playlist,
|
|
||||||
Album,
|
|
||||||
SearchResult,
|
|
||||||
LyricLine,
|
|
||||||
QrCodeResult,
|
|
||||||
AuthStatus,
|
|
||||||
} from "./provider.js";
|
|
||||||
|
|
||||||
const execFileAsync = promisify(execFile);
|
|
||||||
|
|
||||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
||||||
|
|
||||||
/** Resolve the yt-dlp binary path. Checks the project bin/ dir first, then PATH. */
|
|
||||||
function findYtDlp(): string {
|
|
||||||
const exe = process.platform === "win32" ? "yt-dlp.exe" : "yt-dlp";
|
|
||||||
const candidates = [
|
|
||||||
join(__dirname, "..", "..", "bin", exe),
|
|
||||||
join(__dirname, "..", "..", "bin", "yt-dlp"),
|
|
||||||
exe,
|
|
||||||
];
|
|
||||||
for (const c of candidates) {
|
|
||||||
// Absolute/relative paths: only return if the file exists.
|
|
||||||
// Bare names: return and let execFile resolve via PATH.
|
|
||||||
const isBinPath = c.includes(join("bin", "yt-dlp"));
|
|
||||||
if (!isBinPath || existsSync(c)) return c;
|
|
||||||
}
|
|
||||||
return exe;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Availability check for yt-dlp. Runs `yt-dlp --version` and caches only
|
|
||||||
* the positive result — if the binary is missing, subsequent calls retry
|
|
||||||
* so the user can install yt-dlp while the server is running and pick it
|
|
||||||
* up without a restart. Used by getAuthStatus() so the UI can reflect
|
|
||||||
* whether YouTube is actually usable.
|
|
||||||
*/
|
|
||||||
let cachedAvailable = false;
|
|
||||||
let pendingCheck: Promise<boolean> | null = null;
|
|
||||||
async function checkYtDlpAvailable(): Promise<boolean> {
|
|
||||||
if (cachedAvailable) return true;
|
|
||||||
if (pendingCheck) return pendingCheck;
|
|
||||||
pendingCheck = (async () => {
|
|
||||||
try {
|
|
||||||
await execFileAsync(findYtDlp(), ["--version"], {
|
|
||||||
timeout: 5_000,
|
|
||||||
maxBuffer: 1024,
|
|
||||||
});
|
|
||||||
cachedAvailable = true;
|
|
||||||
return true;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
} finally {
|
|
||||||
pendingCheck = null;
|
|
||||||
}
|
|
||||||
})();
|
|
||||||
return pendingCheck;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Force re-detection on the next call (for tests). */
|
|
||||||
export function resetYtDlpAvailabilityCache(): void {
|
|
||||||
cachedAvailable = false;
|
|
||||||
pendingCheck = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function runYtDlp(args: string[], timeoutMs = 30_000): Promise<string> {
|
|
||||||
const binary = findYtDlp();
|
|
||||||
const env = { ...process.env };
|
|
||||||
if (process.env.HTTPS_PROXY || process.env.HTTP_PROXY) {
|
|
||||||
// yt-dlp respects these env vars natively
|
|
||||||
}
|
|
||||||
const { stdout } = await execFileAsync(binary, args, {
|
|
||||||
timeout: timeoutMs,
|
|
||||||
env,
|
|
||||||
maxBuffer: 10 * 1024 * 1024,
|
|
||||||
});
|
|
||||||
return stdout;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface YtDlpEntry {
|
|
||||||
id: string;
|
|
||||||
title: string;
|
|
||||||
uploader?: string;
|
|
||||||
channel?: string;
|
|
||||||
duration?: number;
|
|
||||||
thumbnail?: string;
|
|
||||||
webpage_url?: string;
|
|
||||||
url?: string;
|
|
||||||
entries?: YtDlpEntry[];
|
|
||||||
_type?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
function entryToSong(entry: YtDlpEntry): Song {
|
|
||||||
return {
|
|
||||||
id: entry.id ?? "",
|
|
||||||
name: entry.title ?? "Unknown",
|
|
||||||
artist: entry.uploader ?? entry.channel ?? "YouTube",
|
|
||||||
album: "YouTube",
|
|
||||||
duration: Math.round(entry.duration ?? 0),
|
|
||||||
coverUrl: entry.thumbnail ?? "",
|
|
||||||
platform: "youtube",
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export class YouTubeProvider implements MusicProvider {
|
|
||||||
readonly platform = "youtube" as const;
|
|
||||||
private quality = "bestaudio";
|
|
||||||
|
|
||||||
async search(query: string, limit = 5): Promise<SearchResult> {
|
|
||||||
try {
|
|
||||||
const raw = await runYtDlp([
|
|
||||||
`ytsearch${limit}:${query}`,
|
|
||||||
"--dump-json",
|
|
||||||
"--flat-playlist",
|
|
||||||
"--no-warnings",
|
|
||||||
"--quiet",
|
|
||||||
]);
|
|
||||||
const lines = raw.trim().split("\n").filter(Boolean);
|
|
||||||
const songs: Song[] = lines.map((line) => {
|
|
||||||
const entry = JSON.parse(line) as YtDlpEntry;
|
|
||||||
return entryToSong(entry);
|
|
||||||
});
|
|
||||||
return { songs, playlists: [], albums: [] };
|
|
||||||
} catch {
|
|
||||||
return { songs: [], playlists: [], albums: [] };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async getSongUrl(songId: string): Promise<string | null> {
|
|
||||||
try {
|
|
||||||
const url = `https://www.youtube.com/watch?v=${songId}`;
|
|
||||||
const raw = await runYtDlp([
|
|
||||||
url,
|
|
||||||
"--get-url",
|
|
||||||
"-f",
|
|
||||||
"bestaudio[ext=webm]/bestaudio[ext=m4a]/bestaudio",
|
|
||||||
"--no-warnings",
|
|
||||||
"--quiet",
|
|
||||||
], 45_000);
|
|
||||||
const audioUrl = raw.trim().split("\n")[0];
|
|
||||||
return audioUrl || null;
|
|
||||||
} catch {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
setQuality(quality: string): void {
|
|
||||||
this.quality = quality;
|
|
||||||
}
|
|
||||||
|
|
||||||
getQuality(): string {
|
|
||||||
return this.quality;
|
|
||||||
}
|
|
||||||
|
|
||||||
async getSongDetail(songId: string): Promise<Song | null> {
|
|
||||||
try {
|
|
||||||
const url = `https://www.youtube.com/watch?v=${songId}`;
|
|
||||||
const raw = await runYtDlp([url, "--dump-json", "--no-warnings", "--quiet"]);
|
|
||||||
const entry = JSON.parse(raw.trim()) as YtDlpEntry;
|
|
||||||
return entryToSong(entry);
|
|
||||||
} catch {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async getPlaylistSongs(playlistId: string): Promise<Song[]> {
|
|
||||||
try {
|
|
||||||
const url = playlistId.startsWith("http")
|
|
||||||
? playlistId
|
|
||||||
: `https://www.youtube.com/playlist?list=${playlistId}`;
|
|
||||||
const raw = await runYtDlp([
|
|
||||||
url,
|
|
||||||
"--dump-json",
|
|
||||||
"--flat-playlist",
|
|
||||||
"--no-warnings",
|
|
||||||
"--quiet",
|
|
||||||
], 60_000);
|
|
||||||
const lines = raw.trim().split("\n").filter(Boolean);
|
|
||||||
return lines.map((line) => entryToSong(JSON.parse(line) as YtDlpEntry));
|
|
||||||
} catch {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async getRecommendPlaylists(): Promise<Playlist[]> {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
async getAlbumSongs(_albumId: string): Promise<Song[]> {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
async getLyrics(_songId: string): Promise<LyricLine[]> {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
async getQrCode(): Promise<QrCodeResult> {
|
|
||||||
return { qrUrl: "", key: "" };
|
|
||||||
}
|
|
||||||
|
|
||||||
async checkQrCodeStatus(
|
|
||||||
_key: string
|
|
||||||
): Promise<"waiting" | "scanned" | "confirmed" | "expired"> {
|
|
||||||
return "expired";
|
|
||||||
}
|
|
||||||
|
|
||||||
setCookie(_cookie: string): void {}
|
|
||||||
getCookie(): string { return ""; }
|
|
||||||
|
|
||||||
async getAuthStatus(): Promise<AuthStatus> {
|
|
||||||
// YouTube has no login concept via yt-dlp, so "loggedIn" here means
|
|
||||||
// "yt-dlp binary is reachable and responds to --version". The UI can
|
|
||||||
// use this flag to grey out YouTube when the optional dependency is
|
|
||||||
// missing, instead of silently returning empty search results.
|
|
||||||
const available = await checkYtDlpAvailable();
|
|
||||||
if (available) {
|
|
||||||
return { loggedIn: true, nickname: "YouTube (yt-dlp)" };
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
loggedIn: false,
|
|
||||||
nickname: "YouTube (yt-dlp not installed)",
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+7
-185
@@ -1,5 +1,4 @@
|
|||||||
import { EventEmitter } from "node:events";
|
import { EventEmitter } from "node:events";
|
||||||
import { Readable } from "node:stream";
|
|
||||||
import {
|
import {
|
||||||
Client as TS3FullClient,
|
Client as TS3FullClient,
|
||||||
generateIdentity as genTS3Identity,
|
generateIdentity as genTS3Identity,
|
||||||
@@ -8,48 +7,23 @@ import {
|
|||||||
listChannels,
|
listChannels,
|
||||||
listClients,
|
listClients,
|
||||||
clientMove,
|
clientMove,
|
||||||
fileTransferDeleteFile,
|
|
||||||
type Identity,
|
type Identity,
|
||||||
type TextMessage,
|
type TextMessage,
|
||||||
type ClientInfo,
|
type ClientInfo,
|
||||||
type FileUploadInfo,
|
|
||||||
} from "@honeybbq/teamspeak-client";
|
} from "@honeybbq/teamspeak-client";
|
||||||
import type { Logger } from "../logger.js";
|
import type { Logger } from "../logger.js";
|
||||||
import {
|
|
||||||
detectServerProtocol,
|
|
||||||
type ServerProtocol,
|
|
||||||
} from "./protocol-detect.js";
|
|
||||||
import { TS6HttpQuery } from "./http-query.js";
|
|
||||||
|
|
||||||
export { CODEC_OPUS_MUSIC } from "./voice.js";
|
export { CODEC_OPUS_MUSIC } from "./voice.js";
|
||||||
export type { ServerProtocol } from "./protocol-detect.js";
|
|
||||||
export type { FileUploadInfo } from "@honeybbq/teamspeak-client";
|
|
||||||
|
|
||||||
/** Escape a string for use in TS3 ServerQuery-style commands. */
|
|
||||||
export function escapeTS3(str: string): string {
|
|
||||||
return str
|
|
||||||
.replace(/\\/g, "\\\\")
|
|
||||||
.replace(/ /g, "\\s")
|
|
||||||
.replace(/\//g, "\\/")
|
|
||||||
.replace(/\|/g, "\\p")
|
|
||||||
.replace(/\t/g, "\\t")
|
|
||||||
.replace(/\n/g, "\\n")
|
|
||||||
.replace(/\r/g, "\\r");
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface TS3ClientOptions {
|
export interface TS3ClientOptions {
|
||||||
host: string;
|
host: string;
|
||||||
port: number; // Voice/virtual server port (default 9987)
|
port: number; // Voice/virtual server port (default 9987)
|
||||||
queryPort: number; // ServerQuery port (10011 for TS3, 10080 for TS6 HTTP)
|
queryPort: number; // ServerQuery port (default 10011) — unused now, kept for compat
|
||||||
nickname: string;
|
nickname: string;
|
||||||
identity?: string; // Exported identity string, or undefined to generate new
|
identity?: string; // Exported identity string, or undefined to generate new
|
||||||
defaultChannel?: string;
|
defaultChannel?: string;
|
||||||
channelPassword?: string;
|
channelPassword?: string;
|
||||||
serverPassword?: string;
|
serverPassword?: string;
|
||||||
/** Force a specific protocol instead of auto-detecting. */
|
|
||||||
serverProtocol?: ServerProtocol;
|
|
||||||
/** API key for TS6 HTTP Query authentication. */
|
|
||||||
ts6ApiKey?: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface TS3TextMessage {
|
export interface TS3TextMessage {
|
||||||
@@ -66,9 +40,6 @@ export class TS3Client extends EventEmitter {
|
|||||||
private clientId = 0;
|
private clientId = 0;
|
||||||
private logger: Logger;
|
private logger: Logger;
|
||||||
private disconnecting = false;
|
private disconnecting = false;
|
||||||
private detectedProtocol: ServerProtocol = "unknown";
|
|
||||||
private httpQuery: TS6HttpQuery | null = null;
|
|
||||||
private udpErrorTimer: ReturnType<typeof setTimeout> | null = null;
|
|
||||||
|
|
||||||
constructor(private options: TS3ClientOptions, logger: Logger) {
|
constructor(private options: TS3ClientOptions, logger: Logger) {
|
||||||
super();
|
super();
|
||||||
@@ -81,105 +52,25 @@ export class TS3Client extends EventEmitter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The detected (or forced) server protocol after connect(). */
|
|
||||||
getServerProtocol(): ServerProtocol {
|
|
||||||
return this.detectedProtocol;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** TS6 HTTP Query client (available after connecting to a TS6 server). */
|
|
||||||
getHttpQuery(): TS6HttpQuery | null {
|
|
||||||
return this.httpQuery;
|
|
||||||
}
|
|
||||||
|
|
||||||
async connect(): Promise<void> {
|
async connect(): Promise<void> {
|
||||||
// Clean up any existing connection before creating a new one
|
|
||||||
if (this.client) {
|
|
||||||
this.logger.info("Cleaning up previous connection before reconnecting");
|
|
||||||
try {
|
|
||||||
await this.client.disconnect();
|
|
||||||
} catch {
|
|
||||||
// Ignore errors during cleanup
|
|
||||||
}
|
|
||||||
this.client = null;
|
|
||||||
this.clientId = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
const addr = `${this.options.host}:${this.options.port}`;
|
const addr = `${this.options.host}:${this.options.port}`;
|
||||||
|
this.logger.info({ addr }, "Connecting to TeamSpeak server (full client protocol)");
|
||||||
// Detect or use forced protocol
|
|
||||||
if (this.options.serverProtocol && this.options.serverProtocol !== "unknown") {
|
|
||||||
this.detectedProtocol = this.options.serverProtocol;
|
|
||||||
this.logger.info(
|
|
||||||
{ addr, protocol: this.detectedProtocol },
|
|
||||||
"Using forced server protocol",
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
this.logger.info({ addr }, "Detecting server protocol (TS3/TS6)...");
|
|
||||||
const detection = await detectServerProtocol(
|
|
||||||
this.options.host,
|
|
||||||
this.options.port,
|
|
||||||
3000,
|
|
||||||
{ ts3QueryPort: 10011, ts6HttpPort: 10080 },
|
|
||||||
);
|
|
||||||
this.detectedProtocol = detection.protocol;
|
|
||||||
if (this.detectedProtocol === "unknown") {
|
|
||||||
this.logger.warn(
|
|
||||||
{ addr },
|
|
||||||
"Could not detect server protocol (query ports 10011/10080 unreachable). " +
|
|
||||||
"Will attempt voice connection anyway. Use serverProtocol option to force TS3 or TS6.",
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
this.logger.info(
|
|
||||||
{ addr, protocol: this.detectedProtocol, queryPort: detection.queryPort },
|
|
||||||
`Server protocol detected: ${this.detectedProtocol.toUpperCase()}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set up TS6 HTTP Query if applicable
|
|
||||||
if (this.detectedProtocol === "ts6") {
|
|
||||||
const queryPort = this.options.queryPort !== 10011 ? this.options.queryPort : 10080;
|
|
||||||
this.httpQuery = new TS6HttpQuery({
|
|
||||||
host: this.options.host,
|
|
||||||
port: queryPort,
|
|
||||||
apiKey: this.options.ts6ApiKey,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Guard against calling connect() while already connected.
|
|
||||||
// Save detectedProtocol first because disconnect() resets it.
|
|
||||||
if (this.client) {
|
|
||||||
this.logger.warn("connect() called while already connected, disconnecting first");
|
|
||||||
const savedProtocol = this.detectedProtocol;
|
|
||||||
const savedHttpQuery = this.httpQuery;
|
|
||||||
this.disconnect();
|
|
||||||
this.detectedProtocol = savedProtocol;
|
|
||||||
this.httpQuery = savedHttpQuery;
|
|
||||||
// Give the old client a moment to tear down
|
|
||||||
await new Promise((r) => setTimeout(r, 100));
|
|
||||||
}
|
|
||||||
|
|
||||||
this.logger.info(
|
|
||||||
{ addr, protocol: this.detectedProtocol },
|
|
||||||
"Connecting to TeamSpeak server (full client protocol)",
|
|
||||||
);
|
|
||||||
|
|
||||||
// Throttle repeated "udp send error" warnings (fires every 20ms during playback if UDP breaks)
|
// Throttle repeated "udp send error" warnings (fires every 20ms during playback if UDP breaks)
|
||||||
let udpErrorCount = 0;
|
let udpErrorCount = 0;
|
||||||
|
let udpErrorTimer: ReturnType<typeof setTimeout> | null = null;
|
||||||
const throttledWarn = (msg: string, ...args: unknown[]) => {
|
const throttledWarn = (msg: string, ...args: unknown[]) => {
|
||||||
if (typeof msg === "string" && msg.includes("udp send error")) {
|
if (typeof msg === "string" && msg.includes("udp send error")) {
|
||||||
udpErrorCount++;
|
udpErrorCount++;
|
||||||
if (udpErrorCount === 1) {
|
if (udpErrorCount === 1) {
|
||||||
this.logger.warn(msg);
|
this.logger.warn(msg);
|
||||||
// After 2 seconds, log a summary and reset.
|
// After 2 seconds, log a summary and reset
|
||||||
// Clear any previous timer to avoid leaking it.
|
udpErrorTimer = setTimeout(() => {
|
||||||
if (this.udpErrorTimer) clearTimeout(this.udpErrorTimer);
|
|
||||||
this.udpErrorTimer = setTimeout(() => {
|
|
||||||
if (udpErrorCount > 1) {
|
if (udpErrorCount > 1) {
|
||||||
this.logger.warn(`udp send error (repeated ${udpErrorCount} times, connection may be lost)`);
|
this.logger.warn(`udp send error (repeated ${udpErrorCount} times, connection may be lost)`);
|
||||||
}
|
}
|
||||||
udpErrorCount = 0;
|
udpErrorCount = 0;
|
||||||
this.udpErrorTimer = null;
|
udpErrorTimer = null;
|
||||||
}, 2000);
|
}, 2000);
|
||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
@@ -188,9 +79,6 @@ export class TS3Client extends EventEmitter {
|
|||||||
};
|
};
|
||||||
|
|
||||||
this.client = new TS3FullClient(this.identity, addr, this.options.nickname, {
|
this.client = new TS3FullClient(this.identity, addr, this.options.nickname, {
|
||||||
// Forward server password to the protocol library so it can be
|
|
||||||
// included in clientinit for password-protected servers
|
|
||||||
serverPassword: this.options.serverPassword,
|
|
||||||
logger: {
|
logger: {
|
||||||
debug: (msg) => this.logger.debug(msg),
|
debug: (msg) => this.logger.debug(msg),
|
||||||
info: (msg) => this.logger.info(msg),
|
info: (msg) => this.logger.info(msg),
|
||||||
@@ -224,19 +112,9 @@ export class TS3Client extends EventEmitter {
|
|||||||
});
|
});
|
||||||
|
|
||||||
await this.client.connect();
|
await this.client.connect();
|
||||||
// Note: @honeybbq/teamspeak-client 0.2.x ships a universal clientinit
|
|
||||||
// (client_version "3.?.? [Build: 5680278000]" + matching signature)
|
|
||||||
// that works against both TS3 and TS6 servers. The old 3.6.2 monkey-
|
|
||||||
// patch on handler.sendPacket was removed when we bumped to 0.2.1 — it
|
|
||||||
// would have replaced the library's new correct version with a stale
|
|
||||||
// signature and made TS6 handshakes fail.
|
|
||||||
await this.client.waitConnected();
|
await this.client.waitConnected();
|
||||||
this.clientId = this.client.clientID();
|
this.clientId = this.client.clientID();
|
||||||
this.voiceFramesSent = 0;
|
this.logger.info({ clientId: this.clientId }, "Logged in (visible client)");
|
||||||
this.logger.info(
|
|
||||||
{ clientId: this.clientId, protocol: this.detectedProtocol },
|
|
||||||
`Logged in (visible client, ${this.detectedProtocol.toUpperCase()} server)`,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Join default channel if specified
|
// Join default channel if specified
|
||||||
if (this.options.defaultChannel) {
|
if (this.options.defaultChannel) {
|
||||||
@@ -297,56 +175,6 @@ export class TS3Client extends EventEmitter {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Raw command & file transfer pass-through ---
|
|
||||||
|
|
||||||
async execCommand(cmd: string): Promise<void> {
|
|
||||||
if (!this.client) throw new Error("Not connected");
|
|
||||||
await this.client.execCommand(cmd);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Fire a command without waiting for the server's response. */
|
|
||||||
async sendCommandNoWait(cmd: string): Promise<void> {
|
|
||||||
if (!this.client) throw new Error("Not connected");
|
|
||||||
await this.client.sendCommandNoWait(cmd);
|
|
||||||
}
|
|
||||||
|
|
||||||
async execCommandWithResponse(cmd: string): Promise<Record<string, string>[]> {
|
|
||||||
if (!this.client) throw new Error("Not connected");
|
|
||||||
return this.client.execCommandWithResponse(cmd);
|
|
||||||
}
|
|
||||||
|
|
||||||
async fileTransferInitUpload(
|
|
||||||
channelID: bigint,
|
|
||||||
path: string,
|
|
||||||
password: string,
|
|
||||||
size: bigint,
|
|
||||||
overwrite = true,
|
|
||||||
): Promise<FileUploadInfo> {
|
|
||||||
if (!this.client) throw new Error("Not connected");
|
|
||||||
return this.client.fileTransferInitUpload(channelID, path, password, size, overwrite);
|
|
||||||
}
|
|
||||||
|
|
||||||
async uploadFileData(host: string, info: FileUploadInfo, data: Readable): Promise<void> {
|
|
||||||
if (!this.client) throw new Error("Not connected");
|
|
||||||
await this.client.uploadFileData(host, info, data);
|
|
||||||
}
|
|
||||||
|
|
||||||
async fileTransferDeleteFile(channelID: bigint, paths: string[]): Promise<void> {
|
|
||||||
if (!this.client) throw new Error("Not connected");
|
|
||||||
await fileTransferDeleteFile(this.client, channelID, paths);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The server host (needed for file transfer TCP connections). */
|
|
||||||
getHost(): string {
|
|
||||||
return this.options.host;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The current channel ID of this client. */
|
|
||||||
getChannelId(): bigint {
|
|
||||||
if (!this.client) return 0n;
|
|
||||||
return this.client.channelID();
|
|
||||||
}
|
|
||||||
|
|
||||||
private voiceFramesSent = 0;
|
private voiceFramesSent = 0;
|
||||||
|
|
||||||
sendVoiceData(opusFrame: Buffer): void {
|
sendVoiceData(opusFrame: Buffer): void {
|
||||||
@@ -384,12 +212,6 @@ export class TS3Client extends EventEmitter {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
this.clientId = 0;
|
this.clientId = 0;
|
||||||
this.httpQuery = null;
|
|
||||||
this.detectedProtocol = "unknown";
|
|
||||||
if (this.udpErrorTimer) {
|
|
||||||
clearTimeout(this.udpErrorTimer);
|
|
||||||
this.udpErrorTimer = null;
|
|
||||||
}
|
|
||||||
this.logger.info("Disconnected from TeamSpeak server");
|
this.logger.info("Disconnected from TeamSpeak server");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,17 +1,10 @@
|
|||||||
/**
|
|
||||||
* TS3 raw-TCP ServerQuery connection (port 10011).
|
|
||||||
*
|
|
||||||
* @deprecated This module only works with TS3 servers. TS6 servers replaced
|
|
||||||
* the raw-TCP ServerQuery with HTTP/HTTPS (port 10080/10443) and SSH (10022).
|
|
||||||
* For TS6 servers, use {@link ../http-query.js TS6HttpQuery} instead.
|
|
||||||
*/
|
|
||||||
import net from "node:net";
|
import net from "node:net";
|
||||||
import { EventEmitter } from "node:events";
|
import { EventEmitter } from "node:events";
|
||||||
import { encodeCommand, decodeResponse, parseErrorLine } from "./commands.js";
|
import { encodeCommand, decodeResponse, parseErrorLine } from "./commands.js";
|
||||||
|
|
||||||
export interface ConnectionOptions {
|
export interface ConnectionOptions {
|
||||||
host: string;
|
host: string;
|
||||||
port: number; // ServerQuery port: 10011 (TS3) — not available on TS6
|
port: number; // ServerQuery port, typically 10011
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface CommandResult {
|
export interface CommandResult {
|
||||||
|
|||||||
@@ -1,223 +0,0 @@
|
|||||||
import http from "node:http";
|
|
||||||
import https from "node:https";
|
|
||||||
|
|
||||||
export interface HttpQueryOptions {
|
|
||||||
host: string;
|
|
||||||
port: number; // 10080 (HTTP) or 10443 (HTTPS)
|
|
||||||
useTls?: boolean;
|
|
||||||
apiKey?: string;
|
|
||||||
timeoutMs?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface HttpQueryResult {
|
|
||||||
status: number;
|
|
||||||
body: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Thrown when the TS6 HTTP Query returns a non-2xx status.
|
|
||||||
*
|
|
||||||
* The previous implementation silently ignored the status code, so a 400
|
|
||||||
* (bad parameter) or 403 (insufficient permission) looked identical to
|
|
||||||
* success in logs. Callers that rely on the response being applied —
|
|
||||||
* nickname / description / away-status updates — should catch this and
|
|
||||||
* surface it rather than log "updated" for a request that was rejected.
|
|
||||||
*/
|
|
||||||
export class HttpQueryError extends Error {
|
|
||||||
readonly status: number;
|
|
||||||
readonly body: unknown;
|
|
||||||
readonly path: string;
|
|
||||||
|
|
||||||
constructor(path: string, status: number, body: unknown) {
|
|
||||||
const bodySnippet = (() => {
|
|
||||||
if (body == null) return "";
|
|
||||||
const s = typeof body === "string" ? body : JSON.stringify(body);
|
|
||||||
return s.length > 200 ? s.slice(0, 200) + "\u2026" : s;
|
|
||||||
})();
|
|
||||||
super(
|
|
||||||
`TS6 HTTP Query ${path} failed: status=${status}${
|
|
||||||
bodySnippet ? ` body=${bodySnippet}` : ""
|
|
||||||
}`,
|
|
||||||
);
|
|
||||||
this.name = "HttpQueryError";
|
|
||||||
this.status = status;
|
|
||||||
this.body = body;
|
|
||||||
this.path = path;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* TS6 HTTP Query client.
|
|
||||||
*
|
|
||||||
* TeamSpeak 6 Server replaces the TS3 raw-TCP ServerQuery (port 10011)
|
|
||||||
* with an HTTP/HTTPS API on ports 10080/10443.
|
|
||||||
*
|
|
||||||
* Common endpoints (TS6 HTTP Query):
|
|
||||||
* GET / → server info / health check
|
|
||||||
* POST /api-key → create API key
|
|
||||||
* GET /1/serverlist → list virtual servers
|
|
||||||
* GET /1/clientlist?sid={sid} → list clients
|
|
||||||
* POST /1/sendtextmessage → send text message
|
|
||||||
* POST /1/clientmove → move a client
|
|
||||||
* GET /1/channellist?sid={sid} → list channels
|
|
||||||
* POST /1/clientupdate → update client properties
|
|
||||||
*/
|
|
||||||
export class TS6HttpQuery {
|
|
||||||
private options: Required<HttpQueryOptions>;
|
|
||||||
|
|
||||||
constructor(options: HttpQueryOptions) {
|
|
||||||
this.options = {
|
|
||||||
host: options.host,
|
|
||||||
port: options.port,
|
|
||||||
useTls: options.useTls ?? options.port === 10443,
|
|
||||||
apiKey: options.apiKey ?? "",
|
|
||||||
timeoutMs: options.timeoutMs ?? 5000,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async request(
|
|
||||||
method: "GET" | "POST" | "PUT" | "DELETE",
|
|
||||||
path: string,
|
|
||||||
body?: Record<string, unknown>,
|
|
||||||
): Promise<HttpQueryResult> {
|
|
||||||
const { host, port, useTls, apiKey, timeoutMs } = this.options;
|
|
||||||
const transport = useTls ? https : http;
|
|
||||||
|
|
||||||
const headers: Record<string, string> = {
|
|
||||||
Accept: "application/json",
|
|
||||||
};
|
|
||||||
if (apiKey) {
|
|
||||||
headers["x-api-key"] = apiKey;
|
|
||||||
}
|
|
||||||
|
|
||||||
let bodyStr: string | undefined;
|
|
||||||
if (body) {
|
|
||||||
bodyStr = JSON.stringify(body);
|
|
||||||
headers["Content-Type"] = "application/json";
|
|
||||||
headers["Content-Length"] = String(Buffer.byteLength(bodyStr));
|
|
||||||
}
|
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
let settled = false;
|
|
||||||
const fail = (err: Error) => {
|
|
||||||
if (settled) return;
|
|
||||||
settled = true;
|
|
||||||
reject(err);
|
|
||||||
};
|
|
||||||
|
|
||||||
const req = transport.request(
|
|
||||||
{
|
|
||||||
hostname: host,
|
|
||||||
port,
|
|
||||||
path,
|
|
||||||
method,
|
|
||||||
timeout: timeoutMs,
|
|
||||||
headers,
|
|
||||||
rejectUnauthorized: false, // self-signed certs common on self-hosted
|
|
||||||
},
|
|
||||||
(res) => {
|
|
||||||
let data = "";
|
|
||||||
res.setEncoding("utf-8");
|
|
||||||
res.on("data", (chunk: string) => (data += chunk));
|
|
||||||
res.on("error", fail);
|
|
||||||
res.on("end", () => {
|
|
||||||
if (settled) return;
|
|
||||||
settled = true;
|
|
||||||
let parsed: unknown;
|
|
||||||
try {
|
|
||||||
parsed = JSON.parse(data);
|
|
||||||
} catch {
|
|
||||||
parsed = data;
|
|
||||||
}
|
|
||||||
resolve({
|
|
||||||
status: res.statusCode ?? 0,
|
|
||||||
body: parsed,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
req.on("error", fail);
|
|
||||||
req.on("timeout", () => {
|
|
||||||
req.destroy();
|
|
||||||
fail(new Error("TS6 HTTP Query timeout"));
|
|
||||||
});
|
|
||||||
|
|
||||||
if (bodyStr) {
|
|
||||||
req.write(bodyStr);
|
|
||||||
}
|
|
||||||
req.end();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Check if the TS6 HTTP Query is reachable */
|
|
||||||
async healthCheck(): Promise<boolean> {
|
|
||||||
try {
|
|
||||||
const result = await this.request("GET", "/");
|
|
||||||
return result.status >= 200 && result.status < 500;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** List virtual servers */
|
|
||||||
async serverList(): Promise<HttpQueryResult> {
|
|
||||||
return this.request("GET", "/1/serverlist");
|
|
||||||
}
|
|
||||||
|
|
||||||
/** List clients on a virtual server */
|
|
||||||
async clientList(sid = 1): Promise<HttpQueryResult> {
|
|
||||||
return this.request("GET", `/1/clientlist?sid=${sid}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** List channels on a virtual server */
|
|
||||||
async channelList(sid = 1): Promise<HttpQueryResult> {
|
|
||||||
return this.request("GET", `/1/channellist?sid=${sid}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Send a text message */
|
|
||||||
async sendTextMessage(
|
|
||||||
targetMode: number,
|
|
||||||
target: number,
|
|
||||||
msg: string,
|
|
||||||
sid = 1,
|
|
||||||
): Promise<HttpQueryResult> {
|
|
||||||
return this.request("POST", `/1/sendtextmessage?sid=${sid}`, {
|
|
||||||
targetmode: targetMode,
|
|
||||||
target,
|
|
||||||
msg,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Update client properties (e.g., description, nickname, away).
|
|
||||||
*
|
|
||||||
* Throws HttpQueryError on non-2xx responses. The TS6 server returns
|
|
||||||
* 400 for invalid parameters and 403 for insufficient permissions;
|
|
||||||
* prior to this check the errors were silently dropped and callers
|
|
||||||
* logged a false "updated" success.
|
|
||||||
*/
|
|
||||||
async clientUpdate(
|
|
||||||
properties: Record<string, string | number>,
|
|
||||||
sid = 1,
|
|
||||||
): Promise<HttpQueryResult> {
|
|
||||||
const path = `/1/clientupdate?sid=${sid}`;
|
|
||||||
const result = await this.request("POST", path, properties);
|
|
||||||
if (result.status < 200 || result.status >= 300) {
|
|
||||||
throw new HttpQueryError(path, result.status, result.body);
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Move a client to a channel */
|
|
||||||
async clientMove(
|
|
||||||
clid: number,
|
|
||||||
cid: number,
|
|
||||||
cpw?: string,
|
|
||||||
sid = 1,
|
|
||||||
): Promise<HttpQueryResult> {
|
|
||||||
const body: Record<string, unknown> = { clid, cid };
|
|
||||||
if (cpw) body.cpw = cpw;
|
|
||||||
return this.request("POST", `/1/clientmove?sid=${sid}`, body);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
import { describe, it, expect } from "vitest";
|
|
||||||
import {
|
|
||||||
detectServerProtocol,
|
|
||||||
type ServerProtocol,
|
|
||||||
type ProtocolDetectResult,
|
|
||||||
} from "./protocol-detect.js";
|
|
||||||
|
|
||||||
describe("protocol-detect", () => {
|
|
||||||
it("returns unknown for unreachable hosts", async () => {
|
|
||||||
const result = await detectServerProtocol("192.0.2.1", 9987, 1000);
|
|
||||||
expect(result.protocol).toBe("unknown");
|
|
||||||
expect(result.queryPort).toBeNull();
|
|
||||||
expect(result.voicePort).toBe(9987);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("result shape matches ProtocolDetectResult interface", async () => {
|
|
||||||
const result = await detectServerProtocol("127.0.0.1", 9987, 500);
|
|
||||||
expect(result).toHaveProperty("protocol");
|
|
||||||
expect(result).toHaveProperty("queryPort");
|
|
||||||
expect(result).toHaveProperty("voicePort");
|
|
||||||
expect(["ts3", "ts6", "unknown"]).toContain(result.protocol);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,128 +0,0 @@
|
|||||||
import net from "node:net";
|
|
||||||
import http from "node:http";
|
|
||||||
|
|
||||||
export type ServerProtocol = "ts3" | "ts6" | "unknown";
|
|
||||||
|
|
||||||
export interface ProtocolDetectResult {
|
|
||||||
protocol: ServerProtocol;
|
|
||||||
/** The query port that responded (10011 for TS3, 10080 for TS6 HTTP) */
|
|
||||||
queryPort: number | null;
|
|
||||||
/** Whether the voice port (UDP 9987) is the same for both */
|
|
||||||
voicePort: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface DetectOptions {
|
|
||||||
/** TS3 ServerQuery probe port (default: 10011) */
|
|
||||||
ts3QueryPort?: number;
|
|
||||||
/** TS6 HTTP Query probe port (default: 10080) */
|
|
||||||
ts6HttpPort?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Probe a TeamSpeak server to determine if it's running TS3 or TS6.
|
|
||||||
*
|
|
||||||
* Detection strategy:
|
|
||||||
* 1. Try TCP connect to port 10011 (TS3 ServerQuery) — if banner starts with "TS3", it's TS3.
|
|
||||||
* 2. Try HTTP GET to port 10080 (TS6 HTTP Query) — if we get a valid HTTP response, it's TS6.
|
|
||||||
* 3. If neither responds, return "unknown" (voice-only connection may still work).
|
|
||||||
*/
|
|
||||||
export async function detectServerProtocol(
|
|
||||||
host: string,
|
|
||||||
voicePort = 9987,
|
|
||||||
timeoutMs = 3000,
|
|
||||||
options?: DetectOptions,
|
|
||||||
): Promise<ProtocolDetectResult> {
|
|
||||||
const ts3Port = options?.ts3QueryPort ?? 10011;
|
|
||||||
const ts6Port = options?.ts6HttpPort ?? 10080;
|
|
||||||
|
|
||||||
const [ts3, ts6] = await Promise.allSettled([
|
|
||||||
probeTS3Query(host, ts3Port, timeoutMs),
|
|
||||||
probeTS6HttpQuery(host, ts6Port, timeoutMs),
|
|
||||||
]);
|
|
||||||
|
|
||||||
// Prefer TS3 if both somehow respond (shouldn't happen in practice)
|
|
||||||
if (ts3.status === "fulfilled" && ts3.value) {
|
|
||||||
return { protocol: "ts3", queryPort: ts3Port, voicePort };
|
|
||||||
}
|
|
||||||
if (ts6.status === "fulfilled" && ts6.value) {
|
|
||||||
return { protocol: "ts6", queryPort: ts6Port, voicePort };
|
|
||||||
}
|
|
||||||
|
|
||||||
return { protocol: "unknown", queryPort: null, voicePort };
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Probe TS3 ServerQuery by connecting to raw TCP and checking for "TS3" banner.
|
|
||||||
*/
|
|
||||||
function probeTS3Query(host: string, port: number, timeoutMs: number): Promise<boolean> {
|
|
||||||
return new Promise((resolve) => {
|
|
||||||
let resolved = false;
|
|
||||||
const done = (value: boolean) => {
|
|
||||||
if (resolved) return;
|
|
||||||
resolved = true;
|
|
||||||
socket.removeAllListeners();
|
|
||||||
socket.destroy();
|
|
||||||
resolve(value);
|
|
||||||
};
|
|
||||||
|
|
||||||
const socket = net.createConnection({ host, port, timeout: timeoutMs });
|
|
||||||
let banner = "";
|
|
||||||
const MAX_BANNER = 256; // TS3 banner is ~50 bytes; cap to avoid memory abuse
|
|
||||||
|
|
||||||
socket.setTimeout(timeoutMs);
|
|
||||||
|
|
||||||
socket.on("data", (data: Buffer) => {
|
|
||||||
banner += data.toString("utf-8");
|
|
||||||
if (banner.length > MAX_BANNER) banner = banner.slice(0, MAX_BANNER);
|
|
||||||
if (banner.includes("TS3")) {
|
|
||||||
done(true);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
socket.on("connect", () => {
|
|
||||||
// Wait briefly for banner after TCP connect
|
|
||||||
setTimeout(() => done(banner.includes("TS3")), 500);
|
|
||||||
});
|
|
||||||
|
|
||||||
socket.on("error", () => done(false));
|
|
||||||
socket.on("timeout", () => done(false));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Probe TS6 HTTP Query by sending GET / and checking for a valid response.
|
|
||||||
* Any HTTP status (including 401/403) confirms the TS6 HTTP Query exists.
|
|
||||||
*/
|
|
||||||
function probeTS6HttpQuery(host: string, port: number, timeoutMs: number): Promise<boolean> {
|
|
||||||
return new Promise((resolve) => {
|
|
||||||
let resolved = false;
|
|
||||||
const done = (value: boolean) => {
|
|
||||||
if (resolved) return;
|
|
||||||
resolved = true;
|
|
||||||
resolve(value);
|
|
||||||
};
|
|
||||||
|
|
||||||
const req = http.request(
|
|
||||||
{
|
|
||||||
hostname: host,
|
|
||||||
port,
|
|
||||||
path: "/",
|
|
||||||
method: "GET",
|
|
||||||
timeout: timeoutMs,
|
|
||||||
headers: { Accept: "application/json" },
|
|
||||||
},
|
|
||||||
(res) => {
|
|
||||||
res.resume();
|
|
||||||
done(res.statusCode !== undefined);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
req.on("error", () => done(false));
|
|
||||||
req.on("timeout", () => {
|
|
||||||
req.destroy();
|
|
||||||
done(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
req.end();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import cookieParser from "cookie-parser";
|
|
||||||
import request from "supertest";
|
|
||||||
import { createDatabase, type BotDatabase } from "../../data/database.js";
|
|
||||||
import { createUserStore } from "../../data/users.js";
|
|
||||||
import { createSessionStore } from "../../data/sessions.js";
|
|
||||||
import { createAuditStore } from "../../data/audit.js";
|
|
||||||
import { createRequireAuth } from "../middleware/requireAuth.js";
|
|
||||||
import { createAuditRouter } from "./audit.js";
|
|
||||||
import { SESSION_COOKIE_NAME } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
describe("audit router", () => {
|
|
||||||
let botDb: BotDatabase;
|
|
||||||
let app: express.Express;
|
|
||||||
let cookie: string;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
botDb = createDatabase(":memory:");
|
|
||||||
const users = createUserStore(botDb.db);
|
|
||||||
const sessions = createSessionStore(botDb.db);
|
|
||||||
const audit = createAuditStore(botDb.db);
|
|
||||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
cookie = `${SESSION_COOKIE_NAME}=${sessions.createSession(alice.id).token}`;
|
|
||||||
for (let i = 0; i < 3; i++) {
|
|
||||||
audit.record({
|
|
||||||
actorId: alice.id, actorUsername: "alice",
|
|
||||||
targetUserId: "x", targetUsername: "x",
|
|
||||||
action: "user.created",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
app = express();
|
|
||||||
app.use(express.json());
|
|
||||||
app.use(cookieParser());
|
|
||||||
app.use("/api", createRequireAuth(sessions));
|
|
||||||
app.use("/api/audit", createAuditRouter(audit));
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => botDb.close());
|
|
||||||
|
|
||||||
it("requires auth", async () => {
|
|
||||||
const res = await request(app).get("/api/audit");
|
|
||||||
expect(res.status).toBe(401);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("returns entries newest-first", async () => {
|
|
||||||
const res = await request(app).get("/api/audit").set("Cookie", cookie);
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.body.entries).toHaveLength(3);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("honors limit query param", async () => {
|
|
||||||
const res = await request(app).get("/api/audit?limit=1").set("Cookie", cookie);
|
|
||||||
expect(res.body.entries).toHaveLength(1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
import { Router } from "express";
|
|
||||||
import type { AuditStore } from "../../data/audit.js";
|
|
||||||
|
|
||||||
export function createAuditRouter(audit: AuditStore): Router {
|
|
||||||
const router = Router();
|
|
||||||
router.get("/", (req, res) => {
|
|
||||||
const limit = clampInt(req.query.limit, 1, 500, 100);
|
|
||||||
const offset = clampInt(req.query.offset, 0, 100_000, 0);
|
|
||||||
res.json({ entries: audit.list(limit, offset) });
|
|
||||||
});
|
|
||||||
return router;
|
|
||||||
}
|
|
||||||
|
|
||||||
function clampInt(v: unknown, min: number, max: number, def: number): number {
|
|
||||||
const n = typeof v === "string" ? parseInt(v, 10) : NaN;
|
|
||||||
if (!Number.isFinite(n)) return def;
|
|
||||||
return Math.min(Math.max(n, min), max);
|
|
||||||
}
|
|
||||||
@@ -1,6 +1,5 @@
|
|||||||
import { Router } from "express";
|
import { Router } from "express";
|
||||||
import type { MusicProvider } from "../../music/provider.js";
|
import type { MusicProvider } from "../../music/provider.js";
|
||||||
import { YouTubeProvider } from "../../music/youtube.js";
|
|
||||||
import type { CookieStore } from "../../music/auth.js";
|
import type { CookieStore } from "../../music/auth.js";
|
||||||
import type { Logger } from "../../logger.js";
|
import type { Logger } from "../../logger.js";
|
||||||
|
|
||||||
@@ -12,13 +11,9 @@ export function createAuthRouter(
|
|||||||
cookieStore?: CookieStore
|
cookieStore?: CookieStore
|
||||||
): Router {
|
): Router {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
// YouTube is auth-less; we only use this instance so /auth/status can
|
|
||||||
// report whether yt-dlp is actually installed (loggedIn=false otherwise).
|
|
||||||
const youtubeProvider: MusicProvider = new YouTubeProvider();
|
|
||||||
|
|
||||||
function getProvider(platform?: string): MusicProvider {
|
function getProvider(platform?: string): MusicProvider {
|
||||||
if (platform === "bilibili") return bilibiliProvider;
|
if (platform === "bilibili") return bilibiliProvider;
|
||||||
if (platform === "youtube") return youtubeProvider;
|
|
||||||
return platform === "qq" ? qqProvider : neteaseProvider;
|
return platform === "qq" ? qqProvider : neteaseProvider;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -124,14 +119,6 @@ export function createAuthRouter(
|
|||||||
res.status(400).json({ error: "cookie is required" });
|
res.status(400).json({ error: "cookie is required" });
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
// YouTube has no cookie concept — reject instead of falling through and
|
|
||||||
// clobbering the NetEase cookie entry.
|
|
||||||
if (platform === "youtube") {
|
|
||||||
res
|
|
||||||
.status(400)
|
|
||||||
.json({ error: "YouTube does not use cookies (uses yt-dlp binary)" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const provider = getProvider(platform);
|
const provider = getProvider(platform);
|
||||||
provider.setCookie(cookie);
|
provider.setCookie(cookie);
|
||||||
const plat = platform === "bilibili" ? "bilibili" as const
|
const plat = platform === "bilibili" ? "bilibili" as const
|
||||||
|
|||||||
Executable → Regular
+3
-96
@@ -1,18 +1,12 @@
|
|||||||
import { Router } from "express";
|
import { Router } from "express";
|
||||||
import type { BotManager } from "../../bot/manager.js";
|
import type { BotManager } from "../../bot/manager.js";
|
||||||
import type { BotConfig } from "../../data/config.js";
|
import type { BotConfig } from "../../data/config.js";
|
||||||
import { saveConfig } from "../../data/config.js";
|
|
||||||
import type { Logger } from "../../logger.js";
|
import type { Logger } from "../../logger.js";
|
||||||
import type { BotDatabase } from "../../data/database.js";
|
|
||||||
import type { AvatarStore } from "../../data/avatars.js";
|
|
||||||
|
|
||||||
export function createBotRouter(
|
export function createBotRouter(
|
||||||
botManager: BotManager,
|
botManager: BotManager,
|
||||||
config: BotConfig,
|
config: BotConfig,
|
||||||
configPath: string,
|
logger: Logger
|
||||||
logger: Logger,
|
|
||||||
botDb: BotDatabase,
|
|
||||||
avatarStore: AvatarStore,
|
|
||||||
): Router {
|
): Router {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
@@ -40,70 +34,6 @@ export function createBotRouter(
|
|||||||
res.json(saved);
|
res.json(saved);
|
||||||
});
|
});
|
||||||
|
|
||||||
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 exists =
|
|
||||||
botManager.getBot(req.params.id) ||
|
|
||||||
botDb.getBotInstances().some((b) => b.id === req.params.id);
|
|
||||||
if (!exists) {
|
|
||||||
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] as string;
|
|
||||||
const buf = Buffer.from(m[2] ?? "", "base64");
|
|
||||||
if (buf.length === 0) {
|
|
||||||
res.status(400).json({ error: "empty image" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
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);
|
|
||||||
botManager.getBot(req.params.id)?.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);
|
|
||||||
botManager.getBot(req.params.id)?.getProfileManager().setCustomAvatar(null);
|
|
||||||
res.status(204).end();
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/", async (req, res) => {
|
router.post("/", async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const {
|
const {
|
||||||
@@ -113,7 +43,6 @@ export function createBotRouter(
|
|||||||
nickname,
|
nickname,
|
||||||
defaultChannel,
|
defaultChannel,
|
||||||
channelPassword,
|
channelPassword,
|
||||||
serverPassword,
|
|
||||||
autoStart,
|
autoStart,
|
||||||
} = req.body;
|
} = req.body;
|
||||||
if (!name || !serverAddress || !nickname) {
|
if (!name || !serverAddress || !nickname) {
|
||||||
@@ -129,7 +58,6 @@ export function createBotRouter(
|
|||||||
nickname,
|
nickname,
|
||||||
defaultChannel,
|
defaultChannel,
|
||||||
channelPassword,
|
channelPassword,
|
||||||
serverPassword,
|
|
||||||
autoStart: autoStart ?? false,
|
autoStart: autoStart ?? false,
|
||||||
});
|
});
|
||||||
res.status(201).json(bot.getStatus());
|
res.status(201).json(bot.getStatus());
|
||||||
@@ -147,10 +75,10 @@ export function createBotRouter(
|
|||||||
res.status(404).json({ error: "Bot not found" });
|
res.status(404).json({ error: "Bot not found" });
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const { name, serverAddress, serverPort, nickname, defaultChannel, channelPassword, serverPassword } = req.body;
|
const { name, serverAddress, serverPort, nickname, defaultChannel, channelPassword } = req.body;
|
||||||
// Update in database
|
// Update in database
|
||||||
botManager.updateBot(req.params.id, {
|
botManager.updateBot(req.params.id, {
|
||||||
name, serverAddress, serverPort, nickname, defaultChannel, channelPassword, serverPassword,
|
name, serverAddress, serverPort, nickname, defaultChannel, channelPassword,
|
||||||
});
|
});
|
||||||
res.json({ success: true });
|
res.json({ success: true });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -186,26 +114,5 @@ export function createBotRouter(
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// GET /api/bot/settings — 读取全局 bot 行为设置
|
|
||||||
router.get("/settings", (_req, res) => {
|
|
||||||
res.json({ idleTimeoutMinutes: config.idleTimeoutMinutes ?? 0 });
|
|
||||||
});
|
|
||||||
|
|
||||||
// POST /api/bot/settings — 保存全局 bot 行为设置
|
|
||||||
router.post("/settings", (req, res) => {
|
|
||||||
const { idleTimeoutMinutes } = req.body;
|
|
||||||
if (typeof idleTimeoutMinutes !== "number" || idleTimeoutMinutes < 0) {
|
|
||||||
res.status(400).json({ error: "idleTimeoutMinutes must be a non-negative number" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
config.idleTimeoutMinutes = idleTimeoutMinutes;
|
|
||||||
saveConfig(configPath, config);
|
|
||||||
// 通知所有 bot 实例更新定时器
|
|
||||||
for (const bot of botManager.getAllBots()) {
|
|
||||||
bot.updateIdleTimeout(idleTimeoutMinutes);
|
|
||||||
}
|
|
||||||
res.json({ ok: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
return router;
|
return router;
|
||||||
}
|
}
|
||||||
+29
-22
@@ -1,6 +1,5 @@
|
|||||||
import { Router } from "express";
|
import { Router } from "express";
|
||||||
import type { MusicProvider } from "../../music/provider.js";
|
import type { MusicProvider } from "../../music/provider.js";
|
||||||
import { YouTubeProvider } from "../../music/youtube.js";
|
|
||||||
import type { Logger } from "../../logger.js";
|
import type { Logger } from "../../logger.js";
|
||||||
|
|
||||||
export function createMusicRouter(
|
export function createMusicRouter(
|
||||||
@@ -10,11 +9,9 @@ export function createMusicRouter(
|
|||||||
logger: Logger
|
logger: Logger
|
||||||
): Router {
|
): Router {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
const youtubeProvider: MusicProvider = new YouTubeProvider();
|
|
||||||
|
|
||||||
function getProvider(platform?: string): MusicProvider {
|
function getProvider(platform?: string): MusicProvider {
|
||||||
if (platform === "bilibili") return bilibiliProvider;
|
if (platform === "bilibili") return bilibiliProvider;
|
||||||
if (platform === "youtube") return youtubeProvider;
|
|
||||||
return platform === "qq" ? qqProvider : neteaseProvider;
|
return platform === "qq" ? qqProvider : neteaseProvider;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -52,20 +49,14 @@ export function createMusicRouter(
|
|||||||
]);
|
]);
|
||||||
|
|
||||||
const songs = [
|
const songs = [
|
||||||
...(neteaseResult.status === "fulfilled" ? neteaseResult.value.songs : []),
|
...(neteaseResult.status === "fulfilled"
|
||||||
|
? neteaseResult.value.songs
|
||||||
|
: []),
|
||||||
...(qqResult.status === "fulfilled" ? qqResult.value.songs : []),
|
...(qqResult.status === "fulfilled" ? qqResult.value.songs : []),
|
||||||
...(bilibiliResult.status === "fulfilled" ? bilibiliResult.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 });
|
res.json({ songs });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.error({ err }, "Unified search failed");
|
logger.error({ err }, "Unified search failed");
|
||||||
res.status(500).json({ error: (err as Error).message });
|
res.status(500).json({ error: (err as Error).message });
|
||||||
@@ -174,16 +165,32 @@ export function createMusicRouter(
|
|||||||
router.get("/playlist/:id/detail", async (req, res) => {
|
router.get("/playlist/:id/detail", async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const provider = getProvider(req.query.platform as string);
|
const provider = getProvider(req.query.platform as string);
|
||||||
if (!provider.getPlaylistDetail) {
|
// Use the playlist songs endpoint to get basic info,
|
||||||
res.status(501).json({ error: "Not supported by this provider" });
|
// but we also need detail info (name, cover, description).
|
||||||
return;
|
// For netease, we access the underlying API directly.
|
||||||
|
const nProvider = provider as any;
|
||||||
|
if (nProvider.api) {
|
||||||
|
const cookieParams = nProvider.cookie
|
||||||
|
? { cookie: nProvider.cookie }
|
||||||
|
: {};
|
||||||
|
const detailRes = await nProvider.api.get("/playlist/detail", {
|
||||||
|
params: { id: req.params.id, ...cookieParams },
|
||||||
|
});
|
||||||
|
const p = detailRes.data?.playlist;
|
||||||
|
if (p) {
|
||||||
|
res.json({
|
||||||
|
playlist: {
|
||||||
|
id: String(p.id),
|
||||||
|
name: p.name,
|
||||||
|
description: p.description ?? "",
|
||||||
|
coverUrl: p.coverImgUrl ?? "",
|
||||||
|
songCount: p.trackCount ?? 0,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
const detail = await provider.getPlaylistDetail(req.params.id);
|
res.status(404).json({ error: "Playlist not found" });
|
||||||
if (!detail) {
|
|
||||||
res.status(404).json({ error: "Playlist not found" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
res.json({ playlist: detail });
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.error({ err }, "Get playlist detail failed");
|
logger.error({ err }, "Get playlist detail failed");
|
||||||
res.status(500).json({ error: (err as Error).message });
|
res.status(500).json({ error: (err as Error).message });
|
||||||
|
|||||||
+39
-271
@@ -25,14 +25,6 @@ export function createPlayerRouter(
|
|||||||
next();
|
next();
|
||||||
});
|
});
|
||||||
|
|
||||||
/** Map API platform string to the corresponding command flag. */
|
|
||||||
const platformFlag = (platform: unknown): string => {
|
|
||||||
if (platform === "bilibili") return "-b";
|
|
||||||
if (platform === "qq") return "-q";
|
|
||||||
if (platform === "youtube") return "-y";
|
|
||||||
return "";
|
|
||||||
};
|
|
||||||
|
|
||||||
router.post("/:botId/play", async (req, res) => {
|
router.post("/:botId/play", async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
@@ -41,7 +33,8 @@ export function createPlayerRouter(
|
|||||||
res.status(400).json({ error: "query is required" });
|
res.status(400).json({ error: "query is required" });
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const cmd = parseCommand(`!play ${platformFlag(platform)} ${query}`.trim(), "!");
|
const flags = platform === "bilibili" ? "-b" : platform === "qq" ? "-q" : "";
|
||||||
|
const cmd = parseCommand(`!play ${flags} ${query}`.trim(), "!");
|
||||||
if (!cmd) {
|
if (!cmd) {
|
||||||
res.status(400).json({ error: "Invalid command" });
|
res.status(400).json({ error: "Invalid command" });
|
||||||
return;
|
return;
|
||||||
@@ -57,7 +50,8 @@ export function createPlayerRouter(
|
|||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { query, platform } = req.body;
|
const { query, platform } = req.body;
|
||||||
const cmd = parseCommand(`!add ${platformFlag(platform)} ${query}`.trim(), "!");
|
const flags = platform === "bilibili" ? "-b" : platform === "qq" ? "-q" : "";
|
||||||
|
const cmd = parseCommand(`!add ${flags} ${query}`.trim(), "!");
|
||||||
if (!cmd) {
|
if (!cmd) {
|
||||||
res.status(400).json({ error: "Invalid command" });
|
res.status(400).json({ error: "Invalid command" });
|
||||||
return;
|
return;
|
||||||
@@ -91,21 +85,7 @@ export function createPlayerRouter(
|
|||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { volume } = req.body;
|
const { volume } = req.body;
|
||||||
// Reject bad input with a proper 4xx instead of letting cmdVol
|
const cmd = parseCommand(`!vol ${volume}`, "!")!;
|
||||||
// return a "Usage:" string inside a 200 body — API clients can't
|
|
||||||
// detect that failure mode, and the UI would silently swallow it.
|
|
||||||
if (
|
|
||||||
typeof volume !== "number" ||
|
|
||||||
!Number.isFinite(volume) ||
|
|
||||||
volume < 0 ||
|
|
||||||
volume > 100
|
|
||||||
) {
|
|
||||||
res
|
|
||||||
.status(400)
|
|
||||||
.json({ error: "volume must be a number between 0 and 100" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const cmd = parseCommand(`!vol ${Math.round(volume)}`, "!")!;
|
|
||||||
const response = await bot.executeCommand(cmd);
|
const response = await bot.executeCommand(cmd);
|
||||||
res.json({ message: response });
|
res.json({ message: response });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -113,18 +93,10 @@ export function createPlayerRouter(
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const VALID_MODES = new Set(["seq", "loop", "random", "rloop"]);
|
|
||||||
|
|
||||||
router.post("/:botId/mode", async (req, res) => {
|
router.post("/:botId/mode", async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { mode } = req.body;
|
const { mode } = req.body;
|
||||||
if (typeof mode !== "string" || !VALID_MODES.has(mode)) {
|
|
||||||
res
|
|
||||||
.status(400)
|
|
||||||
.json({ error: "mode must be one of: seq, loop, random, rloop" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const cmd = parseCommand(`!mode ${mode}`, "!")!;
|
const cmd = parseCommand(`!mode ${mode}`, "!")!;
|
||||||
const response = await bot.executeCommand(cmd);
|
const response = await bot.executeCommand(cmd);
|
||||||
res.json({ message: response });
|
res.json({ message: response });
|
||||||
@@ -144,12 +116,8 @@ export function createPlayerRouter(
|
|||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { position } = req.body; // seconds
|
const { position } = req.body; // seconds
|
||||||
// typeof NaN === "number" and NaN < 0 is false, so a plain range
|
if (typeof position !== "number" || position < 0) {
|
||||||
// check lets NaN/Infinity through and later corrupts seekOffset.
|
res.status(400).json({ error: "position (seconds) is required" });
|
||||||
if (typeof position !== "number" || !Number.isFinite(position) || position < 0) {
|
|
||||||
res
|
|
||||||
.status(400)
|
|
||||||
.json({ error: "position must be a finite non-negative number" });
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
bot.getPlayer().seek(position);
|
bot.getPlayer().seek(position);
|
||||||
@@ -185,15 +153,7 @@ export function createPlayerRouter(
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const queue = bot.getQueueManager();
|
const queue = bot.getQueueManager();
|
||||||
// Validate the index BEFORE stopping current playback — otherwise an
|
bot.getPlayer().stop(); // Stop current playback first
|
||||||
// invalid index silently kills the user's current song and leaves the
|
|
||||||
// queue idle.
|
|
||||||
if (index >= queue.size()) {
|
|
||||||
res.status(400).json({ error: "Invalid queue index" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
bot.getPlayer().stop();
|
|
||||||
bot.getPlayer().resetFailures();
|
|
||||||
const song = queue.playAt(index);
|
const song = queue.playAt(index);
|
||||||
if (!song) {
|
if (!song) {
|
||||||
res.status(400).json({ error: "Invalid queue index" });
|
res.status(400).json({ error: "Invalid queue index" });
|
||||||
@@ -214,8 +174,9 @@ export function createPlayerRouter(
|
|||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { playlistId, platform } = req.body;
|
const { playlistId, platform } = req.body;
|
||||||
|
const flags = platform === "bilibili" ? "-b" : platform === "qq" ? "-q" : "";
|
||||||
const cmd = parseCommand(
|
const cmd = parseCommand(
|
||||||
`!playlist ${platformFlag(platform)} ${playlistId}`.trim(),
|
`!playlist ${flags} ${playlistId}`.trim(),
|
||||||
"!"
|
"!"
|
||||||
)!;
|
)!;
|
||||||
const response = await bot.executeCommand(cmd);
|
const response = await bot.executeCommand(cmd);
|
||||||
@@ -231,17 +192,14 @@ export function createPlayerRouter(
|
|||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { playlistId, platform } = req.body;
|
const { playlistId, platform } = req.body;
|
||||||
// Use the bot's own provider lookup — it already knows about youtube,
|
const provider = platform === "bilibili" ? bilibiliProvider : platform === "qq" ? qqProvider : neteaseProvider;
|
||||||
// which the router's constructor params did not.
|
if (!provider) {
|
||||||
const provider = bot.getProviderFor(
|
res.status(500).json({ error: "Provider not available" });
|
||||||
platform === "bilibili" || platform === "qq" || platform === "youtube"
|
return;
|
||||||
? platform
|
}
|
||||||
: "netease"
|
|
||||||
);
|
|
||||||
|
|
||||||
// Stop current playback
|
// Stop current playback
|
||||||
bot.getPlayer().stop();
|
bot.getPlayer().stop();
|
||||||
bot.getPlayer().resetFailures();
|
|
||||||
|
|
||||||
const songs = await provider.getPlaylistSongs(playlistId);
|
const songs = await provider.getPlaylistSongs(playlistId);
|
||||||
if (songs.length === 0) {
|
if (songs.length === 0) {
|
||||||
@@ -249,32 +207,9 @@ export function createPlayerRouter(
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// QQ-specific optimization: many users' QQ playlists contain a
|
|
||||||
// large fraction of songs that return result=104003 (region/copyright
|
|
||||||
// restricted). Batch-resolve URLs once and only queue the playable
|
|
||||||
// ones, otherwise the playback retry loop wastes time guessing.
|
|
||||||
let queueable: { id: string }[] = songs;
|
|
||||||
const totalCount = songs.length;
|
|
||||||
const qqLike = provider as { getPlayableSongIds?: (ids: string[]) => Promise<Set<string> | null> };
|
|
||||||
if (typeof qqLike.getPlayableSongIds === "function") {
|
|
||||||
const playable = await qqLike.getPlayableSongIds(songs.map((s: { id: string }) => s.id));
|
|
||||||
if (playable !== null) {
|
|
||||||
// Authoritative answer from upstream — even an empty set means
|
|
||||||
// "we know none are playable", short-circuit immediately rather
|
|
||||||
// than wasting 20+ retries.
|
|
||||||
queueable = songs.filter((s: { id: string }) => playable.has(s.id));
|
|
||||||
}
|
|
||||||
// If null, the batch endpoint itself errored — fall through to
|
|
||||||
// the sequential retry path, which still has a chance.
|
|
||||||
}
|
|
||||||
if (queueable.length === 0) {
|
|
||||||
res.json({ ok: false, message: `歌单 ${totalCount} 首歌曲均无版权可播放（区域/版权限制）` });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const queue = bot.getQueueManager();
|
const queue = bot.getQueueManager();
|
||||||
queue.clear();
|
queue.clear();
|
||||||
for (const song of queueable) {
|
for (const song of songs) {
|
||||||
queue.add({ ...song, platform: provider.platform });
|
queue.add({ ...song, platform: provider.platform });
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -288,192 +223,46 @@ export function createPlayerRouter(
|
|||||||
first = queue.play();
|
first = queue.play();
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the first picked song can't resolve (e.g., QQ song with no
|
if (first) {
|
||||||
// streaming entitlement → result 104003), fall back to playNext's
|
await bot.resolveAndPlay(first);
|
||||||
// retry-skip behavior. Use a higher retry budget than the default
|
|
||||||
// trackEnd auto-advance because user-initiated playlist plays
|
|
||||||
// commonly have long contiguous runs of unplayable songs.
|
|
||||||
let started = first ? await bot.resolveAndPlay(first) : false;
|
|
||||||
if (first && !started) {
|
|
||||||
started = await bot.playNext(20);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const playing = queue.current();
|
res.json({ message: `Loaded ${songs.length} songs. Now playing: ${first?.name ?? "unknown"}` });
|
||||||
const loadedMsg = queueable.length < totalCount
|
|
||||||
? `已加载 ${queueable.length}/${totalCount} 首（其余区域/版权限制）`
|
|
||||||
: `已加载 ${queueable.length} 首`;
|
|
||||||
if (started && playing) {
|
|
||||||
res.json({ ok: true, message: `${loadedMsg}，正在播放：${playing.name}` });
|
|
||||||
} else {
|
|
||||||
res.json({ ok: false, message: `${loadedMsg}，但无法开始播放。` });
|
|
||||||
}
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.error({ err }, "Play playlist failed");
|
logger.error({ err }, "Play playlist failed");
|
||||||
res.status(500).json({ error: (err as Error).message });
|
res.status(500).json({ error: (err as Error).message });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Play an album by ID — mirrors play-playlist but calls getAlbumSongs
|
|
||||||
router.post("/:botId/play-album", async (req, res) => {
|
|
||||||
try {
|
|
||||||
const bot = (req as any).bot;
|
|
||||||
const { albumId, platform } = req.body;
|
|
||||||
const provider = bot.getProviderFor(
|
|
||||||
platform === "bilibili" || platform === "qq" || platform === "youtube"
|
|
||||||
? platform
|
|
||||||
: "netease"
|
|
||||||
);
|
|
||||||
|
|
||||||
// Stop current playback
|
|
||||||
bot.getPlayer().stop();
|
|
||||||
bot.getPlayer().resetFailures();
|
|
||||||
|
|
||||||
const songs = await provider.getAlbumSongs(albumId);
|
|
||||||
if (songs.length === 0) {
|
|
||||||
res.json({ message: "Album is empty" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// QQ-specific optimization: batch-resolve playable IDs to avoid
|
|
||||||
// wasting retries on region/copyright-restricted tracks.
|
|
||||||
let queueable: { id: string }[] = songs;
|
|
||||||
const totalCount = songs.length;
|
|
||||||
const qqLike = provider as { getPlayableSongIds?: (ids: string[]) => Promise<Set<string> | null> };
|
|
||||||
if (typeof qqLike.getPlayableSongIds === "function") {
|
|
||||||
const playable = await qqLike.getPlayableSongIds(songs.map((s: { id: string }) => s.id));
|
|
||||||
if (playable !== null) {
|
|
||||||
queueable = songs.filter((s: { id: string }) => playable.has(s.id));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (queueable.length === 0) {
|
|
||||||
res.json({ ok: false, message: `专辑 ${totalCount} 首歌曲均无版权可播放（区域/版权限制）` });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const queue = bot.getQueueManager();
|
|
||||||
queue.clear();
|
|
||||||
for (const song of queueable) {
|
|
||||||
queue.add({ ...song, platform: provider.platform });
|
|
||||||
}
|
|
||||||
|
|
||||||
const mode = queue.getMode();
|
|
||||||
let first;
|
|
||||||
if (mode === "random" || mode === "rloop") {
|
|
||||||
const idx = Math.floor(Math.random() * queue.size());
|
|
||||||
first = queue.playAt(idx);
|
|
||||||
} else {
|
|
||||||
first = queue.play();
|
|
||||||
}
|
|
||||||
|
|
||||||
let started = first ? await bot.resolveAndPlay(first) : false;
|
|
||||||
if (first && !started) {
|
|
||||||
started = await bot.playNext(20);
|
|
||||||
}
|
|
||||||
|
|
||||||
const playing = queue.current();
|
|
||||||
const loadedMsg = queueable.length < totalCount
|
|
||||||
? `已加载 ${queueable.length}/${totalCount} 首（其余区域/版权限制）`
|
|
||||||
: `已加载 ${queueable.length} 首`;
|
|
||||||
if (started && playing) {
|
|
||||||
res.json({ ok: true, message: `${loadedMsg}，正在播放：${playing.name}` });
|
|
||||||
} else {
|
|
||||||
res.json({ ok: false, message: `${loadedMsg}，但无法开始播放。` });
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
logger.error({ err }, "play-album failed");
|
|
||||||
res.status(500).json({ error: (err as Error).message });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Play a single song by ID — resolves URL on demand
|
// Play a single song by ID — resolves URL on demand
|
||||||
router.post("/:botId/play-song", async (req, res) => {
|
router.post("/:botId/play-by-id", async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { song } = req.body;
|
const { songId, platform } = req.body;
|
||||||
if (!song || !song.id || !song.platform) {
|
const provider = platform === "bilibili" ? bilibiliProvider : platform === "qq" ? qqProvider : neteaseProvider;
|
||||||
res.status(400).json({ error: "song object with id and platform is required" });
|
if (!provider) {
|
||||||
|
res.status(500).json({ error: "Provider not available" });
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const song = await provider.getSongDetail(songId);
|
||||||
|
if (!song) {
|
||||||
|
res.json({ message: "Song not found" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
const queue = bot.getQueueManager();
|
const queue = bot.getQueueManager();
|
||||||
queue.clear();
|
queue.clear();
|
||||||
queue.add(song);
|
queue.add({ ...song, platform: provider.platform });
|
||||||
queue.play();
|
queue.play();
|
||||||
|
|
||||||
bot.getPlayer().resetFailures();
|
|
||||||
const ok = await bot.resolveAndPlay(queue.current()!);
|
const ok = await bot.resolveAndPlay(queue.current()!);
|
||||||
if (!ok) {
|
if (!ok) {
|
||||||
res.json({ ok: false, message: `无法播放「${song.name || song.id}」（区域/版权限制）` });
|
res.json({ message: `Cannot play: ${song.name}` });
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
res.json({ ok: true, message: `正在播放：${song.name || 'Unknown'} - ${song.artist || 'Unknown'}` });
|
res.json({ message: `Now playing: ${song.name} - ${song.artist}` });
|
||||||
} catch (err) {
|
|
||||||
res.status(500).json({ error: (err as Error).message });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Insert a single song to play right after the current one.
|
|
||||||
// If nothing is playing, behaves like /play-song (start immediately).
|
|
||||||
router.post("/:botId/play-next-song", async (req, res) => {
|
|
||||||
try {
|
|
||||||
const bot = (req as any).bot;
|
|
||||||
const { song } = req.body;
|
|
||||||
if (!song || !song.id || !song.platform) {
|
|
||||||
res.status(400).json({ error: "song object with id and platform is required" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const queue = bot.getQueueManager();
|
|
||||||
const wasIdle = bot.getPlayer().getState() === "idle";
|
|
||||||
// Capture the slot addNext WILL insert at, before mutating the queue.
|
|
||||||
// addNext pushes when currentIndex<0 (slot = size); otherwise splices
|
|
||||||
// at currentIndex+1. Using size-1 after addNext was wrong when the
|
|
||||||
// queue had stale currentIndex>=0 while the player was idle (e.g.,
|
|
||||||
// after natural track end without queue.clear()).
|
|
||||||
const insertedAt =
|
|
||||||
queue.getCurrentIndex() < 0 ? queue.size() : queue.getCurrentIndex() + 1;
|
|
||||||
queue.addNext(song);
|
|
||||||
|
|
||||||
if (wasIdle) {
|
|
||||||
// Promote the just-added song to current and start it.
|
|
||||||
queue.playAt(insertedAt);
|
|
||||||
bot.getPlayer().resetFailures();
|
|
||||||
const ok = await bot.resolveAndPlay(queue.current()!);
|
|
||||||
if (!ok) {
|
|
||||||
res.json({ ok: false, message: `无法播放「${song.name || song.id}」（区域/版权限制）` });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
res.json({ ok: true, message: `正在播放：${song.name || 'Unknown'} - ${song.artist || 'Unknown'}` });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
res.json({ ok: true, message: `已加入下一首：${song.name || 'Unknown'} - ${song.artist || 'Unknown'}` });
|
|
||||||
} catch (err) {
|
|
||||||
res.status(500).json({ error: (err as Error).message });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/:botId/add-song", async (req, res) => {
|
|
||||||
try {
|
|
||||||
const bot = (req as any).bot;
|
|
||||||
const { song } = req.body;
|
|
||||||
if (!song || !song.id || !song.platform) {
|
|
||||||
res.status(400).json({ error: "song object with id and platform is required" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const queue = bot.getQueueManager();
|
|
||||||
const wasIdle = bot.getPlayer().getState() === "idle";
|
|
||||||
queue.add(song);
|
|
||||||
|
|
||||||
// If nothing was playing, start this newly-added song immediately.
|
|
||||||
if (wasIdle) {
|
|
||||||
queue.playAt(queue.size() - 1);
|
|
||||||
bot.getPlayer().resetFailures();
|
|
||||||
await bot.resolveAndPlay(queue.current()!);
|
|
||||||
res.json({ message: `Now playing: ${song.name || 'Unknown'} - ${song.artist || 'Unknown'}` });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
res.json({ message: `Added to queue: ${song.name || 'Unknown'} - ${song.artist || 'Unknown'} (position ${queue.size()})` });
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
res.status(500).json({ error: (err as Error).message });
|
res.status(500).json({ error: (err as Error).message });
|
||||||
}
|
}
|
||||||
@@ -484,11 +273,11 @@ export function createPlayerRouter(
|
|||||||
try {
|
try {
|
||||||
const bot = (req as any).bot;
|
const bot = (req as any).bot;
|
||||||
const { songId, platform } = req.body;
|
const { songId, platform } = req.body;
|
||||||
const provider = bot.getProviderFor(
|
const provider = platform === "bilibili" ? bilibiliProvider : platform === "qq" ? qqProvider : neteaseProvider;
|
||||||
platform === "bilibili" || platform === "qq" || platform === "youtube"
|
if (!provider) {
|
||||||
? platform
|
res.status(500).json({ error: "Provider not available" });
|
||||||
: "netease"
|
return;
|
||||||
);
|
}
|
||||||
|
|
||||||
const song = await provider.getSongDetail(songId);
|
const song = await provider.getSongDetail(songId);
|
||||||
if (!song) {
|
if (!song) {
|
||||||
@@ -511,27 +300,6 @@ export function createPlayerRouter(
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// --- Profile config endpoints ---
|
|
||||||
|
|
||||||
router.get("/:botId/profile", (req, res) => {
|
|
||||||
const bot = (req as any).bot;
|
|
||||||
res.json(bot.getProfileManager().getConfig());
|
|
||||||
});
|
|
||||||
|
|
||||||
router.put("/:botId/profile", (req, res) => {
|
|
||||||
try {
|
|
||||||
const bot = (req as any).bot;
|
|
||||||
const pm = bot.getProfileManager();
|
|
||||||
pm.updateConfig(req.body);
|
|
||||||
if (database) {
|
|
||||||
database.saveProfileConfig(bot.id, pm.getConfig());
|
|
||||||
}
|
|
||||||
res.json(pm.getConfig());
|
|
||||||
} catch (err) {
|
|
||||||
res.status(500).json({ error: (err as Error).message });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.get("/:botId/history", (req, res) => {
|
router.get("/:botId/history", (req, res) => {
|
||||||
if (!database) {
|
if (!database) {
|
||||||
res.json({ history: [] });
|
res.json({ history: [] });
|
||||||
|
|||||||
@@ -1,151 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import cookieParser from "cookie-parser";
|
|
||||||
import request from "supertest";
|
|
||||||
import pino from "pino";
|
|
||||||
import { createDatabase, type BotDatabase } from "../../data/database.js";
|
|
||||||
import { createUserStore, type UserStore } from "../../data/users.js";
|
|
||||||
import { createSessionStore, type SessionStore } from "../../data/sessions.js";
|
|
||||||
import { createAuditStore } from "../../data/audit.js";
|
|
||||||
import { createSessionRouter } from "./session.js";
|
|
||||||
import { SESSION_COOKIE_NAME } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
function makeApp(botDb: BotDatabase, users: UserStore, sessions: SessionStore) {
|
|
||||||
const app = express();
|
|
||||||
app.use(express.json());
|
|
||||||
app.use(cookieParser());
|
|
||||||
const audit = createAuditStore(botDb.db);
|
|
||||||
app.use("/api/session", createSessionRouter(users, sessions, audit, pino({ level: "silent" })));
|
|
||||||
return app;
|
|
||||||
}
|
|
||||||
|
|
||||||
function extractCookie(res: request.Response): string {
|
|
||||||
const header = res.headers["set-cookie"];
|
|
||||||
const arr = Array.isArray(header) ? header : header ? [header] : [];
|
|
||||||
const found = arr.find((c) => c.startsWith(`${SESSION_COOKIE_NAME}=`));
|
|
||||||
if (!found) throw new Error("no session cookie set");
|
|
||||||
return found.split(";")[0]; // "tsmb_session=xxxx"
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("session router", () => {
|
|
||||||
let botDb: BotDatabase;
|
|
||||||
let users: UserStore;
|
|
||||||
let sessions: SessionStore;
|
|
||||||
let app: express.Express;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
botDb = createDatabase(":memory:");
|
|
||||||
users = createUserStore(botDb.db);
|
|
||||||
sessions = createSessionStore(botDb.db);
|
|
||||||
app = makeApp(botDb, users, sessions);
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => botDb.close());
|
|
||||||
|
|
||||||
it("GET /needs-setup returns true on an empty db", async () => {
|
|
||||||
const res = await request(app).get("/api/session/needs-setup");
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.body).toEqual({ needsSetup: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /setup creates the first admin, logs them in, and returns false from /needs-setup afterwards", async () => {
|
|
||||||
const setupRes = await request(app)
|
|
||||||
.post("/api/session/setup")
|
|
||||||
.send({ username: "alice", password: "hunter2-hunter2" });
|
|
||||||
expect(setupRes.status).toBe(200);
|
|
||||||
expect(setupRes.body.username).toBe("alice");
|
|
||||||
extractCookie(setupRes);
|
|
||||||
|
|
||||||
const needs = await request(app).get("/api/session/needs-setup");
|
|
||||||
expect(needs.body).toEqual({ needsSetup: false });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /setup returns 409 once a user already exists", async () => {
|
|
||||||
await users.createUser("admin", "pw-admin-pw", "admin");
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/session/setup")
|
|
||||||
.send({ username: "alice", password: "pw" });
|
|
||||||
expect(res.status).toBe(409);
|
|
||||||
expect(res.body).toEqual({ error: "already initialized" });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /login returns 401 with constant-time delay on bad credentials", async () => {
|
|
||||||
await users.createUser("alice", "correct-pw-pw", "admin");
|
|
||||||
const start = Date.now();
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/session/login")
|
|
||||||
.send({ username: "alice", password: "wrong" });
|
|
||||||
expect(res.status).toBe(401);
|
|
||||||
expect(res.body).toEqual({ error: "invalid credentials" });
|
|
||||||
expect(Date.now() - start).toBeGreaterThanOrEqual(200);
|
|
||||||
}, 10_000);
|
|
||||||
|
|
||||||
it("POST /login sets a session cookie on success", async () => {
|
|
||||||
await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/session/login")
|
|
||||||
.send({ username: "alice", password: "pw-alice" });
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.body.username).toBe("alice");
|
|
||||||
extractCookie(res);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("GET /me returns the current user when cookie is present, 401 otherwise", async () => {
|
|
||||||
await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
const loginRes = await request(app)
|
|
||||||
.post("/api/session/login")
|
|
||||||
.send({ username: "alice", password: "pw-alice" });
|
|
||||||
const cookie = extractCookie(loginRes);
|
|
||||||
|
|
||||||
const me = await request(app).get("/api/session/me").set("Cookie", cookie);
|
|
||||||
expect(me.status).toBe(200);
|
|
||||||
expect(me.body.username).toBe("alice");
|
|
||||||
|
|
||||||
const anon = await request(app).get("/api/session/me");
|
|
||||||
expect(anon.status).toBe(401);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /logout deletes the session and clears the cookie", async () => {
|
|
||||||
await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
const loginRes = await request(app)
|
|
||||||
.post("/api/session/login")
|
|
||||||
.send({ username: "alice", password: "pw-alice" });
|
|
||||||
const cookie = extractCookie(loginRes);
|
|
||||||
|
|
||||||
const logout = await request(app).post("/api/session/logout").set("Cookie", cookie);
|
|
||||||
expect(logout.status).toBe(204);
|
|
||||||
|
|
||||||
const me = await request(app).get("/api/session/me").set("Cookie", cookie);
|
|
||||||
expect(me.status).toBe(401);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /change-password requires old password and invalidates other sessions", async () => {
|
|
||||||
const u = await users.createUser("alice", "old-pw-pw", "admin");
|
|
||||||
const cookieA = extractCookie(
|
|
||||||
await request(app).post("/api/session/login").send({ username: "alice", password: "old-pw-pw" })
|
|
||||||
);
|
|
||||||
const cookieB = extractCookie(
|
|
||||||
await request(app).post("/api/session/login").send({ username: "alice", password: "old-pw-pw" })
|
|
||||||
);
|
|
||||||
|
|
||||||
const wrongOld = await request(app)
|
|
||||||
.post("/api/session/change-password")
|
|
||||||
.set("Cookie", cookieA)
|
|
||||||
.send({ oldPassword: "WRONG", newPassword: "newpassword" });
|
|
||||||
expect(wrongOld.status).toBe(401);
|
|
||||||
|
|
||||||
const ok = await request(app)
|
|
||||||
.post("/api/session/change-password")
|
|
||||||
.set("Cookie", cookieA)
|
|
||||||
.send({ oldPassword: "old-pw-pw", newPassword: "newpassword" });
|
|
||||||
expect(ok.status).toBe(204);
|
|
||||||
|
|
||||||
const meA = await request(app).get("/api/session/me").set("Cookie", cookieA);
|
|
||||||
expect(meA.status).toBe(200);
|
|
||||||
|
|
||||||
const meB = await request(app).get("/api/session/me").set("Cookie", cookieB);
|
|
||||||
expect(meB.status).toBe(401);
|
|
||||||
|
|
||||||
expect(u.id).toBe(meA.body.id);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
import { Router } from "express";
|
|
||||||
import type { Request, Response, NextFunction } from "express";
|
|
||||||
import type { Logger } from "../../logger.js";
|
|
||||||
import type { UserStore } from "../../data/users.js";
|
|
||||||
import type { SessionStore } from "../../data/sessions.js";
|
|
||||||
import type { AuditStore } from "../../data/audit.js";
|
|
||||||
import { SESSION_TTL_MS } from "../../data/sessions.js";
|
|
||||||
import { SESSION_COOKIE_NAME, validateSessionFromHeaders, extractSessionToken } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
const FAILED_LOGIN_DELAY_MS = 250;
|
|
||||||
|
|
||||||
function setSessionCookie(res: Response, token: string): void {
|
|
||||||
res.cookie(SESSION_COOKIE_NAME, token, {
|
|
||||||
httpOnly: true,
|
|
||||||
sameSite: "lax",
|
|
||||||
secure: res.req.secure,
|
|
||||||
path: "/",
|
|
||||||
maxAge: SESSION_TTL_MS,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function clearSessionCookie(res: Response): void {
|
|
||||||
res.clearCookie(SESSION_COOKIE_NAME, { path: "/" });
|
|
||||||
}
|
|
||||||
|
|
||||||
function delay(ms: number): Promise<void> {
|
|
||||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
||||||
}
|
|
||||||
|
|
||||||
function isValidUsername(v: unknown): v is string {
|
|
||||||
return typeof v === "string" && /^[A-Za-z0-9_\-.]{3,32}$/.test(v);
|
|
||||||
}
|
|
||||||
|
|
||||||
function isValidPassword(v: unknown): v is string {
|
|
||||||
return typeof v === "string" && v.length >= 8 && v.length <= 200;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseTokenFromCookie(cookieHeader: string | undefined): string | null {
|
|
||||||
if (!cookieHeader) return null;
|
|
||||||
const match = cookieHeader
|
|
||||||
.split(";")
|
|
||||||
.map((p) => p.trim())
|
|
||||||
.find((p) => p.startsWith(`${SESSION_COOKIE_NAME}=`));
|
|
||||||
if (!match) return null;
|
|
||||||
return decodeURIComponent(match.slice(SESSION_COOKIE_NAME.length + 1));
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createSessionRouter(
|
|
||||||
users: UserStore,
|
|
||||||
sessions: SessionStore,
|
|
||||||
audit: AuditStore,
|
|
||||||
logger: Logger
|
|
||||||
): Router {
|
|
||||||
const router = Router();
|
|
||||||
|
|
||||||
const requireAuthInline = (req: Request, res: Response, next: NextFunction) => {
|
|
||||||
const result = validateSessionFromHeaders(req.headers.cookie, sessions);
|
|
||||||
if (!result) {
|
|
||||||
clearSessionCookie(res);
|
|
||||||
res.status(401).json({ error: "unauthenticated" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
req.user = { id: result.userId, username: result.username, role: result.role };
|
|
||||||
const token = extractSessionToken(req.headers.cookie);
|
|
||||||
if (token) setSessionCookie(res, token);
|
|
||||||
next();
|
|
||||||
};
|
|
||||||
|
|
||||||
router.get("/needs-setup", (_req, res) => {
|
|
||||||
res.json({ needsSetup: users.countUsers() === 0 });
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/setup", async (req, res) => {
|
|
||||||
const { username, password } = req.body ?? {};
|
|
||||||
if (users.countUsers() !== 0) {
|
|
||||||
res.status(409).json({ error: "already initialized" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!isValidUsername(username) || !isValidPassword(password)) {
|
|
||||||
res.status(400).json({ error: "invalid username or password" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
const user = await users.createFirstUser(username, password);
|
|
||||||
if (!user) {
|
|
||||||
res.status(409).json({ error: "already initialized" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const { token } = sessions.createSession(user.id);
|
|
||||||
setSessionCookie(res, token);
|
|
||||||
try {
|
|
||||||
audit.record({
|
|
||||||
actorId: user.id, actorUsername: user.username,
|
|
||||||
targetUserId: user.id, targetUsername: user.username,
|
|
||||||
action: "admin.first_created",
|
|
||||||
});
|
|
||||||
} catch (auditErr) {
|
|
||||||
logger.warn({ err: auditErr, action: "admin.first_created" }, "audit insert failed");
|
|
||||||
}
|
|
||||||
logger.info({ userId: user.id, username }, "First admin created");
|
|
||||||
res.json({ id: user.id, username: user.username, role: user.role });
|
|
||||||
} catch (err) {
|
|
||||||
logger.error({ err }, "setup failed");
|
|
||||||
res.status(500).json({ error: "internal" });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/login", async (req, res) => {
|
|
||||||
const { username, password } = req.body ?? {};
|
|
||||||
if (typeof username !== "string" || typeof password !== "string") {
|
|
||||||
res.status(400).json({ error: "invalid request" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const user = users.findByUsername(username);
|
|
||||||
const ok = user ? await users.verifyPassword(password, user.passwordHash) : false;
|
|
||||||
if (!user || !ok) {
|
|
||||||
await delay(FAILED_LOGIN_DELAY_MS);
|
|
||||||
res.status(401).json({ error: "invalid credentials" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const { token } = sessions.createSession(user.id);
|
|
||||||
setSessionCookie(res, token);
|
|
||||||
res.json({ id: user.id, username: user.username, role: user.role });
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/logout", (req, res) => {
|
|
||||||
const token = parseTokenFromCookie(req.headers.cookie);
|
|
||||||
if (token) {
|
|
||||||
sessions.deleteSession(token);
|
|
||||||
}
|
|
||||||
clearSessionCookie(res);
|
|
||||||
res.status(204).end();
|
|
||||||
});
|
|
||||||
|
|
||||||
router.get("/me", requireAuthInline, (req, res) => {
|
|
||||||
res.json(req.user);
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/change-password", requireAuthInline, async (req, res) => {
|
|
||||||
const { oldPassword, newPassword } = req.body ?? {};
|
|
||||||
if (typeof oldPassword !== "string") {
|
|
||||||
res.status(400).json({ error: "invalid request" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const u = users.findById(req.user!.id);
|
|
||||||
if (!u || !(await users.verifyPassword(oldPassword, u.passwordHash))) {
|
|
||||||
await delay(FAILED_LOGIN_DELAY_MS);
|
|
||||||
res.status(401).json({ error: "invalid credentials" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!isValidPassword(newPassword)) {
|
|
||||||
res.status(400).json({ error: "invalid request" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
await users.changePassword(u.id, newPassword);
|
|
||||||
const currentToken = parseTokenFromCookie(req.headers.cookie);
|
|
||||||
sessions.deleteAllForUser(u.id, currentToken ?? undefined);
|
|
||||||
try {
|
|
||||||
audit.record({
|
|
||||||
actorId: u.id, actorUsername: u.username,
|
|
||||||
targetUserId: u.id, targetUsername: u.username,
|
|
||||||
action: "user.password_changed",
|
|
||||||
});
|
|
||||||
} catch (auditErr) {
|
|
||||||
logger.warn({ err: auditErr, action: "user.password_changed" }, "audit insert failed");
|
|
||||||
}
|
|
||||||
res.status(204).end();
|
|
||||||
});
|
|
||||||
|
|
||||||
return router;
|
|
||||||
}
|
|
||||||
@@ -1,257 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import cookieParser from "cookie-parser";
|
|
||||||
import request from "supertest";
|
|
||||||
import pino from "pino";
|
|
||||||
import { createDatabase, type BotDatabase } from "../../data/database.js";
|
|
||||||
import { createUserStore, type UserStore } from "../../data/users.js";
|
|
||||||
import { createSessionStore, type SessionStore } from "../../data/sessions.js";
|
|
||||||
import { createAuditStore } from "../../data/audit.js";
|
|
||||||
import { createRequireAuth } from "../middleware/requireAuth.js";
|
|
||||||
import { createUsersRouter } from "./users.js";
|
|
||||||
import { SESSION_COOKIE_NAME } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
function makeApp(botDb: BotDatabase, users: UserStore, sessions: SessionStore) {
|
|
||||||
const app = express();
|
|
||||||
app.use(express.json());
|
|
||||||
app.use(cookieParser());
|
|
||||||
const requireAuth = createRequireAuth(sessions);
|
|
||||||
const audit = createAuditStore(botDb.db);
|
|
||||||
app.use("/api", requireAuth);
|
|
||||||
app.use("/api/users", createUsersRouter(users, sessions, audit, pino({ level: "silent" })));
|
|
||||||
return app;
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("users router", () => {
|
|
||||||
let botDb: BotDatabase;
|
|
||||||
let users: UserStore;
|
|
||||||
let sessions: SessionStore;
|
|
||||||
let app: express.Express;
|
|
||||||
let aliceId: string;
|
|
||||||
let aliceCookie: string;
|
|
||||||
let bobId: string;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
botDb = createDatabase(":memory:");
|
|
||||||
users = createUserStore(botDb.db);
|
|
||||||
sessions = createSessionStore(botDb.db);
|
|
||||||
app = makeApp(botDb, users, sessions);
|
|
||||||
const alice = await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
aliceId = alice.id;
|
|
||||||
aliceCookie = `${SESSION_COOKIE_NAME}=${sessions.createSession(alice.id).token}`;
|
|
||||||
const bob = await users.createUser("bob", "pw-bob-bob", "member");
|
|
||||||
bobId = bob.id;
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => botDb.close());
|
|
||||||
|
|
||||||
it("requires auth for all routes", async () => {
|
|
||||||
expect((await request(app).get("/api/users")).status).toBe(401);
|
|
||||||
expect((await request(app).post("/api/users").send({ username: "x", password: "yyyyyyyy" })).status).toBe(401);
|
|
||||||
expect((await request(app).delete(`/api/users/${bobId}`)).status).toBe(401);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("GET / lists users with id+username+createdAt, no password hash", async () => {
|
|
||||||
const res = await request(app).get("/api/users").set("Cookie", aliceCookie);
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.body.users).toHaveLength(2);
|
|
||||||
for (const u of res.body.users) {
|
|
||||||
expect(u).toHaveProperty("id");
|
|
||||||
expect(u).toHaveProperty("username");
|
|
||||||
expect(u).toHaveProperty("createdAt");
|
|
||||||
expect(u).not.toHaveProperty("passwordHash");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST / creates a user", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/users")
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ username: "charlie", password: "charlie-pw" });
|
|
||||||
expect(res.status).toBe(201);
|
|
||||||
expect(res.body.username).toBe("charlie");
|
|
||||||
expect(users.countUsers()).toBe(3);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST / returns 409 on duplicate username", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/users")
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ username: "BOB", password: "another-pw" });
|
|
||||||
expect(res.status).toBe(409);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST / returns 400 on invalid input", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/users")
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ username: "x", password: "short" });
|
|
||||||
expect(res.status).toBe(400);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("DELETE /:id removes the user and their sessions", async () => {
|
|
||||||
const bobToken = sessions.createSession(bobId).token;
|
|
||||||
const res = await request(app).delete(`/api/users/${bobId}`).set("Cookie", aliceCookie);
|
|
||||||
expect(res.status).toBe(204);
|
|
||||||
expect(users.countUsers()).toBe(1);
|
|
||||||
expect(sessions.validateAndTouch(bobToken)).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("DELETE /:id of self returns 400", async () => {
|
|
||||||
const res = await request(app).delete(`/api/users/${aliceId}`).set("Cookie", aliceCookie);
|
|
||||||
expect(res.status).toBe(400);
|
|
||||||
expect(res.body).toEqual({ error: "cannot delete self" });
|
|
||||||
expect(users.countUsers()).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("DELETE /:id of nonexistent returns 404", async () => {
|
|
||||||
const res = await request(app).delete(`/api/users/not-a-real-id`).set("Cookie", aliceCookie);
|
|
||||||
expect(res.status).toBe(404);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /:id/reset-password updates the hash and invalidates target's sessions", async () => {
|
|
||||||
const bobToken = sessions.createSession(bobId).token;
|
|
||||||
const res = await request(app)
|
|
||||||
.post(`/api/users/${bobId}/reset-password`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ newPassword: "bob-new-pw" });
|
|
||||||
expect(res.status).toBe(204);
|
|
||||||
expect(sessions.validateAndTouch(bobToken)).toBeNull();
|
|
||||||
const bob = users.findByUsername("bob");
|
|
||||||
expect(await users.verifyPassword("bob-new-pw", bob!.passwordHash)).toBe(true);
|
|
||||||
expect(await users.verifyPassword("pw-bob-bob", bob!.passwordHash)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /:id/reset-password 404 on unknown user", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post(`/api/users/not-a-real-id/reset-password`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ newPassword: "anything-here" });
|
|
||||||
expect(res.status).toBe(404);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /:id/reset-password 400 on short password", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post(`/api/users/${bobId}/reset-password`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ newPassword: "short" });
|
|
||||||
expect(res.status).toBe(400);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("returns 201 even if audit insert fails (POST /api/users)", async () => {
|
|
||||||
// Build a broken audit store that throws on record()
|
|
||||||
const brokenAudit = {
|
|
||||||
record: () => { throw new Error("simulated disk-full"); },
|
|
||||||
list: () => [],
|
|
||||||
};
|
|
||||||
// Reassemble app with the broken audit
|
|
||||||
const localApp = express();
|
|
||||||
localApp.use(express.json());
|
|
||||||
localApp.use(cookieParser());
|
|
||||||
localApp.use("/api", createRequireAuth(sessions));
|
|
||||||
localApp.use(
|
|
||||||
"/api/users",
|
|
||||||
createUsersRouter(users, sessions, brokenAudit, pino({ level: "silent" }))
|
|
||||||
);
|
|
||||||
const res = await request(localApp)
|
|
||||||
.post("/api/users")
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ username: "charlie", password: "charlie-pw" });
|
|
||||||
expect(res.status).toBe(201);
|
|
||||||
expect(users.countUsers()).toBe(3);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /:id/reset-password on self preserves the actor's current session", async () => {
|
|
||||||
// Alice resets her OWN password
|
|
||||||
const res = await request(app)
|
|
||||||
.post(`/api/users/${aliceId}/reset-password`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ newPassword: "alice-new-pw" });
|
|
||||||
expect(res.status).toBe(204);
|
|
||||||
|
|
||||||
// Alice's CURRENT session should still work
|
|
||||||
// (we'd need a protected endpoint to verify; use GET /api/users which is already mounted)
|
|
||||||
const followUp = await request(app).get("/api/users").set("Cookie", aliceCookie);
|
|
||||||
expect(followUp.status).toBe(200);
|
|
||||||
|
|
||||||
// The password hash IS updated (sanity check)
|
|
||||||
const alice = users.findById(aliceId);
|
|
||||||
expect(await users.verifyPassword("alice-new-pw", alice!.passwordHash)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST /:id/reset-password on another user does NOT preserve any of target's sessions", async () => {
|
|
||||||
const bobToken = sessions.createSession(bobId).token;
|
|
||||||
const res = await request(app)
|
|
||||||
.post(`/api/users/${bobId}/reset-password`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ newPassword: "bob-new-pw" });
|
|
||||||
expect(res.status).toBe(204);
|
|
||||||
// Bob's session should be dead
|
|
||||||
expect(sessions.validateAndTouch(bobToken)).toBeNull();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST / defaults new user to role=member when role omitted", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/users")
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ username: "carol", password: "pw-carol-pw" });
|
|
||||||
expect(res.status).toBe(201);
|
|
||||||
expect(res.body.role).toBe("member");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("POST / accepts role=admin", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/api/users")
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ username: "carol", password: "pw-carol-pw", role: "admin" });
|
|
||||||
expect(res.status).toBe(201);
|
|
||||||
expect(res.body.role).toBe("admin");
|
|
||||||
expect(users.countAdmins()).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("PATCH /:id/role can change role between admin and member", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.patch(`/api/users/${bobId}/role`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ role: "admin" });
|
|
||||||
expect(res.status).toBe(204);
|
|
||||||
expect(users.findById(bobId)!.role).toBe("admin");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("PATCH /:id/role blocks demoting the last admin", async () => {
|
|
||||||
// alice is the only admin. Demoting her would leave 0 admins. Block.
|
|
||||||
const res = await request(app)
|
|
||||||
.patch(`/api/users/${aliceId}/role`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ role: "member" });
|
|
||||||
expect(res.status).toBe(400);
|
|
||||||
expect(res.body).toEqual({ error: "cannot demote last admin" });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("PATCH /:id/role allows demoting an admin when other admins exist", async () => {
|
|
||||||
// Promote bob first
|
|
||||||
users.setRole(bobId, "admin");
|
|
||||||
// Now both are admins. Demoting alice should work.
|
|
||||||
const res = await request(app)
|
|
||||||
.patch(`/api/users/${aliceId}/role`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ role: "member" });
|
|
||||||
expect(res.status).toBe(204);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("PATCH /:id/role 400 on invalid role", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.patch(`/api/users/${bobId}/role`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ role: "superuser" });
|
|
||||||
expect(res.status).toBe(400);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("PATCH /:id/role 404 on unknown user", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.patch(`/api/users/not-a-real-id/role`)
|
|
||||||
.set("Cookie", aliceCookie)
|
|
||||||
.send({ role: "admin" });
|
|
||||||
expect(res.status).toBe(404);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,166 +0,0 @@
|
|||||||
import { Router } from "express";
|
|
||||||
import type { Logger } from "../../logger.js";
|
|
||||||
import type { UserStore } from "../../data/users.js";
|
|
||||||
import { UsernameTakenError } from "../../data/users.js";
|
|
||||||
import type { SessionStore } from "../../data/sessions.js";
|
|
||||||
import type { AuditStore } from "../../data/audit.js";
|
|
||||||
import { extractSessionToken } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
function isValidUsername(v: unknown): v is string {
|
|
||||||
return typeof v === "string" && /^[A-Za-z0-9_\-.]{3,32}$/.test(v);
|
|
||||||
}
|
|
||||||
|
|
||||||
function isValidPassword(v: unknown): v is string {
|
|
||||||
return typeof v === "string" && v.length >= 8 && v.length <= 200;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createUsersRouter(
|
|
||||||
users: UserStore,
|
|
||||||
sessions: SessionStore,
|
|
||||||
audit: AuditStore,
|
|
||||||
logger: Logger
|
|
||||||
): Router {
|
|
||||||
const router = Router();
|
|
||||||
|
|
||||||
router.get("/", (_req, res) => {
|
|
||||||
res.json({ users: users.listUsers() });
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/", async (req, res) => {
|
|
||||||
const { username, password, role: roleInput } = req.body ?? {};
|
|
||||||
if (!isValidUsername(username) || !isValidPassword(password)) {
|
|
||||||
res.status(400).json({ error: "invalid username or password" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const role: "admin" | "member" = roleInput === "admin" ? "admin" : "member";
|
|
||||||
try {
|
|
||||||
const u = await users.createUser(username, password, role);
|
|
||||||
try {
|
|
||||||
audit.record({
|
|
||||||
actorId: req.user!.id, actorUsername: req.user!.username,
|
|
||||||
targetUserId: u.id, targetUsername: u.username,
|
|
||||||
action: "user.created",
|
|
||||||
});
|
|
||||||
} catch (auditErr) {
|
|
||||||
logger.warn({ err: auditErr, action: "user.created" }, "audit insert failed");
|
|
||||||
}
|
|
||||||
logger.info({ createdBy: req.user!.id, newUserId: u.id, username, role }, "User created");
|
|
||||||
res.status(201).json({ id: u.id, username: u.username, role: u.role });
|
|
||||||
} catch (err) {
|
|
||||||
if (err instanceof UsernameTakenError) {
|
|
||||||
res.status(409).json({ error: "username taken" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
logger.error({ err }, "createUser failed");
|
|
||||||
res.status(500).json({ error: "internal" });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.delete("/:id", (req, res) => {
|
|
||||||
const targetId = req.params.id;
|
|
||||||
// Snapshot target's username BEFORE deletion for audit
|
|
||||||
const target = users.findById(targetId);
|
|
||||||
if (!target) {
|
|
||||||
res.status(404).json({ error: "not found" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (targetId === req.user!.id) {
|
|
||||||
res.status(400).json({ error: "cannot delete self" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const result = users.deleteUserIfNotLastAdmin(targetId);
|
|
||||||
if (result === "not_found") {
|
|
||||||
res.status(404).json({ error: "not found" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (result === "would_orphan") {
|
|
||||||
res.status(400).json({ error: "cannot delete last admin" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// FK CASCADE removes sessions; explicit call is belt-and-suspenders
|
|
||||||
sessions.deleteAllForUser(targetId);
|
|
||||||
try {
|
|
||||||
audit.record({
|
|
||||||
actorId: req.user!.id, actorUsername: req.user!.username,
|
|
||||||
targetUserId: target.id, targetUsername: target.username,
|
|
||||||
action: "user.deleted",
|
|
||||||
});
|
|
||||||
} catch (auditErr) {
|
|
||||||
logger.warn({ err: auditErr, action: "user.deleted" }, "audit insert failed");
|
|
||||||
}
|
|
||||||
logger.info({ deletedBy: req.user!.id, deletedUserId: targetId }, "User deleted");
|
|
||||||
res.status(204).end();
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/:id/reset-password", async (req, res) => {
|
|
||||||
const { newPassword } = req.body ?? {};
|
|
||||||
if (!isValidPassword(newPassword)) {
|
|
||||||
res.status(400).json({ error: "invalid password" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const targetId = req.params.id;
|
|
||||||
const target = users.findById(targetId);
|
|
||||||
if (!target) {
|
|
||||||
res.status(404).json({ error: "not found" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
await users.changePassword(targetId, newPassword);
|
|
||||||
// Invalidate all sessions for the target user (except current actor's if it's the same user)
|
|
||||||
const exceptToken = targetId === req.user!.id
|
|
||||||
? (extractSessionToken(req.headers.cookie) ?? undefined)
|
|
||||||
: undefined;
|
|
||||||
sessions.deleteAllForUser(targetId, exceptToken);
|
|
||||||
try {
|
|
||||||
audit.record({
|
|
||||||
actorId: req.user!.id, actorUsername: req.user!.username,
|
|
||||||
targetUserId: target.id, targetUsername: target.username,
|
|
||||||
action: "user.password_reset",
|
|
||||||
});
|
|
||||||
} catch (auditErr) {
|
|
||||||
logger.warn({ err: auditErr, action: "user.password_reset" }, "audit insert failed");
|
|
||||||
}
|
|
||||||
logger.info({ resetBy: req.user!.id, targetUserId: targetId }, "Password reset");
|
|
||||||
res.status(204).end();
|
|
||||||
});
|
|
||||||
|
|
||||||
router.patch("/:id/role", (req, res) => {
|
|
||||||
const targetId = req.params.id;
|
|
||||||
const { role: newRole } = req.body ?? {};
|
|
||||||
if (newRole !== "admin" && newRole !== "member") {
|
|
||||||
res.status(400).json({ error: "invalid role" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Snapshot the target's old role and username for audit (BEFORE the atomic update,
|
|
||||||
// so we record what actually changed; if the user is gone we'll skip audit).
|
|
||||||
const targetBefore = users.findById(targetId);
|
|
||||||
if (!targetBefore) {
|
|
||||||
res.status(404).json({ error: "not found" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const result = users.setRoleIfNotLastAdmin(targetId, newRole);
|
|
||||||
if (result === "not_found") {
|
|
||||||
res.status(404).json({ error: "not found" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (result === "would_orphan") {
|
|
||||||
res.status(400).json({ error: "cannot demote last admin" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Only audit when the role actually changed
|
|
||||||
if (targetBefore.role !== newRole) {
|
|
||||||
try {
|
|
||||||
audit.record({
|
|
||||||
actorId: req.user!.id, actorUsername: req.user!.username,
|
|
||||||
targetUserId: targetBefore.id, targetUsername: targetBefore.username,
|
|
||||||
action: "user.role_changed",
|
|
||||||
});
|
|
||||||
} catch (auditErr) {
|
|
||||||
logger.warn({ err: auditErr, action: "user.role_changed" }, "audit insert failed");
|
|
||||||
}
|
|
||||||
logger.info({ actorId: req.user!.id, targetId, newRole }, "User role changed");
|
|
||||||
}
|
|
||||||
res.status(204).end();
|
|
||||||
});
|
|
||||||
|
|
||||||
return router;
|
|
||||||
}
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
import type { SessionStore, SessionValidation } from "../../data/sessions.js";
|
|
||||||
|
|
||||||
export const SESSION_COOKIE_NAME = "tsmb_session";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Validate the session cookie carried on an arbitrary HTTP-like header bag.
|
|
||||||
* Used by Express middleware (req.headers.cookie) AND by the raw WebSocket
|
|
||||||
* upgrade handler (req.headers.cookie) — they share this exact behavior.
|
|
||||||
*/
|
|
||||||
export function validateSessionFromHeaders(
|
|
||||||
rawCookieHeader: string | undefined,
|
|
||||||
sessions: SessionStore
|
|
||||||
): SessionValidation | null {
|
|
||||||
if (!rawCookieHeader) return null;
|
|
||||||
const token = parseCookie(rawCookieHeader, SESSION_COOKIE_NAME);
|
|
||||||
if (!token) return null;
|
|
||||||
return sessions.validateAndTouch(token);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function extractSessionToken(rawCookieHeader: string | undefined): string | null {
|
|
||||||
if (!rawCookieHeader) return null;
|
|
||||||
return parseCookie(rawCookieHeader, SESSION_COOKIE_NAME);
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseCookie(header: string, name: string): string | null {
|
|
||||||
for (const part of header.split(";")) {
|
|
||||||
const trimmed = part.trim();
|
|
||||||
const eq = trimmed.indexOf("=");
|
|
||||||
if (eq < 1) continue;
|
|
||||||
if (trimmed.slice(0, eq) !== name) continue;
|
|
||||||
try {
|
|
||||||
return decodeURIComponent(trimmed.slice(eq + 1));
|
|
||||||
} catch {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import request from "supertest";
|
|
||||||
import { csrfOriginCheck } from "./csrf.js";
|
|
||||||
|
|
||||||
describe("csrfOriginCheck middleware", () => {
|
|
||||||
let app: express.Express;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
app = express();
|
|
||||||
app.use(csrfOriginCheck);
|
|
||||||
app.get("/", (_req, res) => res.json({ ok: true }));
|
|
||||||
app.post("/", (_req, res) => res.json({ ok: true }));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows safe methods (GET/HEAD/OPTIONS) without Origin", async () => {
|
|
||||||
const res = await request(app).get("/");
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects POST without Origin or Referer", async () => {
|
|
||||||
const res = await request(app).post("/");
|
|
||||||
expect(res.status).toBe(403);
|
|
||||||
expect(res.body).toEqual({ error: "bad origin" });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("accepts POST when Origin host matches request host", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/")
|
|
||||||
.set("Host", "example.com")
|
|
||||||
.set("Origin", "https://example.com");
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects POST when Origin host does not match request host", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/")
|
|
||||||
.set("Host", "example.com")
|
|
||||||
.set("Origin", "https://evil.com");
|
|
||||||
expect(res.status).toBe(403);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("accepts POST when Referer host matches and Origin is absent", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/")
|
|
||||||
.set("Host", "example.com")
|
|
||||||
.set("Referer", "https://example.com/some/path");
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects POST when Referer host does not match", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.post("/")
|
|
||||||
.set("Host", "example.com")
|
|
||||||
.set("Referer", "https://evil.com/some/path");
|
|
||||||
expect(res.status).toBe(403);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
import type { Request, Response, NextFunction } from "express";
|
|
||||||
|
|
||||||
const SAFE_METHODS = new Set(["GET", "HEAD", "OPTIONS"]);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Same-origin CSRF protection. For mutating requests, the Origin or Referer
|
|
||||||
* header must indicate a host equal to the request's own host.
|
|
||||||
*
|
|
||||||
* SameSite=Lax on the session cookie blocks classic cross-site form posts;
|
|
||||||
* this header check covers the remaining attack surface.
|
|
||||||
*/
|
|
||||||
export function csrfOriginCheck(req: Request, res: Response, next: NextFunction): void {
|
|
||||||
if (SAFE_METHODS.has(req.method)) {
|
|
||||||
next();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const expectedHost = req.get("host");
|
|
||||||
const originHeader = req.get("origin");
|
|
||||||
const refererHeader = req.get("referer");
|
|
||||||
const headerHost = hostOf(originHeader) ?? hostOf(refererHeader);
|
|
||||||
if (!headerHost || !expectedHost || headerHost !== expectedHost) {
|
|
||||||
res.status(403).json({ error: "bad origin" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
next();
|
|
||||||
}
|
|
||||||
|
|
||||||
function hostOf(url: string | undefined): string | null {
|
|
||||||
if (!url) return null;
|
|
||||||
try {
|
|
||||||
return new URL(url).host;
|
|
||||||
} catch {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import request from "supertest";
|
|
||||||
import { createRateLimit } from "./rateLimit.js";
|
|
||||||
|
|
||||||
describe("createRateLimit", () => {
|
|
||||||
let app: express.Express;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
app = express();
|
|
||||||
// capacity=3, refill=1/sec → first 3 succeed, then 429 until refill.
|
|
||||||
app.use(createRateLimit({ capacity: 3, refillPerSec: 1 }));
|
|
||||||
app.get("/", (_req, res) => res.json({ ok: true }));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows up to capacity bursts then rejects with 429", async () => {
|
|
||||||
expect((await request(app).get("/")).status).toBe(200);
|
|
||||||
expect((await request(app).get("/")).status).toBe(200);
|
|
||||||
expect((await request(app).get("/")).status).toBe(200);
|
|
||||||
const denied = await request(app).get("/");
|
|
||||||
expect(denied.status).toBe(429);
|
|
||||||
expect(denied.body).toEqual({ error: "rate limit exceeded" });
|
|
||||||
expect(denied.headers["retry-after"]).toBeDefined();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("uses per-key buckets when keyFn is provided", async () => {
|
|
||||||
const customApp = express();
|
|
||||||
customApp.use(
|
|
||||||
createRateLimit({
|
|
||||||
capacity: 1,
|
|
||||||
refillPerSec: 0.001,
|
|
||||||
keyFn: (req) => req.get("x-user") ?? "anon",
|
|
||||||
})
|
|
||||||
);
|
|
||||||
customApp.get("/", (_req, res) => res.json({ ok: true }));
|
|
||||||
expect((await request(customApp).get("/").set("X-User", "alice")).status).toBe(200);
|
|
||||||
expect((await request(customApp).get("/").set("X-User", "alice")).status).toBe(429);
|
|
||||||
// Different user, separate bucket → still has a token.
|
|
||||||
expect((await request(customApp).get("/").set("X-User", "bob")).status).toBe(200);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
import type { Request, Response, NextFunction, RequestHandler } from "express";
|
|
||||||
|
|
||||||
interface Bucket {
|
|
||||||
tokens: number;
|
|
||||||
lastRefillMs: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface RateLimitOptions {
|
|
||||||
/** Bucket capacity (max burst). */
|
|
||||||
capacity: number;
|
|
||||||
/** Tokens refilled per second. */
|
|
||||||
refillPerSec: number;
|
|
||||||
/** Optional key function; defaults to req.ip. */
|
|
||||||
keyFn?: (req: Request) => string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* In-memory token-bucket rate limiter.
|
|
||||||
*
|
|
||||||
* Each unique key (default: req.ip) gets its own bucket. Refills continuously
|
|
||||||
* at `refillPerSec` up to `capacity`. Each request consumes 1 token; if no
|
|
||||||
* token is available, returns 429 with Retry-After.
|
|
||||||
*
|
|
||||||
* Buckets evict themselves after 10 minutes of inactivity to bound memory.
|
|
||||||
*/
|
|
||||||
export function createRateLimit(options: RateLimitOptions): RequestHandler {
|
|
||||||
const buckets = new Map<string, Bucket>();
|
|
||||||
const EVICT_AFTER_MS = 10 * 60 * 1000;
|
|
||||||
// Periodic eviction to bound memory under attack.
|
|
||||||
const evict = setInterval(() => {
|
|
||||||
const cutoff = Date.now() - EVICT_AFTER_MS;
|
|
||||||
for (const [k, b] of buckets) {
|
|
||||||
if (b.lastRefillMs < cutoff) buckets.delete(k);
|
|
||||||
}
|
|
||||||
}, 60_000);
|
|
||||||
// Unref the timer so it doesn't keep the process alive in tests.
|
|
||||||
if (typeof (evict as { unref?: () => void }).unref === "function") {
|
|
||||||
(evict as { unref: () => void }).unref();
|
|
||||||
}
|
|
||||||
|
|
||||||
const keyFn = options.keyFn ?? ((req) => req.ip ?? "unknown");
|
|
||||||
|
|
||||||
return function rateLimit(req: Request, res: Response, next: NextFunction): void {
|
|
||||||
const key = keyFn(req);
|
|
||||||
const now = Date.now();
|
|
||||||
let b = buckets.get(key);
|
|
||||||
if (!b) {
|
|
||||||
b = { tokens: options.capacity, lastRefillMs: now };
|
|
||||||
buckets.set(key, b);
|
|
||||||
}
|
|
||||||
const elapsedSec = (now - b.lastRefillMs) / 1000;
|
|
||||||
b.tokens = Math.min(options.capacity, b.tokens + elapsedSec * options.refillPerSec);
|
|
||||||
b.lastRefillMs = now;
|
|
||||||
if (b.tokens < 1) {
|
|
||||||
const waitSec = Math.ceil((1 - b.tokens) / options.refillPerSec);
|
|
||||||
res.setHeader("Retry-After", String(waitSec));
|
|
||||||
res.status(429).json({ error: "rate limit exceeded" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
b.tokens -= 1;
|
|
||||||
next();
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import cookieParser from "cookie-parser";
|
|
||||||
import request from "supertest";
|
|
||||||
import { createDatabase, type BotDatabase } from "../../data/database.js";
|
|
||||||
import { createUserStore } from "../../data/users.js";
|
|
||||||
import { createSessionStore } from "../../data/sessions.js";
|
|
||||||
import { createRequireAuth } from "./requireAuth.js";
|
|
||||||
import { requireAdmin } from "./requireAdmin.js";
|
|
||||||
import { SESSION_COOKIE_NAME } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
describe("requireAdmin middleware", () => {
|
|
||||||
let botDb: BotDatabase;
|
|
||||||
let app: express.Express;
|
|
||||||
let adminCookie: string;
|
|
||||||
let memberCookie: string;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
botDb = createDatabase(":memory:");
|
|
||||||
const users = createUserStore(botDb.db);
|
|
||||||
const sessions = createSessionStore(botDb.db);
|
|
||||||
const admin = await users.createUser("admin", "pw-admin-pw", "admin");
|
|
||||||
const member = await users.createUser("member", "pw-member-pw", "member");
|
|
||||||
adminCookie = `${SESSION_COOKIE_NAME}=${sessions.createSession(admin.id).token}`;
|
|
||||||
memberCookie = `${SESSION_COOKIE_NAME}=${sessions.createSession(member.id).token}`;
|
|
||||||
app = express();
|
|
||||||
app.use(cookieParser());
|
|
||||||
app.use(createRequireAuth(sessions));
|
|
||||||
app.use(requireAdmin);
|
|
||||||
app.get("/admin-only", (_req, res) => res.json({ ok: true }));
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => botDb.close());
|
|
||||||
|
|
||||||
it("rejects unauthenticated requests with 401", async () => {
|
|
||||||
const res = await request(app).get("/admin-only");
|
|
||||||
expect(res.status).toBe(401);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects member with 403", async () => {
|
|
||||||
const res = await request(app).get("/admin-only").set("Cookie", memberCookie);
|
|
||||||
expect(res.status).toBe(403);
|
|
||||||
expect(res.body).toEqual({ error: "forbidden" });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows admin", async () => {
|
|
||||||
const res = await request(app).get("/admin-only").set("Cookie", adminCookie);
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
import type { Request, Response, NextFunction } from "express";
|
|
||||||
|
|
||||||
export function requireAdmin(req: Request, res: Response, next: NextFunction): void {
|
|
||||||
if (!req.user) {
|
|
||||||
res.status(401).json({ error: "unauthenticated" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (req.user.role !== "admin") {
|
|
||||||
res.status(403).json({ error: "forbidden" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
next();
|
|
||||||
}
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import cookieParser from "cookie-parser";
|
|
||||||
import request from "supertest";
|
|
||||||
import { createDatabase, type BotDatabase } from "../../data/database.js";
|
|
||||||
import { createUserStore } from "../../data/users.js";
|
|
||||||
import { createSessionStore } from "../../data/sessions.js";
|
|
||||||
import { createRequireAuth } from "./requireAuth.js";
|
|
||||||
import { SESSION_COOKIE_NAME } from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
describe("requireAuth middleware", () => {
|
|
||||||
let botDb: BotDatabase;
|
|
||||||
let app: express.Express;
|
|
||||||
let validToken: string;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
botDb = createDatabase(":memory:");
|
|
||||||
const users = createUserStore(botDb.db);
|
|
||||||
const sessions = createSessionStore(botDb.db);
|
|
||||||
const u = await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
validToken = sessions.createSession(u.id).token;
|
|
||||||
|
|
||||||
app = express();
|
|
||||||
app.use(cookieParser());
|
|
||||||
app.use(createRequireAuth(sessions));
|
|
||||||
app.get("/protected", (req, res) => {
|
|
||||||
res.json({ ok: true, user: (req as any).user });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
botDb.close();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects requests without a session cookie", async () => {
|
|
||||||
const res = await request(app).get("/protected");
|
|
||||||
expect(res.status).toBe(401);
|
|
||||||
expect(res.body).toEqual({ error: "unauthenticated" });
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects requests with an unknown session cookie", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.get("/protected")
|
|
||||||
.set("Cookie", `${SESSION_COOKIE_NAME}=garbage`);
|
|
||||||
expect(res.status).toBe(401);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows requests with a valid session cookie and attaches req.user", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.get("/protected")
|
|
||||||
.set("Cookie", `${SESSION_COOKIE_NAME}=${validToken}`);
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.body.ok).toBe(true);
|
|
||||||
expect(res.body.user.username).toBe("alice");
|
|
||||||
expect(res.body.user.role).toBe("admin");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rolls the cookie max-age forward on successful auth", async () => {
|
|
||||||
const res = await request(app)
|
|
||||||
.get("/protected")
|
|
||||||
.set("Cookie", `${SESSION_COOKIE_NAME}=${validToken}`);
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
const setCookieHeaders = res.headers["set-cookie"];
|
|
||||||
const arr = Array.isArray(setCookieHeaders) ? setCookieHeaders : setCookieHeaders ? [setCookieHeaders] : [];
|
|
||||||
const refreshed = arr.find((c) => c.startsWith(`${SESSION_COOKIE_NAME}=`));
|
|
||||||
expect(refreshed).toBeDefined();
|
|
||||||
expect(refreshed!).toMatch(/Max-Age=\d+/);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
import type { Request, Response, NextFunction, RequestHandler } from "express";
|
|
||||||
import type { SessionStore } from "../../data/sessions.js";
|
|
||||||
import { SESSION_TTL_MS } from "../../data/sessions.js";
|
|
||||||
import {
|
|
||||||
validateSessionFromHeaders,
|
|
||||||
extractSessionToken,
|
|
||||||
SESSION_COOKIE_NAME,
|
|
||||||
} from "../auth/validateSession.js";
|
|
||||||
|
|
||||||
declare module "express-serve-static-core" {
|
|
||||||
interface Request {
|
|
||||||
user?: { id: string; username: string; role: "admin" | "member" };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createRequireAuth(sessions: SessionStore): RequestHandler {
|
|
||||||
return function requireAuth(req: Request, res: Response, next: NextFunction) {
|
|
||||||
const result = validateSessionFromHeaders(req.headers.cookie, sessions);
|
|
||||||
if (!result) {
|
|
||||||
res.clearCookie(SESSION_COOKIE_NAME, { path: "/" });
|
|
||||||
res.status(401).json({ error: "unauthenticated" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
req.user = { id: result.userId, username: result.username, role: result.role };
|
|
||||||
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();
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
import { describe, it, expect } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import request from "supertest";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The clickjacking-defence middleware is mounted at the top of
|
|
||||||
* `createWebServer` in `server.ts`. This test asserts the exact behavior
|
|
||||||
* we expect from that middleware in isolation. The wiring inside
|
|
||||||
* `server.ts` is verified by code review (git diff).
|
|
||||||
*/
|
|
||||||
describe("security headers (anti-clickjacking)", () => {
|
|
||||||
function buildApp() {
|
|
||||||
const app = express();
|
|
||||||
app.use((_req, res, next) => {
|
|
||||||
res.setHeader("X-Frame-Options", "DENY");
|
|
||||||
res.setHeader("Content-Security-Policy", "frame-ancestors 'none'");
|
|
||||||
next();
|
|
||||||
});
|
|
||||||
app.get("/", (_req, res) => res.json({ ok: true }));
|
|
||||||
app.post("/", (_req, res) => res.json({ ok: true }));
|
|
||||||
return app;
|
|
||||||
}
|
|
||||||
|
|
||||||
it("sets X-Frame-Options: DENY on GET responses", async () => {
|
|
||||||
const res = await request(buildApp()).get("/");
|
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.headers["x-frame-options"]).toBe("DENY");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("sets Content-Security-Policy frame-ancestors 'none' on GET responses", async () => {
|
|
||||||
const res = await request(buildApp()).get("/");
|
|
||||||
expect(res.headers["content-security-policy"]).toBe("frame-ancestors 'none'");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("sets both headers on POST responses too", async () => {
|
|
||||||
const res = await request(buildApp()).post("/");
|
|
||||||
expect(res.headers["x-frame-options"]).toBe("DENY");
|
|
||||||
expect(res.headers["content-security-policy"]).toBe("frame-ancestors 'none'");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
Executable → Regular
+7
-128
@@ -1,7 +1,6 @@
|
|||||||
import express from "express";
|
import express from "express";
|
||||||
import http from "node:http";
|
import http from "node:http";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import cookieParser from "cookie-parser";
|
|
||||||
import { WebSocketServer } from "ws";
|
import { WebSocketServer } from "ws";
|
||||||
import type { BotManager } from "../bot/manager.js";
|
import type { BotManager } from "../bot/manager.js";
|
||||||
import type { MusicProvider } from "../music/provider.js";
|
import type { MusicProvider } from "../music/provider.js";
|
||||||
@@ -9,25 +8,11 @@ import type { BotDatabase } from "../data/database.js";
|
|||||||
import type { BotConfig } from "../data/config.js";
|
import type { BotConfig } from "../data/config.js";
|
||||||
import type { Logger } from "../logger.js";
|
import type { Logger } from "../logger.js";
|
||||||
import type { CookieStore } from "../music/auth.js";
|
import type { CookieStore } from "../music/auth.js";
|
||||||
import type { AvatarStore } from "../data/avatars.js";
|
|
||||||
import { createBotRouter } from "./api/bot.js";
|
import { createBotRouter } from "./api/bot.js";
|
||||||
import { createMusicRouter } from "./api/music.js";
|
import { createMusicRouter } from "./api/music.js";
|
||||||
import { createPlayerRouter } from "./api/player.js";
|
import { createPlayerRouter } from "./api/player.js";
|
||||||
import { createAuthRouter } from "./api/auth.js";
|
import { createAuthRouter } from "./api/auth.js";
|
||||||
import { createSessionRouter } from "./api/session.js";
|
|
||||||
import { createUsersRouter } from "./api/users.js";
|
|
||||||
import { createAuditStore } from "../data/audit.js";
|
|
||||||
import { createAuditRouter } from "./api/audit.js";
|
|
||||||
import { setupWebSocket } from "./websocket.js";
|
import { setupWebSocket } from "./websocket.js";
|
||||||
import { createUserStore } from "../data/users.js";
|
|
||||||
import { createSessionStore } from "../data/sessions.js";
|
|
||||||
import { createRequireAuth } from "./middleware/requireAuth.js";
|
|
||||||
import { requireAdmin } from "./middleware/requireAdmin.js";
|
|
||||||
import { csrfOriginCheck } from "./middleware/csrf.js";
|
|
||||||
import { createRateLimit } from "./middleware/rateLimit.js";
|
|
||||||
import { validateSessionFromHeaders } from "./auth/validateSession.js";
|
|
||||||
|
|
||||||
const SESSION_CLEANUP_INTERVAL_MS = 60 * 60 * 1000; // 1 hour
|
|
||||||
|
|
||||||
export interface WebServerOptions {
|
export interface WebServerOptions {
|
||||||
port: number;
|
port: number;
|
||||||
@@ -37,10 +22,8 @@ export interface WebServerOptions {
|
|||||||
bilibiliProvider: MusicProvider;
|
bilibiliProvider: MusicProvider;
|
||||||
database: BotDatabase;
|
database: BotDatabase;
|
||||||
config: BotConfig;
|
config: BotConfig;
|
||||||
configPath: string;
|
|
||||||
logger: Logger;
|
logger: Logger;
|
||||||
cookieStore?: CookieStore;
|
cookieStore?: CookieStore;
|
||||||
avatarStore: AvatarStore;
|
|
||||||
staticDir?: string;
|
staticDir?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -54,62 +37,11 @@ export function createWebServer(options: WebServerOptions): WebServer {
|
|||||||
const server = http.createServer(app);
|
const server = http.createServer(app);
|
||||||
const logger = options.logger.child({ component: "web" });
|
const logger = options.logger.child({ component: "web" });
|
||||||
|
|
||||||
if (options.config.trustProxy) {
|
app.use(express.json());
|
||||||
app.set("trust proxy", true);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Security headers: prevent the WebUI from being embedded in a third-party
|
|
||||||
// iframe (clickjacking defence). CSP frame-ancestors is the modern equivalent
|
|
||||||
// of X-Frame-Options; both are set for compatibility across browsers.
|
|
||||||
app.use((_req, res, next) => {
|
|
||||||
res.setHeader("X-Frame-Options", "DENY");
|
|
||||||
res.setHeader("Content-Security-Policy", "frame-ancestors 'none'");
|
|
||||||
next();
|
|
||||||
});
|
|
||||||
|
|
||||||
app.use(express.json({ limit: "400kb" }));
|
|
||||||
app.use(cookieParser());
|
|
||||||
|
|
||||||
const users = createUserStore(options.database.db);
|
|
||||||
const sessions = createSessionStore(options.database.db);
|
|
||||||
const audit = createAuditStore(options.database.db);
|
|
||||||
|
|
||||||
// ─── Public routes (no auth, no CSRF) ───────────────────────────────────
|
|
||||||
app.get("/api/health", (_req, res) => {
|
|
||||||
res.json({ status: "ok", version: "0.1.0" });
|
|
||||||
});
|
|
||||||
|
|
||||||
app.get("/api/config/public-url", (_req, res) => {
|
|
||||||
const raw = (options.config.publicUrl ?? "").trim();
|
|
||||||
res.json({ publicUrl: raw ? raw.replace(/\/+$/, "") : null });
|
|
||||||
});
|
|
||||||
|
|
||||||
// Anti-DoS: throttle expensive (bcrypt) auth endpoints.
|
|
||||||
// 5 req per minute per IP for /login (capacity 5, refill 5/60 = ~0.083/sec).
|
|
||||||
// 3 req per minute per IP for /setup (more limited; first-run is rare).
|
|
||||||
const loginLimit = createRateLimit({ capacity: 5, refillPerSec: 5 / 60 });
|
|
||||||
const setupLimit = createRateLimit({ capacity: 3, refillPerSec: 3 / 60 });
|
|
||||||
app.use("/api/session/login", loginLimit);
|
|
||||||
app.use("/api/session/setup", setupLimit);
|
|
||||||
|
|
||||||
app.use("/api/session", createSessionRouter(users, sessions, audit, logger));
|
|
||||||
|
|
||||||
// ─── Gates for everything else under /api ───────────────────────────────
|
|
||||||
const requireAuth = createRequireAuth(sessions);
|
|
||||||
app.use("/api", csrfOriginCheck);
|
|
||||||
app.use("/api", requireAuth);
|
|
||||||
|
|
||||||
// ─── Protected routes ───────────────────────────────────────────────────
|
|
||||||
app.use(
|
app.use(
|
||||||
"/api/bot",
|
"/api/bot",
|
||||||
createBotRouter(
|
createBotRouter(options.botManager, options.config, logger)
|
||||||
options.botManager,
|
|
||||||
options.config,
|
|
||||||
options.configPath,
|
|
||||||
logger,
|
|
||||||
options.database,
|
|
||||||
options.avatarStore,
|
|
||||||
)
|
|
||||||
);
|
);
|
||||||
app.use(
|
app.use(
|
||||||
"/api/music",
|
"/api/music",
|
||||||
@@ -123,11 +55,11 @@ export function createWebServer(options: WebServerOptions): WebServer {
|
|||||||
"/api/auth",
|
"/api/auth",
|
||||||
createAuthRouter(options.neteaseProvider, options.qqProvider, options.bilibiliProvider, logger, options.cookieStore)
|
createAuthRouter(options.neteaseProvider, options.qqProvider, options.bilibiliProvider, logger, options.cookieStore)
|
||||||
);
|
);
|
||||||
// admin-only routes
|
|
||||||
app.use("/api/users", requireAdmin, createUsersRouter(users, sessions, audit, logger));
|
|
||||||
app.use("/api/audit", requireAdmin, createAuditRouter(audit));
|
|
||||||
|
|
||||||
// ─── Static SPA (public) ────────────────────────────────────────────────
|
app.get("/api/health", (_req, res) => {
|
||||||
|
res.json({ status: "ok", version: "0.1.0" });
|
||||||
|
});
|
||||||
|
|
||||||
if (options.staticDir) {
|
if (options.staticDir) {
|
||||||
app.use(express.static(options.staticDir));
|
app.use(express.static(options.staticDir));
|
||||||
app.get(/^(?!\/api|\/ws)/, (_req, res) => {
|
app.get(/^(?!\/api|\/ws)/, (_req, res) => {
|
||||||
@@ -135,72 +67,19 @@ export function createWebServer(options: WebServerOptions): WebServer {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
server.on("error", (err) => {
|
const wss = new WebSocketServer({ server, path: "/ws" });
|
||||||
logger.error({ err }, "HTTP server error");
|
|
||||||
});
|
|
||||||
|
|
||||||
// ─── WebSocket with manual upgrade auth ────────────────────────────────
|
|
||||||
const wss = new WebSocketServer({ noServer: true });
|
|
||||||
wss.on("error", (err) => {
|
|
||||||
logger.error({ err }, "WebSocket server error");
|
|
||||||
});
|
|
||||||
server.on("upgrade", (req, socket, head) => {
|
|
||||||
if (req.url !== "/ws") {
|
|
||||||
socket.destroy();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const reqHost = req.headers.host;
|
|
||||||
const originHeader = req.headers.origin;
|
|
||||||
if (originHeader) {
|
|
||||||
let originHost: string | null = null;
|
|
||||||
try {
|
|
||||||
originHost = new URL(originHeader).host;
|
|
||||||
} catch {
|
|
||||||
// fall through; treat as missing/invalid origin
|
|
||||||
}
|
|
||||||
if (!originHost || originHost !== reqHost) {
|
|
||||||
socket.write("HTTP/1.1 403 Forbidden\r\nConnection: close\r\n\r\n");
|
|
||||||
socket.destroy();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const result = validateSessionFromHeaders(req.headers.cookie as string | undefined, sessions);
|
|
||||||
if (!result) {
|
|
||||||
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 unknown as { userId: string }).userId = result.userId;
|
|
||||||
wss.emit("connection", ws, req);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
const cleanupWs = setupWebSocket(wss, options.botManager, logger);
|
const cleanupWs = setupWebSocket(wss, options.botManager, logger);
|
||||||
|
|
||||||
// ─── Session cleanup interval ──────────────────────────────────────────
|
|
||||||
let cleanupTimer: ReturnType<typeof setInterval> | null = null;
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
async start(): Promise<void> {
|
async start(): Promise<void> {
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
server.listen(options.port, () => {
|
server.listen(options.port, () => {
|
||||||
logger.info({ port: options.port }, "Web server started");
|
logger.info({ port: options.port }, "Web server started");
|
||||||
cleanupTimer = setInterval(() => {
|
|
||||||
try {
|
|
||||||
sessions.cleanupExpired();
|
|
||||||
} catch (err) {
|
|
||||||
logger.error({ err }, "session cleanup failed");
|
|
||||||
}
|
|
||||||
}, SESSION_CLEANUP_INTERVAL_MS);
|
|
||||||
resolve();
|
resolve();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
stop(): void {
|
stop(): void {
|
||||||
if (cleanupTimer) {
|
|
||||||
clearInterval(cleanupTimer);
|
|
||||||
cleanupTimer = null;
|
|
||||||
}
|
|
||||||
cleanupWs();
|
cleanupWs();
|
||||||
wss.close();
|
wss.close();
|
||||||
server.close();
|
server.close();
|
||||||
|
|||||||
@@ -1,74 +0,0 @@
|
|||||||
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
||||||
import express from "express";
|
|
||||||
import http from "node:http";
|
|
||||||
import { WebSocketServer, WebSocket as WSClient } from "ws";
|
|
||||||
import { AddressInfo } from "node:net";
|
|
||||||
import { createDatabase, type BotDatabase } from "../data/database.js";
|
|
||||||
import { createUserStore } from "../data/users.js";
|
|
||||||
import { createSessionStore } from "../data/sessions.js";
|
|
||||||
import { validateSessionFromHeaders, SESSION_COOKIE_NAME } from "./auth/validateSession.js";
|
|
||||||
|
|
||||||
function buildServer(sessions: ReturnType<typeof createSessionStore>) {
|
|
||||||
const app = express();
|
|
||||||
const server = http.createServer(app);
|
|
||||||
const wss = new WebSocketServer({ noServer: true });
|
|
||||||
wss.on("connection", (ws) => ws.send("hello"));
|
|
||||||
server.on("upgrade", (req, socket, head) => {
|
|
||||||
if (req.url !== "/ws") return socket.destroy();
|
|
||||||
const r = validateSessionFromHeaders(req.headers.cookie as string | undefined, sessions);
|
|
||||||
if (!r) {
|
|
||||||
socket.write("HTTP/1.1 401 Unauthorized\r\nConnection: close\r\n\r\n");
|
|
||||||
socket.destroy();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
wss.handleUpgrade(req, socket, head, (ws) => wss.emit("connection", ws, req));
|
|
||||||
});
|
|
||||||
return { server, wss };
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("WebSocket auth at upgrade", () => {
|
|
||||||
let botDb: BotDatabase;
|
|
||||||
let httpServer: http.Server;
|
|
||||||
let port: number;
|
|
||||||
let validToken: string;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
botDb = createDatabase(":memory:");
|
|
||||||
const users = createUserStore(botDb.db);
|
|
||||||
const sessions = createSessionStore(botDb.db);
|
|
||||||
const u = await users.createUser("alice", "pw-alice", "admin");
|
|
||||||
validToken = sessions.createSession(u.id).token;
|
|
||||||
|
|
||||||
const { server } = buildServer(sessions);
|
|
||||||
httpServer = server;
|
|
||||||
await new Promise<void>((resolve) => httpServer.listen(0, resolve));
|
|
||||||
port = (httpServer.address() as AddressInfo).port;
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(async () => {
|
|
||||||
await new Promise<void>((resolve) => httpServer.close(() => resolve()));
|
|
||||||
botDb.close();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("rejects upgrade without cookie (server-side close before open)", async () => {
|
|
||||||
const ws = new WSClient(`ws://127.0.0.1:${port}/ws`);
|
|
||||||
const result = await new Promise<string>((resolve) => {
|
|
||||||
ws.on("open", () => resolve("opened"));
|
|
||||||
ws.on("unexpected-response", (_req, res) => resolve(`status:${res.statusCode}`));
|
|
||||||
ws.on("error", () => resolve("error"));
|
|
||||||
});
|
|
||||||
expect(result).toMatch(/^status:401$|^error$/);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("accepts upgrade with a valid cookie", async () => {
|
|
||||||
const ws = new WSClient(`ws://127.0.0.1:${port}/ws`, {
|
|
||||||
headers: { Cookie: `${SESSION_COOKIE_NAME}=${validToken}` },
|
|
||||||
});
|
|
||||||
const msg = await new Promise<string>((resolve, reject) => {
|
|
||||||
ws.on("message", (data) => resolve(data.toString()));
|
|
||||||
ws.on("error", reject);
|
|
||||||
});
|
|
||||||
expect(msg).toBe("hello");
|
|
||||||
ws.close();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+14
-52
@@ -10,9 +10,8 @@ export function setupWebSocket(
|
|||||||
): () => void {
|
): () => void {
|
||||||
const clients = new Set<WebSocket>();
|
const clients = new Set<WebSocket>();
|
||||||
|
|
||||||
/** Track which bot instances have listeners attached (keyed by id, storing ref) */
|
/** Track which bots already have listeners attached */
|
||||||
const attachedBots = new Map<string, {
|
const attachedBots = new Map<string, {
|
||||||
bot: BotInstance;
|
|
||||||
stateChange: () => void;
|
stateChange: () => void;
|
||||||
connected: () => void;
|
connected: () => void;
|
||||||
disconnected: () => void;
|
disconnected: () => void;
|
||||||
@@ -40,31 +39,13 @@ export function setupWebSocket(
|
|||||||
const message = JSON.stringify(data);
|
const message = JSON.stringify(data);
|
||||||
for (const client of clients) {
|
for (const client of clients) {
|
||||||
if (client.readyState === WebSocket.OPEN) {
|
if (client.readyState === WebSocket.OPEN) {
|
||||||
try {
|
client.send(message);
|
||||||
client.send(message);
|
|
||||||
} catch {
|
|
||||||
clients.delete(client);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
function detachBotListener(id: string): void {
|
|
||||||
const existing = attachedBots.get(id);
|
|
||||||
if (!existing) return;
|
|
||||||
existing.bot.removeListener("stateChange", existing.stateChange);
|
|
||||||
existing.bot.removeListener("connected", existing.connected);
|
|
||||||
existing.bot.removeListener("disconnected", existing.disconnected);
|
|
||||||
attachedBots.delete(id);
|
|
||||||
}
|
|
||||||
|
|
||||||
function attachBotListener(bot: BotInstance): void {
|
function attachBotListener(bot: BotInstance): void {
|
||||||
const existing = attachedBots.get(bot.id);
|
if (attachedBots.has(bot.id)) return;
|
||||||
if (existing) {
|
|
||||||
if (existing.bot === bot) return; // already attached to this instance
|
|
||||||
// Bot instance was replaced (e.g. startBot re-created it) — re-attach
|
|
||||||
detachBotListener(bot.id);
|
|
||||||
}
|
|
||||||
|
|
||||||
const onStateChange = () => {
|
const onStateChange = () => {
|
||||||
broadcast({
|
broadcast({
|
||||||
@@ -96,7 +77,6 @@ export function setupWebSocket(
|
|||||||
bot.on("disconnected", onDisconnected);
|
bot.on("disconnected", onDisconnected);
|
||||||
|
|
||||||
attachedBots.set(bot.id, {
|
attachedBots.set(bot.id, {
|
||||||
bot,
|
|
||||||
stateChange: onStateChange,
|
stateChange: onStateChange,
|
||||||
connected: onConnected,
|
connected: onConnected,
|
||||||
disconnected: onDisconnected,
|
disconnected: onDisconnected,
|
||||||
@@ -110,39 +90,21 @@ export function setupWebSocket(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// React immediately when a bot instance is created or replaced
|
// Check for newly added bots periodically
|
||||||
const onBotInstance = (bot: BotInstance) => attachBotListener(bot);
|
const intervalId = setInterval(ensureAllBotsAttached, 5000);
|
||||||
botManager.on("botInstance", onBotInstance);
|
|
||||||
|
|
||||||
// React when a bot is removed: detach its listener and tell clients to drop it
|
|
||||||
const onBotInstanceRemoved = (id: string) => {
|
|
||||||
detachBotListener(id);
|
|
||||||
broadcast({ type: "botRemoved", botId: id });
|
|
||||||
};
|
|
||||||
botManager.on("botInstanceRemoved", onBotInstanceRemoved);
|
|
||||||
|
|
||||||
/** Drop attached listeners whose bot is no longer in the manager. */
|
|
||||||
function reconcileAttachedBots(): void {
|
|
||||||
const liveIds = new Set(botManager.getAllBots().map((b) => b.id));
|
|
||||||
for (const id of Array.from(attachedBots.keys())) {
|
|
||||||
if (!liveIds.has(id)) detachBotListener(id);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Safety net: periodically re-check in case any bot was missed
|
|
||||||
const intervalId = setInterval(() => {
|
|
||||||
reconcileAttachedBots();
|
|
||||||
ensureAllBotsAttached();
|
|
||||||
}, 5000);
|
|
||||||
ensureAllBotsAttached();
|
ensureAllBotsAttached();
|
||||||
|
|
||||||
return () => {
|
return () => {
|
||||||
clearInterval(intervalId);
|
clearInterval(intervalId);
|
||||||
botManager.removeListener("botInstance", onBotInstance);
|
// Clean up named listeners
|
||||||
botManager.removeListener("botInstanceRemoved", onBotInstanceRemoved);
|
for (const bot of botManager.getAllBots()) {
|
||||||
// Clean up all attached listeners (detach from stored bot refs, not live map)
|
const listeners = attachedBots.get(bot.id);
|
||||||
for (const id of Array.from(attachedBots.keys())) {
|
if (listeners) {
|
||||||
detachBotListener(id);
|
bot.removeListener("stateChange", listeners.stateChange);
|
||||||
|
bot.removeListener("connected", listeners.connected);
|
||||||
|
bot.removeListener("disconnected", listeners.disconnected);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
attachedBots.clear();
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -3,10 +3,6 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
<!-- Bilibili / NetEase / QQ image CDNs reject requests whose Referer is not on their whitelist.
|
|
||||||
Setting no-referrer at the document level covers <img> tags AND CSS background-image fetches.
|
|
||||||
Our own /api/* CSRF check uses Origin (not Referer), so this doesn't break auth. -->
|
|
||||||
<meta name="referrer" content="no-referrer">
|
|
||||||
<title>TSMusicBot</title>
|
<title>TSMusicBot</title>
|
||||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||||
<link href="https://fonts.googleapis.com/css2?family=Barlow:wght@400;500;600;700;800&display=swap" rel="stylesheet">
|
<link href="https://fonts.googleapis.com/css2?family=Barlow:wght@400;500;600;700;800&display=swap" rel="stylesheet">
|
||||||
|
|||||||
Generated
+57
@@ -797,6 +797,9 @@
|
|||||||
"arm"
|
"arm"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -818,6 +821,9 @@
|
|||||||
"arm"
|
"arm"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -839,6 +845,9 @@
|
|||||||
"arm64"
|
"arm64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -860,6 +869,9 @@
|
|||||||
"arm64"
|
"arm64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -881,6 +893,9 @@
|
|||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -902,6 +917,9 @@
|
|||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1070,6 +1088,9 @@
|
|||||||
"arm"
|
"arm"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1084,6 +1105,9 @@
|
|||||||
"arm"
|
"arm"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1098,6 +1122,9 @@
|
|||||||
"arm64"
|
"arm64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1112,6 +1139,9 @@
|
|||||||
"arm64"
|
"arm64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1126,6 +1156,9 @@
|
|||||||
"loong64"
|
"loong64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1140,6 +1173,9 @@
|
|||||||
"loong64"
|
"loong64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1154,6 +1190,9 @@
|
|||||||
"ppc64"
|
"ppc64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1168,6 +1207,9 @@
|
|||||||
"ppc64"
|
"ppc64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1182,6 +1224,9 @@
|
|||||||
"riscv64"
|
"riscv64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1196,6 +1241,9 @@
|
|||||||
"riscv64"
|
"riscv64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1210,6 +1258,9 @@
|
|||||||
"s390x"
|
"s390x"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1224,6 +1275,9 @@
|
|||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"glibc"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
@@ -1238,6 +1292,9 @@
|
|||||||
"x64"
|
"x64"
|
||||||
],
|
],
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"libc": [
|
||||||
|
"musl"
|
||||||
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"os": [
|
"os": [
|
||||||
|
|||||||
+2
-303
@@ -5,152 +5,32 @@
|
|||||||
<RouterView />
|
<RouterView />
|
||||||
</main>
|
</main>
|
||||||
<Player />
|
<Player />
|
||||||
<Toast />
|
|
||||||
<Queue class="mobile-queue" :open="mobileQueueOpen" @close="mobileQueueOpen = false" />
|
|
||||||
|
|
||||||
<!-- Mobile mini player -->
|
|
||||||
<div v-if="currentSong" class="m-player" @click="router.push('/lyrics')">
|
|
||||||
<div class="m-player-progress">
|
|
||||||
<div class="m-player-progress-fill" :style="{ width: mobileProgressPct + '%' }" />
|
|
||||||
</div>
|
|
||||||
<CoverArt :url="currentSong.coverUrl" :size="40" :radius="8" />
|
|
||||||
<div class="m-player-info">
|
|
||||||
<div class="m-player-name">{{ currentSong.name }}</div>
|
|
||||||
<div class="m-player-artist">{{ currentSong.artist }}</div>
|
|
||||||
</div>
|
|
||||||
<div class="m-player-controls" @click.stop>
|
|
||||||
<button class="m-player-btn" @click="playerStore.prev()">
|
|
||||||
<Icon icon="mdi:skip-previous" />
|
|
||||||
</button>
|
|
||||||
<button class="m-player-btn" @click="playerStore.isPlaying ? playerStore.pause() : playerStore.resume()">
|
|
||||||
<Icon :icon="playerStore.isPlaying ? 'mdi:pause' : 'mdi:play'" />
|
|
||||||
</button>
|
|
||||||
<button class="m-player-btn" @click="playerStore.next()">
|
|
||||||
<Icon icon="mdi:skip-next" />
|
|
||||||
</button>
|
|
||||||
<button class="m-player-btn" @click="cycleMobileMode">
|
|
||||||
<Icon :icon="mobileModeIcon" />
|
|
||||||
</button>
|
|
||||||
<button class="m-player-btn" @click="toggleMobileQueue">
|
|
||||||
<Icon icon="mdi:playlist-music" />
|
|
||||||
</button>
|
|
||||||
<button class="m-player-btn" @click="toggleMobileVolume">
|
|
||||||
<Icon icon="mdi:volume-high" />
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
<div v-if="mobileVolumeOpen" class="m-volume-popover" @click.stop>
|
|
||||||
<Icon icon="mdi:volume-high" class="m-volume-icon" />
|
|
||||||
<input
|
|
||||||
type="range"
|
|
||||||
min="0"
|
|
||||||
max="100"
|
|
||||||
:value="mobileVolume"
|
|
||||||
class="m-volume-slider"
|
|
||||||
@input="onMobileVolumeChange"
|
|
||||||
/>
|
|
||||||
<span class="m-volume-value">{{ mobileVolume }}</span>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Mobile bottom tab bar -->
|
|
||||||
<nav class="m-tabbar">
|
|
||||||
<RouterLink to="/" class="m-tab" :class="{ active: route.path === '/' }">
|
|
||||||
<Icon icon="mdi:home" class="tab-icon" />
|
|
||||||
<span class="tab-label">发现</span>
|
|
||||||
</RouterLink>
|
|
||||||
<RouterLink to="/search" class="m-tab" :class="{ active: route.path === '/search' }">
|
|
||||||
<Icon icon="mdi:magnify" class="tab-icon" />
|
|
||||||
<span class="tab-label">搜索</span>
|
|
||||||
</RouterLink>
|
|
||||||
<RouterLink to="/library" class="m-tab" :class="{ active: route.path === '/library' }">
|
|
||||||
<Icon icon="mdi:music-box-multiple" class="tab-icon" />
|
|
||||||
<span class="tab-label">音乐库</span>
|
|
||||||
</RouterLink>
|
|
||||||
<RouterLink to="/settings" class="m-tab" :class="{ active: route.path.startsWith('/settings') }">
|
|
||||||
<Icon icon="mdi:cog" class="tab-icon" />
|
|
||||||
<span class="tab-label">设置</span>
|
|
||||||
</RouterLink>
|
|
||||||
</nav>
|
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { computed, onMounted, onUnmounted, ref } from 'vue';
|
import { computed, onMounted, onUnmounted } from 'vue';
|
||||||
import { useRoute, useRouter } from 'vue-router';
|
|
||||||
import { Icon } from '@iconify/vue';
|
|
||||||
import { usePlayerStore } from './stores/player.js';
|
import { usePlayerStore } from './stores/player.js';
|
||||||
import { useWebSocket } from './composables/useWebSocket.js';
|
import { useWebSocket } from './composables/useWebSocket.js';
|
||||||
import Navbar from './components/Navbar.vue';
|
import Navbar from './components/Navbar.vue';
|
||||||
import Player from './components/Player.vue';
|
import Player from './components/Player.vue';
|
||||||
import CoverArt from './components/CoverArt.vue';
|
|
||||||
import Toast from './components/Toast.vue';
|
|
||||||
import Queue from './components/Queue.vue';
|
|
||||||
|
|
||||||
const playerStore = usePlayerStore();
|
const playerStore = usePlayerStore();
|
||||||
const theme = computed(() => playerStore.theme);
|
const theme = computed(() => playerStore.theme);
|
||||||
const route = useRoute();
|
|
||||||
const router = useRouter();
|
|
||||||
const { connect } = useWebSocket();
|
const { connect } = useWebSocket();
|
||||||
const currentSong = computed(() => playerStore.currentSong);
|
|
||||||
const mobileVolume = computed(() => playerStore.activeBot?.volume ?? 75);
|
|
||||||
const mobileMode = computed(() => playerStore.activeBot?.playMode ?? 'seq');
|
|
||||||
const mobileModeOrder = ['seq', 'loop', 'random', 'rloop'];
|
|
||||||
const mobileModeIcons: Record<string, string> = {
|
|
||||||
seq: 'mdi:arrow-right',
|
|
||||||
loop: 'mdi:repeat',
|
|
||||||
random: 'mdi:shuffle',
|
|
||||||
rloop: 'mdi:repeat-once',
|
|
||||||
};
|
|
||||||
const mobileModeIcon = computed(() => mobileModeIcons[mobileMode.value] ?? mobileModeIcons.seq);
|
|
||||||
const mobileVolumeOpen = ref(false);
|
|
||||||
const mobileQueueOpen = ref(false);
|
|
||||||
|
|
||||||
const mobileProgressPct = ref(0);
|
|
||||||
let syncTimer: ReturnType<typeof setInterval> | null = null;
|
let syncTimer: ReturnType<typeof setInterval> | null = null;
|
||||||
let mobileRaf: number | null = null;
|
|
||||||
|
|
||||||
function updateMobileProgress() {
|
|
||||||
const duration = currentSong.value?.duration ?? 0;
|
|
||||||
mobileProgressPct.value = duration > 0
|
|
||||||
? Math.min((playerStore.elapsed / duration) * 100, 100)
|
|
||||||
: 0;
|
|
||||||
mobileRaf = requestAnimationFrame(updateMobileProgress);
|
|
||||||
}
|
|
||||||
|
|
||||||
function onMobileVolumeChange(e: Event) {
|
|
||||||
const volume = Number((e.target as HTMLInputElement).value);
|
|
||||||
playerStore.setVolume(volume);
|
|
||||||
}
|
|
||||||
|
|
||||||
function toggleMobileVolume() {
|
|
||||||
mobileVolumeOpen.value = !mobileVolumeOpen.value;
|
|
||||||
if (mobileVolumeOpen.value) mobileQueueOpen.value = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
function toggleMobileQueue() {
|
|
||||||
mobileQueueOpen.value = !mobileQueueOpen.value;
|
|
||||||
if (mobileQueueOpen.value) mobileVolumeOpen.value = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
function cycleMobileMode() {
|
|
||||||
const currentIndex = mobileModeOrder.indexOf(mobileMode.value);
|
|
||||||
const nextMode = mobileModeOrder[(currentIndex + 1) % mobileModeOrder.length] ?? mobileModeOrder[0];
|
|
||||||
mobileVolumeOpen.value = false;
|
|
||||||
mobileQueueOpen.value = false;
|
|
||||||
playerStore.setMode(nextMode);
|
|
||||||
}
|
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
playerStore.loadTheme();
|
playerStore.loadTheme();
|
||||||
connect();
|
connect();
|
||||||
playerStore.fetchBots();
|
playerStore.fetchBots();
|
||||||
|
// Periodically sync elapsed time from server (ground truth)
|
||||||
syncTimer = setInterval(() => playerStore.syncElapsed(), 3000);
|
syncTimer = setInterval(() => playerStore.syncElapsed(), 3000);
|
||||||
mobileRaf = requestAnimationFrame(updateMobileProgress);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
onUnmounted(() => {
|
onUnmounted(() => {
|
||||||
if (syncTimer) clearInterval(syncTimer);
|
if (syncTimer) clearInterval(syncTimer);
|
||||||
if (mobileRaf !== null) cancelAnimationFrame(mobileRaf);
|
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
@@ -167,186 +47,5 @@ onUnmounted(() => {
|
|||||||
@media (max-width: 1336px) {
|
@media (max-width: 1336px) {
|
||||||
padding: 80px 5vw 80px;
|
padding: 80px 5vw 80px;
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (max-width: 768px) {
|
|
||||||
padding: 72px 16px 200px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Mobile mini player
|
|
||||||
.m-player {
|
|
||||||
position: fixed;
|
|
||||||
left: 8px;
|
|
||||||
right: 8px;
|
|
||||||
bottom: 68px;
|
|
||||||
height: 58px;
|
|
||||||
padding: 8px 10px;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 10px;
|
|
||||||
background: var(--bg-secondary);
|
|
||||||
border-radius: var(--radius-md);
|
|
||||||
box-shadow: 0 6px 20px rgba(0, 0, 0, 0.35);
|
|
||||||
z-index: 95;
|
|
||||||
cursor: pointer;
|
|
||||||
|
|
||||||
@media (min-width: 769px) {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.mobile-queue {
|
|
||||||
display: none;
|
|
||||||
|
|
||||||
@media (max-width: 768px) {
|
|
||||||
display: flex;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-progress {
|
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
left: 10px;
|
|
||||||
right: 10px;
|
|
||||||
height: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-progress-fill {
|
|
||||||
height: 2px;
|
|
||||||
background: var(--color-primary);
|
|
||||||
border-radius: 1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-info {
|
|
||||||
flex: 1;
|
|
||||||
min-width: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-controls {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 4px;
|
|
||||||
flex: 0 0 auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-name {
|
|
||||||
font-size: 13px;
|
|
||||||
font-weight: 500;
|
|
||||||
white-space: nowrap;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-artist {
|
|
||||||
font-size: 11px;
|
|
||||||
color: var(--text-secondary);
|
|
||||||
white-space: nowrap;
|
|
||||||
overflow: hidden;
|
|
||||||
text-overflow: ellipsis;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-player-btn {
|
|
||||||
width: 28px;
|
|
||||||
height: 32px;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
font-size: 20px;
|
|
||||||
opacity: 0.85;
|
|
||||||
flex-shrink: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-volume-popover {
|
|
||||||
position: absolute;
|
|
||||||
right: 8px;
|
|
||||||
bottom: calc(100% + 8px);
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 8px;
|
|
||||||
width: min(260px, calc(100vw - 32px));
|
|
||||||
padding: 10px 12px;
|
|
||||||
background: var(--bg-secondary);
|
|
||||||
border: 1px solid var(--border-color);
|
|
||||||
border-radius: var(--radius-md);
|
|
||||||
box-shadow: var(--shadow-dropdown);
|
|
||||||
cursor: default;
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-volume-icon {
|
|
||||||
flex: 0 0 auto;
|
|
||||||
font-size: 18px;
|
|
||||||
color: var(--text-secondary);
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-volume-slider {
|
|
||||||
flex: 1 1 auto;
|
|
||||||
min-width: 0;
|
|
||||||
height: 4px;
|
|
||||||
appearance: none;
|
|
||||||
background: var(--border-color);
|
|
||||||
border-radius: 2px;
|
|
||||||
outline: none;
|
|
||||||
|
|
||||||
&::-webkit-slider-thumb {
|
|
||||||
appearance: none;
|
|
||||||
width: 16px;
|
|
||||||
height: 16px;
|
|
||||||
background: var(--color-primary);
|
|
||||||
border-radius: 50%;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-volume-value {
|
|
||||||
flex: 0 0 30px;
|
|
||||||
font-size: 12px;
|
|
||||||
color: var(--text-secondary);
|
|
||||||
text-align: right;
|
|
||||||
font-variant-numeric: tabular-nums;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Mobile bottom tab bar
|
|
||||||
.m-tabbar {
|
|
||||||
position: fixed;
|
|
||||||
left: 0;
|
|
||||||
right: 0;
|
|
||||||
bottom: 0;
|
|
||||||
height: 60px;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: space-around;
|
|
||||||
padding-bottom: env(safe-area-inset-bottom, 0);
|
|
||||||
background: var(--bg-navbar);
|
|
||||||
backdrop-filter: saturate(180%) blur(20px);
|
|
||||||
-webkit-backdrop-filter: saturate(180%) blur(20px);
|
|
||||||
border-top: 1px solid var(--border-color);
|
|
||||||
z-index: 100;
|
|
||||||
|
|
||||||
@media (min-width: 769px) {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.m-tab {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
align-items: center;
|
|
||||||
gap: 2px;
|
|
||||||
padding: 6px 14px;
|
|
||||||
color: var(--text-tertiary);
|
|
||||||
text-decoration: none;
|
|
||||||
font-family: inherit;
|
|
||||||
|
|
||||||
&.active {
|
|
||||||
color: var(--color-primary);
|
|
||||||
}
|
|
||||||
|
|
||||||
.tab-icon {
|
|
||||||
font-size: 22px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tab-label {
|
|
||||||
font-size: 10px;
|
|
||||||
font-weight: 500;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
import router from '../router/index.js';
|
|
||||||
import { useSession } from '../composables/useSession.js';
|
|
||||||
|
|
||||||
let installed = false;
|
|
||||||
const nativeFetch: typeof window.fetch = window.fetch.bind(window);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Wraps fetch so every call:
|
|
||||||
* - sends cookies (`credentials: 'same-origin'`)
|
|
||||||
* - on 401 from /api/*: clear local session, redirect to /login
|
|
||||||
*
|
|
||||||
* Always uses the captured native fetch, never the (possibly wrapped) global.
|
|
||||||
*/
|
|
||||||
export function apiFetch(input: RequestInfo | URL, init: RequestInit = {}): Promise<Response> {
|
|
||||||
const merged: RequestInit = {
|
|
||||||
credentials: 'same-origin',
|
|
||||||
...init,
|
|
||||||
headers: { ...(init.headers ?? {}) },
|
|
||||||
};
|
|
||||||
return nativeFetch(input, merged).then(async (res) => {
|
|
||||||
if (res.status === 401 && shouldTriggerRefresh(input)) {
|
|
||||||
const session = useSession();
|
|
||||||
await session.refresh();
|
|
||||||
const current = router.currentRoute.value;
|
|
||||||
if (current.name !== 'login' && current.name !== 'first-run') {
|
|
||||||
await router.replace({ name: 'login', query: { next: current.fullPath } });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return res;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function shouldTriggerRefresh(input: RequestInfo | URL): boolean {
|
|
||||||
const url = typeof input === 'string' ? input : input instanceof URL ? input.toString() : input.url;
|
|
||||||
return url.startsWith('/api/') && !url.startsWith('/api/session/');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Replaces window.fetch with apiFetch so existing call sites do not need to be touched.
|
|
||||||
* Call once at app startup.
|
|
||||||
*/
|
|
||||||
export function installApiClient(): void {
|
|
||||||
if (installed) return;
|
|
||||||
installed = true;
|
|
||||||
window.fetch = ((input: RequestInfo | URL, init?: RequestInit) => {
|
|
||||||
return apiFetch(input, init ?? {});
|
|
||||||
}) as typeof window.fetch;
|
|
||||||
(window as unknown as { __originalFetch?: typeof fetch }).__originalFetch = nativeFetch;
|
|
||||||
}
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
<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; }
|
|
||||||
|
|
||||||
.btn-sm {
|
|
||||||
padding: 6px 14px;
|
|
||||||
background: var(--hover-bg);
|
|
||||||
border-radius: var(--radius-sm);
|
|
||||||
font-size: 12px;
|
|
||||||
font-weight: 600;
|
|
||||||
transition: all var(--transition-fast);
|
|
||||||
&:hover { background: var(--color-primary); color: white; }
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn-danger {
|
|
||||||
&:hover { background: #f44336; color: white; }
|
|
||||||
}
|
|
||||||
|
|
||||||
.hint { font-size: 12px; opacity: 0.6; margin: 0; }
|
|
||||||
.hint.error { color: #f44336; opacity: 1; }
|
|
||||||
</style>
|
|
||||||
Loaded 100 of 124 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user