Files
ClassHelper/docs/dev/index.md
T
LoveChengke b7cdc7c9ea fix(clients,client,web): 远控指令的两个修复 —— 执行失败不再谎报成功 + 「上次指令」让"点了没反应"可见(1.3.2)
背景:用户报「下发锁屏等等指令不生效」。先把服务端那条链路单独验了一遍
(模拟客户端:登记 → 下发 → 心跳带回 → 设备列表可见 → 回执 → 清除),**整条是通的**;
真正的问题在两处。

客户端:执行失败会谎报成功
- `spawn` 找不到可执行文件 / 没权限时**不抛异常**,而是在下一个 tick 发一个异步 `error` 事件 ——
  只包 `try/catch` 抓不到,代码一路走到 `return { ok: true }`,回执写着「已下达系统命令」,
  Web 端看起来一切正常而机器纹丝不动
- 现在等一个 200ms 的窗口确认没有立刻报错,失败如实回执(`client-agent.ts` 的 `executeCommand`)

Web 端:点了没生效,界面上什么都不说
- 一条命令被**取消 / 过期**之后就从 `pendingCommand` 里消失,页面留白 ——
  而最常见的两种"没反应"恰恰是「本机没人确认(客户端 60 秒自动按取消)」与「下达时机器离线」
- `GET /clients/devices` 增加 `lastCommand`(最近一条,不论状态);
  「客户端」页的设备表多一列「上次指令」,由 `commandStateText()` 翻成一句人话
  (已执行 / 本机用户取消 / 已过期 —— 下达时机器不在线 / 待执行)
- 下发成功的提示补上「60 秒内没人点确认就按取消处理」

文档
- AGENTS.md §5 第 69 条记下这两条,并写明排查同类反馈的顺序:**先看那台机器的客户端版本是否 ≥ 1.3.0**
  (远控命令的处理 `client-agent.ts` 是 1.3.0 才有的,旧客户端连心跳都不发)
- docs/reference.md 4.15 的表格补上「二次确认」的准确口径与新增的「上次指令」列

验收:`lint` / `typecheck` / `check:icons` / `docs:check` 全绿;
后端端到端 **247/247**、联动链路 **44/44**、插件静态契约 **76/76**、
Web 真实点击 **34/34**、客户端冒烟 **90/90**;
远控链路另用模拟客户端跑通,并确认新增的「上次指令」在待执行与已回执两种状态下都显示正确。
2026-10-11 17:00:11 +08:00

3.6 KiB
Raw Blame History

title, description
title description
开发文档 ClassHelper的架构、接口、数据模型、权限、动效层,以及验收与发版流程。

开发文档

ClassHelper是一个 pnpm monorepo,一份代码产出四个交付物:

交付物 位置 形态
后端服务 packages/server Express 5 + Prisma 7 + Socket.IO,接口前缀 /api
Web 管理端 packages/web-admin Vue 3 + Vite + Element Plus(教师 / 管理员用,PWA 可安装)
桌面客户端 packages/desktop-client Electron + Vue 3(ClassHelper 班级端 / 教室机器,含灵动岛浮窗)
共享契约 packages/shared 三端共用的类型 / 常量 / 权限 / 工具函数
ClassIsland 联动插件 packages/classisland-plugin .NET 8 / C#(独立于 pnpm workspace,不参与 pnpm install)

核心链路:

教师在 Web 端发布内容
        │  REST API(JWT 鉴权)
        ▼
   后端服务(Express + Prisma)
        │  写库 + 按班级房间广播
        ▼
 Socket.IO ──► class:{classId} 房间 ──► 学生桌面客户端实时更新 UI(含灵动岛)

ClassIsland(教室机器)──► 联动插件 ──► /api/integrations/classisland/*(设备令牌鉴权)
                                  ▲                          │
                                  └──── 老师下发的提醒 ◄──────┘

这一章有什么

页面 内容
架构总览 目录结构、技术栈、模块化设计、几条贯穿全局的约定
REST API 全部接口一览(方法 / 路径 / 权限)
实时事件(Socket.IO) 事件清单、房间规则、新增事件要改哪三处
数据模型 24 张表、迁移历史、跨库约定
角色与权限 权限矩阵与实现位置
动效层与主题 beUI 令牌、CSS linear() 弹簧、深色主题
ClassIsland 插件 插件契约、镜像为什么要带 startTime、部署与调试
灵动岛设计令牌 岛逐项的几何 / 配色 / 排版 token
验收与测试 五套验收脚本怎么跑、哪些用例是脆弱的
版本迭代与发布 改版本号、出安装包、发 Release 的完整流程

仓库里另外两份文档

  • 完整参考 —— 产品说明书(原 README 全文),功能行为的权威来源; 仓库首页那份 README 是精简后的门面页,细节都在这里。
  • AGENTS.md —— 工程约定与开发环境注意事项,改代码前必读。里面每一条硬约定都对应一处容易踩空的地方, 比代码注释更值得先看一遍。