Merge pull request #755 from slok/slok/ui

Support time utils

Author: slok

internal/http/backend/app/time_utils.go

@@ -6,20 +6,12 @@ import (
 	"time"
 
 	"github.com/slok/sloth/internal/http/backend/model"
+	utilstime "github.com/slok/sloth/pkg/common/utils/time"
 )
 
 func calculateStepsForTimeRange(from, to time.Time) time.Duration {
 	const autoSteps = 50
-	totalDuration := to.Sub(from)
-	step := totalDuration / time.Duration(autoSteps)
-
-	// Round step to minutes.
-	if step < time.Minute {
-		step = time.Minute
-	}
-	step = (time.Duration(int(step.Minutes())) * time.Minute)
-
-	return step
+	return utilstime.CalculateStepsForTimeRange(from, to, autoSteps)
 }
 
 func sanitizeDataPoints(dps []model.DataPoint, from, to time.Time, step time.Duration) []model.DataPoint {
@@ -47,44 +39,16 @@ func sanitizeDataPoints(dps []model.DataPoint, from, to time.Time, step time.Dur
 	return sanitizedDPs
 }
 
-func roundTimeToDay(t time.Time) time.Time {
-	return time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())
-}
-
-func weekMonday(t time.Time) time.Time {
-	diff := time.Duration(t.Weekday() - 1)
-	if diff < 0 {
-		diff = 6
-	}
-
-	return roundTimeToDay(t).Add(-1 * diff * 24 * time.Hour) // Remove the diff days until monday.
-}
-
-func monthFirst(t time.Time) time.Time {
-	return time.Date(t.Year(), t.Month(), 1, 0, 0, 0, 0, t.Location())
-}
-
-func quarterFirst(t time.Time) time.Time {
-	// Gets the first day of the quarter the time is in.
-	month := ((t.Month()-1)/3)*3 + 1
-	return time.Date(t.Year(), month, 1, 0, 0, 0, 0, t.Location())
-}
-
-func yearFirst(t time.Time) time.Time {
-	// Gets the first day of the year the time is in.
-	return time.Date(t.Year(), 1, 1, 0, 0, 0, 0, t.Location())
-}
-
 func startOfPeriod(t time.Time, periodType BudgetRangeType) (time.Time, error) {
 	switch periodType {
 	case BudgetRangeTypeYearly:
-		return yearFirst(t), nil
+		return utilstime.YearFirst(t), nil
 	case BudgetRangeTypeQuarterly:
-		return quarterFirst(t), nil
+		return utilstime.QuarterFirst(t), nil
 	case BudgetRangeTypeMonthly:
-		return monthFirst(t), nil
+		return utilstime.MonthFirst(t), nil
 	case BudgetRangeTypeWeekly:
-		return weekMonday(t), nil
+		return utilstime.WeekMonday(t), nil
 	}
 
 	return time.Time{}, fmt.Errorf("unknown budget range type: %q", periodType)
@@ -93,15 +57,13 @@ func startOfPeriod(t time.Time, periodType BudgetRangeType) (time.Time, error) {
 func endOfPeriod(t time.Time, periodType BudgetRangeType) (time.Time, error) {
 	switch periodType {
 	case BudgetRangeTypeYearly:
-		return yearFirst(t).Add(365*24*time.Hour - 1), nil
+		return utilstime.EndOfYear(t), nil
 	case BudgetRangeTypeQuarterly:
-		// TODO: This is a simplification, not all months have 30 days.
-		return quarterFirst(t).Add(3*30*24*time.Hour - 1), nil
+		return utilstime.EndOfQuarter(t), nil
 	case BudgetRangeTypeMonthly:
-		// TODO: This is a simplification, not all months have 30 days.
-		return monthFirst(t).Add(30*24*time.Hour - 1), nil
+		return utilstime.EndOfMonth(t), nil
 	case BudgetRangeTypeWeekly:
-		return weekMonday(t).Add(7*24*time.Hour - 1), nil
+		return utilstime.EndOfWeek(t), nil
 	}
 
 	return time.Time{}, fmt.Errorf("unknown budget range type: %q", periodType)

pkg/common/utils/time/time_utils.go

@@ -0,0 +1,99 @@
+package time
+
+import (
+	"time"
+)
+
+// CalculateStepsForTimeRange calculates the step duration for a given time range and number of steps.
+func CalculateStepsForTimeRange(from, to time.Time, steps int) time.Duration {
+	totalDuration := to.Sub(from)
+	step := totalDuration / time.Duration(steps)
+
+	// Round step to minutes.
+	if step < time.Minute {
+		step = time.Minute
+	}
+	step = (time.Duration(int(step.Minutes())) * time.Minute)
+
+	return step
+}
+
+// RoundTimeToDay rounds a time to the start of the day (00:00:00).
+func RoundTimeToDay(t time.Time) time.Time {
+	return time.Date(t.Year(), t.Month(), t.Day(), 0, 0, 0, 0, t.Location())
+}
+
+// WeekMonday returns the Monday of the week for the given time.
+func WeekMonday(t time.Time) time.Time {
+	diff := time.Duration(t.Weekday() - 1)
+	if diff < 0 {
+		diff = 6
+	}
+
+	return RoundTimeToDay(t).Add(-1 * diff * 24 * time.Hour) // Remove the diff days until monday.
+}
+
+// MonthFirst returns the first TS of the month for the given time.
+func MonthFirst(t time.Time) time.Time {
+	return time.Date(t.Year(), t.Month(), 1, 0, 0, 0, 0, t.Location())
+}
+
+// QuarterFirst returns the first TS of the quarter for the given time.
+func QuarterFirst(t time.Time) time.Time {
+	// Gets the first day of the quarter the time is in.
+	month := ((t.Month()-1)/3)*3 + 1
+	return time.Date(t.Year(), month, 1, 0, 0, 0, 0, t.Location())
+}
+
+// YearFirst returns the first TS of the year for the given time.
+func YearFirst(t time.Time) time.Time {
+	// Gets the first day of the year the time is in.
+	return time.Date(t.Year(), 1, 1, 0, 0, 0, 0, t.Location())
+}
+
+// EndOfWeek returns the last TS of the week for the given time.
+func EndOfWeek(t time.Time) time.Time {
+	return WeekMonday(t).Add(7*24*time.Hour - 1)
+}
+
+// EndOfMonth returns the last TS of the month for the given time.
+func EndOfMonth(t time.Time) time.Time {
+	return SetEndOfDay(LastDayOfMonth(t))
+}
+
+// EndOfQuarter returns the last TS of the quarter for the given time.
+func EndOfQuarter(t time.Time) time.Time {
+	qf := QuarterFirst(t)
+	qe := NextMonths(qf, 2) // We are at first month of quarter, add 2 to get to last month.
+	return SetEndOfDay(LastDayOfMonth(qe))
+}
+
+func EndOfYear(t time.Time) time.Time {
+	nextYear := time.Date(t.Year()+1, 1, 1, 0, 0, 0, 0, t.Location())
+	return SetEndOfDay(nextYear.Add(-24 * time.Hour))
+}
+
+// LastDayOfMonth returns the last day of the month for the given time.
+func LastDayOfMonth(t time.Time) time.Time {
+	year := t.Year()
+	firstOfNextMonth := time.Date(year, t.Month()+1, 1, 0, 0, 0, 0, t.Location())
+	lastOfMonth := firstOfNextMonth.Add(-24 * time.Hour)
+	return lastOfMonth
+}
+
+// NextMonths returns the time after adding the specified number of months to the given time.
+func NextMonths(t time.Time, months int) time.Time {
+	year := t.Year()
+	month := t.Month() + time.Month(months)
+	if month > 12 {
+		month = month % 12
+		year++
+	}
+
+	return time.Date(year, month, t.Day(), t.Hour(), t.Minute(), t.Second(), t.Nanosecond(), t.Location())
+}
+
+// SetEndOfDay sets the time to the end of the day (23:59:59.999999999) in a given TS.
+func SetEndOfDay(t time.Time) time.Time {
+	return time.Date(t.Year(), t.Month(), t.Day(), 23, 59, 59, 999999999, t.Location())
+}