fix: strip timezone information from a date in dau response

Emyrk · Emyrk · commit af7791206f0c · 2024-01-31T10:37:50.000-06:00
Timezone information is lost, so do not forward it to the client.
diff --git a/coderd/insights_test.go b/coderd/insights_test.go
@@ -39,6 +39,9 @@ import (
 func TestDeploymentInsights(t *testing.T) {
 	t.Parallel()
 
+	clientTz, err := time.LoadLocation("America/Chicago")
+	require.NoError(t, err)
+
 	client := coderdtest.New(t, &coderdtest.Options{
 		IncludeProvisionerDaemon:    true,
 		AgentStatsRefreshInterval:   time.Millisecond * 100,
@@ -64,7 +67,7 @@ func TestDeploymentInsights(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 	defer cancel()
 
-	daus, err := client.DeploymentDAUs(context.Background(), codersdk.TimezoneOffsetHour(time.UTC))
+	daus, err := client.DeploymentDAUs(context.Background(), codersdk.TimezoneOffsetHour(clientTz))
 	require.NoError(t, err)
 
 	res, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{})
@@ -84,22 +87,23 @@ func TestDeploymentInsights(t *testing.T) {
 	_ = sshConn.Close()
 
 	wantDAUs := &codersdk.DAUsResponse{
+		TZHourOffset: codersdk.TimezoneOffsetHour(clientTz),
 		Entries: []codersdk.DAUEntry{
 			{
-				Date:   time.Now().UTC().Truncate(time.Hour * 24),
+				Date:   time.Now().In(clientTz).Format("2006-01-02"),
 				Amount: 1,
 			},
 		},
 	}
 	require.Eventuallyf(t, func() bool {
-		daus, err = client.DeploymentDAUs(ctx, codersdk.TimezoneOffsetHour(time.UTC))
+		daus, err = client.DeploymentDAUs(ctx, codersdk.TimezoneOffsetHour(clientTz))
 		require.NoError(t, err)
 		return len(daus.Entries) > 0
 	},
 		testutil.WaitShort, testutil.IntervalFast,
 		"deployment daus never loaded",
 	)
-	gotDAUs, err := client.DeploymentDAUs(ctx, codersdk.TimezoneOffsetHour(time.UTC))
+	gotDAUs, err := client.DeploymentDAUs(ctx, codersdk.TimezoneOffsetHour(clientTz))
 	require.NoError(t, err)
 	require.Equal(t, gotDAUs, wantDAUs)
 
diff --git a/coderd/metricscache/metricscache.go b/coderd/metricscache/metricscache.go
@@ -166,7 +166,9 @@ func convertDAUResponse[T dauRow](rows []T, tzOffset int) codersdk.DAUsResponse
 	var resp codersdk.DAUsResponse
 	for _, date := range fillEmptyDays(dates) {
 		resp.Entries = append(resp.Entries, codersdk.DAUEntry{
-			Date:   date,
+			// This date is truncated to 00:00:00 of the given day, so only
+			// return date information.
+			Date:   date.Format("2006-01-02"),
 			Amount: len(respMap[date]),
 		})
 	}
diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -1405,7 +1405,7 @@ func TestTemplateMetrics(t *testing.T) {
 	wantDAUs := &codersdk.DAUsResponse{
 		Entries: []codersdk.DAUEntry{
 			{
-				Date:   time.Now().UTC().Truncate(time.Hour * 24),
+				Date:   time.Now().UTC().Truncate(time.Hour * 24).Format("2006-01-02"),
 				Amount: 1,
 			},
 		},
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -2168,8 +2168,10 @@ type DAUsResponse struct {
 }
 
 type DAUEntry struct {
-	Date   time.Time `json:"date" format:"date-time"`
-	Amount int       `json:"amount"`
+	// Date is a string formatted as 2024-01-31.
+	// Timezone and time information is not included.
+	Date   string `json:"date"`
+	Amount int    `json:"amount"`
 }
 
 type DAURequest struct {

Original file line number	Diff line number	Diff line change
`@@ -1405,7 +1405,7 @@ func TestTemplateMetrics(t *testing.T) {`
`1405`	`1405`	`wantDAUs := &codersdk.DAUsResponse{`
`1406`	`1406`	`Entries: []codersdk.DAUEntry{`
`1407`	`1407`	`{`
`1408`		`- Date: time.Now().UTC().Truncate(time.Hour * 24),`
	`1408`	`+ Date: time.Now().UTC().Truncate(time.Hour * 24).Format("2006-01-02"),`
`1409`	`1409`	`Amount: 1,`
`1410`	`1410`	`},`
`1411`	`1411`	`},`
Original file line number	Diff line number	Diff line change
`@@ -2168,8 +2168,10 @@ type DAUsResponse struct {`
`2168`	`2168`	`}`
`2169`	`2169`
`2170`	`2170`	`type DAUEntry struct {`
`2171`		- Date time.Time `json:"date" format:"date-time"`
`2172`		- Amount int `json:"amount"`
	`2171`	`+ // Date is a string formatted as 2024-01-31.`
	`2172`	`+ // Timezone and time information is not included.`
	`2173`	+ Date string `json:"date"`
	`2174`	+ Amount int `json:"amount"`
`2173`	`2175`	`}`
`2174`	`2176`
`2175`	`2177`	`type DAURequest struct {`