@rei-standard/amsg-server 2.6.0-next.2 → 2.6.0-next.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +599 -24
- package/dist/adapters/d1.d.ts +416 -0
- package/dist/adapters/factory.d.ts +39 -0
- package/dist/adapters/interface.d.ts +306 -0
- package/dist/adapters/neon.d.ts +88 -0
- package/dist/adapters/pg-shared.d.ts +161 -0
- package/dist/adapters/pg.d.ts +84 -0
- package/dist/adapters/schema.d.ts +57 -0
- package/dist/adapters/schema.sqlite.d.ts +49 -0
- package/dist/chunk-7NMQFTDJ.cjs +148 -0
- package/dist/chunk-E7OWP3VL.cjs +135 -0
- package/dist/chunk-GN44PST5.mjs +148 -0
- package/dist/chunk-KOJQVOYS.mjs +5847 -0
- package/dist/chunk-QHVID3V2.cjs +5847 -0
- package/dist/chunk-ZGGF4GMA.mjs +135 -0
- package/dist/cloudflare/single-user-worker.d.ts +37 -0
- package/dist/cloudflare.cjs +39 -2
- package/dist/cloudflare.d.ts +10 -2
- package/dist/cloudflare.mjs +40 -3
- package/dist/handlers/cancel-message.d.ts +3 -0
- package/dist/handlers/capabilities.d.ts +4 -0
- package/dist/handlers/client-state.d.ts +7 -0
- package/dist/handlers/get-message.d.ts +3 -0
- package/dist/handlers/get-user-key.d.ts +3 -0
- package/dist/handlers/init-tenant.d.ts +23 -0
- package/dist/handlers/llm-credentials.d.ts +5 -0
- package/dist/handlers/messages.d.ts +3 -0
- package/dist/handlers/outbox.d.ts +7 -0
- package/dist/handlers/push-subscription.d.ts +5 -0
- package/dist/handlers/schedule-message.d.ts +3 -0
- package/dist/handlers/send-notifications.d.ts +3 -0
- package/dist/handlers/single-user-init.d.ts +13 -0
- package/dist/handlers/update-message.d.ts +3 -0
- package/dist/handlers/vapid-public-key.d.ts +19 -0
- package/dist/index.cjs +133 -44
- package/dist/index.d.cts +131 -766
- package/dist/index.d.ts +131 -766
- package/dist/index.mjs +125 -36
- package/dist/lib/agentic-fire.d.ts +108 -0
- package/dist/lib/client-state-store.d.ts +80 -0
- package/dist/lib/constant-time.d.ts +14 -0
- package/dist/lib/db-errors.d.ts +10 -0
- package/dist/lib/encryption.d.ts +48 -0
- package/dist/lib/errors.d.ts +215 -0
- package/dist/lib/llm-credentials-store.d.ts +147 -0
- package/dist/lib/llm.d.ts +1 -0
- package/dist/lib/message-processor.d.ts +73 -0
- package/dist/lib/outbox-store.d.ts +95 -0
- package/dist/lib/push-subscription-store.d.ts +94 -0
- package/dist/lib/recurrence.d.ts +51 -0
- package/dist/lib/request.d.ts +182 -0
- package/dist/lib/result-emitter.d.ts +54 -0
- package/dist/lib/run-tick.d.ts +115 -0
- package/dist/lib/schema-version.d.ts +50 -0
- package/dist/lib/state-accessors.d.ts +70 -0
- package/dist/lib/state-chunks.d.ts +55 -0
- package/dist/lib/task-projection.d.ts +92 -0
- package/dist/lib/validation.d.ts +97 -0
- package/dist/lib/version.d.ts +7 -0
- package/dist/lib/webcrypto-utils.d.ts +1 -0
- package/dist/lib/webpush-webcrypto.d.ts +78 -0
- package/dist/{neon-BFUS25UX.cjs → neon-KP2CPA57.cjs} +110 -10
- package/dist/{neon-CU5N3CSW.mjs → neon-ZIMHALYI.mjs} +106 -6
- package/dist/{pg-QO6NKTGL.mjs → pg-QGC2XHUT.mjs} +94 -5
- package/dist/{pg-IIH3M4OM.cjs → pg-RZPQGXR3.cjs} +98 -9
- package/dist/single-user.d.ts +95 -0
- package/dist/tenant/blob-store.d.ts +30 -0
- package/dist/tenant/context.d.ts +47 -0
- package/dist/tenant/single-user-context.d.ts +29 -0
- package/dist/tenant/token.d.ts +26 -0
- package/package.json +3 -3
- package/dist/chunk-5ENJGVZX.mjs +0 -72
- package/dist/chunk-GN5QTMCL.cjs +0 -1870
- package/dist/chunk-PVNLB6TF.mjs +0 -1870
- package/dist/chunk-RGECD4OH.cjs +0 -72
- package/dist/cloudflare-B-E51VjP.d.cts +0 -2848
- package/dist/cloudflare-B-E51VjP.d.ts +0 -2848
- package/dist/cloudflare.d.cts +0 -2
- package/dist/neon-CJl66EGy.d.cts +0 -251
- package/dist/neon-DYvGnCzx.d.ts +0 -251
- package/dist/pg-07S-u_H4.d.cts +0 -246
- package/dist/pg-Du-pN_UT.d.ts +0 -246
- package/dist/schema-C8OnYk6j.d.cts +0 -74
- package/dist/schema-C8OnYk6j.d.ts +0 -74
package/README.md
CHANGED
|
@@ -2,14 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
`@rei-standard/amsg-server` 是 ReiStandard 主动消息标准的服务端 SDK:Blob 租户配置、`tenantToken` / `cronToken` 鉴权、标准路由处理器。API 规范见 [API 技术规范](https://github.com/Tosd0/ReiStandard/blob/main/standards/active-messaging-api.md)。
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
- 初始化流程合并为 `POST /api/v1/init-tenant`
|
|
8
|
-
- 移除旧端点:`init-database`、`init-master-key`
|
|
9
|
-
- 业务端点统一使用 `Authorization: Bearer <tenantToken>`
|
|
10
|
-
- `send-notifications` 支持 `cronToken`(Header 或 query token)
|
|
11
|
-
|
|
12
|
-
2.2+ 的字段增量(`messages` 数组、`splitPattern`、`avatarUrl` 软清空策略)在规范的 [§6.1](https://github.com/Tosd0/ReiStandard/blob/main/standards/active-messaging-api.md#61-ai-消息字段约束) / [§6.2](https://github.com/Tosd0/ReiStandard/blob/main/standards/active-messaging-api.md#62-avatarurl-软清空策略)。其中 `splitPattern` 是 server 调度任务的持久化配置;`amsg-instant` 0.8.0 起改为 hook 内自定义 split 函数 + `pushPayloads`。
|
|
5
|
+
历史变更见各版本 [CHANGELOG](https://github.com/Tosd0/ReiStandard/blob/main/packages/rei-standard-amsg/server/CHANGELOG.md)。2.2+ 的字段增量(`messages` 数组、`splitPattern`、`avatarUrl` 软清空策略)在规范的 [§6.1](https://github.com/Tosd0/ReiStandard/blob/main/standards/active-messaging-api.md#61-ai-消息字段约束) / [§6.2](https://github.com/Tosd0/ReiStandard/blob/main/standards/active-messaging-api.md#62-avatarurl-软清空策略)。其中 `splitPattern` 是 server 调度任务的持久化配置;`amsg-instant` 0.8.0 起改为 hook 内自定义 split 函数 + `pushPayloads`。
|
|
13
6
|
|
|
14
7
|
## 安装
|
|
15
8
|
|
|
@@ -50,6 +43,13 @@ const rei = await createReiServer({
|
|
|
50
43
|
// PUT /api/v1/update-message -> rei.handlers.updateMessage.PUT
|
|
51
44
|
// DELETE /api/v1/cancel-message -> rei.handlers.cancelMessage.DELETE
|
|
52
45
|
// GET /api/v1/messages -> rei.handlers.messages.GET
|
|
46
|
+
// GET /api/v1/message?id={uuid} -> rei.handlers.getMessage.GET
|
|
47
|
+
// PUT /api/v1/push-subscription -> rei.handlers.pushSubscription.PUT
|
|
48
|
+
// GET /api/v1/push-subscription -> rei.handlers.pushSubscription.GET
|
|
49
|
+
// DELETE /api/v1/push-subscription -> rei.handlers.pushSubscription.DELETE
|
|
50
|
+
// PUT /api/v1/llm-credentials -> rei.handlers.llmCredentials.PUT
|
|
51
|
+
// GET /api/v1/llm-credentials -> rei.handlers.llmCredentials.GET
|
|
52
|
+
// DELETE /api/v1/llm-credentials -> rei.handlers.llmCredentials.DELETE
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
## 关于 `messageType: 'instant'`
|
|
@@ -104,10 +104,350 @@ AI 配置消息的提示词可以用两种形态之一,**互斥二选一**:
|
|
|
104
104
|
- 限制:每项 ≤ 200 字符,数组 ≤ 10 项;非法或无法 `new RegExp(...)` 通过 → `400 INVALID_PARAMETERS`(schedule)/ `400 INVALID_UPDATE_DATA`(update)。
|
|
105
105
|
- `update-message` 显式传 `splitPattern: null` 可重置回默认;不传则保留原值。
|
|
106
106
|
|
|
107
|
+
## 一条 Web Push 能塞多少
|
|
108
|
+
|
|
109
|
+
推送服务(FCM / APNs / Mozilla autopush)限的是**加密后** body 的 4096 字节,超了当场 413 拒收,用户什么也收不到。明文额度要把 aes128gcm 的固定开销减掉——header 86(salt 16 + record size 4 + keyid 长度 1 + 应用服务器公钥 65)+ 填充分隔符 1 + GCM auth tag 16 = 103 字节——所以**一条 push 的 payload 上限是 3993 字节**,按 UTF-8 字节算,不是字符数。
|
|
110
|
+
|
|
111
|
+
`sendWebPush` 会在发出去之前挡下超限的 payload,抛出 `err.code === 'PUSH_PAYLOAD_TOO_LARGE'` 的错误,消息里带实际字节数和上限。
|
|
112
|
+
|
|
113
|
+
组 payload 之前想自己做预算,用导出的常量和工具函数,别写死魔法数字:
|
|
114
|
+
|
|
115
|
+
```js
|
|
116
|
+
import { MAX_PUSH_PAYLOAD_BYTES, measurePushPayload } from '@rei-standard/amsg-server';
|
|
117
|
+
|
|
118
|
+
const { bytes, remainingBytes, withinLimit } = measurePushPayload(JSON.stringify(push));
|
|
119
|
+
// remainingBytes = 还能再塞多少字节(已超限时为负)
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### 信封预留:fire-time hook 组 payload 时要多留一截
|
|
123
|
+
|
|
124
|
+
hook 把 `pushPayloads` 交还给库之后,库还会往每条 push 上补一批「这是谁、第几条、什么时候」的字段:
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
messageId / sessionId / timestamp / messageIndex / totalMessages
|
|
128
|
+
taskId / taskUuid / recurrenceType / occurrenceMs
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
也就是说 hook 手里量到的不是最终 payload。这批字段占的字节由导出的 `PUSH_ENVELOPE_RESERVED_BYTES`(384 字节,含 JSON 的引号逗号,按 uuid ≤ 64 字符算)兜住;`measurePushPayload` 传 `{ reserveEnvelope: true }` 就是「库补完字段之后还装得下」的口径:
|
|
132
|
+
|
|
133
|
+
```js
|
|
134
|
+
import { measurePushPayload, PUSH_ENVELOPE_RESERVED_BYTES } from '@rei-standard/amsg-server';
|
|
135
|
+
|
|
136
|
+
const { remainingBytes } = measurePushPayload(
|
|
137
|
+
JSON.stringify({ ...basePush, message: '' }),
|
|
138
|
+
{ reserveEnvelope: true }
|
|
139
|
+
);
|
|
140
|
+
const message = body.length <= remainingBytes ? body : body.slice(0, remainingBytes);
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
用比 64 字符更长的 uuid(`scheduleTask` 允许传任意字符串)就自己再多留一点。
|
|
144
|
+
|
|
145
|
+
### 装不下就切片:`multipart`
|
|
146
|
+
|
|
147
|
+
思考过程(reasoning)常常一条 push 装不下。装不下时服务端会把它切成分片逐条发,Service Worker 收齐后还原成原样再走正常派发。切多大一片、最多切几片、收齐前能等多久,都是接收端说了算——所以给 `installReiSW` 传了什么,就把同一份原样传给服务端:
|
|
148
|
+
|
|
149
|
+
```js
|
|
150
|
+
const multipart = { maxChunkBytes: 1800, maxChunks: 128, maxTotalBytes: 256_000, ttlMs: 60_000 };
|
|
151
|
+
|
|
152
|
+
installReiSW({ multipart }); // 页面
|
|
153
|
+
createReiServer({ tenant: { … }, multipart }); // 多租户
|
|
154
|
+
createSingleUserServer({ db, masterKey, multipart }); // 单用户
|
|
155
|
+
createSingleUserCloudflareWorker((env) => ({ …, multipart })); // CF Worker(cron 与 runTask 都认)
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
| 键 | 默认值 | 说明 |
|
|
159
|
+
| --- | --- | --- |
|
|
160
|
+
| `maxChunkBytes` | `1800` | 每片装多少字节原文 |
|
|
161
|
+
| `maxChunks` | `128` | 一条消息最多切几片,超了就不发 |
|
|
162
|
+
| `maxTotalBytes` | `256000` | 整条消息的原文上限,超了就不发 |
|
|
163
|
+
| `ttlMs` | `60000` | 接收端收到第一片之后,等齐剩下分片能等多久 |
|
|
164
|
+
|
|
165
|
+
不配 = 两边都用默认值。发送节奏也按 `ttlMs` 排:片数多时自动收紧每片之间的间隔,保证整批分片在这个窗口内发完;收紧到下限还装不下就一片都不发。
|
|
166
|
+
|
|
167
|
+
两边对不上的下场值得记一下:页面把 `maxChunks` 收窄到 32、服务端还按 128 切的话,分片到了接收端会被逐片拒收;节奏排得比窗口长的话,迟到的分片会被当过期丢掉。两种都是「页面上这条思考过程直接没有」,而服务端那边每一片都发成功、看不出任何异常。
|
|
168
|
+
|
|
169
|
+
### 思考过程没送到时的可见性
|
|
170
|
+
|
|
171
|
+
思考过程是正文之外的附赠内容:它没发出去不影响正文,任务照样算成功。这件事有三处看得见——
|
|
172
|
+
|
|
173
|
+
- 定时任务的 tick 汇总多一个 `details.reasoningSkippedTasks`:`[{ taskId, reason }]`。这些任务同时计在 `successCount` 里。
|
|
174
|
+
- instant 消息(`POST /schedule-message`)的成功响应带 `reasoningError`(字符串,只在思考过程没送到时出现)。
|
|
175
|
+
- 服务端日志各打一行:一行说原因,一行说是哪条任务。
|
|
176
|
+
|
|
177
|
+
刻意不写进 `last_error`:那一列说的是「上一次没发出去的原因」,一条正文已经送达的消息挂着它,客户端会当成这次投递失败了。
|
|
178
|
+
|
|
179
|
+
## 推送订阅(用户级)
|
|
180
|
+
|
|
181
|
+
推送订阅一个用户存一份,任务行不携带它,到点投递时现读。用户清了站点数据、重装了 PWA、或者推送服务轮换了 endpoint 之后,覆盖这一份就够了——所有已排的任务,包括角色在 fire 里给自己排的、客户端根本不知道存在的那些,下次触发读到的都是新订阅。
|
|
182
|
+
|
|
183
|
+
| 端点 | 语义 |
|
|
184
|
+
|---|---|
|
|
185
|
+
| `PUT /push-subscription` | 登记 / 覆盖。body =(加密后的)`{ subscription, updatedAt? }`,`subscription` 至少要有非空 `endpoint` |
|
|
186
|
+
| `GET /push-subscription` | `{ exists, updatedAt, endpoint }`。不含订阅的密钥部分——判断「登记过没有、是不是我手里这一个」用 `endpoint` 就够 |
|
|
187
|
+
| `DELETE /push-subscription` | 删掉(设置页的「停止接收推送」) |
|
|
188
|
+
|
|
189
|
+
客户端侧对应 `client.putPushSubscription(subscription)` / `getPushSubscription()` / `deletePushSubscription()`。什么时候调 PUT:`subscribePush()` 拿到订阅之后一次,之后每次应用启动确认订阅仍然有效时再一次(幂等覆盖)。
|
|
190
|
+
|
|
191
|
+
配套的约束:
|
|
192
|
+
|
|
193
|
+
- `POST /schedule-message` 在这个用户还没登记订阅时返回 `409 PUSH_SUBSCRIPTION_MISSING`——建了也永远发不出去,早点说清楚比让它烂在库里强。
|
|
194
|
+
- `POST /schedule-message` 和 `PUT /update-message` 都不收 `pushSubscription` 字段(带了返回 `400 PUSH_SUBSCRIPTION_NOT_ACCEPTED`):静默丢弃会让人以为「这条任务用的是我传的这个订阅」。
|
|
195
|
+
- 投递时读不到订阅(没登记 / 被删了)→ 任务按投递失败处理,原因记进 payload 的 `lastError`,`GET /messages` 上看得见。
|
|
196
|
+
- 数据库侧是 `push_subscriptions` 表(`user_id` 主键,`subscription` 密文,`updated_at` epoch 毫秒)。内置的 D1 / pg / neon 适配器都实现了,`initSchema()` 会建表。自定义适配器要补 `getPushSubscription` / `upsertPushSubscription` / `deletePushSubscription` 三个方法,缺任何一个这几个端点返回 501。
|
|
197
|
+
|
|
198
|
+
装不下的内容(长文、附件详情)建议走旁路:正文存进 `client_state`,push 里只带一个引用键,客户端上线后用 `GET /client-state` 取回。单用户 Worker 的 fire-time hook 用 `ctx.writeState()` 写,见 [`examples/cloudflare-single-user/README.md`](https://github.com/Tosd0/ReiStandard/blob/main/packages/rei-standard-amsg/server/examples/cloudflare-single-user/README.md)。
|
|
199
|
+
|
|
200
|
+
## LLM 凭据(用户级)与 credRefs
|
|
201
|
+
|
|
202
|
+
LLM API 凭据(`apiUrl` / `apiKey` / `primaryModel`)有两种给法:
|
|
203
|
+
|
|
204
|
+
- **内联**:随排程请求带三件套,冻结进任务行(一直以来的方式,继续支持)。
|
|
205
|
+
- **引用**:凭据先用 `PUT /llm-credentials` 集中登记,排程 payload 里只带
|
|
206
|
+
`credRefs: { chat: '<credId>' }`。到点投递时按 credId 现读——换 Key 覆盖对应
|
|
207
|
+
行就够了,所有引用它的任务(包括角色在 fire 里给自己排的、客户端根本不知道
|
|
208
|
+
存在的那些)下次触发用的都是新凭据。
|
|
209
|
+
|
|
210
|
+
| 端点 | 语义 |
|
|
211
|
+
|---|---|
|
|
212
|
+
| `PUT /llm-credentials` | 批量登记 / 覆盖。body =(加密后的)`{ credentials: [{ credId, value: { apiUrl, apiKey, primaryModel } }] }`,一批 ≤100 条,单用户 ≤500 行 |
|
|
213
|
+
| `GET /llm-credentials` | 对账清单 `{ credentials: [{ credId, updatedAt }] }`。**凭据本体永远不回传** |
|
|
214
|
+
| `DELETE /llm-credentials` | 删除。body =(加密后的)`{ credIds: [...] }` 或 `{ all: true }` |
|
|
215
|
+
|
|
216
|
+
客户端侧对应 `client.putLlmCredentials(credentials)` / `listLlmCredentials()` / `deleteLlmCredentials(opts)`。
|
|
217
|
+
|
|
218
|
+
`credId` 是客户端起名的**不透明字符串**(1–128 字符、不含控制字符),服务端不
|
|
219
|
+
解释语义。约定:`char:<charId>/<purpose>`(角色级)、`global/<purpose>`(全
|
|
220
|
+
局)。`credRefs` 的 purpose 键里只有 `chat` 由服务端消费(fire 时的主 LLM 调
|
|
221
|
+
用);其余 purpose(如情绪评估的副 API)归宿主 hook 侧,fire hook 的 ctx 上有
|
|
222
|
+
`resolveLlmCredential(credId)` 可按需取用(每次返回新对象;拿到就用,别挂到
|
|
223
|
+
ctx / metadata / push 上)。
|
|
224
|
+
|
|
225
|
+
配套的规则:
|
|
226
|
+
|
|
227
|
+
- 排程 / 更新时对 `credRefs` 里的**全部** credId 做存在性检查,缺的返回
|
|
228
|
+
`409 CREDENTIAL_NOT_FOUND` 并点名(先登记再排程)。
|
|
229
|
+
- `credRefs.chat` 与内联三件套在同一个请求里不能都传(`400`):chat 凭据只能
|
|
230
|
+
有一个来源。
|
|
231
|
+
- fire 时的解析顺序:`credRefs.chat` → 查表;行没了 → 退回任务里的内联三件套
|
|
232
|
+
(如有);都没有 → 本轮失败,`lastError` 记 `CREDENTIAL_MISSING`,走常规重
|
|
233
|
+
试——补传凭据后下一轮自愈。
|
|
234
|
+
- hook 的 `ctx.scheduleTask()` 自排任务时按 **`credRefs.chat`** 分支:父任务带
|
|
235
|
+
chat 引用 → 复制整份引用、不复制凭据本体,换 Key 自动作用于整条自排链;父任
|
|
236
|
+
务只带非 chat 引用(如仅 emotion)→ 引用与内联三件套**都**复制(引用归 hook
|
|
237
|
+
用途,聊天凭据在内联那份里);存量内联任务照旧复制三件套。
|
|
238
|
+
- `prompted` / `auto` 任务 fire 时既无 `credRefs.chat` 也无内联三件套 → 按
|
|
239
|
+
`CREDENTIAL_MISSING` 失败进常规重试(不会被静默判成「不需要 LLM」)。
|
|
240
|
+
`instant` 保持「无凭据 = 纯推送 `userMessage`」的路由语义。
|
|
241
|
+
- 任务投影(`GET /messages` / hook 的 `ctx.task`)带 `credRefs`(只是名字,不
|
|
242
|
+
是机密),客户端对账用;凭据本体照旧被白名单挡在外面。
|
|
243
|
+
- 数据库侧是 `llm_credentials` 表(`(user_id, cred_id)` 主键,`encrypted_value`
|
|
244
|
+
密文,时间戳 ISO8601 文本)。内置的 D1 / pg / neon 适配器都实现了,
|
|
245
|
+
`initSchema()` 会建表。自定义适配器要补 `upsertLlmCredentials` /
|
|
246
|
+
`getLlmCredentials` / `listLlmCredentials` / `deleteLlmCredentials` 四个方法,
|
|
247
|
+
缺任何一个这几个端点返回 501、带 `credRefs` 的排程也会被拒。
|
|
248
|
+
- 特性探测:`GET /capabilities` 的 `features` 含 `'llm-credentials'`。
|
|
249
|
+
|
|
250
|
+
## 读一条任务:列表 vs 单条
|
|
251
|
+
|
|
252
|
+
| 端点 | 给什么 |
|
|
253
|
+
|---|---|
|
|
254
|
+
| `GET /messages` | 任务列表。每条只带 `charId` / `clientTaskId` 两个 `metadata` 子字段 |
|
|
255
|
+
| `GET /message?id=<uuid>` | 单条任务。同样的形状,外加**完整的 `metadata`** |
|
|
256
|
+
|
|
257
|
+
什么时候需要单条:`PUT /update-message` 对 `metadata` 是**整体替换**(不深合并),所以「只改 metadata 里的一个键」必须先把完整的那份读回来,改完再整份传上去;只传一部分会把宿主存在里面的其余键(任务指令、锚点时间戳、过期策略之类)一起冲掉。列表不带整份 metadata,是因为一页最多 100 条,每条都驮着它会把响应撑得很大,而列表要的只是「有哪些任务」。
|
|
258
|
+
|
|
259
|
+
`GET /message` 只读得到还没发出去的任务;已完成 / 已失败的返回 `409 TASK_ALREADY_COMPLETED`,不存在返回 `404 TASK_NOT_FOUND`(与 `PUT /update-message` 同一口径)。响应和列表一样是加密的,客户端侧对应 `client.getMessage(uuid)`。
|
|
260
|
+
|
|
261
|
+
## 更新任务时能改哪些字段
|
|
262
|
+
|
|
263
|
+
`PUT /update-message` 的可写字段:`contactName` / `avatarUrl` / `userMessage` / `completePrompt` / `messages` / `nextSendAt` / `recurrenceType` / `tzId` / `metadata` / `messageSubtype` / `maxTokens` / `temperature` / `splitPattern` / `llmExtraBody`、凭据三件套 `apiUrl` / `apiKey` / `primaryModel`,以及凭据引用 `credRefs`。
|
|
264
|
+
|
|
265
|
+
- `contactName` 必须是非空字符串(口径与排程时一致),空串 / `null` / 非字符串一律 `400`。用户给角色改了名之后,之前排的任务推送出来的通知标题(「来自 <contactName>」)靠它跟着改。
|
|
266
|
+
- `metadata` 是整体替换,不深合并——只改一个子字段的读-改-写流程见上一节。
|
|
267
|
+
- `avatarUrl` 显式传 `null` 是「不改」而不是「清空」(§6.2 的软清空策略要求非法头像被摘掉时保留旧头像,「摘掉」和「传了个 null」在这一层是同一件事)。
|
|
268
|
+
- 凭据三件套传 `null` 同样只是忽略:清掉任何一个,任务到点就发不出去。
|
|
269
|
+
- `credRefs` 是整体替换(语义同 `metadata`),同样做存在性检查;与内联三件套在同一个请求里混着传返回 `400`。给存量内联任务补 `credRefs` 时不动已存的三件套——那份留作 fire 时表行缺失的兜底。
|
|
270
|
+
- `pushSubscription` 不收(`400 PUSH_SUBSCRIPTION_NOT_ACCEPTED`),它是用户级的一份,走 `PUT /push-subscription`。
|
|
271
|
+
- `userMessage` 给了就必须是字符串(口径与排程时一致):它到点要过正则切分,别的类型收进来只会在投递时炸。
|
|
272
|
+
- `messageSubtype` / `llmExtraBody` 显式传 `null` 是「改回默认」(分别是投递时的 `'chat'` 和「不透传额外参数」),不会被当成「不改」吞掉。
|
|
273
|
+
- 响应里的 `updatedFields` 只列真正落进这次更新的字段。请求里带了但没被应用的键——这个接口不接受的、拼错的、传了 `null` 走「不改」语义的——不会出现在里面。
|
|
274
|
+
|
|
275
|
+
## 取消 / 顶替时,没发出去的那几段也会撤掉
|
|
276
|
+
|
|
277
|
+
适配器实现了 outbox 那组方法(内置 D1 有)时,每条 push 在发出去之前会先落一行 `message_outbox`,客户端离线或推送服务抽风时靠 `GET /outbox` 补收。这就带来一个收尾问题:一条任务投递到一半失败过的话,没发出去的那几段还留在 outbox 里等补收,光删任务行它们不会跟着走。
|
|
278
|
+
|
|
279
|
+
所以 `DELETE /cancel-message` 和 `POST /schedule-message` 的 `supersedesUuid` 顶替,都会顺手把该任务名下还没发出去的行撤掉。已经推到设备上的分段不动——取消的意思是「别再发后面的」,不是「把用户已经收到的从收件箱里抹掉」,那几条留着让客户端照常 ack。
|
|
280
|
+
|
|
281
|
+
清理是 best-effort:适配器没实现 outbox、或者清理本身出错,都不影响取消 / 顶替的成功返回(任务行已经删掉了)。
|
|
282
|
+
|
|
283
|
+
## 推送自带任务身份
|
|
284
|
+
|
|
285
|
+
每条从任务行发出去的 push(冻结 prompt 路径和 fire-time hook 路径都算)顶层带这四个字段:
|
|
286
|
+
|
|
287
|
+
| 字段 | 是什么 |
|
|
288
|
+
|---|---|
|
|
289
|
+
| `taskId` | 任务行 id;没有行的 in-server instant 路径为 `null` |
|
|
290
|
+
| `taskUuid` | 任务 uuid(排程方选的那个) |
|
|
291
|
+
| `recurrenceType` | `none` / `daily` / `weekly` —— 这条任务还会不会再来 |
|
|
292
|
+
| `occurrenceMs` | 本次触发的名义时刻,epoch 毫秒 |
|
|
293
|
+
|
|
294
|
+
客户端据此认领任务:角色在 fire 里给自己排的任务,客户端从没见过它,靠这四个字段就能把它记进面板、让用户取消得掉。放在顶层而不是 `metadata` 里——`metadata` 是调用方自己的地盘,库不往里写。
|
|
295
|
+
|
|
296
|
+
hook 在 `pushPayloads` 里自己写了这几个字段的话会被库覆盖:它们描述的是任务行的事实,不是内容。
|
|
297
|
+
|
|
298
|
+
## Fire 时刻 hooks
|
|
299
|
+
|
|
300
|
+
配上 `hooks: { onBeforeFire, onLLMOutput, executeToolCalls }` 之后,AI 类任务的 prompt 不再是排程那一刻冻结的文本,而是 cron 触发时现场组装,工具也在服务端就地跑完,全程不需要客户端在线。完整用法见 [`examples/cloudflare-single-user/README.md`](https://github.com/Tosd0/ReiStandard/blob/main/packages/rei-standard-amsg/server/examples/cloudflare-single-user/README.md) 的「Fire 时刻 hooks」。
|
|
301
|
+
|
|
302
|
+
三个 hook 拿到的 ctx 上都有这几个口子:
|
|
303
|
+
|
|
304
|
+
| ctx 上的口子 | 干什么 |
|
|
305
|
+
|---|---|
|
|
306
|
+
| `readState(ns)` / `writeState(ns, entries)` | 读写 `client_state`,和客户端 `GET/PUT /client-state` 是同一份数据 |
|
|
307
|
+
| `emitResult(payload)` | 给客户端送一条**不是聊天内容**的结果(落收件箱 + 推送) |
|
|
308
|
+
| `scheduleTask(options)` | 给同一个用户再建一条定时任务 |
|
|
309
|
+
| `scratch` | 本次 fire 的便签对象,三个 hook 加上发送后的 `onAfterSend` 共享同一个引用,fire 结束即丢弃 |
|
|
310
|
+
|
|
311
|
+
`onLLMOutput` / `executeToolCalls` 的 ctx 上另外带着任务身份:
|
|
312
|
+
|
|
313
|
+
| 字段 | 是什么 |
|
|
314
|
+
|---|---|
|
|
315
|
+
| `taskId` | 任务行 id |
|
|
316
|
+
| `taskUuid` | 任务 uuid(排程方选的那个) |
|
|
317
|
+
| `occurrenceMs` | 本次触发的名义时刻,epoch 毫秒 |
|
|
318
|
+
|
|
319
|
+
`sessionId` 是给日志和去重用的不透明字符串,格式随版本变,别拆它拿上面这些值。
|
|
320
|
+
|
|
321
|
+
### config 级 hook
|
|
322
|
+
|
|
323
|
+
这两个挂在 worker 工厂 config 的顶层(不在 `hooks` 里):
|
|
324
|
+
|
|
325
|
+
| hook | 什么时候调 | 载荷 |
|
|
326
|
+
|---|---|---|
|
|
327
|
+
| `onAfterSend` | fire 的 pushPayloads 逐段发完,或中途发挂 | `{ task, sentCount, total, error, scratch, readState, writeState, emitResult }` |
|
|
328
|
+
| `onFireSettled` | 一次 fire 收尾——只要 `onBeforeFire` 被调用过,什么结局都调一次 | `{ task, status, skipReason, sentCount, total, iterations, error, scratch, readState, writeState, emitResult }` |
|
|
329
|
+
| `onStaleSkip` | 任务错过触发时刻超过 60 分钟、这一次(或这几次)不再补发 | `{ reason, action, metadata, recurrenceType, occurrenceMs, skippedCount, skippedOccurrences, skippedTruncated, nextSendAt, readState, writeState, emitResult }` |
|
|
330
|
+
|
|
331
|
+
三个 hook 都自带 `readState` / `writeState` / `emitResult`,作用于当前用户,语义与 fire 级那套一致。`onStaleSkip` 尤其需要:服务停摆恢复后的第一跳里可能一次 fire 都没跑过,而那正是它要留痕迹的时候。
|
|
332
|
+
|
|
333
|
+
`onAfterSend` 的 `scratch` 与本次 fire 的 `onBeforeFire` / `onLLMOutput` 是同一个引用——「这次生成了哪几段正文」之类的上下文直接从这里读,不用自建按任务分格的登记表。全部成功时 `error` 为 `null`;第 k 段失败时 `sentCount = k`、`error` 带原始错误,且在错误往上抛之前调用完。
|
|
334
|
+
|
|
335
|
+
`onFireSettled` 是「这次 fire 结束了」这一个信号,`status` 说明结局:
|
|
336
|
+
|
|
337
|
+
| status | 什么时候 |
|
|
338
|
+
|---|---|
|
|
339
|
+
| `sent` | pushPayloads 全部发完(`sentCount === total`) |
|
|
340
|
+
| `skipped` | 这次不发。`skipReason` 区分是 `onBeforeFire` 直接 `{ skip: true }`(`'before-fire'`)还是模型跑完后判定不发(`'skip-push'`) |
|
|
341
|
+
| `failed` | 链路抛错,`error` 带原始错误。发到第 k 段挂了也是这个:`sentCount = k`、`total` 是原本要发的段数 |
|
|
342
|
+
| `not-handled` | `onBeforeFire` 返回 `null`,这条任务交还给排程时冻结的 prompt 老链路。那条链路不归 fire hook 管,它后面发没发出去不体现在这里 |
|
|
343
|
+
|
|
344
|
+
跟 `onAfterSend` 的分工:`onAfterSend` 只走「有 push 要发」这条路,所以 hook 判断这次不用说话、或者链路中途抛错时它不会被调到——「开始时占点什么、结束时放掉」的写法要挂 `onFireSettled`(fire 里已经用 `ctx.scheduleTask` 建出来的任务,不记账就成了只活在数据库里的幽灵任务;fire 开头拿的锁,没有可靠释放点就只能等 TTL)。正常发完时两个都会调,`onAfterSend` 在前。`scratch` 是同一个引用。没配 hooks 的部署、以及不需要 LLM 的固定文本任务不走 fire 这条路径,两个都不会调。
|
|
345
|
+
|
|
346
|
+
`onStaleSkip` 的 `action` 分两种:
|
|
347
|
+
|
|
348
|
+
- `expired` —— 一次性任务,这一次永远不会补发了,行已标 `failed`。
|
|
349
|
+
- `fast_forwarded` —— 循环任务,攒下的这几次都跳过,排期已快进到 `nextSendAt`,行仍是 `pending`,下一次照常触发。
|
|
350
|
+
|
|
351
|
+
`skippedCount` 是一共跳过几次(含名义那一次),`skippedOccurrences` 是被跳过的名义时刻列表(epoch 毫秒);超过 32 次时只给首末两个并把 `skippedTruncated` 置 `true`。两种 action 都会把原因写进 payload 的 `lastError`,`GET /messages` 上看得见。
|
|
352
|
+
|
|
353
|
+
两个 hook 都是 best-effort:自身抛错只记日志,不影响主流程。
|
|
354
|
+
|
|
355
|
+
### `ctx.scheduleTask(options)`
|
|
356
|
+
|
|
357
|
+
角色在这次 fire 里给自己排一条后续任务:「这条发完,一个半小时后我再接着说一句」。建出来的是一条正常的任务行,到点由 cron 触发,用户全程离线也不影响。
|
|
358
|
+
|
|
359
|
+
```js
|
|
360
|
+
const result = await ctx.scheduleTask({
|
|
361
|
+
firstSendTime: new Date(Date.now() + 90 * 60_000).toISOString(), // 必填,ISO 字符串
|
|
362
|
+
messageType: 'auto', // 可选,默认继承当前任务
|
|
363
|
+
recurrenceType: 'none', // 可选,默认 none
|
|
364
|
+
tzId: 'Asia/Tokyo', // 可选,默认继承当前任务;循环推进按这个时区的墙钟走
|
|
365
|
+
metadata: { beat: 'followup' }, // 可选,整体替换当前任务的 metadata(不深合并)
|
|
366
|
+
uuid: `fire-${ctx.taskId}-${ctx.occurrenceMs}`, // 可选,默认随机
|
|
367
|
+
});
|
|
368
|
+
// → { created: true, id, uuid, nextSendAt }
|
|
369
|
+
// 或 { created: false, reason: 'duplicate', uuid, task }
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
撞 uuid 时 `task` 是那条**已经存在的任务行**的投影,形状与 `GET /messages` 列出来的一样(`{ id, uuid, contactName, messageType, messageSubtype, nextSendAt, recurrenceType, tzId, status, retryCount, createdAt, updatedAt, charId, clientTaskId, lastError }`,不含任何凭据)。用确定性 uuid 做重试幂等时,重跑那轮靠它把这条任务记进自己的账本、随 push 带回客户端认领——否则这条任务只活在数据库里,面板列不出、用户取消不了,却照样到点触发。行读不回来(已经不是 pending)→ `task` 为 `null`。
|
|
373
|
+
|
|
374
|
+
凭据和投递配置(`apiUrl` / `apiKey` / `primaryModel` / `maxTokens` / `temperature` / `splitPattern`)以及 `contactName` / `avatarUrl` / `messageSubtype` / `userMessage` / `tzId` 从当前任务继承,宿主只说「什么时候、说什么方向」——hook 全程看不到凭据。推送订阅是用户级的一份,任务不携带、也不用继承。`completePrompt` / `messages` 不继承(都置 `null`):hook 每次现场重组 prompt,把排程时冻结的旧 prompt 带过去,新任务万一走回冻结 prompt 老链路就会静默发出一条谁也没打算发的文案。
|
|
375
|
+
|
|
376
|
+
护栏:
|
|
377
|
+
|
|
378
|
+
| 护栏 | 阈值 / 规则 | 不满足时 | 为什么 |
|
|
379
|
+
|---|---|---|---|
|
|
380
|
+
| `firstSendTime` | 必填、能解析成合法时间、至少比现在晚 **60 秒** | `RangeError` | cron 一分钟一跳,排在 60 秒内等于让下一跳立刻捡走,容易变成自己触发自己的紧密循环 |
|
|
381
|
+
| `messageType` | 只收 `auto` / `prompted` / `fixed` | `TypeError` | `instant` 的语义是「建行的那一刻就投递」,那条路径归 `POST /schedule-message` 管;从 fire 里造这么一行,投递时机反而说不清 |
|
|
382
|
+
| `messageType: 'fixed'` | 必须有 `userMessage`(自己传或继承到) | `TypeError` | 固定文本任务没有正文,就是一条永远发空的任务 |
|
|
383
|
+
| 单次 fire 的建任务条数 | 默认 **2 条**,factory 配置 `maxScheduledTasksPerFire` 可调(`0` = 不许自排) | `RangeError` | 模型自排后续本质上是条能无限延伸的链,没有上限就没人按停止键 |
|
|
384
|
+
| `uuid` 撞车 | 不当错误处理 | 返回 `{ created: false, reason: 'duplicate', uuid, task }` | fire 失败会整条重跑,宿主传一个由「任务 id + 触发时刻」推出来的确定性 uuid 就天然幂等 |
|
|
385
|
+
| `tzId` | 可用的 IANA 时区 id,或 `null` | `TypeError` | 认不出来的时区会让循环推进悄悄退回 UTC,用户设的钟点从此对不上 |
|
|
386
|
+
| 任务内容大小 | 与 `POST /schedule-message` 同一道闸门 | 抛 `RangeError`(`code: 'TASK_PAYLOAD_TOO_LARGE'`) | 往 `metadata` 里塞一坨大对象会顶穿存储的单行上限,不拦的话到落库那步才炸,报错看不出所以然 |
|
|
387
|
+
| 数据库适配器没有 `createTask` | — | 抛 `DeploymentConfigError`(`code: 'AGENTIC_SCHEDULE_UNSUPPORTED'`) | 静默成功会让宿主以为后续那条排上了,其实谁也不会触发它 |
|
|
388
|
+
|
|
389
|
+
`recurrenceType` 沿用排程接口那套 `none` / `daily` / `weekly`,别的值抛 `TypeError`。参数不合法的调用不占建任务额度;uuid 撞车占(那条任务其实已经建出来了)。
|
|
390
|
+
|
|
391
|
+
### `ctx.emitResult(payload)`
|
|
392
|
+
|
|
393
|
+
聊天正文之外的产出——整理好的一份数据、一条账目、后台生成的产物——用它送给客户端。
|
|
394
|
+
|
|
395
|
+
```js
|
|
396
|
+
const { messageId, pushed } = await ctx.emitResult({
|
|
397
|
+
resultKind: 'fire-pack', // 必填:这类结果的名字,客户端按它分流
|
|
398
|
+
packId: 'pack_42', // 以下随便加,形状由你定
|
|
399
|
+
entries: [{ id: 1 }, { id: 2 }],
|
|
400
|
+
notification: { title: '整理好了', body: '点开看看' }, // 可选,见下
|
|
401
|
+
});
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
一条结果走两条路,缺一不可:
|
|
405
|
+
|
|
406
|
+
| 路 | 负责什么 |
|
|
407
|
+
|---|---|
|
|
408
|
+
| 落进 `message_outbox` | **到达**。客户端下次 `GET /outbox?since=` 一定拿得到——推送没送到、内容超过一条推送 4KB 的上限,都不会让它丢 |
|
|
409
|
+
| 发一条 Web Push | **及时**。跑完当场弹一下叫人回来看,而不是等客户端下次上线 |
|
|
410
|
+
|
|
411
|
+
客户端因此不必为每种结果各写一套轮询:补收机制已经在那儿了,结果跟聊天消息从同一个口子回来,靠 `messageKind === 'result'` 分开,再按 `resultKind` 分流。
|
|
412
|
+
|
|
413
|
+
**通知**默认弹(结果与聊天正文同待遇,其余 push 类型是静默送给页面)。标题正文在 `notification` 里自定义,字段与 SW 那套一致(`title` / `body` / `icon` / `tag` / …);不想弹就 `notification: { show: false }`。
|
|
414
|
+
|
|
415
|
+
**返回值**里 `pushed` 是「这次推送有没有真的发出去」。`false` 只表示没能当场送达(订阅失效、推送服务抽风、payload 超过 4KB),行还在收件箱里等补收——所以这不算失败,`emitResult` 也不会因此抛错。
|
|
416
|
+
|
|
417
|
+
**落行失败会抛**:收件箱是到达的保证,静默丢掉正是这个能力要修的病。适配器没有 `message_outbox`(自定义适配器)时同样抛,`code` 是 `OUTBOX_UNSUPPORTED`。
|
|
418
|
+
|
|
419
|
+
**取消**与聊天分段同待遇:结果行上带 `task_uuid`,`DELETE /message` 取消、`supersedesUuid` 顶替时,这条任务名下**还没送到**的结果一起撤掉;已经推到设备上的留着让客户端照常 ack(推出去的撤不回来)。
|
|
420
|
+
|
|
421
|
+
**重试**:`messageId` 缺省值掺了任务 id 与本次名义触发时刻,同一次触发重跑时第 n 条结果拿到的还是同一个 id,收件箱靠 `(user_id, message_id)` 唯一约束天然去重,不会补出第二条。想自己控制就在 payload 里传 `messageId`。
|
|
422
|
+
|
|
423
|
+
`GET /capabilities` 的 features 里有 `emit-result`。
|
|
424
|
+
|
|
425
|
+
### hook 契约违约算确定性失败
|
|
426
|
+
|
|
427
|
+
宿主 hook 返回了库不认的东西(`onBeforeFire` 的返回形状、`onLLMOutput` 的决策标签),或者建后续任务时 `createTask` 没把行交回来——这些错误带 `permanent: true` 和一个稳定的 `code`(`AGENTIC_BAD_BEFORE_FIRE` / `AGENTIC_BAD_DECISION` / `AGENTIC_SCHEDULE_FAILED` / `TASK_PAYLOAD_TOO_LARGE`),投递侧据此跳过退避阶梯:一次性任务直接标 `failed`,循环任务作废本次 occurrence。重试也是同一个结果,而每重试一轮都要把 `onBeforeFire` 和一整轮 LLM 重跑一遍。
|
|
428
|
+
|
|
429
|
+
分界线是「谁写错了」:契约由宿主代码定死,重掷一次还是同一个形状;而模型这一轮掷出了什么则是每轮都可能不同的。所以「tool-request 决策里没有能解析的 `toolCalls`」(`AGENTIC_EMPTY_TOOL_REQUEST`)和「轮数用尽也没等到 `finish` / `skip-push`」(`AGENTIC_LOOP_EXCEEDED`)带 `code` 但不带 `permanent`,留在退避阶梯上——隔两分钟重掷一次多半就正常收尾了,判终态的话一次性任务第一次掷歪就永久 `failed`,行离开 `pending` 之后连 `PUT /update-message` 都救不回来(回 409)。
|
|
430
|
+
|
|
431
|
+
### 部署配错了算可重试
|
|
432
|
+
|
|
433
|
+
部署缺了必要的能力——没配 `onLLMOutput` / `executeToolCalls`,或者自定义适配器没有 `createTask` / `deleteTaskByUuid` / `getTaskByUuid` / `upsertClientState`——抛的是 `DeploymentConfigError`:带同样的 `code`(`AGENTIC_CONFIG_ERROR` / `AGENTIC_SCHEDULE_UNSUPPORTED` / `AGENTIC_CANCEL_UNSUPPORTED` / `AGENTIC_RENEW_UNSUPPORTED` / `AGENTIC_STATE_WRITE_UNSUPPORTED`),但**不带** `permanent`,走的是普通的退避阶梯。
|
|
434
|
+
|
|
435
|
+
因为坏的不是这条任务,是这个部署:同一个坏部署下每条到点的任务都会撞同一个错,判终态等于把那段时间里每一条一次性任务都永久标 `failed`,配置改好重新部署也捞不回来(行已不在 `pending`,`PUT /update-message` 回 409)。留在阶梯上的话,配置一修好,下一跳就正常发出去。VAPID 配错回的 400 / 401 / 403 是同一个道理,见下面的推送失败分级。
|
|
436
|
+
|
|
437
|
+
`AGENTIC_TOTAL_TIMEOUT`(整条 fire 链超出 `totalTimeoutMs`)也走退避重试:这一轮慢不代表下一轮也慢。
|
|
438
|
+
|
|
439
|
+
`GET /capabilities` 的 features 里有 `agentic-schedule-task`,前端可以据此判断部署的 worker 认不认这条链路。
|
|
440
|
+
|
|
107
441
|
## 导出(新增)
|
|
108
442
|
|
|
109
|
-
- `validateLlmMessagesArray(messages)` — 同步预校验 messages 数组,返回 `string | null`(错误信息 /
|
|
443
|
+
- `validateLlmMessagesArray(messages)` — 同步预校验 messages 数组,返回 `string | null`(错误信息 / 通过)。形状规则统一在 `@rei-standard/amsg-shared` 的 `validateLlmMessagesShape`,和 `@rei-standard/amsg-instant` 共用同一实现(含 agentic 会话:assistant 带 `tool_calls` 时 content 可空、`role:'tool'` 要求 `tool_call_id`)。
|
|
110
444
|
- `validateSplitPattern(value)` — 同步预校验 splitPattern(string / string[] / null),返回 `string | null`。
|
|
445
|
+
- `MAX_PUSH_PAYLOAD_BYTES` — 一条 push 的明文上限,3993 字节。
|
|
446
|
+
- `PUSH_ENVELOPE_RESERVED_BYTES` — 库在 hook 交还 payload 之后还要补的那批字段占的字节上界,384。
|
|
447
|
+
- `WEB_PUSH_MAX_BODY_BYTES` / `WEB_PUSH_ENCRYPTION_OVERHEAD_BYTES` — 推送服务的密文 body 上限(4096)与 aes128gcm 固定开销(103),上面那个数就是两者相减。
|
|
448
|
+
- `measurePushPayload(payload)` — 量一段 payload 的字节数与剩余额度,返回 `{ bytes, maxBytes, remainingBytes, withinLimit }`。
|
|
449
|
+
|
|
450
|
+
以上几个在包根和 `@rei-standard/amsg-server/cloudflare` 两个入口都有。
|
|
111
451
|
|
|
112
452
|
## 一体化初始化流程
|
|
113
453
|
|
|
@@ -118,26 +458,261 @@ AI 配置消息的提示词可以用两种形态之一,**互斥二选一**:
|
|
|
118
458
|
|
|
119
459
|
## 端点鉴权
|
|
120
460
|
|
|
121
|
-
- `get-user-key`、`schedule-message`、`update-message`、`cancel-message`、`messages`
|
|
461
|
+
- `get-user-key`、`schedule-message`、`update-message`、`cancel-message`、`messages`、`message`
|
|
122
462
|
- `Authorization: Bearer <tenantToken>`
|
|
123
463
|
- `send-notifications`
|
|
124
464
|
- `Authorization: Bearer <cronToken>` 或 `?token=<cronToken>`
|
|
125
465
|
|
|
466
|
+
## 请求体可以压缩(`Content-Encoding: gzip`)
|
|
467
|
+
|
|
468
|
+
带 `Content-Encoding: gzip` 的请求体在读出来的那一步自动解压,单用户 Worker 上每个带 body 的端点都认(`POST /schedule-message`、`PUT /client-state`、`PUT /llm-credentials`……)。客户端把大 body 压了再传能省下几倍传输量,两边都不用改端点。
|
|
469
|
+
|
|
470
|
+
```js
|
|
471
|
+
await fetch(`${baseUrl}/client-state`, {
|
|
472
|
+
method: 'PUT',
|
|
473
|
+
headers: { ...encryptionHeaders, 'Content-Encoding': 'gzip' },
|
|
474
|
+
body: await gzip(JSON.stringify(encryptedEnvelope)),
|
|
475
|
+
});
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
几条边界:
|
|
479
|
+
|
|
480
|
+
| 情况 | 结果 |
|
|
481
|
+
|---|---|
|
|
482
|
+
| 没有这个头 | 原样读,行为与以前一字不差 |
|
|
483
|
+
| 说是 gzip、字节却是明文 | 按明文处理。有些边缘网关会替你解开请求体却留着这个头,照着头再解一次只会解出乱码 |
|
|
484
|
+
| `br` / `deflate` 之类 | `415 UNSUPPORTED_CONTENT_ENCODING`,不猜着解 |
|
|
485
|
+
| 解压后超过上限 | `413 REQUEST_BODY_TOO_LARGE`。默认 32MB,config 的 `maxRequestBodyBytes` 可调 |
|
|
486
|
+
| 声明了 gzip 但数据是坏的 | `400 INVALID_CONTENT_ENCODING` |
|
|
487
|
+
|
|
488
|
+
上限只管压缩这条路:几百 KB 的压缩数据能展开成几个 GB,不设上限等于把内存交给调用方决定。不压缩的请求体不受它约束。
|
|
489
|
+
|
|
490
|
+
自己包路由的宿主用 `readRequestBody(request, { maxBytes })` 代替 `await request.text()` 就能得到同样的行为,`GET /capabilities` 的 features 里有 `gzip-request-body`。
|
|
491
|
+
|
|
492
|
+
## `client_state` 的过期清理(`clientStateTtl`)
|
|
493
|
+
|
|
494
|
+
`client_state` 默认不过期:写进去的是宿主的数据,库不替它决定什么时候该没。
|
|
495
|
+
|
|
496
|
+
但「大内容旁路」那类用法写的是一次性内容——一条 push 塞不下的正文先写进状态、push 里只带一个引用键,客户端取走之后没人再回来删它。给这类命名空间配上天数,cron 每跳顺手清一次:
|
|
497
|
+
|
|
498
|
+
```js
|
|
499
|
+
clientStateTtl: {
|
|
500
|
+
fire_pack: 7, // fire_pack 下超过 7 天没更新的条目自动清掉
|
|
501
|
+
scratch_pad: 1,
|
|
502
|
+
}
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
- **逐个命名空间开**,没写进配置的一个都不动。
|
|
506
|
+
- 判据是行本来就有的 `updated_at` 列,不加列——升级后老库不用改表结构,也就没有「表没跟上、cron 静默挂在缺的那一列上」这一说。
|
|
507
|
+
- 大值分块存储的切片行跟着根行一起走,不留读不出来的垃圾行。
|
|
508
|
+
- 天数不是正数的条目会被跳过并告警一次;清理本身失败只记日志,不影响这一跳的投递。
|
|
509
|
+
|
|
510
|
+
一个坑说在前头:`PUT /client-state` 和 `writeState()` 的条件写护栏(entry 上的 `version`)落的就是 `updated_at` 这一列。护栏值传的是自增计数器之类的小整数时,这行的 `updated_at` 看起来就像 1970 年,第一次清理就会被扫走。要给某个命名空间配 TTL,就让它的写入方把 `version` 传成毫秒时间戳。
|
|
511
|
+
|
|
512
|
+
`GET /capabilities` 的 features 里有 `client-state-ttl`。
|
|
513
|
+
|
|
514
|
+
## 循环任务的时区(`tzId`)
|
|
515
|
+
|
|
516
|
+
`daily` / `weekly` 任务可以带一个 IANA 时区 id:
|
|
517
|
+
|
|
518
|
+
```js
|
|
519
|
+
await client.scheduleMessage({
|
|
520
|
+
contactName: 'Rei',
|
|
521
|
+
messageType: 'auto',
|
|
522
|
+
firstSendTime: '2026-03-07T13:00:00.000Z', // 纽约当地 08:00
|
|
523
|
+
recurrenceType: 'daily',
|
|
524
|
+
tzId: 'America/New_York',
|
|
525
|
+
// …
|
|
526
|
+
});
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
带了 `tzId` 的任务按**那个时区的墙钟**推进:日期 +1 天 / +7 天,钟点原样保留。用户设的「每天早八点」在夏令时切换前后都还是早八点。不带 `tzId` 的任务按 UTC 推进(等价于固定 +24h / +7×24h)。
|
|
530
|
+
|
|
531
|
+
`PUT /update-message` 也认这个字段:传时区 id 换一个,传 `null` 改回按 UTC 推进(`hasOwnProperty` 判断,不会被吞掉)。`GET /messages` 每条任务多返回一个 `tzId`(没设 → `null`)。
|
|
532
|
+
|
|
533
|
+
两个边界情况的收敛规则:春令时被跳过的墙钟(例如纽约 2:30 不存在)落到切换之后的等价时刻(当地 3:30);秋令时重复出现的墙钟(当地 1:30 出现两次)取其中一个,不触发两次。时区换算全部走 `Intl`,不手搓偏移加减。
|
|
534
|
+
|
|
535
|
+
## 触发任务时的占位
|
|
536
|
+
|
|
537
|
+
`send-notifications`(以及单用户 Worker 的 `scheduled()`)每条任务开跑前会先占位:在这一行的 `lease_until` 上写下「归我管到现在 + 租期为止」,本次投递期间别的 tick 领不走它;占位改到 0 行说明别人先领走了,本次直接跳过。cron 一分钟一跳而带工具的 AI 任务常常跑过一分钟,没有这层占位同一条任务会被相邻几跳重复触发。
|
|
538
|
+
|
|
539
|
+
租约写在自己的列上,`next_send_at` 全程不动——任务列表读到的一直是用户设的那个时刻,循环任务也按它推进到下一次。投递收尾时租约就放掉,失败重试的退避(2 分钟起)不会被租期压住。
|
|
540
|
+
|
|
541
|
+
领了任务的那一跳中途没了(Worker 被回收之类)就没人来放租约,这条任务要等租约到期才会被后面的 tick 接手。把租期设得比最慢的一次投递长一点即可。
|
|
542
|
+
|
|
543
|
+
租期默认 10 分钟;配了 `totalTimeoutMs` 的话按它 + 2 分钟往上抬。想自己定就在 `runScheduledTick` 的 ctx(或单用户 Worker 的 config)里传 `claimLeaseMs`——注意 `createReiServer` 内置的 `/send-notifications` 处理器不透传这两个值,要调租期就自己调 `runScheduledTick`。`onBeforeFire` 里按次放宽的预算占位时看不到,那种情况也要显式设 `claimLeaseMs`。
|
|
544
|
+
|
|
545
|
+
占位管的是定时触发这条路径。`messageType: 'instant'` 走的是「建行 → 当场投递」,不经过占位。
|
|
546
|
+
|
|
547
|
+
内置适配器都实现了占位。自定义适配器可以不实现 `claimTask`,跑得动,只是回到不占位的行为。
|
|
548
|
+
|
|
549
|
+
投递失败的退避记在 `retry_after` 上,租约同时放掉。两件事分两列记:`lease_until` 只表示「这条正在跑」,`retry_after` 表示「这条没在跑,在等重试」。挤在一列的话,下面的分组串行会把一条正在退避、其实闲着的任务当成「这一组忙着」,同组别的任务白等一轮退避(最长 6 分钟)。
|
|
550
|
+
|
|
551
|
+
## 同一分组的任务不并发(`serializeBy`)
|
|
552
|
+
|
|
553
|
+
同一个角色可能有好几条定时任务。撞在一起并发跑的话,用户一口气收到两条互不知情的消息;宿主在 hook 里维护的「我刚才说过什么」台账通常是读进内存 → 改 → 整份写回,两条各改各的再写回,后写的必然盖掉前面那条。
|
|
554
|
+
|
|
555
|
+
`runScheduledTick`(以及单用户 Worker 的 config)收一个可选的 `serializeBy`:
|
|
556
|
+
|
|
557
|
+
```js
|
|
558
|
+
await runScheduledTick({
|
|
559
|
+
// ...其余 ctx
|
|
560
|
+
serializeBy: (task) => task.metadata?.charId ?? null,
|
|
561
|
+
});
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
- 参数是与 `onBeforeFire` 的 `ctx.task` 同一份的只读任务视图(凭据已剔除)。
|
|
565
|
+
- 返回 `null` / 空串、或者不配这个函数 → 这条任务不参与串行,行为与以前完全一致。
|
|
566
|
+
- 同一分组同时只放行一条,**跨跳也算**:上一跳的 fire 还拿着租约时,下一跳捞到同组的另一条也不放行。一次 fire 常常跑十几秒到几分钟,只挡同一跳是不够的。
|
|
567
|
+
- 同一跳内同组放行的是**到点更早**的那条;跑完之后不补跑同组剩下的,留给下一跳。
|
|
568
|
+
- 被拦下的任务是**推迟不是丢弃**:`next_send_at` / `status` / `retry_count` 一个字段都不会被动,下一跳原样再捞一次。条数记在 `details.serializeSkippedTasks`(同一跳内拦下的)和 `details.claimSkippedTasks`(跨跳拦下的)里。
|
|
569
|
+
- `serializeBy` 自身抛错时这条任务这一跳不跑:分不清它属于哪一组,就不该冒着破坏台账的风险跑下去。
|
|
570
|
+
- 正在等重试的任务不算「这一组忙着」(退避记在 `retry_after` 上,租约已经放掉)。
|
|
571
|
+
|
|
572
|
+
判定和占位是同一条 `UPDATE`:先查「这一组忙不忙」再占位的话,两个 tick 的查询会双双在对方占位之前返回「不忙」。分组 key 不明文落库——库拿它和该用户的存储密钥做一次 HMAC,`serialize_group` 列存的是那个派生值。
|
|
573
|
+
|
|
574
|
+
自定义适配器实现了 `claimTask` 但忽略第四个参数的,分组串行退化成只在同一跳内生效;完全没实现 `claimTask` 的同理。
|
|
575
|
+
|
|
576
|
+
`createReiServer` 内置的 `/send-notifications` 处理器不透传 `serializeBy`(和 `claimLeaseMs` 一样),多租户部署要用就自己调 `runScheduledTick`。单用户 Worker 直接在 config 里写。
|
|
577
|
+
|
|
578
|
+
## 任务表用到的三列
|
|
579
|
+
|
|
580
|
+
`lease_until` / `retry_after` / `serialize_group`(都可空)。走 `POST /init-tenant`(或任何一次 `initSchema`)会自动给已有的表补上,跑几次都没事;手工维护表结构的看 `examples/cloudflare-single-user/schema.sql`,Postgres 侧对应三句 `ALTER TABLE scheduled_messages ADD COLUMN IF NOT EXISTS …`。分组串行还多一个索引 `idx_serialize_group_lease`,`initSchema` 一并建。
|
|
581
|
+
|
|
582
|
+
## 表结构自查(`getSchemaVersion` / `ensureSchema`)
|
|
583
|
+
|
|
584
|
+
建表语句是 `CREATE TABLE IF NOT EXISTS`,已经存在的表不会被改动,后加的列靠 `initSchema()` 里的 ALTER 补。升级到新版之后没人再跑一次建表的话,这个部署的表就停在旧形状上——cron 每分钟挂在缺的那一列上,任务一条都不发,而前端界面一切正常。
|
|
585
|
+
|
|
586
|
+
这两个函数把「我需要什么 / 现在是什么 / 帮我补齐」露出来:
|
|
587
|
+
|
|
588
|
+
```js
|
|
589
|
+
import { getSchemaVersion, ensureSchema } from '@rei-standard/amsg-server/cloudflare';
|
|
590
|
+
|
|
591
|
+
const state = await getSchemaVersion(db);
|
|
592
|
+
// → { current: '2.6.0' | null, required: '2.6.0', ok: true | false, missing: [] }
|
|
593
|
+
|
|
594
|
+
if (!state.ok) {
|
|
595
|
+
const fixed = await ensureSchema(db); // 建表 + 补列 + 建索引,重复调没事
|
|
596
|
+
// → { current, required, ok, missing, migrated: true, schema }
|
|
597
|
+
}
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
| 字段 | 是什么 |
|
|
601
|
+
|---|---|
|
|
602
|
+
| `required` | 这一版代码需要的表结构版本(导出常量 `SCHEMA_VERSION`)。表结构自己的版本号,只在表 / 列 / 关键索引变化时抬,与包版本各走各的 |
|
|
603
|
+
| `current` | 活库当前满足的版本:够用就是 `required` 那个值,缺东西就是 `null`(只知道不够用,不知道它停在哪一版) |
|
|
604
|
+
| `ok` | 需要的表 / 列 / 关键索引是不是都在 |
|
|
605
|
+
| `missing` | 缺什么,形如 `table:message_outbox` / `column:scheduled_messages.last_error` / `index:uidx_uuid`。整张表缺席时只报这一张表,不逐列展开 |
|
|
606
|
+
| `migrated`(只有 `ensureSchema` 有) | 这次有没有真的跑 `initSchema()`。本来就够用 → `false`,`schema` 也是 `null` |
|
|
607
|
+
|
|
608
|
+
「需要什么」是从建表语句里解析出来的,不是另抄一份清单:抄的那份漏掉新列的话,自查会对着一个缺列的库回「一切正常」。
|
|
609
|
+
|
|
610
|
+
什么时候调、缺了怎么提示用户,由宿主决定——库不会在每次请求里偷偷迁移。`POST /init-tenant` 的行为一点没变(它内部做的就是 `initSchema()`)。
|
|
611
|
+
|
|
612
|
+
单用户 Worker 上有走 `env` 的同名方法:`worker.getSchemaVersion(env)` / `worker.ensureSchema(env)`,省得自己再造一次适配器。
|
|
613
|
+
|
|
614
|
+
自查要求适配器实现 `describeSchema()`(活库里现在有哪些表 / 列 / 索引,只读)。内置适配器里目前只有 D1 实现了;别的适配器调这两个函数会抛错,而不是假装一切正常。
|
|
615
|
+
|
|
616
|
+
## 只跑指定那一条任务(`runTask`)
|
|
617
|
+
|
|
618
|
+
`scheduled()` 的语义是「扫一遍所有到期任务」。刚落库的任务想立刻跑起来时,触发一次全量扫描是能达到目的,但那样多个执行者会去扫同一批任务,宿主只能退回单实例串行才不重复发。
|
|
619
|
+
|
|
620
|
+
`runTask` 只跑指定那一条,走的是 cron 完全同一条投递链(占位、租约心跳、过期守卫、失败重试 / 终态、hook 全套):
|
|
621
|
+
|
|
622
|
+
```js
|
|
623
|
+
// 单用户 Worker:从 env 拿库和配置
|
|
624
|
+
const result = await worker.runTask(uuid, env);
|
|
625
|
+
|
|
626
|
+
// 自己攒 ctx 的宿主(和 runScheduledTick 同一份 ctx)
|
|
627
|
+
import { runTask } from '@rei-standard/amsg-server/cloudflare';
|
|
628
|
+
const result = await runTask(ctx, uuid);
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
跑起来了是 `{ ran: true, summary }`(`summary` 与 `runScheduledTick` 的返回同构,`totalTasks` 恒为 1)。不跑的几种情形分开回报,宿主不用猜:
|
|
632
|
+
|
|
633
|
+
| `reason` | 什么意思 | 附带 |
|
|
634
|
+
|---|---|---|
|
|
635
|
+
| `not_found` | 没有这条 uuid。一次性任务发完即删,所以「已经发完了」的那条也落在这里 | — |
|
|
636
|
+
| `already_settled` | 行还在,但已经是终态 | `status`(`sent` / `failed`) |
|
|
637
|
+
| `not_due` | 还没到触发时刻 | `nextSendAt` |
|
|
638
|
+
| `retry_pending` | 上次投递失败,还在退避窗口里 | `retryAfter` |
|
|
639
|
+
| `not_configured` | VAPID / webpush 没配齐,跑了也只是白扣这条任务一次重试(只有 `worker.runTask` 有这一种) | — |
|
|
640
|
+
|
|
641
|
+
这个入口只是换了个触发器,不是绕过排期的后门:没到点、在退避窗口里的都不跑。`already_settled` 要求适配器实现 `getTaskStatusByUuidOnly(uuid)`(D1 / pg / neon 都实现了);不实现的自定义适配器把这种情况并进 `not_found`。
|
|
642
|
+
|
|
643
|
+
## 出错时的真实原因
|
|
644
|
+
|
|
645
|
+
`fetch()` 兜底的 500 一直是 `{ success: false, error: { code: 'INTERNAL_ERROR', message: '服务器内部错误' } }`。这两个字段一个没动,真因加在 `error.cause` 上:
|
|
646
|
+
|
|
647
|
+
```json
|
|
648
|
+
{
|
|
649
|
+
"success": false,
|
|
650
|
+
"error": {
|
|
651
|
+
"code": "INTERNAL_ERROR",
|
|
652
|
+
"message": "服务器内部错误",
|
|
653
|
+
"cause": {
|
|
654
|
+
"stage": "request",
|
|
655
|
+
"name": "Error",
|
|
656
|
+
"message": "D1_ERROR: no such table: message_outbox"
|
|
657
|
+
}
|
|
658
|
+
}
|
|
659
|
+
}
|
|
660
|
+
```
|
|
661
|
+
|
|
662
|
+
| 字段 | 是什么 |
|
|
663
|
+
|---|---|
|
|
664
|
+
| `stage` | 在哪一段炸的:`config` = 构建配置时(少了 binding、环境变量丢了),`request` = 路由或处理器抛错 |
|
|
665
|
+
| `name` | 错误类型(`error.name`,认不出来时是 `Error`) |
|
|
666
|
+
| `message` | 错误消息,长得像凭据的串已遮掉、超长截断到 500 字符。`stage: 'config'` 的响应回给跨域调用方时没有这个字段,见下 |
|
|
667
|
+
| `code` | 错误自带的 `code` 字符串,有才带 |
|
|
668
|
+
|
|
669
|
+
只带错误类型和消息文本:密钥、用户数据、任务正文都不在 `error.message` 上,也不往这里放。
|
|
670
|
+
|
|
671
|
+
`stage: 'config'` 那条路多一层收敛:配置都没建起来时这个部署允许哪些 origin 无从得知,响应头只能回显来访 Origin,于是任意第三方页面一个 `fetch` 就能读到这条响应。而构建期异常的原文往往就是部署信息本身(`env.DB is undefined` 报的是 binding 名)。所以跨域读到的那份 `cause` 只有 `stage` / `name` / `code`,`message` 不出去;同源请求和不带 `Origin` 的调用(`curl`、服务端之间调用)照旧拿全文,`wrangler tail` 里也一直有。配置一修好,响应立刻回到部署自己那套 CORS,`stage: 'request'` 的 500 不受这层影响。
|
|
672
|
+
|
|
673
|
+
cron 那条路上没有调用方能读到响应,所以另开两个出口:
|
|
674
|
+
|
|
675
|
+
```js
|
|
676
|
+
export default createSingleUserCloudflareWorker(buildConfig, {
|
|
677
|
+
onError({ stage, error, cause, path }) {
|
|
678
|
+
// fetch / cron 任何一段出错都会调一次(best-effort,自身抛错只记日志)
|
|
679
|
+
},
|
|
680
|
+
});
|
|
681
|
+
```
|
|
682
|
+
|
|
683
|
+
- `onError` 放在工厂的第二个参数上,而不是 `buildConfig` 的返回值里:`buildConfig` 自己抛错时配置里的东西一个都读不到,而那恰恰是最需要被看见的一种故障。`stage` 在 cron 路径上是 `config`(配置构建失败 / VAPID 没配齐)或 `tick`(那一跳抛错)。VAPID 没配齐这一支没有异常对象,`error` 为 `null`、`cause.name` 是 `VapidNotConfigured`。
|
|
684
|
+
- `scheduled()` 现在有返回值:`{ ok: true, summary }` 或 `{ ok: false, cause }`。Cloudflare 不看它,是给「自己包一层再转调 `scheduled`」的宿主和测试用的。
|
|
685
|
+
|
|
126
686
|
## 导出 API(Exports)
|
|
127
687
|
|
|
128
|
-
-
|
|
129
|
-
|
|
130
|
-
- `
|
|
131
|
-
- `
|
|
132
|
-
- `
|
|
133
|
-
- `
|
|
134
|
-
- `
|
|
135
|
-
- `
|
|
136
|
-
- `
|
|
137
|
-
- `
|
|
138
|
-
- `
|
|
139
|
-
- `
|
|
140
|
-
- `
|
|
688
|
+
包根(`@rei-standard/amsg-server`):
|
|
689
|
+
|
|
690
|
+
- `createReiServer` — 多租户装配线(标准路由处理器全家)
|
|
691
|
+
- `createSingleUserServer` — 单用户装配线:没有租户概念,不需要 Blob 租户配置和 tenantToken 体系
|
|
692
|
+
- `createSingleUserCloudflareWorker` — 单用户 Cloudflare Worker 一键装配(`fetch` + `scheduled` 两个入口)
|
|
693
|
+
- `createAdapter` / `createD1Adapter` — pg·neon / Cloudflare D1 数据库适配器
|
|
694
|
+
- `runScheduledTick` — 手动触发一轮到期任务投递(自定义 cron 宿主、要调 `claimLeaseMs` 时用)
|
|
695
|
+
- `runTask` — 只跑指定那一条任务(与 cron 同一条投递链)
|
|
696
|
+
- `getSchemaVersion` / `ensureSchema` / `SCHEMA_VERSION` — 表结构自查与补齐
|
|
697
|
+
- `summarizeErrorCause` — 把异常压成响应体里 `error.cause` 那个形状(自己包一层路由、想回同样形状时用同一份)
|
|
698
|
+
- `NonRetryableError` / `isNonRetryableError` — hook 侧标注「重试也好不了」的失败
|
|
699
|
+
- `readRequestBody` / `DEFAULT_MAX_REQUEST_BODY_BYTES` — 请求正文的读取口(`Content-Encoding: gzip` 在这一步还原),自己包路由时代替 `await request.text()`
|
|
700
|
+
- `createWebCryptoWebPush` — 纯 Web Crypto 的 Web Push 发送器(不依赖 `web-push` 包)
|
|
701
|
+
- `createTenantToken` / `verifyTenantToken`
|
|
702
|
+
- `deriveUserEncryptionKey` / `decryptPayload` / `encryptForStorage` / `decryptFromStorage`
|
|
703
|
+
- `validateScheduleMessagePayload` / `validateLlmMessagesArray` / `validateSplitPattern` / `validateAvatarUrl`
|
|
704
|
+
- `measurePushPayload` / `MAX_PUSH_PAYLOAD_BYTES` / `PUSH_ENVELOPE_RESERVED_BYTES` / `WEB_PUSH_MAX_BODY_BYTES` / `WEB_PUSH_ENCRYPTION_OVERHEAD_BYTES`
|
|
705
|
+
- `isValidISO8601` / `isValidUrl` / `isValidUUID` / `isValidUUIDv4` / `isValidTimeZoneId`
|
|
706
|
+
- `advanceOccurrence` / `nextFutureOccurrence` / `planNextOccurrence` — 循环任务的时区感知推进(宿主想自己算「下次什么时候」时用同一份实现)
|
|
707
|
+
|
|
708
|
+
`@rei-standard/amsg-server/cloudflare` 子路径 —— 只含「单用户 + D1 + Web Crypto 推送」这条子图,不引用多租户装配线和 pg / neon / `web-push`,所以 D1-only 安装(不装可选数据库 peer)也能干净打包,Worker 不需要 `nodejs_compat` 兼容 flag:
|
|
709
|
+
|
|
710
|
+
- `createSingleUserCloudflareWorker` / `createSingleUserServer` / `createD1Adapter` / `runScheduledTick` / `runTask`
|
|
711
|
+
- `getSchemaVersion` / `ensureSchema` / `SCHEMA_VERSION`
|
|
712
|
+
- `summarizeErrorCause` / `NonRetryableError` / `isNonRetryableError`
|
|
713
|
+
- `createWebCryptoWebPush` / `measurePushPayload` / `MAX_PUSH_PAYLOAD_BYTES` / `WEB_PUSH_MAX_BODY_BYTES` / `WEB_PUSH_ENCRYPTION_OVERHEAD_BYTES`
|
|
714
|
+
- `readRequestBody` / `DEFAULT_MAX_REQUEST_BODY_BYTES`
|
|
715
|
+
- `deriveUserEncryptionKey` / `decryptPayload` / `encryptForStorage` / `decryptFromStorage`
|
|
141
716
|
|
|
142
717
|
## 运行环境与要求
|
|
143
718
|
|
|
@@ -180,7 +755,7 @@ PUBLIC_BASE_URL=https://your-domain.com
|
|
|
180
755
|
VERCEL_PROTECTION_BYPASS=YOUR_BYPASS_KEY
|
|
181
756
|
```
|
|
182
757
|
|
|
183
|
-
Vercel
|
|
758
|
+
函数超时、响应头这类 Vercel 配置的写法可参考 [`tests/vercel.json.example`](https://github.com/Tosd0/ReiStandard/blob/main/tests/vercel.json.example)(它是 `tests/` 健康检查端点的部署配置,不是本包的部署模板);环境变量用 `vercel env add` 或控制台配置,不写进 `vercel.json`。
|
|
184
759
|
|
|
185
760
|
## 相关链接(绝对 URL)
|
|
186
761
|
|