Skip to content

fix(cli): speed up --resume / /resume session listing #26487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dimssu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(cli): speed up --resume / /resume session listing #26487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67f7cac
fix(cli): speed up session listing for --resume and /resume
dimssu May 5, 2026
26f3d1e
fix(cli): unlink metadata sidecar in session retention cleanup
dimssu May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion packages/cli/src/utils/sessionCleanup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
type Config,
deleteSessionArtifactsAsync,
deleteSubagentSessionDirAndArtifactsAsync,
getSessionMetadataSidecarPath,
} from '@google/gemini-cli-core';
import type { Settings, SessionRetentionSettings } from '../config/settings.js';
import { getAllSessionFiles, type SessionFileEntry } from './sessionUtils.js';
Expand Down Expand Up @@ -53,6 +54,20 @@ function isSessionIdRecord(record: unknown): record is { sessionId: string } {
return isStringProperty(record, 'sessionId');
}

async function unlinkSidecarIfPresent(jsonlPath: string): Promise<void> {
try {
await fs.unlink(getSessionMetadataSidecarPath(jsonlPath));
} catch (error) {
if (error instanceof Error && 'code' in error && error.code !== 'ENOENT') {
debugLogger.warn(
`Failed to remove session metadata sidecar for ${path.basename(jsonlPath)}: ${
error.message
}`,
);
}
}
}

/**
* Result of session cleanup operation
*/
Expand Down Expand Up @@ -131,7 +146,9 @@ export async function cleanupExpiredSessions(
return { ...result, disabled: true };
}

const allFiles = await getAllSessionFiles(chatsDir, config.getSessionId());
const allFiles = await getAllSessionFiles(chatsDir, config.getSessionId(), {
lazyMigrate: false,
});
result.scanned = allFiles.length;

if (allFiles.length === 0) {
Expand Down Expand Up @@ -216,6 +233,7 @@ export async function cleanupExpiredSessions(
// Delete the session file
if (!fullSessionId || fullSessionId !== config.getSessionId()) {
await fs.unlink(filePath);
await unlinkSidecarIfPresent(filePath);

if (fullSessionId) {
await cleanupSessionAndSubagentsAsync(fullSessionId, config);
Expand Down Expand Up @@ -244,6 +262,7 @@ export async function cleanupExpiredSessions(
// Fallback to old logic
const sessionPath = path.join(chatsDir, sessionToDelete.fileName);
await fs.unlink(sessionPath);
await unlinkSidecarIfPresent(sessionPath);

const sessionId = sessionToDelete.sessionInfo?.id;
if (sessionId) {
Expand Down
198 changes: 198 additions & 0 deletions packages/cli/src/utils/sessionUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,204 @@ describe('SessionSelector', () => {
expect(sessions.length).toBe(1);
expect(sessions[0].id).toBe(mainSessionId);
});

describe('metadata sidecar fast path', () => {
it('listSessions uses the sidecar even when the chat file is unreadable', async () => {
const sessionId = randomUUID();
const chatsDir = path.join(tmpDir, 'chats');
await fs.mkdir(chatsDir, { recursive: true });

const fileBase = `${SESSION_FILE_PREFIX}2024-01-01T10-00-${sessionId.slice(0, 8)}`;
const jsonlPath = path.join(chatsDir, `${fileBase}.jsonl`);
const sidecarPath = path.join(chatsDir, `${fileBase}.meta.json`);

// Empty/unreadable chat content; sidecar is the source of truth here.
await fs.writeFile(jsonlPath, '');
await fs.writeFile(
sidecarPath,
JSON.stringify({
version: 1,
sessionId,
projectHash: 'test-hash',
startTime: '2024-01-01T10:00:00.000Z',
lastUpdated: '2024-01-01T10:30:00.000Z',
kind: 'main',
summary: 'sidecar-summary',
messageCount: 3,
userMessageCount: 2,
hasUserOrAssistantMessage: true,
firstUserMessage: 'sidecar first user msg',
}),
);

const sessionSelector = new SessionSelector(storage);
const sessions = await sessionSelector.listSessions();
expect(sessions.length).toBe(1);
expect(sessions[0].id).toBe(sessionId);
expect(sessions[0].summary).toBe('sidecar-summary');
expect(sessions[0].messageCount).toBe(3);
expect(sessions[0].firstUserMessage).toBe('sidecar first user msg');
});

it('falls back to chat-file parsing and backfills the sidecar when missing', async () => {
const sessionId = randomUUID();
const chatsDir = path.join(tmpDir, 'chats');
await fs.mkdir(chatsDir, { recursive: true });

const fileBase = `${SESSION_FILE_PREFIX}2024-01-01T10-00-${sessionId.slice(0, 8)}`;
const jsonlPath = path.join(chatsDir, `${fileBase}.jsonl`);
const sidecarPath = path.join(chatsDir, `${fileBase}.meta.json`);

const header = {
sessionId,
projectHash: 'test-hash',
startTime: '2024-01-01T10:00:00.000Z',
lastUpdated: '2024-01-01T10:30:00.000Z',
kind: 'main',
};
const message = {
id: 'msg1',
timestamp: '2024-01-01T10:00:00.000Z',
type: 'user',
content: 'fallback first user',
};
await fs.writeFile(
jsonlPath,
JSON.stringify(header) + '\n' + JSON.stringify(message) + '\n',
);

// No sidecar yet
await expect(fs.stat(sidecarPath)).rejects.toThrow();

const sessionSelector = new SessionSelector(storage);
const sessions = await sessionSelector.listSessions();

expect(sessions.length).toBe(1);
expect(sessions[0].id).toBe(sessionId);
expect(sessions[0].firstUserMessage).toBe('fallback first user');

// Lazy migration should have written the sidecar.
const sidecarContent = JSON.parse(
await fs.readFile(sidecarPath, 'utf8'),
) as { sessionId: string; messageCount: number; version: number };
expect(sidecarContent.version).toBe(1);
expect(sidecarContent.sessionId).toBe(sessionId);
expect(sidecarContent.messageCount).toBe(1);
});

it('falls back when the sidecar version is unknown', async () => {
const sessionId = randomUUID();
const chatsDir = path.join(tmpDir, 'chats');
await fs.mkdir(chatsDir, { recursive: true });

const fileBase = `${SESSION_FILE_PREFIX}2024-01-01T10-00-${sessionId.slice(0, 8)}`;
const jsonlPath = path.join(chatsDir, `${fileBase}.jsonl`);
const sidecarPath = path.join(chatsDir, `${fileBase}.meta.json`);

const header = {
sessionId,
projectHash: 'test-hash',
startTime: '2024-01-01T10:00:00.000Z',
lastUpdated: '2024-01-01T10:30:00.000Z',
kind: 'main',
};
const message = {
id: 'msg1',
timestamp: '2024-01-01T10:00:00.000Z',
type: 'user',
content: 'fallback again',
};
await fs.writeFile(
jsonlPath,
JSON.stringify(header) + '\n' + JSON.stringify(message) + '\n',
);
// Sidecar with unknown version — must be ignored.
await fs.writeFile(sidecarPath, JSON.stringify({ version: 999 }));

const sessionSelector = new SessionSelector(storage);
const sessions = await sessionSelector.listSessions();
expect(sessions.length).toBe(1);
expect(sessions[0].firstUserMessage).toBe('fallback again');
});

it('skips sidecars whose kind is subagent', async () => {
const sessionId = randomUUID();
const chatsDir = path.join(tmpDir, 'chats');
await fs.mkdir(chatsDir, { recursive: true });

const fileBase = `${SESSION_FILE_PREFIX}2024-01-01T10-00-${sessionId.slice(0, 8)}`;
const jsonlPath = path.join(chatsDir, `${fileBase}.jsonl`);
const sidecarPath = path.join(chatsDir, `${fileBase}.meta.json`);
await fs.writeFile(jsonlPath, '');
await fs.writeFile(
sidecarPath,
JSON.stringify({
version: 1,
sessionId,
projectHash: 'test-hash',
startTime: '2024-01-01T10:00:00.000Z',
lastUpdated: '2024-01-01T10:30:00.000Z',
kind: 'subagent',
messageCount: 1,
userMessageCount: 1,
hasUserOrAssistantMessage: true,
}),
);

const sessionSelector = new SessionSelector(storage);
const sessions = await sessionSelector.listSessions();
expect(sessions.length).toBe(0);
});

it('does not surface the sidecar file itself as a session entry', async () => {
const sessionId = randomUUID();
const chatsDir = path.join(tmpDir, 'chats');
await fs.mkdir(chatsDir, { recursive: true });

const fileBase = `${SESSION_FILE_PREFIX}2024-01-01T10-00-${sessionId.slice(0, 8)}`;
const jsonlPath = path.join(chatsDir, `${fileBase}.jsonl`);
const sidecarPath = path.join(chatsDir, `${fileBase}.meta.json`);

const header = {
sessionId,
projectHash: 'test-hash',
startTime: '2024-01-01T10:00:00.000Z',
lastUpdated: '2024-01-01T10:30:00.000Z',
kind: 'main',
};
const message = {
id: 'msg1',
timestamp: '2024-01-01T10:00:00.000Z',
type: 'user',
content: 'hi',
};
await fs.writeFile(
jsonlPath,
JSON.stringify(header) + '\n' + JSON.stringify(message) + '\n',
);
await fs.writeFile(
sidecarPath,
JSON.stringify({
version: 1,
sessionId,
projectHash: 'test-hash',
startTime: '2024-01-01T10:00:00.000Z',
lastUpdated: '2024-01-01T10:30:00.000Z',
kind: 'main',
messageCount: 1,
userMessageCount: 1,
hasUserOrAssistantMessage: true,
firstUserMessage: 'hi',
}),
);

const sessionSelector = new SessionSelector(storage);
const sessions = await sessionSelector.listSessions();
// Exactly one entry — the sidecar must not be confused for a chat file.
expect(sessions.length).toBe(1);
expect(sessions[0].fileName).toBe(`${fileBase}.jsonl`);
});
});
});

describe('extractFirstUserMessage', () => {
Expand Down
Loading