Files
gemini-cli/packages/cli/src/ui/utils/updateCheck.ts

108 lines
2.9 KiB
TypeScript
Raw Normal View History

2025-06-17 08:24:07 -07:00
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import type { UpdateInfo } from 'update-notifier';
import updateNotifier from 'update-notifier';
2025-06-30 20:03:16 -07:00
import semver from 'semver';
import { getPackageJson } from '../../utils/package.js';
import type { LoadedSettings } from '../../config/settings.js';
2025-06-17 08:24:07 -07:00
export const FETCH_TIMEOUT_MS = 2000;
export interface UpdateObject {
message: string;
update: UpdateInfo;
}
/**
* From a nightly and stable update, determines which is the "best" one to offer.
* The rule is to always prefer nightly if the base versions are the same.
*/
function getBestAvailableUpdate(
nightly?: UpdateInfo,
stable?: UpdateInfo,
): UpdateInfo | null {
if (!nightly) return stable || null;
if (!stable) return nightly || null;
const nightlyVer = nightly.latest;
const stableVer = stable.latest;
if (
semver.coerce(stableVer)?.version === semver.coerce(nightlyVer)?.version
) {
return nightly;
}
return semver.gt(stableVer, nightlyVer) ? stable : nightly;
}
export async function checkForUpdates(
settings: LoadedSettings,
): Promise<UpdateObject | null> {
try {
if (settings.merged.general?.disableUpdateNag) {
return null;
}
// Skip update check when running from source (development mode)
if (process.env['DEV'] === 'true') {
return null;
}
const packageJson = await getPackageJson();
if (!packageJson || !packageJson.name || !packageJson.version) {
return null;
}
const { name, version: currentVersion } = packageJson;
const isNightly = currentVersion.includes('nightly');
const createNotifier = (distTag: 'latest' | 'nightly') =>
updateNotifier({
pkg: {
name,
version: currentVersion,
},
updateCheckInterval: 0,
shouldNotifyInNpmScript: true,
distTag,
});
if (isNightly) {
const [nightlyUpdateInfo, latestUpdateInfo] = await Promise.all([
createNotifier('nightly').fetchInfo(),
createNotifier('latest').fetchInfo(),
]);
const bestUpdate = getBestAvailableUpdate(
nightlyUpdateInfo,
latestUpdateInfo,
);
if (bestUpdate && semver.gt(bestUpdate.latest, currentVersion)) {
const message = `A new version of Gemini CLI is available! ${currentVersion}${bestUpdate.latest}`;
return {
message,
update: { ...bestUpdate, current: currentVersion },
};
}
} else {
const updateInfo = await createNotifier('latest').fetchInfo();
if (updateInfo && semver.gt(updateInfo.latest, currentVersion)) {
const message = `Gemini CLI update available! ${currentVersion}${updateInfo.latest}`;
return {
message,
update: { ...updateInfo, current: currentVersion },
};
}
}
2025-06-17 08:24:07 -07:00
return null;
} catch (e) {
console.warn('Failed to check for updates: ' + e);
return null;
}
2025-06-17 08:24:07 -07:00
}