Improve UI for StartTime and fix StartTime struct

garden-app/integration_tests/main_test.go

@@ -161,7 +161,7 @@ func GardenTests(t *testing.T) {
  // Create new Garden with LightOnTime in the near future, so LightDelay will assume the light is currently off,
  // meaning adhoc action is going to be predictably delayed
  maxZones := uint(1)
- startTime := &pkg.StartTime{time.Now().In(time.Local).Add(1 * time.Second).Truncate(time.Second)}
+ startTime := pkg.NewStartTime(time.Now().In(time.Local).Add(1 * time.Second).Truncate(time.Second))
  newGarden := &pkg.Garden{
  Name: "TestGarden",
  TopicPrefix: "test",
@@ -197,7 +197,7 @@ func GardenTests(t *testing.T) {
  status, err = makeRequest(http.MethodGet, fmt.Sprintf("/gardens/%s", g.ID.String()), http.NoBody, &getG)
  assert.NoError(t, err)
  assert.Equal(t, http.StatusOK, status)
- assert.Equal(t, startTime.Add(1*time.Second), getG.NextLightAction.Time.Local())
+ assert.Equal(t, startTime.Time.Add(1*time.Second), getG.NextLightAction.Time.Local())
 
  time.Sleep(3 * time.Second)
 
@@ -209,7 +209,7 @@ func GardenTests(t *testing.T) {
  })
  t.Run("ChangeLightScheduleStartTimeResetsLightSchedule", func(t *testing.T) {
  // Reschedule Light to turn in in 1 second, for 1 second
- newStartTime := &pkg.StartTime{time.Now().Add(1 * time.Second).Truncate(time.Second)}
+ newStartTime := pkg.NewStartTime(time.Now().Add(1 * time.Second).Truncate(time.Second))
  var g server.GardenResponse
  status, err := makeRequest(http.MethodPatch, "/gardens/"+gardenID, pkg.Garden{
  LightSchedule: &pkg.LightSchedule{
@@ -228,7 +228,7 @@ func GardenTests(t *testing.T) {
  status, err = makeRequest(http.MethodGet, "/gardens/"+gardenID, nil, &g2)
  assert.NoError(t, err)
  assert.Equal(t, http.StatusOK, status)
- assert.Equal(t, newStartTime.String(), (&pkg.StartTime{g2.NextLightAction.Time.Local()}).String())
+ assert.Equal(t, newStartTime.String(), pkg.NewStartTime(g2.NextLightAction.Time.Local()).String())
  assert.Equal(t, pkg.LightStateOn, g2.NextLightAction.State)
 
  time.Sleep(2 * time.Second)
@@ -371,12 +371,12 @@ func ZoneTests(t *testing.T) {
  newStartTime := time.Now().Add(2 * time.Second).Truncate(time.Second)
  var ws server.WaterScheduleResponse
  status, err := makeRequest(http.MethodPatch, "/water_schedules/"+waterScheduleID, pkg.WaterSchedule{
- StartTime: &pkg.StartTime{newStartTime},
+ StartTime: pkg.NewStartTime(newStartTime),
  Duration: &pkg.Duration{Duration: time.Second},
  }, &ws)
  assert.NoError(t, err)
  assert.Equal(t, http.StatusOK, status)
- assert.Equal(t, (&pkg.StartTime{newStartTime}).String(), ws.WaterSchedule.StartTime.String())
+ assert.Equal(t, pkg.NewStartTime(newStartTime).String(), ws.WaterSchedule.StartTime.String())
 
  time.Sleep(100 * time.Millisecond)
 
@@ -422,12 +422,12 @@ func WaterScheduleTests(t *testing.T) {
  newStartTime := time.Now().Add(2 * time.Second).Truncate(time.Second)
  var ws server.WaterScheduleResponse
  status, err := makeRequest(http.MethodPatch, "/water_schedules/"+waterScheduleID, pkg.WaterSchedule{
- StartTime: &pkg.StartTime{newStartTime},
+ StartTime: pkg.NewStartTime(newStartTime),
  Duration: &pkg.Duration{Duration: time.Second},
  }, &ws)
  assert.NoError(t, err)
  assert.Equal(t, http.StatusOK, status)
- assert.Equal(t, (&pkg.StartTime{newStartTime}).String(), ws.WaterSchedule.StartTime.String())
+ assert.Equal(t, pkg.NewStartTime(newStartTime).String(), ws.WaterSchedule.StartTime.String())
 
  time.Sleep(100 * time.Millisecond)
 

garden-app/pkg/duration_test.go

@@ -2,9 +2,11 @@ package pkg
 
 import (
  "encoding/json"
+ "net/url"
  "testing"
  "time"
 
+ "github.com/ajg/form"
  "github.com/stretchr/testify/assert"
  "gopkg.in/yaml.v3"
 )
@@ -158,3 +160,37 @@ func TestDurationYAMLMarshal(t *testing.T) {
  assert.Equal(t, "cron:*/5 * * * 1\n", string(result))
  })
 }
+
+func TestDurationUnmarshalText(t *testing.T) {
+ tests := []struct {
+ name string
+ input url.Values
+ expected Duration
+ }{
+ {
+ "DurationString",
+ url.Values{
+ "Duration": []string{"1m0s"},
+ },
+ Duration{Duration: 1 * time.Minute},
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ var result struct {
+ Duration Duration
+ }
+ err := form.DecodeString(&result, tt.input.Encode())
+ assert.NoError(t, err)
+ assert.Equal(t, tt.expected, result.Duration)
+
+ var formResult struct {
+ Duration Duration
+ }
+ err = form.DecodeValues(&formResult, tt.input)
+ assert.NoError(t, err)
+ assert.Equal(t, tt.expected, formResult.Duration)
+ })
+ }
+}

garden-app/pkg/garden.go

@@ -158,9 +158,12 @@ func (g *Garden) Bind(r *http.Request) error {
  } else if *g.MaxZones == 0 {
  return errors.New("max_zones must not be 0")
  }
- // consider empty LightSchedule as nil
- if g.LightSchedule != nil && (g.LightSchedule.Duration == nil || g.LightSchedule.Duration.Duration == 0) && g.LightSchedule.StartTime == nil {
- g.LightSchedule = nil
+ // consider empty LightSchedule as nil for removing from HTML form
+ if g.LightSchedule != nil && (g.LightSchedule.Duration == nil || g.LightSchedule.Duration.Duration == 0) {
+ startTimeEmpty := g.LightSchedule.StartTime == nil || g.LightSchedule.StartTime.Time.IsZero()
+ if startTimeEmpty {
+ g.LightSchedule = nil
+ }
  }
  if g.LightSchedule != nil {
  if g.LightSchedule.Duration == nil {
@@ -185,6 +188,12 @@ func (g *Garden) Bind(r *http.Request) error {
  }
 
  if g.LightSchedule != nil {
+ if g.LightSchedule.StartTime != nil {
+ err = g.LightSchedule.StartTime.Validate()
+ if err != nil {
+ return err
+ }
+ }
  // Check that Duration is valid Duration
  if g.LightSchedule.Duration != nil {
  if g.LightSchedule.Duration.Duration >= 24*time.Hour {

garden-app/pkg/garden_test.go

@@ -118,7 +118,7 @@ func TestGardenPatch(t *testing.T) {
  {
  "PatchLightSchedule.StartTime",
  &Garden{LightSchedule: &LightSchedule{
- StartTime: &StartTime{Time: time.Date(0, 1, 1, 15, 4, 0, 0, time.FixedZone("", 0))},
+ StartTime: NewStartTime(time.Date(0, 1, 1, 15, 4, 0, 0, time.FixedZone("", 0))),
  }},
  },
  {
@@ -159,7 +159,7 @@ func TestGardenPatch(t *testing.T) {
  t.Run("RemoveLightSchedule", func(t *testing.T) {
  g := &Garden{
  LightSchedule: &LightSchedule{
- StartTime: &StartTime{Time: time.Date(0, 1, 1, 15, 4, 0, 0, time.FixedZone("", 0))},
+ StartTime: NewStartTime(time.Date(0, 1, 1, 15, 4, 0, 0, time.FixedZone("", 0))),
  Duration: &Duration{2 * time.Hour, ""},
  },
  }

garden-app/pkg/start_time.go

@@ -1,13 +1,10 @@
 package pkg
 
 import (
- "bytes"
  "encoding/json"
  "fmt"
  "strconv"
  "time"
-
- "github.com/ajg/form"
 )
 
 const (
@@ -18,30 +15,43 @@ const (
 // StartTime allows for special handling of Time without the date and also allows several
 // formats for decoding so it is more easily compatible with HTML forms
 type StartTime struct {
- time.Time
-}
+ Time time.Time `form:"-"`
 
-type startTimeSplit struct {
  Hour int
  Minute int
  TZ string
 }
 
-func (st *startTimeSplit) String() string {
- return fmt.Sprintf("%02d:%02d:00%s", st.Hour, st.Minute, st.TZ)
-}
-
 func StartTimeFromString(startTime string) (*StartTime, error) {
  result, err := time.Parse(startTimeFormat, startTime)
  if err != nil {
  return nil, fmt.Errorf("error parsing start time: %w", err)
  }
 
- return &StartTime{result}, nil
+ return &StartTime{Time: result}, nil
+}
+
+func NewStartTime(t time.Time) *StartTime {
+ return &StartTime{Time: t}
 }
 
 func (st *StartTime) String() string {
- return st.Format(startTimeFormat)
+ return st.Time.Format(startTimeFormat)
+}
+
+// Validate is used after parsing from HTML form so the time can be parsed
+func (st *StartTime) Validate() error {
+ if !st.Time.IsZero() {
+ return nil
+ }
+
+ result, err := time.Parse(startTimeFormat, fmt.Sprintf("%02d:%02d:00%s", st.Hour, st.Minute, st.TZ))
+ if err != nil {
+ return err
+ }
+ st.Time = result
+
+ return nil
 }
 
 func (st *StartTime) MarshalJSON() ([]byte, error) {
@@ -60,13 +70,17 @@ func (st *StartTime) UnmarshalJSON(data []byte) error {
  case string:
  timeString = v
  case map[string]any:
- var splitTime startTimeSplit
+ var splitTime struct {
+ Hour int
+ Minute int
+ TZ string
+ }
  err := json.Unmarshal(data, &splitTime)
  if err != nil {
  return err
  }
 
- timeString = splitTime.String()
+ timeString = fmt.Sprintf("%02d:%02d:00%s", splitTime.Hour, splitTime.Minute, splitTime.TZ)
  default:
  return fmt.Errorf("unexpected type %T, must be string or object", v)
  }
@@ -80,26 +94,6 @@ func (st *StartTime) UnmarshalJSON(data []byte) error {
  return nil
 }
 
-func (st *StartTime) UnmarshalText(data []byte) error {
- var timeString string
-
- var splitTime startTimeSplit
- err := form.NewDecoder(bytes.NewBuffer(data)).Decode(&splitTime)
- if err != nil {
- timeString = string(data)
- } else {
- timeString = splitTime.String()
- }
-
- startTime, err := StartTimeFromString(timeString)
- if err != nil {
- return err
- }
- st.Time = startTime.Time
-
- return nil
-}
-
 // TimeLocationFromOffset uses an offset minutes from JS `new Date().getTimezoneOffset()` and parses it into
 // Go's time.Location. JS offsets are positive if they are behind UTC
 func TimeLocationFromOffset(offsetMinutes string) (*time.Location, error) {