feat: implement `SetGroupInfoEX` interface. (#2552)

* refactor: refactor workflows contents.

* add tool workflows.

* update field.

* fix: remove chat error.

* Fix err.

* fix error.

* remove cn comment.

* update workflows files.

* update infra config.

* move workflows.

* feat: update bot.

* fix: solve uncorrect outdated msg get.

* update get docIDs logic.

* update

* update skip logic.

* fix

* update.

* feat: implement `SetGroupInfoEX` interface.

* remove null interface.

* update router.

config/webhooks.yml

@@ -130,6 +130,13 @@ beforeSetGroupInfo:
   enable: false
   timeout: 5
   failedContinue: true
+afterSetGroupInfoEX:
+  enable: false
+  timeout: 5
+beforeSetGroupInfoEX:
+  enable: false
+  timeout: 5
+  failedContinue: true
 afterRevokeMsg:
   enable: false
   timeout: 5

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/gorilla/websocket v1.5.1
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0
 	github.com/mitchellh/mapstructure v1.5.0
-	github.com/openimsdk/protocol v0.0.72-alpha.2
+	github.com/openimsdk/protocol v0.0.72-alpha.5
 	github.com/openimsdk/tools v0.0.49-alpha.55
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_golang v1.18.0

go.sum

@@ -319,8 +319,8 @@ github.com/onsi/gomega v1.25.0 h1:Vw7br2PCDYijJHSfBOWhov+8cAnUf8MfMaIOV323l6Y=
 github.com/onsi/gomega v1.25.0/go.mod h1:r+zV744Re+DiYCIPRlYOTxn0YkOLcAnW8k1xXdMPGhM=
 github.com/openimsdk/gomake v0.0.14-alpha.5 h1:VY9c5x515lTfmdhhPjMvR3BBRrRquAUCFsz7t7vbv7Y=
 github.com/openimsdk/gomake v0.0.14-alpha.5/go.mod h1:PndCozNc2IsQIciyn9mvEblYWZwJmAI+06z94EY+csI=
-github.com/openimsdk/protocol v0.0.72-alpha.2 h1:H5IcoAR4jTzJ7uvmFmc6/6rPOKEGRLWnu+qre8B5hk0=
+github.com/openimsdk/protocol v0.0.72-alpha.5 h1:1Xjyx6ivTb782Sm7wMJXCLZP80iXADVo1CySis1rOG0=
-github.com/openimsdk/protocol v0.0.72-alpha.2/go.mod h1:OZQA9FR55lseYoN2Ql1XAHYKHJGu7OMNkUbuekrKCM8=
+github.com/openimsdk/protocol v0.0.72-alpha.5/go.mod h1:OZQA9FR55lseYoN2Ql1XAHYKHJGu7OMNkUbuekrKCM8=
 github.com/openimsdk/tools v0.0.49-alpha.55 h1:KPgC53oqiwZYssLKljhtXbWXifMlTj2SSQEusj4Uf4k=
 github.com/openimsdk/tools v0.0.49-alpha.55/go.mod h1:h1cYmfyaVtgFbKmb1Cfsl8XwUOMTt8ubVUQrdGtsUh4=
 github.com/pelletier/go-toml/v2 v2.1.0 h1:FnwAJ4oYMvbT/34k9zzHuZNrhlz48GB3/s6at6/MHO4=

internal/api/group.go

@@ -35,6 +35,10 @@ func (o *GroupApi) SetGroupInfo(c *gin.Context) {
 	a2r.Call(group.GroupClient.SetGroupInfo, o.Client, c)
 }
 
+func (o *GroupApi) SetGroupInfoEX(c *gin.Context) {
+	a2r.Call(group.GroupClient.SetGroupInfoEX, o.Client, c)
+}
+
 func (o *GroupApi) JoinGroup(c *gin.Context) {
 	a2r.Call(group.GroupClient.JoinGroup, o.Client, c)
 }

internal/api/router.go

@@ -2,12 +2,16 @@ package api
 
 import (
 	"fmt"
+
 	"github.com/gin-gonic/gin"
 	"github.com/gin-gonic/gin/binding"
 	"github.com/go-playground/validator/v10"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 
+	"net/http"
+	"strings"
+
 	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/servererrs"
 	"github.com/openimsdk/open-im-server/v3/pkg/rpcclient"
@@ -16,8 +20,6 @@ import (
 	"github.com/openimsdk/tools/discovery"
 	"github.com/openimsdk/tools/log"
 	"github.com/openimsdk/tools/mw"
-	"net/http"
-	"strings"
 )
 
 func prommetricsGin() gin.HandlerFunc {
@@ -112,6 +114,7 @@ func newGinRouter(disCov discovery.SvcDiscoveryRegistry, config *Config) *gin.En
 	{
 		groupRouterGroup.POST("/create_group", g.CreateGroup)
 		groupRouterGroup.POST("/set_group_info", g.SetGroupInfo)
+		groupRouterGroup.POST("/set_group_info_ex", g.SetGroupInfoEX)
 		groupRouterGroup.POST("/join_group", g.JoinGroup)
 		groupRouterGroup.POST("/quit_group", g.QuitGroup)
 		groupRouterGroup.POST("/group_application_response", g.ApplicationGroupResponse)

internal/api/user.go

@@ -36,9 +36,11 @@ func (u *UserApi) UserRegister(c *gin.Context) {
 	a2r.Call(user.UserClient.UserRegister, u.Client, c)
 }
 
+// UpdateUserInfo is deprecated. Use UpdateUserInfoEx
 func (u *UserApi) UpdateUserInfo(c *gin.Context) {
 	a2r.Call(user.UserClient.UpdateUserInfo, u.Client, c)
 }
+
 func (u *UserApi) UpdateUserInfoEx(c *gin.Context) {
 	a2r.Call(user.UserClient.UpdateUserInfoEx, u.Client, c)
 }

internal/rpc/group/callback.go

@@ -358,3 +358,74 @@ func (s *groupServer) webhookAfterSetGroupInfo(ctx context.Context, after *confi
 	}
 	s.webhookClient.AsyncPost(ctx, cbReq.GetCallbackCommand(), cbReq, &callbackstruct.CallbackAfterSetGroupInfoResp{}, after)
 }
+
+func (s *groupServer) webhookBeforeSetGroupInfoEX(ctx context.Context, before *config.BeforeConfig, req *group.SetGroupInfoEXReq) error {
+	return webhook.WithCondition(ctx, before, func(ctx context.Context) error {
+		cbReq := &callbackstruct.CallbackBeforeSetGroupInfoEXReq{
+			CallbackCommand: callbackstruct.CallbackBeforeSetGroupInfoCommand,
+			GroupID:         req.GroupInfoForSetEX.GroupID,
+			GroupName:       req.GroupInfoForSetEX.GroupName,
+			Notification:    req.GroupInfoForSetEX.Notification,
+			Introduction:    req.GroupInfoForSetEX.Introduction,
+			FaceURL:         req.GroupInfoForSetEX.FaceURL,
+		}
+
+		if req.GroupInfoForSetEX.Ex != nil {
+			cbReq.Ex = req.GroupInfoForSetEX.Ex
+		}
+		log.ZDebug(ctx, "debug CallbackBeforeSetGroupInfoEX", "ex", cbReq.Ex)
+
+		if req.GroupInfoForSetEX.NeedVerification != nil {
+			cbReq.NeedVerification = req.GroupInfoForSetEX.NeedVerification
+		}
+		if req.GroupInfoForSetEX.LookMemberInfo != nil {
+			cbReq.LookMemberInfo = req.GroupInfoForSetEX.LookMemberInfo
+		}
+		if req.GroupInfoForSetEX.ApplyMemberFriend != nil {
+			cbReq.ApplyMemberFriend = req.GroupInfoForSetEX.ApplyMemberFriend
+		}
+
+		resp := &callbackstruct.CallbackBeforeSetGroupInfoEXResp{}
+
+		if err := s.webhookClient.SyncPost(ctx, cbReq.GetCallbackCommand(), cbReq, resp, before); err != nil {
+			return err
+		}
+
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.GroupID, &resp.GroupID)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.GroupName, &resp.GroupName)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.FaceURL, &resp.FaceURL)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.Introduction, &resp.Introduction)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.Ex, &resp.Ex)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.NeedVerification, &resp.NeedVerification)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.LookMemberInfo, &resp.LookMemberInfo)
+		datautil.NotNilReplace(&req.GroupInfoForSetEX.ApplyMemberFriend, &resp.ApplyMemberFriend)
+
+		return nil
+	})
+}
+
+func (s *groupServer) webhookAfterSetGroupInfoEX(ctx context.Context, after *config.AfterConfig, req *group.SetGroupInfoEXReq) {
+	cbReq := &callbackstruct.CallbackAfterSetGroupInfoEXReq{
+		CallbackCommand: callbackstruct.CallbackAfterSetGroupInfoCommand,
+		GroupID:         req.GroupInfoForSetEX.GroupID,
+		GroupName:       req.GroupInfoForSetEX.GroupName,
+		Notification:    req.GroupInfoForSetEX.Notification,
+		Introduction:    req.GroupInfoForSetEX.Introduction,
+		FaceURL:         req.GroupInfoForSetEX.FaceURL,
+	}
+
+	if req.GroupInfoForSetEX.Ex != nil {
+		cbReq.Ex = req.GroupInfoForSetEX.Ex
+	}
+	if req.GroupInfoForSetEX.NeedVerification != nil {
+		cbReq.NeedVerification = req.GroupInfoForSetEX.NeedVerification
+	}
+	if req.GroupInfoForSetEX.LookMemberInfo != nil {
+		cbReq.LookMemberInfo = req.GroupInfoForSetEX.LookMemberInfo
+	}
+	if req.GroupInfoForSetEX.ApplyMemberFriend != nil {
+		cbReq.ApplyMemberFriend = req.GroupInfoForSetEX.ApplyMemberFriend
+	}
+
+	s.webhookClient.AsyncPost(ctx, cbReq.GetCallbackCommand(), cbReq, &callbackstruct.CallbackAfterSetGroupInfoEXResp{}, after)
+}

internal/rpc/group/db_map.go

@@ -54,6 +54,39 @@ func UpdateGroupInfoMap(ctx context.Context, group *sdkws.GroupInfoForSet) map[s
 	return m
 }
 
+func UpdateGroupInfoEXMap(ctx context.Context, group *sdkws.GroupInfoForSetEX) map[string]any {
+	m := make(map[string]any)
+
+	if group.GroupName != "" {
+		m["group_name"] = group.GroupName
+	}
+	if group.Notification != nil {
+		m["notification"] = group.Notification.Value
+		m["notification_update_time"] = time.Now()
+		m["notification_user_id"] = mcontext.GetOpUserID(ctx)
+	}
+	if group.Introduction != nil {
+		m["introduction"] = group.Introduction.Value
+	}
+	if group.FaceURL != nil {
+		m["face_url"] = group.FaceURL.Value
+	}
+	if group.NeedVerification != nil {
+		m["need_verification"] = group.NeedVerification.Value
+	}
+	if group.LookMemberInfo != nil {
+		m["look_member_info"] = group.LookMemberInfo.Value
+	}
+	if group.ApplyMemberFriend != nil {
+		m["apply_member_friend"] = group.ApplyMemberFriend.Value
+	}
+	if group.Ex != nil {
+		m["ex"] = group.Ex.Value
+	}
+
+	return m
+}
+
 func UpdateGroupStatusMap(status int) map[string]any {
 	return map[string]any{
 		"status": status,

internal/rpc/user/user.go

@@ -17,6 +17,11 @@ package user
 import (
 	"context"
 	"errors"
+	"math/rand"
+	"strings"
+	"sync"
+	"time"
+
 	"github.com/openimsdk/open-im-server/v3/internal/rpc/relation"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
@@ -29,10 +34,6 @@ import (
 	"github.com/openimsdk/protocol/group"
 	friendpb "github.com/openimsdk/protocol/relation"
 	"github.com/openimsdk/tools/db/redisutil"
-	"math/rand"
-	"strings"
-	"sync"
-	"time"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/convert"
@@ -147,41 +148,35 @@ func (s *userServer) UpdateUserInfo(ctx context.Context, req *pbuser.UpdateUserI
 		return nil, err
 	}
 	s.friendNotificationSender.UserInfoUpdatedNotification(ctx, req.UserInfo.UserID)
-	//friends, err := s.friendRpcClient.GetFriendIDs(ctx, req.UserInfo.UserID)
+
-	//if err != nil {
-	//	return nil, err
-	//}
-	//if req.UserInfo.Nickname != "" || req.UserInfo.FaceURL != "" {
-	//	if err = s.NotificationUserInfoUpdate(ctx, req.UserInfo.UserID,oldUser); err != nil {
-	//		return nil, err
-	//	}
-	//}
-	//for _, friendID := range friends {
-	//	s.friendNotificationSender.FriendInfoUpdatedNotification(ctx, req.UserInfo.UserID, friendID)
-	//}
 	s.webhookAfterUpdateUserInfo(ctx, &s.config.WebhooksConfig.AfterUpdateUserInfo, req)
 	if err = s.NotificationUserInfoUpdate(ctx, req.UserInfo.UserID, oldUser); err != nil {
 		return nil, err
 	}
 	return resp, nil
 }
+
 func (s *userServer) UpdateUserInfoEx(ctx context.Context, req *pbuser.UpdateUserInfoExReq) (resp *pbuser.UpdateUserInfoExResp, err error) {
 	resp = &pbuser.UpdateUserInfoExResp{}
 	err = authverify.CheckAccessV3(ctx, req.UserInfo.UserID, s.config.Share.IMAdminUserID)
 	if err != nil {
 		return nil, err
 	}
+
 	if err = s.webhookBeforeUpdateUserInfoEx(ctx, &s.config.WebhooksConfig.BeforeUpdateUserInfoEx, req); err != nil {
 		return nil, err
 	}
+
 	oldUser, err := s.db.GetUserByID(ctx, req.UserInfo.UserID)
 	if err != nil {
 		return nil, err
 	}
+
 	data := convert.UserPb2DBMapEx(req.UserInfo)
 	if err = s.db.UpdateByMap(ctx, req.UserInfo.UserID, data); err != nil {
 		return nil, err
 	}
+
 	s.friendNotificationSender.UserInfoUpdatedNotification(ctx, req.UserInfo.UserID)
 	//friends, err := s.friendRpcClient.GetFriendIDs(ctx, req.UserInfo.UserID)
 	//if err != nil {
@@ -199,6 +194,7 @@ func (s *userServer) UpdateUserInfoEx(ctx context.Context, req *pbuser.UpdateUse
 	if err := s.NotificationUserInfoUpdate(ctx, req.UserInfo.UserID, oldUser); err != nil {
 		return nil, err
 	}
+
 	return resp, nil
 }
 func (s *userServer) SetGlobalRecvMessageOpt(ctx context.Context, req *pbuser.SetGlobalRecvMessageOptReq) (resp *pbuser.SetGlobalRecvMessageOptResp, err error) {

pkg/callbackstruct/constant.go

@@ -18,7 +18,9 @@ const (
 	CallbackBeforeInviteJoinGroupCommand    = "callbackBeforeInviteJoinGroupCommand"
 	CallbackAfterJoinGroupCommand           = "callbackAfterJoinGroupCommand"
 	CallbackAfterSetGroupInfoCommand        = "callbackAfterSetGroupInfoCommand"
+	CallbackAfterSetGroupInfoEXCommand      = "callbackAfterSetGroupInfoCommandEX"
 	CallbackBeforeSetGroupInfoCommand       = "callbackBeforeSetGroupInfoCommand"
+	CallbackBeforeSetGroupInfoEXCommand     = "callbackBeforeSetGroupInfoEXCommand"
 	CallbackAfterRevokeMsgCommand           = "callbackBeforeAfterMsgCommand"
 	CallbackBeforeAddBlackCommand           = "callbackBeforeAddBlackCommand"
 	CallbackAfterAddFriendCommand           = "callbackAfterAddFriendCommand"

pkg/callbackstruct/group.go

@@ -17,6 +17,7 @@ package callbackstruct
 import (
 	"github.com/openimsdk/open-im-server/v3/pkg/apistruct"
 	common "github.com/openimsdk/protocol/sdkws"
+	"github.com/openimsdk/protocol/wrapperspb"
 )
 
 type CallbackCommand string
@@ -242,3 +243,48 @@ type CallbackAfterSetGroupInfoReq struct {
 type CallbackAfterSetGroupInfoResp struct {
 	CommonCallbackResp
 }
+
+type CallbackBeforeSetGroupInfoEXReq struct {
+	CallbackCommand   `json:"callbackCommand"`
+	OperationID       string                  `json:"operationID"`
+	GroupID           string                  `json:"groupID"`
+	GroupName         string                  `json:"groupName"`
+	Notification      *wrapperspb.StringValue `json:"notification"`
+	Introduction      *wrapperspb.StringValue `json:"introduction"`
+	FaceURL           *wrapperspb.StringValue `json:"faceURL"`
+	Ex                *wrapperspb.StringValue `json:"ex"`
+	NeedVerification  *wrapperspb.Int32Value  `json:"needVerification"`
+	LookMemberInfo    *wrapperspb.Int32Value  `json:"lookMemberInfo"`
+	ApplyMemberFriend *wrapperspb.Int32Value  `json:"applyMemberFriend"`
+}
+
+type CallbackBeforeSetGroupInfoEXResp struct {
+	CommonCallbackResp
+	GroupID           string                  `json:"groupID"`
+	GroupName         string                  `json:"groupName"`
+	Notification      *wrapperspb.StringValue `json:"notification"`
+	Introduction      *wrapperspb.StringValue `json:"introduction"`
+	FaceURL           *wrapperspb.StringValue `json:"faceURL"`
+	Ex                *wrapperspb.StringValue `json:"ex"`
+	NeedVerification  *wrapperspb.Int32Value  `json:"needVerification"`
+	LookMemberInfo    *wrapperspb.Int32Value  `json:"lookMemberInfo"`
+	ApplyMemberFriend *wrapperspb.Int32Value  `json:"applyMemberFriend"`
+}
+
+type CallbackAfterSetGroupInfoEXReq struct {
+	CallbackCommand   `json:"callbackCommand"`
+	OperationID       string                  `json:"operationID"`
+	GroupID           string                  `json:"groupID"`
+	GroupName         string                  `json:"groupName"`
+	Notification      *wrapperspb.StringValue `json:"notification"`
+	Introduction      *wrapperspb.StringValue `json:"introduction"`
+	FaceURL           *wrapperspb.StringValue `json:"faceURL"`
+	Ex                *wrapperspb.StringValue `json:"ex"`
+	NeedVerification  *wrapperspb.Int32Value  `json:"needVerification"`
+	LookMemberInfo    *wrapperspb.Int32Value  `json:"lookMemberInfo"`
+	ApplyMemberFriend *wrapperspb.Int32Value  `json:"applyMemberFriend"`
+}
+
+type CallbackAfterSetGroupInfoEXResp struct {
+	CommonCallbackResp
+}

pkg/common/config/config.go

@@ -422,6 +422,8 @@ type Webhooks struct {
 	BeforeInviteUserToGroup  BeforeConfig `mapstructure:"beforeInviteUserToGroup"`
 	AfterSetGroupInfo        AfterConfig  `mapstructure:"afterSetGroupInfo"`
 	BeforeSetGroupInfo       BeforeConfig `mapstructure:"beforeSetGroupInfo"`
+	AfterSetGroupInfoEX      AfterConfig  `mapstructure:"afterSetGroupInfoEX"`
+	BeforeSetGroupInfoEX     BeforeConfig `mapstructure:"beforeSetGroupInfoEX"`
 	AfterRevokeMsg           AfterConfig  `mapstructure:"afterRevokeMsg"`
 	BeforeAddBlack           BeforeConfig `mapstructure:"beforeAddBlack"`
 	AfterAddFriend           AfterConfig  `mapstructure:"afterAddFriend"`