Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shows total tracked time in issue and milestone list #3341

Merged
merged 39 commits into from
Apr 29, 2018
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
72c4296
Show total tracked time in issue and milestone list
jonasfranz Jan 9, 2018
1c0201f
Merge branch 'master' of https://github.com/go-gitea/gitea into 3003-…
jonasfranz Jan 9, 2018
1875038
Optimizing TotalTimes by using SumInt
jonasfranz Jan 10, 2018
b849f54
Merge branch 'master' into 3003-timetracking
jonasfranz Feb 3, 2018
fda4dd4
Fixing wrong total times for milestones caused by a missing JOIN
jonasfranz Feb 3, 2018
983c1e1
Logging error instead of ignoring it
jonasfranz Feb 3, 2018
707f3db
Merge branch 'master' into 3003-timetracking
jonasfranz Feb 3, 2018
26a1e02
Correcting spelling mistakes
jonasfranz Feb 3, 2018
67be8bd
Merge remote-tracking branch 'jonas/3003-timetracking' into 3003-time…
jonasfranz Feb 3, 2018
f1cfe62
Change error message to a short version
jonasfranz Feb 3, 2018
770fea4
Merge branch 'master' into 3003-timetracking
jonasfranz Feb 9, 2018
3c8507a
Merge branch 'master' into 3003-timetracking
jonasfranz Feb 26, 2018
c5c812c
Add error handling to TotalTimes
jonasfranz Feb 26, 2018
e92cc12
Merge branch 'master' into 3003-timetracking
jonasfranz Mar 10, 2018
8481f2d
Introduce TotalTrackedTimes as variable of issue
jonasfranz Mar 11, 2018
4cac53e
Fixed test + gofmt
jonasfranz Mar 11, 2018
79dc9d8
Merge branch 'master' into 3003-timetracking
jonasfranz Mar 15, 2018
421cbfb
Merge branch 'master' into 3003-timetracking
jonasfranz Mar 16, 2018
1077882
Merge branch 'master' into 3003-timetracking
jonasfranz Mar 28, 2018
9bb7714
Merge branch 'master' into 3003-timetracking
jonasfranz Mar 30, 2018
0143b50
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 3, 2018
2f6a6fd
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 4, 2018
2d13376
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 10, 2018
a87698b
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 13, 2018
ec0d41c
Load TotalTrackedTimes via MilestoneList instead of single requests
jonasfranz Apr 16, 2018
856087e
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 16, 2018
02dc1cf
Add documentation for MilestoneList
jonasfranz Apr 16, 2018
9508985
Merge remote-tracking branch 'onion/3003-timetracking' into 3003-time…
jonasfranz Apr 16, 2018
0ba269b
Add documentation for MilestoneList
jonasfranz Apr 16, 2018
70e9bbd
Fix test
jonasfranz Apr 16, 2018
221a327
Change comment from SQL query to description
jonasfranz Apr 19, 2018
90658cc
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 19, 2018
ca5243c
Fix unit test by using int64 instead of int
jonasfranz Apr 19, 2018
d623780
Fix unit test by using int64 instead of int
jonasfranz Apr 19, 2018
6a97bf7
Check if timetracker is enabled
jonasfranz Apr 20, 2018
62f9962
Fix test by enabling timetracking
jonasfranz Apr 21, 2018
2835f08
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 21, 2018
526f7db
Merge branch 'master' into 3003-timetracking
jonasfranz Apr 23, 2018
e9562ad
Merge branch 'master' into 3003-timetracking
lafriks Apr 29, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions models/issue.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ type Issue struct {
UpdatedUnix util.TimeStamp `xorm:"INDEX updated"`
ClosedUnix util.TimeStamp `xorm:"INDEX"`

Attachments []*Attachment `xorm:"-"`
Comments []*Comment `xorm:"-"`
Reactions ReactionList `xorm:"-"`
Attachments []*Attachment `xorm:"-"`
Comments []*Comment `xorm:"-"`
Reactions ReactionList `xorm:"-"`
TotalTrackedTime int64 `xorm:"-"`
}

var (
Expand All @@ -69,6 +70,15 @@ func init() {
issueTasksDonePat = regexp.MustCompile(issueTasksDoneRegexpStr)
}

func (issue *Issue) loadTotalTimes(e Engine) (err error) {
opts := FindTrackedTimesOptions{IssueID: issue.ID}
issue.TotalTrackedTime, err = opts.ToSession(e).SumInt(&TrackedTime{}, "time")
if err != nil {
return err
}
return nil
}

func (issue *Issue) loadRepo(e Engine) (err error) {
if issue.Repo == nil {
issue.Repo, err = getRepositoryByID(e, issue.RepoID)
Expand All @@ -79,6 +89,15 @@ func (issue *Issue) loadRepo(e Engine) (err error) {
return nil
}

// IsTimetrackerEnabled returns true if the repo enables timetracking
func (issue *Issue) IsTimetrackerEnabled() bool {
if err := issue.loadRepo(x); err != nil {
log.Error(4, fmt.Sprintf("loadRepo: %v", err))
return false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If error is ignored than at least it should be logged

}
return issue.Repo.IsTimetrackerEnabled()
}

// GetPullRequest returns the issue pull request
func (issue *Issue) GetPullRequest() (pr *PullRequest, err error) {
if !issue.IsPull {
Expand Down Expand Up @@ -226,6 +245,10 @@ func (issue *Issue) loadAttributes(e Engine) (err error) {
return err
}

if err = issue.loadTotalTimes(e); err != nil {
return err
}

return issue.loadReactions(e)
}

Expand Down
41 changes: 41 additions & 0 deletions models/issue_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,43 @@ func (issues IssueList) loadComments(e Engine) (err error) {
return nil
}

func (issues IssueList) loadTotalTrackedTimes(e Engine) (err error) {
type totalTimesByIssue struct {
IssueID int64
Time int64
}
if len(issues) == 0 {
return nil
}
var trackedTimes = make(map[int64]int64, len(issues))

// select issue_id, sum(time) from tracked_time where issue_id in (<issue ids in current page>) group by issue_id
rows, err := e.Table("tracked_time").
Select("issue_id, sum(time) as time").
In("issue_id", issues.getIssueIDs()).
GroupBy("issue_id").
Rows(new(totalTimesByIssue))
if err != nil {
return err
}

defer rows.Close()

for rows.Next() {
var totalTime totalTimesByIssue
err = rows.Scan(&totalTime)
if err != nil {
return err
}
trackedTimes[totalTime.IssueID] = totalTime.Time
}

for _, issue := range issues {
issue.TotalTrackedTime = trackedTimes[issue.ID]
}
return nil
}

// loadAttributes loads all attributes, expect for attachments and comments
func (issues IssueList) loadAttributes(e Engine) (err error) {
if _, err = issues.loadRepositories(e); err != nil {
Expand All @@ -316,6 +353,10 @@ func (issues IssueList) loadAttributes(e Engine) (err error) {
return
}

if err = issues.loadTotalTrackedTimes(e); err != nil {
return
}

return nil
}

Expand Down
5 changes: 5 additions & 0 deletions models/issue_list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,10 @@ func TestIssueList_LoadAttributes(t *testing.T) {
for _, comment := range issue.Comments {
assert.EqualValues(t, issue.ID, comment.IssueID)
}
if issue.ID == int64(1) {
assert.Equal(t, int64(400), issue.TotalTrackedTime)
} else if issue.ID == int64(2) {
assert.Equal(t, int64(3662), issue.TotalTrackedTime)
}
}
}
63 changes: 60 additions & 3 deletions models/issue_milestone.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ type Milestone struct {
DeadlineString string `xorm:"-"`
DeadlineUnix util.TimeStamp
ClosedDateUnix util.TimeStamp

TotalTrackedTime int64 `xorm:"-"`
}

// BeforeInsert is invoked from XORM before inserting an object of this type.
Expand Down Expand Up @@ -123,14 +125,70 @@ func GetMilestoneByRepoID(repoID, id int64) (*Milestone, error) {
return getMilestoneByRepoID(x, repoID, id)
}

type MilestoneList []*Milestone

func (milestones MilestoneList) loadTotalTrackedTimes(e Engine) error {
type totalTimesByMilestone struct {
MilestoneID int64
Time int64
}
if len(milestones) == 0 {
return nil
}
var trackedTimes = make(map[int64]int64, len(milestones))

// SELECT milestone_id, sum(time) as time FROM `issue`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment should be removed

// INNER JOIN `milestone` ON issue.milestone_id = milestone.id
// LEFT JOIN `tracked_time` ON tracked_time.issue_id = issue.id
// WHERE `milestone_id` IN (?) GROUP BY milestone_id
rows, err := e.Table("issue").
Join("INNER", "milestone", "issue.milestone_id = milestone.id").
Join("LEFT", "tracked_time", "tracked_time.issue_id = issue.id").
Select("milestone_id, sum(time) as time").
In("milestone_id", milestones.getMilestoneIDs()).
GroupBy("milestone_id").
Rows(new(totalTimesByMilestone))
if err != nil {
return err
}

defer rows.Close()

for rows.Next() {
var totalTime totalTimesByMilestone
err = rows.Scan(&totalTime)
if err != nil {
return err
}
trackedTimes[totalTime.MilestoneID] = totalTime.Time
}

for _, milestone := range milestones {
milestone.TotalTrackedTime = trackedTimes[milestone.ID]
}
return nil
}

func (milestones MilestoneList) LoadTotalTrackedTimes() error {
return milestones.loadTotalTrackedTimes(x)
}

func (milestones MilestoneList) getMilestoneIDs() []int64 {
var ids = make([]int64, 0, len(milestones))
for _, ms := range milestones {
ids = append(ids, ms.ID)
}
return ids
}

// GetMilestonesByRepoID returns all milestones of a repository.
func GetMilestonesByRepoID(repoID int64) ([]*Milestone, error) {
func GetMilestonesByRepoID(repoID int64) (MilestoneList, error) {
miles := make([]*Milestone, 0, 10)
return miles, x.Where("repo_id = ?", repoID).Find(&miles)
}

// GetMilestones returns a list of milestones of given repository and status.
func GetMilestones(repoID int64, page int, isClosed bool, sortType string) ([]*Milestone, error) {
func GetMilestones(repoID int64, page int, isClosed bool, sortType string) (MilestoneList, error) {
miles := make([]*Milestone, 0, setting.UI.IssuePagingNum)
sess := x.Where("repo_id = ? AND is_closed = ?", repoID, isClosed)
if page > 0 {
Expand All @@ -151,7 +209,6 @@ func GetMilestones(repoID int64, page int, isClosed bool, sortType string) ([]*M
default:
sess.Asc("deadline_unix")
}

return miles, sess.Find(&miles)
}

Expand Down
9 changes: 9 additions & 0 deletions models/issue_milestone_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,12 @@ func TestDeleteMilestoneByRepoID(t *testing.T) {

assert.NoError(t, DeleteMilestoneByRepoID(NonexistentID, NonexistentID))
}

func TestMilestoneList_LoadTotalTrackedTimes(t *testing.T) {
assert.NoError(t, PrepareTestDatabase())
miles := MilestoneList{
AssertExistsAndLoadBean(t, &Milestone{ID: 1}).(*Milestone),
}
assert.NoError(t, miles.LoadTotalTrackedTimes())
assert.Equal(t, miles[0].TotalTrackedTime, 3661)
}
5 changes: 3 additions & 2 deletions models/issue_stopwatch.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func CreateOrStopIssueStopwatch(user *User, issue *Issue) error {
Doer: user,
Issue: issue,
Repo: issue.Repo,
Content: secToTime(timediff),
Content: SecToTime(timediff),
Type: CommentTypeStopTracking,
}); err != nil {
return err
Expand Down Expand Up @@ -124,7 +124,8 @@ func CancelStopwatch(user *User, issue *Issue) error {
return nil
}

func secToTime(duration int64) string {
// SecToTime converts an amount of seconds to a human-readable string (example: 66s -> 1min 6s)
func SecToTime(duration int64) string {
seconds := duration % 60
minutes := (duration / (60)) % 60
hours := duration / (60 * 60)
Expand Down
8 changes: 8 additions & 0 deletions models/issue_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -279,3 +279,11 @@ func TestGetUserIssueStats(t *testing.T) {
assert.Equal(t, test.ExpectedIssueStats, *stats)
}
}

func TestIssue_loadTotalTimes(t *testing.T) {
assert.NoError(t, PrepareTestDatabase())
ms, err := GetIssueByID(2)
assert.NoError(t, err)
assert.NoError(t, ms.loadTotalTimes(x))
assert.Equal(t, int64(3662), ms.TotalTrackedTime)
}
23 changes: 16 additions & 7 deletions models/issue_tracked_time.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
api "code.gitea.io/sdk/gitea"

"github.com/go-xorm/builder"
"github.com/go-xorm/xorm"
)

// TrackedTime represents a time that was spent for a specific issue.
Expand Down Expand Up @@ -44,6 +45,7 @@ type FindTrackedTimesOptions struct {
IssueID int64
UserID int64
RepositoryID int64
MilestoneID int64
}

// ToCond will convert each condition into a xorm-Cond
Expand All @@ -58,16 +60,23 @@ func (opts *FindTrackedTimesOptions) ToCond() builder.Cond {
if opts.RepositoryID != 0 {
cond = cond.And(builder.Eq{"issue.repo_id": opts.RepositoryID})
}
if opts.MilestoneID != 0 {
cond = cond.And(builder.Eq{"issue.milestone_id": opts.MilestoneID})
}
return cond
}

// ToSession will convert the given options to a xorm Session by using the conditions from ToCond and joining with issue table if required
func (opts *FindTrackedTimesOptions) ToSession(e Engine) *xorm.Session {
if opts.RepositoryID > 0 || opts.MilestoneID > 0 {
return e.Join("INNER", "issue", "issue.id = tracked_time.issue_id").Where(opts.ToCond())
}
return x.Where(opts.ToCond())
}

// GetTrackedTimes returns all tracked times that fit to the given options.
func GetTrackedTimes(options FindTrackedTimesOptions) (trackedTimes []*TrackedTime, err error) {
if options.RepositoryID > 0 {
err = x.Join("INNER", "issue", "issue.id = tracked_time.issue_id").Where(options.ToCond()).Find(&trackedTimes)
return
}
err = x.Where(options.ToCond()).Find(&trackedTimes)
err = options.ToSession(x).Find(&trackedTimes)
return
}

Expand All @@ -85,7 +94,7 @@ func AddTime(user *User, issue *Issue, time int64) (*TrackedTime, error) {
Issue: issue,
Repo: issue.Repo,
Doer: user,
Content: secToTime(time),
Content: SecToTime(time),
Type: CommentTypeAddTimeManual,
}); err != nil {
return nil, err
Expand Down Expand Up @@ -115,7 +124,7 @@ func TotalTimes(options FindTrackedTimesOptions) (map[*User]string, error) {
}
return nil, err
}
totalTimes[user] = secToTime(total)
totalTimes[user] = SecToTime(total)
}
return totalTimes, nil
}
5 changes: 3 additions & 2 deletions modules/templates/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,9 @@ func NewFuncMap() []template.FuncMap {
}
return dict, nil
},
"Printf": fmt.Sprintf,
"Escape": Escape,
"Printf": fmt.Sprintf,
"Escape": Escape,
"Sec2Time": models.SecToTime,
}}
}

Expand Down
2 changes: 1 addition & 1 deletion options/locale/locale_en-US.ini
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,7 @@ issues.add_time_minutes = Minutes
issues.add_time_sum_to_small = No time was entered
issues.cancel_tracking = Cancel
issues.cancel_tracking_history = `cancelled time tracking %s`
issues.time_spent_total = Total time spent
issues.time_spent_from_all_authors = `Total time spent: %s`

pulls.desc = Pulls management your code review and merge requests
pulls.new = New Pull Request
Expand Down
6 changes: 6 additions & 0 deletions routers/repo/issue.go
Original file line number Diff line number Diff line change
Expand Up @@ -1139,6 +1139,12 @@ func Milestones(ctx *context.Context) {
ctx.ServerError("GetMilestones", err)
return
}
if ctx.Repo.Repository.IsTimetrackerEnabled() {
if miles.LoadTotalTrackedTimes(); err != nil {
ctx.ServerError("LoadTotalTrackedTimes", err)
return
}
}
for _, m := range miles {
m.RenderedContent = string(markdown.Render([]byte(m.Content), ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas()))
}
Expand Down
4 changes: 4 additions & 0 deletions templates/repo/issue/list.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,10 @@
<span class="comment ui right"><i class="octicon octicon-comment"></i> {{.NumComments}}</span>
{{end}}

{{if and .IsTimetrackerEnabled .TotalTrackedTime}}
<span class="comment ui right"><i class="octicon octicon-clock"></i> {{.TotalTrackedTime | Sec2Time}}</span>
{{end}}

<p class="desc">
{{$.i18n.Tr "repo.issues.opened_by" $timeStr .Poster.HomeLink .Poster.Name | Safe}}
{{$tasks := .GetTasks}}
Expand Down
1 change: 1 addition & 0 deletions templates/repo/issue/milestones.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<span class="issue-stats">
<i class="octicon octicon-issue-opened"></i> {{$.i18n.Tr "repo.issues.open_tab" .NumOpenIssues}}
<i class="octicon octicon-issue-closed"></i> {{$.i18n.Tr "repo.issues.close_tab" .NumClosedIssues}}
{{if .TotalTrackedTime}}<i class="octicon octicon-clock"></i> {{.TotalTrackedTime|Sec2Time}}{{end}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably also change to same as in issues.tmpl: {{if and .IsTimetrackerEnabled .TotalTrackedTime}}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, because .TotalTrackedTime is zero if timetracker is disabled because TotalTrackedTime is only loaded if it is enabled. (https://github.com/go-gitea/gitea/pull/3341/files#diff-ece22e0fe138da6e0fe0f25213406313R1142)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Than probably there also needs to be such check added so that it would behave same in both places: https://github.com/JonasFranzDEV/gitea/blob/d6237809c472de482cc31fb954af1a8fd6ef54b4/models/issue.go#L248

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lafriks Done

</span>
</div>
{{if $.IsRepositoryWriter}}
Expand Down
2 changes: 1 addition & 1 deletion templates/repo/issue/view_content/sidebar.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
{{if gt (len .WorkingUsers) 0}}
<div class="ui divider"></div>
<div class="ui participants comments">
<span class="text"><strong>{{.i18n.Tr "repo.issues.time_spent_total"}}</strong></span>
<span class="text"><strong>{{.i18n.Tr "repo.issues.time_spent_from_all_authors" ($.Issue.TotalTrackedTime | Sec2Time) | Safe}}</strong></span>
<div>
{{range $user, $trackedtime := .WorkingUsers}}
<div class="comment">
Expand Down
3 changes: 3 additions & 0 deletions templates/user/dashboard/issues.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@
{{if .NumComments}}
<span class="comment ui right"><i class="octicon octicon-comment"></i> {{.NumComments}}</span>
{{end}}
{{if and .IsTimetrackerEnabled .TotalTrackedTime}}
<span class="comment ui right"><i class="octicon octicon-clock"></i> {{.TotalTrackedTime | Sec2Time}}</span>
{{end}}

<p class="desc">
{{$.i18n.Tr "repo.issues.opened_by" $timeStr .Poster.HomeLink .Poster.Name | Safe}}
Expand Down