Adjust timezone for ZoneHistory in UI (#201)

Author: calvinmclean

garden-app/server/garden_responses.go

@@ -145,14 +145,7 @@ func (g *GardenResponse) Render(w http.ResponseWriter, r *http.Request) error {
 			State: nextLightState,
 		}
 
-		var loc *time.Location
-		tzHeader := r.Header.Get("X-TZ-Offset")
-		if tzHeader != "" {
-			loc, err = pkg.TimeLocationFromOffset(tzHeader)
-			if err != nil {
-				return fmt.Errorf("error parsing timezone from header: %w", err)
-			}
-		}
+		loc := getLocationFromRequest(r)
 		if loc == nil {
 			loc = g.LightSchedule.StartTime.Time.Location()
 		}

garden-app/server/water_schedule_responses.go

@@ -42,15 +42,7 @@ func GetNextWaterDetails(r *http.Request, ws *pkg.WaterSchedule, worker *worker.
 		return result
 	}
 
-	var loc *time.Location
-	tzHeader := r.Header.Get("X-TZ-Offset")
-	if tzHeader != "" {
-		var err error
-		loc, err = pkg.TimeLocationFromOffset(tzHeader)
-		if err != nil {
-			result.Message = fmt.Sprintf("error parsing timezone from header: %v", err)
-		}
-	}
+	loc := getLocationFromRequest(r)
 	if loc == nil {
 		loc = ws.StartTime.Time.Location()
 	}

garden-app/server/zone.go

@@ -295,7 +295,7 @@ func (api *ZonesAPI) waterHistory(_ http.ResponseWriter, r *http.Request, zone *
 		return nil, apiErr
 	}
 
-	return NewZoneWaterHistoryResponse(history), nil
+	return NewZoneWaterHistoryResponse(history, getLocationFromRequest(r)), nil
 }
 
 func (api *ZonesAPI) getWaterHistoryFromRequest(r *http.Request, zone *pkg.Zone, logger *slog.Logger) ([]pkg.WaterHistory, *babyapi.ErrResponse) {

garden-app/server/zone_responses.go

@@ -117,7 +117,7 @@ func (zr *ZoneResponse) Render(w http.ResponseWriter, r *http.Request) error {
 			logger.Error("error getting water history", "error", apiErr)
 			zr.HistoryError = apiErr.ErrorText
 		}
-		zr.History = NewZoneWaterHistoryResponse(history)
+		zr.History = NewZoneWaterHistoryResponse(history, getLocationFromRequest(r))
 
 		// Reverse history for better presentation in UI
 		slices.Reverse(zr.History.History)
@@ -168,6 +168,18 @@ func (azr AllZonesResponse) Render(w http.ResponseWriter, r *http.Request) error
 	return azr.ResourceList.Render(w, r)
 }
 
+// getLocationFromRequest reads the X-TZ-Offset header and returns the corresponding time.Location
+func getLocationFromRequest(r *http.Request) *time.Location {
+	tzHeader := r.Header.Get("X-TZ-Offset")
+	if tzHeader != "" {
+		loc, err := pkg.TimeLocationFromOffset(tzHeader)
+		if err == nil {
+			return loc
+		}
+	}
+	return nil
+}
+
 func (azr AllZonesResponse) HTML(_ http.ResponseWriter, r *http.Request) string {
 	slices.SortFunc(azr.Items, func(z *ZoneResponse, zz *ZoneResponse) int {
 		return strings.Compare(z.Name, zz.Name)
@@ -199,14 +211,21 @@ type ZoneWaterHistoryResponse struct {
 }
 
 // NewZoneWaterHistoryResponse creates a response by creating some basic statistics about a list of history events
-func NewZoneWaterHistoryResponse(history []pkg.WaterHistory) ZoneWaterHistoryResponse {
+// and converting times to the specified location
+func NewZoneWaterHistoryResponse(history []pkg.WaterHistory, loc *time.Location) ZoneWaterHistoryResponse {
 	total := time.Duration(0)
 	count := 0
-	for _, h := range history {
+	for i, h := range history {
 		if h.Status == pkg.WaterStatusCompleted {
 			total += h.Duration.Duration
 			count++
 		}
+		// Convert times to the target timezone
+		if loc != nil {
+			history[i].SentAt = h.SentAt.In(loc)
+			history[i].StartedAt = h.StartedAt.In(loc)
+			history[i].CompletedAt = h.CompletedAt.In(loc)
+		}
 	}
 
 	average := time.Duration(0)

garden-app/server/zone_test.go

@@ -1105,6 +1105,55 @@ func TestWaterHistory(t *testing.T) {
 		},
 	}
 
+	// Test timezone conversion separately since it requires different setup
+	t.Run("SuccessfulWaterHistoryWithTimezoneConversion", func(t *testing.T) {
+		// Use UTC time in mock data
+		utcTime, _ := time.Parse(time.RFC3339Nano, "2021-10-03T18:24:52.891386Z")
+
+		influxdbClient := new(influxdb.MockClient)
+		influxdbClient.On("GetWaterHistory", mock.Anything, id.String(), "test-garden", time.Hour*72, uint64(5)).
+			Return([]pkg.WaterHistory{
+				{
+					Duration:    pkg.Duration{Duration: 3 * time.Second},
+					Status:      pkg.WaterStatusCompleted,
+					Source:      string(action.SourceCommand),
+					SentAt:      utcTime,
+					StartedAt:   utcTime,
+					CompletedAt: utcTime,
+					EventID:     "00000000000000000000",
+				},
+			}, nil)
+		influxdbClient.On("Close")
+
+		storageClient, err := storage.NewClient(storage.Config{
+			ConnectionString: ":memory:",
+		})
+		assert.NoError(t, err)
+
+		zr := NewZonesAPI()
+		zr.setup(storageClient, influxdbClient, worker.NewWorker(storageClient, influxdbClient, nil, slog.Default()))
+
+		garden := createExampleGarden()
+		zone := createExampleZone()
+
+		err = storageClient.Gardens.Set(context.Background(), garden)
+		assert.NoError(t, err)
+		err = storageClient.Zones.Set(context.Background(), zone)
+		assert.NoError(t, err)
+
+		// Use X-TZ-Offset: 420 (UTC-7 / America/Phoenix) to convert from UTC to Phoenix time
+		r := httptest.NewRequest(http.MethodGet, fmt.Sprintf("/gardens/%s/zones/%s/history", garden.ID, zone.ID), http.NoBody)
+		r.Header.Set("X-TZ-Offset", "420")
+		w := babytest.TestWithParentRoute(t, zr.API, garden, "Gardens", "/gardens", r)
+
+		assert.Equal(t, http.StatusOK, w.Code)
+		// The UTC time should be converted to -07:00 offset (18:24:52 - 7 hours = 11:24:52 local time)
+		expected := `{"history":[{"duration":"3s","event_id":"00000000000000000000","status":"complete","source":"command","sent_at":"2021-10-03T11:24:52.891386-07:00","started_at":"2021-10-03T11:24:52.891386-07:00","completed_at":"2021-10-03T11:24:52.891386-07:00"}],"count":1,"average":"3s","total":"3s"}`
+		assert.Equal(t, expected, strings.TrimSpace(w.Body.String()))
+
+		influxdbClient.AssertExpectations(t)
+	})
+
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			influxdbClient := new(influxdb.MockClient)