mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-20 17:08:01 +00:00
feat(sdk): 注入行为的记忆/裁剪标志位（纯追加）+ plugindev 退出码修复 + 示例 hmap 随发版
## 1. 注入标志位（公开 API 纯追加，无签名变更）
给注入行为补上工具早已有的两类声明位，并让通道定义也带上：
- `InjectOptions{NoMemory, ContextPolicy, CleanerName}`
- `IOInjector` 新增六个 `*Opts` 变体（排队/中断/同步 × 纯文本/带媒体）
- `ChannelDef.ContextPolicy`，并**补上 JSON tag**（Cleaner 标 `json:"-"`）
零值 InjectOptions 与旧的三参数方法完全等价（记入记忆 + 不裁剪），
存量插件不需要改一行、也不需要重编；旧方法保留为转发到零值 opts 的语法糖。
三条设计要点：
- **默认不裁剪**：裁剪会归档丢弃低相关事件，必须显式声明（ContextPolicy=prune）。
- **中断也允许声明 prune**（已确认）：中断同样携带内容进上下文。
- `CleanerName`：注入的 source 未必是注册过的输入通道名，而注入内容常带
ANSI/JSON 包装；允许显式指定用哪个已注册 cleaner 清洗。
顺带修掉一个易静默丢字段的坑：`ChannelDef` 原来没有 JSON tag，只能手写字段
白名单跨进程传（`{"NoMemory": ...}`），新增字段会被丢掉。现在模板整体传 `def`。
## 2. 示例调用点统一写明意图
rss/memo/calendar/qq 的中断注入显式 `NoMemory: true`（行为等价，写清语义）。
## 3. plugindev 出错却 exit 0（真缺陷）
`buildBundle`/`buildTarget` 遇错只 Printf 后 return，`cmdBuild` 返回 void，
于是**构建失败也退 0**。实测中一个示例的 windows 目标编译失败，批量脚本却报
「17/17 全绿」，并因此少产出 16 个 .hmap。现在累计 `buildFailed` 并以非零退出。
## 4. 平台策略：插件目标去掉 windows
homed 已放弃 Windows 原生（见核心仓 cmd/homed/platform_windows.go：插件体系依赖
fd 继承 + 统一共享内存区的段内偏移解引用，Windows 句柄模型无法表达），
插件只运行在 homed 能跑的平台上，故 `allBundleTargets` 去掉 windows，
并对 windows 目标给出**可执行的报错**（指引 WSL2），而不是让它死在一句
`undefined: attachUnifiedShm` 上。
## 5. 发版附带各示例插件的 .hmap
新增 `package/build-examples.sh` 并接入 `package/build.sh`（组件 all|plugindev|examples）：
- 用**刚构建出来的**那把工具链构建示例，保证与本次发版同源
- 逐平台 `--no-bundle --target <os/arch>`（bundle 会连 windows 一起编）
- 判成功同时看**退出码 + 产物存在**
- 全部产物齐了才 `sha256sum`（边打边算会漏掉后生成的包）
- 有任一失败即整体失败，不生成 SHA256SUMS
## 6. 版本
SDK 仍为 1.2.0（main 是下一个未发布中版本）；1.2.0 条目补记本次新增接口，
并注明新标志位需核心 1.2.0+（旧核心会忽略这些字段，不报错但不生效）。
This commit is contained in:
JianFeeeee
149
package/build-examples.sh
Normal file
149
package/build-examples.sh
Normal file
@ -0,0 +1,149 @@
|
||||
#!/usr/bin/env bash
|
||||
# 给 SDK 发版打包**示例插件**的 .hmap 产物。
|
||||
#
|
||||
# 为什么要在 SDK 仓库里发示例插件的 hmap：
|
||||
# 插件二进制与内核是**协议绑定**的（internal/plugin/proc/protocol.go 的
|
||||
# ProtocolVersion + 统一共享内存区魔数）。SDK 升版往往同时意味着协议变化，
|
||||
# 而示例插件（qq/memo/browser/…）是使用者最常直接安装的东西。
|
||||
# 如果 SDK 只发工具链不发示例产物，使用者要么自己重编、要么用到与本版 SDK
|
||||
# 不匹配的旧产物——后者的表现是握手失败（协议/魔数不匹配），而且看起来像
|
||||
# 「插件坏了」而不是「版本不配套」。
|
||||
#
|
||||
# 用法：
|
||||
# package/build-examples.sh [TARGET] [OUT_DIR]
|
||||
# TARGET native(默认) | linux/amd64 | linux/arm64 | darwin/amd64 | darwin/arm64 | windows/amd64 | all
|
||||
# OUT_DIR 产物目录（默认 build/examples）
|
||||
#
|
||||
# 产物：
|
||||
# <OUT_DIR>/<name>_<goos>_<goarch>.hmap 每个示例插件一份
|
||||
# <OUT_DIR>/SHA256SUMS 全部产物齐全**之后**才计算
|
||||
# <OUT_DIR>/MANIFEST.txt 版本、协议版本、产自哪个 commit
|
||||
#
|
||||
# 纪律（与本项目其它构建脚本一致）：
|
||||
# 1. 判成功看**产物是否存在**，不看退出码——plugindev 对部分错误只打印不退出。
|
||||
# 2. SHA256SUMS 必须在全部产物生成完毕后一次算完，边打边算会漏掉后生成的包。
|
||||
set -uo pipefail
|
||||
|
||||
SDK_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
||||
TARGET="${1:-native}"
|
||||
OUT_DIR="${2:-$SDK_ROOT/build/examples}"
|
||||
GO="${GO:-$(command -v go 2>/dev/null || echo go)}"
|
||||
|
||||
case "$TARGET" in
|
||||
native) GOOS=""; GOARCH="" ;;
|
||||
linux/amd64) GOOS=linux; GOARCH=amd64 ;;
|
||||
linux/arm64) GOOS=linux; GOARCH=arm64 ;;
|
||||
darwin/amd64) GOOS=darwin; GOARCH=amd64 ;;
|
||||
darwin/arm64) GOOS=darwin; GOARCH=arm64 ;;
|
||||
windows/amd64)
|
||||
# 明确拒绝，而不是让调用方拿到一句深层 Go 编译错误。
|
||||
# 协议 2 的统一共享内存区只移植到了 Unix：内核 internal/plugin/proc/
|
||||
# shmpass_windows.go 仍是旧的 SHM_STAGE/SHM_EVTRING 两段布局，
|
||||
# 插件模板 proc_shm_windows.go 也缺 attachUnifiedShm。
|
||||
echo "windows 目标暂不支持：协议 2 的统一共享内存区未移植到 Windows（内核与插件模板均缺实现）。" >&2
|
||||
exit 1
|
||||
;;
|
||||
all)
|
||||
echo "本脚本一次只构建一个平台；请由 package/build.sh 传入具体目标。" >&2
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
echo "Unknown target: $TARGET" >&2
|
||||
echo "Usage: $0 [native|linux/amd64|linux/arm64|darwin/amd64|darwin/arm64|windows/amd64|all] [OUT_DIR]" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
export CGO_ENABLED=0
|
||||
|
||||
# 按平台逐个构建，**不用** bundle 模式：
|
||||
# - bundle 会连 windows 一起编，而协议 2 的统一共享区尚未移植到 Windows
|
||||
# （内核 shmpass_windows.go 仍是旧的两段布局），必然失败；
|
||||
# - 逐平台构建每个目标都产出一份 .hmap，正是发版要附的产物。
|
||||
# 平台名解析成本脚本后面用（校验和与 MANIFEST 都要写清楚是哪个平台）。
|
||||
if [ -z "${GOOS:-}" ]; then
|
||||
GOOS="$(go env GOOS)"; GOARCH="$(go env GOARCH)"
|
||||
fi
|
||||
|
||||
# 1) 先保证工具链可用：示例必须用**本仓当前源码**构建，否则产物协议与这一版 SDK 不符。
|
||||
# 允许外部指定（发版脚本会在跨平台构建后把刚产出的工具链路径传进来）。
|
||||
PLUGINDEV="${PLUGINDEV:-$SDK_ROOT/build/plugindev}"
|
||||
if [ ! -x "$PLUGINDEV" ]; then
|
||||
echo "[examples] 先构建 plugindev ..."
|
||||
( cd "$SDK_ROOT/tools/plugindev" && "$GO" build -o "$PLUGINDEV" . ) || {
|
||||
echo "[examples] plugindev 构建失败，无法继续" >&2; exit 1; }
|
||||
fi
|
||||
if [ ! -x "$PLUGINDEV" ]; then
|
||||
echo "[examples] plugindev 不存在或不可执行：$PLUGINDEV" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "=== 协议 ==="
|
||||
echo " ProtocolVersion = $(grep -m1 '^const ProtocolVersion' "$SDK_ROOT/../internal/plugin/proc/protocol.go" 2>/dev/null | grep -oE '[0-9]+' || echo '?（本仓非内核仓，跳过）')"
|
||||
|
||||
mkdir -p "$OUT_DIR"
|
||||
# 清掉上一次的校验和：残留的 SHA256SUMS 会掩盖本次缺产物。
|
||||
rm -f "$OUT_DIR"/SHA256SUMS "$OUT_DIR"/MANIFEST.txt
|
||||
|
||||
ok=0
|
||||
fail=0
|
||||
failed_names=""
|
||||
|
||||
for dir in "$SDK_ROOT"/example/*/; do
|
||||
[ -f "$dir/plugin.go" ] || continue
|
||||
name="$(basename "$dir")"
|
||||
|
||||
# 清掉旧产物：残留会让人（和本脚本）误判成功。
|
||||
rm -rf "$dir/build" "$dir/dist"
|
||||
|
||||
out=$( cd "$dir" && "$PLUGINDEV" build --no-bundle --target "$GOOS/$GOARCH" 2>&1 )
|
||||
rc=$?
|
||||
|
||||
# 判据是**退出码 + 产物存在**，两者都要。
|
||||
# 只看退出码：plugindev 曾经出错也退 0（已修，但脚本不该依赖它「现在」是对的）。
|
||||
# 只看产物：部分平台失败时会留下上一次的产物，看起来像成功。
|
||||
hmap="$(ls "$dir"/dist/*.hmap 2>/dev/null | head -1)"
|
||||
if [ $rc -eq 0 ] && [ -n "$hmap" ]; then
|
||||
# 保留插件自己声明的产物名（它用的是 plg.json 的 name_en，是插件的身份），
|
||||
# 只在前面加平台前缀避免多平台互相覆盖。
|
||||
dest="$OUT_DIR/${GOOS}_${GOARCH}_$(basename "$hmap")"
|
||||
cp "$hmap" "$dest"
|
||||
printf "✓ %-14s → %s (%s)\n" "$name" "$(basename "$dest")" "$(du -h "$dest" | cut -f1)"
|
||||
ok=$((ok + 1))
|
||||
else
|
||||
printf "✗ %-14s 构建失败 (rc=%d)\n" "$name" "$rc"
|
||||
echo "$out" | tail -6 | sed 's/^/ /'
|
||||
fail=$((fail + 1))
|
||||
failed_names="$failed_names $name"
|
||||
fi
|
||||
done
|
||||
|
||||
echo
|
||||
echo "示例产物: 成功 $ok / 失败 $fail"
|
||||
[ -n "$failed_names" ] && echo "失败:$failed_names"
|
||||
|
||||
# 有失败就不算发版闭环：宁可整个中断，也不要发出「少几个插件」的包。
|
||||
if [ $fail -ne 0 ]; then
|
||||
echo "[examples] 有示例构建失败，不生成 SHA256SUMS" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# 2) 全部产物齐了才算校验和。
|
||||
( cd "$OUT_DIR" && sha256sum ./*.hmap > SHA256SUMS )
|
||||
|
||||
VERSION="${VERSION:-$(git -C "$SDK_ROOT" describe --tags --dirty 2>/dev/null || echo unknown)}"
|
||||
COMMIT="${COMMIT:-$(git -C "$SDK_ROOT" rev-parse --short HEAD 2>/dev/null || echo unknown)}"
|
||||
{
|
||||
echo "sdk_version: $VERSION"
|
||||
echo "sdk_commit: $COMMIT"
|
||||
echo "target: $GOOS/$GOARCH"
|
||||
echo "plugins: $ok"
|
||||
echo "built_at: $(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
||||
echo
|
||||
echo "这些 .hmap 与本版 SDK 的插件协议绑定，必须与同版本内核配套安装。"
|
||||
echo "校验：sha256sum -c SHA256SUMS"
|
||||
} > "$OUT_DIR/MANIFEST.txt"
|
||||
|
||||
echo "[examples] 产物: $OUT_DIR"
|
||||
echo "[examples] 清单: $OUT_DIR/MANIFEST.txt"
|
||||
echo "[examples] 校验: $OUT_DIR/SHA256SUMS"
|
||||
@ -28,7 +28,7 @@ case "$TARGET" in
|
||||
;;
|
||||
*)
|
||||
echo "Unknown target: $TARGET"
|
||||
echo "Usage: $0 [native|linux/amd64|linux/arm64|darwin/amd64|darwin/arm64|windows/amd64|all] [all|plugindev]"
|
||||
echo "Usage: $0 [native|linux/amd64|linux/arm64|darwin/amd64|darwin/arm64|windows/amd64|all] [all|plugindev|examples]"
|
||||
exit 1
|
||||
esac
|
||||
|
||||
@ -55,9 +55,32 @@ build_plugindev() {
|
||||
cd "$PROJECT_ROOT"
|
||||
}
|
||||
|
||||
# 示例插件产物随 SDK 一起发。
|
||||
#
|
||||
# 为什么必须发：插件二进制与内核是**协议绑定**的（ProtocolVersion + 统一共享
|
||||
# 内存区魔数）。SDK 升版常伴随协议变化，只发工具链不发示例产物，使用者很可能
|
||||
# 拿旧产物去装，表现是握手失败（魔数不匹配）——看起来像「插件坏了」而不是
|
||||
# 「版本不配套」。
|
||||
#
|
||||
# 用刚构建出来的那把工具链（而非 PATH 里的），保证产物与本次发版同源。
|
||||
build_examples() {
|
||||
local dev="$BUILD_DIR/plugindev${SUFFIX:+_$SUFFIX}"
|
||||
[ "$GOOS" = "windows" ] && dev="${dev}.exe"
|
||||
echo "[BUILD] example plugins ${GOOS:-linux}/${GOARCH:-amd64} → $BUILD_DIR/examples"
|
||||
PLUGINDEV="$dev" VERSION="$VERSION" bash "$PROJECT_ROOT/package/build-examples.sh" "$TARGET" "$BUILD_DIR/examples"
|
||||
echo " OK"
|
||||
}
|
||||
|
||||
case "$COMPONENT" in
|
||||
all|plugindev) build_plugindev ;;
|
||||
all)
|
||||
# 工具链必须先建完：示例用它来构建（同源保证协议一致）。
|
||||
build_plugindev
|
||||
build_examples
|
||||
;;
|
||||
plugindev) build_plugindev ;;
|
||||
examples) build_examples ;;
|
||||
*)
|
||||
echo "Unknown component: $COMPONENT"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
Reference in New Issue
Block a user