feat(server,web,desktop,shared,deploy,plugin): 数据库管理模块 + 客户端深色模式/设置拆子路由/首启引导,版本统一 1.0.0
- 服务端新增 database 模块(/api/database/*,仅 ADMIN):全库 JSON 快照(备份 / 恢复 / 导入导出 / 定时备份
共用同一格式,14 张表按拓扑序导出、恢复时关外键检查)、连接测试与目标库校验、一键 SQLite ⇄ MySQL 切换
(备份 → 导出 → 测试连接 → 校验空库 → 改 schema → 子进程 generate / tsc / db push → 写数据,全部成功才改写
.env,中途失败回滚 schema);XML 快照与 SQLite 数据文件均可下载;打包形态随包带上 prisma CLI 与 typescript
(prisma-client 生成物是 .ts,需再编进 dist/generated,安装包因之变大)
- Web 管理端新增「数据库管理」页(仅管理员),并加首次登录新手引导(el-tour,可跳过、可随时重看,版本号写
localStorage,改版后老用户会再收到一次)
- 客户端设置改版:侧边栏改为分组折叠菜单,设置拆成 6 个子路由
(/settings/{general,appearance,island,reminder,account,about}),新增深色模式(主题持久化到主进程配置,
主窗口底色跟主题走,避免"先白后黑"闪一下),新增「关于」页(应用信息 / 诊断信息)
- 客户端新增首启六步引导(OnboardingWelcome,状态存主进程配置 onboardingDone)
- 客户端主窗口初始尺寸与 ClassIsland 对齐(1242x582 / minHeight 540 / 居中)
- 版本号统一提升到 1.0.0:5 个 package.json、部署配置与镜像标签(.env.example / docker-compose / Dockerfile)、
服务端 /health 与首页、插件 manifest.yml 与 BridgeService.PluginVersion、文档里的安装包名
- 文档与验收同步:AGENTS.md 补第 37~51 条约定(深色主题实现边界、设置子路由、数据库管理三件事、侧栏与窗口
尺寸、引导在自动化里的判据等),README 补「数据库管理 / 新手引导 / 设置改版」三节;verify:e2e 增补 13 条
数据库管理用例,客户端冒烟与 Web UI 冒烟跟进子路由、深色主题、侧栏与引导
验证:pnpm lint 0 error;pnpm typecheck 全过;verify:e2e 186/186;verify:classisland-plugin 68/68;
build:desktop 通过(含产物凭据门禁);verify:desktop 99/102(3 项为上课时段下的"真实通知链路"用例,
客户端按产品规则暂存普通通知所致,见下);插件 dotnet 编译 0 错误。
注:verify:desktop 的「真实通知链路 / 标记已读」三项要求当前不在上课时段——本次运行时种子课表恰有
「周五 10:55-11:40 生物」正在进行,客户端正确地暂存了普通通知(AGENTS.md 第 18 条),属时间相关用例,
与本次改动无关。
This commit is contained in:
1 parent
391e2c1591
commit
572295c297
66 files changed
+5131
-1027
No files matched your search
@@ -25,6 +25,8 @@ export const API_PATHS = {
|
||||
imports: '/imports',
|
||||
/** ClassIsland 联动:设备接入、状态上报、通知下发 */
|
||||
integrations: '/integrations',
|
||||
/** 数据库管理(仅管理员):状态/备份/导入导出/一键切换 */
|
||||
database: '/database',
|
||||
dashboard: '/dashboard/summary',
|
||||
} as const;
|
||||
|
||||
@@ -476,6 +478,12 @@ export const STORAGE_KEYS = {
|
||||
serverUrl: 'classhelper.serverUrl',
|
||||
cachePrefix: 'classhelper.cache',
|
||||
lastSyncAt: 'classhelper.lastSyncAt',
|
||||
/**
|
||||
* 新手引导「已看过」标记(Web 管理端 localStorage)。
|
||||
* 值为引导版本号:改版引导内容后版本 +1,看过旧版的老用户会再收到一次新版引导。
|
||||
* EXE 客户端不用这个键 —— 它的引导状态在主进程配置(`onboardingDone`)里。
|
||||
*/
|
||||
onboarding: 'classhelper.onboarding',
|
||||
} as const;
|
||||
|
||||
/** 桌面客户端默认后端地址 */
|
||||
|
||||
@@ -1017,3 +1017,84 @@ export interface SocketAuthPayload {
|
||||
token: string;
|
||||
clientType?: 'admin' | 'desktop';
|
||||
}
|
||||
|
||||
/* ================================================================ 数据库管理(仅管理员) */
|
||||
|
||||
/** 数据库管理支持的提供方(Redis 等键值库不是 Prisma 支持的主库,不在范围内) */
|
||||
export type DatabaseProvider = 'sqlite' | 'mysql';
|
||||
|
||||
/** GET /api/database/status 的返回 */
|
||||
export interface DatabaseStatusDto {
|
||||
provider: DatabaseProvider;
|
||||
connected: boolean;
|
||||
/** ping 延迟(毫秒);未连接时为 null */
|
||||
latencyMs: number | null;
|
||||
/** 数据库引擎版本(sqlite_version() / VERSION()) */
|
||||
version: string | null;
|
||||
/** 数据体积(字节);MySQL 取 information_schema 汇总 */
|
||||
sizeBytes: number | null;
|
||||
/** 当前连接串的脱敏展示(MySQL 隐藏密码) */
|
||||
databaseUrlMasked: string;
|
||||
/** SQLite 数据文件绝对路径(MySQL 为空串) */
|
||||
sqliteFilePath: string;
|
||||
/** 数据目录(备份与定时配置所在处) */
|
||||
dataDir: string;
|
||||
backupDir: string;
|
||||
tables: DatabaseTableCountDto[];
|
||||
backups: DatabaseBackupMetaDto[];
|
||||
schedule: DatabaseBackupScheduleDto;
|
||||
/** 是否有正在进行的切换任务(期间禁止备份/导入/恢复) */
|
||||
switchRunning: boolean;
|
||||
}
|
||||
|
||||
export interface DatabaseTableCountDto {
|
||||
name: string;
|
||||
/** -1 表示统计失败(表结构与代码不一致时出现) */
|
||||
count: number;
|
||||
}
|
||||
|
||||
export interface DatabaseBackupMetaDto {
|
||||
name: string;
|
||||
kind: 'manual' | 'auto';
|
||||
sizeBytes: number;
|
||||
createdAt: string;
|
||||
}
|
||||
|
||||
export interface DatabaseBackupScheduleDto {
|
||||
enabled: boolean;
|
||||
intervalHours: number;
|
||||
keepCount: number;
|
||||
lastAutoBackupAt: string | null;
|
||||
}
|
||||
|
||||
/** POST /api/database/test-connection 的返回 */
|
||||
export interface DatabaseConnectionTestDto {
|
||||
ok: boolean;
|
||||
provider: DatabaseProvider;
|
||||
latencyMs: number | null;
|
||||
version: string | null;
|
||||
/** 新建 SQLite 库时目标文件还不存在,属正常情况(切换时会自动建库) */
|
||||
note?: string;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/** 数据库切换任务(POST /switch 后用 jobId 轮询) */
|
||||
export interface DatabaseSwitchJobDto {
|
||||
id: string;
|
||||
status: 'running' | 'done' | 'error';
|
||||
target: { provider: DatabaseProvider; url: string };
|
||||
steps: DatabaseSwitchStepDto[];
|
||||
error?: string;
|
||||
/** 完成后为 true:需要重启服务端才能让新数据库生效 */
|
||||
restartRequired: boolean;
|
||||
counts?: Record<string, number>;
|
||||
backupName?: string;
|
||||
startedAt: string;
|
||||
finishedAt?: string;
|
||||
}
|
||||
|
||||
export interface DatabaseSwitchStepDto {
|
||||
name: string;
|
||||
status: 'running' | 'done' | 'error';
|
||||
detail?: string;
|
||||
}
|
||||
Reference in new issue
Block a user