Format unsaved entity file paths

Author: gandarez

cmd/heartbeat/heartbeat_test.go

@@ -598,7 +598,7 @@ func TestSendHeartbeats_NonExistingEntity(t *testing.T) {
 	assert.Contains(t, string(output), "skipping because of non-existing file")
 }
 
-func TestSendHeartbeats_IsUnsavedEntity(t *testing.T) {
+func TestSendHeartbeats_ExtraHeartbeatsIsUnsavedEntity(t *testing.T) {
 	resetSingleton(t)
 
 	testServerURL, router, tearDown := setupTestServer()
@@ -639,8 +639,8 @@ func TestSendHeartbeats_IsUnsavedEntity(t *testing.T) {
 
 		expectedBodyStr := fmt.Sprintf(
 			string(expectedBody),
-			entities[0].Entity, userAgent,
-			entities[1].Entity, userAgent,
+			entities[0].Entity, subfolders, userAgent,
+			entities[1].Entity, subfolders, userAgent,
 			entities[2].Entity, subfolders, userAgent,
 		)
 
@@ -707,7 +707,6 @@ func TestSendHeartbeats_IsUnsavedEntity(t *testing.T) {
 	v.Set("lines-in-file", 91)
 	v.Set("plugin", plugin)
 	v.Set("time", 1585598051)
-	v.Set("timeout", 5)
 	v.Set("extra-heartbeats", true)
 	v.Set("log-file", logFile.Name())
 	v.Set("verbose", true)

cmd/heartbeat/testdata/api_heartbeats_request_is_unsaved_entity_template.json

@@ -7,6 +7,7 @@
     "lineno": 11,
     "lines": 91,
     "project": "wakatime-cli",
+    "project_root_count": %d,
     "type": "file",
     "time": 1585598051,
     "user_agent": "%s"
@@ -20,6 +21,7 @@
     "lineno": 42,
     "lines": 45,
     "project": "wakatime-cli",
+    "project_root_count": %d,
     "type": "file",
     "time": 1585598052,
     "user_agent": "%s"

pkg/heartbeat/format.go

@@ -36,14 +36,19 @@ func WithFormatting() HandleOption {
 	}
 }
 
-// Format accepts a heartbeat formats it's filepath and returns the formatted version.
+// Format accepts a heartbeat to format its filepath and returns the formatted version.
 func Format(ctx context.Context, h Heartbeat) Heartbeat {
-	if !h.IsUnsavedEntity && (runtime.GOOS != "windows" || !windows.IsWindowsNetworkMount(h.Entity)) {
-		formatLinuxFilePath(ctx, &h)
+	if h.EntityType != FileType {
+		return h
 	}
 
 	if runtime.GOOS == "windows" {
 		formatWindowsFilePath(ctx, &h)
+		return h
+	}
+
+	if !windows.IsWindowsNetworkMount(h.Entity) {
+		formatLinuxFilePath(ctx, &h)
 	}
 
 	return h
@@ -92,9 +97,15 @@ func formatLinuxFilePath(ctx context.Context, h *Heartbeat) {
 func formatWindowsFilePath(ctx context.Context, h *Heartbeat) {
 	logger := log.Extract(ctx)
 
-	h.Entity = windows.FormatFilePath(h.Entity)
+	formatted, err := filepath.Abs(h.Entity)
+	if err != nil {
+		logger.Debugf("failed to resolve absolute path for %q: %s", h.Entity, err)
+		return
+	}
+
+	h.Entity = windows.FormatFilePath(formatted)
 
-	if !h.IsUnsavedEntity && !windows.IsWindowsNetworkMount(h.Entity) {
+	if !windows.IsWindowsNetworkMount(h.Entity) {
 		var err error
 
 		h.LocalFile, err = windows.FormatLocalFilePath(h.LocalFile, h.Entity)

pkg/heartbeat/format_test.go

@@ -54,6 +54,43 @@ func TestWithFormatting(t *testing.T) {
 	}, result)
 }
 
+func TestFormat_NotFileType(t *testing.T) {
+	tests := map[string]heartbeat.EntityType{
+		"app":    heartbeat.AppType,
+		"domain": heartbeat.DomainType,
+		"event":  heartbeat.EventType,
+		"url":    heartbeat.URLType,
+	}
+
+	for name, entityType := range tests {
+		t.Run(name, func(t *testing.T) {
+			h := heartbeat.Heartbeat{
+				Entity:     "/unmodified",
+				EntityType: entityType,
+			}
+
+			formatted := heartbeat.Format(context.Background(), h)
+
+			assert.Equal(t, "/unmodified", formatted.Entity)
+		})
+	}
+}
+
+func TestFormat_WindowsPath(t *testing.T) {
+	if runtime.GOOS != "windows" {
+		t.Skip("Skipping because OS is not windows.")
+	}
+
+	h := heartbeat.Heartbeat{
+		Entity:     `C:\Users\project\main.go`,
+		EntityType: heartbeat.FileType,
+	}
+
+	formatted := heartbeat.Format(context.Background(), h)
+
+	assert.Equal(t, "C:/Users/project/main.go", formatted.Entity)
+}
+
 func TestFormat_NetworkMount(t *testing.T) {
 	if runtime.GOOS != "windows" {
 		t.Skip("Skipping because OS is not windows.")

pkg/windows/windows.go

@@ -39,7 +39,7 @@ var (
 // FormatFilePath formats a windows filepath by converting backslash to
 // frontslash and ensuring that drive letter is upper case.
 func FormatFilePath(fp string) string {
-	isWindowsNetworkMount := windowsNetworkMountRegex.MatchString(fp)
+	isWindowsNetworkMount := IsWindowsNetworkMount(fp)
 
 	fp = backslashReplaceRegex.ReplaceAllString(fp, "/")