mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-26 21:54:19 -04:00
I found myself wondering whether a PR I scheduled for automerge was actually merged. It was, but I didn't receive a mail notification for it - that makes sense considering I am the doer and usually don't want to receive such notifications. But ideally I want to receive a notification when a PR was merged because I scheduled it for automerge. This PR implements exactly that. The implementation works, but I wonder if there's a way to avoid passing the "This PR was automerged" state down so much. I tried solving this via the database (checking if there's an automerge scheduled for this PR when sending the notification) but that did not work reliably, probably because sending the notification happens async and the entry might have already been deleted. My implementation might be the most straightforward but maybe not the most elegant. Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: Andrew Thornton <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
203 lines
7.0 KiB
Go
203 lines
7.0 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package mailer
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
access_model "code.gitea.io/gitea/models/perm/access"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unit"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/container"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
)
|
|
|
|
func fallbackMailSubject(issue *issues_model.Issue) string {
|
|
return fmt.Sprintf("[%s] %s (#%d)", issue.Repo.FullName(), issue.Title, issue.Index)
|
|
}
|
|
|
|
type mailCommentContext struct {
|
|
context.Context
|
|
Issue *issues_model.Issue
|
|
Doer *user_model.User
|
|
ActionType activities_model.ActionType
|
|
Content string
|
|
Comment *issues_model.Comment
|
|
ForceDoerNotification bool
|
|
}
|
|
|
|
const (
|
|
// MailBatchSize set the batch size used in mailIssueCommentBatch
|
|
MailBatchSize = 100
|
|
)
|
|
|
|
// mailIssueCommentToParticipants can be used for both new issue creation and comment.
|
|
// This function sends two list of emails:
|
|
// 1. Repository watchers (except for WIP pull requests) and users who are participated in comments.
|
|
// 2. Users who are not in 1. but get mentioned in current issue/comment.
|
|
func mailIssueCommentToParticipants(ctx *mailCommentContext, mentions []*user_model.User) error {
|
|
// Required by the mail composer; make sure to load these before calling the async function
|
|
if err := ctx.Issue.LoadRepo(ctx); err != nil {
|
|
return fmt.Errorf("LoadRepo(): %w", err)
|
|
}
|
|
if err := ctx.Issue.LoadPoster(); err != nil {
|
|
return fmt.Errorf("LoadPoster(): %w", err)
|
|
}
|
|
if err := ctx.Issue.LoadPullRequest(); err != nil {
|
|
return fmt.Errorf("LoadPullRequest(): %w", err)
|
|
}
|
|
|
|
// Enough room to avoid reallocations
|
|
unfiltered := make([]int64, 1, 64)
|
|
|
|
// =========== Original poster ===========
|
|
unfiltered[0] = ctx.Issue.PosterID
|
|
|
|
// =========== Assignees ===========
|
|
ids, err := issues_model.GetAssigneeIDsByIssue(ctx.Issue.ID)
|
|
if err != nil {
|
|
return fmt.Errorf("GetAssigneeIDsByIssue(%d): %w", ctx.Issue.ID, err)
|
|
}
|
|
unfiltered = append(unfiltered, ids...)
|
|
|
|
// =========== Participants (i.e. commenters, reviewers) ===========
|
|
ids, err = issues_model.GetParticipantsIDsByIssueID(ctx.Issue.ID)
|
|
if err != nil {
|
|
return fmt.Errorf("GetParticipantsIDsByIssueID(%d): %w", ctx.Issue.ID, err)
|
|
}
|
|
unfiltered = append(unfiltered, ids...)
|
|
|
|
// =========== Issue watchers ===========
|
|
ids, err = issues_model.GetIssueWatchersIDs(ctx, ctx.Issue.ID, true)
|
|
if err != nil {
|
|
return fmt.Errorf("GetIssueWatchersIDs(%d): %w", ctx.Issue.ID, err)
|
|
}
|
|
unfiltered = append(unfiltered, ids...)
|
|
|
|
// =========== Repo watchers ===========
|
|
// Make repo watchers last, since it's likely the list with the most users
|
|
if !(ctx.Issue.IsPull && ctx.Issue.PullRequest.IsWorkInProgress() && ctx.ActionType != activities_model.ActionCreatePullRequest) {
|
|
ids, err = repo_model.GetRepoWatchersIDs(ctx, ctx.Issue.RepoID)
|
|
if err != nil {
|
|
return fmt.Errorf("GetRepoWatchersIDs(%d): %w", ctx.Issue.RepoID, err)
|
|
}
|
|
unfiltered = append(ids, unfiltered...)
|
|
}
|
|
|
|
visited := make(container.Set[int64], len(unfiltered)+len(mentions)+1)
|
|
|
|
// Avoid mailing the doer
|
|
if ctx.Doer.EmailNotificationsPreference != user_model.EmailNotificationsAndYourOwn && !ctx.ForceDoerNotification {
|
|
visited.Add(ctx.Doer.ID)
|
|
}
|
|
|
|
// =========== Mentions ===========
|
|
if err = mailIssueCommentBatch(ctx, mentions, visited, true); err != nil {
|
|
return fmt.Errorf("mailIssueCommentBatch() mentions: %w", err)
|
|
}
|
|
|
|
// Avoid mailing explicit unwatched
|
|
ids, err = issues_model.GetIssueWatchersIDs(ctx, ctx.Issue.ID, false)
|
|
if err != nil {
|
|
return fmt.Errorf("GetIssueWatchersIDs(%d): %w", ctx.Issue.ID, err)
|
|
}
|
|
visited.AddMultiple(ids...)
|
|
|
|
unfilteredUsers, err := user_model.GetMaileableUsersByIDs(unfiltered, false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if err = mailIssueCommentBatch(ctx, unfilteredUsers, visited, false); err != nil {
|
|
return fmt.Errorf("mailIssueCommentBatch(): %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func mailIssueCommentBatch(ctx *mailCommentContext, users []*user_model.User, visited container.Set[int64], fromMention bool) error {
|
|
checkUnit := unit.TypeIssues
|
|
if ctx.Issue.IsPull {
|
|
checkUnit = unit.TypePullRequests
|
|
}
|
|
|
|
langMap := make(map[string][]*user_model.User)
|
|
for _, user := range users {
|
|
if !user.IsActive {
|
|
// Exclude deactivated users
|
|
continue
|
|
}
|
|
// At this point we exclude:
|
|
// user that don't have all mails enabled or users only get mail on mention and this is one ...
|
|
if !(user.EmailNotificationsPreference == user_model.EmailNotificationsEnabled ||
|
|
user.EmailNotificationsPreference == user_model.EmailNotificationsAndYourOwn ||
|
|
fromMention && user.EmailNotificationsPreference == user_model.EmailNotificationsOnMention) {
|
|
continue
|
|
}
|
|
|
|
// if we have already visited this user we exclude them
|
|
if !visited.Add(user.ID) {
|
|
continue
|
|
}
|
|
|
|
// test if this user is allowed to see the issue/pull
|
|
if !access_model.CheckRepoUnitUser(ctx, ctx.Issue.Repo, user, checkUnit) {
|
|
continue
|
|
}
|
|
|
|
langMap[user.Language] = append(langMap[user.Language], user)
|
|
}
|
|
|
|
for lang, receivers := range langMap {
|
|
// because we know that the len(receivers) > 0 and we don't care about the order particularly
|
|
// working backwards from the last (possibly) incomplete batch. If len(receivers) can be 0 this
|
|
// starting condition will need to be changed slightly
|
|
for i := ((len(receivers) - 1) / MailBatchSize) * MailBatchSize; i >= 0; i -= MailBatchSize {
|
|
msgs, err := composeIssueCommentMessages(ctx, lang, receivers[i:], fromMention, "issue comments")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
SendAsyncs(msgs)
|
|
receivers = receivers[:i]
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// MailParticipants sends new issue thread created emails to repository watchers
|
|
// and mentioned people.
|
|
func MailParticipants(issue *issues_model.Issue, doer *user_model.User, opType activities_model.ActionType, mentions []*user_model.User) error {
|
|
if setting.MailService == nil {
|
|
// No mail service configured
|
|
return nil
|
|
}
|
|
|
|
content := issue.Content
|
|
if opType == activities_model.ActionCloseIssue || opType == activities_model.ActionClosePullRequest ||
|
|
opType == activities_model.ActionReopenIssue || opType == activities_model.ActionReopenPullRequest ||
|
|
opType == activities_model.ActionMergePullRequest || opType == activities_model.ActionAutoMergePullRequest {
|
|
content = ""
|
|
}
|
|
forceDoerNotification := opType == activities_model.ActionAutoMergePullRequest
|
|
if err := mailIssueCommentToParticipants(
|
|
&mailCommentContext{
|
|
Context: context.TODO(), // TODO: use a correct context
|
|
Issue: issue,
|
|
Doer: doer,
|
|
ActionType: opType,
|
|
Content: content,
|
|
Comment: nil,
|
|
ForceDoerNotification: forceDoerNotification,
|
|
}, mentions); err != nil {
|
|
log.Error("mailIssueCommentToParticipants: %v", err)
|
|
}
|
|
return nil
|
|
}
|