feat: merge push function

Author: CutebreadCat

cmd/common/main.go

@@ -216,15 +216,7 @@ func syncNoticeTask(ctx context.Context) error {
 		// 进行消息推送
 		if ok := umeng.EnqueueAsync(func() error {
 			deeplink := constants.UmengJwchNoticeDeeplink + "?url=" + url.QueryEscape(info.URL)
-			err = umeng.SendAndroidGroupcastWithGoApp(constants.UmengJwchNotificationTitle, info.Title, "", constants.UmengJwchNoticeTag, "教务处", deeplink)
-			if err != nil {
-				logger.WithCtx(ctx).Errorf("notice sync task: failed to send notice to Android: %v", err)
-			}
-
-			err = umeng.SendIOSGroupcast(constants.UmengJwchNotificationTitle, "", info.Title, constants.UmengJwchNoticeTag, "教务处", deeplink)
-			if err != nil {
-				logger.WithCtx(ctx).Errorf("notice sync task: failed to send notice to IOS: %v", err)
-			}
+			umeng.PushByType(constants.UmengPushTypeTeaching, constants.UmengJwchNotificationTitle, info.Title, "", constants.UmengJwchNoticeTag, "教务处", deeplink)
 			logger.WithCtx(ctx).Infof("notice sync task: notice send success")
 			return nil
 		}); !ok {

config/types.go

@@ -167,11 +167,8 @@ type XiaomiNoticeTemplate struct {
 	TemplateID string `mapstructure:"template_id"`
 }
 
-type XiaomiNotice struct {
-	Score    XiaomiNoticeTemplate `mapstructure:"score"`
-	Exam     XiaomiNoticeTemplate `mapstructure:"exam"`
-	Teaching XiaomiNoticeTemplate `mapstructure:"teaching"`
-}
+// XiaomiNotice 小米推送模板配置，key 为推送类型（score/exam/teaching），对应 pkg/constants 中的 UmengPushType*
+type XiaomiNotice map[string]XiaomiNoticeTemplate
 
 type vendors struct {
 	ChannelActivity string          `mapstructure:"channel_activity"`

internal/academic/service/get_scores.go

@@ -205,14 +205,7 @@ func (s *AcademicService) sendNotifications(courseName, tag string) (err error)
 	title := constants.UmengGradeNotificationTitle
 	text := fmt.Sprintf("%v%v", courseName, constants.UmengGradeNotificationBodySuffix)
 	description := fmt.Sprintf("成绩更新%v", tag[:12])
-	err = umeng.SendAndroidGroupcastWithGoApp(title, text, "", tag, description, constants.UmengGradeDeeplink)
-	if err != nil {
-		logger.Errorf("task queue: failed to send notice to Android: %v", err)
-	}
-	err = umeng.SendIOSGroupcast(title, "", text, tag, description, constants.UmengGradeDeeplink)
-	if err != nil {
-		logger.Errorf("task queue: failed to send notice to IOS: %v", err)
-	}
+	umeng.PushByType(constants.UmengPushTypeScore, title, text, "", tag, description, constants.UmengGradeDeeplink)
 
 	logger.Infof("task queue: send notice to app, tag:%v", tag)
 	return nil

internal/academic/service/get_scores_test.go

@@ -30,6 +30,7 @@ import (
 	baseContext "github.com/west2-online/fzuhelper-server/pkg/base/context"
 	"github.com/west2-online/fzuhelper-server/pkg/cache"
 	academicCache "github.com/west2-online/fzuhelper-server/pkg/cache/academic"
+	"github.com/west2-online/fzuhelper-server/pkg/constants"
 	"github.com/west2-online/fzuhelper-server/pkg/db"
 	academicDB "github.com/west2-online/fzuhelper-server/pkg/db/academic"
 	dbModel "github.com/west2-online/fzuhelper-server/pkg/db/model"
@@ -615,11 +616,27 @@ func TestAcademicService_sendNotifications(t *testing.T) {
 			courseName := "数据结构"
 			tag := "abcdefghijklmnopqrstuvwxyz123456"
 
-			// Mock umeng 推送成功
-			umengAndroidPatch := mockey.Mock(umeng.SendAndroidGroupcastWithGoApp).Return(nil).Build()
+			// Mock umeng 推送成功，并断言按成绩类型下发
+			umengAndroidPatch := mockey.Mock(umeng.SendAndroidGroupcastWithGoApp).To(
+				func(pushType, title, text, ticker, gotTag, description, deeplink string) error {
+					So(pushType, ShouldEqual, constants.UmengPushTypeScore)
+					So(title, ShouldEqual, constants.UmengGradeNotificationTitle)
+					So(text, ShouldEqual, courseName+constants.UmengGradeNotificationBodySuffix)
+					So(gotTag, ShouldEqual, tag)
+					So(description, ShouldEqual, fmt.Sprintf("成绩更新%v", tag[:12]))
+					So(deeplink, ShouldEqual, constants.UmengGradeDeeplink)
+					return nil
+				},
+			).Build()
 			defer umengAndroidPatch.UnPatch()
 
-			umengIOSPatch := mockey.Mock(umeng.SendIOSGroupcast).Return(nil).Build()
+			iosCalled := false
+			umengIOSPatch := mockey.Mock(umeng.SendIOSGroupcast).To(
+				func(title, subtitle, body, tag, description, deeplink string) error {
+					iosCalled = true
+					return nil
+				},
+			).Build()
 			defer umengIOSPatch.UnPatch()
 
 			ctx := context.Background()
@@ -631,6 +648,7 @@ func TestAcademicService_sendNotifications(t *testing.T) {
 
 			// Then: 应该成功发送推送
 			So(err, ShouldBeNil)
+			So(iosCalled, ShouldBeTrue)
 		})
 
 		Convey("should handle notification errors gracefully", func() {

internal/course/service/exam_snapshot_test.go

@@ -22,6 +22,7 @@ import (
 	"github.com/bytedance/mockey"
 	"github.com/stretchr/testify/assert"
 
+	"github.com/west2-online/fzuhelper-server/pkg/constants"
 	"github.com/west2-online/fzuhelper-server/pkg/umeng"
 	"github.com/west2-online/fzuhelper-server/pkg/utils"
 	"github.com/west2-online/jwch"
@@ -178,7 +179,8 @@ func TestCourseServiceSendExamNotification(t *testing.T) {
 	for _, tt := range tests {
 		mockey.PatchConvey(tt.name, t, func() {
 			mockey.Mock(umeng.SendAndroidGroupcastWithGoApp).To(
-				func(title, text, ticker, tag, description, deeplink string) error {
+				func(pushType, title, text, ticker, tag, description, deeplink string) error {
+					assert.Equal(t, constants.UmengPushTypeExam, pushType)
 					assert.Equal(t, "fzuhelper://exam-room", deeplink)
 					return tt.androidErr
 				},

internal/course/service/get_course_list.go

@@ -34,7 +34,6 @@ import (
 	"github.com/west2-online/fzuhelper-server/pkg/constants"
 	"github.com/west2-online/fzuhelper-server/pkg/db/model"
 	"github.com/west2-online/fzuhelper-server/pkg/errno"
-	"github.com/west2-online/fzuhelper-server/pkg/logger"
 	"github.com/west2-online/fzuhelper-server/pkg/taskqueue"
 	"github.com/west2-online/fzuhelper-server/pkg/umeng"
 	"github.com/west2-online/fzuhelper-server/pkg/utils"
@@ -266,17 +265,7 @@ func (s *CourseService) sendExamNotification(change courseExamChange) {
 	title := constants.UmengExamNotificationTitle
 	text := fmt.Sprintf("%v%v", change.Exam.Name, constants.UmengExamNotificationBodySuffix)
 	description := fmt.Sprintf("考试信息更新%v", change.Tag[:12])
-	if err := umeng.SendAndroidGroupcastWithGoApp(
-		title, text, "", change.Tag, description, constants.UmengExamRoomDeeplink,
-	); err != nil {
-		logger.Errorf("CourseService.sendExamNotification: send Android notification failed: %v", err)
-	}
-
-	if err := umeng.SendIOSGroupcast(
-		title, "", text, change.Tag, description, constants.UmengExamRoomDeeplink,
-	); err != nil {
-		logger.Errorf("CourseService.sendExamNotification: send iOS notification failed: %v", err)
-	}
+	umeng.PushByType(constants.UmengPushTypeExam, title, text, "", change.Tag, description, constants.UmengExamRoomDeeplink)
 }
 
 func (s *CourseService) GetCourseListYjsy(req *course.CourseListRequest, loginData *kitexModel.LoginData) ([]*kitexModel.Course, error) {

pkg/constants/umeng.go

@@ -37,6 +37,13 @@ const (
 	UmengJwchNoticeDeeplink = "fzuhelper://office_notice" // 教务处通知的deeplink
 )
 
+// 推送类型，用于按业务场景选择对应的推送模板
+const (
+	UmengPushTypeScore    = "score"    // 推送类型：成绩通知
+	UmengPushTypeExam     = "exam"     // 推送类型：考试通知
+	UmengPushTypeTeaching = "teaching" // 推送类型：教务处通知
+)
+
 const (
 	UmengXiaomiTemplateKeyword       = "keywords1" // 小米模板的参数占位符
 	UmengGradeNotificationTitle      = "成绩更新啦"

pkg/umeng/groupcast.go

@@ -58,27 +58,18 @@ func getChannelProperties(title, content string) AndroidChannelProperties {
 	}
 }
 
-func getXiaomiNoticeProperties(text, deeplink string, notice config.XiaomiNotice) (string, *XiaomiExtraProperties) {
-	var template config.XiaomiNoticeTemplate
-	var keyword string
-	baseDeeplink, _, _ := strings.Cut(deeplink, "?")
-	// 这里分割是因为后端传给前端的教务处通知的deeplink是带有url的
-	// 所以要进行一个分割,让他能够匹配基础的类型(常量包定义)
-	switch baseDeeplink {
-	case constants.UmengGradeDeeplink:
-		template = notice.Score
-		keyword = strings.TrimSuffix(text, constants.UmengGradeNotificationBodySuffix)
-		// 从具体内容当中分割出{"keywords1"}
-	case constants.UmengExamRoomDeeplink:
-		template = notice.Exam
-		keyword = strings.TrimSuffix(text, constants.UmengExamNotificationBodySuffix)
-	case constants.UmengJwchNoticeDeeplink:
-		template = notice.Teaching
-		keyword = text
-	default:
+// getXiaomiNoticeProperties 按推送类型从小米模板注册表与配置中选取模板，
+// 模板参数由 keyword 提取规则（去掉正文后缀）得到
+func getXiaomiNoticeProperties(text, pushType string, notice config.XiaomiNotice) (string, *XiaomiExtraProperties) {
+	kind, ok := xiaomiTemplateKinds[pushType]
+	if !ok {
 		return "", nil
 	}
-
+	template, ok := notice[pushType]
+	if !ok {
+		return "", nil
+	}
+	keyword := strings.TrimSuffix(text, kind.KeywordSuffix)
 	if template.ChannelID == "" || template.TemplateID == "" || keyword == "" {
 		return "", nil
 	}
@@ -99,11 +90,21 @@ func getXiaomiNoticeProperties(text, deeplink string, notice config.XiaomiNotice
 	}
 }
 
-func SendAndroidGroupcastWithGoApp(title, text, ticker, tag, description, deeplink string) error {
+// PushByType 按推送类型同时下发安卓与 iOS 推送，任一端失败仅记录日志，不影响业务（尽力而为）
+func PushByType(pushType, title, text, ticker, tag, description, deeplink string) {
+	if err := SendAndroidGroupcastWithGoApp(pushType, title, text, ticker, tag, description, deeplink); err != nil {
+		logger.Errorf("umeng.PushByType: %s failed to send Android groupcast: %v", pushType, err)
+	}
+	if err := SendIOSGroupcast(title, "", text, tag, description, deeplink); err != nil {
+		logger.Errorf("umeng.PushByType: %s failed to send IOS groupcast: %v", pushType, err)
+	}
+}
+
+func SendAndroidGroupcastWithGoApp(pushType, title, text, ticker, tag, description, deeplink string) error {
 	channelProperties := getChannelProperties(title, text)
 	xiaomiChannelID, xiaomiExtraProperties := getXiaomiNoticeProperties(
 		text,
-		deeplink,
+		pushType,
 		config.Vendors.XiaomiNotice,
 	)
 	if xiaomiChannelID != "" && xiaomiExtraProperties != nil {

pkg/umeng/groupcast_test.go

@@ -19,21 +19,72 @@ package umeng
 import (
 	"testing"
 
+	"github.com/bytedance/mockey"
+	"github.com/stretchr/testify/assert"
+
 	"github.com/west2-online/fzuhelper-server/config"
 	"github.com/west2-online/fzuhelper-server/pkg/constants"
 )
 
+func TestPushByType(t *testing.T) {
+	tests := []struct {
+		name       string
+		pushType   string
+		androidErr error
+		iosErr     error
+	}{
+		{
+			name:     "send to both android and ios",
+			pushType: constants.UmengPushTypeScore,
+		},
+		{
+			name:       "ignore android and ios failures",
+			pushType:   constants.UmengPushTypeExam,
+			androidErr: assert.AnError,
+			iosErr:     assert.AnError,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var androidPushType string
+			androidPatch := mockey.Mock(SendAndroidGroupcastWithGoApp).To(
+				func(pushType, title, text, ticker, tag, description, deeplink string) error {
+					androidPushType = pushType
+					return tt.androidErr
+				},
+			).Build()
+			defer androidPatch.UnPatch()
+
+			iosCalled := false
+			iosPatch := mockey.Mock(SendIOSGroupcast).To(
+				func(title, subtitle, body, tag, description, deeplink string) error {
+					iosCalled = true
+					return tt.iosErr
+				},
+			).Build()
+			defer iosPatch.UnPatch()
+
+			// PushByType 为尽力而为，两端失败仅记录日志，不应 panic
+			PushByType(tt.pushType, "title", "text", "ticker", "tag", "description", "deeplink")
+
+			assert.Equal(t, tt.pushType, androidPushType)
+			assert.True(t, iosCalled)
+		})
+	}
+}
+
 func TestGetXiaomiNoticeProperties(t *testing.T) {
 	notice := config.XiaomiNotice{
-		Score: config.XiaomiNoticeTemplate{
+		constants.UmengPushTypeScore: {
 			ChannelID:  "score-channel",
 			TemplateID: "P12395",
 		},
-		Exam: config.XiaomiNoticeTemplate{
+		constants.UmengPushTypeExam: {
 			ChannelID:  "exam-channel",
 			TemplateID: "P12394",
 		},
-		Teaching: config.XiaomiNoticeTemplate{
+		constants.UmengPushTypeTeaching: {
 			ChannelID:  "teaching-channel",
 			TemplateID: "P12325",
 		},
@@ -42,44 +93,44 @@ func TestGetXiaomiNoticeProperties(t *testing.T) {
 	tests := []struct {
 		name          string
 		text          string
-		deeplink      string
+		pushType      string
 		wantChannelID string
 		wantTemplate  string
 		wantKeyword   string
 	}{
 		{
 			name:          "score",
 			text:          "数据结构" + constants.UmengGradeNotificationBodySuffix,
-			deeplink:      constants.UmengGradeDeeplink,
+			pushType:      constants.UmengPushTypeScore,
 			wantChannelID: "score-channel",
 			wantTemplate:  "P12395",
 			wantKeyword:   "数据结构",
 		},
 		{
 			name:          "exam",
 			text:          "数据结构" + constants.UmengExamNotificationBodySuffix,
-			deeplink:      constants.UmengExamRoomDeeplink,
+			pushType:      constants.UmengPushTypeExam,
 			wantChannelID: "exam-channel",
 			wantTemplate:  "P12394",
 			wantKeyword:   "数据结构",
 		},
 		{
 			name:          "teaching",
 			text:          "关于补考安排的通知",
-			deeplink:      constants.UmengJwchNoticeDeeplink + "?url=https%3A%2F%2Fexample.com%2Fnotice",
+			pushType:      constants.UmengPushTypeTeaching,
 			wantChannelID: "teaching-channel",
 			wantTemplate:  "P12325",
 			wantKeyword:   "关于补考安排的通知",
 		},
 		{
-			name:     "unknown deeplink",
-			deeplink: "fzuhelper://unknown",
+			name:     "unknown push type",
+			pushType: "unknown",
 		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			gotChannelID, gotProperties := getXiaomiNoticeProperties(tt.text, tt.deeplink, notice)
+			gotChannelID, gotProperties := getXiaomiNoticeProperties(tt.text, tt.pushType, notice)
 			if gotChannelID != tt.wantChannelID {
 				t.Fatalf("channel ID = %q, want %q", gotChannelID, tt.wantChannelID)
 			}

pkg/umeng/xiaomi_template.go

@@ -0,0 +1,38 @@
+/*
+Copyright 2024 The west2-online Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package umeng
+
+import (
+	"github.com/west2-online/fzuhelper-server/pkg/constants"
+)
+
+// XiaomiTemplateKind 描述一种推送类型对应的小米模板 keyword 提取规则
+type XiaomiTemplateKind struct {
+	// KeywordSuffix 从 text 中提取 keywords1 时去掉的正文后缀，空串表示取完整 text
+	KeywordSuffix string
+}
+
+// xiaomiTemplateKinds 推送类型注册表，新增推送类型只需在配置中增加模板并在这里注册一项
+var xiaomiTemplateKinds = map[string]XiaomiTemplateKind{
+	constants.UmengPushTypeScore: {
+		KeywordSuffix: constants.UmengGradeNotificationBodySuffix,
+	},
+	constants.UmengPushTypeExam: {
+		KeywordSuffix: constants.UmengExamNotificationBodySuffix,
+	},
+	constants.UmengPushTypeTeaching: {},
+}