mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-05-29 23:52:38 +00:00

Send a Mail when an action run fails or a workflow recovers. This PR depends on https://codeberg.org/forgejo/forgejo/pulls/7491 closes #3719 ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/7509): <!--number 7509 --><!--line 0 --><!--description c2VuZCBtYWlsIG9uIGZhaWxlZCBvciByZWNvdmVyZWQgd29ya2Zsb3cgcnVu-->send mail on failed or recovered workflow run<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7509 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: christopher-besch <mail@chris-besch.com> Co-committed-by: christopher-besch <mail@chris-besch.com>
221 lines
8.4 KiB
Go
221 lines
8.4 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package mailer
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
actions_model "forgejo.org/models/actions"
|
|
activities_model "forgejo.org/models/activities"
|
|
issues_model "forgejo.org/models/issues"
|
|
repo_model "forgejo.org/models/repo"
|
|
user_model "forgejo.org/models/user"
|
|
"forgejo.org/modules/log"
|
|
notify_service "forgejo.org/services/notify"
|
|
)
|
|
|
|
type mailNotifier struct {
|
|
notify_service.NullNotifier
|
|
}
|
|
|
|
var _ notify_service.Notifier = &mailNotifier{}
|
|
|
|
// NewNotifier create a new mailNotifier notifier
|
|
func NewNotifier() notify_service.Notifier {
|
|
return &mailNotifier{}
|
|
}
|
|
|
|
func (m *mailNotifier) CreateIssueComment(ctx context.Context, doer *user_model.User, repo *repo_model.Repository,
|
|
issue *issues_model.Issue, comment *issues_model.Comment, mentions []*user_model.User,
|
|
) {
|
|
var act activities_model.ActionType
|
|
switch comment.Type {
|
|
case issues_model.CommentTypeClose:
|
|
act = activities_model.ActionCloseIssue
|
|
case issues_model.CommentTypeReopen:
|
|
act = activities_model.ActionReopenIssue
|
|
case issues_model.CommentTypeComment:
|
|
act = activities_model.ActionCommentIssue
|
|
case issues_model.CommentTypeCode:
|
|
act = activities_model.ActionCommentIssue
|
|
case issues_model.CommentTypePullRequestPush:
|
|
act = 0
|
|
}
|
|
|
|
if err := MailParticipantsComment(ctx, comment, act, issue, mentions); err != nil {
|
|
log.Error("MailParticipantsComment: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) NewIssue(ctx context.Context, issue *issues_model.Issue, mentions []*user_model.User) {
|
|
if err := MailParticipants(ctx, issue, issue.Poster, activities_model.ActionCreateIssue, mentions); err != nil {
|
|
log.Error("MailParticipants: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) IssueChangeStatus(ctx context.Context, doer *user_model.User, commitID string, issue *issues_model.Issue, actionComment *issues_model.Comment, isClosed bool) {
|
|
var actionType activities_model.ActionType
|
|
if issue.IsPull {
|
|
if isClosed {
|
|
actionType = activities_model.ActionClosePullRequest
|
|
} else {
|
|
actionType = activities_model.ActionReopenPullRequest
|
|
}
|
|
} else {
|
|
if isClosed {
|
|
actionType = activities_model.ActionCloseIssue
|
|
} else {
|
|
actionType = activities_model.ActionReopenIssue
|
|
}
|
|
}
|
|
|
|
if err := MailParticipants(ctx, issue, doer, actionType, nil); err != nil {
|
|
log.Error("MailParticipants: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) IssueChangeTitle(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, oldTitle string) {
|
|
if err := issue.LoadPullRequest(ctx); err != nil {
|
|
log.Error("issue.LoadPullRequest: %v", err)
|
|
return
|
|
}
|
|
if issue.IsPull && issues_model.HasWorkInProgressPrefix(oldTitle) && !issue.PullRequest.IsWorkInProgress(ctx) {
|
|
if err := MailParticipants(ctx, issue, doer, activities_model.ActionPullRequestReadyForReview, nil); err != nil {
|
|
log.Error("MailParticipants: %v", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) NewPullRequest(ctx context.Context, pr *issues_model.PullRequest, mentions []*user_model.User) {
|
|
if err := MailParticipants(ctx, pr.Issue, pr.Issue.Poster, activities_model.ActionCreatePullRequest, mentions); err != nil {
|
|
log.Error("MailParticipants: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) PullRequestReview(ctx context.Context, pr *issues_model.PullRequest, r *issues_model.Review, comment *issues_model.Comment, mentions []*user_model.User) {
|
|
var act activities_model.ActionType
|
|
switch comment.Type {
|
|
case issues_model.CommentTypeClose:
|
|
act = activities_model.ActionCloseIssue
|
|
case issues_model.CommentTypeReopen:
|
|
act = activities_model.ActionReopenIssue
|
|
case issues_model.CommentTypeComment:
|
|
act = activities_model.ActionCommentPull
|
|
}
|
|
if err := MailParticipantsComment(ctx, comment, act, pr.Issue, mentions); err != nil {
|
|
log.Error("MailParticipantsComment: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) PullRequestCodeComment(ctx context.Context, pr *issues_model.PullRequest, comment *issues_model.Comment, mentions []*user_model.User) {
|
|
if err := MailMentionsComment(ctx, pr, comment, mentions); err != nil {
|
|
log.Error("MailMentionsComment: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) IssueChangeAssignee(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, assignee *user_model.User, removed bool, comment *issues_model.Comment) {
|
|
// mail only sent to added assignees and not self-assignee
|
|
if !removed && doer.ID != assignee.ID && assignee.EmailNotificationsPreference != user_model.EmailNotificationsDisabled {
|
|
ct := fmt.Sprintf("Assigned #%d.", issue.Index)
|
|
if err := SendIssueAssignedMail(ctx, issue, doer, ct, comment, []*user_model.User{assignee}); err != nil {
|
|
log.Error("Error in SendIssueAssignedMail for issue[%d] to assignee[%d]: %v", issue.ID, assignee.ID, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) PullRequestReviewRequest(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, reviewer *user_model.User, isRequest bool, comment *issues_model.Comment) {
|
|
if isRequest && doer.ID != reviewer.ID && reviewer.EmailNotificationsPreference != user_model.EmailNotificationsDisabled {
|
|
ct := fmt.Sprintf("Requested to review %s.", issue.HTMLURL())
|
|
if err := SendIssueAssignedMail(ctx, issue, doer, ct, comment, []*user_model.User{reviewer}); err != nil {
|
|
log.Error("Error in SendIssueAssignedMail for issue[%d] to reviewer[%d]: %v", issue.ID, reviewer.ID, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) MergePullRequest(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
|
|
if err := pr.LoadIssue(ctx); err != nil {
|
|
log.Error("LoadIssue: %v", err)
|
|
return
|
|
}
|
|
if err := MailParticipants(ctx, pr.Issue, doer, activities_model.ActionMergePullRequest, nil); err != nil {
|
|
log.Error("MailParticipants: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) AutoMergePullRequest(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
|
|
if err := pr.LoadIssue(ctx); err != nil {
|
|
log.Error("pr.LoadIssue: %v", err)
|
|
return
|
|
}
|
|
if err := MailParticipants(ctx, pr.Issue, doer, activities_model.ActionAutoMergePullRequest, nil); err != nil {
|
|
log.Error("MailParticipants: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) PullRequestPushCommits(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest, comment *issues_model.Comment) {
|
|
var err error
|
|
if err = comment.LoadIssue(ctx); err != nil {
|
|
log.Error("comment.LoadIssue: %v", err)
|
|
return
|
|
}
|
|
if err = comment.Issue.LoadRepo(ctx); err != nil {
|
|
log.Error("comment.Issue.LoadRepo: %v", err)
|
|
return
|
|
}
|
|
if err = comment.Issue.LoadPullRequest(ctx); err != nil {
|
|
log.Error("comment.Issue.LoadPullRequest: %v", err)
|
|
return
|
|
}
|
|
if err = comment.Issue.PullRequest.LoadBaseRepo(ctx); err != nil {
|
|
log.Error("comment.Issue.PullRequest.LoadBaseRepo: %v", err)
|
|
return
|
|
}
|
|
if err := comment.LoadPushCommits(ctx); err != nil {
|
|
log.Error("comment.LoadPushCommits: %v", err)
|
|
}
|
|
m.CreateIssueComment(ctx, doer, comment.Issue.Repo, comment.Issue, comment, nil)
|
|
}
|
|
|
|
func (m *mailNotifier) PullReviewDismiss(ctx context.Context, doer *user_model.User, review *issues_model.Review, comment *issues_model.Comment) {
|
|
if err := comment.Review.LoadReviewer(ctx); err != nil {
|
|
log.Error("Error in PullReviewDismiss while loading reviewer for issue[%d], review[%d] and reviewer[%d]: %v", review.Issue.ID, comment.Review.ID, comment.Review.ReviewerID, err)
|
|
}
|
|
if err := MailParticipantsComment(ctx, comment, activities_model.ActionPullReviewDismissed, review.Issue, nil); err != nil {
|
|
log.Error("MailParticipantsComment: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) NewRelease(ctx context.Context, rel *repo_model.Release) {
|
|
if err := rel.LoadAttributes(ctx); err != nil {
|
|
log.Error("LoadAttributes: %v", err)
|
|
return
|
|
}
|
|
|
|
if rel.IsDraft || rel.IsPrerelease {
|
|
return
|
|
}
|
|
|
|
MailNewRelease(ctx, rel)
|
|
}
|
|
|
|
func (m *mailNotifier) RepoPendingTransfer(ctx context.Context, doer, newOwner *user_model.User, repo *repo_model.Repository) {
|
|
if err := SendRepoTransferNotifyMail(ctx, doer, newOwner, repo); err != nil {
|
|
log.Error("SendRepoTransferNotifyMail: %v", err)
|
|
}
|
|
}
|
|
|
|
func (m *mailNotifier) NewUserSignUp(ctx context.Context, newUser *user_model.User) {
|
|
MailNewUser(ctx, newUser)
|
|
}
|
|
|
|
func (m *mailNotifier) ActionRunNowDone(ctx context.Context, run *actions_model.ActionRun, priorStatus actions_model.Status, lastRun *actions_model.ActionRun) {
|
|
// Only send a mail on a successful run when the workflow recovered (i.e., the run before failed).
|
|
if run.Status.IsSuccess() && (lastRun == nil || lastRun.Status.IsSuccess()) {
|
|
return
|
|
}
|
|
if err := MailActionRun(run, priorStatus, lastRun); err != nil {
|
|
log.Error("MailActionRunNowDone: %v", err)
|
|
}
|
|
}
|