update check + tests (#2772)

This commit is contained in:
Eddie Santos
2025-06-30 20:03:16 -07:00
committed by GitHub
parent e10c208fbe
commit e5b1208bd8
4 changed files with 99 additions and 4 deletions

View File

@@ -0,0 +1,82 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { vi, describe, it, expect, beforeEach } from 'vitest';
import { checkForUpdates } from './updateCheck.js';
const getPackageJson = vi.hoisted(() => vi.fn());
vi.mock('../../utils/package.js', () => ({
getPackageJson,
}));
const updateNotifier = vi.hoisted(() => vi.fn());
vi.mock('update-notifier', () => ({
default: updateNotifier,
}));
describe('checkForUpdates', () => {
beforeEach(() => {
vi.resetAllMocks();
});
it('should return null if package.json is missing', async () => {
getPackageJson.mockResolvedValue(null);
const result = await checkForUpdates();
expect(result).toBeNull();
});
it('should return null if there is no update', async () => {
getPackageJson.mockResolvedValue({
name: 'test-package',
version: '1.0.0',
});
updateNotifier.mockReturnValue({ update: null });
const result = await checkForUpdates();
expect(result).toBeNull();
});
it('should return a message if a newer version is available', async () => {
getPackageJson.mockResolvedValue({
name: 'test-package',
version: '1.0.0',
});
updateNotifier.mockReturnValue({
update: { current: '1.0.0', latest: '1.1.0' },
});
const result = await checkForUpdates();
expect(result).toContain('1.0.0 → 1.1.0');
});
it('should return null if the latest version is the same as the current version', async () => {
getPackageJson.mockResolvedValue({
name: 'test-package',
version: '1.0.0',
});
updateNotifier.mockReturnValue({
update: { current: '1.0.0', latest: '1.0.0' },
});
const result = await checkForUpdates();
expect(result).toBeNull();
});
it('should return null if the latest version is older than the current version', async () => {
getPackageJson.mockResolvedValue({
name: 'test-package',
version: '1.1.0',
});
updateNotifier.mockReturnValue({
update: { current: '1.1.0', latest: '1.0.0' },
});
const result = await checkForUpdates();
expect(result).toBeNull();
});
it('should handle errors gracefully', async () => {
getPackageJson.mockRejectedValue(new Error('test error'));
const result = await checkForUpdates();
expect(result).toBeNull();
});
});

View File

@@ -5,6 +5,7 @@
*/
import updateNotifier from 'update-notifier';
import semver from 'semver';
import { getPackageJson } from '../../utils/package.js';
export async function checkForUpdates(): Promise<string | null> {
@@ -24,7 +25,10 @@ export async function checkForUpdates(): Promise<string | null> {
shouldNotifyInNpmScript: true,
});
if (notifier.update) {
if (
notifier.update &&
semver.gt(notifier.update.latest, notifier.update.current)
) {
return `Gemini CLI update available! ${notifier.update.current}${notifier.update.latest}\nRun npm install -g ${packageJson.name} to update`;
}