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

Open Beginner friendly
#5,636 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
git, node.js, typescript

Research direction

Read scripts/interface-diff.mjs, focusing on resolveBase() at lines 239–245 and the error handling in main() at lines 354–355. Reproduce the missing origin/v2/main case with the provided steps, then check how the explicit --base path reports the Git error. Done when default-base failures expose the underlying cause while retaining useful guidance.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
92k
Forks
12k
Avg merge
3h 46m
Merged PRs (30d)
206

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from modelcontextprotocol/servers

All issues in modelcontextprotocol/servers

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.