comment hell

Author: Trey Ivy

ent/schema/actiondata.go

@@ -35,10 +35,10 @@ func (ActionData) Fields() []ent.Field {
 		// Accumulated CPU time of all spawned actions of this type.
 		// This is only set if all the actions reported a time
 		field.Int64("system_time").
-			//GoType(time.Duration(0)).
 			Optional(),
+
+		// User time spent in millisconds
 		field.Int64("user_time").
-			//GoType(time.Duration(0)).
 			Optional(),
 	}
 }

ent/schema/bazelinvocation.go

@@ -92,14 +92,14 @@ func (BazelInvocation) Edges() []ent.Edge {
 		edge.To("problems", BazelInvocationProblem.Type).
 			Annotations(entgql.Skip(entgql.SkipType)),
 
-		//Build Metrics for the Completed Invocation
+		// Build Metrics for the Completed Invocation
 		edge.To("metrics", Metrics.Type).
 			Unique(),
 
-		//Test Data for the completed Invocation
+		// Test Data for the completed Invocation
 		edge.To("test_collection", TestCollection.Type),
 
-		//Target Data for the completed Invocation
+		// Target Data for the completed Invocation
 		edge.To("targets", TargetPair.Type),
 	}
 }

ent/schema/buildgraphmetrics.go

@@ -76,8 +76,7 @@ func (BuildGraphMetrics) Edges() []ent.Edge {
 	return []ent.Edge{
 		edge.From("metrics", Metrics.Type).
 			Ref("build_graph_metrics"),
-
-		//NOTE: these are all missing from the proto, but i'm including them here for now for completeness
+		// NOTE: these are all missing from the proto, but i'm including them here for now for completeness
 
 		// Dirtied Values.
 		// Number of SkyValues that were dirtied during the build. Dirtied nodes are

ent/schema/resourceusage.go

@@ -14,7 +14,7 @@ type ResourceUsage struct {
 // Fields of the ResourceUsage.
 func (ResourceUsage) Fields() []ent.Field {
 	return []ent.Field{
-		//NOTE: not currently implemented on the proto but included here for completeness
+		// NOTE: not currently implemented on the proto but included here for completeness
 		// The name.
 		field.String("name").Optional(),
 

ent/schema/targetcomplete.go

@@ -46,7 +46,7 @@ func (TargetComplete) Fields() []ent.Field {
 				"ENORMOUS").
 			Optional(),
 
-		//TODO: implement failure detail.
+		// TODO: implement failure detail.
 	}
 }
 

ent/schema/timingbreakdown.go

@@ -18,7 +18,7 @@ func (TimingBreakdown) Fields() []ent.Field {
 		field.String("name").Optional(),
 
 		// Time spent ding the activity (duration).
-		//NOTE: proto has this as an int, but implemented as a string
+		// NOTE: proto has this as an int, but implemented as a string
 		field.String("time").Optional(),
 	}
 }

internal/graphql/custom.resolvers.go

@@ -119,7 +119,8 @@ func (act SaveActor) saveBazelInvocation(
 	buildRecord *ent.Build,
 	metrics *ent.Metrics,
 	tests []*ent.TestCollection,
-	targets []*ent.TargetPair) (*ent.BazelInvocation, error) {
+	targets []*ent.TargetPair,
+) (*ent.BazelInvocation, error) {
 	create := act.db.BazelInvocation.Create().
 		SetInvocationID(uuid.MustParse(summary.InvocationID)).
 		SetStartedAt(summary.StartedAt).
@@ -192,7 +193,7 @@ func (act SaveActor) saveOutputGroup(ctx context.Context, ouputGroup summary.Out
 		SetName(ouputGroup.Name).
 		SetIncomplete(ouputGroup.Incomplete).
 		AddInlineFiles(inlineFiles...).
-		//TODO: implement named set of files logic to recursively add files to this collection
+		// TODO: implement named set of files logic to recursively add files to this collection
 		Save(ctx)
 }
 
@@ -225,8 +226,8 @@ func (act SaveActor) saveTargetCompletion(ctx context.Context, targetCompletion
 }
 
 func (act SaveActor) saveTargetPair(ctx context.Context, targetPair summary.TargetPair, label string) (*ent.TargetPair, error) {
-	var configuration = targetPair.Configuration
-	var completion = targetPair.Completion
+	configuration := targetPair.Configuration
+	completion := targetPair.Completion
 
 	targetConfiguration, err := act.saveTargetConfiguration(ctx, configuration)
 	if err != nil {
@@ -259,7 +260,7 @@ func (act SaveActor) saveTargetPair(ctx context.Context, targetPair summary.Targ
 // ironically, MapBulkCreate doesn't work for the map(string)TargetPair.  Its expecting an int index, not a label.
 func (act SaveActor) saveTargets(ctx context.Context, summary *summary.Summary) ([]*ent.TargetPair, error) {
 	var result []*ent.TargetPair = make([]*ent.TargetPair, len(summary.Targets))
-	var i = 0
+	i := 0
 	for label, pair := range summary.Targets {
 		targetPair, err := act.saveTargetPair(ctx, pair, label)
 		if err != nil {
@@ -354,7 +355,7 @@ func (act SaveActor) saveTestResults(ctx context.Context, testResults []summary.
 			SetTestAttemptDuration(testResult.TestAttemptDuration).
 			SetTestAttemptStart(testResult.TestAttemptStart).
 			SetExecutionInfo(executionInfo)
-		//TODO: implement test action output AddTestActionOutput()
+		// TODO: implement test action output AddTestActionOutput()
 	}).Save(ctx)
 }
 
@@ -381,7 +382,7 @@ func (act SaveActor) saveTestCollection(ctx context.Context, testCollection summ
 
 func (act SaveActor) saveTests(ctx context.Context, summary *summary.Summary) ([]*ent.TestCollection, error) {
 	var result []*ent.TestCollection = make([]*ent.TestCollection, len(summary.Tests))
-	var i = 0
+	i := 0
 	for label, collection := range summary.Tests {
 		testCollection, err := act.saveTestCollection(ctx, collection, label)
 		if err != nil {
@@ -420,7 +421,7 @@ func (act SaveActor) saveRunnerCounts(ctx context.Context, runnerCounts []summar
 	return act.db.RunnerCount.MapCreateBulk(runnerCounts, func(create *ent.RunnerCountCreate, i int) {
 		runnerCount := runnerCounts[i]
 		create.
-			//TODO is there a better type for unsigned int?
+			// TODO is there a better type for unsigned int?
 			SetActionsExecuted(int64(runnerCount.Count)).
 			SetName(runnerCount.Name).
 			SetExecKind(runnerCount.ExecKind)
@@ -464,7 +465,7 @@ func (act SaveActor) saveActionSummary(ctx context.Context, actionSummary summar
 		Save(ctx)
 }
 func (act SaveActor) saveBuildGraphMetrics(ctx context.Context, buildGraphMetrics summary.BuildGraphMetrics) (*ent.BuildGraphMetrics, error) {
-	//TODO:implement EvalutionStats once they exist on the proto
+	// TODO:implement EvalutionStats once they exist on the proto
 	return act.db.BuildGraphMetrics.Create().
 		SetActionLookupValueCount(buildGraphMetrics.ActionLookupValueCount).
 		SetActionLookupValueCountNotIncludingAspects(buildGraphMetrics.ActionLookupValueCountNotIncludingAspects).
@@ -529,6 +530,7 @@ func (act SaveActor) savePackageMetrics(ctx context.Context, packageMetrics summ
 		AddPackageLoadMetrics(packageLoadMetrics...).
 		Save(ctx)
 }
+
 func (act SaveActor) saveCumulativeMetrics(ctx context.Context, cumulativeMetrics summary.CumulativeMetrics) (*ent.CumulativeMetrics, error) {
 	return act.db.CumulativeMetrics.Create().
 		SetNumAnalyses(cumulativeMetrics.NumAnalyses).

pkg/processing/save.go

@@ -118,7 +118,6 @@ func (s Summarizer) ProcessEvent(buildEvent *events.BuildEvent) error {
 		s.handleTargetConfigured(buildEvent.GetConfigured(), buildEvent.GetTargetConfiguredLabel(), time.Now())
 
 	case *bes.BuildEventId_TargetCompleted:
-		//is ths an aborted event?
 		s.handleTargetCompleted(buildEvent.GetCompleted(), buildEvent.GetTargetCompletedLabel(), buildEvent.GetAborted(), time.Now())
 
 	case *bes.BuildEventId_Fetch:
@@ -193,7 +192,7 @@ func (s Summarizer) handleTargetConfigured(target *bes.TargetConfigured, label s
 			TestSize:      TestSize(target.TestSize),
 			Tag:           target.Tag,
 		},
-		Success:    false, //set it to false, change it when we get a complete
+		Success:    false, // set it to false, change it when we get a complete
 		TargetKind: target.TargetKind,
 		TestSize:   TestSize(target.TestSize),
 	}