feat(extension) - Notify users when there is a new version and update it (#7408)

Co-authored-by: Shi Shu <shii@google.com>
Co-authored-by: Shreya <shreyakeshive@google.com>
This commit is contained in:
shishu314
2025-09-03 21:44:52 -04:00
committed by GitHub
parent 931d9fae4c
commit b49410e1d0
2 changed files with 223 additions and 6 deletions
@@ -50,12 +50,18 @@ vi.mock('vscode', () => ({
fire: vi.fn(),
dispose: vi.fn(),
})),
extensions: {
getExtension: vi.fn(),
},
}));
describe('activate', () => {
let context: vscode.ExtensionContext;
beforeEach(() => {
vi.mocked(vscode.window.showInformationMessage).mockResolvedValue(
undefined,
);
context = {
subscriptions: [],
environmentVariableCollection: {
@@ -68,6 +74,11 @@ describe('activate', () => {
extensionUri: {
fsPath: '/path/to/extension',
},
extension: {
packageJSON: {
version: '1.1.0',
},
},
} as unknown as vscode.ExtensionContext;
});
@@ -80,6 +91,9 @@ describe('activate', () => {
.mocked(vscode.window.showInformationMessage)
.mockResolvedValue(undefined as never);
vi.mocked(context.globalState.get).mockReturnValue(undefined);
vi.mocked(vscode.extensions.getExtension).mockReturnValue({
packageJSON: { version: '1.1.0' },
} as vscode.Extension<unknown>);
await activate(context);
expect(showInformationMessageMock).toHaveBeenCalledWith(
'Gemini CLI Companion extension successfully installed.',
@@ -88,6 +102,9 @@ describe('activate', () => {
it('should not show the info message on subsequent activations', async () => {
vi.mocked(context.globalState.get).mockReturnValue(true);
vi.mocked(vscode.extensions.getExtension).mockReturnValue({
packageJSON: { version: '1.1.0' },
} as vscode.Extension<unknown>);
await activate(context);
expect(vscode.window.showInformationMessage).not.toHaveBeenCalled();
});
@@ -102,13 +119,143 @@ describe('activate', () => {
.mocked(vscode.window.showInformationMessage)
.mockResolvedValue('Re-launch Gemini CLI' as never);
vi.mocked(context.globalState.get).mockReturnValue(undefined);
vi.mocked(vscode.extensions.getExtension).mockReturnValue({
packageJSON: { version: '1.1.0' },
} as vscode.Extension<unknown>);
await activate(context);
expect(showInformationMessageMock).toHaveBeenCalled();
await new Promise(process.nextTick); // Wait for the promise to resolve
const commandCallback = vi
.mocked(vscode.commands.registerCommand)
.mock.calls.find((call) => call[0] === 'gemini-cli.runGeminiCLI')?.[1];
expect(showInformationMessageMock).toHaveBeenCalledWith(
'Gemini CLI Companion extension successfully installed.',
);
});
expect(commandCallback).toBeDefined();
describe('update notification', () => {
beforeEach(() => {
// Prevent the "installed" message from showing
vi.mocked(context.globalState.get).mockReturnValue(true);
});
it('should show an update notification if a newer version is available', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue({
ok: true,
json: async () => ({
results: [
{
extensions: [
{
versions: [{ version: '1.2.0' }],
},
],
},
],
}),
} as Response);
const showInformationMessageMock = vi.mocked(
vscode.window.showInformationMessage,
);
await activate(context);
expect(showInformationMessageMock).toHaveBeenCalledWith(
'A new version (1.2.0) of the Gemini CLI Companion extension is available.',
'Update to latest version',
);
});
it('should not show an update notification if the version is the same', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue({
ok: true,
json: async () => ({
results: [
{
extensions: [
{
versions: [{ version: '1.1.0' }],
},
],
},
],
}),
} as Response);
const showInformationMessageMock = vi.mocked(
vscode.window.showInformationMessage,
);
await activate(context);
expect(showInformationMessageMock).not.toHaveBeenCalled();
});
it('should not show an update notification if the version is older', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue({
ok: true,
json: async () => ({
results: [
{
extensions: [
{
versions: [{ version: '1.0.0' }],
},
],
},
],
}),
} as Response);
const showInformationMessageMock = vi.mocked(
vscode.window.showInformationMessage,
);
await activate(context);
expect(showInformationMessageMock).not.toHaveBeenCalled();
});
it('should execute the install command when the user clicks "Update"', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue({
ok: true,
json: async () => ({
results: [
{
extensions: [
{
versions: [{ version: '1.2.0' }],
},
],
},
],
}),
} as Response);
vi.mocked(vscode.window.showInformationMessage).mockResolvedValue(
'Update to latest version' as never,
);
const executeCommandMock = vi.mocked(vscode.commands.executeCommand);
await activate(context);
// Wait for the promise from showInformationMessage.then() to resolve
await new Promise(process.nextTick);
expect(executeCommandMock).toHaveBeenCalledWith(
'workbench.extensions.installExtension',
'Google.gemini-cli-vscode-ide-companion',
);
});
it('should handle fetch errors gracefully', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue({
ok: false,
statusText: 'Internal Server Error',
} as Response);
const showInformationMessageMock = vi.mocked(
vscode.window.showInformationMessage,
);
await activate(context);
expect(showInformationMessageMock).not.toHaveBeenCalled();
});
});
});