[WIP] Consolidate duplicate implementations of formatDuration function (#2684)

Copilot · web-flow · commit df7a13a3e5f3 · 2025-10-28T05:48:29.000-07:00
diff --git a/pkg/cli/audit.go b/pkg/cli/audit.go
@@ -15,6 +15,7 @@ import (
 	"github.com/githubnext/gh-aw/pkg/console"
 	"github.com/githubnext/gh-aw/pkg/constants"
 	"github.com/githubnext/gh-aw/pkg/logger"
+	"github.com/githubnext/gh-aw/pkg/timeutil"
 	"github.com/githubnext/gh-aw/pkg/workflow"
 	"github.com/spf13/cobra"
 )
@@ -455,7 +456,7 @@ func generateAuditReport(processedRun ProcessedRun, metrics LogMetrics) string {
 		report.WriteString(fmt.Sprintf("- **Updated**: %s\n", run.UpdatedAt.Format(time.RFC3339)))
 	}
 	if run.Duration > 0 {
-		report.WriteString(fmt.Sprintf("- **Duration**: %s\n", formatDuration(run.Duration)))
+		report.WriteString(fmt.Sprintf("- **Duration**: %s\n", timeutil.FormatDuration(run.Duration)))
 	}
 	report.WriteString(fmt.Sprintf("- **Event**: %s\n", run.Event))
 	report.WriteString(fmt.Sprintf("- **Branch**: %s\n", run.HeadBranch))
@@ -528,7 +529,7 @@ func generateAuditReport(processedRun ProcessedRun, metrics LogMetrics) string {
 			}
 			durationStr := "N/A"
 			if tool.MaxDuration > 0 {
-				durationStr = formatDuration(tool.MaxDuration)
+				durationStr = timeutil.FormatDuration(tool.MaxDuration)
 			}
 			report.WriteString(fmt.Sprintf("| %s | %d | %s | %s | %s |\n",
 				name, tool.CallCount, inputStr, outputStr, durationStr))
diff --git a/pkg/cli/audit_input_size_test.go b/pkg/cli/audit_input_size_test.go
@@ -74,8 +74,8 @@ func TestAuditReportIncludesInputSizes(t *testing.T) {
 	}
 
 	// Verify durations are displayed
-	if !strings.Contains(report, "2s") {
-		t.Error("Report should contain duration 2s")
+	if !strings.Contains(report, "2.0s") && !strings.Contains(report, "2s") {
+		t.Error("Report should contain duration 2.0s or 2s")
 	}
 
 	// Verify the table has the correct number of columns (5: Tool, Calls, Max Input, Max Output, Max Duration)
diff --git a/pkg/cli/audit_report.go b/pkg/cli/audit_report.go
@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/githubnext/gh-aw/pkg/console"
+	"github.com/githubnext/gh-aw/pkg/timeutil"
 	"github.com/githubnext/gh-aw/pkg/workflow"
 	"github.com/githubnext/gh-aw/pkg/workflow/pretty"
 )
@@ -114,7 +115,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {
 		URL:          run.URL,
 	}
 	if run.Duration > 0 {
-		overview.Duration = formatDuration(run.Duration)
+		overview.Duration = timeutil.FormatDuration(run.Duration)
 	}
 
 	// Build metrics
@@ -135,7 +136,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {
 			Conclusion: jobDetail.Conclusion,
 		}
 		if jobDetail.Duration > 0 {
-			job.Duration = formatDuration(jobDetail.Duration)
+			job.Duration = timeutil.FormatDuration(jobDetail.Duration)
 		}
 		jobs = append(jobs, job)
 	}
@@ -174,7 +175,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {
 				existing.MaxOutputSize = toolCall.MaxOutputSize
 			}
 			if toolCall.MaxDuration > 0 {
-				maxDur := formatDuration(toolCall.MaxDuration)
+				maxDur := timeutil.FormatDuration(toolCall.MaxDuration)
 				if existing.MaxDuration == "" || toolCall.MaxDuration > parseDurationString(existing.MaxDuration) {
 					existing.MaxDuration = maxDur
 				}
@@ -187,7 +188,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {
 				MaxOutputSize: toolCall.MaxOutputSize,
 			}
 			if toolCall.MaxDuration > 0 {
-				info.MaxDuration = formatDuration(toolCall.MaxDuration)
+				info.MaxDuration = timeutil.FormatDuration(toolCall.MaxDuration)
 			}
 			toolStats[displayKey] = info
 		}
diff --git a/pkg/cli/logs.go b/pkg/cli/logs.go
@@ -17,6 +17,7 @@ import (
 	"github.com/githubnext/gh-aw/pkg/console"
 	"github.com/githubnext/gh-aw/pkg/constants"
 	"github.com/githubnext/gh-aw/pkg/logger"
+	"github.com/githubnext/gh-aw/pkg/timeutil"
 	"github.com/githubnext/gh-aw/pkg/workflow"
 	"github.com/githubnext/gh-aw/pkg/workflow/pretty"
 	"github.com/sourcegraph/conc/pool"
@@ -1708,7 +1709,7 @@ func displayLogsOverview(processedRuns []ProcessedRun, verbose bool) {
 		// Format duration
 		durationStr := ""
 		if run.Duration > 0 {
-			durationStr = formatDuration(run.Duration)
+			durationStr = timeutil.FormatDuration(run.Duration)
 			totalDuration += run.Duration
 		}
 
@@ -1797,7 +1798,7 @@ func displayLogsOverview(processedRuns []ProcessedRun, verbose bool) {
 		fmt.Sprintf("TOTAL (%d runs)", len(processedRuns)),
 		"",
 		"",
-		formatDuration(totalDuration),
+		timeutil.FormatDuration(totalDuration),
 		formatNumber(totalTokens),
 		fmt.Sprintf("%.3f", totalCost),
 		fmt.Sprintf("%d", totalTurns),
@@ -1837,17 +1838,6 @@ func ExtractLogMetricsFromRun(processedRun ProcessedRun) workflow.LogMetrics {
 	return metrics
 }
 
-// formatDuration formats a duration in a human-readable way
-func formatDuration(d time.Duration) string {
-	if d < time.Minute {
-		return fmt.Sprintf("%.0fs", d.Seconds())
-	}
-	if d < time.Hour {
-		return fmt.Sprintf("%.1fm", d.Minutes())
-	}
-	return fmt.Sprintf("%.1fh", d.Hours())
-}
-
 // formatNumber formats large numbers in a human-readable way (e.g., "1k", "1.2k", "1.12M")
 func formatNumber(n int) string {
 	if n == 0 {
diff --git a/pkg/cli/logs_report.go b/pkg/cli/logs_report.go
@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/githubnext/gh-aw/pkg/console"
+	"github.com/githubnext/gh-aw/pkg/timeutil"
 	"github.com/githubnext/gh-aw/pkg/workflow"
 )
 
@@ -170,14 +171,14 @@ func buildLogsData(processedRuns []ProcessedRun, outputDir string, continuation
 			Branch:           run.HeadBranch,
 		}
 		if run.Duration > 0 {
-			runData.Duration = formatDuration(run.Duration)
+			runData.Duration = timeutil.FormatDuration(run.Duration)
 		}
 		runs = append(runs, runData)
 	}
 
 	summary := LogsSummary{
 		TotalRuns:         len(processedRuns),
-		TotalDuration:     formatDuration(totalDuration),
+		TotalDuration:     timeutil.FormatDuration(totalDuration),
 		TotalTokens:       totalTokens,
 		TotalCost:         totalCost,
 		TotalTurns:        totalTurns,
@@ -241,7 +242,7 @@ func buildToolUsageSummary(processedRuns []ProcessedRun) []ToolUsageSummary {
 					existing.MaxOutputSize = toolCall.MaxOutputSize
 				}
 				if toolCall.MaxDuration > 0 {
-					maxDur := formatDuration(toolCall.MaxDuration)
+					maxDur := timeutil.FormatDuration(toolCall.MaxDuration)
 					if existing.MaxDuration == "" || toolCall.MaxDuration > parseDurationString(existing.MaxDuration) {
 						existing.MaxDuration = maxDur
 					}
@@ -254,7 +255,7 @@ func buildToolUsageSummary(processedRuns []ProcessedRun) []ToolUsageSummary {
 					Runs:          0, // Will be incremented below
 				}
 				if toolCall.MaxDuration > 0 {
-					info.MaxDuration = formatDuration(toolCall.MaxDuration)
+					info.MaxDuration = timeutil.FormatDuration(toolCall.MaxDuration)
 				}
 				toolStats[displayKey] = info
 			}
diff --git a/pkg/cli/logs_test.go b/pkg/cli/logs_test.go
@@ -7,7 +7,6 @@ import (
 	"path/filepath"
 	"strings"
 	"testing"
-	"time"
 
 	"github.com/githubnext/gh-aw/pkg/workflow"
 	"github.com/githubnext/gh-aw/pkg/workflow/pretty"
@@ -38,25 +37,6 @@ func TestDownloadWorkflowLogs(t *testing.T) {
 	os.RemoveAll("./test-logs")
 }
 
-func TestFormatDuration(t *testing.T) {
-	tests := []struct {
-		duration time.Duration
-		expected string
-	}{
-		{30 * time.Second, "30s"},
-		{90 * time.Second, "1.5m"},
-		{2 * time.Hour, "2.0h"},
-		{45 * time.Minute, "45.0m"},
-	}
-
-	for _, tt := range tests {
-		result := formatDuration(tt.duration)
-		if result != tt.expected {
-			t.Errorf("formatDuration(%v) = %q, expected %q", tt.duration, result, tt.expected)
-		}
-	}
-}
-
 func TestFormatNumber(t *testing.T) {
 	tests := []struct {
 		input    int
diff --git a/pkg/logger/logger.go b/pkg/logger/logger.go
@@ -8,6 +8,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/githubnext/gh-aw/pkg/timeutil"
 	"github.com/mattn/go-isatty"
 )
 
@@ -106,9 +107,9 @@ func (l *Logger) Printf(format string, args ...interface{}) {
 
 	message := fmt.Sprintf(format, args...)
 	if l.color != "" {
-		fmt.Fprintf(os.Stderr, "%s%s%s %s +%s\n", l.color, l.namespace, colorReset, message, formatDuration(diff))
+		fmt.Fprintf(os.Stderr, "%s%s%s %s +%s\n", l.color, l.namespace, colorReset, message, timeutil.FormatDuration(diff))
 	} else {
-		fmt.Fprintf(os.Stderr, "%s %s +%s\n", l.namespace, message, formatDuration(diff))
+		fmt.Fprintf(os.Stderr, "%s %s +%s\n", l.namespace, message, timeutil.FormatDuration(diff))
 	}
 }
 
@@ -127,32 +128,12 @@ func (l *Logger) Print(args ...interface{}) {
 
 	message := fmt.Sprint(args...)
 	if l.color != "" {
-		fmt.Fprintf(os.Stderr, "%s%s%s %s +%s\n", l.color, l.namespace, colorReset, message, formatDuration(diff))
+		fmt.Fprintf(os.Stderr, "%s%s%s %s +%s\n", l.color, l.namespace, colorReset, message, timeutil.FormatDuration(diff))
 	} else {
-		fmt.Fprintf(os.Stderr, "%s %s +%s\n", l.namespace, message, formatDuration(diff))
+		fmt.Fprintf(os.Stderr, "%s %s +%s\n", l.namespace, message, timeutil.FormatDuration(diff))
 	}
 }
 
-// formatDuration formats a duration for display like the debug npm package
-func formatDuration(d time.Duration) string {
-	if d < time.Microsecond {
-		return fmt.Sprintf("%dns", d.Nanoseconds())
-	}
-	if d < time.Millisecond {
-		return fmt.Sprintf("%dµs", d.Microseconds())
-	}
-	if d < time.Second {
-		return fmt.Sprintf("%dms", d.Milliseconds())
-	}
-	if d < time.Minute {
-		return fmt.Sprintf("%.1fs", d.Seconds())
-	}
-	if d < time.Hour {
-		return fmt.Sprintf("%.1fm", d.Minutes())
-	}
-	return fmt.Sprintf("%.1fh", d.Hours())
-}
-
 // computeEnabled computes whether a namespace matches the DEBUG patterns
 func computeEnabled(namespace string) bool {
 	patterns := strings.Split(debugEnv, ",")
diff --git a/pkg/logger/logger_test.go b/pkg/logger/logger_test.go
@@ -332,30 +332,6 @@ func TestColorDisabling(t *testing.T) {
 	}
 }
 
-func TestFormatDuration(t *testing.T) {
-	tests := []struct {
-		name     string
-		duration time.Duration
-		want     string
-	}{
-		{"nanoseconds", 500 * time.Nanosecond, "500ns"},
-		{"microseconds", 500 * time.Microsecond, "500µs"},
-		{"milliseconds", 500 * time.Millisecond, "500ms"},
-		{"seconds", 2500 * time.Millisecond, "2.5s"},
-		{"minutes", 90 * time.Second, "1.5m"},
-		{"hours", 90 * time.Minute, "1.5h"},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got := formatDuration(tt.duration)
-			if got != tt.want {
-				t.Errorf("formatDuration(%v) = %q, want %q", tt.duration, got, tt.want)
-			}
-		})
-	}
-}
-
 func TestMatchPattern(t *testing.T) {
 	tests := []struct {
 		name      string
diff --git a/pkg/timeutil/format.go b/pkg/timeutil/format.go
@@ -0,0 +1,27 @@
+package timeutil
+
+import (
+	"fmt"
+	"time"
+)
+
+// FormatDuration formats a duration for display like the debug npm package
+// It provides granular formatting from nanoseconds to hours
+func FormatDuration(d time.Duration) string {
+	if d < time.Microsecond {
+		return fmt.Sprintf("%dns", d.Nanoseconds())
+	}
+	if d < time.Millisecond {
+		return fmt.Sprintf("%dµs", d.Microseconds())
+	}
+	if d < time.Second {
+		return fmt.Sprintf("%dms", d.Milliseconds())
+	}
+	if d < time.Minute {
+		return fmt.Sprintf("%.1fs", d.Seconds())
+	}
+	if d < time.Hour {
+		return fmt.Sprintf("%.1fm", d.Minutes())
+	}
+	return fmt.Sprintf("%.1fh", d.Hours())
+}
diff --git a/pkg/timeutil/format_test.go b/pkg/timeutil/format_test.go

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ import (`
`15`	`15`	`"github.com/githubnext/gh-aw/pkg/console"`
`16`	`16`	`"github.com/githubnext/gh-aw/pkg/constants"`
`17`	`17`	`"github.com/githubnext/gh-aw/pkg/logger"`
	`18`	`+ "github.com/githubnext/gh-aw/pkg/timeutil"`
`18`	`19`	`"github.com/githubnext/gh-aw/pkg/workflow"`
`19`	`20`	`"github.com/spf13/cobra"`
`20`	`21`	`)`
`@@ -455,7 +456,7 @@ func generateAuditReport(processedRun ProcessedRun, metrics LogMetrics) string {`
`455`	`456`	`report.WriteString(fmt.Sprintf("- Updated: %s\n", run.UpdatedAt.Format(time.RFC3339)))`
`456`	`457`	`}`
`457`	`458`	`if run.Duration > 0 {`
`458`		`- report.WriteString(fmt.Sprintf("- Duration: %s\n", formatDuration(run.Duration)))`
	`459`	`+ report.WriteString(fmt.Sprintf("- Duration: %s\n", timeutil.FormatDuration(run.Duration)))`
`459`	`460`	`}`
`460`	`461`	`report.WriteString(fmt.Sprintf("- Event: %s\n", run.Event))`
`461`	`462`	`report.WriteString(fmt.Sprintf("- Branch: %s\n", run.HeadBranch))`
`@@ -528,7 +529,7 @@ func generateAuditReport(processedRun ProcessedRun, metrics LogMetrics) string {`
`528`	`529`	`}`
`529`	`530`	`durationStr := "N/A"`
`530`	`531`	`if tool.MaxDuration > 0 {`
`531`		`- durationStr = formatDuration(tool.MaxDuration)`
	`532`	`+ durationStr = timeutil.FormatDuration(tool.MaxDuration)`
`532`	`533`	`}`
`533`	`534`	`report.WriteString(fmt.Sprintf("\| %s \| %d \| %s \| %s \| %s \|\n",`
`534`	`535`	`name, tool.CallCount, inputStr, outputStr, durationStr))`
Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,8 @@ func TestAuditReportIncludesInputSizes(t *testing.T) {`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`// Verify durations are displayed`
`77`		`- if !strings.Contains(report, "2s") {`
`78`		`- t.Error("Report should contain duration 2s")`
	`77`	`+ if !strings.Contains(report, "2.0s") && !strings.Contains(report, "2s") {`
	`78`	`+ t.Error("Report should contain duration 2.0s or 2s")`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`// Verify the table has the correct number of columns (5: Tool, Calls, Max Input, Max Output, Max Duration)`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ import (`
`9`	`9`	`"time"`
`10`	`10`
`11`	`11`	`"github.com/githubnext/gh-aw/pkg/console"`
	`12`	`+ "github.com/githubnext/gh-aw/pkg/timeutil"`
`12`	`13`	`"github.com/githubnext/gh-aw/pkg/workflow"`
`13`	`14`	`"github.com/githubnext/gh-aw/pkg/workflow/pretty"`
`14`	`15`	`)`
`@@ -114,7 +115,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {`
`114`	`115`	`URL: run.URL,`
`115`	`116`	`}`
`116`	`117`	`if run.Duration > 0 {`
`117`		`- overview.Duration = formatDuration(run.Duration)`
	`118`	`+ overview.Duration = timeutil.FormatDuration(run.Duration)`
`118`	`119`	`}`
`119`	`120`
`120`	`121`	`// Build metrics`
`@@ -135,7 +136,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {`
`135`	`136`	`Conclusion: jobDetail.Conclusion,`
`136`	`137`	`}`
`137`	`138`	`if jobDetail.Duration > 0 {`
`138`		`- job.Duration = formatDuration(jobDetail.Duration)`
	`139`	`+ job.Duration = timeutil.FormatDuration(jobDetail.Duration)`
`139`	`140`	`}`
`140`	`141`	`jobs = append(jobs, job)`
`141`	`142`	`}`
`@@ -174,7 +175,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {`
`174`	`175`	`existing.MaxOutputSize = toolCall.MaxOutputSize`
`175`	`176`	`}`
`176`	`177`	`if toolCall.MaxDuration > 0 {`
`177`		`- maxDur := formatDuration(toolCall.MaxDuration)`
	`178`	`+ maxDur := timeutil.FormatDuration(toolCall.MaxDuration)`
`178`	`179`	`if existing.MaxDuration == "" \|\| toolCall.MaxDuration > parseDurationString(existing.MaxDuration) {`
`179`	`180`	`existing.MaxDuration = maxDur`
`180`	`181`	`}`
`@@ -187,7 +188,7 @@ func buildAuditData(processedRun ProcessedRun, metrics LogMetrics) AuditData {`
`187`	`188`	`MaxOutputSize: toolCall.MaxOutputSize,`
`188`	`189`	`}`
`189`	`190`	`if toolCall.MaxDuration > 0 {`
`190`		`- info.MaxDuration = formatDuration(toolCall.MaxDuration)`
	`191`	`+ info.MaxDuration = timeutil.FormatDuration(toolCall.MaxDuration)`
`191`	`192`	`}`
`192`	`193`	`toolStats[displayKey] = info`
`193`	`194`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import (`
`10`	`10`	`"time"`
`11`	`11`
`12`	`12`	`"github.com/githubnext/gh-aw/pkg/console"`
	`13`	`+ "github.com/githubnext/gh-aw/pkg/timeutil"`
`13`	`14`	`"github.com/githubnext/gh-aw/pkg/workflow"`
`14`	`15`	`)`
`15`	`16`
`@@ -170,14 +171,14 @@ func buildLogsData(processedRuns []ProcessedRun, outputDir string, continuation`
`170`	`171`	`Branch: run.HeadBranch,`
`171`	`172`	`}`
`172`	`173`	`if run.Duration > 0 {`
`173`		`- runData.Duration = formatDuration(run.Duration)`
	`174`	`+ runData.Duration = timeutil.FormatDuration(run.Duration)`
`174`	`175`	`}`
`175`	`176`	`runs = append(runs, runData)`
`176`	`177`	`}`
`177`	`178`
`178`	`179`	`summary := LogsSummary{`
`179`	`180`	`TotalRuns: len(processedRuns),`
`180`		`- TotalDuration: formatDuration(totalDuration),`
	`181`	`+ TotalDuration: timeutil.FormatDuration(totalDuration),`
`181`	`182`	`TotalTokens: totalTokens,`
`182`	`183`	`TotalCost: totalCost,`
`183`	`184`	`TotalTurns: totalTurns,`
`@@ -241,7 +242,7 @@ func buildToolUsageSummary(processedRuns []ProcessedRun) []ToolUsageSummary {`
`241`	`242`	`existing.MaxOutputSize = toolCall.MaxOutputSize`
`242`	`243`	`}`
`243`	`244`	`if toolCall.MaxDuration > 0 {`
`244`		`- maxDur := formatDuration(toolCall.MaxDuration)`
	`245`	`+ maxDur := timeutil.FormatDuration(toolCall.MaxDuration)`
`245`	`246`	`if existing.MaxDuration == "" \|\| toolCall.MaxDuration > parseDurationString(existing.MaxDuration) {`
`246`	`247`	`existing.MaxDuration = maxDur`
`247`	`248`	`}`
`@@ -254,7 +255,7 @@ func buildToolUsageSummary(processedRuns []ProcessedRun) []ToolUsageSummary {`
`254`	`255`	`Runs: 0, // Will be incremented below`
`255`	`256`	`}`
`256`	`257`	`if toolCall.MaxDuration > 0 {`
`257`		`- info.MaxDuration = formatDuration(toolCall.MaxDuration)`
	`258`	`+ info.MaxDuration = timeutil.FormatDuration(toolCall.MaxDuration)`
`258`	`259`	`}`
`259`	`260`	`toolStats[displayKey] = info`
`260`	`261`	`}`