Fix seg-fault when opening submodule in nested folder

Author: jesseduffield

pkg/commands/git_commands/repo_paths.go

@@ -194,19 +194,28 @@ func getCurrentRepoGitDirPath(
 		return "", "", errors.Errorf("could not find git dir for %s: %v", currentPath, err)
 	}
 
-	// confirm whether the next directory up is the worktrees/submodules directory
+	_, err = fs.Stat(worktreeGitPath)
+	if err != nil {
+		return "", "", errors.Errorf("could not find git dir for %s: %v", currentPath, err)
+	}
+
+	// confirm whether the next directory up is the worktrees directory
 	parent := path.Dir(worktreeGitPath)
-	if path.Base(parent) != "worktrees" && path.Base(parent) != "modules" {
-		return "", "", errors.Errorf("could not find git dir for %s", currentPath)
+	if path.Base(parent) == "worktrees" {
+		gitDirPath := path.Dir(parent)
+		return gitDirPath, path.Dir(gitDirPath), nil
 	}
 
-	// if it's a submodule, we treat it as its own repo
-	if path.Base(parent) == "modules" {
+	// Unlike worktrees, submodules can be nested arbitrarily deep, so we check
+	// if the `modules` directory is anywhere up the chain.
+	if strings.Contains(worktreeGitPath, "/modules/") {
+		// For submodules, we just return the path directly
 		return worktreeGitPath, currentPath, nil
 	}
 
-	gitDirPath := path.Dir(parent)
-	return gitDirPath, path.Dir(gitDirPath), nil
+	// If this error causes issues, we could relax the constraint and just always
+	// return the path
+	return "", "", errors.Errorf("could not find git dir for %s: path is not under `worktrees` or `modules` directories", currentPath)
 }
 
 // takes a path containing a symlink and returns the true path

pkg/commands/git_commands/repo_paths_test.go

@@ -73,7 +73,7 @@ func TestGetRepoPathsAux(t *testing.T) {
 			},
 			Path:     "/path/to/repo/worktree2",
 			Expected: nil,
-			Err:      errors.New("failed to get repo git dir path: could not find git dir for /path/to/repo/worktree2"),
+			Err:      errors.New("failed to get repo git dir path: could not find git dir for /path/to/repo/worktree2: open /nonexistant: file does not exist"),
 		},
 		{
 			Name: "submodule",
@@ -92,6 +92,23 @@ func TestGetRepoPathsAux(t *testing.T) {
 			},
 			Err: nil,
 		},
+		{
+			Name: "submodule in nested directory",
+			BeforeFunc: func(fs afero.Fs) {
+				_ = fs.MkdirAll("/path/to/repo/.git/modules/my/submodule1", 0o755)
+				_ = afero.WriteFile(fs, "/path/to/repo/my/submodule1/.git", []byte("gitdir: /path/to/repo/.git/modules/my/submodule1"), 0o644)
+			},
+			Path: "/path/to/repo/my/submodule1",
+			Expected: &RepoPaths{
+				currentPath:        "/path/to/repo/my/submodule1",
+				worktreePath:       "/path/to/repo/my/submodule1",
+				worktreeGitDirPath: "/path/to/repo/.git/modules/my/submodule1",
+				repoPath:           "/path/to/repo/my/submodule1",
+				repoGitDirPath:     "/path/to/repo/.git/modules/my/submodule1",
+				repoName:           "submodule1",
+			},
+			Err: nil,
+		},
 	}
 
 	for _, s := range scenarios {