Merge pull request '[PORT] Replace DateTime with proper functions (gitea#32402)' (#5796) from gusted/forgejo-port-dateutils into forgejo

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/5796
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Reviewed-by: Otto <otto@codeberg.org>

modules/templates/helper.go

@@ -52,6 +52,7 @@ func NewFuncMap() template.FuncMap {
 		"StringUtils": NewStringUtils,
 		"SliceUtils":  NewSliceUtils,
 		"JsonUtils":   NewJsonUtils,
+		"DateUtils":   NewDateUtils,
 
 		// -----------------------------------------------------------------
 		// svg / avatar / icon / color
@@ -68,7 +69,7 @@ func NewFuncMap() template.FuncMap {
 		"CountFmt":      base.FormatNumberSI,
 		"TimeSince":     timeutil.TimeSince,
 		"TimeSinceUnix": timeutil.TimeSinceUnix,
-		"DateTime":      timeutil.DateTime,
+		"DateTime":      dateTimeLegacy, // for backward compatibility only, do not use it anymore
 		"Sec2Time":      util.SecToTime,
 		"LoadTimes": func(startTime time.Time) string {
 			return fmt.Sprint(time.Since(startTime).Nanoseconds()/1e6) + "ms"

modules/templates/util_date.go

@@ -0,0 +1,60 @@
+// Copyright 2024 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package templates
+
+import (
+	"context"
+	"html/template"
+	"time"
+
+	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/timeutil"
+)
+
+type DateUtils struct {
+	ctx context.Context
+}
+
+func NewDateUtils(ctx context.Context) *DateUtils {
+	return &DateUtils{ctx}
+}
+
+// AbsoluteShort renders in "Jan 01, 2006" format
+func (du *DateUtils) AbsoluteShort(time any) template.HTML {
+	return timeutil.DateTime("short", time)
+}
+
+// AbsoluteLong renders in "January 01, 2006" format
+func (du *DateUtils) AbsoluteLong(time any) template.HTML {
+	return timeutil.DateTime("long", time)
+}
+
+// FullTime renders in "Jan 01, 2006 20:33:44" format
+func (du *DateUtils) FullTime(time any) template.HTML {
+	return timeutil.DateTime("full", time)
+}
+
+// ParseLegacy parses the datetime in legacy format, eg: "2016-01-02" in server's timezone.
+// It shouldn't be used in new code. New code should use Time or TimeStamp as much as possible.
+func (du *DateUtils) ParseLegacy(datetime string) time.Time {
+	return parseLegacy(datetime)
+}
+
+func parseLegacy(datetime string) time.Time {
+	t, err := time.Parse(time.RFC3339, datetime)
+	if err != nil {
+		t, _ = time.ParseInLocation(time.DateOnly, datetime, setting.DefaultUILocation)
+	}
+	return t
+}
+
+func dateTimeLegacy(format string, datetime any, _ ...string) template.HTML {
+	if !setting.IsProd || setting.IsInTesting {
+		panic("dateTimeLegacy is for backward compatibility only, do not use it in new code")
+	}
+	if s, ok := datetime.(string); ok {
+		datetime = parseLegacy(s)
+	}
+	return timeutil.DateTime(format, datetime)
+}

modules/templates/util_date_test.go

@@ -1,47 +1,61 @@
 // Copyright 2023 The Gitea Authors. All rights reserved.
 // SPDX-License-Identifier: MIT
 
-package timeutil
+package templates
 
 import (
+	"html/template"
 	"testing"
 	"time"
 
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/test"
+	"code.gitea.io/gitea/modules/timeutil"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestDateTime(t *testing.T) {
-	testTz, _ := time.LoadLocation("America/New_York")
+	testTz, err := time.LoadLocation("America/New_York")
+	require.NoError(t, err)
 	defer test.MockVariableValue(&setting.DefaultUILocation, testTz)()
+	defer test.MockVariableValue(&setting.IsInTesting, false)()
+
+	du := NewDateUtils(nil)
 
 	refTimeStr := "2018-01-01T00:00:00Z"
 	refDateStr := "2018-01-01"
 	refTime, _ := time.Parse(time.RFC3339, refTimeStr)
-	refTimeStamp := TimeStamp(refTime.Unix())
+	refTimeStamp := timeutil.TimeStamp(refTime.Unix())
 
-	assert.EqualValues(t, "-", DateTime("short", nil))
-	assert.EqualValues(t, "-", DateTime("short", 0))
-	assert.EqualValues(t, "-", DateTime("short", time.Time{}))
-	assert.EqualValues(t, "-", DateTime("short", TimeStamp(0)))
+	for _, val := range []any{nil, 0, time.Time{}, timeutil.TimeStamp(0)} {
+		for _, fun := range []func(val any) template.HTML{du.AbsoluteLong, du.AbsoluteShort, du.FullTime} {
+			assert.EqualValues(t, "-", fun(val))
+		}
+	}
 
-	actual := DateTime("short", "invalid")
-	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="invalid">invalid</absolute-date>`, actual)
+	actual := dateTimeLegacy("short", "invalid")
+	assert.EqualValues(t, `-`, actual)
 
-	actual = DateTime("short", refTimeStr)
-	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="2018-01-01T00:00:00Z">2018-01-01T00:00:00Z</absolute-date>`, actual)
-
-	actual = DateTime("short", refTime)
+	actual = dateTimeLegacy("short", refTimeStr)
 	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="2018-01-01T00:00:00Z">2018-01-01</absolute-date>`, actual)
 
-	actual = DateTime("short", refDateStr)
-	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="2018-01-01">2018-01-01</absolute-date>`, actual)
+	actual = du.AbsoluteShort(refTime)
+	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="2018-01-01T00:00:00Z">2018-01-01</absolute-date>`, actual)
 
-	actual = DateTime("short", refTimeStamp)
+	actual = du.AbsoluteLong(refTime)
+	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="long" day="numeric" date="2018-01-01T00:00:00Z">2018-01-01</absolute-date>`, actual)
+
+	actual = dateTimeLegacy("short", refDateStr)
+	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="2018-01-01T00:00:00-05:00">2018-01-01</absolute-date>`, actual)
+
+	actual = du.AbsoluteShort(refTimeStamp)
 	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="short" day="numeric" date="2017-12-31T19:00:00-05:00">2017-12-31</absolute-date>`, actual)
 
-	actual = DateTime("full", refTimeStamp)
+	actual = du.AbsoluteLong(refTimeStamp)
+	assert.EqualValues(t, `<absolute-date weekday="" year="numeric" month="long" day="numeric" date="2017-12-31T19:00:00-05:00">2017-12-31</absolute-date>`, actual)
+
+	actual = du.FullTime(refTimeStamp)
 	assert.EqualValues(t, `<relative-time weekday="" year="numeric" format="datetime" month="short" day="numeric" hour="numeric" minute="numeric" second="numeric" data-tooltip-content data-tooltip-interactive="true" datetime="2017-12-31T19:00:00-05:00">2017-12-31 19:00:00 -05:00</relative-time>`, actual)
 }

modules/timeutil/datetime.go

@@ -12,9 +12,7 @@ import (
 )
 
 // DateTime renders an absolute time HTML element by datetime.
-func DateTime(format string, datetime any, extraAttrs ...string) template.HTML {
-	// TODO: remove the extraAttrs argument, it's not used in any call to DateTime
-
+func DateTime(format string, datetime any) template.HTML {
 	if p, ok := datetime.(*time.Time); ok {
 		datetime = *p
 	}
@@ -34,9 +32,6 @@ func DateTime(format string, datetime any, extraAttrs ...string) template.HTML {
 	switch v := datetime.(type) {
 	case nil:
 		return "-"
-	case string:
-		datetimeEscaped = html.EscapeString(v)
-		textEscaped = datetimeEscaped
 	case time.Time:
 		if v.IsZero() || v.Unix() == 0 {
 			return "-"
@@ -51,10 +46,7 @@ func DateTime(format string, datetime any, extraAttrs ...string) template.HTML {
 		panic(fmt.Sprintf("Unsupported time type %T", datetime))
 	}
 
-	attrs := make([]string, 0, 10+len(extraAttrs))
-	attrs = append(attrs, extraAttrs...)
-	attrs = append(attrs, `weekday=""`, `year="numeric"`)
-
+	attrs := []string{`weekday=""`, `year="numeric"`}
 	switch format {
 	case "short", "long": // date only
 		attrs = append(attrs, `month="`+format+`"`, `day="numeric"`)