MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-07-18 14:00:27 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat(core, cli): Add auth type to history checkpoint. (#13023)

Browse Source
This commit is contained in:
joshualitt
2025-11-13 15:13:39 -08:00
committed by GitHub
parent 7bec972c87
commit 028c6fe71b
6 changed files with 143 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/src/core/logger.test.ts
+40 -17
View File
@@ -20,6 +20,7 @@ import {
encodeTagName,
decodeTagName,
} from './logger.js';
import { AuthType } from './contentGenerator.js';
import { Storage } from '../config/storage.js';
import { promises as fs, existsSync } from 'node:fs';
import path from 'node:path';
@@ -432,13 +433,19 @@ describe('Logger', () => {
encodedTag: '..%2F..%2Fsecret',
},
])('should save a checkpoint', async ({ tag, encodedTag }) => {
await logger.saveCheckpoint(conversation, tag);
await logger.saveCheckpoint(
{ history: conversation, authType: AuthType.LOGIN_WITH_GOOGLE },
tag,
);
const taggedFilePath = path.join(
TEST_GEMINI_DIR,
`checkpoint-${encodedTag}.json`,
);
const fileContent = await fs.readFile(taggedFilePath, 'utf-8');
expect(JSON.parse(fileContent)).toEqual(conversation);
expect(JSON.parse(fileContent)).toEqual({
history: conversation,
authType: AuthType.LOGIN_WITH_GOOGLE,
});
});
it('should not throw if logger is not initialized', async () => {
@@ -452,7 +459,7 @@ describe('Logger', () => {
.mockImplementation(() => {});
await expect(
uninitializedLogger.saveCheckpoint(conversation, 'tag'),
uninitializedLogger.saveCheckpoint({ history: conversation }, 'tag'),
).resolves.not.toThrow();
expect(consoleErrorSpy).toHaveBeenCalledWith(
'Logger not initialized or checkpoint file path not set. Cannot save a checkpoint.',
@@ -492,10 +499,13 @@ describe('Logger', () => {
encodedTag: '..%2F..%2Fsecret',
},
])('should load from a checkpoint', async ({ tag, encodedTag }) => {
const taggedConversation = [
...conversation,
{ role: 'user', parts: [{ text: 'hello' }] },
];
const taggedConversation = {
history: [
...conversation,
{ role: 'user', parts: [{ text: 'hello' }] },
],
authType: AuthType.USE_GEMINI,
};
const taggedFilePath = path.join(
TEST_GEMINI_DIR,
`checkpoint-${encodedTag}.json`,
@@ -511,18 +521,31 @@ describe('Logger', () => {
expect(decodeTagName(encodedTag)).toBe(tag);
});
it('should return an empty array if a tagged checkpoint file does not exist', async () => {
const loaded = await logger.loadCheckpoint('nonexistent-tag');
expect(loaded).toEqual([]);
it('should load a legacy checkpoint without authType', async () => {
const tag = 'legacy-tag';
const encodedTag = 'legacy-tag';
const taggedFilePath = path.join(
TEST_GEMINI_DIR,
`checkpoint-${encodedTag}.json`,
);
await fs.writeFile(taggedFilePath, JSON.stringify(conversation, null, 2));
const loaded = await logger.loadCheckpoint(tag);
expect(loaded).toEqual({ history: conversation });
});
it('should return an empty array if the checkpoint file does not exist', async () => {
it('should return an empty history if a tagged checkpoint file does not exist', async () => {
const loaded = await logger.loadCheckpoint('nonexistent-tag');
expect(loaded).toEqual({ history: [] });
});
it('should return an empty history if the checkpoint file does not exist', async () => {
await fs.unlink(TEST_CHECKPOINT_FILE_PATH); // Ensure it's gone
const loaded = await logger.loadCheckpoint('missing');
expect(loaded).toEqual([]);
expect(loaded).toEqual({ history: [] });
});
it('should return an empty array if the file contains invalid JSON', async () => {
it('should return an empty history if the file contains invalid JSON', async () => {
const tag = 'invalid-json-tag';
const encodedTag = 'invalid-json-tag';
const taggedFilePath = path.join(
@@ -534,14 +557,14 @@ describe('Logger', () => {
.spyOn(console, 'error')
.mockImplementation(() => {});
const loadedCheckpoint = await logger.loadCheckpoint(tag);
expect(loadedCheckpoint).toEqual([]);
expect(loadedCheckpoint).toEqual({ history: [] });
expect(consoleErrorSpy).toHaveBeenCalledWith(
expect.stringContaining('Failed to read or parse checkpoint file'),
expect.any(Error),
);
});
it('should return an empty array if logger is not initialized', async () => {
it('should return an empty history if logger is not initialized', async () => {
const uninitializedLogger = new Logger(
testSessionId,
new Storage(process.cwd()),
@@ -551,7 +574,7 @@ describe('Logger', () => {
.spyOn(console, 'error')
.mockImplementation(() => {});
const loadedCheckpoint = await uninitializedLogger.loadCheckpoint('tag');
expect(loadedCheckpoint).toEqual([]);
expect(loadedCheckpoint).toEqual({ history: [] });
expect(consoleErrorSpy).toHaveBeenCalledWith(
'Logger not initialized or checkpoint file path not set. Cannot load checkpoint.',
);
@@ -726,7 +749,7 @@ describe('Logger', () => {
);
const loaded = await logger.loadCheckpoint(tag);
expect(loaded).toEqual(taggedConversation);
expect(loaded.history).toEqual(taggedConversation);
});
});
packages/core/src/core/logger.ts
+29 -12
View File
@@ -7,6 +7,7 @@
import path from 'node:path';
import { promises as fs } from 'node:fs';
import type { Content } from '@google/genai';
import type { AuthType } from './contentGenerator.js';
import type { Storage } from '../config/storage.js';
import { debugLogger } from '../utils/debugLogger.js';
import { coreEvents } from '../utils/events.js';
@@ -25,6 +26,11 @@ export interface LogEntry {
message: string;
}
export interface Checkpoint {
history: Content[];
authType?: AuthType;
}
// This regex matches any character that is NOT a letter (a-z, A-Z),
// a number (0-9), a hyphen (-), an underscore (_), or a dot (.).
@@ -314,7 +320,7 @@ export class Logger {
return newPath;
}
async saveCheckpoint(conversation: Content[], tag: string): Promise<void> {
async saveCheckpoint(checkpoint: Checkpoint, tag: string): Promise<void> {
if (!this.initialized) {
debugLogger.error(
'Logger not initialized or checkpoint file path not set. Cannot save a checkpoint.',
@@ -324,42 +330,53 @@ export class Logger {
// Always save with the new encoded path.
const path = this._checkpointPath(tag);
try {
await fs.writeFile(path, JSON.stringify(conversation, null, 2), 'utf-8');
await fs.writeFile(path, JSON.stringify(checkpoint, null, 2), 'utf-8');
} catch (error) {
debugLogger.error('Error writing to checkpoint file:', error);
}
}
async loadCheckpoint(tag: string): Promise<Content[]> {
async loadCheckpoint(tag: string): Promise<Checkpoint> {
if (!this.initialized) {
debugLogger.error(
'Logger not initialized or checkpoint file path not set. Cannot load checkpoint.',
);
return [];
return { history: [] };
}
const path = await this._getCheckpointPath(tag);
try {
const fileContent = await fs.readFile(path, 'utf-8');
const parsedContent = JSON.parse(fileContent);
if (!Array.isArray(parsedContent)) {
debugLogger.warn(
`Checkpoint file at ${path} is not a valid JSON array. Returning empty checkpoint.`,
);
return [];
// Handle legacy format (just an array of Content)
if (Array.isArray(parsedContent)) {
return { history: parsedContent as Content[] };
}
return parsedContent as Content[];
if (
typeof parsedContent === 'object' &&
parsedContent !== null &&
'history' in parsedContent
) {
return parsedContent as Checkpoint;
}
debugLogger.warn(
`Checkpoint file at ${path} has an unknown format. Returning empty checkpoint.`,
);
return { history: [] };
} catch (error) {
const nodeError = error as NodeJS.ErrnoException;
if (nodeError.code === 'ENOENT') {
// This is okay, it just means the checkpoint doesn't exist in either format.
return [];
return { history: [] };
}
debugLogger.error(
`Failed to read or parse checkpoint file ${path}:`,
error,
);
return [];
return { history: [] };
}
}