Issue due date #3794

kolaente · 2018-04-14T15:24:20Z

Fixes #2533.
~~Blocked by go-gitea/go-sdk#103.~~

This PR adds the ability to add due dates to issues. This works similar to milestones, but for single issues. Due date can be managed via the api.
Due dates are shown in the issue list, overdue issues are marked in red.

Screenshots

TODO

Update go-sdk once its merged

…-due-date

…dates

lunny · 2018-04-15T01:27:21Z

models/issue.go

-	UpdatedUnix  util.TimeStamp `xorm:"INDEX updated"`
-	ClosedUnix   util.TimeStamp `xorm:"INDEX"`
+	DeadlineUnix   util.TimeStamp `xorm:"INDEX"`
+	DeadlineString string         `xorm:"-"`


It seems this field is unnecessary.

No, it is needed to show the deadline in templates.

You could use something like .DeadlineUnix.FormatShort.

Thanks, I didn't know that function exists.

On another note, what do you think about putting date formats in the corresponding locale files meaning we could have different date formats for every locale?

lunny · 2018-04-15T01:28:20Z

models/issue.go

+		}
+	}
+
+	return UpdateIssue(issue)


this should be err = updateIssue(sess, issue) and need sess.Commit()

jonasfranz · 2018-04-15T17:27:39Z

models/issue_comment.go

@@ -485,6 +491,45 @@ func createAssigneeComment(e *xorm.Session, doer *User, repo *Repository, issue
 	})
 }

+func createAddedDeadlineComment(e *xorm.Session, doer *User, repo *Repository, issue *Issue, dateUnix util.TimeStamp) (*Comment, error) {


I think that you could pack all of these create...DeadlineComment functions into one function with an additional parameter type (please also check if the type is a valid deadline type).

Done, good idea!

jonasfranz · 2018-04-15T17:29:59Z

modules/auth/repo_form.go

+
+// DeadlineForm hold the validation rules for deadlines
+type DeadlineForm struct {
+	DateString string `form:"date" binding:"Required;MaxSize(10)"`


Replace MaxSize with Size since a yyyy-mm-dd date has always 10 characters.

Thanks, I didn't know Size exists.

jonasfranz · 2018-04-15T17:33:30Z

templates/repo/issue/view_content/comments.tmpl

+				<img src="{{.Poster.RelAvatarLink}}">
+			</a>
+			<span class="text grey"><a href="{{.Poster.HomeLink}}">{{.Poster.Name}}</a>
+			{{$.i18n.Tr "repo.issues.due_date_added" .Content $createdStr | Safe}}


Please remove |Safe since it is not required (no safe HTML content inside)

If I do that, it looks like that:

So I'm leaving it. (same for the other ones)

Fair enough

jonasfranz · 2018-04-15T17:33:36Z

templates/repo/issue/view_content/comments.tmpl

+				<img src="{{.Poster.RelAvatarLink}}">
+			</a>
+			<span class="text grey"><a href="{{.Poster.HomeLink}}">{{.Poster.Name}}</a>
+			{{$.i18n.Tr "repo.issues.due_date_modified" .Content $createdStr | Safe}}


Please remove |Safe since it is not required (no safe HTML content inside)

jonasfranz · 2018-04-15T17:33:47Z

templates/repo/issue/view_content/comments.tmpl

+				<img src="{{.Poster.RelAvatarLink}}">
+			</a>
+			<span class="text grey"><a href="{{.Poster.HomeLink}}">{{.Poster.Name}}</a>
+			{{$.i18n.Tr "repo.issues.due_date_remove" .Content $createdStr | Safe}}


Please remove |Safe since it is not required (no safe HTML content inside)

jonasfranz · 2018-04-15T17:35:56Z

templates/repo/issue/view_content/sidebar.tmpl

+			<form method="POST"{{if gt .Issue.DeadlineUnix 0}}style="display: none;"{{end}}} id="add_deadline_form" action="{{$.RepoLink}}/issues/{{.Issue.Index}}/deadline/update" class="ui action input fluid">
+				{{$.CsrfTokenHtml}}
+				<div class="ui fluid action input">
+					<input required placeholder='{{.i18n.Tr "repo.issues.due_date_form"}}' {{if gt .Issue.DeadlineUnix 0}}value="{{.Issue.DeadlineUnix.Format "2006-01-02"}}"{{end}} type="date" name="date" style="min-width: 13.9rem;border-radius: 4px 0 0 4px;border-right: 0;white-space: nowrap;">


Replace placeholder='...' with placeholder="..."

jonasfranz · 2018-04-15T17:40:50Z

options/locale/locale_en-US.ini

+issues.invalid_due_date_format = "Due date format is invalid, must be 'yyyy-mm-dd'."
+issues.error_modifying_due_date = "An error occured while modifying the due date."
+issues.error_removing_due_date = "An error occured while remvoing the due date."
+issues.due_date_form = "Due date, format yyyy-mm-dd"


I think that

format yyyy-mm-dd

could be confusing for users from non-english countries (like Germany) because modern browsers use for the UI the local date format (in Germany: dd.mm.yyyy) and as value yyyy-mm-dd. (https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date#Value)

Yes, but that value is used as a placeholder for the input. If the browser supports input type date, the browser does what you described thus not showing the placeholder at all (because there's already something inside that field).

Some screenshots with an empty input:

Firefox:

Chromium:

The format doesnt really seem to be an issue here.

Also, currently the date is not localized anywhere, so if we'd start doing that here we should do it everywhere which is totally out of scope for this pr.

If the placeholder isn't shown at all it could be removed to reduce translation effort.

It is shown when the browser doesn't support the <input type="date"/> tag, so I'd leave that.

+ ui & validation improvements

lunny · 2018-04-17T00:57:40Z

models/issue.go

+// AfterLoad checks if the issue is overdue and sets the property
+func (issue *Issue) AfterLoad() {
+	if util.TimeStampNow() >= issue.DeadlineUnix {
+		issue.IsOverDue = true


why not just change IsOverDue as a method of Issue?

Good idea, I've changed it.

Morlinest · 2018-04-29T14:55:00Z

models/issue.go

+	if err := sess.Begin(); err != nil {
+		return err
+	}
+	defer sess.Close()


defer sess.Close() should be after sess := x.NewSession() and before sess.Begin()

Sure, fixed.

Morlinest · 2018-04-29T15:12:31Z

routers/api/v1/repo/issue.go

@@ -265,6 +272,16 @@ func EditIssue(ctx *context.APIContext, form api.EditIssueOption) {
 		issue.Content = *form.Body
 	}

+	var deadlineUnix util.TimeStamp


nit: Use var deadlineUnix util.TimeStamp or var deadline util.TimeStamp, not both as it has same meaning (same in repo/issue.go and repo/pull.go).

Sure, I fixed that as well.

…dline + style nitpicks

Morlinest · 2018-04-29T16:15:50Z

routers/repo/issue.go

+	}
+
+	// Check if the user has at least write access to the repo
+	if !ctx.Repo.IsWriter() {


I found there is authorization middleware, can you use that instead? Like in m.Post("/status", reqRepoWriter, repo.UpdateIssueStatus). It calls RequireRepoWriter() func.

…-due-date

jonasfranz · 2018-05-01T09:57:22Z

@lunny I already approved it here: #3794 (comment)

Morlinest

Should be last changes. There are another two things I don' like. But one is not related directly only to this issue (usage of ctx.Writen() and ctx.HasError()) and second is about better UI (but that can be updated in future, right now I have not better idea).

Morlinest · 2018-05-01T12:03:21Z

routers/routes/routes.go

@@ -496,6 +496,8 @@ func RegisterRoutes(m *macaron.Macaron) {
 					})
 				})
 				m.Post("/reactions/:action", bindIgnErr(auth.ReactionForm{}), repo.ChangeIssueReaction)
+				m.Post("/deadline/update", reqRepoWriter, bindIgnErr(auth.DeadlineForm{}), repo.UpdateDeadline)
+				m.Post("/deadline/remove", reqRepoWriter, repo.RemoveDeadline)


For consistency, this endpoint should be called /delete.

Fixed that.

Morlinest · 2018-05-01T12:15:47Z

templates/repo/issue/view_content/sidebar.tmpl

+				{{end}}
+				<br/>
+				<a style="cursor:pointer;" onclick="toggleDuedateForm();"><i class="edit icon"></i>Edit</a> -
+				<a style="cursor:pointer;" onclick="deleteDueDate('{{$.RepoLink}}/issues/{{.Issue.Index}}/deadline/remove');"><i class="remove icon"></i>Remove</a>


This can/should be standard link (<a href="{{$.RepoLink}}/issues/{{.Issue.Index}}/deadline/remove">), right?

No, the js function sends a post request.

I'll send a seperate pr after this one is merged which will add a seperate api endpoint for deadlines which then will be used for the update the deadline from the UI.

Good to know you will improve this solution and add api endpoint. Until then, you should not simulate api endpoint by using js and standard page, ignoring anything it can return. For now, there is not reason to use js, you can add it later, in another PR when api would be ready for it.

I've modifed the endpoint, deleting a deadline is now done via GET.

Morlinest

gj

kolaente · 2018-05-01T18:00:14Z

@Morlinest thanks!

lafriks

@Morlinest @kolaente Wanted to already merge but there one thing needs to be changed back as it was in previous commits. For security reasons all actions that update database must be done using post method, so that CSRF can be verified and user could not be fooled into actions that he did not want (either by giving him url or redirecting him to such url)

kolaente · 2018-05-01T18:50:01Z

@lafriks OK, I'll change it back to how it was before.

kolaente · 2018-05-01T18:52:17Z

@lafriks Done.

Morlinest · 2018-05-01T19:18:58Z

Just for info, I don't like this halfway solution.

lafriks · 2018-05-01T20:41:31Z

@Morlinest about doing post for removing due date?

kolaente added 15 commits March 22, 2018 23:18

Started adding deadline to ui

406cd5a

Implemented basic issue due date managing

859cd47

Improved UI for due date managing

02415f7

Merge branch 'master' of https://github.com/go-gitea/gitea into issue…

bfef995

…-due-date

Added at least write access to the repo in order to modify issue due …

74c9e07

…dates

Ui improvements

aeb3db9

Added issue comments creation when adding/modifying/removing a due date

211b2ed

Show due date in issue list

82d7bf0

merge with master

13a12c3

Added api support for issue due dates

c1ada01

Fixed lint suggestions

6663012

Added deadline to sdk

f4baf19

Updated css

06d9649

Added support for adding/modifiying deadlines for pull requests via api

3bf2227

Fixed comments not created when updating or removing a deadline

60bbb23

kolaente mentioned this pull request Apr 14, 2018

Preparation for Issue due dates (go-gitea/gitea#2533) go-gitea/go-sdk#103

Merged

update sdk (will do properly once go-gitea/go-sdk#103 is merged)

192f31e

lunny requested changes Apr 15, 2018

View reviewed changes

bkcsoft added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Apr 15, 2018

lunny added the type/enhancement An improvement of existing functionality label Apr 15, 2018

kolaente added 3 commits April 15, 2018 10:21

enhanced updateIssueDeadline

f766101

Removed unnessecary Issue.DeadlineString

a1b79fe

UI improvements

e659699

jonasfranz suggested changes Apr 15, 2018

View reviewed changes

kolaente added 3 commits April 16, 2018 19:04

Small improvments to comment creation

bdec65a

+ ui & validation improvements

merge with gitea-master

38e1180

merge with gitea-master

51d3e4f

lunny requested changes Apr 17, 2018

View reviewed changes

kolaente added 2 commits April 17, 2018 18:38

Check if an issue is overdue is now a seperate function

5c93fe0

Updated go-sdk with govendor as it was merged

7292c30

Morlinest reviewed Apr 29, 2018

View reviewed changes

kolaente added 2 commits April 29, 2018 17:47

small improvments to xorm session handling when updating an issue dea…

f35fec0

…dline + style nitpicks

style nitpicks

1412580

Morlinest reviewed Apr 29, 2018

View reviewed changes

kolaente added 4 commits April 29, 2018 18:43

Moved checking for if the user has write acces to middleware

fe68965

Merge branch 'master' of https://github.com/go-gitea/gitea into issue…

65e841d

…-due-date

Merge with gitea-master

311dc73

Merge with gitea-master

8d3fff2

jonasfranz approved these changes May 1, 2018

View reviewed changes

Morlinest suggested changes May 1, 2018

View reviewed changes

kolaente added 2 commits May 1, 2018 15:11

renamed remove deadline url

3f570d4

Deleting a deadline is now possible via get

a7a9529

Morlinest approved these changes May 1, 2018

View reviewed changes

lafriks requested changes May 1, 2018

View reviewed changes

Reverted deleting a deadline back to using a post request

d49dd2f

lafriks approved these changes May 1, 2018

View reviewed changes

lafriks merged commit 1a97030 into go-gitea:master May 1, 2018

lafriks added the type/changelog Adds the changelog for a new Gitea version label May 1, 2018

kolaente mentioned this pull request May 2, 2018

Issue due date api #3890

Merged

kolaente deleted the issue-due-date branch January 24, 2019 18:16

go-gitea locked and limited conversation to collaborators Nov 24, 2020

delvh removed the type/changelog Adds the changelog for a new Gitea version label Oct 7, 2023

Issue due date #3794

Issue due date #3794

Conversation

kolaente commented Apr 14, 2018 • edited Loading

Screenshots

TODO

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonasfranz commented May 1, 2018

Morlinest left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Morlinest left a comment

Choose a reason for hiding this comment

kolaente commented May 1, 2018

lafriks left a comment

Choose a reason for hiding this comment

kolaente commented May 1, 2018

kolaente commented May 1, 2018

Morlinest commented May 1, 2018

lafriks commented May 1, 2018

kolaente commented Apr 14, 2018 •

edited

Loading