AlexStocks commented on code in PR #3575: URL: https://github.com/apache/dubbo-go/pull/3575#discussion_r4505078915
########## CODE_REVIEW_GUIDE.md: ########## @@ -0,0 +1,267 @@ +# dubbo-go 代码审查指南(Code Review Standard & Process) + +> 适用对象:`dubbo.apache.org/dubbo-go/v3`(本仓库) +> 维护者:Committer / Maintainer 团队 +> 版本:v1.0 · 2026-07-30 +> 配套文档: [`CONTRIBUTING.md`](./CONTRIBUTING.md) · [`security-review-2026-07-30.md`](./security-review-2026-07-30.md) + +--- + +## 0. 为什么需要这份指南 + +dubbo-go 是一个**面向网络的 Go RPC 框架**,被上游业务作为基础库消费。它的代码质量直接影响成百上千个微服务的稳定性、安全性和可维护性。与业务代码不同,这里有两个特殊性: + +1. **并发是默认状态**:连接池(getty)、注册中心监听、配置中心订阅、每请求 goroutine,几乎每一行都在并发环境里跑。 +2. **信任边界复杂**:配置中心(ZK/Nacos/Apollo/File)、反序列化(Hessian2)、脚本路由(goja JS)、metrics/probe 端点、TLS 都是典型的攻击面。 + +我们在 [`security-review-2026-07-30.md`](./security-review-2026-07-30.md) 中已经发现若干真实风险(脚本路由无执行超时、metrics 端点默认无认证、TLS 未设 `MinVersion`、`exec` 拼 `$USER`、File 配置中心路径可穿越)。**自动化工具(golangci / CodeQL)无法替代人对这些语义风险的判断**,因此必须建立一套可执行的人工审查标准。 + +本指南目标:让任何一次 PR 的审查结果**可预期、可对齐、可复盘**,而不是依赖 reviewer 的个人经验。 + +--- + +## 1. 角色与职责 + +| 角色 | 职责 | +|------|------| +| **Author(作者)** | 保证 PR 自测通过、描述清晰、关联 issue、不夹带无关改动;对 reviewer 的疑问及时响应。 | +| **Reviewer(审查者)** | 至少 1 名,对改动的正确性、安全性、可维护性负责;按本指南清单逐项确认;给出明确的 `Approve` / `Request changes`。 | +| **Maintainer / Approver** | 拥有合并权限的 Committer;负责最终把关**兼容性破坏**、跨模块影响、与发行版本(release 分支)的一致性;可要求额外批准。 | +| **CI(自动门禁)** | 跑 fmt / test / lint / CodeQL / codecov,作为**合并的最低门槛**,不等于人工审查。 | + +> ⚠️ 当前仓库**没有 `CODEOWNERS` 文件**。强烈建议建立(见 §6.3),否则 reviewer 分配完全靠手动,容易出现「无人审」或「不懂的人审」。 Review Comment: 💭 这段与同一个 PR 的内容自相矛盾,也与 §6.2 的表格矛盾: - 这里写「⚠️ 当前仓库**没有** `CODEOWNERS` 文件。强烈建议建立」; - 本 PR 同时在仓库根新增了 `CODEOWNERS`; - 第 211 行 §6.2 又写 `CODEOWNERS | ✅ 已建立`。 合并后读者会看到「没有」与「已建立」并存。建议改成「本指南配套引入了 `CODEOWNERS`(见 §6.3),owner handle 需按实际团队替换」。 ########## CODEOWNERS: ########## @@ -0,0 +1,42 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# dubbo-go CODEOWNERS +# --------------------------------------------------------------------------- +# 作用:PR 触碰对应路径时自动请求以下 owner 审查(见 CODE_REVIEW_GUIDE.md §6.3)。 +# 注意:下方 @dubbo-go/xxx 为「团队/个人 handle 占位符」,请替换为真实的 +# GitHub team 名或 Committer 个人账号,否则 GitHub 不会路由审查。 +# 语法:<path> @owner1 @owner2 +# --------------------------------------------------------------------------- + +# 核心模块 +/cluster/ @dubbo-go/cluster-maintainers Review Comment: 🟡 **这些 owner 全部是占位符,合并后 GitHub 不会路由任何审查,反而会在每个 PR 上出现 "Unknown owner" 警告。** `@dubbo-go/cluster-maintainers` 这类 team 在 `apache` 组织下并不存在(`apache/dubbo-go` 没有按模块拆分的 team)。CODEOWNERS 一旦包含无法解析的 owner,GitHub 会把整条规则判为无效——也就是说这份文件**当前的实际效果是零**,而正文里写「✅ 已建立」会让人误以为路由已经生效。 两条路径,选一: 1. 先把真实 team 建好(或换成 Committer 个人 handle,例如 `@AlexStocks @Alanxtl`),再合并本文件; 2. 如果团队结构还没定,本 PR 只提交 `CODE_REVIEW_GUIDE.md`,CODEOWNERS 拆成后续 PR —— 半成品比没有更容易误导。 同理 `* @dubbo-go/committers` 也需要一个真实存在的 team。 ########## cluster/router/script/instance/js_instance.go: ########## @@ -38,6 +39,12 @@ const ( jsScriptPrefix = "\n" + jsScriptResultName + ` = ` ) +// defaultScriptTimeout bounds the execution of a user-provided routing script. +// Without it a runaway/looping script (e.g. `while (true) {}`) would block the +// routing goroutine indefinitely, causing a denial of service. +// See CODE_REVIEW_GUIDE.md §4.2.2. +const defaultScriptTimeout = 500 * time.Millisecond Review Comment: 💭 500ms 是硬编码常量,对「脚本里遍历几千个 invoker 做匹配」的合法场景可能偏紧,而超时的后果是**整次路由失败**(`Run` 返回 `invokers, err`,由上层兜底放行),线上表现是「路由规则偶发不生效」,很难排查。 两个建议(都不阻塞): 1. 允许通过 URL 参数覆盖默认值(例如 `script.timeout`,缺省 500ms),并在 README 里写明超时后的行为是 fail-open 到全部 provider; 2. 超时时把 `InterruptedError` 与真实语法/运行错误在日志上区分开(现在都会落到同一条 error 路径),否则排障时无法判断是脚本写错还是被限时打断。 另外补一句边界说明会更完整:`Interrupt` 只能打断**正在执行的 JS**;如果脚本长时间停在 Go 回调(`invocation` 上的方法)里,超时不会生效。这条 limitation 值得写进包注释。 ########## CODE_REVIEW_GUIDE.md: ########## @@ -0,0 +1,267 @@ +# dubbo-go 代码审查指南(Code Review Standard & Process) + +> 适用对象:`dubbo.apache.org/dubbo-go/v3`(本仓库) +> 维护者:Committer / Maintainer 团队 +> 版本:v1.0 · 2026-07-30 +> 配套文档: [`CONTRIBUTING.md`](./CONTRIBUTING.md) · [`security-review-2026-07-30.md`](./security-review-2026-07-30.md) + +--- + +## 0. 为什么需要这份指南 + +dubbo-go 是一个**面向网络的 Go RPC 框架**,被上游业务作为基础库消费。它的代码质量直接影响成百上千个微服务的稳定性、安全性和可维护性。与业务代码不同,这里有两个特殊性: + +1. **并发是默认状态**:连接池(getty)、注册中心监听、配置中心订阅、每请求 goroutine,几乎每一行都在并发环境里跑。 +2. **信任边界复杂**:配置中心(ZK/Nacos/Apollo/File)、反序列化(Hessian2)、脚本路由(goja JS)、metrics/probe 端点、TLS 都是典型的攻击面。 + +我们在 [`security-review-2026-07-30.md`](./security-review-2026-07-30.md) 中已经发现若干真实风险(脚本路由无执行超时、metrics 端点默认无认证、TLS 未设 `MinVersion`、`exec` 拼 `$USER`、File 配置中心路径可穿越)。**自动化工具(golangci / CodeQL)无法替代人对这些语义风险的判断**,因此必须建立一套可执行的人工审查标准。 + +本指南目标:让任何一次 PR 的审查结果**可预期、可对齐、可复盘**,而不是依赖 reviewer 的个人经验。 + +--- + +## 1. 角色与职责 + +| 角色 | 职责 | +|------|------| +| **Author(作者)** | 保证 PR 自测通过、描述清晰、关联 issue、不夹带无关改动;对 reviewer 的疑问及时响应。 | +| **Reviewer(审查者)** | 至少 1 名,对改动的正确性、安全性、可维护性负责;按本指南清单逐项确认;给出明确的 `Approve` / `Request changes`。 | +| **Maintainer / Approver** | 拥有合并权限的 Committer;负责最终把关**兼容性破坏**、跨模块影响、与发行版本(release 分支)的一致性;可要求额外批准。 | +| **CI(自动门禁)** | 跑 fmt / test / lint / CodeQL / codecov,作为**合并的最低门槛**,不等于人工审查。 | + +> ⚠️ 当前仓库**没有 `CODEOWNERS` 文件**。强烈建议建立(见 §6.3),否则 reviewer 分配完全靠手动,容易出现「无人审」或「不懂的人审」。 + +--- + +## 2. 审查流程 + +``` +┌────────────┐ ┌──────────────────┐ ┌──────────────┐ ┌──────────────┐ ┌──────────┐ +│ 1.作者自检 │ → │ 2.提交 PR(门禁) │ → │ 3.自动 CI │ → │ 4.人工审查 │ → │ 5.合并 │ +└────────────┘ └──────────────────┘ └──────────────┘ └──────────────┘ └──────────┘ + 本地 pre-push 标题/描述/issue/签名 fmt+test+lint ≥1 Approve + squash/merge + 跑全量清单 见 CONTRIBUTING +CodeQL+codecov 无未解决 Blocker 回退策略 +``` + +### 2.1 作者自检(提交前) +- 本地执行(不要等 CI 报错): + ```bash + make check-fmt && make test && make lint + make test-race # 与上游现有 race 门禁保持一致 + ``` +- 对照 §4 清单做一遍自我审查,尤其是并发安全与安全性维度。 +- 一个 PR **只解决一件事**(一个 issue);重构与功能修复分开提。 + +### 2.2 提交 PR +遵循现有 [`CONTRIBUTING.md`](./CONTRIBUTING.md): +- 标题:`<type>: 一句话摘要`,backport 加 `[3.0]` 前缀。 +- 描述必须关联 issue:`Fixes: #xxxx`。 +- 提交需 `Signed-off-by`(提交时 `git commit -s`)。 +- PR 描述用本指南 §7 的模板,明确:改动动机、影响面、测试方式、兼容性说明。 Review Comment: 🟡 **`./security-review-2026-07-30.md` 在本仓库不存在,两个链接都会 404。** 我核过 `gh api repos/apache/dubbo-go/contents/security-review-2026-07-30.md` → `Not Found`,且它也不在本 PR 的文件列表里。第 60 行(配套文档)与第 71 行(「我们在……中已经发现若干真实风险」)都会指向死链。 而且这段还把这批结论当作已发布文档引用(脚本路由无超时 / metrics 无认证 / TLS 未设 MinVersion / `exec` 拼 `$USER` / File 配置中心路径穿越)。建议二选一: 1. 把该安全评估一并放进本 PR(或先在独立 PR 合入); 2. 删掉对它的链接,把结论直接内联进 §4.2,并改用 issue 编号做追溯。 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
