fix: Add a message about permissions command on startup in untrusted … (#10755)

This commit is contained in:
shrutip90
2025-10-08 22:17:58 -07:00
committed by GitHub
parent 3d24575239
commit a044c25981
3 changed files with 46 additions and 12 deletions

View File

@@ -796,7 +796,7 @@ Logging in with Google... Please restart Gemini CLI to continue.
const [showIdeRestartPrompt, setShowIdeRestartPrompt] = useState(false);
const { isFolderTrustDialogOpen, handleFolderTrustSelect, isRestarting } =
useFolderTrust(settings, setIsTrustedFolder);
useFolderTrust(settings, setIsTrustedFolder, historyManager.addItem);
const {
needsRestart: ideNeedsRestart,
restartReason: ideTrustRestartReason,

View File

@@ -31,6 +31,7 @@ describe('useFolderTrust', () => {
let loadTrustedFoldersSpy: vi.SpyInstance;
let isWorkspaceTrustedSpy: vi.SpyInstance;
let onTrustChange: (isTrusted: boolean | undefined) => void;
let addItem: vi.Mock;
beforeEach(() => {
mockSettings = {
@@ -54,6 +55,7 @@ describe('useFolderTrust', () => {
isWorkspaceTrustedSpy = vi.spyOn(trustedFolders, 'isWorkspaceTrusted');
mockedCwd.mockReturnValue('/test/path');
onTrustChange = vi.fn();
addItem = vi.fn();
});
afterEach(() => {
@@ -63,7 +65,7 @@ describe('useFolderTrust', () => {
it('should not open dialog when folder is already trusted', () => {
isWorkspaceTrustedSpy.mockReturnValue({ isTrusted: true, source: 'file' });
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
expect(result.current.isFolderTrustDialogOpen).toBe(false);
expect(onTrustChange).toHaveBeenCalledWith(true);
@@ -72,7 +74,7 @@ describe('useFolderTrust', () => {
it('should not open dialog when folder is already untrusted', () => {
isWorkspaceTrustedSpy.mockReturnValue({ isTrusted: false, source: 'file' });
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
expect(result.current.isFolderTrustDialogOpen).toBe(false);
expect(onTrustChange).toHaveBeenCalledWith(false);
@@ -84,19 +86,37 @@ describe('useFolderTrust', () => {
source: undefined,
});
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
expect(result.current.isFolderTrustDialogOpen).toBe(true);
expect(onTrustChange).toHaveBeenCalledWith(undefined);
});
it('should send a message if the folder is untrusted', () => {
isWorkspaceTrustedSpy.mockReturnValue({ isTrusted: false, source: 'file' });
renderHook(() => useFolderTrust(mockSettings, onTrustChange, addItem));
expect(addItem).toHaveBeenCalledWith(
{
text: 'This folder is not trusted. Some features may be disabled. Use the `/permissions` command to change the trust level.',
type: 'info',
},
expect.any(Number),
);
});
it('should not send a message if the folder is trusted', () => {
isWorkspaceTrustedSpy.mockReturnValue({ isTrusted: true, source: 'file' });
renderHook(() => useFolderTrust(mockSettings, onTrustChange, addItem));
expect(addItem).not.toHaveBeenCalled();
});
it('should handle TRUST_FOLDER choice', () => {
isWorkspaceTrustedSpy.mockReturnValue({
isTrusted: undefined,
source: undefined,
});
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
act(() => {
@@ -118,7 +138,7 @@ describe('useFolderTrust', () => {
source: undefined,
});
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
act(() => {
@@ -139,7 +159,7 @@ describe('useFolderTrust', () => {
source: undefined,
});
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
act(() => {
@@ -161,7 +181,7 @@ describe('useFolderTrust', () => {
source: undefined,
});
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
act(() => {
@@ -179,7 +199,7 @@ describe('useFolderTrust', () => {
it('should set isRestarting to true when trust status changes from false to true', () => {
isWorkspaceTrustedSpy.mockReturnValue({ isTrusted: false, source: 'file' }); // Initially untrusted
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
act(() => {
@@ -196,7 +216,7 @@ describe('useFolderTrust', () => {
source: undefined,
});
const { result } = renderHook(() =>
useFolderTrust(mockSettings, onTrustChange),
useFolderTrust(mockSettings, onTrustChange, addItem),
);
act(() => {

View File

@@ -4,7 +4,7 @@
* SPDX-License-Identifier: Apache-2.0
*/
import { useState, useCallback, useEffect } from 'react';
import { useState, useCallback, useEffect, useRef } from 'react';
import type { LoadedSettings } from '../../config/settings.js';
import { FolderTrustChoice } from '../components/FolderTrustDialog.js';
import {
@@ -13,14 +13,17 @@ import {
isWorkspaceTrusted,
} from '../../config/trustedFolders.js';
import * as process from 'node:process';
import { type HistoryItemWithoutId, MessageType } from '../types.js';
export const useFolderTrust = (
settings: LoadedSettings,
onTrustChange: (isTrusted: boolean | undefined) => void,
addItem: (item: HistoryItemWithoutId, timestamp: number) => number,
) => {
const [isTrusted, setIsTrusted] = useState<boolean | undefined>(undefined);
const [isFolderTrustDialogOpen, setIsFolderTrustDialogOpen] = useState(false);
const [isRestarting, setIsRestarting] = useState(false);
const startupMessageSent = useRef(false);
const folderTrust = settings.merged.security?.folderTrust?.enabled;
@@ -29,7 +32,18 @@ export const useFolderTrust = (
setIsTrusted(trusted);
setIsFolderTrustDialogOpen(trusted === undefined);
onTrustChange(trusted);
}, [folderTrust, onTrustChange, settings.merged]);
if (trusted === false && !startupMessageSent.current) {
addItem(
{
type: MessageType.INFO,
text: 'This folder is not trusted. Some features may be disabled. Use the `/permissions` command to change the trust level.',
},
Date.now(),
);
startupMessageSent.current = true;
}
}, [folderTrust, onTrustChange, settings.merged, addItem]);
const handleFolderTrustSelect = useCallback(
(choice: FolderTrustChoice) => {