Fix display since time round (#14226) (#14873)

Backport #14226

* Fix display since time round

* Fix since time

* Fix tests

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>

modules/timeutil/since.go

@@ -7,6 +7,7 @@ package timeutil
 import (
 	"fmt"
 	"html/template"
+	"math"
 	"strings"
 	"time"
 
@@ -25,7 +26,11 @@ const (
 	Year   = 12 * Month
 )
 
-func computeTimeDiff(diff int64, lang string) (int64, string) {
+func round(s float64) int64 {
+	return int64(math.Round(s))
+}
+
+func computeTimeDiffFloor(diff int64, lang string) (int64, string) {
 	diffStr := ""
 	switch {
 	case diff <= 0:
@@ -83,6 +88,94 @@ func computeTimeDiff(diff int64, lang string) (int64, string) {
 	return diff, diffStr
 }
 
+func computeTimeDiff(diff int64, lang string) (int64, string) {
+	diffStr := ""
+	switch {
+	case diff <= 0:
+		diff = 0
+		diffStr = i18n.Tr(lang, "tool.now")
+	case diff < 2:
+		diff = 0
+		diffStr = i18n.Tr(lang, "tool.1s")
+	case diff < 1*Minute:
+		diffStr = i18n.Tr(lang, "tool.seconds", diff)
+		diff = 0
+
+	case diff < Minute+Minute/2:
+		diff -= 1 * Minute
+		diffStr = i18n.Tr(lang, "tool.1m")
+	case diff < 1*Hour:
+		minutes := round(float64(diff) / Minute)
+		if minutes > 1 {
+			diffStr = i18n.Tr(lang, "tool.minutes", minutes)
+		} else {
+			diffStr = i18n.Tr(lang, "tool.1m")
+		}
+		diff -= diff / Minute * Minute
+
+	case diff < Hour+Hour/2:
+		diff -= 1 * Hour
+		diffStr = i18n.Tr(lang, "tool.1h")
+	case diff < 1*Day:
+		hours := round(float64(diff) / Hour)
+		if hours > 1 {
+			diffStr = i18n.Tr(lang, "tool.hours", hours)
+		} else {
+			diffStr = i18n.Tr(lang, "tool.1h")
+		}
+		diff -= diff / Hour * Hour
+
+	case diff < Day+Day/2:
+		diff -= 1 * Day
+		diffStr = i18n.Tr(lang, "tool.1d")
+	case diff < 1*Week:
+		days := round(float64(diff) / Day)
+		if days > 1 {
+			diffStr = i18n.Tr(lang, "tool.days", days)
+		} else {
+			diffStr = i18n.Tr(lang, "tool.1d")
+		}
+		diff -= diff / Day * Day
+
+	case diff < Week+Week/2:
+		diff -= 1 * Week
+		diffStr = i18n.Tr(lang, "tool.1w")
+	case diff < 1*Month:
+		weeks := round(float64(diff) / Week)
+		if weeks > 1 {
+			diffStr = i18n.Tr(lang, "tool.weeks", weeks)
+		} else {
+			diffStr = i18n.Tr(lang, "tool.1w")
+		}
+		diff -= diff / Week * Week
+
+	case diff < 1*Month+Month/2:
+		diff -= 1 * Month
+		diffStr = i18n.Tr(lang, "tool.1mon")
+	case diff < 1*Year:
+		months := round(float64(diff) / Month)
+		if months > 1 {
+			diffStr = i18n.Tr(lang, "tool.months", months)
+		} else {
+			diffStr = i18n.Tr(lang, "tool.1mon")
+		}
+		diff -= diff / Month * Month
+
+	case diff < Year+Year/2:
+		diff -= 1 * Year
+		diffStr = i18n.Tr(lang, "tool.1y")
+	default:
+		years := round(float64(diff) / Year)
+		if years > 1 {
+			diffStr = i18n.Tr(lang, "tool.years", years)
+		} else {
+			diffStr = i18n.Tr(lang, "tool.1y")
+		}
+		diff -= (diff / Year) * Year
+	}
+	return diff, diffStr
+}
+
 // MinutesToFriendly returns a user friendly string with number of minutes
 // converted to hours and minutes.
 func MinutesToFriendly(minutes int, lang string) string {
@@ -111,7 +204,7 @@ func timeSincePro(then, now time.Time, lang string) string {
 			break
 		}
 
-		diff, diffStr = computeTimeDiff(diff, lang)
+		diff, diffStr = computeTimeDiffFloor(diff, lang)
 		timeStr += ", " + diffStr
 	}
 	return strings.TrimPrefix(timeStr, ", ")

modules/timeutil/since_test.go

@@ -5,6 +5,7 @@
 package timeutil
 
 import (
+	"fmt"
 	"os"
 	"testing"
 	"time"
@@ -47,27 +48,39 @@ func TestTimeSince(t *testing.T) {
 
 	// test that each diff in `diffs` yields the expected string
 	test := func(expected string, diffs ...time.Duration) {
+		t.Run(expected, func(t *testing.T) {
 			for _, diff := range diffs {
 				actual := timeSince(BaseDate, BaseDate.Add(diff), "en")
 				assert.Equal(t, i18n.Tr("en", "tool.ago", expected), actual)
 				actual = timeSince(BaseDate.Add(diff), BaseDate, "en")
 				assert.Equal(t, i18n.Tr("en", "tool.from_now", expected), actual)
 			}
+		})
 	}
 	test("1 second", time.Second, time.Second+50*time.Millisecond)
 	test("2 seconds", 2*time.Second, 2*time.Second+50*time.Millisecond)
-	test("1 minute", time.Minute, time.Minute+30*time.Second)
+	test("1 minute", time.Minute, time.Minute+29*time.Second)
-	test("2 minutes", 2*time.Minute, 2*time.Minute+30*time.Second)
+	test("2 minutes", 2*time.Minute, time.Minute+30*time.Second)
-	test("1 hour", time.Hour, time.Hour+30*time.Minute)
+	test("2 minutes", 2*time.Minute, 2*time.Minute+29*time.Second)
-	test("2 hours", 2*time.Hour, 2*time.Hour+30*time.Minute)
+	test("1 hour", time.Hour, time.Hour+29*time.Minute)
-	test("1 day", DayDur, DayDur+12*time.Hour)
+	test("2 hours", 2*time.Hour, time.Hour+30*time.Minute)
-	test("2 days", 2*DayDur, 2*DayDur+12*time.Hour)
+	test("2 hours", 2*time.Hour, 2*time.Hour+29*time.Minute)
+	test("3 hours", 3*time.Hour, 2*time.Hour+30*time.Minute)
+	test("1 day", DayDur, DayDur+11*time.Hour)
+	test("2 days", 2*DayDur, DayDur+12*time.Hour)
+	test("2 days", 2*DayDur, 2*DayDur+11*time.Hour)
+	test("3 days", 3*DayDur, 2*DayDur+12*time.Hour)
 	test("1 week", WeekDur, WeekDur+3*DayDur)
+	test("2 weeks", 2*WeekDur, WeekDur+4*DayDur)
 	test("2 weeks", 2*WeekDur, 2*WeekDur+3*DayDur)
-	test("1 month", MonthDur, MonthDur+15*DayDur)
+	test("3 weeks", 3*WeekDur, 2*WeekDur+4*DayDur)
-	test("2 months", 2*MonthDur, 2*MonthDur+15*DayDur)
+	test("1 month", MonthDur, MonthDur+14*DayDur)
-	test("1 year", YearDur, YearDur+6*MonthDur)
+	test("2 months", 2*MonthDur, MonthDur+15*DayDur)
-	test("2 years", 2*YearDur, 2*YearDur+6*MonthDur)
+	test("2 months", 2*MonthDur, 2*MonthDur+14*DayDur)
+	test("1 year", YearDur, YearDur+5*MonthDur)
+	test("2 years", 2*YearDur, YearDur+6*MonthDur)
+	test("2 years", 2*YearDur, 2*YearDur+5*MonthDur)
+	test("3 years", 3*YearDur, 2*YearDur+6*MonthDur)
 }
 
 func TestTimeSincePro(t *testing.T) {
@@ -114,11 +127,11 @@ func TestHtmlTimeSince(t *testing.T) {
 	}
 	test("1 second", time.Second)
 	test("3 minutes", 3*time.Minute+5*time.Second)
-	test("1 day", DayDur+18*time.Hour)
+	test("1 day", DayDur+11*time.Hour)
-	test("1 week", WeekDur+6*DayDur)
+	test("1 week", WeekDur+3*DayDur)
-	test("3 months", 3*MonthDur+3*WeekDur)
+	test("3 months", 3*MonthDur+2*WeekDur)
 	test("2 years", 2*YearDur)
-	test("3 years", 3*YearDur+11*MonthDur+4*WeekDur)
+	test("3 years", 2*YearDur+11*MonthDur+4*WeekDur)
 }
 
 func TestComputeTimeDiff(t *testing.T) {
@@ -126,26 +139,35 @@ func TestComputeTimeDiff(t *testing.T) {
 	// computeTimeDiff(base + offset) == (offset, str)
 	test := func(base int64, str string, offsets ...int64) {
 		for _, offset := range offsets {
+			t.Run(fmt.Sprintf("%s:%d", str, offset), func(t *testing.T) {
 				diff, diffStr := computeTimeDiff(base+offset, "en")
 				assert.Equal(t, offset, diff)
 				assert.Equal(t, str, diffStr)
+			})
 		}
 	}
 	test(0, "now", 0)
 	test(1, "1 second", 0)
 	test(2, "2 seconds", 0)
-	test(Minute, "1 minute", 0, 1, 30, Minute-1)
+	test(Minute, "1 minute", 0, 1, 29)
-	test(2*Minute, "2 minutes", 0, Minute-1)
+	test(Minute, "2 minutes", 30, Minute-1)
-	test(Hour, "1 hour", 0, 1, Hour-1)
+	test(2*Minute, "2 minutes", 0, 29)
-	test(5*Hour, "5 hours", 0, Hour-1)
+	test(2*Minute, "3 minutes", 30, Minute-1)
-	test(Day, "1 day", 0, 1, Day-1)
+	test(Hour, "1 hour", 0, 1, 29*Minute)
-	test(5*Day, "5 days", 0, Day-1)
+	test(Hour, "2 hours", 30*Minute, Hour-1)
-	test(Week, "1 week", 0, 1, Week-1)
+	test(5*Hour, "5 hours", 0, 29*Minute)
-	test(3*Week, "3 weeks", 0, 4*Day+25000)
+	test(Day, "1 day", 0, 1, 11*Hour)
-	test(Month, "1 month", 0, 1, Month-1)
+	test(Day, "2 days", 12*Hour, Day-1)
-	test(10*Month, "10 months", 0, Month-1)
+	test(5*Day, "5 days", 0, 11*Hour)
-	test(Year, "1 year", 0, Year-1)
+	test(Week, "1 week", 0, 1, 3*Day)
-	test(3*Year, "3 years", 0, Year-1)
+	test(Week, "2 weeks", 4*Day, Week-1)
+	test(3*Week, "3 weeks", 0, 3*Day)
+	test(Month, "1 month", 0, 1)
+	test(Month, "2 months", 16*Day, Month-1)
+	test(10*Month, "10 months", 0, 13*Day)
+	test(Year, "1 year", 0, 179*Day)
+	test(Year, "2 years", 180*Day, Year-1)
+	test(3*Year, "3 years", 0, 179*Day)
 }
 
 func TestMinutesToFriendly(t *testing.T) {