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

Abierto Apto para principiantes
#5,636 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
git, node.js, typescript

Línea de trabajo

Lee scripts/interface-diff.mjs, centrándote en resolveBase() en las líneas 239–245 y en el manejo de errores de main() en las líneas 354–355. Reproduce el caso en el que falta origin/v2/main con los pasos proporcionados y luego comprueba cómo la ruta explícita de --base informa del error de Git. El trabajo estará terminado cuando los errores con la base predeterminada expongan la causa subyacente y conserven indicaciones útiles.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
92k
Forks
12k
Merge medio
3 h 46 min
PR fusionados (30 d)
206

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de modelcontextprotocol/servers

Todos los issues de modelcontextprotocol/servers

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.