Merge pull request #1008 from wakatime/develop

Release v1.88.1

Author: alanhamlett

TROUBLESHOOTING.md

@@ -20,7 +20,7 @@ Each plugin also has its own log file:
 * **Emacs** messages go to the *messages* buffer window
 * **Jetbrains IDEs (IntelliJ IDEA, PyCharm, RubyMine, PhpStorm, AppCode, AndroidStudio, WebStorm)** log to `idea.log` ([locating IDE log files][locating IDE log files])
 * **Komodo** logs are written to `pystderr.log` (Help -> Troubleshooting -> View Log File)
-* **Netbeans** logs to it's own log file (View -> IDE Log)
+* **Netbeans** logs to its own log file (View -> IDE Log)
 * **Notepad++** errors go to `AppData\Roaming\Notepad++\plugins\config\WakaTime.log` (this file is only created when an error occurs)
 * **Sublime** Text logs to the Sublime Console (View -> Show Console)
 * **TextMate** logs to stderr so run TextMate from Terminal to see any errors ([enable logging][textmate logging])
@@ -34,7 +34,7 @@ Check the [Plugin Status Page][plugins status] to see when the API last heard fr
 Useful API Endpoints for debugging:
 
 * [List of your Plugins and when they were last heard from][user agents api]
-* [List of your Machines and ther IPs][machines api]
+* [List of your Machines and their IPs][machines api]
 
 Useful Resources:
 

USAGE.md

@@ -133,7 +133,7 @@ projects/foo = your-api-key
 
 ### Api Key Environment Variable
 
-If a `WAKATIME_API_KEY` env var exists, wakatime-cli will use it’s value as the api key.
+If a `WAKATIME_API_KEY` env var exists, wakatime-cli will use its value as the api key.
 This means you don’t need a `~/.wakatime.cfg` file, or you can omit or leave empty the `api_key` setting in your config file if using the env var.
 However, if an api key exists in your `~/.wakatime.cfg` file then it takes precedence over the env var.
 
@@ -157,5 +157,5 @@ For commonly used configuration options, see examples in the [FAQ](https://wakat
 
 ## Internal INI Config File
 
-The plugins and waktime-cli use a separate internal INI file for things like caching auto-update requests to the GitHub releases API, and exponential backoff to the WakaTime API.
+The plugins and wakatime-cli use a separate internal INI file for things like caching auto-update requests to the GitHub releases API, and exponential backoff to the WakaTime API.
 The default internal INI config file location is `$WAKATIME_HOME/.wakatime/wakatime-internal.cfg`.

cmd/today/today.go

@@ -33,7 +33,7 @@ func Run(v *viper.Viper) (int, error) {
 	return exitcode.Success, nil
 }
 
-// Today returns a rendered summary of todays coding activity.
+// Today returns a rendered summary of today's coding activity.
 func Today(v *viper.Viper) (string, error) {
 	paramAPI, err := params.LoadAPIParams(v)
 	if err != nil {

cmd/todaygoal/todaygoal.go

@@ -45,7 +45,7 @@ func Run(v *viper.Viper) (int, error) {
 	return exitcode.Success, nil
 }
 
-// Goal returns total time of given goal id for todays coding activity.
+// Goal returns total time of given goal id for today's coding activity.
 func Goal(v *viper.Viper) (string, error) {
 	params, err := LoadParams(v)
 	if err != nil {

go.sum

@@ -296,8 +296,6 @@ golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw=
-golang.org/x/crypto v0.13.0 h1:mvySKfSWJ+UKUii46M40LOvyWfN0s2U+46/jDd0e6Ck=
-golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=
 golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
 golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
@@ -433,16 +431,13 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
-golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
 golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/term v0.12.0 h1:/ZfYdc3zq+q02Rv9vGqTeSItdzZTSNDmfTi0mBAuidU=
-golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
 golang.org/x/term v0.15.0 h1:y/Oo/a/q3IXu26lQgl04j/gjuBDOBlx7X6Om1j2CPW4=
+golang.org/x/term v0.15.0/go.mod h1:BDl952bC7+uMoWR75FIrCDx79TPU9oHkTZ9yRbYOrX0=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -452,8 +447,6 @@ golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
-golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
-golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=

pkg/apikey/apikey.go

@@ -34,9 +34,11 @@ func WithReplacing(config Config) heartbeat.HandleOption {
 				result, ok := MatchPattern(h.Entity, config.MapPatterns)
 				if ok {
 					hh[n].APIKey = result
-				} else {
-					hh[n].APIKey = config.DefaultAPIKey
+
+					continue
 				}
+
+				hh[n].APIKey = config.DefaultAPIKey
 			}
 
 			return next(hh)

pkg/project/file.go

@@ -49,8 +49,8 @@ func (f File) Detect() (Result, bool, error) {
 	return result, true, nil
 }
 
-// fileExists checks if a file or directory exist.
-func fileExists(fp string) bool {
+// fileOrDirExists checks if a file or directory exist.
+func fileOrDirExists(fp string) bool {
 	_, err := os.Stat(fp)
 	return err == nil || os.IsExist(err)
 }

pkg/project/git.go

@@ -27,7 +27,7 @@ func (g Git) Detect() (Result, bool, error) {
 	fp := g.Filepath
 
 	// Take only the directory
-	if fileExists(fp) {
+	if fileOrDirExists(fp) {
 		fp = filepath.Dir(fp)
 	}
 
@@ -73,7 +73,9 @@ func (g Git) Detect() (Result, bool, error) {
 		return Result{}, false, fmt.Errorf("error finding gitdir: %s", err)
 	}
 
-	// Commonly .git file is present when it's a worktree
+	// Commonly .git folder is present when it's a worktree but there's an exception where
+	// worktree is present but .git folder is not present. In that case, we need to find
+	// for worktree folder.
 	// Find for commondir file
 	commondir, ok, err := findCommondir(gitdir)
 	if err != nil {
@@ -82,7 +84,16 @@ func (g Git) Detect() (Result, bool, error) {
 
 	// we found a commondir file so this is a worktree
 	if ok {
-		project := projectOrRemote(filepath.Base(filepath.Dir(commondir)), g.ProjectFromGitRemote, commondir)
+		dir := filepath.Dir(commondir)
+
+		// Commonly commondir file contains a .git folder but there's an exception where
+		// commondir contains the actual git folder. It's common when repo is bare and
+		// it's a worktree.
+		if strings.LastIndex(commondir, ".git") == -1 {
+			dir = commondir
+		}
+
+		project := projectOrRemote(filepath.Base(dir), g.ProjectFromGitRemote, commondir)
 
 		branch, err := findGitBranch(filepath.Join(gitdir, "HEAD"))
 		if err != nil {
@@ -96,7 +107,7 @@ func (g Git) Detect() (Result, bool, error) {
 		return Result{
 			Project: project,
 			Branch:  branch,
-			Folder:  filepath.Dir(commondir),
+			Folder:  dir,
 		}, true, nil
 	}
 
@@ -198,13 +209,13 @@ func findGitdir(fp string) (string, error) {
 	return "", nil
 }
 
-func resolveGitdir(fp string, gitdir string) (string, error) {
+func resolveGitdir(fp, gitdir string) (string, error) {
 	subPath := strings.TrimSpace(gitdir)
 	if !filepath.IsAbs(subPath) {
 		subPath = filepath.Join(fp, subPath)
 	}
 
-	if fileExists(filepath.Join(subPath, "HEAD")) {
+	if fileOrDirExists(filepath.Join(subPath, "HEAD")) {
 		return subPath, nil
 	}
 
@@ -220,7 +231,7 @@ func findCommondir(fp string) (string, bool, error) {
 		return "", false, nil
 	}
 
-	if fileExists(filepath.Join(fp, "commondir")) {
+	if fileOrDirExists(filepath.Join(fp, "commondir")) {
 		return resolveCommondir(fp)
 	}
 
@@ -244,11 +255,7 @@ func resolveCommondir(fp string) (string, bool, error) {
 			fmt.Errorf("failed to get absolute path: %s", err)
 	}
 
-	if filepath.Base(gitdir) == ".git" {
-		return gitdir, true, nil
-	}
-
-	return "", false, nil
+	return gitdir, true, nil
 }
 
 func projectOrRemote(projectName string, projectFromGitRemote bool, dotGitFolder string) string {
@@ -273,7 +280,7 @@ func projectOrRemote(projectName string, projectFromGitRemote bool, dotGitFolder
 }
 
 func findGitBranch(fp string) (string, error) {
-	if !fileExists(fp) {
+	if !fileOrDirExists(fp) {
 		return "master", nil
 	}
 
@@ -290,7 +297,7 @@ func findGitBranch(fp string) (string, error) {
 }
 
 func findGitRemote(fp string) (string, error) {
-	if !fileExists(fp) {
+	if !fileOrDirExists(fp) {
 		return "", nil
 	}
 

pkg/project/git_test.go

@@ -154,6 +154,45 @@ func TestGit_Detect_WorktreeGitRemote(t *testing.T) {
 	}, result)
 }
 
+func TestGit_Detect_Worktree_BareRepo(t *testing.T) {
+	fp := setupTestGitWorktreeBareRepo(t)
+
+	g := project.Git{
+		Filepath: filepath.Join(fp, "wakatime-cli/master/src/pkg/file.go"),
+	}
+
+	result, detected, err := g.Detect()
+	require.NoError(t, err)
+
+	assert.True(t, detected)
+	assert.Contains(t, result.Folder, filepath.Join(fp, "wakatime-cli"))
+	assert.Equal(t, project.Result{
+		Project: "wakatime-cli",
+		Branch:  "feature/api",
+		Folder:  result.Folder,
+	}, result)
+}
+
+func TestGit_Detect_WorktreeGitRemote_BareRepo(t *testing.T) {
+	fp := setupTestGitWorktreeBareRepo(t)
+
+	g := project.Git{
+		Filepath:             filepath.Join(fp, "wakatime-cli/master/src/pkg/file.go"),
+		ProjectFromGitRemote: true,
+	}
+
+	result, detected, err := g.Detect()
+	require.NoError(t, err)
+
+	assert.True(t, detected)
+	assert.Contains(t, result.Folder, filepath.Join(fp, "wakatime-cli"))
+	assert.Equal(t, project.Result{
+		Project: "wakatime/wakatime-cli",
+		Branch:  "feature/api",
+		Folder:  result.Folder,
+	}, result)
+}
+
 func TestGit_Detect_Submodule(t *testing.T) {
 	fp := setupTestGitSubmodule(t)
 
@@ -456,6 +495,48 @@ func setupTestGitWorktree(t *testing.T) (fp string) {
 	return tmpDir
 }
 
+func setupTestGitWorktreeBareRepo(t *testing.T) (fp string) {
+	tmpDir := t.TempDir()
+
+	tmpDir, err := realpath.Realpath(tmpDir)
+	require.NoError(t, err)
+
+	if runtime.GOOS == "windows" {
+		tmpDir = windows.FormatFilePath(tmpDir)
+	}
+
+	// Create directories
+	err = os.MkdirAll(filepath.Join(tmpDir, "wakatime-cli/worktrees/master"), os.FileMode(int(0700)))
+	require.NoError(t, err)
+
+	err = os.MkdirAll(filepath.Join(tmpDir, "wakatime-cli/master/src/pkg"), os.FileMode(int(0700)))
+	require.NoError(t, err)
+
+	// Create fake file
+	tmpFile, err := os.Create(filepath.Join(tmpDir, "wakatime-cli/master/src/pkg/file.go"))
+	require.NoError(t, err)
+
+	defer tmpFile.Close()
+
+	// Setup basic git
+	copyFile(t, "testdata/git_basic/config", filepath.Join(tmpDir, "wakatime-cli/config"))
+	copyFile(t, "testdata/git_worktree/HEAD", filepath.Join(tmpDir, "wakatime-cli/HEAD"))
+
+	// Setup git worktree
+	copyFile(t, "testdata/git_worktree/HEAD2", filepath.Join(tmpDir, "wakatime-cli/worktrees/master/HEAD"))
+	copyFile(t, "testdata/git_worktree/commondir", filepath.Join(tmpDir, "wakatime-cli/worktrees/master/commondir"))
+
+	tmpFile, err = os.Create(filepath.Join(tmpDir, "wakatime-cli/master/.git"))
+	require.NoError(t, err)
+
+	defer tmpFile.Close()
+
+	_, err = tmpFile.WriteString(fmt.Sprintf("gitdir: %s/wakatime-cli/worktrees/master", tmpDir))
+	require.NoError(t, err)
+
+	return tmpDir
+}
+
 func setupTestGitSubmodule(t *testing.T) (fp string) {
 	tmpDir := t.TempDir()
 

pkg/project/mercurial.go

@@ -19,7 +19,7 @@ func (m Mercurial) Detect() (Result, bool, error) {
 	var fp string
 
 	// Take only the directory
-	if fileExists(m.Filepath) {
+	if fileOrDirExists(m.Filepath) {
 		fp = filepath.Dir(m.Filepath)
 	}
 
@@ -49,7 +49,7 @@ func (m Mercurial) Detect() (Result, bool, error) {
 
 func findHgBranch(fp string) (string, error) {
 	p := filepath.Join(fp, "branch")
-	if !fileExists(p) {
+	if !fileOrDirExists(p) {
 		return "default", nil
 	}