feat(cli): export chat history in /bug and prefill GitHub issue (#16115)

This commit is contained in:
N. Taylor Mullen
2026-01-08 03:43:55 -08:00
committed by GitHub
parent 722c4933dc
commit 030847a80a
6 changed files with 234 additions and 101 deletions

View File

@@ -6,6 +6,7 @@
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import open from 'open';
import path from 'node:path';
import { bugCommand } from './bugCommand.js';
import { createMockCommandContext } from '../../test-utils/mockCommandContext.js';
import { getVersion } from '@google/gemini-cli-core';
@@ -15,6 +16,16 @@ import { formatMemoryUsage } from '../utils/formatters.js';
// Mock dependencies
vi.mock('open');
vi.mock('../utils/formatters.js');
vi.mock('../utils/historyExportUtils.js', async (importOriginal) => {
const actual =
await importOriginal<typeof import('../utils/historyExportUtils.js')>();
return {
...actual,
exportHistoryToFile: vi.fn(),
};
});
import { exportHistoryToFile } from '../utils/historyExportUtils.js';
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
@@ -27,6 +38,13 @@ vi.mock('@google/gemini-cli-core', async (importOriginal) => {
},
sessionId: 'test-session-id',
getVersion: vi.fn(),
INITIAL_HISTORY_LENGTH: 1,
debugLogger: {
error: vi.fn(),
log: vi.fn(),
debug: vi.fn(),
warn: vi.fn(),
},
};
});
vi.mock('node:process', () => ({
@@ -52,11 +70,14 @@ describe('bugCommand', () => {
vi.mocked(getVersion).mockResolvedValue('0.1.0');
vi.mocked(formatMemoryUsage).mockReturnValue('100 MB');
vi.stubEnv('SANDBOX', 'gemini-test');
vi.useFakeTimers();
vi.setSystemTime(new Date('2024-01-01T00:00:00Z'));
});
afterEach(() => {
vi.unstubAllEnvs();
vi.clearAllMocks();
vi.useRealTimers();
});
it('should generate the default GitHub issue URL', async () => {
@@ -66,6 +87,11 @@ describe('bugCommand', () => {
getModel: () => 'gemini-pro',
getBugCommand: () => undefined,
getIdeMode: () => true,
getGeminiClient: () => ({
getChat: () => ({
getHistory: () => [],
}),
}),
},
},
});
@@ -86,13 +112,58 @@ describe('bugCommand', () => {
* **Kitty Keyboard Protocol:** Supported
* **IDE Client:** VSCode
`;
const expectedUrl =
'https://github.com/google-gemini/gemini-cli/issues/new?template=bug_report.yml&title=A%20test%20bug&info=' +
encodeURIComponent(expectedInfo);
const expectedUrl = `https://github.com/google-gemini/gemini-cli/issues/new?template=bug_report.yml&title=A%20test%20bug&info=${encodeURIComponent(expectedInfo)}&problem=A%20test%20bug`;
expect(open).toHaveBeenCalledWith(expectedUrl);
});
it('should export chat history if available', async () => {
const history = [
{ role: 'user', parts: [{ text: 'hello' }] },
{ role: 'model', parts: [{ text: 'hi' }] },
];
const mockContext = createMockCommandContext({
services: {
config: {
getModel: () => 'gemini-pro',
getBugCommand: () => undefined,
getIdeMode: () => true,
getGeminiClient: () => ({
getChat: () => ({
getHistory: () => history,
}),
}),
storage: {
getProjectTempDir: () => '/tmp/gemini',
},
},
},
});
if (!bugCommand.action) throw new Error('Action is not defined');
await bugCommand.action(mockContext, 'Bug with history');
const expectedPath = path.join(
'/tmp/gemini',
'bug-report-history-1704067200000.json',
);
expect(exportHistoryToFile).toHaveBeenCalledWith({
history,
filePath: expectedPath,
});
const addItemCall = vi.mocked(mockContext.ui.addItem).mock.calls[0];
const messageText = addItemCall[0].text;
expect(messageText).toContain(expectedPath);
expect(messageText).toContain('📄 **Chat History Exported**');
expect(messageText).toContain('Privacy Disclaimer:');
expect(messageText).not.toContain('additional-context=');
expect(messageText).toContain('problem=');
const reminder =
'\n\n[ACTION REQUIRED] 📎 PLEASE ATTACH THE EXPORTED CHAT HISTORY JSON FILE TO THIS ISSUE IF YOU FEEL COMFORTABLE SHARING IT.';
expect(messageText).toContain(encodeURIComponent(reminder));
});
it('should use a custom URL template from config if provided', async () => {
const customTemplate =
'https://internal.bug-tracker.com/new?desc={title}&details={info}';
@@ -102,6 +173,11 @@ describe('bugCommand', () => {
getModel: () => 'gemini-pro',
getBugCommand: () => ({ urlTemplate: customTemplate }),
getIdeMode: () => true,
getGeminiClient: () => ({
getChat: () => ({
getHistory: () => [],
}),
}),
},
},
});