schedule: add methods to fetch tz and cron string separately

johnstcn · johnstcn · commit 5f7cf8703940 · 2022-05-13T20:48:58.000Z
diff --git a/coderd/autobuild/schedule/schedule.go b/coderd/autobuild/schedule/schedule.go
@@ -34,12 +34,12 @@ var defaultParser = cron.NewParser(parserFormat)
 //  us_sched, _ := schedule.Weekly("CRON_TZ=US/Central 30 9 1-5")
 //  fmt.Println(sched.Next(time.Now()).Format(time.RFC3339))
 //  // Output: 2022-04-04T14:30:00Z
-func Weekly(spec string) (*Schedule, error) {
-	if err := validateWeeklySpec(spec); err != nil {
+func Weekly(raw string) (*Schedule, error) {
+	if err := validateWeeklySpec(raw); err != nil {
 		return nil, xerrors.Errorf("validate weekly schedule: %w", err)
 	}
 
-	specSched, err := defaultParser.Parse(spec)
+	specSched, err := defaultParser.Parse(raw)
 	if err != nil {
 		return nil, xerrors.Errorf("parse schedule: %w", err)
 	}
@@ -49,9 +49,18 @@ func Weekly(spec string) (*Schedule, error) {
 		return nil, xerrors.Errorf("expected *cron.SpecSchedule but got %T", specSched)
 	}
 
+	tz := "UTC"
+	cron := raw
+	if strings.HasPrefix(raw, "CRON_TZ=") {
+		tz = strings.TrimPrefix(strings.Fields(raw)[0], "CRON_TZ=")
+		cron = strings.Join(strings.Fields(raw)[1:], " ")
+	}
+
 	cronSched := &Schedule{
 		sched: schedule,
-		spec:  spec,
+		raw:   raw,
+		tz:    tz,
+		cron:  cron,
 	}
 	return cronSched, nil
 }
@@ -61,12 +70,25 @@ func Weekly(spec string) (*Schedule, error) {
 type Schedule struct {
 	sched *cron.SpecSchedule
 	// XXX: there isn't any nice way for robfig/cron to serialize
-	spec string
+	raw  string
+	tz   string
+	cron string
 }
 
 // String serializes the schedule to its original human-friendly format.
 func (s Schedule) String() string {
-	return s.spec
+	return s.raw
+}
+
+// Timezone returns the timezone for the schedule.
+func (s Schedule) Timezone() string {
+	return s.tz
+}
+
+// Cron returns the cron spec for the schedule with the leading CRON_TZ
+// stripped, if present.
+func (s Schedule) Cron() string {
+	return s.cron
 }
 
 // Next returns the next time in the schedule relative to t.
diff --git a/coderd/autobuild/schedule/schedule_test.go b/coderd/autobuild/schedule/schedule_test.go
@@ -17,20 +17,26 @@ func Test_Weekly(t *testing.T) {
 		at            time.Time
 		expectedNext  time.Time
 		expectedError string
+		expectedCron  string
+		expectedTz    string
 	}{
 		{
 			name:          "with timezone",
 			spec:          "CRON_TZ=US/Central 30 9 * * 1-5",
 			at:            time.Date(2022, 4, 1, 14, 29, 0, 0, time.UTC),
 			expectedNext:  time.Date(2022, 4, 1, 14, 30, 0, 0, time.UTC),
 			expectedError: "",
+			expectedCron:  "30 9 * * 1-5",
+			expectedTz:    "US/Central",
 		},
 		{
 			name:          "without timezone",
 			spec:          "30 9 * * 1-5",
 			at:            time.Date(2022, 4, 1, 9, 29, 0, 0, time.Local),
 			expectedNext:  time.Date(2022, 4, 1, 9, 30, 0, 0, time.Local),
 			expectedError: "",
+			expectedCron:  "30 9 * * 1-5",
+			expectedTz:    "UTC",
 		},
 		{
 			name:          "invalid schedule",
@@ -86,6 +92,8 @@ func Test_Weekly(t *testing.T) {
 				require.NoError(t, err)
 				require.Equal(t, testCase.expectedNext, nextTime)
 				require.Equal(t, testCase.spec, actual.String())
+				require.Equal(t, testCase.expectedCron, actual.Cron())
+				require.Equal(t, testCase.expectedTz, actual.Timezone())
 			} else {
 				require.EqualError(t, err, testCase.expectedError)
 				require.Nil(t, actual)
