fix(cli): Make IDE trust listener also listen to IDE status changes a… (#9783)

This commit is contained in:
shrutip90
2025-09-29 13:54:12 -07:00
committed by GitHub
parent 0c3fcb7030
commit d6933c77ba
8 changed files with 440 additions and 32 deletions
@@ -0,0 +1,226 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/** @vitest-environment jsdom */
import { renderHook, act } from '@testing-library/react';
import { vi, describe, it, expect, beforeEach } from 'vitest';
import {
IdeClient,
IDEConnectionStatus,
ideContextStore,
type IDEConnectionState,
} from '@google/gemini-cli-core';
import { useIdeTrustListener } from './useIdeTrustListener.js';
import * as trustedFolders from '../../config/trustedFolders.js';
import { useSettings } from '../contexts/SettingsContext.js';
import type { LoadedSettings } from '../../config/settings.js';
// Mock dependencies
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const original =
await importOriginal<typeof import('@google/gemini-cli-core')>();
const ideClientInstance = {
addTrustChangeListener: vi.fn(),
removeTrustChangeListener: vi.fn(),
addStatusChangeListener: vi.fn(),
removeStatusChangeListener: vi.fn(),
getConnectionStatus: vi.fn(() => ({
status: IDEConnectionStatus.Disconnected,
})),
};
return {
...original,
IdeClient: {
getInstance: vi.fn().mockResolvedValue(ideClientInstance),
},
ideContextStore: {
get: vi.fn(),
subscribe: vi.fn(),
},
};
});
vi.mock('../../config/trustedFolders.js');
vi.mock('../contexts/SettingsContext.js');
describe('useIdeTrustListener', () => {
let mockSettings: LoadedSettings;
let mockIdeClient: Awaited<ReturnType<typeof IdeClient.getInstance>>;
let trustChangeCallback: (isTrusted: boolean) => void;
let statusChangeCallback: (state: IDEConnectionState) => void;
beforeEach(async () => {
vi.clearAllMocks();
mockIdeClient = await IdeClient.getInstance();
mockSettings = {
merged: {
security: {
folderTrust: {
enabled: true,
},
},
},
} as LoadedSettings;
vi.mocked(useSettings).mockReturnValue(mockSettings);
vi.mocked(mockIdeClient.addTrustChangeListener).mockImplementation((cb) => {
trustChangeCallback = cb;
});
vi.mocked(mockIdeClient.addStatusChangeListener).mockImplementation(
(cb) => {
statusChangeCallback = cb;
},
);
});
it('should initialize correctly with no trust information', () => {
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: undefined,
source: undefined,
});
const { result } = renderHook(() => useIdeTrustListener());
expect(result.current.isIdeTrusted).toBe(undefined);
expect(result.current.needsRestart).toBe(false);
expect(result.current.restartReason).toBe('NONE');
});
it('should NOT set needsRestart when connecting for the first time', async () => {
vi.mocked(mockIdeClient.getConnectionStatus).mockReturnValue({
status: IDEConnectionStatus.Disconnected,
});
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: true,
source: 'ide',
});
const { result } = renderHook(() => useIdeTrustListener());
// Manually trigger the initial connection state for the test setup
await act(async () => {
statusChangeCallback({ status: IDEConnectionStatus.Disconnected });
});
expect(result.current.isIdeTrusted).toBe(undefined);
expect(result.current.needsRestart).toBe(false);
await act(async () => {
vi.mocked(ideContextStore.get).mockReturnValue({
workspaceState: { isTrusted: true },
});
statusChangeCallback({ status: IDEConnectionStatus.Connected });
});
expect(result.current.isIdeTrusted).toBe(true);
expect(result.current.needsRestart).toBe(false);
expect(result.current.restartReason).toBe('CONNECTION_CHANGE');
});
it('should set needsRestart when IDE trust changes', async () => {
vi.mocked(mockIdeClient.getConnectionStatus).mockReturnValue({
status: IDEConnectionStatus.Connected,
});
vi.mocked(ideContextStore.get).mockReturnValue({
workspaceState: { isTrusted: true },
});
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: true,
source: 'ide',
});
const { result } = renderHook(() => useIdeTrustListener());
// Manually trigger the initial connection state for the test setup
await act(async () => {
statusChangeCallback({ status: IDEConnectionStatus.Connected });
});
expect(result.current.isIdeTrusted).toBe(true);
expect(result.current.needsRestart).toBe(false);
await act(async () => {
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: false,
source: 'ide',
});
vi.mocked(ideContextStore.get).mockReturnValue({
workspaceState: { isTrusted: false },
});
trustChangeCallback(false);
});
expect(result.current.isIdeTrusted).toBe(false);
expect(result.current.needsRestart).toBe(true);
expect(result.current.restartReason).toBe('TRUST_CHANGE');
});
it('should set needsRestart when IDE disconnects', async () => {
vi.mocked(mockIdeClient.getConnectionStatus).mockReturnValue({
status: IDEConnectionStatus.Connected,
});
vi.mocked(ideContextStore.get).mockReturnValue({
workspaceState: { isTrusted: true },
});
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: true,
source: 'ide',
});
const { result } = renderHook(() => useIdeTrustListener());
// Manually trigger the initial connection state for the test setup
await act(async () => {
statusChangeCallback({ status: IDEConnectionStatus.Connected });
});
expect(result.current.isIdeTrusted).toBe(true);
expect(result.current.needsRestart).toBe(false);
await act(async () => {
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: undefined,
source: undefined,
});
vi.mocked(ideContextStore.get).mockReturnValue(undefined);
statusChangeCallback({ status: IDEConnectionStatus.Disconnected });
});
expect(result.current.isIdeTrusted).toBe(undefined);
expect(result.current.needsRestart).toBe(true);
expect(result.current.restartReason).toBe('CONNECTION_CHANGE');
});
it('should NOT set needsRestart if trust value does not change', async () => {
vi.mocked(mockIdeClient.getConnectionStatus).mockReturnValue({
status: IDEConnectionStatus.Connected,
});
vi.mocked(ideContextStore.get).mockReturnValue({
workspaceState: { isTrusted: true },
});
vi.mocked(trustedFolders.isWorkspaceTrusted).mockReturnValue({
isTrusted: true,
source: 'ide',
});
const { result, rerender } = renderHook(() => useIdeTrustListener());
// Manually trigger the initial connection state for the test setup
await act(async () => {
statusChangeCallback({ status: IDEConnectionStatus.Connected });
});
expect(result.current.isIdeTrusted).toBe(true);
expect(result.current.needsRestart).toBe(false);
rerender();
expect(result.current.isIdeTrusted).toBe(true);
expect(result.current.needsRestart).toBe(false);
});
});
@@ -4,44 +4,87 @@
* SPDX-License-Identifier: Apache-2.0
*/
import { useCallback, useEffect, useState, useSyncExternalStore } from 'react';
import { IdeClient, ideContextStore } from '@google/gemini-cli-core';
import {
useCallback,
useEffect,
useState,
useSyncExternalStore,
useRef,
} from 'react';
import {
IdeClient,
IDEConnectionStatus,
ideContextStore,
type IDEConnectionState,
} from '@google/gemini-cli-core';
import { useSettings } from '../contexts/SettingsContext.js';
import { isWorkspaceTrusted } from '../../config/trustedFolders.js';
export type RestartReason = 'NONE' | 'CONNECTION_CHANGE' | 'TRUST_CHANGE';
/**
* This hook listens for trust status updates from the IDE companion extension.
* It provides the current trust status from the IDE and a flag indicating
* if a restart is needed because the trust state has changed.
* It provides the current trust status from the IDE and a reason if a restart
* is needed because the trust state has changed.
*/
export function useIdeTrustListener() {
const settings = useSettings();
const [connectionStatus, setConnectionStatus] = useState<IDEConnectionStatus>(
IDEConnectionStatus.Disconnected,
);
const previousTrust = useRef<boolean | undefined>(undefined);
const [restartReason, setRestartReason] = useState<RestartReason>('NONE');
const [needsRestart, setNeedsRestart] = useState(false);
const subscribe = useCallback((onStoreChange: () => void) => {
const handleStatusChange = (state: IDEConnectionState) => {
setConnectionStatus(state.status);
setRestartReason('CONNECTION_CHANGE');
// Also notify useSyncExternalStore that the data has changed
onStoreChange();
};
const handleTrustChange = () => {
setRestartReason('TRUST_CHANGE');
onStoreChange();
};
(async () => {
const ideClient = await IdeClient.getInstance();
ideClient.addTrustChangeListener(onStoreChange);
ideClient.addTrustChangeListener(handleTrustChange);
ideClient.addStatusChangeListener(handleStatusChange);
setConnectionStatus(ideClient.getConnectionStatus().status);
})();
return () => {
(async () => {
const ideClient = await IdeClient.getInstance();
ideClient.removeTrustChangeListener(onStoreChange);
ideClient.removeTrustChangeListener(handleTrustChange);
ideClient.removeStatusChangeListener(handleStatusChange);
})();
};
}, []);
const getSnapshot = () => ideContextStore.get()?.workspaceState?.isTrusted;
const getSnapshot = () => {
if (connectionStatus !== IDEConnectionStatus.Connected) {
return undefined;
}
return ideContextStore.get()?.workspaceState?.isTrusted;
};
const isIdeTrusted = useSyncExternalStore(subscribe, getSnapshot);
const [needsRestart, setNeedsRestart] = useState(false);
const [initialTrustValue] = useState(isIdeTrusted);
useEffect(() => {
const currentTrust = isWorkspaceTrusted(settings.merged).isTrusted;
// Trigger a restart if the overall trust status for the CLI has changed,
// but not on the initial trust value.
if (
!needsRestart &&
initialTrustValue !== undefined &&
initialTrustValue !== isIdeTrusted
previousTrust.current !== undefined &&
previousTrust.current !== currentTrust
) {
setNeedsRestart(true);
}
}, [isIdeTrusted, initialTrustValue, needsRestart]);
previousTrust.current = currentTrust;
}, [isIdeTrusted, settings.merged]);
return { isIdeTrusted, needsRestart };
return { isIdeTrusted, needsRestart, restartReason };
}