redisx

README

redisx

redisx 是基础库标准与交付运行时仓库，承担五类职责：Standard Source、Go Reference Template、Generator、Harness 和 Evidence Runtime。它把基础库的公共 API、配置、错误、健康检查、metrics、测试、release Evidence、Goal Runtime 和下游生成规则放在同一套可验证工件中维护。

旧名 redisx 和示例名 foundationx 只允许出现在迁移文档语境中；新的默认下游集成目标是 kernel，生成库包括 configx、observex、testkitx、postgresx、redisx、kafkax、natsx、taosx、ossx 和 clickhousex。

标准源仓库 URL 为 redisx。本仓库不再把标准源与模板实现拆成两个角色：标准文本、模板、generator、Harness gate 和 Evidence runtime 必须一起通过 release gate 验证。

五类职责

• Standard Source：维护基础库 P0 标准、仓库角色、分层、模块边界、DoD、安全、release 和 Evidence 协议。
• Go Reference Template：提供可编译参考包 pkg/redisx、内部辅助、examples、contracts 和 testkit，用于证明标准可落地。
• Generator：通过 docs/generation.md 与 scripts/render_template.sh 渲染具体基础库 module path、package name、README、docs 和 contracts。
• Harness：通过 Makefile、scripts、CI 和 .agent/harness/harness.yaml 固化 required、extended、docs、boundary、integration、score 和 final gate。
• Evidence Runtime：通过 docs/standard/evidence-protocol.md、docs/release.md、.agent 和 release/manifest/latest.json 记录可追溯完成状态。

非目标

• 不依赖 x.go，也不把 x.go 作为基础库构建前提。
• 不包含 x.go 业务模型、业务 repository、业务消息 schema 或应用 wiring。
• 不隐式读取生产密钥，不把 /home/k8s/secrets/env/* 的内容写入源码、README、测试日志、manifest 或 PR 描述。
• 不创建隐藏全局客户端、不可关闭后台进程或真实基础设施 runtime。
• 不把旧 redisx / foundationx 叙事继续作为主身份。

标准结构

• pkg/redisx：公共包 API 的可编译参考实现；渲染后会移动到 pkg/<package-name>。
• internal/：脱敏、校验和运行时说明等内部辅助代码。
• testkit/：可复用测试夹具和断言。
• examples/：最小使用示例。
• contracts/：JSON schema 和 metrics contract。
• docs/：规格、设计、API、配置、测试、标准、迁移和发布文档。
• scripts/：Harness gate 与 Evidence 脚本。
• .agent/：Full Goal Runtime v3.1 工件、Evidence、评审、发布、回滚和复盘模板。
• release/manifest/：release manifest 模板；latest.json 由 release gate 生成并作为 Evidence artifact 保存。

文档入口

• 基础库标准索引：P0 标准入口，覆盖仓库角色、分层、DoD、Harness、Evidence、release、安全和 generator 契约。
• 基础库总标准：同步 redisx 的公共 API、配置、错误、健康检查、metrics、测试、安全和发布规则。
• 仓库角色：区分 redisx、kernel、生成基础库和 x.go。
• 模块边界：定义标准、模板、generator、Harness、Evidence 与下游库边界。
• 下游矩阵：列出 kernel 与所有目标库的 module path、package、layer、允许依赖和禁止依赖。
• 下游同步策略：定义 redisx 变更如何同步到 kernel、L1/L2 基础库，以及 x.go 的消费方边界。
• x.go 集成边界：说明 x.go 只能作为调用方组合层，基础库不得反向依赖。
• 迁移指南：记录旧名到新身份的迁移规则。
• Harness gate：required、extended、generator、docs、score 和 final gate 命令。
• Evidence 协议：DONE with evidence: 和 release manifest 要求。
• 测试策略：单元、示例 smoke、release quality 和 release manifest fixture 隔离要求。
• 当前状态：Redis L2-T2 能力、integration、persistence、Evidence 和 release-readiness 对齐快照。
• Redis L2 执行方案：Redis adapter 的 L2-T2 profile、真实 Redis integration、persistence recovery 和 release-readiness 证据口径。
• Redis integration 测试：环境变量门禁、Docker-backed Redis、真实 Redis 占位符命令和覆盖清单。
• L2 Evidence 目录：unit、contract、integration、persistence profiles 的 evidence 文件与通过标准。
• 安全与密钥策略：secret scan、每周窗口 govulncheck 和 Agent runtime 目录排除边界。
• 供应链与 Evidence：workflow Action SHA pinning、每周窗口 govulncheck 固定版本、release manifest 和 CI artifact 对齐。
• Release Scorecard：goalcli score --min 9.8 的评分维度、阈值和语义边界。
• 发布：release-check、manifest 字段和 Evidence 规则。
• 独立审计 2026-06-02：独立审计发现、修复状态和剩余验证缺口。
• 项目分析快照 2026-06-02：v0.3.7 发布/分析快照；当前治理主基线仍以 目标文档 v2.9.3 Complete 和 .agent/traceability/traceability-matrix.md 为准。
• 结构性问题清单 2026-06-02：记录架构、治理和交付风险的结构化问题清单。
• 项目结构分析报告 2026-06-05：记录当前评分、结构性问题、已修复的安全门禁频率和后续治理建议。
• .agent 真相状态文件：汇总当前治理、命令实现、release gate、Evidence 可用性和下游采纳状态口径。

命令

本地运行完整 gate 前默认需要安装 golangci-lint；make security 默认只运行 secret scan，不访问漏洞库。只有 XLIB_ENABLE_VULNCHECK=1 且一周窗口到期、状态缺失，或 XLIB_FORCE_VULNCHECK=1 时才执行 govulncheck ./...。状态文件默认 .cache/security/govulncheck-last-run，可用 XLIB_VULNCHECK_INTERVAL_HOURS / XLIB_VULNCHECK_STATE 调整。缺少默认必需工具，或漏洞扫描到期/强制执行时缺少 govulncheck，相关 gate 必须失败，不允许把必需 gate 记录为跳过。

首次 clone 必跑

新协作者 clone 仓库后必须立即执行：

make install-hooks   # 启用 .githooks 本地 P0 防线（RULE-WORKTREE-001 + RULE-SECRET-001）
make doctor-hooks    # 验证 core.hooksPath=.githooks 已生效
make sync-main       # 拉取并 fast-forward 本地 main（RULE-MAIN-SYNC-002）

make install-hooks 把 git config core.hooksPath 指向仓库内的 .githooks/ 目录。未启用 hooks 时，pre-commit 与 pre-push 不会被 Git 调用，本地 P0 防线（禁止在 main commit、secret 提前拦截）形同虚设。 此外，go run ./cmd/goalcli doctor 会在 details 中报告当前 hooks 启用状态，配合 make doctor-hooks 形成自检闭环。make ci 链首位的 doctor-hooks-local 也会在本地环境强制 fail-fast（CI 环境通过 $CI / $GITHUB_ACTIONS 自动跳过）。

标准 gate

make ci
make ci-extended
GOWORK=off make dependency-check
GOWORK=off make standard-impact-check
GOWORK=off make docs-check
GOWORK=off make test-integration
REDISX_PERSISTENCE_INTEGRATION=1 GOWORK=off make test-persistence-integration
GOWORK=off make l2-check
XLIB_CONTEXT=release_verify GOWORK=off make release-check
XLIB_CONTEXT=release_verify GOWORK=off make release-final-check
XLIB_CONTEXT=release_verify GOWORK=off make release-preflight VERSION=v1.0.0
make evidence

make integration 会先执行 downstream template smoke，再进入 Redis L2 integration runner。真实 Redis profile 必须由调用方显式注入 REDISX_INTEGRATION=1 和 REDISX_REDIS_* 环境变量；persistence recovery 使用 REDISX_PERSISTENCE_INTEGRATION=1 触发。Integration 覆盖 string/hash/list/pipeline writes、lock token compare-release 和 fixed-window rate-limit TTL window；persistence profile 覆盖 durable strings、hashes、lists、counters 和 pipeline writes。文档、日志和 Evidence 只允许记录变量名与占位符，不得记录真实 host、password、TLS material 或 secret file 内容。

release-check 和 release-check-extended 已依赖 dependency-check、standard-impact-check 和 docs-check，用于在生成 Evidence 前确认依赖漂移自动化、标准影响报告、标准文档入口、下游同步策略、链接、模板占位符、当前命名、关键文本和 release manifest 协议没有漂移。dependency-check 读取 renovate.json、.github/dependabot.yml 和 go.mod；standard-impact-check 生成 release/standard-impact/latest.md，并把 downstream_sync_required、downstream_release_decision（只允许 required / not_required）和 repository_rules_release_decision（只允许 audit_required / not_required）结论交给 release manifest。docs-check 是结构性 gate，不替代人工语义审查。

Release gate 还必须执行 GOWORK=off go run ./cmd/goalcli score --min 9.8。GitHub Actions workflow 引用的第三方 Action 必须固定为 40 位 commit SHA 并保留来源 tag 注释；CI、Release Check、Auto Patch 和 Docker Contract workflow 默认设置 XLIB_ENABLE_VULNCHECK=0，Security workflow 每周一 03:17 UTC 定时强制执行漏洞扫描；启用或定时扫描时必须使用固定基线 golang.org/x/vuln/cmd/govulncheck@v1.1.4，不得用 @latest 作为发布门禁配置。

生成 kernel 示例：

scripts/render_template.sh \
  --module-name kernel \
  --module-path github.com/ZoneCNH/kernel \
  --package-name kernel \
  --out ../kernel

发布式验证必须使用 GOWORK=off，避免父级或本地 go.work 改写 module 解析并掩盖模板独立性问题：

GOWORK=off make docs-check
XLIB_CONTEXT=release_verify GOWORK=off make release-check

Evidence

完成需要 release manifest 和 CI Evidence。release/manifest/latest.json 是生成产物，不提交到源码历史；对应的 release/manifest/latest.json.sha256 也是生成产物，两者都必须保持在 .gitignore 中。manifest 会记录 module、commit、tree SHA、源码摘要、contract 指纹、dependencies、tools、生成时间、工作区状态、gate 结果、standard_impact、downstream_sync_required、generator_evidence、score、workflow 和这两个 Evidence artifact；其中 standard_impact.downstream_release_decision 只能使用 required 或 not_required，standard_impact.repository_rules_release_decision 只能使用 audit_required 或 not_required。release-check 会生成并校验 checksum，CI 会上传两者作为 artifact。make release-evidence-check 会验证 manifest 与当前仓库事实一致，make release-final-check 会额外要求工作区为 clean。Release manifest 测试必须在临时 fixture 仓库中构造所需 .omc state，不得依赖当前工作区的 Agent 运行态文件。最终完成声明必须包含 DONE with evidence:。

Redis L2 evidence 固定在 .agent/evidence/l2/：integration-report.json 记录 live Redis command coverage，persistence-report.json 记录 restart recovery，release-readiness.json 汇总 unit、contract、integration、persistence 必需 profile。v1.0.0 公共写入面覆盖 strings、hashes、lists、counters 和 pipeline writes；cache-aside JSON codec helpers 建立在 string values 上。Lock token 和 fixed-window rate-limit key 是 TTL-scoped 协调状态，pub/sub 不纳入 durable persistence 承诺。公开 Evidence 只记录 profile 状态、覆盖项和占位符变量名。

Full Goal Runtime v3.1 位于 .agent，其中 goal-runtime、object-model、state-machine、traceability-matrix、harness、evidence-protocol、release-template、retrospective-template、risk-register、decision-log、rollback-protocol 和 patch 文档用于把标准、执行、评审、发布和复盘连接到同一套 Evidence 协议。

v1.0.0 Redis 写入支持

pkg/redisx 的 v1.0.0 release surface 覆盖字符串 KV、multi-key、counter、Hash、List、Pipeline 和 TTL 相关写入。公共辅助包括 KeyBuilder、JSONCodec / Codec[T]、cache-aside Cache[T] 与 NewCacheClient[T]、自动 token 的 NewLock / Lock、显式 token 的 AcquireLock / ReleaseLock，以及 fixed-window FixedWindowRateLimiter。

持久化边界保持在 Redis 后端：非 TTL 的 string、MSet、hash、list、counter 和 pipeline 写入由被测 Redis 的 AOF/RDB 保证 restart recovery；lock token、rate-limit window 与 pub/sub 是 TTL-scoped / transient state，不作为 durable evidence。

Smoke 覆盖

go test ./... 必须覆盖公共包、internal/、contracts/、testkit/ 和 examples/。当前示例 smoke 测试会验证 examples/basic 输出模块名、examples/config 输出脱敏值、examples/health 输出健康状态，防止文档示例和模板行为漂移。

scripts/run_fuzz_smoke.sh 默认执行快速 fuzz smoke，FUZZ_SMOKE_TIME 未设置时每个 fuzz target 使用 10s。需要深度 fuzz 时显式设置更长时间，例如 FUZZ_SMOKE_TIME=2m make fuzz-smoke，并在最终 Evidence/DONE 说明中记录该时间配置。

Docker Toolchain Runtime

Docker Toolchain Runtime 是工具链运行时，不是第二套 gate。它定义 .dockerignore / .git build context 边界、BuildKit/cache/volume、环境变量 pass-through（XLIB_CONTEXT、GOWORK、VERSION、DOWNSTREAM、XLIB_ENABLE_VULNCHECK、REDISX_REDIS_ADDR、REDISX_REDIS_URL、REDISX_REDIS_DB）和下游模板继承规则。

本地 Docker/devcontainer 默认提供 Redis 7.2 服务，并暴露非敏感端点变量：REDISX_REDIS_ADDR=redis:6379、REDISX_REDIS_URL=redis://redis:6379/0、REDISX_REDIS_DB=0；不设置 password、token 或 secret 默认值。

GOWORK=off make docker-toolchain-check
GOWORK=off make docker-ci
XLIB_CONTEXT=release_verify GOWORK=off make docker-release-check

docker-ci 只在容器运行时中调用既有 make ci；docker-release-check 只在容器运行时中调用既有 make release-check。发布、Harness、CI 和 downstream verification 仍必须使用 GOWORK=off。