From 64e0ba10de1163791c2f073c6dbb156b6c888255 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Sun, 31 Mar 2024 11:57:14 +0800 Subject: [PATCH 1/2] Add project workflow feature so users can define how to execute steps when project related events fired --- models/project/board.go | 12 +++ models/project/issue.go | 5 ++ models/project/project.go | 24 +++++- modules/projects/workflow.go | 45 ++++++++++ modules/projects/workflow_test.go | 46 ++++++++++ services/projects/workflow_notifier.go | 111 +++++++++++++++++++++++++ 6 files changed, 242 insertions(+), 1 deletion(-) create mode 100644 modules/projects/workflow.go create mode 100644 modules/projects/workflow_test.go create mode 100644 services/projects/workflow_notifier.go diff --git a/models/project/board.go b/models/project/board.go index 5f142a356c..210eaa1dc1 100644 --- a/models/project/board.go +++ b/models/project/board.go @@ -219,6 +219,18 @@ func GetBoard(ctx context.Context, boardID int64) (*Board, error) { return board, nil } +func GetBoardByProjectIDAndBoardName(ctx context.Context, projectID int64, boardName string) (*Board, error) { + board := new(Board) + has, err := db.GetEngine(ctx).Where("project_id=? AND title=?", projectID, boardName).Get(board) + if err != nil { + return nil, err + } else if !has { + return nil, ErrProjectBoardNotExist{ProjectID: projectID, Name: boardName} + } + + return board, nil +} + // UpdateBoard updates a project board func UpdateBoard(ctx context.Context, board *Board) error { var fieldToUpdate []string diff --git a/models/project/issue.go b/models/project/issue.go index ebc9719de5..c98544b0a4 100644 --- a/models/project/issue.go +++ b/models/project/issue.go @@ -75,6 +75,11 @@ func (p *Project) NumOpenIssues(ctx context.Context) int { return int(c) } +func MoveIssueToAnotherBoard(ctx context.Context, issueID int64, newBoard *Board) error { + _, err := db.GetEngine(ctx).Exec("UPDATE `project_issue` SET project_board_id=? WHERE issue_id=?", newBoard.ID, issueID) + return err +} + // MoveIssuesOnProjectBoard moves or keeps issues in a column and sorts them inside that column func MoveIssuesOnProjectBoard(ctx context.Context, board *Board, sortedIssueIDs map[int64]int64) error { return db.WithTx(ctx, func(ctx context.Context) error { diff --git a/models/project/project.go b/models/project/project.go index 8f9ee2a99e..994c4441eb 100644 --- a/models/project/project.go +++ b/models/project/project.go @@ -52,6 +52,7 @@ const ( type ErrProjectNotExist struct { ID int64 RepoID int64 + Name string } // IsErrProjectNotExist checks if an error is a ErrProjectNotExist @@ -61,6 +62,9 @@ func IsErrProjectNotExist(err error) bool { } func (err ErrProjectNotExist) Error() string { + if err.RepoID > 0 && len(err.Name) > 0 { + return fmt.Sprintf("projects does not exist [repo_id: %d, name: %s]", err.RepoID, err.Name) + } return fmt.Sprintf("projects does not exist [id: %d]", err.ID) } @@ -70,7 +74,9 @@ func (err ErrProjectNotExist) Unwrap() error { // ErrProjectBoardNotExist represents a "ProjectBoardNotExist" kind of error. type ErrProjectBoardNotExist struct { - BoardID int64 + BoardID int64 + ProjectID int64 + Name string } // IsErrProjectBoardNotExist checks if an error is a ErrProjectBoardNotExist @@ -80,6 +86,9 @@ func IsErrProjectBoardNotExist(err error) bool { } func (err ErrProjectBoardNotExist) Error() string { + if err.ProjectID > 0 && len(err.Name) > 0 { + return fmt.Sprintf("project board does not exist [project_id: %d, name: %s]", err.ProjectID, err.Name) + } return fmt.Sprintf("project board does not exist [id: %d]", err.BoardID) } @@ -293,6 +302,19 @@ func GetProjectByID(ctx context.Context, id int64) (*Project, error) { return p, nil } +// GetProjectByName returns the projects in a repository +func GetProjectByName(ctx context.Context, repoID int64, name string) (*Project, error) { + p := new(Project) + has, err := db.GetEngine(ctx).Where("repo_id=? AND title=?", repoID, name).Get(p) + if err != nil { + return nil, err + } else if !has { + return nil, ErrProjectNotExist{RepoID: repoID, Name: name} + } + + return p, nil +} + // GetProjectForRepoByID returns the projects in a repository func GetProjectForRepoByID(ctx context.Context, repoID, id int64) (*Project, error) { p := new(Project) diff --git a/modules/projects/workflow.go b/modules/projects/workflow.go new file mode 100644 index 0000000000..751c611801 --- /dev/null +++ b/modules/projects/workflow.go @@ -0,0 +1,45 @@ +// Copyright 2024 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +// Action represents an action that can be taken in a workflow +type Action struct { + SetValue string +} + +const ( + // Project workflow event names + EventItemAddedToProject = "item_added_to_project" + EventItemClosed = "item_closed" +) + +type Event struct { + Name string + Types []string + Actions []Action +} + +type Workflow struct { + Name string + Events []Event +} + +func ParseWorkflow(content string) (*Workflow, error) { + return &Workflow{}, nil +} + +func (w *Workflow) FireAction(evtName string, f func(action Action) error) error { + for _, evt := range w.Events { + if evt.Name == evtName { + for _, action := range evt.Actions { + // Do something with action + if err := f(action); err != nil { + return err + } + } + break + } + } + return nil +} diff --git a/modules/projects/workflow_test.go b/modules/projects/workflow_test.go new file mode 100644 index 0000000000..17147335dd --- /dev/null +++ b/modules/projects/workflow_test.go @@ -0,0 +1,46 @@ +// Copyright 2024 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestParseWorkflow(t *testing.T) { + workflowFile := ` +name: Test Workflow +on: + item_added_to_project: + types: [issue, pull_request] + action: + - set_value: "status=Todo" + + item_closed: + types: [issue, pull_request] + action: + - remove_label: "" + + item_reopened: + action: + + code_changes_requested: + action: + + code_review_approved: + action: + + pull_request_merged: + action: + + auto_add_to_project: + action: +` + + wf, err := ParseWorkflow(workflowFile) + assert.NoError(t, err) + + assert.Equal(t, "Test Workflow", wf.Name) +} diff --git a/services/projects/workflow_notifier.go b/services/projects/workflow_notifier.go new file mode 100644 index 0000000000..1b778fdedb --- /dev/null +++ b/services/projects/workflow_notifier.go @@ -0,0 +1,111 @@ +// Copyright 2024 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package projects + +import ( + "context" + "strings" + + issues_model "code.gitea.io/gitea/models/issues" + project_model "code.gitea.io/gitea/models/project" + user_model "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/git" + "code.gitea.io/gitea/modules/gitrepo" + "code.gitea.io/gitea/modules/log" + project_module "code.gitea.io/gitea/modules/projects" + notify_service "code.gitea.io/gitea/services/notify" +) + +func init() { + notify_service.RegisterNotifier(&workflowNotifier{}) +} + +type workflowNotifier struct { + notify_service.NullNotifier +} + +var _ notify_service.Notifier = &workflowNotifier{} + +// NewNotifier create a new workflowNotifier notifier +func NewNotifier() notify_service.Notifier { + return &workflowNotifier{} +} + +func (m *workflowNotifier) IssueChangeStatus(ctx context.Context, doer *user_model.User, commitID string, issue *issues_model.Issue, actionComment *issues_model.Comment, isClosed bool) { + if isClosed { + if err := issue.LoadRepo(ctx); err != nil { + log.Error("IssueChangeStatus: LoadRepo: %v", err) + return + } + gitRepo, err := gitrepo.OpenRepository(ctx, issue.Repo) + if err != nil { + log.Error("IssueChangeStatus: OpenRepository: %v", err) + return + } + defer gitRepo.Close() + + // Get the commit object for the ref + commit, err := gitRepo.GetCommit(issue.Repo.DefaultBranch) + if err != nil { + log.Error("gitRepo.GetCommit: %w", err) + return + } + + tree, err := commit.SubTree(".gitea/projects") + if _, ok := err.(git.ErrNotExist); ok { + return + } + if err != nil { + log.Error("commit.SubTree: %w", err) + return + } + + entries, err := tree.ListEntriesRecursiveFast() + if err != nil { + log.Error("tree.ListEntriesRecursiveFast: %w", err) + return + } + + ret := make(git.Entries, 0, len(entries)) + for _, entry := range entries { + if strings.HasSuffix(entry.Name(), ".yml") || strings.HasSuffix(entry.Name(), ".yaml") { + ret = append(ret, entry) + } + } + if len(ret) == 0 { + return + } + + for _, entry := range ret { + workflowContent, err := commit.GetFileContent(".gitea/projects/"+entry.Name(), 1024*1024) + if err != nil { + log.Error("gitRepo.GetCommit: %w", err) + return + } + + wf, err := project_module.ParseWorkflow(workflowContent) + if err != nil { + log.Error("IssueChangeStatus: OpenRepository: %v", err) + return + } + projectName := strings.TrimSuffix(strings.TrimSuffix(entry.Name(), ".yml"), ".yaml") + project, err := project_model.GetProjectByName(ctx, issue.RepoID, projectName) + if err != nil { + log.Error("IssueChangeStatus: GetProjectByName: %v", err) + return + } + if err := wf.FireAction(project_module.EventItemClosed, func(action project_module.Action) error { + board, err := project_model.GetBoardByProjectIDAndBoardName(ctx, project.ID, action.SetValue) + if err != nil { + log.Error("IssueChangeStatus: GetBoardByProjectIDAndBoardName: %v", err) + return err + } + return project_model.MoveIssueToAnotherBoard(ctx, issue.ID, board) + }); err != nil { + log.Error("IssueChangeStatus: FireAction: %v", err) + return + } + } + } +} From 95cecbb2943723990aa772c5de97d8b339e17ac8 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 5 Apr 2024 14:18:51 +0800 Subject: [PATCH 2/2] Add NewIssue events --- models/project/issue.go | 8 ++ modules/projects/workflow.go | 6 +- services/projects/workflow_notifier.go | 152 ++++++++++++++++--------- 3 files changed, 110 insertions(+), 56 deletions(-) diff --git a/models/project/issue.go b/models/project/issue.go index c98544b0a4..313cfd7a4f 100644 --- a/models/project/issue.go +++ b/models/project/issue.go @@ -75,6 +75,14 @@ func (p *Project) NumOpenIssues(ctx context.Context) int { return int(c) } +func AddIssueToBoard(ctx context.Context, issueID int64, newBoard *Board) error { + return db.Insert(ctx, &ProjectIssue{ + IssueID: issueID, + ProjectID: newBoard.ProjectID, + ProjectBoardID: newBoard.ID, + }) +} + func MoveIssueToAnotherBoard(ctx context.Context, issueID int64, newBoard *Board) error { _, err := db.GetEngine(ctx).Exec("UPDATE `project_issue` SET project_board_id=? WHERE issue_id=?", newBoard.ID, issueID) return err diff --git a/modules/projects/workflow.go b/modules/projects/workflow.go index 751c611801..0127b12959 100644 --- a/modules/projects/workflow.go +++ b/modules/projects/workflow.go @@ -12,6 +12,7 @@ const ( // Project workflow event names EventItemAddedToProject = "item_added_to_project" EventItemClosed = "item_closed" + EventItem ) type Event struct { @@ -21,8 +22,9 @@ type Event struct { } type Workflow struct { - Name string - Events []Event + Name string + Events []Event + ProjectID int64 } func ParseWorkflow(content string) (*Workflow, error) { diff --git a/services/projects/workflow_notifier.go b/services/projects/workflow_notifier.go index 1b778fdedb..77aac20dd8 100644 --- a/services/projects/workflow_notifier.go +++ b/services/projects/workflow_notifier.go @@ -9,6 +9,7 @@ import ( issues_model "code.gitea.io/gitea/models/issues" project_model "code.gitea.io/gitea/models/project" + repo_model "code.gitea.io/gitea/models/repo" user_model "code.gitea.io/gitea/models/user" "code.gitea.io/gitea/modules/git" "code.gitea.io/gitea/modules/gitrepo" @@ -32,71 +33,114 @@ func NewNotifier() notify_service.Notifier { return &workflowNotifier{} } +func findRepoProjectsWorkflows(ctx context.Context, repo *repo_model.Repository) ([]*project_module.Workflow, error) { + gitRepo, err := gitrepo.OpenRepository(ctx, repo) + if err != nil { + log.Error("IssueChangeStatus: OpenRepository: %v", err) + return nil, err + } + defer gitRepo.Close() + + // Get the commit object for the ref + commit, err := gitRepo.GetCommit(repo.DefaultBranch) + if err != nil { + log.Error("gitRepo.GetCommit: %w", err) + return nil, err + } + + tree, err := commit.SubTree(".gitea/projects") + if _, ok := err.(git.ErrNotExist); ok { + return nil, nil + } + if err != nil { + log.Error("commit.SubTree: %w", err) + return nil, err + } + + entries, err := tree.ListEntriesRecursiveFast() + if err != nil { + log.Error("tree.ListEntriesRecursiveFast: %w", err) + return nil, err + } + + ret := make(git.Entries, 0, len(entries)) + for _, entry := range entries { + if strings.HasSuffix(entry.Name(), ".yml") || strings.HasSuffix(entry.Name(), ".yaml") { + ret = append(ret, entry) + } + } + if len(ret) == 0 { + return nil, nil + } + + wfs := make([]*project_module.Workflow, 0, len(ret)) + for _, entry := range ret { + workflowContent, err := commit.GetFileContent(".gitea/projects/"+entry.Name(), 1024*1024) + if err != nil { + log.Error("gitRepo.GetCommit: %w", err) + return nil, err + } + + wf, err := project_module.ParseWorkflow(workflowContent) + if err != nil { + log.Error("IssueChangeStatus: OpenRepository: %v", err) + return nil, err + } + projectName := strings.TrimSuffix(strings.TrimSuffix(entry.Name(), ".yml"), ".yaml") + project, err := project_model.GetProjectByName(ctx, repo.ID, projectName) + if err != nil { + log.Error("IssueChangeStatus: GetProjectByName: %v", err) + return nil, err + } + wf.ProjectID = project.ID + + wfs = append(wfs, wf) + } + return wfs, nil +} + +func (m *workflowNotifier) NewIssue(ctx context.Context, issue *issues_model.Issue, mentions []*user_model.User) { + if err := issue.LoadRepo(ctx); err != nil { + log.Error("NewIssue: LoadRepo: %v", err) + return + } + wfs, err := findRepoProjectsWorkflows(ctx, issue.Repo) + if err != nil { + log.Error("NewIssue: findRepoProjectsWorkflows: %v", err) + return + } + + for _, wf := range wfs { + if err := wf.FireAction(project_module.EventItemClosed, func(action project_module.Action) error { + board, err := project_model.GetBoardByProjectIDAndBoardName(ctx, wf.ProjectID, action.SetValue) + if err != nil { + log.Error("NewIssue: GetBoardByProjectIDAndBoardName: %v", err) + return err + } + return project_model.AddIssueToBoard(ctx, issue.ID, board) + }); err != nil { + log.Error("NewIssue: FireAction: %v", err) + return + } + } +} +} + func (m *workflowNotifier) IssueChangeStatus(ctx context.Context, doer *user_model.User, commitID string, issue *issues_model.Issue, actionComment *issues_model.Comment, isClosed bool) { if isClosed { if err := issue.LoadRepo(ctx); err != nil { log.Error("IssueChangeStatus: LoadRepo: %v", err) return } - gitRepo, err := gitrepo.OpenRepository(ctx, issue.Repo) + wfs, err := findRepoProjectsWorkflows(ctx, issue.Repo) if err != nil { - log.Error("IssueChangeStatus: OpenRepository: %v", err) - return - } - defer gitRepo.Close() - - // Get the commit object for the ref - commit, err := gitRepo.GetCommit(issue.Repo.DefaultBranch) - if err != nil { - log.Error("gitRepo.GetCommit: %w", err) + log.Error("IssueChangeStatus: findRepoProjectsWorkflows: %v", err) return } - tree, err := commit.SubTree(".gitea/projects") - if _, ok := err.(git.ErrNotExist); ok { - return - } - if err != nil { - log.Error("commit.SubTree: %w", err) - return - } - - entries, err := tree.ListEntriesRecursiveFast() - if err != nil { - log.Error("tree.ListEntriesRecursiveFast: %w", err) - return - } - - ret := make(git.Entries, 0, len(entries)) - for _, entry := range entries { - if strings.HasSuffix(entry.Name(), ".yml") || strings.HasSuffix(entry.Name(), ".yaml") { - ret = append(ret, entry) - } - } - if len(ret) == 0 { - return - } - - for _, entry := range ret { - workflowContent, err := commit.GetFileContent(".gitea/projects/"+entry.Name(), 1024*1024) - if err != nil { - log.Error("gitRepo.GetCommit: %w", err) - return - } - - wf, err := project_module.ParseWorkflow(workflowContent) - if err != nil { - log.Error("IssueChangeStatus: OpenRepository: %v", err) - return - } - projectName := strings.TrimSuffix(strings.TrimSuffix(entry.Name(), ".yml"), ".yaml") - project, err := project_model.GetProjectByName(ctx, issue.RepoID, projectName) - if err != nil { - log.Error("IssueChangeStatus: GetProjectByName: %v", err) - return - } + for _, wf := range wfs { if err := wf.FireAction(project_module.EventItemClosed, func(action project_module.Action) error { - board, err := project_model.GetBoardByProjectIDAndBoardName(ctx, project.ID, action.SetValue) + board, err := project_model.GetBoardByProjectIDAndBoardName(ctx, wf.ProjectID, action.SetValue) if err != nil { log.Error("IssueChangeStatus: GetBoardByProjectIDAndBoardName: %v", err) return err