`interface-diff` discards the git error when resolving its default base and reports the wrong cause

オープン 初心者向け
#5,636 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
git, node.js, typescript

調査の方向性

scripts/interface-diff.mjsを読み、239~245行目のresolveBase()と354~355行目のmain()でのエラー処理に注目してください。提示された手順でorigin/v2/mainが存在しないケースを再現し、続いて明示的な--baseの経路でGitエラーがどのように報告されるか確認してください。デフォルトのベースでの失敗時に、役立つ案内を保ちながら根本原因が示されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Environment

  • modelcontextprotocol/servers at commit 005e7e6ea55a61300f05bd2e02a02bc0822db0f4
  • Node.js 24, any OS
  • Repository script scripts/interface-diff.mjs, also run from the local:gate npm 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.

主要言語
TypeScript
スター
92k
フォーク
12k
平均マージ
3時間 46分
マージ済み PR(30日)
206

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

modelcontextprotocol/servers のほかの issue

modelcontextprotocol/servers の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。