`interface-diff` discards the git error when resolving its default base and reports the wrong cause
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 82/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- git, node.js, typescript
- Lĩnh vực
- cli, developer-experience
Hướng nghiên cứu
Đọc scripts/interface-diff.mjs, tập trung vào resolveBase() ở dòng 239–245 và phần xử lý lỗi trong main() ở dòng 354–355. Dùng các bước được cung cấp để tái hiện trường hợp thiếu origin/v2/main, sau đó kiểm tra cách đường dẫn --base tường minh báo lỗi Git. Hoàn tất khi lỗi với base mặc định nêu rõ nguyên nhân gốc nhưng vẫn giữ lại hướng dẫn hữu ích.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Environment
modelcontextprotocol/serversat commit005e7e6ea55a61300f05bd2e02a02bc0822db0f4- Node.js 24, any OS
- Repository script
scripts/interface-diff.mjs, also run from thelocal:gatenpm stage
Summary
resolveBase() resolves the default comparison branch with a bare try/catch. The catch binds nothing, so it cannot keep the error thrown by git(), and it rethrows a new error holding only a fixed sentence. Every way that git rev-parse --verify origin/v2/main can fail (ref not fetched, not a git repository, dubious ownership, git not installed) collapses into the same message, and for several of those the suggested remedy is wrong. The same git() call reached through --base already reports the real fatal: Needed a single revision error.
Root cause
// scripts/interface-diff.mjs:234-247
const git = (...args) => run("git", args, repoRoot).trim();
function resolveBase(base) {
if (base) return git("rev-parse", "--verify", `${base}^{commit}`);
try {
git("rev-parse", "--verify", DEFAULT_BASE_BRANCH);
} catch {
throw new Error(
`${DEFAULT_BASE_BRANCH} is not available to compare against. Run \`git fetch origin v2/main\`, or name a base with --base <ref>.`,
);
}
return git("merge-base", "HEAD", DEFAULT_BASE_BRANCH);
}
git() delegates to run(), which already builds a diagnostic error:
if (res.error) throw res.error;
if (res.status !== 0)
throw new Error(
`\`${command} ${args.join(" ")}\` exited ${res.status}:\n${tail(res.stdout)}${tail(res.stderr)}`,
);
The catch { at line 241 drops that error entirely.
Affected code
scripts/interface-diff.mjs, resolveBase() lines 239-245. The thrown message is printed by main() at lines 354-355.
Reproduction
main() checks for the built entry before resolving the base, so a build artifact must exist; dist/ is gitignored, so a placeholder is enough for this path.
git clone --single-branch --branch main https://github.com/modelcontextprotocol/servers.git /tmp/servers-no-v2
cd /tmp/servers-no-v2
git checkout 005e7e6ea55a61300f05bd2e02a02bc0822db0f4
mkdir -p src/everything/dist && printf '// placeholder\n' > src/everything/dist/index.js
git rev-parse --verify origin/v2/main; echo "raw git exit=$?"
node scripts/interface-diff.mjs; echo "exit=$?"
Observed with a clone that has no origin/v2/main:
fatal: Needed a single revision
raw git exit=128
origin/v2/main is not available to compare against. Run `git fetch origin v2/main`, or name a base with --base <ref>.
exit=1
Running the same case through the explicit branch shows what is being discarded:
node scripts/interface-diff.mjs --base origin/v2/main
`git rev-parse --verify origin/v2/main^{commit}` exited 128: fatal: Needed a single revision
With git absent from PATH, the default branch prints the byte-identical generic message, although no git fetch can fix that case.
Expected behavior
The default-base failure should preserve the underlying git diagnostic and the suggested remedy should match the failure. For a missing ref, the existing "fetch v2/main" advice is right; for a missing git binary, a non-repository directory, or a dubious-ownership error, the error should say what actually happened.
Actual behavior
All failures of the default git rev-parse --verify origin/v2/main produce one fixed sentence with no git output, exit status, or stderr, and the advice to run git fetch origin v2/main is shown even when fetching cannot help. The explicit --base path reports the real cause, so the information exists but is dropped by the wrapper.
Suggested fix
Bind the caught error and forward it as the cause, keeping the actionable hint:
try {
git("rev-parse", "--verify", DEFAULT_BASE_BRANCH);
} catch (error) {
throw new Error(
`${DEFAULT_BASE_BRANCH} is not available to compare against. Run \`git fetch origin v2/main\`, or name a base with --base <ref>.`,
{ cause: error },
);
}
If the top-level handler prints only err.message, print err.cause?.message when present (or include it in the message). That surfaces fatal: Needed a single revision, not a git repository, or spawn git ENOENT instead of the generic text.
- Ngôn ngữ chính
- TypeScript
- Star
- 92k
- Fork
- 12k
- Merge trung bình
- 3 giờ 46 phút
- Pull request đã merge (30 ngày)
- 206
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của modelcontextprotocol/servers
-
chore server-memory v2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
modelcontextprotocol/servers#5634 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation server-memory v2
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
modelcontextprotocol/servers#5609 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug server-memory v2
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
modelcontextprotocol/servers#5635 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug server-memory v2
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 42/100
modelcontextprotocol/servers#5624 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement v2
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
modelcontextprotocol/servers#5611 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của modelcontextprotocol/servers
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 79/100
hurttlocker/o8#6535 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
Maintainer thường phản hồi trong vòng 1 ngày
-
area: backend bug priority: low
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 92/100
snapotter-hq/SnapOtter#4856 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug follow-up
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
spellshift/realm#2509 ·
Maintainer thường phản hồi trong vòng 1 ngày