Tracker Changes

Now the tool offers manual and auto modes, because of that the tracker needs to change as well since it was built only with the auto mode in mind

Author: AlexsanderHamir

cli/api.go

@@ -94,20 +94,31 @@ func createRunCmd() *cobra.Command {
 
 // createTrackCmd creates the track subcommand
 func createTrackCmd() *cobra.Command {
+	shortExplanation := "Compare performance between two benchmark runs to detect regressions and improvements"
+	cmd := &cobra.Command{
+		Use:   "track",
+		Short: shortExplanation,
+	}
+
+	cmd.AddCommand(createTrackAutoCmd())
+	cmd.AddCommand(createTrackManualCmd())
+
+	return cmd
+}
+
+func createTrackAutoCmd() *cobra.Command {
 	baseTagFlag := "base-tag"
 	currentTagFlag := "current-tag"
 	benchNameFlag := "bench-name"
 	profileTypeFlag := "profile-type"
 	outputFormatFlag := "output-format"
-	example := fmt.Sprintf(`prof track --%s "tag1" --%s "tag2" --%s "cpu" --%s "BenchmarkGenPool" --%s "summary"`, baseTagFlag, currentTagFlag, profileTypeFlag, benchNameFlag, outputFormatFlag)
-	shortExplanation := "Compare performance between two benchmark runs to detect regressions and improvements"
-	longExplanation := "This command only works if the run command was used to collect and organize the benchmark and profile data, as it expects a specific directory structure generated by that process."
+	example := fmt.Sprintf(`prof track auto --%s "tag1" --%s "tag2" --%s "cpu" --%s "BenchmarkGenPool" --%s "summary"`, baseTagFlag, currentTagFlag, profileTypeFlag, benchNameFlag, outputFormatFlag)
+	longExplanation := fmt.Sprintf("This command only works if the %s command was used to collect and organize the benchmark and profile data, as it expects a specific directory structure generated by that process.", shared.AUTOCMD)
 
 	cmd := &cobra.Command{
-		Use:     "track",
-		Short:   shortExplanation,
+		Use:     shared.TrackAutoCMD,
 		Long:    longExplanation,
-		RunE:    runTrack,
+		RunE:    runTrackAuto,
 		Example: example,
 	}
 
@@ -125,6 +136,30 @@ func createTrackCmd() *cobra.Command {
 	return cmd
 }
 
+func createTrackManualCmd() *cobra.Command {
+	baseFlag := "base"
+	currentFlag := "current"
+	outputFormatFlag := "output-format"
+	example := fmt.Sprintf(`prof track %s --%s "path/to/profile_file.txt" --%s  "path/to/profile_file.txt"  --%s "summary"`, shared.TrackManualCMD, baseFlag, currentFlag, outputFormatFlag)
+
+	cmd := &cobra.Command{
+		Use:     shared.TrackManualCMD,
+		Short:   "Manually specify the paths to the profile text files you want to compare.",
+		RunE:    runTrackManual,
+		Example: example,
+	}
+
+	cmd.Flags().StringVar(&baselineTag, baseFlag, "", "Name of the baseline tag")
+	cmd.Flags().StringVar(&currentTag, currentFlag, "", "Name of the current tag")
+	cmd.Flags().StringVar(&outputFormat, outputFormatFlag, "", "Output format choice choice")
+
+	_ = cmd.MarkFlagRequired(baseFlag)
+	_ = cmd.MarkFlagRequired(currentFlag)
+	_ = cmd.MarkFlagRequired(outputFormatFlag)
+
+	return cmd
+}
+
 func createVersionCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:                   "version",
@@ -201,7 +236,7 @@ func runSetup(_ *cobra.Command, _ []string) error {
 }
 
 // runTrack handles the track command execution
-func runTrack(_ *cobra.Command, _ []string) error {
+func runTrackAuto(_ *cobra.Command, _ []string) error {
 	validFormats := map[string]bool{
 		"summary":  true,
 		"detailed": true,
@@ -231,3 +266,33 @@ func runTrack(_ *cobra.Command, _ []string) error {
 
 	return nil
 }
+
+func runTrackManual(_ *cobra.Command, _ []string) error {
+	validFormats := map[string]bool{
+		"summary":  true,
+		"detailed": true,
+	}
+
+	if !validFormats[outputFormat] {
+		return fmt.Errorf("invalid output format '%s'. Valid formats: summary, detailed", outputFormat)
+	}
+
+	report, err := tracker.CheckPerformanceDifferencesManual(baselineTag, currentTag)
+	if err != nil {
+		return fmt.Errorf("failed to track performance differences: %w", err)
+	}
+
+	noFunctionChanges := len(report.FunctionChanges) == 0
+	if noFunctionChanges {
+		slog.Info("No function changes detected between the two runs")
+		return nil
+	}
+
+	switch outputFormat {
+	case "summary":
+		printSummary(report)
+	case "detailed":
+		printDetailedReport(report)
+	}
+	return nil
+}

parser/api.go

@@ -61,8 +61,7 @@ func TurnLinesIntoObjects(profilePath, profileType string) ([]*LineObj, error) {
 	}
 	defer file.Close()
 
-	shouldRemove := true
-	CollectOrRemoveHeader(scanner, profileType, &lines, shouldRemove)
+	CollectOrRemoveHeader(scanner, profileType)
 
 	GetAllProfileLines(scanner, &lines)
 
@@ -152,18 +151,11 @@ func GetAllProfileLines(scanner *bufio.Scanner, lines *[]string) {
 	}
 }
 
-func CollectOrRemoveHeader(scanner *bufio.Scanner, profileType string, lines *[]string, shouldRemove bool) {
-	lineCount := 0
-
-	headerIndex := 6
-	if profileType != "cpu" {
-		headerIndex = 5
-	}
-
-	for lineCount < headerIndex && scanner.Scan() {
-		if !shouldRemove {
-			*lines = append(*lines, scanner.Text())
+func CollectOrRemoveHeader(scanner *bufio.Scanner, profileType string) {
+	for scanner.Scan() {
+		line := scanner.Text()
+		if strings.Contains(line, header) {
+			break
 		}
-		lineCount++
 	}
 }

shared/utils.go

@@ -9,8 +9,10 @@ import (
 
 // CLI Commands
 const (
-	AUTOCMD   = "auto"
-	MANUALCMD = "manual"
+	AUTOCMD        = "auto"
+	MANUALCMD      = "manual"
+	TrackAutoCMD   = AUTOCMD
+	TrackManualCMD = MANUALCMD
 )
 
 const (

tracker/api.go

@@ -44,3 +44,36 @@ func CheckPerformanceDifferences(baselineTag, currentTag, benchName, profileType
 
 	return pgp, nil
 }
+
+// CheckPerformanceDifferences creates the profile report by comparing data from  prof's auto run.
+func CheckPerformanceDifferencesManual(baselineProfile, currentProfile string) (*ProfileChangeReport, error) {
+	lineObjsBaseline, err := parser.TurnLinesIntoObjects(baselineProfile, "")
+	if err != nil {
+		return nil, fmt.Errorf("couldn't get objs for path: %s, error: %w", baselineProfile, err)
+	}
+
+	lineObjsCurrent, err := parser.TurnLinesIntoObjects(currentProfile, "")
+	if err != nil {
+		return nil, fmt.Errorf("couldn't get objs for path: %s, error: %w", currentProfile, err)
+	}
+
+	matchingMap := createHashFromLineObjects(lineObjsBaseline)
+
+	pgp := &ProfileChangeReport{}
+	for _, currentObj := range lineObjsCurrent {
+		baseLineObj, matchNotFound := matchingMap[currentObj.FnName]
+		if !matchNotFound {
+			continue
+		}
+
+		var changeResult *FunctionChangeResult
+		changeResult, err = DetectChange(baseLineObj, currentObj)
+		if err != nil {
+			return nil, fmt.Errorf("DetectChange failed: %w", err)
+		}
+
+		pgp.FunctionChanges = append(pgp.FunctionChanges, changeResult)
+	}
+
+	return pgp, nil
+}