formatted comment output

Author: zhouselena

.evergreen/config.yml

@@ -291,7 +291,6 @@ functions:
       params:
         binary: bash
         env:
-          COMMIT: "${github_commit}"
           VERSION_ID: ${version_id}
         include_expansions_in_env: [perf_uri_private_endpoint]
         args: [*task-runner, perf-pr-comment]

internal/cmd/perfcomp/main.go

@@ -8,10 +8,10 @@ package main
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"log"
 	"os"
+	"strings"
 	"time"
 
 	"go.mongodb.org/mongo-driver/v2/bson"
@@ -51,15 +51,40 @@ type RawData struct {
 	FailedRollupAttempts int64 `bson:"failed_rollup_attempts"`
 }
 
+type StableRegion struct {
+	TimeSeriesInfo struct {
+		Project     string                 `bson:"project"`
+		Variant     string                 `bson:"variant"`
+		Task        string                 `bson:"task"`
+		Test        string                 `bson:"test"`
+		Measurement string                 `bson:"measurement"`
+		Args        map[string]interface{} `bson:"args"`
+	}
+	Start                  interface{}   `bson:"start"`
+	End                    interface{}   `bson:"end"`
+	Values                 []float64     `bson:"values"`
+	StartOrder             int64         `bson:"start_order"`
+	EndOrder               int64         `bson:"end_order"`
+	Mean                   float64       `bson:"mean"`
+	Std                    float64       `bson:"std"`
+	Median                 float64       `bson:"median"`
+	Max                    float64       `bson:"max"`
+	Min                    float64       `bson:"min"`
+	CoefficientOfVariation float64       `bson:"coefficient_of_variation"`
+	LastSuccessfulUpdate   interface{}   `bson:"last_successful_update"`
+	Last                   bool          `bson:"last"`
+	Contexts               []interface{} `bson:"contexts"`
+}
+
 type EnergyStats struct {
-	Benchmark          string
-	Measurement        string
-	PatchVersion       string
-	StableRegionValues []float64
-	PatchValues        []float64
-	E                  float64
-	T                  float64
-	H                  float64
+	Benchmark    string
+	Measurement  string
+	PatchVersion string
+	StableRegion StableRegion
+	PatchValues  []float64
+	E            float64
+	T            float64
+	H            float64
 }
 
 func main() {
@@ -98,9 +123,7 @@ func main() {
 	if err4 != nil {
 		log.Panicf("Error getting raw data: %v", err4)
 	}
-	for _, es := range allEnergyStats {
-		fmt.Printf("%s | %s | E: %f | T: %f | H: %f\n", es.Benchmark, es.Measurement, es.E, es.T, es.H)
-	}
+	fmt.Println(generatePRComment(allEnergyStats, version))
 
 	// Disconnect client
 	err0 := client.Disconnect(context.Background())
@@ -147,7 +170,7 @@ func findRawData(version string, coll *mongo.Collection) ([]RawData, error) {
 	return rawData, nil
 }
 
-func findLastStableRegion(testname string, measurement string, coll *mongo.Collection) ([]float64, error) {
+func findLastStableRegion(testname string, measurement string, coll *mongo.Collection) (*StableRegion, error) {
 	filter := bson.D{
 		{"time_series_info.project", "mongo-go-driver"},
 		{"time_series_info.variant", "perf"},
@@ -157,33 +180,19 @@ func findLastStableRegion(testname string, measurement string, coll *mongo.Colle
 		{"last", true},
 		{"contexts", []string{"GoDriver perf (h-score)"}},
 	}
-	projection := bson.D{
-		{"values", 1},
-	}
-	findOptions := options.FindOne().SetSort(bson.D{{"end", -1}}).SetProjection(projection)
+
+	findOptions := options.FindOne().SetSort(bson.D{{"end", -1}})
 
 	findCtx, cancel := context.WithTimeout(context.Background(), 180*time.Second)
 	defer cancel()
 
-	var result bson.M
-	err := coll.FindOne(findCtx, filter, findOptions).Decode(&result)
+	var sr *StableRegion
+	err := coll.FindOne(findCtx, filter, findOptions).Decode(&sr)
 	if err != nil {
 		return nil, err
 	}
 
-	valuesSlice, ok := result["values"].(bson.A)
-	if !ok {
-		return nil, errors.New("values is not of type bson.A")
-	}
-	var values []float64
-	for _, v := range valuesSlice {
-		number, ok := v.(float64)
-		if !ok {
-			return nil, errors.New("value is not float64")
-		}
-		values = append(values, number)
-	}
-	return values, nil
+	return sr, nil
 }
 
 // For a specific test and measurement
@@ -194,20 +203,20 @@ func getEnergyStatsForOneBenchmark(rd RawData, coll *mongo.Collection) ([]*Energ
 	for i := range rd.Rollups.Stats {
 		measurement := rd.Rollups.Stats[i].Name
 		patchVal := []float64{rd.Rollups.Stats[i].Val}
-		stableRegionVals, err := findLastStableRegion(testname, measurement, coll)
+		stableRegion, err := findLastStableRegion(testname, measurement, coll)
 		if err != nil {
 			return nil, err
 		}
-		e, t, h := GetEnergyStatistics(mat.NewDense(len(stableRegionVals), 1, stableRegionVals), mat.NewDense(1, 1, patchVal))
+		e, t, h := GetEnergyStatistics(mat.NewDense(len(stableRegion.Values), 1, stableRegion.Values), mat.NewDense(1, 1, patchVal))
 		es := EnergyStats{
-			Benchmark:          testname,
-			Measurement:        measurement,
-			PatchVersion:       rd.Info.Version,
-			StableRegionValues: stableRegionVals,
-			PatchValues:        patchVal,
-			E:                  e,
-			T:                  t,
-			H:                  h,
+			Benchmark:    testname,
+			Measurement:  measurement,
+			PatchVersion: rd.Info.Version,
+			StableRegion: *stableRegion,
+			PatchValues:  patchVal,
+			E:            e,
+			T:            t,
+			H:            h,
 		}
 		energyStats = append(energyStats, &es)
 	}
@@ -226,3 +235,26 @@ func getEnergyStatsForAllBenchMarks(patchRawData []RawData, coll *mongo.Collecti
 	}
 	return allEnergyStats, nil
 }
+
+func generatePRComment(energyStats []*EnergyStats, version string) string {
+
+	var comment strings.Builder
+	var testCount int64
+
+	comment.WriteString("# 👋GoDriver Performance\n")
+	fmt.Fprintf(&comment, "The following benchmark tests for version %s had statistically significant changes (i.e., h-score > 0.6):\n", version)
+	comment.WriteString("| Benchmark | Measurement | H-Score | Stable Reg Avg,Med,Std | Patch Value |\n| --- | --- | --- | --- | --- |\n")
+	for _, es := range energyStats {
+		testCount += 1
+		if es.H > 0.6 {
+			fmt.Fprintf(&comment, "| %s | %s | %.4f | %.4f,%.4f,%.4f | %.4f |\n", es.Benchmark, es.Measurement, es.H, es.StableRegion.Mean, es.StableRegion.Median, es.StableRegion.Std, es.PatchValues[0])
+		}
+	}
+
+	if testCount == 0 {
+		comment.WriteString("There were no significant changes to the performance to report.")
+	}
+	comment.WriteString("\n*For a comprehensive view of all microbenchmark results for this PR's commit, please check out the Evergreen perf task for this patch.*")
+
+	return comment.String()
+}