Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor: webhook message (#18200)

ecmadao29421080671c
diff --git a/backend/component/webhook/manager.go b/backend/component/webhook/manager.go
index ad7eeedaf0..3b324992bf 100644
--- a/backend/component/webhook/manager.go
+++ b/backend/component/webhook/manager.go
@@ -4,12 +4,10 @@ import (
"context"
"fmt"
"log/slog"
- "strconv"
"strings"
"time"
"github.com/gosimple/slug"
- "github.com/nyaruka/phonenumbers"
"github.com/bytebase/bytebase/backend/common"
"github.com/bytebase/bytebase/backend/common/log"
@@ -33,6 +31,8 @@ type Metadata struct {
Issue *store.IssueMessage
}
+type UsersGetter func(ctx context.Context) ([]*store.UserMessage, error)
+
// NewManager creates an activity manager.
func NewManager(store *store.Store, iamManager *iam.Manager) *Manager {
return &Manager{
@@ -68,7 +68,6 @@ func (m *Manager) CreateEvent(ctx context.Context, e *Event) {
func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, eventType storepb.Activity_Type) (*webhook.Context, error) {
var webhookCtx webhook.Context
- var mentions []string
var mentionUsers []*store.UserMessage
setting, err := m.store.GetWorkspaceGeneralSetting(ctx)
@@ -169,20 +168,13 @@ func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, even
case storepb.Activity_NOTIFY_ISSUE_APPROVED:
title = "Issue approved"
titleZh = "工单审批通过"
-
mentionUsers = append(mentionUsers, e.Issue.Creator)
- phone, err := maybeGetPhoneFromUser(e.Issue.Creator)
- if err != nil {
- slog.Warn("failed to parse phone number", slog.String("issue_title", e.Issue.Title), log.BBError(err))
- } else if phone != "" {
- mentions = append(mentions, phone)
- }
case storepb.Activity_NOTIFY_PIPELINE_ROLLOUT:
u := e.IssueRolloutReady
title = "Issue is waiting for rollout"
titleZh = "工单待发布"
- var usersGetters []func(context.Context) ([]*store.UserMessage, error)
+ var usersGetters []UsersGetter
if u.RolloutPolicy.GetAutomatic() {
usersGetters = append(usersGetters, getUsersFromUsers(e.Issue.Creator))
} else {
@@ -191,36 +183,7 @@ func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, even
usersGetters = append(usersGetters, getUsersFromRole(m.store, role, e.Project.ResourceID))
}
}
- mentionedUser := map[int]bool{}
- for _, usersGetter := range usersGetters {
- users, err := usersGetter(ctx)
- if err != nil {
- slog.Warn("failed to get users",
- slog.String("issue_name", e.Issue.Title),
- log.BBError(err))
- return nil, err
- }
- for _, user := range users {
- if mentionedUser[user.ID] {
- continue
- }
- if user.MemberDeleted {
- continue
- }
- mentionedUser[user.ID] = true
- mentionUsers = append(mentionUsers, user)
- phone, err := maybeGetPhoneFromUser(user)
- if err != nil {
- slog.Warn("failed to parse phone number",
- slog.String("issue_name", e.Issue.Title),
- log.BBError(err))
- continue
- }
- if phone != "" {
- mentions = append(mentions, phone)
- }
- }
- }
+ mentionUsers = getUsersForDirectMessage(ctx, e, usersGetters...)
case storepb.Activity_ISSUE_APPROVAL_NOTIFY:
roleWithPrefix := e.IssueApprovalCreate.Role
@@ -228,31 +191,11 @@ func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, even
title = "Issue approval needed"
titleZh = "工单待审批"
- var usersGetter func(ctx context.Context) ([]*store.UserMessage, error)
-
+ var usersGetter UsersGetter
role := strings.TrimPrefix(roleWithPrefix, "roles/")
usersGetter = getUsersFromRole(m.store, role, e.Project.ResourceID)
+ mentionUsers = getUsersForDirectMessage(ctx, e, usersGetter)
- users, err := usersGetter(ctx)
- if err != nil {
- slog.Warn("Failed to post webhook event after changing the issue approval node status, failed to get users",
- slog.String("issue_name", e.Issue.Title),
- log.BBError(err))
- return nil, err
- }
- for _, user := range users {
- mentionUsers = append(mentionUsers, user)
- phone, err := maybeGetPhoneFromUser(user)
- if err != nil {
- slog.Warn("failed to parse phone number",
- slog.String("issue_name", e.Issue.Title),
- log.BBError(err))
- continue
- }
- if phone != "" {
- mentions = append(mentions, phone)
- }
- }
default:
// Unsupported event type
return nil, errors.Errorf("unsupported activity type %q for generating webhook context", e.Type)
@@ -276,15 +219,14 @@ func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, even
Name: common.FormatProject(e.Project.ResourceID),
Title: e.Project.Title,
},
- Stage: nil,
- TaskResult: nil,
- Description: e.Comment,
- Link: link,
- ActorID: e.Actor.ID,
- ActorName: e.Actor.Name,
- ActorEmail: e.Actor.Email,
- MentionEndUsers: mentionEndUsers,
- MentionUsersByPhone: mentions,
+ Stage: nil,
+ TaskResult: nil,
+ Description: e.Comment,
+ Link: link,
+ ActorID: e.Actor.ID,
+ ActorName: e.Actor.Name,
+ ActorEmail: e.Actor.Email,
+ MentionEndUsers: mentionEndUsers,
}
if e.Issue != nil {
webhookCtx.Issue = &webhook.Issue{
@@ -318,6 +260,34 @@ func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, even
return &webhookCtx, nil
}
+func getUsersForDirectMessage(ctx context.Context, e *Event, usersGetters ...UsersGetter) []*store.UserMessage {
+ mentionedUser := map[int]bool{}
+ mentionUsers := []*store.UserMessage{}
+
+ for _, usersGetter := range usersGetters {
+ users, err := usersGetter(ctx)
+ if err != nil {
+ slog.Warn("failed to get users",
+ slog.String("event", e.Type.String()),
+ slog.String("issue_name", e.Issue.Title),
+ slog.Int("issue_uid", e.Issue.UID),
+ log.BBError(err))
+ continue
+ }
+ for _, user := range users {
+ if mentionedUser[user.ID] {
+ continue
+ }
+ if user.MemberDeleted {
+ continue
+ }
+ mentionedUser[user.ID] = true
+ mentionUsers = append(mentionUsers, user)
+ }
+ }
+ return mentionUsers
+}
+
func (m *Manager) postWebhookList(ctx context.Context, webhookCtx *webhook.Context, webhookList []*store.ProjectWebhookMessage) {
ctx = context.WithoutCancel(ctx)
setting, err := m.store.GetAppIMSetting(ctx)
@@ -337,7 +307,7 @@ func (m *Manager) postWebhookList(ctx context.Context, webhookCtx *webhook.Conte
return webhook.Post(hook.Payload.GetType(), *webhookCtx)
}); err != nil {
// The external webhook endpoint might be invalid which is out of our code control, so we just emit a warning
- slog.Warn("Failed to post webhook event on activity",
+ slog.Warn("failed to post webhook event on activity",
slog.String("webhook type", hook.Payload.GetType().String()),
slog.String("webhook name", hook.Payload.GetTitle()),
slog.String("activity type", webhookCtx.EventType),
@@ -349,7 +319,7 @@ func (m *Manager) postWebhookList(ctx context.Context, webhookCtx *webhook.Conte
}
}
-func getUsersFromRole(s *store.Store, role string, projectID string) func(context.Context) ([]*store.UserMessage, error) {
+func getUsersFromRole(s *store.Store, role string, projectID string) UsersGetter {
return func(ctx context.Context) ([]*store.UserMessage, error) {
projectIAM, err := s.GetProjectIamPolicy(ctx, projectID)
if err != nil {
@@ -364,32 +334,12 @@ func getUsersFromRole(s *store.Store, role string, projectID string) func(contex
}
}
-func getUsersFromUsers(users ...*store.UserMessage) func(context.Context) ([]*store.UserMessage, error) {
+func getUsersFromUsers(users ...*store.UserMessage) UsersGetter {
return func(_ context.Context) ([]*store.UserMessage, error) {
return users, nil
}
}
-func maybeGetPhoneFromUser(user *store.UserMessage) (string, error) {
- if user == nil {
- return "", nil
- }
- if user.Phone == "" {
- return "", nil
- }
- phoneNumber, err := phonenumbers.Parse(user.Phone, "")
- if err != nil {
- return "", errors.Wrapf(err, "failed to parse phone number %q", user.Phone)
- }
- if phoneNumber == nil {
- return "", nil
- }
- if phoneNumber.NationalNumber == nil {
- return "", nil
- }
- return strconv.FormatInt(int64(*phoneNumber.NationalNumber), 10), nil
-}
-
// ChangeIssueStatus changes the status of an issue.
func ChangeIssueStatus(ctx context.Context, stores *store.Store, webhookManager *Manager, issue *store.IssueMessage, newStatus storepb.Issue_Status, updater *store.UserMessage, comment string) error {
updateIssueMessage := &store.UpdateIssueMessage{Status: &newStatus}
diff --git a/backend/plugin/webhook/dingtalk/dingtalk.go b/backend/plugin/webhook/dingtalk/dingtalk.go
index ca017d2480..593dd840d2 100644
--- a/backend/plugin/webhook/dingtalk/dingtalk.go
+++ b/backend/plugin/webhook/dingtalk/dingtalk.go
@@ -8,9 +8,11 @@ import (
"io"
"log/slog"
"net/http"
+ "strconv"
"strings"
"github.com/cenkalti/backoff/v5"
+ "github.com/nyaruka/phonenumbers"
"github.com/pkg/errors"
"go.uber.org/multierr"
@@ -18,6 +20,7 @@ import (
"github.com/bytebase/bytebase/backend/common/log"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/webhook"
+ "github.com/bytebase/bytebase/backend/store"
)
// getDingTalkConfig extracts the DingTalk configuration from the AppIMSetting.
@@ -132,12 +135,41 @@ func sendDirectMessage(webhookCtx webhook.Context) bool {
return true
}
+func maybeGetPhoneFromUser(user *store.UserMessage) (string, error) {
+ if user == nil {
+ return "", nil
+ }
+ if user.Phone == "" {
+ return "", nil
+ }
+ phoneNumber, err := phonenumbers.Parse(user.Phone, "")
+ if err != nil {
+ return "", errors.Wrapf(err, "failed to parse phone number %q", user.Phone)
+ }
+ if phoneNumber == nil {
+ return "", nil
+ }
+ if phoneNumber.NationalNumber == nil {
+ return "", nil
+ }
+ return strconv.FormatInt(int64(*phoneNumber.NationalNumber), 10), nil
+}
+
func sendMessage(context webhook.Context) error {
text := getMarkdownText(context)
- if len(context.MentionUsersByPhone) > 0 {
+ mentionUsersByPhone := []string{}
+
+ if len(context.MentionEndUsers) > 0 {
var ats []string
- for _, phone := range context.MentionUsersByPhone {
- ats = append(ats, fmt.Sprintf("@%s", phone))
+ for _, user := range context.MentionEndUsers {
+ phone, err := maybeGetPhoneFromUser(user)
+ if err != nil {
+ slog.Warn("failed to parse user phone", log.BBError(err), slog.String("user", user.Name))
+ continue
+ }
+ if phone != "" {
+ ats = append(ats, fmt.Sprintf("@%s", phone))
+ }
}
text += "\n" + strings.Join(ats, " ")
}
@@ -149,8 +181,8 @@ func sendMessage(context webhook.Context) error {
Text: text,
},
}
- if len(context.MentionUsersByPhone) > 0 {
- post.Mention.Mobiles = append(post.Mention.Mobiles, context.MentionUsersByPhone...)
+ if len(mentionUsersByPhone) > 0 {
+ post.Mention.Mobiles = append(post.Mention.Mobiles, mentionUsersByPhone...)
}
body, err := json.Marshal(post)
diff --git a/backend/plugin/webhook/slack/slack.go b/backend/plugin/webhook/slack/slack.go
index 4dea2eb900..ed6236f671 100644
--- a/backend/plugin/webhook/slack/slack.go
+++ b/backend/plugin/webhook/slack/slack.go
@@ -145,6 +145,7 @@ func (*Receiver) Post(context webhook.Context) error {
if postDirectMessage(context) {
return nil
}
+ slog.Warn("failed to send direct messages for slack users, fallback to normal webhook", slog.String("event", context.EventType))
}
return postMessage(context)
}
@@ -196,6 +197,7 @@ func postDirectMessage(webhookCtx webhook.Context) bool {
ctx := context.Background()
t := getSlackToken(webhookCtx.IMSetting)
if t == "" {
+ slog.Warn("failed to found valid slack im token", slog.String("event", webhookCtx.EventType))
return false
}
p := newProvider(t)
@@ -228,7 +230,7 @@ func postDirectMessage(webhookCtx webhook.Context) bool {
}
return errs
}); err != nil {
- slog.Warn("failed to send direct message to slack user", log.BBError(err))
+ slog.Warn("failed to send direct message to slack user", log.BBError(err), slog.String("event", webhookCtx.EventType))
return false
}
diff --git a/backend/plugin/webhook/webhook.go b/backend/plugin/webhook/webhook.go
index 82d2348ff1..990b715e0a 100644
--- a/backend/plugin/webhook/webhook.go
+++ b/backend/plugin/webhook/webhook.go
@@ -95,8 +95,7 @@ type Context struct {
Project *Project
TaskResult *TaskResult
// End users that should be mentioned.
- MentionEndUsers []*store.UserMessage
- MentionUsersByPhone []string
+ MentionEndUsers []*store.UserMessage
DirectMessage bool
IMSetting *storepb.AppIMSetting
diff --git a/frontend/src/components/ProjectWebhookForm.vue b/frontend/src/components/ProjectWebhookForm.vue
index 062ecd0a7c..8221513c47 100644
--- a/frontend/src/components/ProjectWebhookForm.vue
+++ b/frontend/src/components/ProjectWebhookForm.vue
@@ -87,6 +87,40 @@
:disabled="!allowEdit"
/>
</div>
+ <div>
+ <div class="text-md leading-6 font-medium text-main">
+ {{ $t("project.webhook.triggering-activity") }}
+ <RequiredStar />
+ </div>
+ <div class="flex flex-col gap-y-4 mt-2">
+ <div v-for="(item, index) in webhookActivityItemList" :key="index">
+ <div>
+ <div class="flex items-center">
+ <NCheckbox
+ :label="item.title"
+ :checked="isEventOn(item.activity)"
+ @update:checked="
+ (on: boolean) => {
+ toggleEvent(item.activity, on);
+ }
+ "
+ />
+ <NTooltip
+ v-if="
+ webhookSupportDirectMessage && item.supportDirectMessage
+ "
+ >
+ <template #trigger>
+ <InfoIcon class="w-4 h-auto text-gray-500" />
+ </template>
+ {{ $t("project.webhook.activity-support-direct-message") }}
+ </NTooltip>
+ </div>
+ <div class="textinfolabel">{{ item.label }}</div>
+ </div>
+ </div>
+ </div>
+ </div>
<div v-if="webhookSupportDirectMessage">
<div class="text-md leading-6 font-medium text-main">
{{ $t("project.webhook.direct-messages") }}
@@ -141,44 +175,10 @@
/>
</div>
</div>
- <div>
- <div class="text-md leading-6 font-medium text-main">
- {{ $t("project.webhook.triggering-activity") }}
- <RequiredStar />
- </div>
- <div class="flex flex-col gap-y-4 mt-2">
- <div v-for="(item, index) in webhookActivityItemList" :key="index">
- <div>
- <div class="flex items-center">
- <NCheckbox
- :label="item.title"
- :checked="isEventOn(item.activity)"
- @update:checked="
- (on: boolean) => {
- toggleEvent(item.activity, on);
- }
- "
- />
- <NTooltip
- v-if="
- webhookSupportDirectMessage && item.supportDirectMessage
- "
- >
- <template #trigger>
- <InfoIcon class="w-4 h-auto text-gray-500" />
- </template>
- {{ $t("project.webhook.activity-support-direct-message") }}
- </NTooltip>
- </div>
- <div class="textinfolabel">{{ item.label }}</div>
- </div>
- </div>
- </div>
- <div class="mt-4">
- <NButton @click.prevent="testWebhook">
- {{ $t("project.webhook.test-webhook") }}
- </NButton>
- </div>
+ <div class="mt-4">
+ <NButton @click.prevent="testWebhook">
+ {{ $t("project.webhook.test-webhook") }}
+ </NButton>
</div>
</div>
</template>
@@ -201,7 +201,7 @@
:require-confirm="true"
@confirm="deleteWebhook"
/>
- <div class="gap-x-3">
+ <div class="flex items-center gap-x-3">
<NButton v-if="create" @click.prevent="cancel">
{{ $t("common.cancel") }}
</NButton>