dsh-opencode-status 0.1.5 → 0.3.0
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/CHANGELOG.md +50 -0
- package/README.md +43 -11
- package/package.json +5 -4
- package/src/client.js +444 -181
- package/src/index.js +265 -34
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,55 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
- 重构点击交互:侧栏常驻按钮改为打开用量面板(默认用量视图),不再直接弹出连接配置表单;参考 dsh-cpa-status 的双视图范式。
|
|
6
|
+
- 用量面板新增固定底部操作条:`↻ 刷新` 通过 `POST /api/opencode-status/sync` 绕过 30 秒缓存强制重新拉取当前剩余额度(带 `content-type: application/json`,刷新期间按钮禁用并显示旋转 +「刷新中…」),完成后侧栏与面板数值同步更新;右侧固定展示「上次同步 HH:MM:SS」(取 `status.fetchedAt`)。刷新失败时在面板内显示错误文案,不再静默。
|
|
7
|
+
- 设置改为面板内的独立视图(Base URL + API Key),底部 `⚙ 设置` 进入、`← 返回用量` 退出;保存成功后自动回到用量视图。`mode === 'needs_config'` 时面板直接显示设置视图;「取消」保持 0.2.3 语义:丢弃未保存的编辑并关闭面板。
|
|
8
|
+
- 用量面板的三个窗口行同时给出已用 % 与剩余 %、重置倒计时和进度条;颜色按剩余额度阈值(>50 正常、>20 警告、其余错误)着色,与 cpa 的 QuotaBar 语义一致;窗口 `status` 非 `ok` 时给出可见提示。
|
|
9
|
+
- 重新设计 220ms 悬浮微卡:标题 + GO 标识 + 最近同步时间,三个窗口的紧凑行(名称 / 剩余 % / ↻ 重置倒计时 / 细进度条),底部「点击查看详情」;卡片为纯展示(无假按钮),并设置 `pointer-events: none` 不遮挡 footer 按钮的点击。
|
|
10
|
+
- 侧栏常驻按钮按剩余额度着色(>50 正常、>20 警告、否则错误),文案改为「月剩余 N%」摘要;rail 模式(`wide === false`)渲染为真正的 `button`(键盘可达),点击同样打开用量视图。
|
|
11
|
+
- 保留 30 秒 GET 自动刷新;打开面板 / 切换视图只走 30 秒缓存,不触发额外的上游探测,手动刷新是唯一绕过缓存的入口。
|
|
12
|
+
- 测试目录新增 `test/index.js` 目录入口垫片:Node 22.23 的 `node --test <dir>` 不再展开目录参数,垫片让 `node --test dsh-plugins/dsh-opencode-status/test/` 与 `node --test` 两种调用方式都能执行同一套用例。
|
|
13
|
+
- 明确额度语义:上游 `/v1/usage` 只返回 rolling/weekly/monthly 百分比,没有 USD 余额接口(anomalyco/opencode#10448 仍 open),面板只表述「剩余额度 / 可用百分比」,不编造金额。
|
|
14
|
+
- store 用 `view: 'status' | 'settings'` 表达面板视图,不引入已废弃的 `editing` 标识。
|
|
15
|
+
- 修复评审 F2/F3:手动刷新发起时推进请求序号 `statusEpoch`,更早发出的在途 GET 响应(含失败)不再覆盖 `store.status` / `store.error`,手动刷新自身结果仍正常落库,30 秒轮询行为不变;设置视图的「← 返回用量」在 status 尚未加载(null)时也可见,仅 `mode === 'needs_config'` 时隐藏。
|
|
16
|
+
- 测试更新:新增刷新按钮 `POST /sync` 且带 JSON 内容类型、设置入口与视图切换、悬浮卡上次同步、侧栏着色与 rail button、剩余额度阈值着色、窗口异常提示、版本号与文档一致性断言;原有安全与配置用例保持通过(共 35 个用例,含最小 React stub 下的客户端加载、rail button、设置视图返回入口冒烟,以及 F2 的静态断言与「旧 GET 在 POST 之后返回/失败」运行时竞态回归)。
|
|
17
|
+
- 版本号升至 `0.3.0`;README 的功能特性与配置说明同步更新。
|
|
18
|
+
|
|
19
|
+
## 0.2.3
|
|
20
|
+
|
|
21
|
+
- 修复配置面板「取消」按钮点击无反应:该按钮此前只翻转 `editing` 标记,而 0.1.5 的弹窗重构之后已没有任何渲染逻辑读取它。现在「取消」会丢弃未保存的编辑并关闭面板,重新打开时表单从已保存配置重新渲染。
|
|
22
|
+
- 移除 store 中已废弃的 `editing` 字段及其全部写入点。
|
|
23
|
+
- 测试增至 26 个用例,新增客户端「取消」处理函数的静态回归。
|
|
24
|
+
|
|
25
|
+
## 0.2.2
|
|
26
|
+
|
|
27
|
+
- 修复 content-type 回归用例被 Host fence 掩盖的问题:原用例没带 `Host`,请求在来源检查阶段就被拒绝,因此删掉 content-type 校验后测试仍然全绿。现在用例明确带可信 `Host`、断言 `415 UNSUPPORTED_MEDIA_TYPE` 与错误消息,并校验凭据未被修改。
|
|
28
|
+
- `GET` 路由补上与写请求相同的 Host/来源 fence,闭合 DNS rebinding 的读取路径(此前攻击者可读取配额、`baseUrl` 与密钥尾四位掩码)。默认部署(loopback / bind 地址 / `connection.trustedHosts`)不受影响;宿主提供 `connection.isTrusted` 时,读与写都委托官方判定。
|
|
29
|
+
- 写请求 content-type 不合法时由 `403 FORBIDDEN` 改为 `415 UNSUPPORTED_MEDIA_TYPE`,与宿主 `client-connection` 的语义保持一致。
|
|
30
|
+
- 新增两条回归:GET 的 rebinding / 缺 Host / loopback 放行;`connection.isTrusted` 委托在读写两条路径上的放行与拒绝。
|
|
31
|
+
- 文档:README 安全说明区分「默认部署只监听 loopback」与「绑定其它地址时依赖 bind 地址白名单或 `trustedHosts`」,补充读路径 fence 与 415 语义;修复 CHANGELOG 中重复的 `## 0.2.0` 标题。
|
|
32
|
+
- 测试增至 25 个用例。
|
|
33
|
+
|
|
34
|
+
## 0.2.1
|
|
35
|
+
|
|
36
|
+
- package.json 增加 `engines.dsh: ">=0.2.0 <0.3.0-0"` 兼容声明,版本升到 0.2.1。上界写成 `<0.3.0-0` 是为了让 0.3.0 的预发布版同样 UNMET;已用宿主 app-boot 的 `evaluatePluginCompatibility` 实测:`0.2.2-rc.1` → COMPATIBLE,`0.3.0-rc.1` / `0.3.0-rc.2` / `0.3.0` → UNMET(旧的 `>=0.2.0 <0.3.0` 会把 `0.3.0-rc.1`、`0.3.0-rc.2` 误判为 COMPATIBLE)。
|
|
37
|
+
- 请求体 JSON 解析失败时返回 `400` + 错误码 `INVALID`(此前会落到 guard 的 500);`64KB` 请求体上限仍返回 `413`,非对象 JSON 同样返回 `400 INVALID`。
|
|
38
|
+
- 状态缓存(30s TTL)命中条件增加 baseUrl 与 keyRef 比对:在设置页热改配置后,下一次 `GET /api/opencode-status` 立即重新拉取,不再等 TTL 过期;`PUT` 里的显式缓存失效保留。
|
|
39
|
+
- `PUT` / `POST` 写请求增加与宿主 `client-connection` 对齐的来源防护:`content-type` 必须为 `application/json`(允许 charset);`Host` 白名单要求 hostname 属于 loopback(`localhost`、`[::1]`、`127/8`)、等于 `ctx.webServer.host` 的 bind 地址,或命中 `ctx.get('connection')?.trustedHosts`(宿主提供官方 `isTrusted(req)` 时直接采用其结论);拒绝 `sec-fetch-site: cross-site`;带 `Origin` 时必须是同一 authority(`Host` 的默认端口按 `Origin` 的 scheme 归一化,对齐 `isSameAuthorityOrigin`)。否则返回 `403 FORBIDDEN` 且不触碰凭据与配置。`GET` 行为不变,不支持的写方法仍返回 `405`。
|
|
40
|
+
- 客户端强制刷新(`POST /api/opencode-status/sync`)补上 `content-type: application/json`,避免被新的写请求防护拦截。
|
|
41
|
+
- 测试增至 23 个用例,新增 malformed JSON→400、跨源 Origin→403、非 JSON content-type→403、热改配置缓存失效、`engines.dsh` 与客户端请求头断言,以及 DNS rebinding→403(零写入)与 loopback/localhost/bind/trustedHosts 浏览器形态→200 两条回归。
|
|
42
|
+
- 残余风险(后续项):写端点只做来源校验、不做浏览器会话鉴权,同机进程仍可直接访问 loopback 端点;后续可把写操作迁到带鉴权的 `/api` RPC(复用宿主 `connection.admit` 的 Peer 鉴权)。
|
|
43
|
+
|
|
44
|
+
## 0.2.0
|
|
45
|
+
|
|
46
|
+
- 适配 DSH 0.2.x:宿主端改用官方 `Config`(schemastery)schema,`baseUrl` 与 `keyRef` 声明为 `volatile` 字段,删除已被移除的旧配置注册调用,修复插件在 0.2.2-rc.1 上无法激活的问题。
|
|
47
|
+
- `apply(ctx, config)` 同时兼容 plain 配置值与 volatile live ref(`{ get() }` 形态),字段缺失时回退到环境变量 / 官方端点与默认密钥引用。
|
|
48
|
+
- Base URL 修改通过宿主的 settings 服务持久化到 profile 条目 `opencode-status`;宿主未提供该服务或写入失败时返回 `SETTINGS_UNAVAILABLE` / `PERSIST_FAILED` 的 409 响应,不再抛到路由外。
|
|
49
|
+
- 保持对外行为不变:4 个 HTTP 端点(含 GET/PUT 配置与 POST 同步)的状态码与响应结构、30s 缓存、10s 超时、64KB 请求体上限、`no-store`、405 分支、密钥脱敏提示与错误码均未改变;API Key 仍只存放于 credentials。
|
|
50
|
+
- 依赖升级到 `@deepseek-ai/schemastery@^3.19.0`(volatile 字段支持)。
|
|
51
|
+
- 测试迁移到新的 Config 读取路径,并补充 volatile ref、settings 成功 / 缺失 / 失败三条路径与 Config 导出断言。
|
|
52
|
+
|
|
3
53
|
## 0.1.5
|
|
4
54
|
|
|
5
55
|
- 消除点击弹窗中的重复进度条展示:用量进度条与倒计时全部由 220ms 悬浮微卡呈现(免点即看),点击按钮直达「⚙ OpenCode GO 连接配置」管理卡片(配置 Base URL、设置 API Key、清除 Key 与强制同步)。
|
package/README.md
CHANGED
|
@@ -1,20 +1,31 @@
|
|
|
1
1
|
# dsh-opencode-status
|
|
2
2
|
|
|
3
|
-
OpenCode GO 套餐用量与配额状态监控面板插件(DeepSeek Harness
|
|
3
|
+
OpenCode GO 套餐用量与配额状态监控面板插件(DeepSeek Harness):侧栏常驻极简单行胶囊按钮,点击即打开用量面板,查看 5h 滚动窗口、周窗口、月窗口的剩余额度与重置倒计时,并可手动刷新或进入独立设置视图。
|
|
4
4
|
|
|
5
5
|
## 功能特性
|
|
6
6
|
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
7
|
+
- **点击打开用量面板**:侧栏常驻按钮(`● OpenCode · 月剩余 70%`)点击后打开的是用量面板(默认用量视图),不再是只弹出连接配置表单;按剩余额度着色(>50 正常、>20 警告、其余错误),rail 模式下同样是可点击的真按钮。
|
|
8
|
+
- **固定底部操作条**:
|
|
9
|
+
- `↻ 刷新`:通过 `POST /api/opencode-status/sync` 绕过 30 秒缓存,强制重新拉取当前剩余额度;刷新期间按钮禁用并显示旋转与「刷新中…」,完成后面板与侧栏数值同步更新,失败时在面板内显示错误文案而不是静默。
|
|
10
|
+
- `⚙ 设置`:进入面板内的独立连接设置视图,可随时 `← 返回用量`。
|
|
11
|
+
- 右侧固定显示「上次同步 HH:MM:SS」(取 `status.fetchedAt`)。
|
|
12
|
+
- **3 维度用量行**:每行同时给出已用 % 与剩余 %、重置倒计时和进度条,颜色按剩余额度阈值着色(与 dsh-cpa-status 的 QuotaBar 语义一致);窗口状态非 `ok` 时给出可见提示。
|
|
13
|
+
- **滚动窗口 (5h)**:`已用 30% · 剩余 70% · ↻ 4h20m`
|
|
14
|
+
- **周窗口 (Weekly)**:周额度消耗与剩余 % + 重置倒计时
|
|
15
|
+
- **月窗口 (Monthly)**:月额度消耗与剩余 % + 重置倒计时
|
|
16
|
+
- **连接设置视图**:未配置(`mode === 'needs_config'`)时面板直接显示设置视图;保存成功后自动回到用量视图;「取消」丢弃未保存的编辑并关闭面板。密钥仅存入宿主凭据库(`OPENCODE_GO_API_KEY`),API 响应不回传明文。
|
|
17
|
+
- **220ms 悬浮微卡**:鼠标悬停常驻按钮 220ms 后在面板关闭且连接正常时出现,展示标题 + GO 标识 + 最近同步时间、三个窗口的紧凑行(名称 / 剩余 % / ↻ 重置倒计时 / 细进度条)与底部「点击查看详情」;纯展示卡片,不拦截按钮点击。
|
|
18
|
+
- **缓存与刷新**:服务端 30 秒缓存 + 客户端 30 秒自动刷新;打开面板、切换视图不会额外探测上游,手动刷新是唯一绕过缓存的入口。
|
|
19
|
+
- **额度语义**:上游 `/v1/usage` 只提供 rolling/weekly/monthly 百分比,没有 USD 余额接口([anomalyco/opencode#10448](https://github.com/anomalyco/opencode/issues/10448) 仍 open),因此界面只展示「剩余额度 / 可用百分比」,不编造金额余额。
|
|
15
20
|
|
|
16
21
|
## 安装与更新
|
|
17
22
|
|
|
23
|
+
### 兼容性(DSH 0.2.x)
|
|
24
|
+
|
|
25
|
+
- 本版本(`0.3.x`)面向 **DeepSeek Harness 0.2.x**,已在 `0.2.2-rc.1` 上验证;`package.json` 通过 `engines.dsh: ">=0.2.0 <0.3.0-0"` 声明兼容范围(上界带 `-0` 显式排除 0.3.0 的预发布版;宿主用 semver `includePrerelease` 校验,已用其 `evaluatePluginCompatibility` 验证 `0.2.2-rc.1` 为 COMPATIBLE、`0.3.0-rc.1`/`0.3.0-rc.2`/`0.3.0` 为 UNMET)。
|
|
26
|
+
- DSH 0.2.x 移除了旧的插件配置注册接口,改为读取插件导出的 schemastery `Config`:`baseUrl`、`keyRef` 声明为 `volatile` 字段,由宿主生成配置表单并以 live ref 传入 `apply(ctx, config)`。因此 `0.1.x` 及更早版本在 DSH 0.2.x 上无法激活,请升级到 `0.2.0` 或更高版本。
|
|
27
|
+
- 升级方式:先把 DSH 升级到 0.2.x,再执行下面的安装命令(默认拉取 `@latest`),然后重启 `dsh web`。Base URL 会以插件配置写入当前 profile 的 `cordis.patch.yml`,API Key 仍保存在宿主凭据库,无需迁移。
|
|
28
|
+
|
|
18
29
|
### 1. 官方 npm 安装(推荐)
|
|
19
30
|
|
|
20
31
|
```sh
|
|
@@ -29,6 +40,7 @@ dsh plugin --profile web add github:j2st1n/dsh-opencode-status
|
|
|
29
40
|
|
|
30
41
|
> **说明**:
|
|
31
42
|
> - 无需指定版本号,默认拉取 `@latest` 最新版本;
|
|
43
|
+
> - 请使用 `0.2.0` 及以上版本,旧版无法在 DSH 0.2.x 上激活;
|
|
32
44
|
> - 安装后重启 `dsh web` 即可立即生效。
|
|
33
45
|
|
|
34
46
|
### 3. 卸载
|
|
@@ -39,10 +51,30 @@ dsh plugin --profile web remove dsh-opencode-status
|
|
|
39
51
|
|
|
40
52
|
## 配置
|
|
41
53
|
|
|
42
|
-
|
|
43
|
-
- **Base URL**:默认 `https://opencode.ai/zen/go`
|
|
54
|
+
点侧栏常驻按钮打开用量面板,再点面板底部「⚙ 设置」进入连接设置视图;未配置时面板会直接显示设置视图:
|
|
55
|
+
- **Base URL**:默认 `https://opencode.ai/zen/go`(也可用环境变量 `OPENCODE_BASE_URL` 提供未持久化时的默认值)
|
|
44
56
|
- **API Key**:粘贴你的 OpenCode API Key(亦可直接在环境变量中配置 `OPENCODE_GO_API_KEY`)
|
|
45
57
|
|
|
58
|
+
保存成功后自动回到用量视图;「取消」丢弃未保存的编辑并关闭面板,重新打开时表单从已保存配置重新渲染。
|
|
59
|
+
|
|
60
|
+
配置存储方式(DSH 0.2.x):
|
|
61
|
+
- **Base URL** 属于插件 `Config` 的 `volatile` 字段:修改时通过宿主的 settings 服务写回当前 profile 条目(`opencode-status`),重启后依然生效;宿主未提供 settings 服务时,修改 Base URL 会返回明确的错误响应,插件不会崩溃。
|
|
62
|
+
- **API Key** 只写入宿主凭据库(默认引用 `OPENCODE_GO_API_KEY`),HTTP 响应仅返回 `••••` 掩码提示,不回传明文。
|
|
63
|
+
- 状态缓存命中时会校验 baseUrl 与 keyRef,因此在 DSH 设置页改动配置后,下一次读取立即生效,无需等待 30s 缓存过期。
|
|
64
|
+
|
|
65
|
+
## 安全说明
|
|
66
|
+
|
|
67
|
+
- 默认部署只监听本机 loopback,所有响应带 `Cache-Control: no-store`;绑定其它地址时(`--host` / 反代),写请求是否放行取决于 bind 地址白名单与 `connection.trustedHosts`。
|
|
68
|
+
- `GET` 与 `PUT` / `POST` 共用同一套 Host/来源防护,读路径同样会拒绝 DNS rebinding(攻击者页面无法读取配额、`baseUrl` 或密钥掩码):
|
|
69
|
+
- **Host 白名单**:Host 必须可解析,且 hostname 属于 loopback(`localhost`、`[::1]`、`127/8`)、等于监听器 bind 地址(`ctx.webServer.host`),或命中 `ctx.get('connection')?.trustedHosts`;宿主提供官方 `isTrusted(req)` 时直接采用其结论;
|
|
70
|
+
- 请求带 `sec-fetch-site: cross-site` 时直接拒绝;
|
|
71
|
+
- 带 `Origin` 头时必须是同一 authority(Host 的默认端口按 Origin 的 scheme 归一化,对齐 `isSameAuthorityOrigin`),否则返回 `403 FORBIDDEN`,且不会读取或写入凭据与配置。
|
|
72
|
+
- 写请求在上述防护之外还要求 `content-type: application/json`(允许 `charset` 参数),不满足时返回 `415 UNSUPPORTED_MEDIA_TYPE`(与宿主 `client-connection` 语义一致)。
|
|
73
|
+
- 不支持的方法仍返回 `405`(先于来源判定)。
|
|
74
|
+
- 请求体上限 64KB,超出返回 `413`;JSON 解析失败返回 `400`(错误码 `INVALID`)。
|
|
75
|
+
- API Key 只在宿主凭据库中保存,HTTP 响应仅回传尾 4 位掩码。
|
|
76
|
+
- **残余风险**:端点只做来源校验,不做浏览器会话鉴权,同机进程仍可直接访问 loopback 端点;后续可把操作迁到带鉴权的 `/api` RPC(复用宿主 `connection.admit` 的 Peer 鉴权)。
|
|
77
|
+
|
|
46
78
|
## License
|
|
47
79
|
|
|
48
80
|
[Apache-2.0](./LICENSE)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dsh-opencode-status",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "OpenCode GO quota
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "OpenCode GO quota status panel for DeepSeek Harness: click to open a usage panel with manual refresh, per-window remaining quota, a hover overview card, and in-app connection settings",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"keywords": [
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@deepseek-ai/schemastery": "^3.
|
|
37
|
+
"@deepseek-ai/schemastery": "^3.19.0"
|
|
38
38
|
},
|
|
39
39
|
"repository": {
|
|
40
40
|
"type": "git",
|
|
@@ -43,7 +43,8 @@
|
|
|
43
43
|
"homepage": "https://github.com/j2st1n/dsh-opencode-status#readme",
|
|
44
44
|
"bugs": "https://github.com/j2st1n/dsh-opencode-status/issues",
|
|
45
45
|
"engines": {
|
|
46
|
-
"node": ">=20"
|
|
46
|
+
"node": ">=20",
|
|
47
|
+
"dsh": ">=0.2.0 <0.3.0-0"
|
|
47
48
|
},
|
|
48
49
|
"scripts": {
|
|
49
50
|
"test": "node --test"
|