feat(plan): inject message when user manually exits Plan mode (#20203)

This commit is contained in:
Jerop Kipruto
2026-02-24 14:31:41 -05:00
committed by GitHub
parent 87f7f0beb7
commit 4dd940f8ce
6 changed files with 171 additions and 22 deletions

View File

@@ -39,6 +39,7 @@ import {
coreEvents,
CoreEvent,
MCPDiscoveryState,
getPlanModeExitMessage,
} from '@google/gemini-cli-core';
import type { Part, PartListUnion } from '@google/genai';
import type { UseHistoryManagerReturn } from './useHistoryManager.js';
@@ -2079,6 +2080,34 @@ describe('useGeminiStream', () => {
expect.objectContaining({ correlationId: 'corr-call2' }),
);
});
it('should inject a notification message when manually exiting Plan Mode', async () => {
// Setup mockConfig to return PLAN mode initially
(mockConfig.getApprovalMode as Mock).mockReturnValue(ApprovalMode.PLAN);
// Render the hook, which will initialize the previousApprovalModeRef with PLAN
const { result, client } = renderTestHook([]);
// Update mockConfig to return DEFAULT mode (new mode)
(mockConfig.getApprovalMode as Mock).mockReturnValue(
ApprovalMode.DEFAULT,
);
await act(async () => {
// Trigger manual exit from Plan Mode
await result.current.handleApprovalModeChange(ApprovalMode.DEFAULT);
});
// Verify that addHistory was called with the notification message
expect(client.addHistory).toHaveBeenCalledWith({
role: 'user',
parts: [
{
text: getPlanModeExitMessage(ApprovalMode.DEFAULT, true),
},
],
});
});
});
describe('handleFinishedEvent', () => {

View File

@@ -36,6 +36,7 @@ import {
CoreToolCallStatus,
buildUserSteeringHintPrompt,
generateSteeringAckMessage,
getPlanModeExitMessage,
} from '@google/gemini-cli-core';
import type {
Config,
@@ -203,6 +204,9 @@ export const useGeminiStream = (
const abortControllerRef = useRef<AbortController | null>(null);
const turnCancelledRef = useRef(false);
const activeQueryIdRef = useRef<string | null>(null);
const previousApprovalModeRef = useRef<ApprovalMode>(
config.getApprovalMode(),
);
const [isResponding, setIsResponding] = useState<boolean>(false);
const [thought, thoughtRef, setThought] =
useStateAndRef<ThoughtSummary | null>(null);
@@ -1435,6 +1439,34 @@ export const useGeminiStream = (
const handleApprovalModeChange = useCallback(
async (newApprovalMode: ApprovalMode) => {
if (
previousApprovalModeRef.current === ApprovalMode.PLAN &&
newApprovalMode !== ApprovalMode.PLAN &&
streamingState === StreamingState.Idle
) {
if (geminiClient) {
try {
await geminiClient.addHistory({
role: 'user',
parts: [
{
text: getPlanModeExitMessage(newApprovalMode, true),
},
],
});
} catch (error) {
onDebugMessage(
`Failed to notify model of Plan Mode exit: ${getErrorMessage(error)}`,
);
addItem({
type: MessageType.ERROR,
text: 'Failed to update the model about exiting Plan Mode. The model might be out of sync. Please consider restarting the session if you see unexpected behavior.',
});
}
}
}
previousApprovalModeRef.current = newApprovalMode;
// Auto-approve pending tool calls when switching to auto-approval modes
if (
newApprovalMode === ApprovalMode.YOLO ||
@@ -1473,7 +1505,7 @@ export const useGeminiStream = (
}
}
},
[config, toolCalls],
[config, toolCalls, geminiClient, streamingState, addItem, onDebugMessage],
);
const handleCompletedTools = useCallback(

View File

@@ -78,6 +78,7 @@ export * from './utils/authConsent.js';
export * from './utils/googleQuotaErrors.js';
export * from './utils/fileUtils.js';
export * from './utils/planUtils.js';
export * from './utils/approvalModeUtils.js';
export * from './utils/fileDiffUtils.js';
export * from './utils/retry.js';
export * from './utils/shell-utils.js';

View File

@@ -20,30 +20,12 @@ import type { Config } from '../config/config.js';
import { EXIT_PLAN_MODE_TOOL_NAME } from './tool-names.js';
import { validatePlanPath, validatePlanContent } from '../utils/planUtils.js';
import { ApprovalMode } from '../policy/types.js';
import { checkExhaustive } from '../utils/checks.js';
import { resolveToRealPath, isSubpath } from '../utils/paths.js';
import { logPlanExecution } from '../telemetry/loggers.js';
import { PlanExecutionEvent } from '../telemetry/types.js';
import { getExitPlanModeDefinition } from './definitions/coreTools.js';
import { resolveToolDeclaration } from './definitions/resolver.js';
/**
* Returns a human-readable description for an approval mode.
*/
function getApprovalModeDescription(mode: ApprovalMode): string {
switch (mode) {
case ApprovalMode.AUTO_EDIT:
return 'Auto-Edit mode (edits will be applied automatically)';
case ApprovalMode.DEFAULT:
return 'Default mode (edits will require confirmation)';
case ApprovalMode.YOLO:
case ApprovalMode.PLAN:
// YOLO and PLAN are not valid modes to enter when exiting plan mode
throw new Error(`Unexpected approval mode: ${mode}`);
default:
checkExhaustive(mode);
}
}
import { getPlanModeExitMessage } from '../utils/approvalModeUtils.js';
export interface ExitPlanModeParams {
plan_path: string;
@@ -222,15 +204,20 @@ export class ExitPlanModeInvocation extends BaseToolInvocation<
const payload = this.approvalPayload;
if (payload?.approved) {
const newMode = payload.approvalMode ?? ApprovalMode.DEFAULT;
if (newMode === ApprovalMode.PLAN || newMode === ApprovalMode.YOLO) {
throw new Error(`Unexpected approval mode: ${newMode}`);
}
this.config.setApprovalMode(newMode);
this.config.setApprovedPlanPath(resolvedPlanPath);
logPlanExecution(this.config, new PlanExecutionEvent(newMode));
const description = getApprovalModeDescription(newMode);
const exitMessage = getPlanModeExitMessage(newMode);
return {
llmContent: `Plan approved. Switching to ${description}.
llmContent: `${exitMessage}
The approved implementation plan is stored at: ${resolvedPlanPath}
Read and follow the plan strictly during implementation.`,

View File

@@ -0,0 +1,60 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect } from 'vitest';
import { ApprovalMode } from '../policy/types.js';
import {
getApprovalModeDescription,
getPlanModeExitMessage,
} from './approvalModeUtils.js';
describe('approvalModeUtils', () => {
describe('getApprovalModeDescription', () => {
it('should return correct description for DEFAULT mode', () => {
expect(getApprovalModeDescription(ApprovalMode.DEFAULT)).toBe(
'Default mode (edits will require confirmation)',
);
});
it('should return correct description for AUTO_EDIT mode', () => {
expect(getApprovalModeDescription(ApprovalMode.AUTO_EDIT)).toBe(
'Auto-Edit mode (edits will be applied automatically)',
);
});
it('should return correct description for PLAN mode', () => {
expect(getApprovalModeDescription(ApprovalMode.PLAN)).toBe(
'Plan mode (read-only planning)',
);
});
it('should return correct description for YOLO mode', () => {
expect(getApprovalModeDescription(ApprovalMode.YOLO)).toBe(
'YOLO mode (all tool calls auto-approved)',
);
});
});
describe('getPlanModeExitMessage', () => {
it('should return standard message when not manual', () => {
expect(getPlanModeExitMessage(ApprovalMode.DEFAULT, false)).toBe(
'Plan approved. Switching to Default mode (edits will require confirmation).',
);
});
it('should return manual message when manual is true', () => {
expect(getPlanModeExitMessage(ApprovalMode.AUTO_EDIT, true)).toBe(
'User has manually exited Plan Mode. Switching to Auto-Edit mode (edits will be applied automatically).',
);
});
it('should default to non-manual message', () => {
expect(getPlanModeExitMessage(ApprovalMode.YOLO)).toBe(
'Plan approved. Switching to YOLO mode (all tool calls auto-approved).',
);
});
});
});

View File

@@ -0,0 +1,40 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { ApprovalMode } from '../policy/types.js';
import { checkExhaustive } from './checks.js';
/**
* Returns a human-readable description for an approval mode.
*/
export function getApprovalModeDescription(mode: ApprovalMode): string {
switch (mode) {
case ApprovalMode.AUTO_EDIT:
return 'Auto-Edit mode (edits will be applied automatically)';
case ApprovalMode.DEFAULT:
return 'Default mode (edits will require confirmation)';
case ApprovalMode.PLAN:
return 'Plan mode (read-only planning)';
case ApprovalMode.YOLO:
return 'YOLO mode (all tool calls auto-approved)';
default:
return checkExhaustive(mode);
}
}
/**
* Generates a consistent message for plan mode transitions.
*/
export function getPlanModeExitMessage(
newMode: ApprovalMode,
isManual: boolean = false,
): string {
const description = getApprovalModeDescription(newMode);
const prefix = isManual
? 'User has manually exited Plan Mode.'
: 'Plan approved.';
return `${prefix} Switching to ${description}.`;
}