[usage] Fix report generation

Author: easyCZ

components/usage/pkg/controller/reconciler.go

@@ -131,16 +131,16 @@ func (u *UsageReconciler) ReconcileTimeRange(ctx context.Context, from, to time.
 func generateUsageReport(teams []teamWithWorkspaces, maxStopTime time.Time) ([]TeamUsage, error) {
 	var report []TeamUsage
 	for _, team := range teams {
-		var teamTotalRuntime time.Duration
+		var teamTotalRuntime float64
 		for _, workspace := range team.Workspaces {
 			for _, instance := range workspace.Instances {
-				teamTotalRuntime += instance.TotalRuntime(maxStopTime)
+				teamTotalRuntime += instance.WorkspaceRuntimeSeconds(maxStopTime)
 			}
 		}
 
 		report = append(report, TeamUsage{
-			TeamID:            team.TeamID.String(),
-			WorkspacesRuntime: teamTotalRuntime,
+			TeamID:           team.TeamID.String(),
+			WorkspaceSeconds: teamTotalRuntime,
 		})
 	}
 	return report, nil
@@ -312,6 +312,6 @@ func toSet(items []string) []string {
 }
 
 type TeamUsage struct {
-	TeamID            string        `json:"team_id"`
-	WorkspacesRuntime time.Duration `json:"workspaces_runtime"`
+	TeamID           string  `json:"team_id"`
+	WorkspaceSeconds float64 `json:"workspace_seconds"`
 }

components/usage/pkg/controller/reconciler_test.go

@@ -43,7 +43,7 @@ func TestUsageReconciler_ReconcileTimeRange(t *testing.T) {
 				Role:   db.TeamMembershipRole_Member,
 			}
 			workspace := dbtest.NewWorkspace(t, db.Workspace{
-				ID:      "gitpodio-gitpod-gyjr82jkfnd",
+				ID:      "gitpodio-gitpod-gyjr82jkfna",
 				OwnerID: userID,
 			})
 			instances := []db.WorkspaceInstance{
@@ -71,7 +71,7 @@ func TestUsageReconciler_ReconcileTimeRange(t *testing.T) {
 				},
 			}
 
-			expectedRuntime := instances[0].TotalRuntime(scenarioRunTime) + instances[1].TotalRuntime(scenarioRunTime)
+			expectedRuntime := instances[0].WorkspaceRuntimeSeconds(scenarioRunTime) + instances[1].WorkspaceRuntimeSeconds(scenarioRunTime)
 
 			return Scenario{
 				Name:        "oen team with one workspace",
@@ -88,8 +88,57 @@ func TestUsageReconciler_ReconcileTimeRange(t *testing.T) {
 					Teams:                     1,
 					Report: []TeamUsage{
 						{
-							TeamID:            teamID.String(),
-							WorkspacesRuntime: expectedRuntime,
+							TeamID:           teamID.String(),
+							WorkspaceSeconds: expectedRuntime,
+						},
+					},
+				},
+			}
+		})(),
+		(func() Scenario {
+			runTime := time.Date(2022, 05, 31, 23, 59, 59, 999999, time.UTC)
+			teamID, userID := uuid.New(), uuid.New()
+			workspaceID := "gitpodio-gitpod-gyjr82jkfnd"
+			var instances []db.WorkspaceInstance
+			for i := 0; i < 100; i++ {
+				instances = append(instances, db.WorkspaceInstance{
+					ID:           uuid.New(),
+					WorkspaceID:  workspaceID,
+					CreationTime: db.NewVarcharTime(time.Date(2022, 05, 01, 00, 00, 00, 00, time.UTC)),
+					StoppedTime:  db.NewVarcharTime(time.Date(2022, 05, 31, 23, 59, 59, 999999, time.UTC)),
+					Status:       instanceStatus,
+				})
+			}
+
+			return Scenario{
+				Name:    "many long running instances do not overflow number of seconds in usage",
+				NowFunc: func() time.Time { return runTime },
+				Memberships: []db.TeamMembership{
+					{
+						ID:     uuid.New(),
+						TeamID: teamID,
+						UserID: userID,
+						Role:   db.TeamMembershipRole_Member,
+					},
+				},
+				Workspaces: []db.Workspace{
+					dbtest.NewWorkspace(t, db.Workspace{
+						ID:      workspaceID,
+						OwnerID: userID,
+					}),
+				},
+				Instances: instances,
+				Expected: &UsageReconcileStatus{
+					StartTime:                 startOfMay,
+					EndTime:                   startOfJune,
+					WorkspaceInstances:        100,
+					InvalidWorkspaceInstances: 0,
+					Workspaces:                1,
+					Teams:                     1,
+					Report: []TeamUsage{
+						{
+							TeamID:           teamID.String(),
+							WorkspaceSeconds: 9.223372036854766e+11,
 						},
 					},
 				},
@@ -98,18 +147,21 @@ func TestUsageReconciler_ReconcileTimeRange(t *testing.T) {
 	}
 
 	for _, scenario := range scenarios {
-		conn := db.ConnectForTests(t)
-		require.NoError(t, conn.Create(scenario.Memberships).Error)
-		require.NoError(t, conn.Create(scenario.Workspaces).Error)
-		require.NoError(t, conn.Create(scenario.Instances).Error)
+		t.Run(scenario.Name, func(t *testing.T) {
+			conn := db.ConnectForTests(t)
+			require.NoError(t, conn.Create(scenario.Memberships).Error)
+			require.NoError(t, conn.Create(scenario.Workspaces).Error)
+			require.NoError(t, conn.Create(scenario.Instances).Error)
+
+			reconciler := &UsageReconciler{
+				nowFunc: scenario.NowFunc,
+				conn:    conn,
+			}
+			status, err := reconciler.ReconcileTimeRange(context.Background(), startOfMay, startOfJune)
+			require.NoError(t, err)
 
-		reconciler := &UsageReconciler{
-			nowFunc: scenario.NowFunc,
-			conn:    conn,
-		}
-		status, err := reconciler.ReconcileTimeRange(context.Background(), startOfMay, startOfJune)
-		require.NoError(t, err)
+			require.Equal(t, scenario.Expected, status)
+		})
 
-		require.Equal(t, scenario.Expected, status)
 	}
 }

components/usage/pkg/db/workspace_instance.go

@@ -42,16 +42,16 @@ type WorkspaceInstance struct {
 	_ bool `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`
 }
 
-// TotalRuntime computes how long this WorkspaceInstance has been running.
+// WorkspaceRuntimeSeconds computes how long this WorkspaceInstance has been running.
 // If the instance is still running (no stop time set), maxStopTime is used to to compute the duration - this is an upper bound on stop
-func (i *WorkspaceInstance) TotalRuntime(maxStopTime time.Time) time.Duration {
+func (i *WorkspaceInstance) WorkspaceRuntimeSeconds(maxStopTime time.Time) float64 {
 	start := i.StartedTime.Time()
 	stop := maxStopTime
 	if i.StoppedTime.IsSet() {
 		stop = i.StoppedTime.Time()
 	}
 
-	return stop.Sub(start)
+	return stop.Sub(start).Seconds()
 }
 
 // TableName sets the insert table name for this struct type