Start implementing issue weights

Author: maantje

models/issues/comment.go

@@ -114,6 +114,10 @@ const (
 
 	CommentTypePin   // 36 pin Issue
 	CommentTypeUnpin // 37 unpin Issue
+
+	CommentTypeAddedWeight    // 38 Added a weight
+	CommentTypeModifiedWeight // 39 Modified the weight
+	CommentTypeRemovedWeight  // 40 Removed a weight
 )
 
 var commentStrings = []string{
@@ -960,6 +964,40 @@ func createDeadlineComment(ctx context.Context, doer *user_model.User, issue *Is
 	return comment, nil
 }
 
+func CreateWeightComment(ctx context.Context, doer *user_model.User, issue *Issue, newWeight int) (*Comment, error) {
+	var content string
+	var commentType CommentType
+
+	// weight = 0 means deleting
+	if newWeight == 0 {
+		commentType = CommentTypeRemovedWeight
+		content = fmt.Sprintf("%d", issue.Weight)
+	} else if issue.Weight == 0 || issue.Weight == newWeight {
+		commentType = CommentTypeAddedWeight
+		content = fmt.Sprintf("%d", newWeight)
+	} else { // Otherwise modified
+		commentType = CommentTypeModifiedWeight
+		content = fmt.Sprintf("%d|%d", newWeight, issue.Weight)
+	}
+
+	if err := issue.LoadRepo(ctx); err != nil {
+		return nil, err
+	}
+
+	opts := &CreateCommentOptions{
+		Type:    commentType,
+		Doer:    doer,
+		Repo:    issue.Repo,
+		Issue:   issue,
+		Content: content,
+	}
+	comment, err := CreateComment(ctx, opts)
+	if err != nil {
+		return nil, err
+	}
+	return comment, nil
+}
+
 // Creates issue dependency comment
 func createIssueDependencyComment(ctx context.Context, doer *user_model.User, issue, dependentIssue *Issue, add bool) (err error) {
 	cType := CommentTypeAddDependency

models/issues/issue.go

@@ -127,6 +127,7 @@ type Issue struct {
 	NumComments       int
 	Ref               string
 	PinOrder          int `xorm:"DEFAULT 0"`
+	Weight            int
 
 	DeadlineUnix timeutil.TimeStamp `xorm:"INDEX"`
 

models/issues/issue_update.go

@@ -459,6 +459,31 @@ func UpdateIssueDeadline(ctx context.Context, issue *Issue, deadlineUnix timeuti
 	return committer.Commit()
 }
 
+// UpdateIssueDeadline updates an issue deadline and adds comments. Setting a deadline to 0 means deleting it.
+func UpdateIssueWeight(ctx context.Context, issue *Issue, weight int, doer *user_model.User) (err error) {
+	// if the weight hasn't changed do nothing
+	if issue.Weight == weight {
+		return nil
+	}
+	ctx, committer, err := db.TxContext(ctx)
+	if err != nil {
+		return err
+	}
+	defer committer.Close()
+
+	// Update the weight
+	if err = UpdateIssueCols(ctx, &Issue{ID: issue.ID, Weight: weight}, "weight"); err != nil {
+		return err
+	}
+
+	// Make the comment
+	if _, err = CreateWeightComment(ctx, doer, issue, weight); err != nil {
+		return fmt.Errorf("createWeightComment: %w", err)
+	}
+
+	return committer.Commit()
+}
+
 // FindAndUpdateIssueMentions finds users mentioned in the given content string, and saves them in the database.
 func FindAndUpdateIssueMentions(ctx context.Context, issue *Issue, doer *user_model.User, content string) (mentions []*user_model.User, err error) {
 	rawMentions := references.FindAllMentionsMarkdown(content)

models/issues/milestone.go

@@ -65,6 +65,7 @@ type Milestone struct {
 	DeadlineString string `xorm:"-"`
 
 	TotalTrackedTime int64 `xorm:"-"`
+	TotalWeight      int   `xorm:"-"`
 }
 
 func init() {
@@ -355,6 +356,28 @@ func (m *Milestone) LoadTotalTrackedTime(ctx context.Context) error {
 	return nil
 }
 
+// LoadTotalWeight loads the total weight for the milestone
+func (m *Milestone) LoadTotalWeight(ctx context.Context) error {
+	type totalTimesByMilestone struct {
+		MilestoneID int64
+		Weight      int
+	}
+	totalTime := &totalTimesByMilestone{MilestoneID: m.ID}
+	has, err := db.GetEngine(ctx).Table("issue").
+		Join("INNER", "milestone", "issue.milestone_id = milestone.id").
+		Select("milestone_id, sum(weight) as weight").
+		Where("milestone_id = ?", m.ID).
+		GroupBy("milestone_id").
+		Get(totalTime)
+	if err != nil {
+		return err
+	} else if !has {
+		return nil
+	}
+	m.TotalWeight = totalTime.Weight
+	return nil
+}
+
 // InsertMilestones creates milestones of repository.
 func InsertMilestones(ctx context.Context, ms ...*Milestone) (err error) {
 	if len(ms) == 0 {

models/issues/milestone_list.go

@@ -130,6 +130,45 @@ func (milestones MilestoneList) LoadTotalTrackedTimes(ctx context.Context) error
 	return nil
 }
 
+// LoadTotalWeight loads for every milestone in the list the TotalWeight by a batch request
+func (milestones MilestoneList) LoadTotalWeight(ctx context.Context) error {
+	type totalWeightByMilestone struct {
+		MilestoneID int64
+		Weight      int
+	}
+	if len(milestones) == 0 {
+		return nil
+	}
+	trackedTimes := make(map[int64]int, len(milestones))
+
+	// Get total tracked time by milestone_id
+	rows, err := db.GetEngine(ctx).Table("issue").
+		Join("INNER", "milestone", "issue.milestone_id = milestone.id").
+		Select("milestone_id, sum(weight) as weight").
+		In("milestone_id", milestones.getMilestoneIDs()).
+		GroupBy("milestone_id").
+		Rows(new(totalWeightByMilestone))
+	if err != nil {
+		return err
+	}
+
+	defer rows.Close()
+
+	for rows.Next() {
+		var totalTime totalWeightByMilestone
+		err = rows.Scan(&totalTime)
+		if err != nil {
+			return err
+		}
+		trackedTimes[totalTime.MilestoneID] = totalTime.Weight
+	}
+
+	for _, milestone := range milestones {
+		milestone.TotalWeight = trackedTimes[milestone.ID]
+	}
+	return nil
+}
+
 // CountMilestonesByRepoCondAndKw map from repo conditions and the keyword of milestones' name to number of milestones matching the options`
 func CountMilestonesMap(ctx context.Context, opts FindMilestoneOptions) (map[int64]int64, error) {
 	sess := db.GetEngine(ctx).Where(opts.ToConds())

models/migrations/v1_23/v305.go

@@ -0,0 +1,13 @@
+// Copyright 2024 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_23 //nolint
+
+import "xorm.io/xorm"
+
+func AssIssueWeight(x *xorm.Engine) error {
+	type Issue struct {
+		Weight int
+	}
+	return x.Sync(new(Issue))
+}

models/project/column.go

@@ -57,20 +57,6 @@ func (Column) TableName() string {
 	return "project_board" // TODO: the legacy table name should be project_column
 }
 
-// NumIssues return counter of all issues assigned to the column
-func (c *Column) NumIssues(ctx context.Context) int {
-	total, err := db.GetEngine(ctx).Table("project_issue").
-		Where("project_id=?", c.ProjectID).
-		And("project_board_id=?", c.ID).
-		GroupBy("issue_id").
-		Cols("issue_id").
-		Count()
-	if err != nil {
-		return 0
-	}
-	return int(total)
-}
-
 func (c *Column) GetIssues(ctx context.Context) ([]*ProjectIssue, error) {
 	issues := make([]*ProjectIssue, 0, 5)
 	if err := db.GetEngine(ctx).Where("project_id=?", c.ProjectID).

modules/structs/issue.go

@@ -122,13 +122,23 @@ type EditDeadlineOption struct {
 	Deadline *time.Time `json:"due_date"`
 }
 
+type EditWeightOption struct {
+	// required:true
+	Weight int `json:"weight"`
+}
+
 // IssueDeadline represents an issue deadline
 // swagger:model
 type IssueDeadline struct {
 	// swagger:strfmt date-time
 	Deadline *time.Time `json:"due_date"`
 }
 
+// IssueWeight represents an issue weight
+type IssueWeight struct {
+	Weight int `json:"weight"`
+}
+
 // IssueFormFieldType defines issue form field type, can be "markdown", "textarea", "input", "dropdown" or "checkboxes"
 type IssueFormFieldType string
 

options/locale/locale_en-US.ini

@@ -18,6 +18,7 @@ language = Language
 notifications = Notifications
 active_stopwatch = Active Time Tracker
 tracked_time_summary = Summary of tracked time based on filters of issue list
+weight_summary = Total weight of all issues in the milestone
 create_new = Create…
 user_profile_and_more = Profile and Settings…
 signed_in_as = Signed in as
@@ -1698,6 +1699,14 @@ issues.due_date_modified = "modified the due date from %[2]s to %[1]s %[3]s"
 issues.due_date_remove = "removed the due date %s %s"
 issues.due_date_overdue = "Overdue"
 issues.due_date_invalid = "The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'."
+issues.weight_added = "added weight of %s %s"
+issues.weight_modified = " changed weight to %s from %s %s"
+issues.weight_removed = "removed weight of %s %s"
+
+issues.weight.title = Weight
+issues.weight.no_weight = No Weight
+issues.weight.remove_weight = remove weight
+
 issues.dependency.title = Dependencies
 issues.dependency.issue_no_dependencies = No dependencies set.
 issues.dependency.pr_no_dependencies = No dependencies set.

routers/api/v1/repo/issue.go

@@ -707,7 +707,7 @@ func CreateIssue(ctx *context.APIContext) {
 		form.Labels = make([]int64, 0)
 	}
 
-	if err := issue_service.NewIssue(ctx, ctx.Repo.Repository, issue, form.Labels, nil, assigneeIDs, 0); err != nil {
+	if err := issue_service.NewIssue(ctx, ctx.Repo.Repository, issue, form.Labels, nil, assigneeIDs, 0, 0); err != nil {
 		if repo_model.IsErrUserDoesNotHaveAccessToRepo(err) {
 			ctx.Error(http.StatusBadRequest, "UserDoesNotHaveAccessToRepo", err)
 		} else if errors.Is(err, user_model.ErrBlockedUser) {