feat(mcp): notice when a newer CodeGraph release exists, without changing anything (#1243) (#1253)

The recommended MCP config launches the local binary, so a server left
running drifts behind releases silently — users discover the version gap
only when something breaks. Per the reporter's preferred option 1, the
server now checks the latest GitHub release in the background on startup
(never blocking; reuses the upgrade command's release-redirect resolution
so the two can't drift) and surfaces a one-line notice on three surfaces:
one stderr line (the MCP host's server log), the initialize instructions
(with do-not-run-it-yourself guidance for the agent), and codegraph_status.

Discipline: results cache in ~/.codegraph/update-check.json shared across
every proxy/daemon on the machine — 24h TTL on success, 1h backoff after
failure, an outage never hides an already-known update, and a stale cache
re-kicks a background refresh so long-lived daemons keep noticing. The
initialize path is a memoized synchronous cache read (the respond-fast
contract holds), and both handshake answerers (session + proxy) share one
helper so they can't diverge. Never stdout.

Hardening: the latest tag arrives from a network redirect via an on-disk
cache and ends up inside agent-visible instructions, so only a canonical
vX.Y.Z rebuilt from PARSED semver fields is ever interpolated — a tag
carrying trailing text (parseSemver is not end-anchored) renders without
it, and a non-version tag renders nothing and counts as a failed attempt.

Off is off: CODEGRAPH_NO_UPDATE_CHECK=1 (dedicated) or DO_NOT_TRACK=1
(broad convention — already set by data-plane deployments) suppresses the
network call and the notice entirely. Documented in TELEMETRY.md.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Colby Mchenry
2026-07-10 17:36:47 -05:00
committed by GitHub
co-authored by Claude Fable 5
parent 8b82fe71f8
commit 47823944a3
8 changed files with 545 additions and 3 deletions
+9
View File
@@ -50,6 +50,7 @@ import {
import { connectWithHello, runLocalHandshakeProxy } from './proxy';
import { getDaemonSocketCandidates } from './daemon-paths';
import { getTelemetry } from '../telemetry';
import { checkForUpdateInBackground } from '../upgrade/update-check';
import { EARLY_PPID } from './early-ppid';
import { supervisionLostReason, parsePpidPollMs, parseHostPpid } from './ppid-watchdog';
import { installMainThreadWatchdog, WatchdogHandle } from './liveness-watchdog';
@@ -228,6 +229,14 @@ export class MCPServer {
// to the handshake path and never keeps the process alive.
getTelemetry().startInterval();
// #1243: the MCP config launches the local binary, so a server left
// running drifts behind releases with no signal. Refresh the shared
// update-check cache in the background and log ONE stderr notice when a
// newer version exists (stderr only — stdout is the protocol channel).
// The notice also reaches the agent via the initialize instructions and
// codegraph_status. Fire-and-forget: adds nothing to the handshake path.
checkForUpdateInBackground();
// The detached daemon process itself. Checked before the opt-out so the
// daemon honors the same env it was spawned with (it never sets NO_DAEMON).
if (daemonInternalSet()) {
+2 -2
View File
@@ -27,7 +27,7 @@ import { supervisionLostReason } from './ppid-watchdog';
import { armStartupHandshakeTimeout } from './startup-handshake';
import { treatStdinFailureAsShutdown } from './stdin-teardown';
import { CodeGraphPackageVersion } from './version';
import { SERVER_INFO, PROTOCOL_VERSION } from './session';
import { SERVER_INFO, PROTOCOL_VERSION, initializeInstructions } from './session';
import { SERVER_INSTRUCTIONS } from './server-instructions';
import { getStaticTools } from './tools';
import { getTelemetry, ClientInfo } from '../telemetry';
@@ -309,7 +309,7 @@ export async function runLocalHandshakeProxy(deps: LocalHandshakeDeps): Promise<
version: typeof initParams.clientInfo.version === 'string' ? initParams.clientInfo.version : undefined,
};
}
writeClient({ jsonrpc: '2.0', id: msg.id, result: { protocolVersion: PROTOCOL_VERSION, capabilities: { tools: {} }, serverInfo: SERVER_INFO, instructions: SERVER_INSTRUCTIONS } });
writeClient({ jsonrpc: '2.0', id: msg.id, result: { protocolVersion: PROTOCOL_VERSION, capabilities: { tools: {} }, serverInfo: SERVER_INFO, instructions: initializeInstructions(SERVER_INSTRUCTIONS) } });
routeToDaemon(line); // prime the daemon so it resolves the project (its reply is suppressed below)
} else if (msg.method === 'tools/list') {
writeClient({ jsonrpc: '2.0', id: msg.id, result: { tools: getStaticTools() } });
+23 -1
View File
@@ -20,6 +20,7 @@ import { SERVER_INSTRUCTIONS, SERVER_INSTRUCTIONS_NO_ROOT_INDEX } from './server
import { CodeGraphPackageVersion } from './version';
import { findNearestCodeGraphRoot } from '../directory';
import { getTelemetry, ClientInfo } from '../telemetry';
import { getUpdateNotice } from '../upgrade/update-check';
/**
* MCP Server Info — kept on the session because some clients log it. The
@@ -32,6 +33,27 @@ export const SERVER_INFO = {
version: CodeGraphPackageVersion,
};
/**
* Instructions for the `initialize` response, with the update-availability
* notice appended when one is known (#1243). Exported so the proxy's local
* handshake sends the IDENTICAL payload — same convention as SERVER_INFO.
* `getUpdateNotice` is a memoized synchronous cache read, so the #172
* respond-fast contract holds; when no notice exists the instructions are
* byte-identical to the bare constants.
*
* Test-authoring note: on a machine whose real `~/.codegraph` cache knows a
* newer release, spawned servers append the notice — a test asserting exact
* instructions equality must set `CODEGRAPH_NO_UPDATE_CHECK=1` in the spawn
* env or it will fail only in the weeks after a release ships.
*/
export function initializeInstructions(base: string, notice: string | null = getUpdateNotice()): string {
if (!notice) return base;
return (
`${base}\n\n---\n${notice} This server keeps running the old version until ` +
`the user upgrades — mention it when convenient; do not run the upgrade yourself.`
);
}
/** MCP Protocol Version (latest the server claims). */
export const PROTOCOL_VERSION = '2024-11-05';
@@ -207,7 +229,7 @@ export class MCPSession {
protocolVersion: PROTOCOL_VERSION,
capabilities: { tools: {} },
serverInfo: SERVER_INFO,
instructions: indexed ? SERVER_INSTRUCTIONS : SERVER_INSTRUCTIONS_NO_ROOT_INDEX,
instructions: initializeInstructions(indexed ? SERVER_INSTRUCTIONS : SERVER_INSTRUCTIONS_NO_ROOT_INDEX),
});
if (explicitPath) {
+9
View File
@@ -30,6 +30,7 @@ import {
import { clamp, validatePathWithinRoot, validateProjectPath, isConfigLeafNode, CONFIG_LEAF_LANGUAGES } from '../utils';
import { isGeneratedFile } from '../extraction/generated-detection';
import { scanDynamicDispatch } from './dynamic-boundaries';
import { getUpdateNotice } from '../upgrade/update-check';
/**
* An expected, recoverable "codegraph can't serve this" condition — most
@@ -4081,6 +4082,14 @@ export class ToolHandler {
);
}
// A newer release exists (#1243) — status is where users and agents look
// when something seems off, so surface the drift here too. Cheap memoized
// cache read; absent entirely when up to date or opted out.
const updateNotice = getUpdateNotice();
if (updateNotice) {
lines.push(`**Update available:** ${updateNotice}`);
}
// Non-zero at rest means a resolution pass was interrupted mid-run, so
// some files' call/impact edges are missing until the next sync sweeps
// the leftovers (#1187). Surface it — an agent trusting an incomplete
+250
View File
@@ -0,0 +1,250 @@
/**
* Background update-availability check for long-lived servers (#1243).
*
* The recommended MCP config launches the LOCAL `codegraph` binary, so the
* server (and the prompt hook alongside it) silently stays on whatever version
* was last manually upgraded — users discover the drift only when something
* breaks. This module gives the running server *visibility* without changing
* behavior: a non-blocking check against the latest GitHub release, surfaced
* as a one-line notice (stderr log, MCP initialize instructions, and
* `codegraph_status`) telling the user to run `codegraph upgrade`.
*
* Invariants (mirrors the telemetry module's contract):
* - Never stdout — stdio is the MCP protocol channel.
* - Never blocking: the network refresh is fire-and-forget; every reader
* (`getUpdateNotice`) is a cheap synchronous cache read, so the #172
* respond-fast handshake contract holds.
* - Fail silent: offline / rate-limited / disk-full all degrade to "no
* notice", never an error, never a retry loop.
* - Off is off: `CODEGRAPH_NO_UPDATE_CHECK` (dedicated) or `DO_NOT_TRACK`
* (broad don't-phone-home convention — set by e.g. the Pro container's
* data plane) suppresses the network call AND the notice entirely.
*
* The check itself reuses `resolveLatestVersion` — the GitHub release-redirect
* trick with the API fallback — so version resolution can't drift from what
* `codegraph upgrade` installs. Results are cached in `~/.codegraph/` (the
* same global state dir telemetry and the daemon registry use) with a 24h TTL
* on success and a 1h backoff after failure, shared across every proxy /
* daemon process on the machine.
*/
import * as fs from 'fs';
import * as path from 'path';
import * as os from 'os';
import { resolveLatestVersion, isUpdateAvailable, parseSemver } from './index';
import { CodeGraphPackageVersion } from '../mcp/version';
/** Re-check the release feed after this long (successful checks). */
export const UPDATE_CHECK_TTL_MS = 24 * 60 * 60 * 1000;
/** Back off this long after a failed check (offline, rate-limited). */
export const UPDATE_CHECK_FAILURE_BACKOFF_MS = 60 * 60 * 1000;
/** Short network budget — the refresh is background work, not a handshake. */
const UPDATE_CHECK_NETWORK_TIMEOUT_MS = 5000;
export interface UpdateCheckCacheFile {
/** Last time a network check was attempted (ms epoch). */
lastAttemptAt: number;
/** Last time a network check succeeded (ms epoch). */
lastSuccessAt?: number;
/** Latest release tag from the last successful check (e.g. `v1.4.1`). */
latest?: string;
}
export interface UpdateCheckDeps {
/** Global state dir; defaults to ~/.codegraph. Tests inject a temp dir. */
dir?: string;
env?: NodeJS.ProcessEnv;
now?: () => number;
resolveLatest?: () => Promise<string>;
currentVersion?: string;
}
interface ResolvedDeps {
dir: string;
env: NodeJS.ProcessEnv;
now: () => number;
resolveLatest: () => Promise<string>;
currentVersion: string;
}
function resolveDeps(deps: UpdateCheckDeps = {}): ResolvedDeps {
return {
dir: deps.dir ?? path.join(os.homedir(), '.codegraph'),
env: deps.env ?? process.env,
now: deps.now ?? Date.now,
resolveLatest:
deps.resolveLatest ?? (() => resolveLatestVersion(undefined, UPDATE_CHECK_NETWORK_TIMEOUT_MS)),
currentVersion: deps.currentVersion ?? CodeGraphPackageVersion,
};
}
function envTruthy(raw: string | undefined): boolean {
return raw !== undefined && raw !== '' && raw !== '0' && raw.toLowerCase() !== 'false';
}
/**
* True when the update check must not run at all — no network call, no
* notice. `DO_NOT_TRACK` uses the same truthiness the telemetry opt-out does.
*/
export function updateCheckDisabled(env: NodeJS.ProcessEnv = process.env): boolean {
return envTruthy(env.CODEGRAPH_NO_UPDATE_CHECK) || envTruthy(env.DO_NOT_TRACK);
}
export function updateCheckCachePath(dir: string): string {
return path.join(dir, 'update-check.json');
}
export function readUpdateCheckCache(dir: string): UpdateCheckCacheFile | null {
try {
const raw = fs.readFileSync(updateCheckCachePath(dir), 'utf8');
const parsed = JSON.parse(raw) as UpdateCheckCacheFile;
if (typeof parsed?.lastAttemptAt !== 'number') return null;
return parsed;
} catch {
return null; // missing / torn / unparseable — same as no cache
}
}
function writeUpdateCheckCache(dir: string, cache: UpdateCheckCacheFile): void {
try {
fs.mkdirSync(dir, { recursive: true });
fs.writeFileSync(updateCheckCachePath(dir), JSON.stringify(cache));
} catch {
/* fail silent — a read-only home dir must not break the server */
}
}
/**
* Rebuild a canonical `vX.Y.Z[-pre]` tag from the PARSED semver fields, or
* null when the input isn't version-shaped. The notice ends up inside the MCP
* initialize instructions — agent-visible, system-prompt-adjacent text — and
* the `latest` value arrives from a network redirect via an on-disk cache, so
* only a reconstructed canonical string may ever be interpolated, never the
* raw value. (`parseSemver`'s regex is not end-anchored: a value like
* `1.2.3-x <arbitrary text>` parses "valid" while the raw string would carry
* the trailing text straight into every session's instructions.)
*/
export function canonicalVersionTag(v: string): string | null {
const s = parseSemver(v);
if (!s) return null;
return `v${s.major}.${s.minor}.${s.patch}${s.pre ? `-${s.pre}` : ''}`;
}
/** One user-facing sentence; every surface (stderr, instructions, status) shows this. */
export function formatUpdateNotice(current: string, latest: string): string {
return (
`CodeGraph ${latest} is available (this server is running ` +
`${current}). Update with \`codegraph upgrade\`.`
);
}
function noticeFrom(cache: UpdateCheckCacheFile | null, d: ResolvedDeps): string | null {
if (!cache?.latest) return null;
// A dev build whose package.json couldn't be read reports the sentinel
// version; any comparison against it would always claim an update.
if (d.currentVersion === '0.0.0-unknown') return null;
// Canonicalize BOTH sides before comparing or rendering — a non-semver
// `latest` (garbage redirect, tampered cache) yields no notice at all
// rather than flowing into agent-visible text.
const latest = canonicalVersionTag(cache.latest);
const current = canonicalVersionTag(d.currentVersion);
if (!latest || !current) return null;
return isUpdateAvailable(current, latest) ? formatUpdateNotice(current, latest) : null;
}
function cacheIsFresh(cache: UpdateCheckCacheFile | null, nowMs: number): boolean {
if (!cache) return false;
if (cache.lastSuccessAt !== undefined && nowMs - cache.lastSuccessAt < UPDATE_CHECK_TTL_MS) {
return true;
}
// No recent success: only the failure backoff holds the network call off.
return nowMs - cache.lastAttemptAt < UPDATE_CHECK_FAILURE_BACKOFF_MS;
}
/**
* Ensure the on-disk cache is fresh (hitting the network only past the TTL /
* backoff) and return the current notice, or null. Never throws.
*/
export async function refreshUpdateCheck(deps: UpdateCheckDeps = {}): Promise<string | null> {
const d = resolveDeps(deps);
if (updateCheckDisabled(d.env)) return null;
const cached = readUpdateCheckCache(d.dir);
const nowMs = d.now();
if (cacheIsFresh(cached, nowMs)) return noticeFrom(cached, d);
try {
const latest = canonicalVersionTag(await d.resolveLatest());
// A response that isn't version-shaped is a failure, not a result —
// fall through to the backoff path and keep the previous known-good tag.
if (!latest) throw new Error('release feed returned a non-version tag');
const next: UpdateCheckCacheFile = { lastAttemptAt: nowMs, lastSuccessAt: nowMs, latest };
writeUpdateCheckCache(d.dir, next);
return noticeFrom(next, d);
} catch {
// Record the attempt (starts the backoff) but KEEP the previous latest —
// a transient outage must not hide an already-known update.
const next: UpdateCheckCacheFile = {
lastAttemptAt: nowMs,
lastSuccessAt: cached?.lastSuccessAt,
latest: cached?.latest,
};
writeUpdateCheckCache(d.dir, next);
return noticeFrom(next, d);
}
}
// Per-process memo so the sync read path (MCP initialize, codegraph_status)
// touches the disk at most once a minute, not once per handshake.
const NOTICE_MEMO_TTL_MS = 60 * 1000;
let noticeMemo: { at: number; value: string | null } | null = null;
/**
* The current update notice from the on-disk cache — synchronous and cheap
* (memoized disk read), safe on the initialize respond-fast path. When the
* cache has gone stale (e.g. a daemon that has been up for weeks), kicks a
* background refresh so the NEXT reader sees a current answer; this call
* still returns immediately from the stale cache.
*/
export function getUpdateNotice(deps: UpdateCheckDeps = {}): string | null {
const d = resolveDeps(deps);
if (updateCheckDisabled(d.env)) return null;
const useMemo = deps.dir === undefined && deps.now === undefined;
const nowMs = d.now();
if (useMemo && noticeMemo && nowMs - noticeMemo.at < NOTICE_MEMO_TTL_MS) {
return noticeMemo.value;
}
const cached = readUpdateCheckCache(d.dir);
if (!cacheIsFresh(cached, nowMs)) {
void refreshUpdateCheck(deps).catch(() => { /* fail silent */ });
}
const value = noticeFrom(cached, d);
if (useMemo) noticeMemo = { at: nowMs, value };
return value;
}
/** Test hook: clear the per-process memo. */
export function resetUpdateNoticeMemo(): void {
noticeMemo = null;
}
/**
* Fire-and-forget entry point for server startup: refresh the cache in the
* background and, if an update is available, emit ONE stderr line (stderr is
* the MCP-safe channel; hosts surface it in their server logs). Never throws,
* never blocks, never writes stdout.
*/
export function checkForUpdateInBackground(
deps: UpdateCheckDeps = {},
log: (line: string) => void = (line) => process.stderr.write(line),
): void {
refreshUpdateCheck(deps)
.then((notice) => {
// The shared notice sentence starts with "CodeGraph …"; drop the word
// after the log tag so the line doesn't read "[CodeGraph] CodeGraph …".
if (notice) log(`[CodeGraph] ${notice.replace(/^CodeGraph /, '')}\n`);
})
.catch(() => { /* fail silent */ });
}