1
0
Files
DiAL/openspec/specs/single-executable-packaging/spec.md
lanyuanxiaoyao bcfb907bd3 feat: 基础设施加固 — 修复构建、数据保留、错误边界、bundle 拆分
- 修复 build script 引用已删除的 registerCheckers,恢复生产构建
- 生产入口添加 SIGINT/SIGTERM 优雅关闭(与 dev.ts 一致)
- 新增 runtime.retention 配置(默认 7d),ProbeStore.prune() 定时清理过期数据
- parseDuration 扩展支持 h/d 单位
- 新增前端 ErrorBoundary 组件,防止渲染错误白屏
- Vite codeSplitting.groups 拆分 vendor chunks(业务代码 1180KB → 47KB)
- 同步 delta specs 到主规范
2026-05-13 16:48:56 +08:00

4.7 KiB
Raw Blame History

Purpose

定义将 Vite 前端资源与 Bun 后端打包为单个 standalone executable 的生产构建、运行配置和验证要求。

Requirements

Requirement: 生产构建顺序

生产构建 MUST 在编译 Bun 后端 executable 之前先构建 Vite 前端。

Scenario: 运行生产构建

  • WHEN 开发者运行生产构建命令
  • THEN 系统 MUST 在调用 Bun standalone executable 编译之前生成前端静态资源

Scenario: 前端构建失败

  • WHEN 前端生产构建失败
  • THEN 系统 MUST 停止生产构建,且不能输出 stale executable

Requirement: 构建生成确定性

生产构建 SHALL 以稳定顺序生成嵌入静态资源清单,减少重复构建产生无意义差异。

Scenario: 生成静态资源清单

  • WHEN 生产构建扫描 Vite 输出目录并生成嵌入资源模块
  • THEN 资源条目 SHALL 按稳定顺序输出

Scenario: 重复构建相同前端产物

  • WHEN Vite 输出内容未变化且生产构建重复运行
  • THEN 生成的嵌入资源模块 SHALL 保持语义一致且不依赖文件系统遍历顺序

Requirement: 单 executable 输出

生产构建 SHALL 输出一个 standalone executable其中包含 Bun 后端、必要 server 依赖和构建后的前端资源。构建成功后 SHALL 自动清理中间产物目录(.build/),构建失败时 SHALL 保留中间产物以便排查。生成的入口代码 SHALL 通过 import config-loader 模块隐式触发 checker 注册,而非显式调用注册函数。生成的入口 SHALL 注册 SIGINT 和 SIGTERM 信号处理器,在收到信号时依次调用 engine.stop() 和 store.close() 后退出进程。

Scenario: 在目标机器运行 executable

  • WHEN 生成的 executable 在兼容目标平台上运行
  • THEN 它 SHALL 启动全栈应用,且不要求目标机器安装 Node.js、Bun、Vite 或 node_modules

Scenario: 服务嵌入的前端

  • WHEN executable 收到前端根路径请求
  • THEN 它 SHALL 从 executable 内包含的资源服务前端,且不需要外部 dist/ 目录

Scenario: 服务嵌入 API 和页面

  • WHEN 生成的 executable 启动,且浏览器打开前端根路径
  • THEN 页面 SHALL 展示同一个 executable 进程中 /api/summary/api/targets 返回的数据

Scenario: 构建成功后清理中间产物

  • WHEN 生产构建成功完成并输出 executable
  • THEN 系统 SHALL 自动删除 .build/ 目录及其所有内容

Scenario: 构建失败时保留中间产物

  • WHEN 生产构建在任意步骤失败前端构建、中间产物生成、Bun 编译)
  • THEN .build/ 目录 SHALL 保留在磁盘上以供排查

Scenario: checker 注册通过 import 链触发

  • WHEN 生成的入口代码 import config-loader 模块
  • THEN checkerRegistry 单例 SHALL 通过模块依赖链自动完成注册,入口代码 SHALL NOT 显式调用任何注册函数

Scenario: 生产入口优雅关闭

  • WHEN executable 进程收到 SIGINT 或 SIGTERM 信号
  • THEN 系统 SHALL 调用 engine.stop() 停止所有定时器,调用 store.close() 关闭数据库连接,然后以退出码 0 退出进程

Requirement: 外部运行时配置

executable MUST 将环境相关运行时配置保留在嵌入的前端和 server bundle 之外。

Scenario: 修改监听端口

  • WHEN 操作者修改受支持的 port 配置
  • THEN 同一个 executable SHALL 在不重新构建的情况下监听新端口

Scenario: 缺少可选配置

  • WHEN 可选运行时配置被省略
  • THEN executable SHALL 使用文档化的默认值

Requirement: 构建验证

项目 SHALL 提供验证,证明生产 executable 可以服务 API、健康检查、静态资源和 SPA fallback 路由,并且完整验证 MUST 针对当前源码重新构建后的 executable 运行。

Scenario: 验证 executable 路由

  • WHEN 构建验证针对生成的 executable 运行
  • THEN 它 SHALL 检查 /api/summary/api/targets/health、前端根路径、静态资源、未知 API、未知静态资源和前端 fallback 请求

Scenario: 验证生产模式和响应头

  • WHEN 构建验证针对生成的 executable 运行
  • THEN 它 SHALL 检查 API 响应处于 production runtime mode并验证代表性 HTML、JSON 和静态资源响应的缓存或低风险安全 headers

Scenario: 完整验证重新构建 executable

  • WHEN 开发者运行完整验证命令
  • THEN 系统 MUST 先基于当前源码执行生产构建,再对新生成的 executable 运行 smoke test

Scenario: 验证失败

  • WHEN 任一代表性生产路由、响应头、生产模式或构建阶段检查失败
  • THEN 验证 SHALL 使构建或测试命令失败