fix: change time format string from 15:40 to 15:04 (coder#14033) (coder#14072)

stirby · angrycub · web-flow · commit d4f8a6481a87 · 2024-08-01T12:34:10.000-05:00
* Change string format to constant value (cherry picked from commit eacdfb9) Co-authored-by: Charlie Voiselle <464492+angrycub@users.noreply.github.com>
diff --git a/enterprise/coderd/users.go b/enterprise/coderd/users.go
@@ -14,6 +14,8 @@ import (
 	"github.com/coder/coder/v2/codersdk"
 )
 
+const TimeFormatHHMM = "15:04"
+
 func (api *API) autostopRequirementEnabledMW(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
 		// Entitlement must be enabled.
@@ -66,7 +68,7 @@ func (api *API) userQuietHoursSchedule(rw http.ResponseWriter, r *http.Request)
 		RawSchedule: opts.Schedule.String(),
 		UserSet:     opts.UserSet,
 		UserCanSet:  opts.UserCanSet,
-		Time:        opts.Schedule.TimeParsed().Format("15:40"),
+		Time:        opts.Schedule.TimeParsed().Format(TimeFormatHHMM),
 		Timezone:    opts.Schedule.Location().String(),
 		Next:        opts.Schedule.Next(time.Now().In(opts.Schedule.Location())),
 	})
@@ -118,7 +120,7 @@ func (api *API) putUserQuietHoursSchedule(rw http.ResponseWriter, r *http.Reques
 		RawSchedule: opts.Schedule.String(),
 		UserSet:     opts.UserSet,
 		UserCanSet:  opts.UserCanSet,
-		Time:        opts.Schedule.TimeParsed().Format("15:40"),
+		Time:        opts.Schedule.TimeParsed().Format(TimeFormatHHMM),
 		Timezone:    opts.Schedule.Location().String(),
 		Next:        opts.Schedule.Next(time.Now().In(opts.Schedule.Location())),
 	})
diff --git a/enterprise/coderd/users_test.go b/enterprise/coderd/users_test.go
@@ -12,11 +12,14 @@ import (
 	"github.com/coder/coder/v2/coderd/rbac"
 	"github.com/coder/coder/v2/coderd/schedule/cron"
 	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/coder/v2/enterprise/coderd"
 	"github.com/coder/coder/v2/enterprise/coderd/coderdenttest"
 	"github.com/coder/coder/v2/enterprise/coderd/license"
 	"github.com/coder/coder/v2/testutil"
 )
 
+const TimeFormatHHMM = coderd.TimeFormatHHMM
+
 func TestUserQuietHours(t *testing.T) {
 	t.Parallel()
 
@@ -42,15 +45,17 @@ func TestUserQuietHours(t *testing.T) {
 
 	t.Run("OK", func(t *testing.T) {
 		t.Parallel()
-
-		defaultQuietHoursSchedule := "CRON_TZ=America/Chicago 0 1 * * *"
+		// Using 10 for minutes lets us test a format bug in which values greater
+		// than 5 were causing the API to explode because the time was returned
+		// incorrectly
+		defaultQuietHoursSchedule := "CRON_TZ=America/Chicago 10 1 * * *"
 		defaultScheduleParsed, err := cron.Daily(defaultQuietHoursSchedule)
 		require.NoError(t, err)
 		nextTime := defaultScheduleParsed.Next(time.Now().In(defaultScheduleParsed.Location()))
 		if time.Until(nextTime) < time.Hour {
 			// Use a different default schedule instead, because we want to avoid
 			// the schedule "ticking over" during this test run.
-			defaultQuietHoursSchedule = "CRON_TZ=America/Chicago 0 13 * * *"
+			defaultQuietHoursSchedule = "CRON_TZ=America/Chicago 10 13 * * *"
 			defaultScheduleParsed, err = cron.Daily(defaultQuietHoursSchedule)
 			require.NoError(t, err)
 		}
@@ -79,7 +84,7 @@ func TestUserQuietHours(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, defaultScheduleParsed.String(), sched1.RawSchedule)
 		require.False(t, sched1.UserSet)
-		require.Equal(t, defaultScheduleParsed.TimeParsed().Format("15:40"), sched1.Time)
+		require.Equal(t, defaultScheduleParsed.TimeParsed().Format(TimeFormatHHMM), sched1.Time)
 		require.Equal(t, defaultScheduleParsed.Location().String(), sched1.Timezone)
 		require.WithinDuration(t, defaultScheduleParsed.Next(time.Now()), sched1.Next, 15*time.Second)
 
@@ -102,7 +107,7 @@ func TestUserQuietHours(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, customScheduleParsed.String(), sched2.RawSchedule)
 		require.True(t, sched2.UserSet)
-		require.Equal(t, customScheduleParsed.TimeParsed().Format("15:40"), sched2.Time)
+		require.Equal(t, customScheduleParsed.TimeParsed().Format(TimeFormatHHMM), sched2.Time)
 		require.Equal(t, customScheduleParsed.Location().String(), sched2.Timezone)
 		require.WithinDuration(t, customScheduleParsed.Next(time.Now()), sched2.Next, 15*time.Second)
 
@@ -111,7 +116,7 @@ func TestUserQuietHours(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, customScheduleParsed.String(), sched3.RawSchedule)
 		require.True(t, sched3.UserSet)
-		require.Equal(t, customScheduleParsed.TimeParsed().Format("15:40"), sched3.Time)
+		require.Equal(t, customScheduleParsed.TimeParsed().Format(TimeFormatHHMM), sched3.Time)
 		require.Equal(t, customScheduleParsed.Location().String(), sched3.Timezone)
 		require.WithinDuration(t, customScheduleParsed.Next(time.Now()), sched3.Next, 15*time.Second)
 
