xiaoshuai
d854c95ee6
`npm install` 在 postinstall 阶段直接失败退出:
node-hid 编译报错 -> node-addon-api/napi.h:2477 expected unqualified-id
根因不是 node-hid 坏了, 是重建范围错了:
1. postinstall 跑的是 `electron-builder install-app-deps`, 它重建**所有**原生模块;
2. 它给子进程传 `npm_config_build_from_source=false` —— 但这是**字符串** "false",
npm 11 对未知的 npm_config_* 不做布尔转换;
3. pkg-prebuilds-verify 用 `if (process.env.npm_config_build_from_source)` 判断,
字符串 "false" 在 JS 里是真值 -> 直接 exit 1 -> 强制源码编译;
4. node-hid 于是去编译它自带的 node-addon-api 3.2.1, 和现代 Node 头文件不兼容 -> 编译失败
-> 整个 npm install 挂掉。
而 node-hid 根本不需要编译 —— 它自带 N-API 预编译产物, 任何 ABI 都能加载。
真正需要按 Electron ABI 重编的只有 better-sqlite3 (非 N-API, 绑死 V8/ABI,
Electron 32 -> node ABI 128); 其余 (@lydell/node-pty / node-hid /
@serialport/bindings-cpp / usb) 都是 N-API 预编译, 重编既没必要又有害。
改动:
- postinstall 换成 `node scripts/postinstall.js`:
只重建 better-sqlite3, 装完**在 Electron 下真跑一次读写校验**, 失败就 exit 1
—— 把"启动即崩"提前到 install 阶段暴露
- package.json 加 `allowScripts` 白名单 (npm 11 新机制, 目前只提醒不拦截,
但迟早会拦; 顺便让 npm install 输出干净)
- AGENTS.md 坑 #3 改写成新规矩 + 完整根因链
- docs/windows-compat.md / docs/remote-terminal-forward-usb.md 里过时的
"postinstall 走 install-app-deps" 表述一并纠正
验证:
- npm run build ✅
- npm run typecheck ✅ node + web
- npm run selftest ✅ 64 通过 / 0 失败
- npm run selftest:sync ✅ 全部通过
- npm run package:linux ✅ 新 deb
- npm run selftest:package ✅ 4/4 (从 app.asar 真实 spawn pty)
155 lines
12 KiB
Markdown
155 lines
12 KiB
Markdown
# LocalNetMsg Agent Guide
|
||
|
||
LAN instant-messaging desktop app. Stack: **Electron 32 + Vue 3 + TypeScript + Vite + Pinia + Element Plus + SQLite (better-sqlite3)**. Three independent processes built by `electron-vite`.
|
||
|
||
## Commands
|
||
|
||
| Task | Command |
|
||
|---|---|
|
||
| Dev (Electron + HMR) | `npm run dev` |
|
||
| Build (no installer) | `npm run build` |
|
||
| Typecheck main+preload | `npm run typecheck:node` |
|
||
| Typecheck renderer | `npm run typecheck:web` |
|
||
| Typecheck both | `npm run typecheck` |
|
||
| Remote feature self-test (terminal / forward / USB) | `npm run selftest` |
|
||
| Sync-drive end-to-end test (relation -> sync -> delete propagation) | `npm run selftest:sync` |
|
||
| Packaged-artifact smoke check (asar unpack + real pty spawn) | `npm run selftest:package` (run after `npm run package:*`) |
|
||
| Windows installer | `npm run package:win` → `dist-Electron\LocalNetMsg-0.1.0-Setup.exe` |
|
||
| macOS / Linux | `npm run package:mac` / `npm run package:linux` |
|
||
| Unpacked dir only | `npm run package:dir` |
|
||
|
||
All `package:*` scripts bake in `ELECTRON_MIRROR` + `ELECTRON_BUILDER_BINARIES_MIRROR` (npmmirror.com). Do not remove unless on the open internet.
|
||
|
||
`npm run selftest` runs the remote (terminal / port-forward / USB) self-test: one process, two virtual
|
||
nodes, real `ChatServer` + `ChatClient` + remote managers. See `scripts/selftest/`.
|
||
|
||
`npm run selftest:sync` runs the sync-drive end-to-end test (`scripts/selftest/sync-e2e.ts`): two virtual
|
||
nodes, real WS + HTTP, covering **建立关系 → 双向同步 → 改文件 → 删文件 → 删除传播 → 墓碑防复活**.
|
||
改同步引擎后跑它 —— 它守住的是"删了能删掉、删了不会复活"这两条命门。
|
||
|
||
Verify changes via `npm run typecheck` + `npm run selftest` + `npm run selftest:sync` + manual `npm run dev`.
|
||
|
||
## Layout
|
||
|
||
```
|
||
src/
|
||
main/ Electron main process (Node) — entry: index.ts
|
||
discovery.ts UDP broadcast beacon (multi-NIC, per-interface subnet bcast)
|
||
chat-server.ts WebSocketServer on 0.0.0.0:47900
|
||
chat-client.ts Outgoing WS with backoff reconnect
|
||
file-server.ts HTTP /upload + /file, default cap 100GB
|
||
db.ts SQLite via better-sqlite3 (data/app.db)
|
||
settings.ts electron-store wrapper (~/AppData/Roaming/local-net-msg/config.json)
|
||
notify.ts System Notification + Windows overlay badge
|
||
ipc.ts All ipcMain.handle() wiring
|
||
protocol.ts MessageEnvelope, WsFrame, DeviceInfo types
|
||
relations.ts 关系层: 持久绑定 + per-peer 令牌 + 分级授权 (JSON 存储)
|
||
relation-service.ts 关系服务(类): 建立/接受/拒绝/吊销 + 应用对方关系表
|
||
sync-manifest.ts 文件关系表: 墓碑 + Lamport seq + 三方对比 (同步盘地基)
|
||
sync.ts 同步引擎: 扫描 -> 三方对比 -> 上传/下载/删除传播
|
||
auto-sync.ts 自动同步定时器 (60s 轮询 + 指数退避)
|
||
preload/ contextBridge exposing typed API to renderer
|
||
renderer/ Vue 3 SPA (Vite root)
|
||
src/
|
||
main.ts createApp + Pinia + ElementPlus (full import) + zhCn
|
||
App.vue Global event listeners (device:*, message:*, settings:*)
|
||
components/ Sidebar, ChatView, MessageInput, MessageItem, SettingsView, MarkdownView
|
||
stores/ Pinia: device.ts, message.ts, session.ts
|
||
api.ts IPC typings (mirrors preload)
|
||
utils/ format.ts (colorFor, initialsOf, formatSize, ...)
|
||
electron.vite.config.ts Three builds → out/{main,preload,renderer}/
|
||
```
|
||
|
||
Renderer alias: `@` → `src/renderer/src`.
|
||
|
||
## 同步盘 (sync drive) — 三层模型
|
||
|
||
**发现 ≠ 信任**。拆成三层: 发现(临时) → 关系(持久, 用户显式建立) → 授权(分级, 双方各自独立)。
|
||
|
||
- **关系怎么建立**: 跟远程终端的授权闸门**完全一致** —— 对方**直接弹窗**, 不用邀请码/6位码/系统消息卡片。
|
||
`A 点"发起同步关系"` → WS 帧 `relation:request` → B 侧 `enqueueApproval()`(kind='relation') → 弹窗同意 → 回 `relation:accept`。
|
||
帧定义在 `protocol.ts`, 路由在 `ipc.ts` 的 `routeRelationFrame()`。
|
||
- **令牌**: `myToken`=我签发给对方的, `peerToken`=对方签发给我的。旧的全局 `driveToken`
|
||
**不再进 UDP 广播包** (同网段任何进程拿到广播包就能浏览你整个网盘)。file-server 在关系令牌
|
||
匹配不上时回退到旧的全局 token, 给还没升级的对端留过渡通道。
|
||
- **两套独立空间**:
|
||
- `/drive/*` 网盘 —— 要 `drive` 授权, 路径限制在网盘根内
|
||
- `/sync/*` 同步区 —— 要 `sync` 授权, 路径限制在**该关系的同步目录**内 (任意位置, 不必在网盘里)
|
||
只给 `sync` 时**完全不能**浏览网盘。
|
||
- **文件关系表 (manifest)**: 每个关系一份 (key=relationId, 所以同一个本地目录跟多个关系同步也不串)。
|
||
- **墓碑**: 删除不抹记录, 只标 `state='deleted'` —— 直接抹掉的话, 对方离线回来会把已删文件
|
||
当成"新增"重新下载, **删除永远删不掉**; 对方从备份恢复也会让删除被静默撤销。
|
||
- **seq = Lamport 时钟**: hash 只能答"一样不一样", seq 才能答"谁更晚" —— 判定删除方向的关键。
|
||
- **三方对比**: 基线(上次两边一致的 hash) + 本地 + 远端。缺基线时退回 mtime 兜底 (宁可多弹窗)。
|
||
- 墓碑保留 90 天 (比大品牌默认 30 天保守), 且要"对方已越过该 seq"才清理。
|
||
- 删除传播落点: `RelationService.applyPeerManifest()` —— 对方说删了, 我比对基线确认没改过才删本地;
|
||
改过则报冲突, **绝不静默丢数据**。
|
||
|
||
详细设计见 `docs/relation-and-sync.md`。
|
||
|
||
## Network protocol
|
||
|
||
UDP discovery on **47800**, chat WS on **47900**, file HTTP on **47901**. All three bind `0.0.0.0` and auto-shift on conflict.
|
||
|
||
`DeviceInfo` carries `address` (chosen from the first non-internal IPv4 of the responding NIC) plus `chatPort`/`filePort`. The chat server **sends no broadcast** of its own — discovery comes purely from UDP. Receiver uses `rinfo.address` (real source IP), never the payload's `self.address`.
|
||
|
||
## Hard-won pitfalls (don't repeat these)
|
||
|
||
1. **`chat-client` MUST have an `on('error')` listener.** Node EventEmitter throws `ERR_UNHANDLED_ERROR` and kills the main process if `'error'` fires with no listener. The WS `'error'` event is followed by `'close'` which triggers reconnect. Don't try to "fix" by emitting on the client; just `console.warn` and move on.
|
||
|
||
2. **Drag-drop file path.** Electron 32 removed `File.path`. Use `webUtils.getPathForFile(file)` from `electron` — exposed in `src/preload/index.ts` as `getPathForFile(file)`. Callers must read it via `window.api.getPathForFile(f)` BEFORE the await boundary.
|
||
|
||
3. **Native rebuild —— 只重建 `better-sqlite3`, 别用 `electron-builder install-app-deps`.**
|
||
`better-sqlite3` 不是 N-API, 绑死 V8/ABI (Electron 32 → node ABI 128), 必须对着 Electron
|
||
头文件编译; `npm i` 或升级 Electron 后必须重编, 否则 sqlite 打开即崩。
|
||
`postinstall` 现在是 `node scripts/postinstall.js`: 只重建 better-sqlite3, 装完**在 Electron 下
|
||
真跑一次读写校验** (失败就 exit 1, 把"启动即崩"提前到 install 阶段暴露)。
|
||
**别改回 `electron-builder install-app-deps`** —— 它重建**所有**原生模块, 且给子进程塞
|
||
`npm_config_build_from_source=false`; npm 11 对未知 npm_config_* 保留原始字符串, 于是子进程里
|
||
它是字符串 `"false"` —— JS 里是真值 —— `pkg-prebuilds-verify` 直接 exit 1
|
||
(`node_modules/pkg-prebuilds/bin/verify.mjs:14`), 强制源码编译。node-hid 于是去编译它自带的
|
||
node-addon-api 3.2.1, 和现代 Node 头文件不兼容, 编译失败, 整个 `npm install` 挂掉 ——
|
||
而它本来根本不需要编译 (自带 N-API 预编译产物, 任何 ABI 都能加载)。
|
||
同理, node-pty 1.2 的二进制在**平台包** `@lydell/node-pty-<plat>-<arch>` 里, 主包没有
|
||
`prebuilds/` 目录 —— 按主包去找只会误报。
|
||
npm 11 还有个 `allowScripts` 机制 (根 package.json 的 `allowScripts` 字段): 没被显式列入的
|
||
安装脚本只会被"提醒"而非拦截, 但建议把信任的包列进白名单, 免得将来 npm 真的开始拦截。
|
||
|
||
4. **`mkdir` for Windows reserved names.** Output dir is `dist-Electron\` (escaped; `dist\electron` chokes on Windows). Don't rename without verifying the build still produces a valid path.
|
||
|
||
5. **`nsis` is `oneClick: false`.** Installer asks for install path + creates Desktop/Start-Menu shortcuts. Permissions are user-scoped.
|
||
|
||
6. **Renderer global drag highlight.** Track `dragenter`/`dragleave` with a depth counter (not a boolean) — child elements fire leave/enter pairs. See `MessageInput.vue`'s `dragDepth`.
|
||
|
||
7. **WS 通道状态要"拉取式"同步, 不能只靠事件推送.** 聊天框顶部显示的是"通道可用"（outgoing 或 inbound 任一 WS 活着），跟侧边栏的"设备在线"（UDP 发现）是两回事。启动时主进程往往先连上对端（`index.ts` 里 `connectTo` 早于 `createMainWindow`），那条 `device:wsState` 事件会在渲染层订阅之前就发出去被丢掉 —— 早期实现只有事件推送，UI 因此永久停在"等待重连…"，而连接其实一直是好的。规矩：(1) `device:wsState` 推**全量快照**而不是增量；(2) 渲染层 mount 时主动 `invoke('app:state')` 拉一次；(3) 渲染层**先注册监听再 await**，否则 await 期间的事件也会丢。详见 `docs/connection-status.md`。
|
||
|
||
8. **File conflict naming.** Append `_N` before the first `.`: `archive.tar.gz` → `archive_1.tar.gz`, `.bashrc` → `.bashrc_1`. Logic in `file-server.ts` `targetPath()`.
|
||
|
||
## Configuration knobs
|
||
|
||
- `LNM_MAX_FILE_SIZE=<bytes>` env var overrides the 100 GB default in `file-server.ts`. Useful for testing the limit path.
|
||
- `deviceName`, `downloadDir`, `notifications`, `autoStart` live in `~/AppData/Roaming/local-net-msg/config.json` via `electron-store`. Edit the file directly while dev is stopped.
|
||
- `data/app.db` — SQLite DB. DELETE to reset all devices/messages. Auto-migrates on next launch.
|
||
|
||
## Packaging gotcha
|
||
|
||
`release/` contains an `app.asar` Windows cannot delete while the previous app instance holds a file handle. Build now writes to `dist-Electron\` to dodge this. If you ever switch back, kill the running app first or you'll get EPERM.
|
||
|
||
## Linux packaging (icon + taskbar)
|
||
|
||
Ubuntu 装完"没图标"是个坑，有两个独立原因：
|
||
|
||
1. **`linux.icon` 必须指向目录，不能是单张 PNG。** electron-builder 把图标装进 `/usr/share/icons/hicolor/<size>x<size>/apps/<exe>.png`，而单张 PNG 交给 `app-builder` 时它解析不出尺寸（返回 `size: 0`），于是装进 `hicolor/0x0/` 这种非法目录，桌面环境根本找不到 → 启动器没图标。正确做法是给一个**目录**，里面按 `<size>x<size>.png` 命名：`resources/icons/{16,24,32,48,64,128,256,512}x{...}.png`，然后 `linux.icon = "resources/icons"`。图标集用 `node scripts/make-icon.js` 生成（需要 ImageMagick 的 `convert`；生成结果已提交，平时不用跑）。
|
||
|
||
2. **`StartupWMClass` 要跟窗口真实的 WM_CLASS 一致。** electron-builder 默认填 `productName`（`LocalNetMsg`），但 Electron 实际设的是**可执行文件名**（`local-net-msg`）—— 对不上，任务栏就找不到对应启动器，显示成通用图标。用 `xprop -id <wid> WM_CLASS` 确认真实值，然后在 `build.linux.desktop.StartupWMClass` 里写它。
|
||
|
||
Windows / macOS 仍用单张 `resources/icon.png`（那里不按尺寸分目录）。
|
||
|
||
## Windows 兼容性
|
||
|
||
完整的分析、已修问题和待验证清单见 `docs/windows-compat.md`。最容易踩的两个：
|
||
|
||
1. **`build.asarUnpack` 里的原生模块规则必须递归（`**/*`）。** node-pty 1.2 是"主包 + 平台包"拆包架构，平台包 `@lydell/node-pty-<platform>-<arch>` 里除了 `.node` 还有 `conpty.dll` / `OpenConsole.exe`，而 node-pty 的 ConPTY worker 用 `worker_threads.Worker` 起脚本——都必须是磁盘上的真实文件。规则写成 `.../node-pty-*/*`（单层）会把 `prebuilds/<plat>/` 下的东西留在 asar 里，Windows 终端直接起不来（Linux 上看不出来，因为只需要一个 `.node`）。自测 S7 守着这条规则。
|
||
|
||
2. **Windows 保留设备名**：`CON` `PRN` `AUX` `NUL` `COM1-9` `LPT1-9`（带扩展名也算）不能直接当文件名——对它们 `open()` 打开的是设备不是文件。落盘前统一走 `src/main/safe-name.ts` 的 `safeFileName()`（按**本机**平台决定要不要改写，Linux 上 `CON` 是合法文件名，不该动）。
|