Issue time estimate, meaningful time tracking

models/issues/comment.go

@@ -130,6 +130,8 @@ const (
 	CommentTypePRScheduledToAutoMerge
 	// 35 pr was un scheduled to auto merge when checks succeed
 	CommentTypePRUnScheduledToAutoMerge
+	// 36 Change time estimate
+	CommentTypeChangeTimeEstimate
 )
 
 var commentStrings = []string{
@@ -169,6 +171,7 @@ var commentStrings = []string{
 	"change_issue_ref",
 	"pull_scheduled_merge",
 	"pull_cancel_scheduled_merge",
+	"change_time_estimate",
 }
 
 func (t CommentType) String() string {
@@ -244,6 +247,7 @@ type Comment struct {
 	Milestone        *Milestone `xorm:"-"`
 	TimeID           int64
 	Time             *TrackedTime `xorm:"-"`
+	TimeTracked      int64        `xorm:"NOT NULL DEFAULT 0"`
 	AssigneeID       int64
 	RemovedAssignee  bool
 	Assignee         *user_model.User   `xorm:"-"`
@@ -301,6 +305,8 @@ type Comment struct {
 	NewCommit   string                              `xorm:"-"`
 	CommitsNum  int64                               `xorm:"-"`
 	IsForcePush bool                                `xorm:"-"`
+
+	TimeEstimate int64 `xorm:"NOT NULL DEFAULT 0"`
 }
 
 func init() {
@@ -797,6 +803,7 @@ func CreateComment(ctx context.Context, opts *CreateCommentOptions) (_ *Comment,
 		OldProjectID:     opts.OldProjectID,
 		ProjectID:        opts.ProjectID,
 		TimeID:           opts.TimeID,
+		TimeTracked:      opts.TimeTracked,
 		RemovedAssignee:  opts.RemovedAssignee,
 		AssigneeID:       opts.AssigneeID,
 		AssigneeTeamID:   opts.AssigneeTeamID,
@@ -819,6 +826,7 @@ func CreateComment(ctx context.Context, opts *CreateCommentOptions) (_ *Comment,
 		RefIsPull:        opts.RefIsPull,
 		IsForcePush:      opts.IsForcePush,
 		Invalidated:      opts.Invalidated,
+		TimeEstimate:     opts.TimeEstimate,
 	}
 	if _, err = e.Insert(comment); err != nil {
 		return nil, err
@@ -968,6 +976,7 @@ type CreateCommentOptions struct {
 	OldProjectID     int64
 	ProjectID        int64
 	TimeID           int64
+	TimeTracked      int64
 	AssigneeID       int64
 	AssigneeTeamID   int64
 	RemovedAssignee  bool
@@ -990,6 +999,7 @@ type CreateCommentOptions struct {
 	RefIsPull        bool
 	IsForcePush      bool
 	Invalidated      bool
+	TimeEstimate     int64
 }
 
 // GetCommentByID returns the comment by given ID.

models/issues/issue.go

@@ -7,8 +7,10 @@ package issues
 import (
 	"context"
 	"fmt"
+	"math"
 	"regexp"
 	"sort"
+	"strconv"
 	"strings"
 
 	"code.gitea.io/gitea/models/db"
@@ -146,6 +148,9 @@ type Issue struct {
 
 	// For view issue page.
 	ShowRole RoleDescriptor `xorm:"-"`
+
+	// Time estimate
+	TimeEstimate int64 `xorm:"NOT NULL DEFAULT 0"`
 }
 
 var (
@@ -774,6 +779,37 @@ func ChangeIssueTitle(issue *Issue, doer *user_model.User, oldTitle string) (err
 	return committer.Commit()
 }
 
+// ChangeIssueTimeEstimate changes the plan time of this issue, as the given user.
+func ChangeIssueTimeEstimate(issue *Issue, doer *user_model.User, timeEstimate int64) (err error) {
+	ctx, committer, err := db.TxContext(db.DefaultContext)
+	if err != nil {
+		return err
+	}
+	defer committer.Close()
+
+	if err = UpdateIssueCols(ctx, &Issue{ID: issue.ID, TimeEstimate: timeEstimate}, "time_estimate"); err != nil {
+		return fmt.Errorf("updateIssueCols: %w", err)
+	}
+
+	if err = issue.LoadRepo(ctx); err != nil {
+		return fmt.Errorf("loadRepo: %w", err)
+	}
+
+	opts := &CreateCommentOptions{
+		Type:         CommentTypeChangeTimeEstimate,
+		Doer:         doer,
+		Repo:         issue.Repo,
+		Issue:        issue,
+		Content:      util.SecToTime(timeEstimate),
+		TimeEstimate: timeEstimate,
+	}
+	if _, err = CreateComment(ctx, opts); err != nil {
+		return fmt.Errorf("createComment: %w", err)
+	}
+
+	return committer.Commit()
+}
+
 // ChangeIssueRef changes the branch of this issue, as the given user.
 func ChangeIssueRef(issue *Issue, doer *user_model.User, oldRef string) (err error) {
 	ctx, committer, err := db.TxContext(db.DefaultContext)
@@ -2498,3 +2534,88 @@ func DeleteOrphanedIssues(ctx context.Context) error {
 func (issue *Issue) HasOriginalAuthor() bool {
 	return issue.OriginalAuthor != "" && issue.OriginalAuthorID != 0
 }
+
+// TimeEstimateFromStr returns time estimate in seconds from formatted string
+func (issue *Issue) TimeEstimateFromStr(timeStr string) int64 {
+	timeTotal := 0
+
+	// Time match regex
+	rOnlyHours := regexp.MustCompile(`^([\d]+)$`)
+	rWeeks := regexp.MustCompile(`([\d]+)w`)
+	rDays := regexp.MustCompile(`([\d]+)d`)
+	rHours := regexp.MustCompile(`([\d]+)h`)
+	rMinutes := regexp.MustCompile(`([\d]+)m`)
+
+	// If single number entered, assume hours
+	timeStrMatches := rOnlyHours.FindStringSubmatch(timeStr)
+	if len(timeStrMatches) > 0 {
+		raw, _ := strconv.Atoi(timeStrMatches[1])
+		timeTotal += raw * (60 * 60)
+	} else {
+		// Find time weeks
+		timeStrMatches = rWeeks.FindStringSubmatch(timeStr)
+		if len(timeStrMatches) > 0 {
+			raw, _ := strconv.Atoi(timeStrMatches[1])
+			timeTotal += raw * (60 * 60 * 24 * 7)
+		}
+
+		// Find time days
+		timeStrMatches = rDays.FindStringSubmatch(timeStr)
+		if len(timeStrMatches) > 0 {
+			raw, _ := strconv.Atoi(timeStrMatches[1])
+			timeTotal += raw * (60 * 60 * 24)
+		}
+
+		// Find time hours
+		timeStrMatches = rHours.FindStringSubmatch(timeStr)
+		if len(timeStrMatches) > 0 {
+			raw, _ := strconv.Atoi(timeStrMatches[1])
+			timeTotal += raw * (60 * 60)
+		}
+
+		// Find time minutes
+		timeStrMatches = rMinutes.FindStringSubmatch(timeStr)
+		if len(timeStrMatches) > 0 {
+			raw, _ := strconv.Atoi(timeStrMatches[1])
+			timeTotal += raw * (60)
+		}
+	}
+
+	return int64(timeTotal)
+}
+
+// TimeEstimateStr returns formatted time estimate string from seconds (e.g. "2w 4d 12h 5m")
+func (issue *Issue) TimeEstimateToStr() string {
+	var timeParts []string
+
+	timeSeconds := float64(issue.TimeEstimate)
+
+	// Format weeks
+	weeks := math.Floor(timeSeconds / (60 * 60 * 24 * 7))
+	if weeks > 0 {
+		timeParts = append(timeParts, fmt.Sprintf("%dw", int64(weeks)))
+	}
+	timeSeconds -= weeks * (60 * 60 * 24 * 7)
+
+	// Format days
+	days := math.Floor(timeSeconds / (60 * 60 * 24))
+	if days > 0 {
+		timeParts = append(timeParts, fmt.Sprintf("%dd", int64(days)))
+	}
+	timeSeconds -= days * (60 * 60 * 24)
+
+	// Format hours
+	hours := math.Floor(timeSeconds / (60 * 60))
+	if hours > 0 {
+		timeParts = append(timeParts, fmt.Sprintf("%dh", int64(hours)))
+	}
+	timeSeconds -= hours * (60 * 60)
+
+	// Format minutes
+	minutes := math.Floor(timeSeconds / (60))
+	if minutes > 0 {
+		timeParts = append(timeParts, fmt.Sprintf("%dm", int64(minutes)))
+	}
+
+	return strings.Join(timeParts, " ")
+}

models/issues/stopwatch.go

@@ -197,12 +197,12 @@ func FinishIssueStopwatch(ctx context.Context, user *user_model.User, issue *Iss
 	}
 
 	if _, err := CreateComment(ctx, &CreateCommentOptions{
-		Doer:    user,
-		Issue:   issue,
-		Repo:    issue.Repo,
-		Content: util.SecToTime(timediff),
-		Type:    CommentTypeStopTracking,
-		TimeID:  tt.ID,
+		Doer:        user,
+		Issue:       issue,
+		Repo:        issue.Repo,
+		Type:        CommentTypeStopTracking,
+		TimeID:      tt.ID,
+		TimeTracked: tt.Time,
 	}); err != nil {
 		return err
 	}

models/issues/tracked_time.go

@@ -173,12 +173,12 @@ func AddTime(user *user_model.User, issue *Issue, amount int64, created time.Tim
 	}
 
 	if _, err := CreateComment(ctx, &CreateCommentOptions{
-		Issue:   issue,
-		Repo:    issue.Repo,
-		Doer:    user,
-		Content: util.SecToTime(amount),
-		Type:    CommentTypeAddTimeManual,
-		TimeID:  t.ID,
+		Issue:       issue,
+		Repo:        issue.Repo,
+		Doer:        user,
+		Type:        CommentTypeAddTimeManual,
+		TimeID:      t.ID,
+		TimeTracked: t.Time,
 	}); err != nil {
 		return nil, err
 	}
@@ -221,7 +221,12 @@ func TotalTimes(options *FindTrackedTimesOptions) (map[*user_model.User]string,
 			}
 			return nil, err
 		}
-		totalTimes[user] = util.SecToTime(total)
+
+		if total < 60 {
+			totalTimes[user] = util.SecToTimeExact(total, true)
+		} else {
+			totalTimes[user] = util.SecToTimeExact(total, false)
+		}
 	}
 	return totalTimes, nil
 }
@@ -251,11 +256,11 @@ func DeleteIssueUserTimes(issue *Issue, user *user_model.User) error {
 		return err
 	}
 	if _, err := CreateComment(ctx, &CreateCommentOptions{
-		Issue:   issue,
-		Repo:    issue.Repo,
-		Doer:    user,
-		Content: "- " + util.SecToTime(removedTime),
-		Type:    CommentTypeDeleteTimeManual,
+		Issue:       issue,
+		Repo:        issue.Repo,
+		Doer:        user,
+		TimeTracked: removedTime,
+		Type:        CommentTypeDeleteTimeManual,
 	}); err != nil {
 		return err
 	}
@@ -280,11 +285,11 @@ func DeleteTime(t *TrackedTime) error {
 	}
 
 	if _, err := CreateComment(ctx, &CreateCommentOptions{
-		Issue:   t.Issue,
-		Repo:    t.Issue.Repo,
-		Doer:    t.User,
-		Content: "- " + util.SecToTime(t.Time),
-		Type:    CommentTypeDeleteTimeManual,
+		Issue:       t.Issue,
+		Repo:        t.Issue.Repo,
+		Doer:        t.User,
+		TimeTracked: t.Time,
+		Type:        CommentTypeDeleteTimeManual,
 	}); err != nil {
 		return err
 	}

models/issues/tracked_time_test.go

@@ -35,7 +35,7 @@ func TestAddTime(t *testing.T) {
 	assert.Equal(t, int64(3661), tt.Time)
 
 	comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{Type: issues_model.CommentTypeAddTimeManual, PosterID: 3, IssueID: 1})
-	assert.Equal(t, comment.Content, "1 hour 1 minute")
+	assert.Equal(t, comment.TimeTracked, int64(3661))
 }
 
 func TestGetTrackedTimes(t *testing.T) {
@@ -87,7 +87,7 @@ func TestTotalTimes(t *testing.T) {
 	assert.Len(t, total, 1)
 	for user, time := range total {
 		assert.Equal(t, int64(1), user.ID)
-		assert.Equal(t, "6 minutes 40 seconds", time)
+		assert.Equal(t, "6 minutes", time)
 	}
 
 	total, err = issues_model.TotalTimes(&issues_model.FindTrackedTimesOptions{IssueID: 2})

models/migrations/migrations.go

@@ -467,6 +467,10 @@ var migrations = []Migration{
 
 	// v244 -> v245
 	NewMigration("Add NeedApproval to actions tables", v1_20.AddNeedApprovalToActionRun),
+
+	// v245 -> v246
+	NewMigration("Add TimeEstimate to issue table", v1_20.AddTimeEstimateColumnToIssueTable),
+	NewMigration("Add TimeTracked, TimeEstimate to comment table", v1_20.AddColumnsToCommentTable),
 }
 
 // GetCurrentDBVersion returns the current db version

models/migrations/v1_20/v245.go

@@ -0,0 +1,25 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_20 //nolint
+
+import (
+	"xorm.io/xorm"
+)
+
+func AddTimeEstimateColumnToIssueTable(x *xorm.Engine) error {
+	type Issue struct {
+		TimeEstimate int64 `xorm:"NOT NULL DEFAULT 0"`
+	}
+
+	return x.Sync(new(Issue))
+}
+
+func AddColumnsToCommentTable(x *xorm.Engine) error {
+	type Comment struct {
+		TimeTracked  int64 `xorm:"NOT NULL DEFAULT 0"`
+		TimeEstimate int64 `xorm:"NOT NULL DEFAULT 0"`
+	}
+
+	return x.Sync(new(Comment))
+}

modules/structs/issue.go

@@ -54,6 +54,7 @@ type Issue struct {
 	Attachments      []*Attachment `json:"assets"`
 	Labels           []*Label      `json:"labels"`
 	Milestone        *Milestone    `json:"milestone"`
+	TimeEstimate     int           `json:"time_estimate"`
 	// deprecated
 	Assignee  *User   `json:"assignee"`
 	Assignees []*User `json:"assignees"`
@@ -108,6 +109,7 @@ type EditIssueOption struct {
 	// swagger:strfmt date-time
 	Deadline       *time.Time `json:"due_date"`
 	RemoveDeadline *bool      `json:"unset_due_date"`
+	TimeEstimate   *string    `json:"time_estimate"`
 }
 
 // EditDeadlineOption options for creating a deadline

modules/templates/helper.go

@@ -278,9 +278,10 @@ func NewFuncMap() []template.FuncMap {
 			}
 			return dict, nil
 		},
-		"Printf":   fmt.Sprintf,
-		"Escape":   Escape,
-		"Sec2Time": util.SecToTime,
+		"Printf":         fmt.Sprintf,
+		"Escape":         Escape,
+		"Sec2Time":       util.SecToTime,
+		"SecToTimeExact": util.SecToTimeExact,
 		"ParseDeadline": func(deadline string) []string {
 			return strings.Split(deadline, "|")
 		},
@@ -549,9 +550,10 @@ func NewTextFuncMap() []texttmpl.FuncMap {
 			}
 			return dict, nil
 		},
-		"Printf":   fmt.Sprintf,
-		"Escape":   Escape,
-		"Sec2Time": util.SecToTime,
+		"Printf":         fmt.Sprintf,
+		"Escape":         Escape,
+		"Sec2Time":       util.SecToTime,
+		"SecToTimeExact": util.SecToTimeExact,
 		"ParseDeadline": func(deadline string) []string {
 			return strings.Split(deadline, "|")
 		},