Keep documentation focused on current contracts, responsibilities, and required operations. Define when PRs need documentation updates and consolidate setup commands with explicit ownership and permissions. Co-authored-by: Codex <noreply@openai.com>
36 KiB
Codex Proxy RS 架构
本文说明模块职责、请求流程、状态存储和必须保持的约束。 具体 HTTP 字段见 接口文档,部署参数见 部署文档;上游 URL、超时、 重试间隔和 UI 布局属于源码或配置,不在架构文档重复维护。
1. 系统定位
Codex Proxy RS 是单进程、单副本运行的多 Provider AI 网关,同时提供:
- 面向客户端的 OpenAI Responses、Images、standalone Search 和模型目录协议;
- 面向管理员的
/api/admin/*控制面和 Vue 管理端; - OpenAI 与 xAI 两个编译期 Provider;
- PostgreSQL 持久化、Redis 协调状态以及 S3/R2 数据库备份。
系统不提供 /v1/chat/completions,不存在 Provider Instance 层,也不支持通过复制应用容器进行多副本
扩容。Client Key 限定账号分组,而不是绑定某个 Provider;一次请求的 Provider 候选由账号范围、模型
能力和运行时健康共同决定。
2. 运行拓扑
flowchart LR
Client[API Client] --> API[gateway-api]
Browser[Vue Admin] --> API
API --> Core[gateway-core]
API --> Admin[gateway-admin]
Core --> Registry[Provider Registry]
Admin --> Registry
Registry --> OpenAI[provider-openai]
Registry --> XAI[provider-xai]
OpenAI --> OpenAIUpstream[OpenAI upstream]
XAI --> XAIUpstream[xAI upstream]
Core --> Store[gateway-store]
Admin --> Store
OpenAI --> Store
XAI --> Store
Store --> PG[(PostgreSQL)]
Store --> Redis[(Redis)]
Store --> Object[(S3 / R2)]
Host[gateway-host] -. lifecycle / workers / update .-> API
Host -. lazy client distribution resolver .-> Admin
Host --> StoreLinks[RG-Adguard / Microsoft CDN]
backend/apps/gateway 是唯一组合根,按 Host → Store → Provider → Core → Admin → API → Worker 的顺序
初始化具体实现。其余 crate 只暴露自己的配置、端口和 Bundle,不自行定位别的实现。
3. Workspace 边界
| 路径 | 责任 |
|---|---|
backend/apps/gateway |
读取顶层配置、连接 Bundle、注册 Provider 与 Worker |
gateway-protocol |
跨层共享的 OpenAI wire contract、SSE 编解码与无业务 owner 的解析事实,不依赖其他 workspace crate |
gateway-core |
operation、canonical event、请求快照、路由、admission、attempt 协调、交付边界和计量 |
gateway-admin |
管理领域、用例、Provider/Store 端口、审计语义和备份策略 |
gateway-api |
HTTP/WS/SSE 解码与交付、Admin wire、静态管理端;不直接访问 Store 或具体 Provider |
gateway-store |
PostgreSQL、Redis、S3/R2、pg_dump 适配器;不拥有业务策略 |
gateway-host |
配置加载、日志、HTTP 生命周期、Worker 监督和系统更新 |
providers/openai |
OpenAI OAuth、账号选择、目录、额度、Responses/Images/Search transport |
providers/xai |
xAI OAuth session、账号选择、目录、额度和 Grok/Responses 转换 |
frontend |
Vue 管理端,仅通过 Admin API 读写状态 |
依赖方向遵守四条规则:
- Core 不依赖 HTTP、数据库、Redis 或具体 Provider。
- Provider 之间不互相依赖,也不决定跨 Provider fallback。
- API 只调用 Core/Admin 抽象;Store 只实现端口。
- 具体实现只在组合根相遇。
组合根的 workspace architecture tests 冻结成员清单、依赖 DAG、公开模块面、源码纪律以及生产/测试模块 镜像关系;具体行为边界由各 crate 的集成测试维护。
3.1 Rust 模块组织约定
后端采用目录模块的 mod.rs 风格;以下规则由组合根的 workspace architecture tests 扫描全部生产源码与
测试模块树:
- crate root 作为顶层门面,声明模块并暴露该 crate 的配置、Bundle、端口或稳定领域合同;目录节点使用
目录/mod.rs,叶子模块使用名称.rs,不混用名称.rs与名称/两套入口。 - 生产源码不使用内联
mod name { ... }、#[path]或include!隐藏文件归属。lib.rs和各级mod.rs是模块门面,负责声明子模块、选择性 re-export 与少量同层协调。 - 子模块默认私有;只有真实的跨 crate 生产合同才能使用
pub。adapter/provider 的公开根模块由 allowlist 冻结,变更必须同步完成边界审计,不能为测试或兼容路径创建第二 owner。 - owner 级依赖保持单向。两个模块互相引用时,应把共享值对象、端口或生命周期能力提升到共同 owner, 不能依靠同一 crate 内可见性掩盖循环边界。
- 每个 crate 的
src/与tests/平级,生产源码不承载测试。tests/镜像src/的模块目录形态:例如src/foo/mod.rs对应tests/foo/mod.rs,src/foo/bar.rs对应tests/foo/bar.rs。一个生产模块可以没有 测试;额外场景测试必须放在最近的生产 owner 目录下。根级support和冻结的 crate/workspace 架构场景 是明确例外。
较大的模块门面只负责组合和 re-export:账号 Admin HTTP 边界按 wire、credentials、handlers、
presenter 划分;Provider 执行按 continuation、stream、failure、observation 和 worker 等职责拆分;xAI
请求转换按 response、tools 与 history 拆分。各子模块之间只使用 owner 内最小可见性。
3.2 gateway-core 内部 owner
gateway-core 内共享事实按语义 owner 划分:
| 模块 | 唯一责任 |
|---|---|
validation |
纯值对象校验错误和文本约束,不依赖事件、执行错误或路由 |
identity |
Provider 身份值 ProviderKind,只依赖纯校验 |
account |
Provider 账号/credential/quota 值对象、持久化端口与请求级账号选择;scope 持有分组、账号目录和冻结账号范围 |
metering |
标准化 Usage、金额、费用估算与费用明细;不表示账号或开票系统 |
upstream |
跨 Engine、Event、Error 与 Provider 共用的 transport 名称、发送状态和不透明上游值 |
lifecycle |
取消信号、连接注册与 drain 合同 |
engine |
attempt、发送/提交屏障、执行编排和持久化调用时序 |
routing |
冻结路由事实、请求计划、Provider 只读目录合同以及运行时快照的表示与编译 |
runtime |
当前快照的发布、读取、revision 订阅与周期对账任务 |
event 通过 validation / upstream 使用基础值,不依赖承载原始事件的执行错误;账号值对象和
选择策略通过 identity / account::scope 使用身份与范围,不依赖路由计划。routing 和 error 的
既有公开类型路径保留 re-export,定义与 Core 内部使用均归属上述 owner。架构测试约束这些叶子依赖。
Provider 模型能力、目录代次与 ProviderCatalogPort 由 routing::catalog 定义。快照编译和对账只消费
该只读合同,不反向依赖执行注册表;现有 ProviderRegistry 直接实现目录端口,仍只维护一份 Provider
注册集合。已知空目录与查询失败的未知目录保持不同语义,目录替身无需实现请求执行。
客户端原生模型目录同样由 Provider 拥有,通过 ExecutionService 和现有 Registry 的只读调用传递。
routing::catalog 的原生条目只包含模型 ID 与不透明协议正文,Core 负责冻结账号范围和整对象模型映射,
不解析上游字段;API 负责协议输出,不直接依赖具体 Provider。原生目录失败不会退回通用画像,只有不提供
该协议原生目录的 Provider(如 xAI 的 Codex 适配)才走画像转换。目录读取不创建计量请求或推理 attempt。
OpenAI 的账号/凭据 revision/客户端版本隔离、并发合并、TTL、容量与失效均归属已有 credential catalog
service;客户端原生对象只进有界进程缓存,不扩展套餐 Redis ID cache 或持久化模型字段副本。
engine::observation 统一维护单次响应的用量、费用、时间和响应 ID,并负责重试前清理;协调器继续
独占发送、提交、重试和终结顺序。Provider 上报费用优先于本地估算,丢弃的 attempt 不得污染最终计量。
Client Key 费用账本独立累计各次 attempt 的实际费用,不能因请求重试而清空已产生的费用或未知计费状态。
4. 数据面请求生命周期
sequenceDiagram
participant C as Client
participant A as API Adapter
participant E as Core Engine
participant P as Provider
participant S as Store / Ops queue
C->>A: authenticated request
A->>E: Operation + client context
E->>E: freeze snapshot and compile routing plan
E->>S: enqueue request / attempt observations
E->>S: check Key budget against recorded usage
E->>P: one candidate, one credential, one attempt
P-->>E: cold canonical stream + raw wire
E->>E: enforce send and downstream commit barriers
E-->>A: committed response stream
A-->>C: JSON / SSE / WebSocket
E->>S: settle charge idempotently
E->>S: enqueue terminal observation and metering
请求开始时冻结 RuntimeSnapshot、Client Key 的账号范围、模型映射、Codex 客户端最低版本、Provider
候选顺序和调度策略。
运行中的请求始终使用该快照,不拼接不同版本的配置,也不在热路径查询分组关系。
Client Key 鉴权完成后,API adapter 从有界请求头识别 Codex Desktop/CLI,Core 使用同一请求冻结的
RuntimeSnapshot 比较对应最低版本。Desktop 优先于其 User-Agent 内嵌的 CLI/Core 标记;未知客户端不
应用门禁。低版本或已识别但版本不可用时,在进入 Provider 前返回稳定的 426 合同。
核心不变量:
- 一个客户端请求对应一条
model_requests;attempt 是请求内事实,不建立第二张权威表。 - Provider 的一次
execute只选择一个 credential 并返回一个冷流;换号、重试和 fallback 由 Core 决定。 not_sent、sent、ambiguous是单调的上游发送边界;结果不明确时不能假定上游未收到请求。- downstream commit 是不可撤回的交付承诺。commit 后禁止换号、重试和 fallback。
- 跨 Provider 只在账号范围和能力都允许,且请求尚未到达上游或已被证明可安全重放时发生。
- 可恢复观测写入失败不能替换已经确定的客户端协议结果。
Responses 按模型目录编译候选;全局模型映射是精确映射,未命中时模型名原样交给候选 Provider。 Images 与 standalone Search 是 OpenAI Provider 自有端点:两者都不参与文本模型映射,只在 Client Key 的账号范围确实包含 OpenAI 账号时生成单一 OpenAI 候选。Images 不要求模型字段;Search body 中的模型 及其他字段保持原始 bytes 并由上游解释。
5. Provider 与协议边界
Core 只理解 Operation、能力要求、Provider 候选、稳定错误和 canonical event,不读取 Provider SDK
类型。Provider 独占 credential schema、OAuth、账号选择、模型目录、额度投影和上游 transport。
- OpenAI 是透明边界。Responses 请求保留未知字段和字段顺序;SSE、WebSocket、Images 与 standalone Search 的业务正文按原始字节转发。canonical facts 从同一数据旁路提取,只用于路由、观测和计费。
- Responses 的业务扩展头保留原始多值字节;传输与反代请求头分类由
gateway-protocol统一定义, API 入站与 OpenAI Provider 编码共同使用。下游链路元数据和压缩协商不跨越该边界, 上游认证、请求画像与传输字段仍由 Provider 生成;响应方向的诊断头不受请求过滤规则影响。 - xAI 是翻译边界。Provider 把 Grok wire 转换为 Responses wire;上游结构化错误的 message/code/type 可以透出,但账号指纹会先脱敏。
- response ID 是不透明 UTF-8 bytes,不假设 UUID、固定长度或跨 Provider 可复用。
- 请求画像以配置为启动基线。OpenAI Desktop 与 xAI CLI 的官方版本检查只更新各自负责的运行时画像,
不回写
config.yaml。
xAI Provider 负责 Codex custom 工具与 Grok function 工具的双向转换,保持工具类型、item ID 与
call_id 配对;超限或转换失败终止流。默认 store: false 的续接由现有会话 owner 重放完整历史;
原生续接按上游约束处理 instructions 与 previous_response_id,不把协议差异交给 Core。
账号出站代理
出站代理属于账号配置,由各 Provider 在推理、OAuth 服务端交换/刷新、额度、目录和资料等请求中统一使用。 指定代理不可用时请求失败,不退回直连;未配置时直连,不继承进程的全局代理环境变量,TLS 仍验证证书。 用户浏览器访问第三方授权页时的出口不受网关设置控制。
连接池按出口隔离。修改代理推进配置 revision,使后续请求使用新出口;已执行请求可沿原连接完成。
代理变更不推进 credential_revision,不会使进行中的令牌刷新因凭据版本冲突而丢失结果。
xAI 的推理连接池继续按账号绑定隔离;OAuth、目录/计费辅助请求在各自 transport 内复用有界出口
client,OIDC 的 JWKS 缓存与单飞归属对应出口状态。自动刷新提交凭据后的目录预热重新读取当前账号
出口,不从 token-only 路径绕过代理;JWKS 过期或获取失败仍不使用 stale fallback。
代理独立保存和测试,通过 outboundProxyId 绑定账号;账号保留解析后的 URL 供 Provider 使用。
连接配置改变时在同一事务内同步关联账号并清除旧测试结果,已绑定的代理不可删除。
关联账号支持单独移除:在原子更新中校验当前代理 ID,只清除账号的代理 ID 和 URL,
保留账号其他设置;提交配置版本与审计后复用快照发布流程,使后续请求使用直连。
代理目录只携带关联数量;账号明细通过独立分页读端口按需查询,
在同一个只读快照中统计并读取有界页面,不在目录中聚合完整账号数组。
文件及 AT/RT 导入在上游凭据交换前取得 PostgreSQL 会话级共享咨询锁,直到凭据提交后释放。
代理修改、删除和测试结果写入通过同一资源的事务级独占锁检查,导入期间直接返回冲突。
导入保护连接数量有界,不占用提交所需的连接池槽位,也不持有空闲事务。
请求取消或进程退出时关闭会话并释放锁。探测器由组合根注入 OpenAI 的 HTTP 客户端构建函数,
复用其自定义 CA 加载与证书校验规则,Host 不依赖具体 Provider 包。
导入器在认证交换前解析并校验账号出口。sub2api 的代理引用按完整 URL 登记为共享代理并绑定账号; 其 SOCKS5 配置按远端 DNS 语义转换为 SOCKS5H。账号导入只迁移账号及出口,不迁移下游 Key、余额或历史用量。 代理认证信息仅通过敏感账号导出返回,列表、详情、Debug 和普通审计不得暴露;数据库及备份按凭据保护。 输入字段、协议支持与导入校验见 账号 API。
Codex 原生生图与认证
管理端导出的 Codex 配置使用代理 Bearer 密钥,并声明服务端托管账号认证。 客户端据此开放原生生图工具,图片生成和编辑仍进入现有 Images 路由,不新增独立的登录或图片代理服务。 这只解决客户端能力识别;模型能力、客户端限制和上游账号的实际生图权限仍分别检查。
X-OpenAI-Actor-Authorization 是客户端能力标记,不是账号凭据。API 解码和 OpenAI Provider
都过滤该 header,网关继续校验 Client Key,上游认证由服务端账号产生。
客户端配置示例维护在 部署文档。
客户端到代理与代理到上游的传输选择相互独立。客户端的 supports_websockets = false
不禁止 Provider 使用上游 WebSocket。响应终态前的 Close 1000 仍视为失败,
后续恢复请求成功也不改写原失败请求的结果。
错误与诊断三层边界
错误信息按用途分成三层,不能用同一个 message 同时承担协议、界面和诊断职责:
- 数据面协议错误:
/v1/*继续遵守 OpenAI/xAI wire 合同。可交付原始上游响应时保留其状态、headers、 content type 和 body;本地 fallback 使用数据面稳定机器码与安全英文,不受管理端中文化影响。 - 控制面展示错误:
/api/admin/*由 API 统一 HTTP 状态与数值业务码,由 Admin/API owner 提供安全中文 文案。extractor rejection、namespace 404 和 method 405 也使用同一 JSON 信封;任意 Store、Serde、 ProviderDisplay不得直接跨越 HTTP 边界。 - 原始上游诊断:只在连接测试、运维错误详情等明确诊断界面展示已经捕获的原始字段,不翻译、不补造, 也不塞入普通 Admin 错误信封。原始 body 不进入 Debug、普通日志或持久化错误消息。
Provider 管理适配在仍持有结构化失败事实时选择静态 public_message;Admin 将其转为可安全展示的
AdminError.message,API 保留其中的 502/503 具体原因,无公开消息时才使用通用回退。认证与未知
内部异常仍保持固定文案,不能把任意 Provider/Store 的 message 直接放行。
管理提示与 Worker 的处置分类是不同职责:例如 OpenAI 刷新已收到 401 时,可以提示已解析的令牌
拒绝原因,但不因此改变现有有界恢复退避和账号终态判定。刷新繁忙、已知上游失败与结果未知分别映射为
409、50201、50202;结果未知不能触发自动重放一次性凭据,Vue 也不重新解析上游错误码或正文。
连接测试的 gateway / provider / upstream 来源以及 not_sent / sent / ambiguous 发送状态由 Core 在
仍持有完整执行错误时一次判定;Vue 只能根据稳定字段生成摘要,不能匹配英文错误句子反推来源。
Vue 普通管理请求的错误提示由 api/request.ts 响应拦截器统一负责:优先展示安全信封的 message,
缺失或空白时才使用请求层的 HTTP、网络或超时兜底;成功业务码为 200,HTTP 成功但业务码失败也会拒绝。
规范化异常保留 status、code、requestId 与 kind。页面和 useAsyncAction 不重复弹出接口错误;
查询可以保留失败状态与重试入口,本地校验、文件操作、SSE 诊断和成功响应中的业务结果仍归各自 owner。
API 模块通过统一的 RequestOptions 传递 signal、timeout 和 silent。取消或已被新查询取代的请求
不弹提示;后台轮询、重启探测等显式使用 silent,它只关闭提示,不吞异常,也不跳过会话失效处理。
批量操作的部分成功汇总、不可逆操作的结果未知等必要业务处理先将对应请求静默,再由业务 owner 提供
一次有上下文的反馈;不得为普通失败重新维护一套消息或业务码映射。
6. 路由、账号范围与 continuation
Client Key 与账号分组形成授权范围:
- 没有分组关联表示
AllAccounts; - 有关联时只允许已启用分组成员的并集;
- 已绑定分组为空或全部禁用时得到空池,绝不回退为全部账号;
- 分组可以包含多个 Provider,账号也可以属于多个分组。
账号选择综合启停状态、credential/quota 事实、Redis cooldown、并发上限、权重、请求间隔和会话亲和。 账号编辑在一个事务中替换完整调度事实。导入与首次 OAuth 可携带统一账号设置,由 Admin 传递给 Store, 与凭据在同一事务中提交;Provider 仍独占凭据解析。未附带设置的导入、重新授权和后台刷新保留已有分组、 权重与并发设置。管理端导入和账号编辑共用设置表单,凭据输入独立于设置。
Continuation 仍受原请求的 Client Key、账号范围、Provider 和发送/交付边界约束:
- native continuation 固定创建它的 Provider 与账号;
- OpenAI 按 native → replay owner → replay any 推进,并保留官方
previous_response_id语义; - xAI 使用客户端提交的完整历史作为重放输入;
- scope 外账号、跨 Key 复用或不明确发送结果均 fail closed。
会话亲和是优先选择提示,不是硬账号绑定;native continuation 才携带不可跨越的 owner 约束。
Client Key 限额与结算
日金额、七天金额、并发和 RPM 按 Client Key 跨账号、跨 Provider 合计,零表示不限;修改限额不重置已用金额。 Core 负责准入与结算时序,Store 持久化费用账本,Admin 负责限额配置。
- 日窗口按北京时间零点划分;七天窗口从首次准入当天零点开始,到期后由下一次使用重新开启,不固定为周一。
- 金额优先使用 Provider 上报的 USD,否则按现有模型价格估算;订阅账号的估算费用不代表上游订阅账单。 费用归属请求完成时间,跨日请求计入完成日,延迟写入仍保留原完成时间。
- 准入检查已结算金额,不预占未来费用。达到任一金额阈值后拒绝新请求,已准入请求仍可完成并使总额超过阈值。
- SSE 持有并发名额直到终态;WebSocket 每个
response.create独立准入,空闲连接不占名额。 Core 在每次请求开始时重新鉴权并冻结当前策略,既有连接也应用已发布的限额与授权范围变更。 换号和内部重试复用同一名额,Key 与账号并发上限同时生效;预算拒绝或启动失败释放名额。
完成、失败、取消和断连使用同一结算路径,在结束时以网关请求 ID 幂等累计已取得费用。 执行会话持有结算与准入释放的同一个清理 future;协议等待被取消后,后续驱动或宿主 detached finalizer 继续原清理,不重复结算。只有执行终态、结算与释放均已返回,协议层才可视为 finalized 并放弃清理责任。 缺少用量或价格、无法取得 USD 费用的尝试按零累计,不创建待核账记录,也不会阻断 Key; 内部重试中已经取得的费用仍须累计。发送状态只决定重放是否安全,不能据此推断费用。 请求日志继续保留真实错误、用量与费用来源,账本按零累计不表示上游实际免费。
结算写入失败时,进程内保留精确费用,在同一 Key 下次请求前重试;进程退出后无法恢复的费用不会形成欠账。 PostgreSQL 不可用时拒绝所有新的计费请求,Redis 继续管理并发/RPM 租约。 账本独立于可丢弃的请求观测日志,日志清理不重置金额;费用事件保留至删除 Key,已有日志不会回填为账本费用。 字段与错误合同见 Client Key API。
7. 控制面与 revision
管理写入遵循统一流程:
HTTP validation
-> Admin use case
-> Provider prepare/verify when needed
-> PostgreSQL transaction + audit
-> invalidate affected Provider-derived facts when needed
-> publish committed runtime snapshot
-> best-effort observations when needed
会改变路由快照或安全配置的 mutation 在同一 PostgreSQL 事务中提交业务事实、推进内部
config_revision 并写入脱敏审计。Admin mutation 不要求客户端提交 revision;少数账号/分组响应
返回已提交的 configRevision,不将它当作乐观并发前置条件。
额度、cooldown、目录 generation、请求统计和自动 credential refresh 属于运行时观测,不推进全局
revision;credential 轮换只推进账号自己的 credential_revision。Redis 通知用于缩短收敛延迟,
PostgreSQL 周期对账才是正确性基础。
同一 publisher 的管理提交、订阅通知与周期对账共享编译到发布/暂停的临界区,避免旧结果覆盖新授权或 晚到的失败暂停新快照;请求读取不等待刷新锁。对账仍允许持久 revision 回退,不能只比较版本大小。 配置不可确认时暂停新请求;仅目录 generation 变化且编译失败时继续使用旧快照,留待下次对账。
8. 状态所有权
| 状态 | 唯一权威 | 说明 |
|---|---|---|
| 账号、credential、分组、Client Key、设置、审计、请求与备份记录 | PostgreSQL | 业务持久化事实 |
| Client Key 金额窗口与费用事件 | PostgreSQL | 准入与幂等结算的权威账本,独立于请求观测与日志保留策略 |
| admission、lease、cooldown、circuit、会话亲和、continuation、OAuth pending、目录 cache | Redis | 可重建、可过期的协调状态 |
| 日志、OAuth 恢复记录、在线更新状态、备份暂存 | .runtime/ |
部署节点本地运行文件 |
| 重置卡库存与消费结果 | OpenAI upstream | 后端不建立本地卡库存;前端按账号保留当前浏览器会话的最近查询、未决消费幂等键与发送锁,展开行卸载不会清空 |
| Provider 公开模型与请求画像 | Provider/runtime cache | 由官方目录或发布源刷新,不写成第二份业务配置 |
| Windows 安装包临时直链 | Host 进程内短缓存 | 按需解析、严格校验、到期前丢弃;不写 PostgreSQL/Redis,也不代理包字节 |
账号对外状态不是独立列,而是 PostgreSQL credential/quota 事实与 Redis cooldown 的统一投影:
normal、quota_exhausted、rate_limited、disabled、error。只有明确上游证据才能恢复或终态化账号,
本地时钟和不确定响应不能伪造事实。
PostgreSQL schema 由迁移目录按编号管理。已应用迁移按字节冻结,后续 schema 变化只能新增编号迁移, 详见 迁移规则。
9. Credential、额度与主动重置
credential 与 quota 是两组独立事实:credential refresh 不等于 quota refresh,额度接口的 401/403 也不能单独证明 refresh token 永久失效。
- OpenAI 支持 OAuth、AT/RT 与 OAuth JSON,导入识别 camelCase 和官方
auth.json的 snake_case token 字段; RT-only 导入先换取 AT,AT-only 导入没有 自动续期能力。OAuth 身份只从官方 JWT claims 投影,不信任导入文档顶层身份字段。 - xAI 使用 OAuth session;API Key 不是受支持的账号 credential。刷新额度时同步查询官方实时订阅, 只把套餐事实写入现有 quota JSON。明确无付费订阅的个人账号显示 Free;查询失败、缺失字段或 团队身份不推断为 Free,订阅查询失败不影响额度观测。
- 账号导入和 OAuth complete(包括重新授权)在 credential 提交、Provider 事实失效及快照发布后, 由 Admin 共用流程后台读取一次额度;不等待观测完成才返回管理请求,失败记录告警但不回滚账号事务。 手工和后台 credential refresh 仍不隐式刷新 quota。
- quota refresh、正常推理返回的 rate-limit headers 和后台健康任务汇入同一额度事实;套餐只用于展示与 目录 cache 隔离,不创建套餐专属状态机。
主动额度重置是 OpenAI Provider 的不可逆上游操作:列表查询和消费都直接使用当前 Desktop 请求画像; 卡片不写 PostgreSQL/Redis。消费请求携带调用方生成的 UUIDv4 幂等键,同一账号的消费在进程内串行; 发送结果不明确时必须复用原键。确认成功后管理端再显式刷新卡片与 quota,不能直接改本地重置时间。
10. 观测与后台任务
账号容量预测属于 Admin 的只读派生规则,不参与 quota 权威状态、调度或金额结算。Store 通过专用采样端口 在同一 SQL 快照内返回截至观测时间的累计数值及有界历史 Provider 文档;文档仅由具体 Provider 复用协议 解析器解释,Admin 按中立的额度事实选择近期进度段。该采样不改变全站完整交付用量口径,不创建第二份 持久化额度状态。未知 Token/美元费用分别抑制对应预测;历史请求完成时间只是额度时间的近似,不承诺 严格扣额归因或预测准确率。公开字段与采样门槛见 周/月额度预测。
请求观测通过有界进程内队列异步投影到 PostgreSQL。队列满、Store 暂不可用或进程退出超时时,允许丢失
可恢复观测并累计指标,但不允许改变客户端响应。Usage 详情中的 attempt 因此是 best-effort,并通过
attemptsComplete: false 明示不完整性。
模型执行以 model_requests.id 标识,上游身份由 upstream_request_id 保存。
API 输出模型执行与上游请求的关联信息,具体响应头规则见 数据面接口。
入口 middleware 的 ID 用于入口日志,不作为模型请求的主键或检索映射。
失败终态及中间失败的上游请求 ID 优先取对应 ProviderError,缺失时再取该 attempt 的响应
observation、调用 metadata;最终失败的关联头不与 opening 身份混合。
正常路径的请求行仍在首次合法 ProviderStream 建立后随 attempt 合并创建。已进入 Core 执行会话、
但在首次合法冷流建立前发生的无可用账号、准备失败、超时或取消,复用同一请求表补写失败终态与
诊断快照;没有实际 attempt 时计数为零,账号与传输保持空值。Provider 的准备过程不得发送本次请求的
上游握手或业务载荷,也不得启动独立发送任务;已合法登记冷流后,即使没有首事件也保留真实 attempt。
不能因首写失败或缺少 metadata 而伪造零尝试、账号、传输或 not_sent。
终态观测写入由会话持有;事件等待被取消后,后续 poll 或 detached finalizer 继续同一个 future, 保留原结果及完成时间,不重复创建请求。观测写入失败仍为 best-effort,不阻断费用结算与准入释放。 鉴权、解析、路由或准入等尚未进入执行会话的入口拒绝不纳入此请求记录边界;异步投影也仍可能延迟或 丢弃。排障需结合入口日志,不能将“无记录”解释成没有发生错误。
只有完整交付客户端的成功推理响应进入 Token、延迟和成本聚合。OpenAI Provider 根据请求的
generate: false 将连接与上下文准备归类为 prewarm,不信任客户端单独声明的同名 metadata。
Store 的共享用量口径排除这些预热记录,账号用量与额度预测复用同一规则;原始请求审计、响应额度
观测和费用事实仍保留,不将未知费用改写为零,也不影响 Client Key 结算账本。
实际 service_tier 只接受上游响应事件确认,不能用请求期望值替代。
Worker 由各 Bundle 贡献、由 Host 统一监督:
- Store:过期请求恢复、历史保留和 PostgreSQL/Redis 观测队列;
- Core:
runtimeowner 的 RuntimeSnapshot 周期对账和 Redis change 订阅; - Admin:S3/R2 备份 daemon,负责调度、执行、删除收敛与保留清理;
- Provider:credential refresh、quota/catalog 健康和官方版本/etag 检查。
周期任务的 Redis lease 只保证单周期互斥,不构成多副本 leader 选举。备份 daemon 依赖单副本部署边界, 自更新也只替换处理请求的当前进程,因此整个应用必须保持单副本。
11. 生命周期、安全与恢复
启动只有在配置、PostgreSQL、Redis、Provider、Core、Admin、API 和 Worker 全部初始化成功后才进入服务。
健康检查综合 Core、Store 与 Worker 状态,但不会把单个 Provider 的业务降级等同于整个进程失活。
组合根在启动时只把 Host 的 ClientDistributionResolver 能力注入 Admin;此时不访问 RG-Adguard,下载
HTTP Client 构造失败也不会阻断网关启动。外部解析在已认证管理员首次打开客户端下载弹窗时惰性执行,
失败时按架构使用 OpenAI 官方稳定地址。Microsoft Store 内容通道返回的 HTTP/80 临时链接保留原始 scheme,
不会被错误改写到该 host 不保证支持的 HTTPS 虚拟主机。
关闭分为两段:先停止接收新连接并 drain HTTP/WS,再取消并等待 Worker;两段各有独立预算,Compose 的
stop_grace_period 必须覆盖二者之和。超时后只丢弃仍未落盘的可恢复观测,不执行隐式业务重放。
安全边界:
- Provider credential 以 Provider schema 的明文 JSON 保存在 PostgreSQL;数据库和备份必须按敏感数据保护。
host.logging.oauth_recovery默认关闭,开启后将 OAuth 原始 AT/RT 写入独立文件; 与普通文件日志开关分别控制,不输出到普通日志或 stdout。.runtime/logs同样属于敏感数据。host.logging.request_dump默认关闭;开启后独立请求转储包含原始请求头和正文, 可能包含密钥及用户内容,只能在明确的排障范围内使用,不能作为普通日志公开。- Host 拥有文件日志写入、轮转、保留和关闭流程,以时间窗口完整性为约束,队列满时背压,正常关闭时排空并同步。 写入缺口必须通过健康状态持续报告,压缩或清理失败不能伪装成保留完成。 配置、保留窗口和容量规划见 日志与持久化。
- Provider 将安全诊断的阶段、原因码与消息独立于错误大类和发送状态传入 Core;
attempt.failed保存这些字段,最终错误记录优先持久化诊断消息。重试包装不能覆盖底层诊断, 也不能因为错误更详细而改变已有重试安全边界。 - 默认诊断区分 transport 采集的真实头部与用户 JSON;未知 map 的键和值均不原样保留,
嵌套的同名 header 不获得头部白名单权限。管理端反馈包只导出明确允许的关联、分类、阶段和计时,
不复制 trace 的事件 data,也不因历史
sanitized标记而信任旧正文。 - 真实 secret 不进入普通日志、Debug、fixture 或 audit details;明文只能通过账号导出、Key reveal、 备份设置等明确的敏感 Admin 合同返回。
- OAuth pending flow 使用有期限、带 owner 的一次性 claim;事务成功后才消费,失败释放 claim。
- 在线更新校验 Release host、大小、SHA-256 和归档路径,并只允许同一大版本内更新。
PostgreSQL 备份恢复属于人工维护操作。当前没有部署级维护模式开关,需要先停止应用, 离线处理快照中的非终态任务、计划游标和到期清理条件,再重新验证对象存储并恢复计划。 关闭计划开关只阻止新计划任务,不会停止 Worker 的任务恢复和删除流程。 未经核对就启动旧快照,可能触发远端对象删除;操作步骤见 部署文档。
12. 修改与验收
变更应落在拥有该事实的边界:协议适配进 API,执行策略进 Core,Provider 差异进对应 Provider,持久化 实现进 Store,生命周期进 Host,管理规则进 Admin。不要用兼容 shim、第二套状态机或跨层旁路绕开 owner。
后端验证从 backend/Cargo.toml 执行,仓库根目录没有 Cargo manifest:
cargo +1.97.0 fmt --all --manifest-path backend/Cargo.toml -- --check
RUST_MIN_STACK=16777216 cargo +1.97.0 clippy --manifest-path backend/Cargo.toml --all-targets --all-features --locked -- -D warnings
RUST_MIN_STACK=16777216 cargo +1.97.0 test --manifest-path backend/Cargo.toml --test main --locked
线程栈设置与当前 CI 一致。PostgreSQL/Redis 集成测试需按 迁移文档 配置专用测试库;未设置环境变量时,本地相关测试会跳过。 其他检查与界面验证按 贡献与审查 执行。
改动使现有说明失真或缺少必要信息时,修订所属文档:用户入口写入根 README,HTTP 合同写入 docs/api.md,
部署操作写入 deploy/README.md,架构不变量保留在本文。