feat(worktree): add Git worktree support for isolated parallel sessions (#22973)

This commit is contained in:
Jerop Kipruto
2026-03-20 10:10:51 -04:00
committed by GitHub
parent b9c87c14a2
commit 5a3c7154df
23 changed files with 1090 additions and 9 deletions
@@ -0,0 +1,124 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { setupWorktree } from './worktreeSetup.js';
import * as coreFunctions from '@google/gemini-cli-core';
// Mock dependencies
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
return {
...actual,
getProjectRootForWorktree: vi.fn(),
createWorktreeService: vi.fn(),
debugLogger: {
log: vi.fn(),
error: vi.fn(),
debug: vi.fn(),
},
writeToStdout: vi.fn(),
writeToStderr: vi.fn(),
};
});
describe('setupWorktree', () => {
const originalEnv = { ...process.env };
const originalCwd = process.cwd;
const mockService = {
setup: vi.fn(),
maybeCleanup: vi.fn(),
};
beforeEach(() => {
vi.clearAllMocks();
process.env = { ...originalEnv };
// Mock process.cwd and process.chdir
let currentPath = '/mock/project';
process.cwd = vi.fn().mockImplementation(() => currentPath);
process.chdir = vi.fn().mockImplementation((newPath) => {
currentPath = newPath;
});
// Mock successful execution of core utilities
vi.mocked(coreFunctions.getProjectRootForWorktree).mockResolvedValue(
'/mock/project',
);
vi.mocked(coreFunctions.createWorktreeService).mockResolvedValue(
mockService as never,
);
mockService.setup.mockResolvedValue({
name: 'my-feature',
path: '/mock/project/.gemini/worktrees/my-feature',
baseSha: 'base-sha',
});
});
afterEach(() => {
process.env = { ...originalEnv };
process.cwd = originalCwd;
delete (process as { chdir?: typeof process.chdir }).chdir;
});
it('should create and switch to a new worktree', async () => {
await setupWorktree('my-feature');
expect(coreFunctions.getProjectRootForWorktree).toHaveBeenCalledWith(
'/mock/project',
);
expect(coreFunctions.createWorktreeService).toHaveBeenCalledWith(
'/mock/project',
);
expect(mockService.setup).toHaveBeenCalledWith('my-feature');
expect(process.chdir).toHaveBeenCalledWith(
'/mock/project/.gemini/worktrees/my-feature',
);
expect(process.env['GEMINI_CLI_WORKTREE_HANDLED']).toBe('1');
});
it('should generate a name if worktreeName is undefined', async () => {
mockService.setup.mockResolvedValue({
name: 'generated-name',
path: '/mock/project/.gemini/worktrees/generated-name',
baseSha: 'base-sha',
});
await setupWorktree(undefined);
expect(mockService.setup).toHaveBeenCalledWith(undefined);
});
it('should skip worktree creation if GEMINI_CLI_WORKTREE_HANDLED is set', async () => {
process.env['GEMINI_CLI_WORKTREE_HANDLED'] = '1';
await setupWorktree('my-feature');
expect(coreFunctions.createWorktreeService).not.toHaveBeenCalled();
expect(process.chdir).not.toHaveBeenCalled();
});
it('should handle errors gracefully and exit', async () => {
const mockExit = vi.spyOn(process, 'exit').mockImplementation(() => {
throw new Error('PROCESS_EXIT');
});
mockService.setup.mockRejectedValue(new Error('Git failure'));
await expect(setupWorktree('my-feature')).rejects.toThrow('PROCESS_EXIT');
expect(coreFunctions.writeToStderr).toHaveBeenCalledWith(
expect.stringContaining(
'Failed to create or switch to worktree: Git failure',
),
);
expect(mockExit).toHaveBeenCalledWith(1);
mockExit.mockRestore();
});
});
+43
View File
@@ -0,0 +1,43 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
getProjectRootForWorktree,
createWorktreeService,
writeToStderr,
type WorktreeInfo,
} from '@google/gemini-cli-core';
/**
* Sets up a git worktree for parallel sessions.
*
* This function uses a guard (GEMINI_CLI_WORKTREE_HANDLED) to ensure that
* when the CLI relaunches itself (e.g. for memory allocation), it doesn't
* attempt to create a nested worktree.
*/
export async function setupWorktree(
worktreeName: string | undefined,
): Promise<WorktreeInfo | undefined> {
if (process.env['GEMINI_CLI_WORKTREE_HANDLED'] === '1') {
return undefined;
}
try {
const projectRoot = await getProjectRootForWorktree(process.cwd());
const service = await createWorktreeService(projectRoot);
const worktreeInfo = await service.setup(worktreeName || undefined);
process.chdir(worktreeInfo.path);
process.env['GEMINI_CLI_WORKTREE_HANDLED'] = '1';
return worktreeInfo;
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
writeToStderr(`Failed to create or switch to worktree: ${errorMessage}\n`);
process.exit(1);
}
}