- 新增 /ready(DB 探活失败返回 503) - OCR 作业输出 claimed/available/duplicate/failed 统计 - README 补充 /health 与 /ready 说明
hyb-oa Server Runbook (P0/P1)
1. 环境准备
- Node.js:
>=20 - Docker + Docker Compose
- 本地工具:
curl、jq - 配置文件:从
server/.env.example复制为server/.env并按需修改
cd /home/shunli/Projects/hyb-oa/server
cp .env.example .env
2. Gate 基线命令(必须顺序执行)
2.1 启动数据库
cd /home/shunli/Projects/hyb-oa
docker compose up -d db
2.2 应用迁移
cd /home/shunli/Projects/hyb-oa/server
npm run prisma:migrate:deploy
2.3 执行 seed(幂等)
cd /home/shunli/Projects/hyb-oa/server
npm run seed:dev
开发环境默认账号(仅用于本地 seed:dev):
- employee:
[email protected]/EmployeePassword1234 - manager:
[email protected]/ManagerPassword1234 - finance:
[email protected]/FinancePassword1234 - finance_mgr:
[email protected]/FinanceMgrPassword1234 - admin:
[email protected]/AdminPassword1234 - ceo:
[email protected]/CeoPassword1234
说明:
- 以上账号可通过
SEED_*环境变量覆盖(见server/src/scripts/seed-dev.js)。 - 生产/试运行环境默认采用“管理员重置密码”,不建议启用默认弱口令。
2.4 启动服务
cd /home/shunli/Projects/hyb-oa/server
npm run dev
2.5 冒烟验证
cd /home/shunli/Projects/hyb-oa/server
./scripts/smoke-test.sh
2.6 本地最小门禁(P1-b)
cd /home/shunli/Projects/hyb-oa
./scripts/check-minimal.sh
说明:
- 该脚本只做静态/构建级门禁,不启动服务与数据库。
- 全量回归仍通过
server/scripts/regression-all.sh执行。
3. 1 分钟快速验证
cd /home/shunli/Projects/hyb-oa/server
./scripts/smoke-test.sh
也可直接探活:
curl -fsS http://127.0.0.1:3000/health
curl -fsS http://127.0.0.1:3000/ready
说明:
/health:liveness(不查 DB)/ready:readiness(SELECT 1探活 DB,失败返回 503)
4. 回归入口
4.1 脚本回归(推荐)
cd /home/shunli/Projects/hyb-oa/server
BASE_URL=http://127.0.0.1:3000 ./scripts/smoke-test.sh
4.2 判重专项回归(dedup)
cd /home/shunli/Projects/hyb-oa/server
DATABASE_URL='postgresql://hyboa_user:[email protected]:5432/hyb_oa?schema=public' \
BASE_URL=http://127.0.0.1:3000 ./scripts/regression-dedup.sh
4.3 工作流动作回归
cd /home/shunli/Projects/hyb-oa/server
./scripts/regression-workflow-actions.sh
可选并发校验:
cd /home/shunli/Projects/hyb-oa/server
RUN_DELEGATION_CONCURRENCY_CHECK=1 ./scripts/regression-workflow-actions.sh
覆盖场景:
reject:实例=rejected,报销=rejectedreturn:实例=terminated,报销=draftwithdraw:审批未处理前可撤回return后二次submit:创建新实例PERM_002:非 assignee 无法操作no_actionable_approver:全链无可执行审批人阻断negative_not_allowed:负金额防御manager skip:直属上级缺失时跳过并记录transfer:转审成功(任务改派 + 任务/转审记录/history 三处证据)transfer参数校验:reason<10 返回VALID_002transfer同人转审:返回VALID_001(same_assignee_not_allowed)transfer链路上限:同 task 第 4 次转审阻断(chain_limit_exceeded)transfer目标校验:目标审批人须 active 且具备expense.approvepay:财务付款成功(approved -> paid,发票bound -> archived(used_complete))pay权限:非财务返回PERM_001pay状态校验:非approved/paid返回VALID_001pay幂等:重复付款返回 200(archivedInvoiceCount可为 0)pay幂等冲突:已付款后提交冲突凭证字段返回409 VALID_001(already_paid_conflict)delegation:有效期内可代办并在 history 写入 delegation 证据delegation过期:代理人返回PERM_002,自动回收任务可撤销过期委派delegation并发回收(可选):RUN_DELEGATION_CONCURRENCY_CHECK=1时双并发只回收一次并仅写一条自动回收审计
4.4 一键全量回归
cd /home/shunli/Projects/hyb-oa/server
./scripts/regression-all.sh
串联 smoke-test.sh + regression-dedup.sh + regression-workflow-actions.sh + regression-audit.sh + regression-ocr.sh,适用于 CI 或发版前检查。
可选关闭审计/OCR:
cd /home/shunli/Projects/hyb-oa/server
RUN_AUDIT_REGRESSION=0 RUN_OCR_REGRESSION=0 ./scripts/regression-all.sh
独立执行:
cd /home/shunli/Projects/hyb-oa/server
./scripts/regression-audit.sh
OCR_PROVIDER=mock ./scripts/regression-ocr.sh
4.5 Postman 回归
- Collection:
server/postman/hyb-oa.postman_collection.json - Environment:
server/postman/hyb-oa.postman_environment.json - 核心链路:
- Login Employee
- Create Reimbursement
- Upload Invoice
- Bind Invoice
- Submit Reimbursement
- Login CEO
- Approve Workflow Task
- Get Signed URL
4.6 前端壳联调(P1-5)
cd /home/shunli/Projects/hyb-oa/client
npm install
npm run dev
说明:
- 前端开发地址默认
http://127.0.0.1:5173。 - 通过 Vite 代理将
/api转发到http://127.0.0.1:3000。 - Access Token 仅保存在内存,Refresh Token 通过 HttpOnly Cookie 续签。
5. P2 API 摘要
5.1 付款标记(pay)
POST /api/reimbursements/:id/pay- 权限:
expense.finance.pay - 可选请求体:
paymentVoucherNo、paymentDate(YYYY-MM-DD)、paymentChannel(bank/alipay/wechat/cash/other) - 语义:
approved -> paid:返回 200,并归档关联bound发票- 已
paid重复同值:返回 200(payment.idempotent=true) - 已
paid重复冲突值:返回409 VALID_001,details.payment=already_paid_conflict
5.2 委派管理
POST /api/delegations:创建委派(scope + validFrom/validTo)GET /api/delegations/mine:查看我发起/我接收的委派POST /api/delegations/:id/revoke:撤销委派- 委派仅作用于
assignee_id任务,不改写assignee_role语义。 - 自动回收实现采用
FOR UPDATE SKIP LOCKED + UPDATE ... RETURNING,多实例并发下确保同一委派仅回收一次。
5.3 OCR 异步状态查询
- 上传发票在 OCR 开启且
ocr_type=vat时会进入pending_ocr。 GET /api/invoice-pool/:id可轮询 OCR 处理状态(pending_ocr/available/ocr_failed)。
5.4 审计日志查询
GET /api/audit-logs- 权限:
system.audit.view(finance_mgr/admin) - 支持分页与筛选(actor/action/targetType/date range)。
5.5 工作流查询增强(P3)
GET /api/workflow/tasks:支持status/page/pageSize,返回page/pageSize/total/items。GET /api/workflow/tasks/:taskId:任务详情(实例、报销摘要、可执行动作、处理历史)。GET /api/workflow/approvers:转审候选人列表(active + 具备expense.approve)。
5.6 列表查询接口(P3)
GET /api/reimbursements:支持page/pageSize/status/scope。GET /api/invoice-pool:支持page/pageSize/status/ownerScope。
5.7 定时任务(可手动执行)
cd /home/shunli/Projects/hyb-oa/server
npm run job:revoke-expired-delegations
npm run job:ocr-once
6. 关键环境变量
DATABASE_URL: PostgreSQL 连接串JWT_SECRET: JWT & signed-url token 签名密钥APP_TIMEZONE: 默认Asia/ShanghaiSTORAGE_DIR: 默认generated/storage(相对server/)SIGNED_URL_TTL_SECONDS: 默认600MAX_UPLOAD_SIZE_BYTES: 默认10485760(10MB)RATE_LIMIT_ENABLED: 是否启用关键接口限流(默认:production=true,其它环境=false)RATE_LIMIT_LOGIN_MAX:/api/auth/login等接口限流次数(默认10)RATE_LIMIT_LOGIN_WINDOW: 限流时间窗(默认1 minute,支持 ms 格式如30s/1m)DELEGATION_REVOKE_CRON: 委派自动回收定时表达式(默认0 * * * *)OCR_PROVIDER:off/mock/tencent(默认off)OCR_BATCH_SIZE: 每轮 OCR 认领数量(默认10)OCR_LOCK_TTL_SECONDS: OCR 锁超时秒数(默认300)OCR_POLL_CRON: OCR 轮询 cron(默认* * * * *)OCR_MAX_ATTEMPTS: OCR 最大重试次数(默认3)OCR_TIMEOUT_MS: 腾讯 OCR SDK 超时(默认5000)TENCENT_SECRET_ID/TENCENT_SECRET_KEY/TENCENT_OCR_REGION: 腾讯 OCR 配置
安全基线(P4):
- 安全头:默认启用
@fastify/helmet(CSP 默认关闭,避免误伤 SPA 本地调试)。 - 限流:
/api/auth/login、/api/auth/forgot-password、/api/auth/reset-password在RATE_LIMIT_ENABLED=true时启用限流。 - 日志脱敏:
authorization/cookie/password/code/newPassword等敏感字段会被 redaction。
回滚策略:
- 若限流误伤,可先设置
RATE_LIMIT_ENABLED=false(无需改代码)。 - 若安全头造成兼容性问题,可回退
server/src/app.js中 helmet 注册逻辑。
生产提示:大表加索引需评估
CREATE INDEX CONCURRENTLY,避免锁表影响。
7. 常见失败排查
| 现象 | 可能原因 | 解决方案 |
|---|---|---|
prisma migrate deploy 失败 |
DATABASE_URL 未配置/不可达 |
检查 server/.env 与数据库容器状态 |
npm run seed:dev 重复执行报错 |
seed 脚本被改坏,未保持幂等 | 检查 seed-config.js/seed-dev.js 的 upsert / skipDuplicates |
| signed-url 接口返回 403 | JWT_SECRET 不一致、token 过期、访问人无权限 |
统一服务密钥、确认 URL 在 TTL 内、检查账号角色 |
上传返回 file_too_large |
文件超 MAX_UPLOAD_SIZE_BYTES |
调整环境变量或使用更小文件 |
| 上传失败且报目录/权限错误 | STORAGE_DIR 不存在或不可写 |
创建目录并修正权限;Docker 需确认 volume 挂载 |
OCR 长期停留 pending_ocr |
OCR_PROVIDER=off、mock未开启或腾讯密钥无效 |
检查 OCR 环境变量,优先用 OCR_PROVIDER=mock npm run job:ocr-once 验证链路 |
| 委派过期后仍可操作 | 自动回收任务未运行 | 检查 DELEGATION_REVOKE_CRON,手动执行 npm run job:revoke-expired-delegations |
8. 手工故障注入(非阻塞)
8.1 STORAGE_DIR 不可写路径
- 临时将
STORAGE_DIR指向只读目录,执行上传接口,确认错误可观测(日志+返回码)。
8.2 磁盘空间不足(ENOSPC)
- 在受控环境中制造磁盘满条件后重试上传。
- 预期:错误路径可观测(日志中能定位到 I/O 错误),不要求纳入日常 CI 冒烟。