Use database to store the project workflow data

Author: lunny

models/project/workflows.go

@@ -5,8 +5,10 @@ package project
 
 import (
 	"context"
+	"fmt"
 
 	"code.gitea.io/gitea/models/db"
+	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/timeutil"
 	"code.gitea.io/gitea/modules/util"
 )
@@ -25,12 +27,88 @@ const (
 	WorkflowEventAutoCloseIssue       WorkflowEvent = "auto_close_issue"
 )
 
+var workflowEvents = []WorkflowEvent{
+	WorkflowEventItemAddedToProject,
+	WorkflowEventItemReopened,
+	WorkflowEventItemClosed,
+	WorkflowEventCodeChangesRequested,
+	WorkflowEventCodeReviewApproved,
+	WorkflowEventPullRequestMerged,
+	WorkflowEventAutoArchiveItems,
+	WorkflowEventAutoAddToProject,
+	WorkflowEventAutoCloseIssue,
+}
+
+func GetWorkflowEvents() []WorkflowEvent {
+	return workflowEvents
+}
+
+func (we WorkflowEvent) ToString() string {
+	switch we {
+	case WorkflowEventItemAddedToProject:
+		return "Item added to project"
+	case WorkflowEventItemReopened:
+		return "Item reopened"
+	case WorkflowEventItemClosed:
+		return "Item closed"
+	case WorkflowEventCodeChangesRequested:
+		return "Code changes requested"
+	case WorkflowEventCodeReviewApproved:
+		return "Code review approved"
+	case WorkflowEventPullRequestMerged:
+		return "Pull request merged"
+	case WorkflowEventAutoArchiveItems:
+		return "Auto archive items"
+	case WorkflowEventAutoAddToProject:
+		return "Auto add to project"
+	case WorkflowEventAutoCloseIssue:
+		return "Auto close issue"
+	default:
+		return string(we)
+	}
+}
+
+func (we WorkflowEvent) UUID() string {
+	switch we {
+	case WorkflowEventItemAddedToProject:
+		return "item_added_to_project"
+	case WorkflowEventItemReopened:
+		return "item_reopened"
+	case WorkflowEventItemClosed:
+		return "item_closed"
+	case WorkflowEventCodeChangesRequested:
+		return "code_changes_requested"
+	case WorkflowEventCodeReviewApproved:
+		return "code_review_approved"
+	case WorkflowEventPullRequestMerged:
+		return "pull_request_merged"
+	case WorkflowEventAutoArchiveItems:
+		return "auto_archive_items"
+	case WorkflowEventAutoAddToProject:
+		return "auto_add_to_project"
+	case WorkflowEventAutoCloseIssue:
+		return "auto_close_issue"
+	default:
+		return string(we)
+	}
+}
+
+type WorkflowFilterType string
+
+const (
+	WorkflowFilterTypeScope WorkflowFilterType = "scope" // issue, pull_request, etc.
+)
+
+type WorkflowFilter struct {
+	Type  WorkflowFilterType
+	Value string // e.g., "issue", "pull_request", etc.
+}
+
 type WorkflowActionType string
 
 const (
-	WorkflowActionTypeScope  WorkflowActionType = "scope"  // issue, pull_request, etc.
+	WorkflowActionTypeColumn WorkflowActionType = "column" // add the item to the project's column
 	WorkflowActionTypeLabel  WorkflowActionType = "label"  // choose one or more labels
-	WorkflowActionTypeColumn WorkflowActionType = "column" // choose one column
 	WorkflowActionTypeClose  WorkflowActionType = "close"  // close the issue
 )
 
@@ -42,50 +120,44 @@ type WorkflowAction struct {
 type ProjectWorkflow struct {
 	ID              int64
 	ProjectID       int64              `xorm:"unique(s)"`
+	Project         *Project           `xorm:"-"`
 	WorkflowEvent   WorkflowEvent      `xorm:"unique(s)"`
+	WorkflowFilters []WorkflowFilter   `xorm:"TEXT json"`
 	WorkflowActions []WorkflowAction   `xorm:"TEXT json"`
 	CreatedUnix     timeutil.TimeStamp `xorm:"created"`
 	UpdatedUnix     timeutil.TimeStamp `xorm:"updated"`
 }
 
-func (p *ProjectWorkflow) Link() string {
-	return ""
-}
-
-func newDefaultWorkflows() []*ProjectWorkflow {
-	return []*ProjectWorkflow{
-		{
-			WorkflowEvent:   WorkflowEventItemAddedToProject,
-			WorkflowActions: []WorkflowAction{{ActionType: WorkflowActionTypeScope, ActionValue: "issue"}},
-		},
-		{
-			ProjectID:       0,
-			WorkflowEvent:   WorkflowEventItemReopened,
-			WorkflowActions: []WorkflowAction{{ActionType: WorkflowActionTypeScope, ActionValue: "issue"}},
-		},
+func (p *ProjectWorkflow) LoadProject(ctx context.Context) error {
+	if p.Project != nil || p.ProjectID <= 0 {
+		return nil
+	}
+	project, err := GetProjectByID(ctx, p.ProjectID)
+	if err != nil {
+		return err
 	}
+	p.Project = project
+	return nil
 }
 
-func GetWorkflowDefaultValue(workflowIDStr string) *ProjectWorkflow {
-	workflows := newDefaultWorkflows()
-	for _, workflow := range workflows {
-		if workflow.WorkflowEvent == WorkflowEvent(workflowIDStr) {
-			return workflow
-		}
+func (p *ProjectWorkflow) Link(ctx context.Context) string {
+	if err := p.LoadProject(ctx); err != nil {
+		log.Error("ProjectWorkflow Link: %v", err)
+		return ""
 	}
-	return &ProjectWorkflow{}
+	return p.Project.Link(ctx) + fmt.Sprintf("/workflows/%d", p.ID)
 }
 
 func init() {
 	db.RegisterModel(new(ProjectWorkflow))
 }
 
-func FindWorkflowEvents(ctx context.Context, projectID int64) (map[WorkflowEvent]ProjectWorkflow, error) {
-	events := make(map[WorkflowEvent]ProjectWorkflow)
+func FindWorkflowEvents(ctx context.Context, projectID int64) (map[WorkflowEvent]*ProjectWorkflow, error) {
+	events := make(map[WorkflowEvent]*ProjectWorkflow)
 	if err := db.GetEngine(ctx).Where("project_id=?", projectID).Find(&events); err != nil {
 		return nil, err
 	}
-	res := make(map[WorkflowEvent]ProjectWorkflow, len(events))
+	res := make(map[WorkflowEvent]*ProjectWorkflow, len(events))
 	for _, event := range events {
 		res[event.WorkflowEvent] = event
 	}
@@ -102,19 +174,3 @@ func GetWorkflowByID(ctx context.Context, id int64) (*ProjectWorkflow, error) {
 	}
 	return p, nil
 }
-
-func GetWorkflows(ctx context.Context, projectID int64) ([]*ProjectWorkflow, error) {
-	events := make([]*ProjectWorkflow, 0, 10)
-	if err := db.GetEngine(ctx).Where("project_id=?", projectID).Find(&events); err != nil {
-		return nil, err
-	}
-	workflows := newDefaultWorkflows()
-	for i, defaultWorkflow := range workflows {
-		for _, workflow := range events {
-			if workflow.WorkflowEvent == defaultWorkflow.WorkflowEvent {
-				workflows[i] = workflow
-			}
-		}
-	}
-	return workflows, nil
-}

modules/projects/workflow.go

@@ -11,9 +11,14 @@ import (
 	"code.gitea.io/gitea/services/context"
 )
 
-var tmplWorkflows = templates.TplName("projects/workflows")
+var (
+	tmplRepoWorkflows = templates.TplName("repo/projects/workflows")
+	tmplOrgWorkflows  = templates.TplName("org/projects/workflows")
+)
 
 func Workflows(ctx *context.Context) {
+	ctx.Data["WorkflowEvents"] = project_model.GetWorkflowEvents()
+
 	projectID := ctx.PathParamInt64("id")
 	p, err := project_model.GetProjectByID(ctx, projectID)
 	if err != nil {
@@ -24,7 +29,11 @@ func Workflows(ctx *context.Context) {
 		}
 		return
 	}
-	if p.RepoID != ctx.Repo.Repository.ID {
+	if p.Type == project_model.TypeRepository && p.RepoID != ctx.Repo.Repository.ID {
+		ctx.NotFound(nil)
+		return
+	}
+	if (p.Type == project_model.TypeOrganization || p.Type == project_model.TypeIndividual) && p.OwnerID != ctx.ContextUser.ID {
 		ctx.NotFound(nil)
 		return
 	}
@@ -33,41 +42,44 @@ func Workflows(ctx *context.Context) {
 	ctx.Data["PageIsWorkflows"] = true
 	ctx.Data["PageIsProjects"] = true
 	ctx.Data["PageIsProjectsWorkflows"] = true
+	ctx.Data["Project"] = p
 
-	workflows, err := project_model.GetWorkflows(ctx, projectID)
+	workflows, err := project_model.FindWorkflowEvents(ctx, projectID)
 	if err != nil {
 		ctx.ServerError("GetWorkflows", err)
 		return
 	}
+	for _, wf := range workflows {
+		wf.Project = p
+	}
 	ctx.Data["Workflows"] = workflows
 
 	workflowIDStr := ctx.PathParam("workflow_id")
-	var workflow *project_model.ProjectWorkflow
+	ctx.Data["workflowIDStr"] = workflowIDStr
+	var curWorkflow *project_model.ProjectWorkflow
 	if workflowIDStr == "" { // get first value workflow or the first workflow
 		for _, wf := range workflows {
 			if wf.ID > 0 {
-				workflow = wf
+				curWorkflow = wf
 				break
 			}
 		}
-		if workflow.ID == 0 {
-			workflow = workflows[0]
-		}
 	} else {
 		workflowID, _ := strconv.ParseInt(workflowIDStr, 10, 64)
 		if workflowID > 0 {
-			var err error
-			workflow, err = project_model.GetWorkflowByID(ctx, workflowID)
-			if err != nil {
-				ctx.ServerError("GetWorkflowByID", err)
-				return
+			for _, wf := range workflows {
+				if wf.ID == workflowID {
+					curWorkflow = wf
+					break
+				}
 			}
-			ctx.Data["CurWorkflow"] = workflow
-		} else {
-			workflow = project_model.GetWorkflowDefaultValue(workflowIDStr)
 		}
 	}
-	ctx.Data["CurWorkflow"] = workflow
+	ctx.Data["CurWorkflow"] = curWorkflow
 
-	ctx.HTML(200, tmplWorkflows)
+	if p.Type == project_model.TypeRepository {
+		ctx.HTML(200, tmplRepoWorkflows)
+	} else {
+		ctx.HTML(200, tmplOrgWorkflows)
+	}
 }

modules/projects/workflow_test.go

@@ -1030,6 +1030,10 @@ func registerWebRoutes(m *web.Router) {
 				m.Get("", org.Projects)
 				m.Get("/{id}", org.ViewProject)
 			}, reqUnitAccess(unit.TypeProjects, perm.AccessModeRead, true))
+			m.Group("/{id}/workflows", func() {
+				m.Get("", projects.Workflows)
+				m.Get("/{workflow_id}", projects.Workflows)
+			})
 			m.Group("", func() { //nolint:dupl
 				m.Get("/new", org.RenderNewProject)
 				m.Post("/new", web.Bind(forms.CreateProjectForm{}), org.NewProjectPost)