MM-61033: [Shared Channels] Removing a shared channel on one end should make the other remove the shared channel too (#30738)

Этот коммит содержится в:
catalintomai
2025-06-16 16:25:00 +02:00
коммит произвёл GitHub
родитель 7fad136933
Коммит ed3a6d6b91
6 изменённых файлов: 571 добавлений и 12 удалений

Просмотреть файл

@@ -42,6 +42,7 @@ type SelfReferentialSyncHandler struct {
service *sharedchannel.Service
selfCluster *model.RemoteCluster
syncMessageCount *int32
SimulateUnshared bool // When true, always return ErrChannelIsNotShared for sync messages
// Callbacks for capturing sync data
OnIndividualSync func(userId string, messageNumber int32)
@@ -78,6 +79,14 @@ func (h *SelfReferentialSyncHandler) HandleRequest(w http.ResponseWriter, r *htt
err := json.Unmarshal(body, &frame)
if err == nil {
// Simulate the remote having unshared if configured to do so
if h.SimulateUnshared && frame.Msg.Topic == "sharedchannel_sync" {
// Return HTTP error instead of JSON error response
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte("channel is no longer shared"))
return
}
// Process the message to update cursor
response := &remotecluster.Response{}
processErr := h.service.OnReceiveSyncMessageForTesting(frame.Msg, h.selfCluster, response)

Просмотреть файл

@@ -4,12 +4,17 @@
package app
import (
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/v8/platform/services/remotecluster"
"github.com/mattermost/mattermost/server/v8/platform/services/sharedchannel"
)
func setupSharedChannels(tb testing.TB) *TestHelper {
@@ -96,3 +101,458 @@ func TestApp_CheckCanInviteToSharedChannel(t *testing.T) {
assert.Error(t, err, "invalid channel should not allow invites")
})
}
// TestApp_RemoteUnsharing tests the functionality where a shared channel is unshared on one side and triggers an unshare on the remote cluster.
// This test uses a self-referential approach where a server syncs with itself through real HTTP communication.
func TestApp_RemoteUnsharing(t *testing.T) {
th := setupSharedChannels(t).InitBasic()
defer th.TearDown()
ss := th.App.Srv().Store()
// Get the shared channel service and cast to concrete type
scsInterface := th.App.Srv().GetSharedChannelSyncService()
service, ok := scsInterface.(*sharedchannel.Service)
require.True(t, ok, "Expected sharedchannel.Service concrete type")
// Ensure services are active
err := service.Start()
require.NoError(t, err)
rcService := th.App.Srv().GetRemoteClusterService()
if rcService != nil {
_ = rcService.Start()
}
t.Run("remote-initiated unshare with single remote", func(t *testing.T) {
EnsureCleanState(t, th, ss)
var syncHandler *SelfReferentialSyncHandler
// Create a test HTTP server that acts as the "remote" cluster
testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if syncHandler != nil {
syncHandler.HandleRequest(w, r)
} else {
writeOKResponse(w)
}
}))
defer testServer.Close()
// Create a self-referential remote cluster
selfCluster := &model.RemoteCluster{
RemoteId: model.NewId(),
Name: "test-remote",
DisplayName: "Test Remote",
SiteURL: testServer.URL,
Token: model.NewId(),
CreateAt: model.GetMillis(),
LastPingAt: model.GetMillis(),
CreatorId: th.BasicUser.Id,
RemoteTeamId: model.NewId(),
}
selfCluster, err = ss.RemoteCluster().Save(selfCluster)
require.NoError(t, err)
// Initialize sync handler
syncHandler = NewSelfReferentialSyncHandler(t, service, selfCluster)
// Create a shared channel
channel := th.CreateChannel(th.Context, th.BasicTeam)
sc := &model.SharedChannel{
ChannelId: channel.Id,
TeamId: channel.TeamId,
Home: true,
ReadOnly: false,
ShareName: channel.Name,
ShareDisplayName: channel.DisplayName,
SharePurpose: channel.Purpose,
ShareHeader: channel.Header,
CreatorId: th.BasicUser.Id,
RemoteId: "",
}
_, err = th.App.ShareChannel(th.Context, sc)
require.NoError(t, err)
// Share the channel with the remote
scr := &model.SharedChannelRemote{
Id: model.NewId(),
ChannelId: channel.Id,
CreatorId: th.BasicUser.Id,
IsInviteAccepted: true,
IsInviteConfirmed: true,
RemoteId: selfCluster.RemoteId,
LastPostUpdateAt: model.GetMillis(),
}
_, err = ss.SharedChannel().SaveRemote(scr)
require.NoError(t, err)
// Get post count before "remote-initiated unshare"
postsBeforeRemove, appErr := th.App.GetPostsPage(model.GetPostsOptions{
ChannelId: channel.Id,
Page: 0,
PerPage: 10,
})
require.Nil(t, appErr)
postCountBefore := len(postsBeforeRemove.Posts)
// Verify the channel is initially shared
err = th.App.checkChannelIsShared(channel.Id)
require.NoError(t, err, "Channel should be shared initially")
// Step 1: Verify the channel is initially shared
err = th.App.checkChannelIsShared(channel.Id)
require.NoError(t, err, "Channel should be shared initially")
// Step 2: Create a sync message that would be sent to the remote
syncMsg := model.NewSyncMsg(channel.Id)
syncMsg.Posts = []*model.Post{{
Id: model.NewId(),
ChannelId: channel.Id,
UserId: th.BasicUser.Id,
Message: "Test message after remote unshare",
CreateAt: model.GetMillis(),
}}
// Step 3: Simulate receiving ErrChannelIsNotShared from the remote
// This directly tests the error handling logic without async complexity
service.HandleChannelNotSharedErrorForTesting(syncMsg, selfCluster)
// Step 4: Verify the channel is no longer shared locally
err = th.App.checkChannelIsShared(channel.Id)
assert.Error(t, err, "Channel should no longer be shared after error handling")
// Verify a system message was posted to inform users the channel is no longer shared
postsAfterRemove, appErr := th.App.GetPostsPage(model.GetPostsOptions{
ChannelId: channel.Id,
Page: 0,
PerPage: 10,
})
require.Nil(t, appErr)
// Expected: only one notification post when a remote is removed
assert.Equal(t, postCountBefore+1, len(postsAfterRemove.Posts), "There should be one new post")
// Find and verify the system message content
var systemPost *model.Post
for _, p := range postsAfterRemove.Posts {
if p.Type == model.PostTypeSystemGeneric {
systemPost = p
break
}
}
require.NotNil(t, systemPost, "A system post should be created")
assert.Equal(t, "This channel is no longer shared.", systemPost.Message, "Message should match unshare message")
})
t.Run("remote-initiated unshare with multiple remotes", func(t *testing.T) {
EnsureCleanState(t, th, ss)
var syncHandler1, syncHandler2 *SelfReferentialSyncHandler
// Create test HTTP servers for both remotes
testServer1 := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if syncHandler1 != nil {
syncHandler1.HandleRequest(w, r)
} else {
writeOKResponse(w)
}
}))
defer testServer1.Close()
testServer2 := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if syncHandler2 != nil {
syncHandler2.HandleRequest(w, r)
} else {
writeOKResponse(w)
}
}))
defer testServer2.Close()
// Create two self-referential remote clusters
selfCluster1 := &model.RemoteCluster{
RemoteId: model.NewId(),
Name: "test-remote-1",
DisplayName: "Test Remote 1",
SiteURL: testServer1.URL,
Token: model.NewId(),
CreateAt: model.GetMillis(),
LastPingAt: model.GetMillis(),
CreatorId: th.BasicUser.Id,
RemoteTeamId: model.NewId(),
}
selfCluster1, err = ss.RemoteCluster().Save(selfCluster1)
require.NoError(t, err)
selfCluster2 := &model.RemoteCluster{
RemoteId: model.NewId(),
Name: "test-remote-2",
DisplayName: "Test Remote 2",
SiteURL: testServer2.URL,
Token: model.NewId(),
CreateAt: model.GetMillis(),
LastPingAt: model.GetMillis(),
CreatorId: th.BasicUser.Id,
RemoteTeamId: model.NewId(),
}
selfCluster2, err = ss.RemoteCluster().Save(selfCluster2)
require.NoError(t, err)
// Initialize sync handlers
syncHandler1 = NewSelfReferentialSyncHandler(t, service, selfCluster1)
syncHandler2 = NewSelfReferentialSyncHandler(t, service, selfCluster2)
// Create a shared channel
channel := th.CreateChannel(th.Context, th.BasicTeam)
sc := &model.SharedChannel{
ChannelId: channel.Id,
TeamId: channel.TeamId,
Home: true,
ReadOnly: false,
ShareName: channel.Name,
ShareDisplayName: channel.DisplayName,
SharePurpose: channel.Purpose,
ShareHeader: channel.Header,
CreatorId: th.BasicUser.Id,
RemoteId: "",
}
_, err = th.App.ShareChannel(th.Context, sc)
require.NoError(t, err)
// Share the channel with both remotes
scr1 := &model.SharedChannelRemote{
Id: model.NewId(),
ChannelId: channel.Id,
CreatorId: th.BasicUser.Id,
IsInviteAccepted: true,
IsInviteConfirmed: true,
RemoteId: selfCluster1.RemoteId,
LastPostUpdateAt: model.GetMillis(),
}
_, err = ss.SharedChannel().SaveRemote(scr1)
require.NoError(t, err)
scr2 := &model.SharedChannelRemote{
Id: model.NewId(),
ChannelId: channel.Id,
CreatorId: th.BasicUser.Id,
IsInviteAccepted: true,
IsInviteConfirmed: true,
RemoteId: selfCluster2.RemoteId,
LastPostUpdateAt: model.GetMillis(),
}
_, err = ss.SharedChannel().SaveRemote(scr2)
require.NoError(t, err)
// Verify the channel is shared with both remotes
hasRemote1, err := ss.SharedChannel().HasRemote(channel.Id, selfCluster1.RemoteId)
require.NoError(t, err)
require.True(t, hasRemote1, "Channel should be shared with remote 1")
hasRemote2, err := ss.SharedChannel().HasRemote(channel.Id, selfCluster2.RemoteId)
require.NoError(t, err)
require.True(t, hasRemote2, "Channel should be shared with remote 2")
// Step 1: Verify the channel is initially shared with both remotes
err = th.App.checkChannelIsShared(channel.Id)
require.NoError(t, err, "Channel should be shared initially")
// Step 2: Create a post in the channel to trigger sync activity
post := &model.Post{
ChannelId: channel.Id,
UserId: th.BasicUser.Id,
Message: "Test message after remote 1 unshare",
}
_, appErr := th.App.CreatePost(th.Context, post, channel, model.CreatePostFlags{})
require.Nil(t, appErr)
// Get post count after creating the test post but before "remote-initiated unshare"
postsBeforeRemove, appErr := th.App.GetPostsPage(model.GetPostsOptions{
ChannelId: channel.Id,
Page: 0,
PerPage: 10,
})
require.Nil(t, appErr)
postCountBefore := len(postsBeforeRemove.Posts)
// Step 3: Create a sync message for remote 1
syncMsg := model.NewSyncMsg(channel.Id)
syncMsg.Posts = []*model.Post{{
Id: model.NewId(),
ChannelId: channel.Id,
UserId: th.BasicUser.Id,
Message: "Test message after remote 1 unshare",
CreateAt: model.GetMillis(),
}}
// Step 4: Simulate remote 1 returning ErrChannelIsNotShared
service.HandleChannelNotSharedErrorForTesting(syncMsg, selfCluster1)
// Verify we now have only 1 remote (remote 2)
remotes, err := ss.SharedChannel().GetRemotes(0, 10, model.SharedChannelRemoteFilterOpts{
ChannelId: channel.Id,
})
require.NoError(t, err)
require.Len(t, remotes, 1, "Expected 1 remote after removing remote 1")
t.Logf("Number of remotes after unshare: %d", len(remotes))
// The expected behavior is that only the specific remote should be removed,
// with the channel remaining shared with other remotes.
err = th.App.checkChannelIsShared(channel.Id)
// The channel should still be shared with remote2, so this should pass
assert.NoError(t, err, "Channel should still be shared with other remotes")
// Verify remote 1 is no longer in shared channel
hasRemote1After, err := ss.SharedChannel().HasRemote(channel.Id, selfCluster1.RemoteId)
require.NoError(t, err)
require.False(t, hasRemote1After, "Channel should no longer be shared with remote 1")
// Check if remote 2 is still associated with the channel
// Expected behavior: remote 2 should still be associated
hasRemote2After, err := ss.SharedChannel().HasRemote(channel.Id, selfCluster2.RemoteId)
require.NoError(t, err)
assert.True(t, hasRemote2After, "Channel should still be shared with remote 2")
// Verify a system message was posted about remote 1 unsharing
postsAfterRemove, appErr := th.App.GetPostsPage(model.GetPostsOptions{
ChannelId: channel.Id,
Page: 0,
PerPage: 10,
})
require.Nil(t, appErr)
// Expected: only one notification post when a remote is removed
assert.Equal(t, postCountBefore+1, len(postsAfterRemove.Posts), "There should be one new post")
// Find and verify the system message content
var systemPost *model.Post
for _, p := range postsAfterRemove.Posts {
if p.Type == model.PostTypeSystemGeneric {
systemPost = p
break
}
}
require.NotNil(t, systemPost, "A system post should be created")
assert.Equal(t, "This channel is no longer shared.", systemPost.Message, "Message should match unshare message")
})
}
func TestSyncMessageErrChannelNotSharedResponse(t *testing.T) {
th := setupSharedChannels(t).InitBasic()
defer th.TearDown()
// Setup: Create a shared channel and remote cluster
ss := th.App.Srv().Store()
// Get the shared channel service and cast to concrete type
scsInterface := th.App.Srv().GetSharedChannelSyncService()
service, ok := scsInterface.(*sharedchannel.Service)
require.True(t, ok, "Expected sharedchannel.Service concrete type")
channel := th.CreateChannel(th.Context, th.BasicTeam)
sc := &model.SharedChannel{
ChannelId: channel.Id,
TeamId: th.BasicTeam.Id,
Home: true,
ShareName: channel.Name,
ShareDisplayName: channel.DisplayName,
CreatorId: th.BasicUser.Id,
RemoteId: "",
}
_, err := ss.SharedChannel().Save(sc)
require.NoError(t, err)
// Create a self-referential remote cluster
selfCluster := &model.RemoteCluster{
RemoteId: model.NewId(),
Name: "test-remote",
DisplayName: "Test Remote",
SiteURL: "https://test.example.com",
Token: model.NewId(),
CreateAt: model.GetMillis(),
LastPingAt: model.GetMillis(),
CreatorId: th.BasicUser.Id,
RemoteTeamId: model.NewId(),
}
selfCluster, err = ss.RemoteCluster().Save(selfCluster)
require.NoError(t, err)
// Create shared channel remote
scr := &model.SharedChannelRemote{
Id: model.NewId(),
ChannelId: channel.Id,
CreatorId: th.BasicUser.Id,
IsInviteAccepted: true,
IsInviteConfirmed: true,
RemoteId: selfCluster.RemoteId,
LastPostCreateAt: model.GetMillis(),
LastPostUpdateAt: model.GetMillis(),
}
_, err = ss.SharedChannel().SaveRemote(scr)
require.NoError(t, err)
// Verify channel is initially shared
hasRemote, err := ss.SharedChannel().HasRemote(channel.Id, selfCluster.RemoteId)
require.NoError(t, err)
require.True(t, hasRemote, "Channel should be shared with remote initially")
// Test: Simulate sync message callback receiving ErrChannelNotShared response
syncMsg := model.NewSyncMsg(channel.Id)
syncMsg.Posts = []*model.Post{{
Id: model.NewId(),
ChannelId: channel.Id,
UserId: th.BasicUser.Id,
Message: "Test sync message",
CreateAt: model.GetMillis(),
}}
// Create a response that simulates the remote returning ErrChannelNotShared
response := &remotecluster.Response{
Status: "fail",
Err: "cannot process sync message; channel is no longer shared: " + channel.Id,
}
// Test the complete flow by simulating what happens in sendSyncMsgToRemote callback
// This tests the fixed error detection logic that checks rcResp.Err
var callbackTriggered bool
mockCallback := func(rcMsg model.RemoteClusterMsg, rc *model.RemoteCluster, rcResp *remotecluster.Response, errResp error) {
callbackTriggered = true
// This simulates the fixed logic in sync_send_remote.go
if rcResp != nil && !rcResp.IsSuccess() && strings.Contains(rcResp.Err, "channel is no longer shared") {
service.HandleChannelNotSharedErrorForTesting(syncMsg, rc)
}
}
// Trigger the callback with our mock response
mockCallback(model.RemoteClusterMsg{}, selfCluster, response, nil)
// Verify the callback was triggered
require.True(t, callbackTriggered, "Callback should have been triggered")
// Verify the channel is no longer shared with the remote
hasRemoteAfter, err := ss.SharedChannel().HasRemote(channel.Id, selfCluster.RemoteId)
require.NoError(t, err)
require.False(t, hasRemoteAfter, "Channel should no longer be shared with remote after error")
// Verify a system message was posted
posts, appErr := th.App.GetPostsPage(model.GetPostsOptions{
ChannelId: channel.Id,
Page: 0,
PerPage: 10,
})
require.Nil(t, appErr)
// Find the system message
var systemPost *model.Post
for _, p := range posts.Posts {
if p.Type == model.PostTypeSystemGeneric && p.Message == "This channel is no longer shared." {
systemPost = p
break
}
}
require.NotNil(t, systemPost, "System message should be posted when channel becomes unshared")
}