docs: define proxy labels and default profiles

This commit is contained in:
QiuSW
2026-07-27 12:00:38 +08:00
parent eeb7950806
commit a8b7277dab
9 changed files with 58 additions and 6 deletions
+3 -2
View File
@@ -25,7 +25,7 @@ type RemoteDebugTargetInspector interface {
调用者必须提供当前实例已经验证的实际端口;实现仍会复核 `/json/version` 的浏览器类型。该接口只请求 loopback HTTP `/json/list`,不公开或使用 `webSocketDebuggerUrl`,也不提供导航、关闭、创建 target 或执行脚本的接口。
UI 编辑使用独立的 `EditableInstance` DTO(`ID`、名称、浏览器类型、User Data Dir、启动 URL、`ProxyID`),不将运行时 PID、状态、来源或实际远程调试端口写回配置。`ProxyProfile` DTO 只包含 `ID`、名称和已校验的无认证端点;不提供认证字段。状态刷新使用 `RefreshInstanceStatus(ctx, []InstanceSnapshot) ([]InstanceStatusResult, error)` 形状:每个结果以 `ID` 和快照版本对应,错误可按行返回;实现只能检查调用方提供的实例范围。
UI 编辑使用独立的 `EditableInstance` DTO(`ID`、名称、浏览器类型、User Data Dir、启动 URL、`ProxyID`),不将运行时 PID、状态、来源或实际远程调试端口写回配置。`ProxyProfile` DTO 只包含 `ID`、必填且大小写无关唯一的显示名称、已校验的无认证端点;不提供认证字段。`InstanceRow.ProxyID` 是唯一持久关联,列表中的代理名称是按当前代理 DTO 推导的显示值,不持久化副本。状态刷新使用 `RefreshInstanceStatus(ctx, []InstanceSnapshot) ([]InstanceStatusResult, error)` 形状:每个结果以 `ID` 和快照版本对应,错误可按行返回;实现只能检查调用方提供的实例范围。
## Application service
@@ -75,9 +75,10 @@ type TrayState struct {
func DefaultPath() (string, error) // <dir(os.Executable())>\\config.json
func LegacyPath() (string, error) // %APPDATA%\\chub\\config.json,仅用于一次迁移
func OpenDefault() (*Store, error) // 目标优先;必要时校验并原子迁移 legacy
func DefaultInstanceUserDataDir(instanceID string) (string, error) // <dir(os.Executable())>\\user_data_dirs\\<instanceID>
```
调用方不得把当前工作目录作为配置来源,也不得自行复制、删除或合并 legacy 文件。`OpenDefault` 的迁移是文件级配置迁移,不迁移 `UserDataDir`、日志目录或浏览器文件;目标文件存在、legacy 缺失时均不产生写入。迁移失败返回稳定的配置错误,调用方不得改用 legacy 继续写入。
调用方不得把当前工作目录作为配置来源,也不得自行复制、删除或合并 legacy 文件。`OpenDefault` 的迁移是文件级配置迁移,不迁移 `UserDataDir`、日志目录或浏览器文件;目标文件存在、legacy 缺失时均不产生写入。`DefaultInstanceUserDataDir` 只生成绝对默认字符串,不创建目录;调用方必须先分配稳定、唯一的实例 ID。迁移失败返回稳定的配置错误,调用方不得改用 legacy 继续写入。
## CLI 当前合约