mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-04-01 00:40:42 -07:00
feat: implement file system reversion utilities for rewind (#15715)
This commit is contained in:
Adib234
473
packages/cli/src/ui/utils/rewindFileOps.test.ts
Normal file
473
packages/cli/src/ui/utils/rewindFileOps.test.ts
Normal file
@@ -0,0 +1,473 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||
import {
|
||||
calculateTurnStats,
|
||||
calculateRewindImpact,
|
||||
revertFileChanges,
|
||||
} from './rewindFileOps.js';
|
||||
import type {
|
||||
ConversationRecord,
|
||||
MessageRecord,
|
||||
ToolCallRecord,
|
||||
} from '@google/gemini-cli-core';
|
||||
import { coreEvents } from '@google/gemini-cli-core';
|
||||
import fs from 'node:fs/promises';
|
||||
import path from 'node:path';
|
||||
|
||||
vi.mock('node:fs/promises');
|
||||
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
|
||||
const actual =
|
||||
await importOriginal<typeof import('@google/gemini-cli-core')>();
|
||||
return {
|
||||
...actual,
|
||||
coreEvents: {
|
||||
emitFeedback: vi.fn(),
|
||||
},
|
||||
};
|
||||
});
|
||||
|
||||
describe('rewindFileOps', () => {
|
||||
const mockConversation: ConversationRecord = {
|
||||
sessionId: 'test-session',
|
||||
projectHash: 'hash',
|
||||
startTime: 'time',
|
||||
lastUpdated: 'time',
|
||||
messages: [],
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('calculateTurnStats', () => {
|
||||
it('returns null if no edits found after user message', () => {
|
||||
const userMsg: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'hello',
|
||||
id: '1',
|
||||
timestamp: '1',
|
||||
};
|
||||
const geminiMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
content: 'hi',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
};
|
||||
mockConversation.messages = [userMsg, geminiMsg];
|
||||
|
||||
const stats = calculateTurnStats(mockConversation, userMsg);
|
||||
expect(stats).toBeNull();
|
||||
});
|
||||
|
||||
it('calculates stats for single turn correctly', () => {
|
||||
const userMsg: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'hello',
|
||||
id: '1',
|
||||
timestamp: '1',
|
||||
};
|
||||
const toolMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-1',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file1.ts',
|
||||
filePath: '/file1.ts',
|
||||
originalContent: 'old',
|
||||
newContent: 'new',
|
||||
isNewFile: false,
|
||||
diffStat: {
|
||||
model_added_lines: 5,
|
||||
model_removed_lines: 2,
|
||||
user_added_lines: 0,
|
||||
user_removed_lines: 0,
|
||||
model_added_chars: 100,
|
||||
model_removed_chars: 20,
|
||||
user_added_chars: 0,
|
||||
user_removed_chars: 0,
|
||||
},
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
const userMsg2: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'next',
|
||||
id: '3',
|
||||
timestamp: '3',
|
||||
};
|
||||
|
||||
mockConversation.messages = [userMsg, toolMsg, userMsg2];
|
||||
|
||||
const stats = calculateTurnStats(mockConversation, userMsg);
|
||||
expect(stats).toEqual({
|
||||
addedLines: 5,
|
||||
removedLines: 2,
|
||||
fileCount: 1,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('calculateRewindImpact', () => {
|
||||
it('calculates cumulative stats across multiple turns', () => {
|
||||
const userMsg1: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'start',
|
||||
id: '1',
|
||||
timestamp: '1',
|
||||
};
|
||||
const toolMsg1: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-1',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file1.ts',
|
||||
filePath: '/file1.ts',
|
||||
fileDiff: 'diff1',
|
||||
originalContent: 'old',
|
||||
newContent: 'new',
|
||||
isNewFile: false,
|
||||
diffStat: {
|
||||
model_added_lines: 5,
|
||||
model_removed_lines: 2,
|
||||
user_added_lines: 0,
|
||||
user_removed_lines: 0,
|
||||
model_added_chars: 0,
|
||||
model_removed_chars: 0,
|
||||
user_added_chars: 0,
|
||||
user_removed_chars: 0,
|
||||
},
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
const userMsg2: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'next',
|
||||
id: '3',
|
||||
timestamp: '3',
|
||||
};
|
||||
|
||||
const toolMsg2: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '4',
|
||||
timestamp: '4',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-2',
|
||||
status: 'success',
|
||||
timestamp: '4',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file2.ts',
|
||||
filePath: '/file2.ts',
|
||||
fileDiff: 'diff2',
|
||||
originalContent: 'old',
|
||||
newContent: 'new',
|
||||
isNewFile: false,
|
||||
diffStat: {
|
||||
model_added_lines: 3,
|
||||
model_removed_lines: 1,
|
||||
user_added_lines: 0,
|
||||
user_removed_lines: 0,
|
||||
model_added_chars: 0,
|
||||
model_removed_chars: 0,
|
||||
user_added_chars: 0,
|
||||
user_removed_chars: 0,
|
||||
},
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
mockConversation.messages = [userMsg1, toolMsg1, userMsg2, toolMsg2];
|
||||
|
||||
const stats = calculateRewindImpact(mockConversation, userMsg1);
|
||||
|
||||
expect(stats).toEqual({
|
||||
addedLines: 8, // 5 + 3
|
||||
removedLines: 3, // 2 + 1
|
||||
fileCount: 2,
|
||||
details: [
|
||||
{ fileName: 'file1.ts', diff: 'diff1' },
|
||||
{ fileName: 'file2.ts', diff: 'diff2' },
|
||||
],
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('revertFileChanges', () => {
|
||||
const mockDiffStat = {
|
||||
model_added_lines: 1,
|
||||
model_removed_lines: 1,
|
||||
user_added_lines: 0,
|
||||
user_removed_lines: 0,
|
||||
model_added_chars: 1,
|
||||
model_removed_chars: 1,
|
||||
user_added_chars: 0,
|
||||
user_removed_chars: 0,
|
||||
};
|
||||
|
||||
it('does nothing if message not found', async () => {
|
||||
mockConversation.messages = [];
|
||||
await revertFileChanges(mockConversation, 'missing-id');
|
||||
expect(fs.writeFile).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('reverts exact match', async () => {
|
||||
const userMsg: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'start',
|
||||
id: '1',
|
||||
timestamp: '1',
|
||||
};
|
||||
const toolMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-1',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file.txt',
|
||||
filePath: path.resolve('/root/file.txt'),
|
||||
originalContent: 'old',
|
||||
newContent: 'new',
|
||||
isNewFile: false,
|
||||
diffStat: mockDiffStat,
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
mockConversation.messages = [userMsg, toolMsg];
|
||||
|
||||
vi.mocked(fs.readFile).mockResolvedValue('new');
|
||||
|
||||
await revertFileChanges(mockConversation, '1');
|
||||
|
||||
expect(fs.writeFile).toHaveBeenCalledWith(
|
||||
path.resolve('/root/file.txt'),
|
||||
'old',
|
||||
);
|
||||
});
|
||||
|
||||
it('deletes new file on revert', async () => {
|
||||
const userMsg: MessageRecord = {
|
||||
type: 'user',
|
||||
content: 'start',
|
||||
id: '1',
|
||||
timestamp: '1',
|
||||
};
|
||||
const toolMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'write_file',
|
||||
id: 'tool-call-2',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file.txt',
|
||||
filePath: path.resolve('/root/file.txt'),
|
||||
originalContent: null,
|
||||
newContent: 'content',
|
||||
isNewFile: true,
|
||||
diffStat: mockDiffStat,
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
mockConversation.messages = [userMsg, toolMsg];
|
||||
|
||||
vi.mocked(fs.readFile).mockResolvedValue('content');
|
||||
|
||||
await revertFileChanges(mockConversation, '1');
|
||||
|
||||
expect(fs.unlink).toHaveBeenCalledWith(path.resolve('/root/file.txt'));
|
||||
});
|
||||
|
||||
it('handles smart revert (patching) successfully', async () => {
|
||||
const original = Array.from(
|
||||
{ length: 20 },
|
||||
(_, i) => `line${i + 1}`,
|
||||
).join('\n');
|
||||
// Agent changes line 2
|
||||
const agentModifiedLines = original.split('\n');
|
||||
agentModifiedLines[1] = 'line2-modified';
|
||||
const agentModified = agentModifiedLines.join('\n');
|
||||
|
||||
// User changes line 18 (far away from line 2)
|
||||
const userModifiedLines = [...agentModifiedLines];
|
||||
userModifiedLines[17] = 'line18-modified';
|
||||
const userModified = userModifiedLines.join('\n');
|
||||
|
||||
const toolMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-1',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file.txt',
|
||||
filePath: path.resolve('/root/file.txt'),
|
||||
originalContent: original,
|
||||
newContent: agentModified,
|
||||
isNewFile: false,
|
||||
diffStat: mockDiffStat,
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
mockConversation.messages = [
|
||||
{ type: 'user', content: 'start', id: '1', timestamp: '1' },
|
||||
toolMsg,
|
||||
];
|
||||
vi.mocked(fs.readFile).mockResolvedValue(userModified);
|
||||
|
||||
await revertFileChanges(mockConversation, '1');
|
||||
|
||||
// Expect line 2 to be reverted to original, but line 18 to keep user modification
|
||||
const expectedLines = original.split('\n');
|
||||
expectedLines[17] = 'line18-modified';
|
||||
const expectedContent = expectedLines.join('\n');
|
||||
|
||||
expect(fs.writeFile).toHaveBeenCalledWith(
|
||||
path.resolve('/root/file.txt'),
|
||||
expectedContent,
|
||||
);
|
||||
});
|
||||
|
||||
it('emits warning on smart revert failure', async () => {
|
||||
const original = 'line1\nline2\nline3';
|
||||
const agentModified = 'line1\nline2-modified\nline3';
|
||||
// User modification conflicts with the agent's change.
|
||||
const userModified = 'line1\nline2-usermodified\nline3';
|
||||
|
||||
const toolMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-1',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file.txt',
|
||||
filePath: path.resolve('/root/file.txt'),
|
||||
originalContent: original,
|
||||
newContent: agentModified,
|
||||
isNewFile: false,
|
||||
diffStat: mockDiffStat,
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
mockConversation.messages = [
|
||||
{ type: 'user', content: 'start', id: '1', timestamp: '1' },
|
||||
toolMsg,
|
||||
];
|
||||
vi.mocked(fs.readFile).mockResolvedValue(userModified);
|
||||
|
||||
await revertFileChanges(mockConversation, '1');
|
||||
|
||||
expect(fs.writeFile).not.toHaveBeenCalled();
|
||||
expect(coreEvents.emitFeedback).toHaveBeenCalledWith(
|
||||
'warning',
|
||||
expect.stringContaining('Smart revert for file.txt failed'),
|
||||
);
|
||||
});
|
||||
|
||||
it('emits error if fs.readFile fails with a generic error', async () => {
|
||||
const toolMsg: MessageRecord = {
|
||||
type: 'gemini',
|
||||
id: '2',
|
||||
timestamp: '2',
|
||||
content: '',
|
||||
toolCalls: [
|
||||
{
|
||||
name: 'replace',
|
||||
id: 'tool-call-1',
|
||||
status: 'success',
|
||||
timestamp: '2',
|
||||
args: {},
|
||||
resultDisplay: {
|
||||
fileName: 'file.txt',
|
||||
filePath: path.resolve('/root/file.txt'),
|
||||
originalContent: 'old',
|
||||
newContent: 'new',
|
||||
isNewFile: false,
|
||||
diffStat: mockDiffStat,
|
||||
},
|
||||
},
|
||||
] as unknown as ToolCallRecord[],
|
||||
};
|
||||
|
||||
mockConversation.messages = [
|
||||
{ type: 'user', content: 'start', id: '1', timestamp: '1' },
|
||||
toolMsg,
|
||||
];
|
||||
// Simulate a generic file read error
|
||||
vi.mocked(fs.readFile).mockRejectedValue(new Error('Permission denied'));
|
||||
|
||||
await revertFileChanges(mockConversation, '1');
|
||||
expect(fs.writeFile).not.toHaveBeenCalled();
|
||||
expect(coreEvents.emitFeedback).toHaveBeenCalledWith(
|
||||
'error',
|
||||
'Error reading file.txt during revert: Permission denied',
|
||||
expect.any(Error),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user