249 lines
13 KiB
Markdown
249 lines
13 KiB
Markdown
# 工时记账与薪酬核算系统 (Work Hours Tracker)
|
||
|
||
轻量级工时排班记账与多周期薪酬核算系统。采用 Local-First（本地优先）离线架构，支持移动端秒开、增量双向同步，并将薪酬算法收口为同构纯函数引擎。
|
||
|
||
---
|
||
|
||
## 一、 开发目的
|
||
|
||
1. **解决复杂排班与工时结算痛点**
|
||
- 针对非标工时制（大小夜班、跨日班次、工时补扣、满勤奖惩等）场景，解决人工核算繁琐、极易出错的问题。
|
||
- 实现**工时填报即时核算、多周期薪酬实时预估**，让收入与扣罚明细清晰透明。
|
||
|
||
2. **本地优先 (Local-First) 与离线可用**
|
||
- 保证在弱网、无网或服务离线环境下，移动端仍可秒开并正常记账与查询。
|
||
- 采用增量版本变更日志机制，网络恢复后自动与服务端完成双向合并，避免数据冲突与丢失。
|
||
|
||
3. **算法同构与高可靠性保障**
|
||
- 核心薪酬核算逻辑完全剥离为纯函数模块（`shared/payroll.js`），实现**前端交互实时核算**与**后端/测试环境同构复用**。
|
||
- 配备涵盖 100+ 真实场景的自动化基线测试（Parity Test），保障业务规则演进时算法零误差。
|
||
|
||
---
|
||
|
||
## 二、 核心架构与业务流程
|
||
|
||
```
|
||
┌────────────────────────────────────────────────────────┐
|
||
│ 前端 (Vue 3 PWA) │
|
||
│ - 日历排班视图 / 工时打卡 / 薪酬看板 / 扣罚明细 │
|
||
│ - 本地持久化 (LocalStorage / IndexedDB) │
|
||
│ - 纯函数核算引擎 (shared/payroll.js) │
|
||
│ - 启动守卫：依赖加载失败时静默自愈，无错误卡片 │
|
||
└──────────────────────────┬─────────────────────────────┘
|
||
│ 增量双向同步 (/api/push, /api/changes)
|
||
▼
|
||
┌────────────────────────────────────────────────────────┐
|
||
│ 后端服务 (Node.js REST API) │
|
||
│ - 鉴权与用户管理 (Token-based Auth) │
|
||
│ - 数据版本控制与原子合并 │
|
||
│ - 静态资产安全分发与白名单隔离 │
|
||
│ - 数据持久化存储引擎 │
|
||
└────────────────────────────────────────────────────────┘
|
||
```
|
||
|
||
### 1. 业务交互流程
|
||
1. **工时录入与即时核算**：
|
||
- 用户在日历/表单选择班次类型（白班/夜班/连班）及加班时数。
|
||
- 前端直接调用 `WHTPayroll` 引擎，实时计算日收益、月累计工时、基础底薪、满勤补贴与扣罚。
|
||
2. **离线持久化与同步入队**：
|
||
- 变更记录即刻写入本地持久化存储，并生成操作变更日志（Changelog）。
|
||
3. **数据合并与同步**：
|
||
- 同步模块（`sync.js`）触发后台长轮询或网络恢复监听，通过 `/api/push` 提交本地变更，并通过 `/api/changes` 拉取服务端增量更新，按时间戳与修订号完成双向一致性合并。
|
||
|
||
### 2. 项目目录结构
|
||
- `index.html`：主交互界面，包含日历打卡、月度明细、薪酬测算看板与自定义规则配置。
|
||
内置启动守卫：Vue / 薪酬模块加载失败时不弹任何错误卡片，白屏中央仅一行「正在恢复连接…」小灰字，
|
||
后台退避轮询（2s→4s→…封顶 30s）自动重取资源并恢复；每会话自动 reload 上限 2 次防闪屏，
|
||
额度用尽后转纯后台轮询。技术日志仅输出到控制台（`[boot-guard]` 前缀）。
|
||
- `shared/payroll.js`：独立同构薪酬计算模块（包含时薪折算、截断规则、周期合并等 30+ 纯函数）。
|
||
- `sync.js`：本地优先增量同步适配层。
|
||
- `server/`：轻量级 REST API 服务端（支持多用户鉴权、版本同步、健康检查 `/api/health`），
|
||
并内置只读 MCP 端点（`POST /mcp`）：AI 客户端可查询出勤与薪酬。支持多用户独立 MCP 令牌隔离，配置在页面「设置 → AI 接入 (MCP)」管理，开关/令牌即时生效。
|
||
- `.build/`：Tailwind CSS 预编译工作区（只在开发机跑，产物是 `vendor/tailwind.css`，运行时不需要它）。
|
||
**改 `index.html` 里出现的新 Tailwind class 后必须重跑**：`cd .build && npx tailwindcss -i input.css -o ../vendor/tailwind.css --minify`，
|
||
否则新样式不在预编译产物里，页面静默丢样式（2026-09-13 MCP 开关按钮不可见即此因）。
|
||
- `test/` & `tools/`：基线测试（Parity Test）、断言验证与回归测试工具。
|
||
|
||
---
|
||
|
||
## 三、 部署方式
|
||
|
||
系统支持 **Node.js 直接部署 (Systemd 守护)** 与 **反向代理部署**。
|
||
|
||
### 1. 环境要求
|
||
- **Node.js**：`>= 22.5.0`
|
||
- **操作系统**：Linux (Debian/Ubuntu/CentOS 等)
|
||
|
||
### 2. 部署步骤
|
||
|
||
#### 步骤一：克隆代码与安装依赖
|
||
```bash
|
||
git clone https://gitea.king.nyc.mn/openclaw/work-hours-tracker.git
|
||
cd work-hours-tracker
|
||
|
||
# 安装主项目及服务端依赖
|
||
npm install
|
||
cd server && npm install && cd ..
|
||
```
|
||
|
||
#### 步骤二：运行测试门禁验证
|
||
在正式启动前，确保全量计算基线与服务端测试全部通过：
|
||
```bash
|
||
npm run test
|
||
# 预期输出：test:payroll 与 test:server 全部通过
|
||
```
|
||
|
||
#### 步骤三：Systemd 服务配置
|
||
仓库内已带与线上运行一致的单元文件 `server/work-hours-tracker.service`，拷贝后启用即可：
|
||
```bash
|
||
cp server/work-hours-tracker.service /etc/systemd/system/work-hours-tracker.service
|
||
# 部署路径不同时，先修改单元文件里的 WorkingDirectory 再 daemon-reload
|
||
systemctl daemon-reload
|
||
systemctl enable --now work-hours-tracker.service
|
||
```
|
||
|
||
单元文件关键内容（端口固定 9522：localStorage 按 origin 隔离，换端口 = 换 origin，
|
||
已有打卡数据会看不见，勿改；如需开启多用户注册，可添加 `Environment=ALLOW_REGISTER=1`）：
|
||
```ini
|
||
[Unit]
|
||
Description=Work Hours Tracker (Node: static + sync API)
|
||
After=network.target
|
||
|
||
[Service]
|
||
Type=simple
|
||
User=root
|
||
WorkingDirectory=/root/.openclaw/workspace/work-hours-tracker/server
|
||
ExecStart=/usr/bin/node --disable-warning=ExperimentalWarning node-server.js
|
||
Environment=PORT=9522
|
||
Environment=HOST=0.0.0.0
|
||
# Environment=ALLOW_REGISTER=1 # 开放多用户自适应注册（首个用户创建后如需继续允许新账号注册可启用）
|
||
Restart=always
|
||
RestartSec=3
|
||
|
||
[Install]
|
||
WantedBy=multi-user.target
|
||
```
|
||
|
||
加载并启动服务：
|
||
```bash
|
||
systemctl daemon-reload
|
||
systemctl enable --now work-hours-tracker.service
|
||
```
|
||
|
||
#### 步骤四：服务检查与连通性验证
|
||
```bash
|
||
# 查看运行状态
|
||
systemctl status work-hours-tracker.service
|
||
|
||
# 接口健康检查
|
||
curl -s http://127.0.0.1:9522/api/health
|
||
# 正常返回: {"ok":true,"users":1}
|
||
```
|
||
|
||
---
|
||
|
||
## 四、 运维与日常管理
|
||
|
||
- **更新重启**：
|
||
```bash
|
||
systemctl restart work-hours-tracker.service
|
||
```
|
||
- **查看实时日志**：
|
||
```bash
|
||
journalctl -u work-hours-tracker.service -f
|
||
```
|
||
- **基线快照校验**（当薪酬规则发生改动时）：
|
||
```bash
|
||
npm run baseline # 校验基线无漂移
|
||
npm run baseline:write # 确认规则变更并更新快照
|
||
```
|
||
- **改了前端样式后重编译 CSS**（index.html 新增 Tailwind class 时）：
|
||
```bash
|
||
cd .build && npx tailwindcss -i input.css -o ../vendor/tailwind.css --minify
|
||
```
|
||
产物立即生效（服务端逐请求读文件 + no-cache + ETag），无需重启。
|
||
|
||
---
|
||
|
||
## 五、 AI 接入 (MCP)
|
||
|
||
服务端内置只读 MCP 端点（Streamable HTTP，`POST /mcp`，JSON-RPC 2.0），让对话式 AI 查询出勤与薪酬。
|
||
算钱一律复用 `shared/payroll.js` 引擎（与前端看板同源），不让 AI 口算。
|
||
|
||
- **工具 7 个**（全部只读，不写库）：`get_month_summary` / `get_shift_records` / `get_payroll_settings` /
|
||
`get_penalty_details` / `simulate_leave` / `list_month_overview` / `get_business_rules`
|
||
- **配置存 DB**（`user_mcp_tokens` 表，用户级物理隔离），页面「设置 → AI 接入 (MCP)」可开关/生成/重置各自令牌，**即时生效无需重启**
|
||
- **多用户隔离**：各用户 AI 客户端凭借专属 Bearer Token 鉴权，仅查自身出勤打卡与薪酬概况，互不干扰
|
||
- `MCP_AUTH_TOKEN` 环境变量只做首启种子（库里从没有过令牌时迁入 DB），不设也行
|
||
- 状态语义：未配置 → `404`（端点视为不存在）；已配置但关闭 → `503`；令牌错误 → `401`
|
||
- 管理 API（登录态）：`GET /api/mcp/status`（掩码）、`POST /api/mcp/token`（生成/重置，明文仅回一次）、
|
||
`GET /api/mcp/token`（复制用取回明文）、`POST /api/mcp/enabled`
|
||
- 测试：`cd server && node --disable-warning=ExperimentalWarning test/mcp.test.js`（47 项，含多用户隔离验证）
|
||
|
||
---
|
||
|
||
## 六、 Android 客户端与移动端打包
|
||
|
||
系统提供原生 Android 包装壳（WebView 容器，代码位于 `android/`），将 Web 资产打包至本地 `assets/www`，支持彻底离线断网运行与静默更新。
|
||
|
||
### 1. 原生功能特性
|
||
- **纯本地离线优先 (Local-First)**：以 `file:///android_asset/www/index.html` 启动，无网络时本地打卡与薪酬核算 100% 完整可用。
|
||
- **默认服务探活回退**：内置默认远程同步地址 `https://daka.kory.kdns.fr`，非 HTTP(S) 环境无需手动填写即可直接探活或注册/登录同步。
|
||
- **沉浸式交互与返回拦截**：双击返回键安全退出防误触（提示「再按一次退出工时打卡」），状态栏与导航栏自适应沉浸。
|
||
- **静态资源一键同步**：前端资产修改后，运行 `./android/copy-web-assets.sh` 即可自动同步至 Android 工程 assets 目录。
|
||
|
||
### 2. 本地与 CI/CD 自动构建 APK
|
||
- **本地编译**：
|
||
```bash
|
||
cd android
|
||
./gradlew assembleRelease
|
||
# 生成产物：android/app/build/outputs/apk/release/app-release-unsigned.apk
|
||
```
|
||
- **GitHub Actions 自动化发布**：
|
||
- 推送带 `v*` 格式的 Git Tag（如 `git tag v1.0.1 && git push github v1.0.1`）时，自动触发 `.github/workflows/build-apk.yml` 工作流。
|
||
- 构建产物会自动签名并发布到 GitHub Releases，附带安装包与 SHA256 校验和。
|
||
|
||
---
|
||
|
||
## 七、 版本发布历史 (Changelog)
|
||
|
||
### v1.0.2 (2026-09-15)
|
||
- **修复 (MCP 状态联动与生命周期)**：
|
||
- 修复退出登录后前端 `mcp` 响应式对象残留已开启状态、点击关闭弹出「未登录」错误的问题。
|
||
- 新增 `resetMcpState(authNeeded)` 函数，在 `doLogout` 成功退出时联动重置 MCP 状态并清空掩码。
|
||
- `loadMcpStatus` 增加登录凭证前置检测与 401/403 异常拦截重置；在 `doLogin` 成功后自动拉取当前账号的专属 MCP 状态。
|
||
- 未登录时 MCP 接入开关与生成令牌按钮自动置灰禁用，右上角徽章明确显示「本设备请先登录」，`toggleMcp` 增加前置拦截提示。
|
||
- **Android 原生资产与版本**：
|
||
- 静态资产同步至 `android/app/src/main/assets/www/`。
|
||
- 版本号升级：`versionCode 3`，`versionName "1.0.2"`。
|
||
|
||
### v1.0.1 (2026-09-15)
|
||
- **应用名称统一**：
|
||
- Android 原生应用名称统一由「工时记账」修改为「工时打卡」（`strings.xml`）。
|
||
- `MainActivity.java` 连续双击返回退出提示文案同步更新为「再按一次退出工时打卡」。
|
||
- **默认远程服务器探活与回退**：
|
||
- `sync.js` 预设 `DEFAULT_REMOTE_BASE = 'https://daka.kory.kdns.fr'`。
|
||
- 深度适配 Android WebView `file:///android_asset/...` 环境，未手动指定服务器地址时自动探活并回退到默认远程服务器。
|
||
- **设置页交互分流与体验重构**：
|
||
- 底部导航栏点击「设置」原生切换至 `<section v-show="tab === 'settings'">` 独立全屏视图，保持打卡、汇总、设置三页平级体验。
|
||
- 顶部导航栏齿轮图标保留快速弹出轻量半屏抽屉（`settingsOpen`）能力，满足快捷调整设置的需求。
|
||
- **登录 / 注册模式解耦**：
|
||
- 在设置页「云端同步」卡片中引入「账号登录 / 注册新账号」模式切换（`authMode`）。
|
||
- 彻底解除了等待服务端异步探测返回 `allowRegister` 按钮才浮现的延迟限制。
|
||
- **文档与发版**：
|
||
- 补充 README「六、 Android 客户端与移动端打包」章节。
|
||
- 版本号升级：`versionCode 2`，`versionName "1.0.1"`。
|
||
|
||
### v1.0.0 (2026-09-15)
|
||
- **Android 原生离线客户端支持**：
|
||
- 新增基于 Android WebView 的原生包装容器（`android/` 工程）。
|
||
- 将前端静态资产封装在本地 assets，支持完全脱网离线运行及沉浸式体验。
|
||
- **构建环境与依赖约束修复**：
|
||
- 解决 GitHub Actions CI 构建 Release APK 出现的 Kotlin stdlib 多版本冲突（`Duplicate class kotlin.collections.jdk8.CollectionsJDK8Kt`）。
|
||
- 在 `android/app/build.gradle` 引入 Kotlin BOM 平台依赖约束：`org.jetbrains.kotlin:kotlin-bom:1.8.22`。
|
||
- **CI/CD 自动化构建流水线**：
|
||
- 新增 `.github/workflows/build-apk.yml` 自动化构建工作流。
|
||
- 支持推送 `v*` 标签时自动编译、签名并发布 GitHub Release 及附带 APK 校验和。
|
||
- **系统核心基线**：
|
||
- Local-First 本地优先架构、纯函数薪酬计算引擎（`shared/payroll.js`）、启动自愈守卫、多用户数据隔离与用户级只读 MCP 服务。
|