Fix --mount-git-worktree-common-dir has no effect when the devcontainer.json defines a custom workspaceMount

Author: Mathiyarasy

src/spec-node/utils.ts

@@ -383,11 +383,20 @@ export async function getWorkspaceConfiguration(cliHost: CLIHost, workspace: Wor
 	}
 	let { workspaceFolder, workspaceMount } = config;
 	let additionalMountString: string | undefined;
-	if (workspace && (!workspaceFolder || !('workspaceMount' in config))) {
+	if (workspace && (!workspaceFolder || !('workspaceMount' in config) || (mountWorkspaceGitRoot && mountGitWorktreeCommonDir))) {
 		const hostMountFolder = await getHostMountFolder(cliHost, workspace.rootFolderPath, mountWorkspaceGitRoot, output);
 
+		// When the user provides a custom workspaceMount, derive containerMountFolder from its
+		// target= value so that the worktree common-dir path is computed correctly.
+		let containerMountFolder: string;
+		if ('workspaceMount' in config && config.workspaceMount) {
+			const targetMatch = /(?:^|,)(?:dst|destination|target)=(?:"([^"]+)"|([^,]+))/.exec(config.workspaceMount);
+			containerMountFolder = targetMatch ? (targetMatch[1] ?? targetMatch[2]) : path.posix.join('/workspaces', cliHost.path.basename(hostMountFolder));
+		} else {
+			containerMountFolder = path.posix.join('/workspaces', cliHost.path.basename(hostMountFolder));
+		}
+
 		// Check if .git is a file (worktree) with a relative gitdir path
-		let containerMountFolder = path.posix.join('/workspaces', cliHost.path.basename(hostMountFolder));
 		if (mountWorkspaceGitRoot && mountGitWorktreeCommonDir) {
 			const dotGitPath = cliHost.path.join(hostMountFolder, '.git');
 			if (await cliHost.isFile(dotGitPath)) {
@@ -399,12 +408,16 @@ export async function getWorkspaceConfiguration(cliHost: CLIHost, workspace: Wor
 					if (!cliHost.path.isAbsolute(gitdir)) {
 						// gitdir points to .git/worktrees/<name>/, common dir is .git/ (two levels up)
 						const gitCommonDir = cliHost.path.resolve(hostMountFolder, gitdir, '..', '..');
-						// Collect path segments from hostMountFolder up to the parent of gitCommonDir
-						const segments: string[] = [];
-						for (let current = hostMountFolder; !gitCommonDir.startsWith(current + cliHost.path.sep) && current !== cliHost.path.dirname(current); current = cliHost.path.dirname(current)) {
-							segments.unshift(cliHost.path.basename(current));
+						// Only recompute containerMountFolder when the workspace mount is auto-generated;
+						// when the user supplied workspaceMount, keep the target they specified.
+						if (!('workspaceMount' in config)) {
+							// Collect path segments from hostMountFolder up to the parent of gitCommonDir
+							const segments: string[] = [];
+							for (let current = hostMountFolder; !gitCommonDir.startsWith(current + cliHost.path.sep) && current !== cliHost.path.dirname(current); current = cliHost.path.dirname(current)) {
+								segments.unshift(cliHost.path.basename(current));
+							}
+							containerMountFolder = path.posix.join('/workspaces', ...segments);
 						}
-						containerMountFolder = path.posix.join('/workspaces', ...segments);
 						// Calculate where the common dir should be mounted in the container
 						const containerGitdir = cliHost.platform === 'win32' ? gitdir.replace(/\\/g, '/') : gitdir;
 						const containerGitCommonDir = path.posix.resolve(containerMountFolder, containerGitdir, '..', '..');

src/test/workspaceConfiguration.test.ts

@@ -328,6 +328,53 @@ describe('getWorkspaceConfiguration', function () {
 					assert.strictEqual(result.additionalMountString, `type=bind,source=${p.repoGitPath},target=/workspaces/repos/main/.git${p.consistency}`);
 				});
 
+				it('should preserve custom workspaceMount target when adding worktree common dir mount', async () => {
+					const p = {
+						linux: {
+							worktreePath: '/home/user/worktrees/feature',
+							gitFile: '/home/user/worktrees/feature/.git',
+							gitdir: 'gitdir: ../../repo/.git/worktrees/feature',
+							repoGitPath: '/home/user/repo/.git',
+							consistency: ''
+						},
+						darwin: {
+							worktreePath: '/Users/user/worktrees/feature',
+							gitFile: '/Users/user/worktrees/feature/.git',
+							gitdir: 'gitdir: ../../repo/.git/worktrees/feature',
+							repoGitPath: '/Users/user/repo/.git',
+							consistency: ',consistency=consistent'
+						},
+						win32: {
+							worktreePath: 'C:\\Users\\user\\worktrees\\feature',
+							gitFile: 'C:\\Users\\user\\worktrees\\feature\\.git',
+							gitdir: 'gitdir: ../../repo/.git/worktrees/feature',
+							repoGitPath: 'C:\\Users\\user\\repo\\.git',
+							consistency: ',consistency=consistent'
+						},
+					}[platform];
+
+					const cliHost = createMockCLIHost({
+						platform,
+						files: {
+							[p.gitFile]: p.gitdir
+						}
+					});
+					const workspace = createWorkspace(p.worktreePath);
+
+					const result = await getWorkspaceConfiguration(
+						cliHost,
+						workspace,
+						{ workspaceMount: 'type=bind,source=${localWorkspaceFolder},target=/testworkspace' },
+						true,
+						true,
+						nullLog
+					);
+
+					assert.strictEqual(result.workspaceFolder, '/testworkspace');
+					assert.strictEqual(result.workspaceMount, 'type=bind,source=${localWorkspaceFolder},target=/testworkspace');
+					assert.strictEqual(result.additionalMountString, `type=bind,source=${p.repoGitPath},target=/repo/.git${p.consistency}`);
+				});
+
 			});
 
 			describe('git root in parent folder', function () {