Fix mute channel when not a member and adding unit tests (#8609)

2025-02-25 18:55:24 -06:00 · 2018-04-12 10:12:59 -03:00
parent 2d0fef4d94
commit 1ebf19825b
4 changed files with 223 additions and 2 deletions
--- a/app/channel.go
+++ b/app/channel.go
@@ -1491,7 +1491,13 @@ func (a *App) GetDirectChannel(userId1, userId2 string) (*model.Channel, *model.
 }

 func (a *App) ToggleMuteChannel(channelId string, userId string) *model.ChannelMember {
-	member := (<-a.Srv.Store.Channel().GetMember(channelId, userId)).Data.(*model.ChannelMember)
+	result := <-a.Srv.Store.Channel().GetMember(channelId, userId)
+
+	if result.Err != nil {
+		return nil
+	}
+
+	member := result.Data.(*model.ChannelMember)

 	if member.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP] == model.CHANNEL_NOTIFY_MENTION {
 		member.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP] = model.CHANNEL_MARK_UNREAD_ALL
--- a/app/command_mute.go
+++ b/app/command_mute.go
@@ -40,7 +40,7 @@ func (me *MuteProvider) DoCommand(a *App, args *model.CommandArgs, message strin
 	var noChannelErr *model.AppError

 	if channel, noChannelErr = a.GetChannel(args.ChannelId); noChannelErr != nil {
-		return &model.CommandResponse{Text: args.T("api.command_mute.error", map[string]interface{}{"Channel": channel.DisplayName}), ResponseType: model.COMMAND_RESPONSE_TYPE_EPHEMERAL}
+		return &model.CommandResponse{Text: args.T("api.command_mute.no_channel.error"), ResponseType: model.COMMAND_RESPONSE_TYPE_EPHEMERAL}
 	}

 	channelName := ""
@@ -63,6 +63,9 @@ func (me *MuteProvider) DoCommand(a *App, args *model.CommandArgs, message strin
 	}

 	channelMember := a.ToggleMuteChannel(channel.Id, args.UserId)
+	if channelMember == nil {
+		return &model.CommandResponse{Text: args.T("api.command_mute.not_member.error", map[string]interface{}{"Channel": channelName}), ResponseType: model.COMMAND_RESPONSE_TYPE_EPHEMERAL}
+	}

 	// Invalidate cache to allow cache lookups while sending notifications
 	a.Srv.Store.Channel().InvalidateCacheForChannelMembersNotifyProps(channel.Id)
--- a/app/command_mute_test.go
+++ b/app/command_mute_test.go
@@ -0,0 +1,204 @@
+// Copyright (c) 2018-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package app
+
+import (
+	"github.com/mattermost/mattermost-server/model"
+	"github.com/nicksnyder/go-i18n/i18n"
+	"github.com/stretchr/testify/assert"
+	"testing"
+	"time"
+)
+
+func TestMuteCommandNoChannel(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	if testing.Short() {
+		t.SkipNow()
+	}
+
+	channel1 := th.BasicChannel
+	channel1M, channel1MError := th.App.GetChannelMember(channel1.Id, th.BasicUser.Id)
+
+	if channel1MError != nil {
+		t.Fatal("User is not a member of channel 1")
+	}
+
+	if channel1M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP] == model.CHANNEL_NOTIFY_MENTION {
+		t.Fatal("channel shouldn't be muted on initial setup")
+	}
+
+	cmd := &MuteProvider{}
+	resp := cmd.DoCommand(th.App, &model.CommandArgs{
+		T:      i18n.IdentityTfunc(),
+		UserId: th.BasicUser.Id,
+	}, "")
+	assert.Equal(t, "api.command_mute.no_channel.error", resp.Text)
+}
+
+func TestMuteCommandNoArgs(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	channel1 := th.BasicChannel
+	channel1M, _ := th.App.GetChannelMember(channel1.Id, th.BasicUser.Id)
+
+	assert.Equal(t, model.CHANNEL_NOTIFY_ALL, channel1M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+
+	cmd := &MuteProvider{}
+
+	// First mute the channel
+	resp := cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel1.Id,
+		UserId:    th.BasicUser.Id,
+	}, "")
+	assert.Equal(t, "api.command_mute.success_mute", resp.Text)
+
+	// Now unmute the channel
+	time.Sleep(time.Millisecond)
+	resp = cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel1.Id,
+		UserId:    th.BasicUser.Id,
+	}, "")
+
+	assert.Equal(t, "api.command_mute.success_unmute", resp.Text)
+}
+
+func TestMuteCommandSpecificChannel(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	if testing.Short() {
+		t.SkipNow()
+	}
+
+	channel1 := th.BasicChannel
+	channel2, _ := th.App.CreateChannel(&model.Channel{
+		DisplayName: "AA",
+		Name:        "aa" + model.NewId() + "a",
+		Type:        model.CHANNEL_OPEN,
+		TeamId:      th.BasicTeam.Id,
+		CreatorId:   th.BasicUser.Id,
+	}, true)
+
+	channel2M, _ := th.App.GetChannelMember(channel2.Id, th.BasicUser.Id)
+
+	assert.Equal(t, model.CHANNEL_NOTIFY_ALL, channel2M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+
+	cmd := &MuteProvider{}
+
+	// First mute the channel
+	resp := cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel1.Id,
+		UserId:    th.BasicUser.Id,
+	}, channel2.Name)
+	assert.Equal(t, "api.command_mute.success_mute", resp.Text)
+	time.Sleep(time.Millisecond)
+	channel2M, _ = th.App.GetChannelMember(channel2.Id, th.BasicUser.Id)
+	assert.Equal(t, model.CHANNEL_NOTIFY_MENTION, channel2M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+
+	// Now unmute the channel
+	resp = cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel1.Id,
+		UserId:    th.BasicUser.Id,
+	}, "~"+channel2.Name)
+
+	assert.Equal(t, "api.command_mute.success_unmute", resp.Text)
+	time.Sleep(time.Millisecond)
+	channel2M, _ = th.App.GetChannelMember(channel2.Id, th.BasicUser.Id)
+	assert.Equal(t, model.CHANNEL_NOTIFY_ALL, channel2M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+}
+
+func TestMuteCommandNotMember(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	if testing.Short() {
+		t.SkipNow()
+	}
+
+	channel1 := th.BasicChannel
+	channel2, _ := th.App.CreateChannel(&model.Channel{
+		DisplayName: "AA",
+		Name:        "aa" + model.NewId() + "a",
+		Type:        model.CHANNEL_OPEN,
+		TeamId:      th.BasicTeam.Id,
+		CreatorId:   th.BasicUser.Id,
+	}, false)
+
+	cmd := &MuteProvider{}
+
+	// First mute the channel
+	resp := cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel1.Id,
+		UserId:    th.BasicUser.Id,
+	}, channel2.Name)
+	assert.Equal(t, "api.command_mute.not_member.error", resp.Text)
+}
+
+func TestMuteCommandNotChannel(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	if testing.Short() {
+		t.SkipNow()
+	}
+
+	channel1 := th.BasicChannel
+
+	cmd := &MuteProvider{}
+
+	// First mute the channel
+	resp := cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel1.Id,
+		UserId:    th.BasicUser.Id,
+	}, "~noexists")
+	assert.Equal(t, "api.command_mute.error", resp.Text)
+}
+
+func TestMuteCommandDMChannel(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	if testing.Short() {
+		t.SkipNow()
+	}
+
+	channel2, _ := th.App.CreateDirectChannel(th.BasicUser.Id, th.BasicUser2.Id)
+	channel2M, _ := th.App.GetChannelMember(channel2.Id, th.BasicUser.Id)
+
+	assert.Equal(t, model.CHANNEL_NOTIFY_ALL, channel2M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+
+	cmd := &MuteProvider{}
+
+	// First mute the channel
+	resp := cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel2.Id,
+		UserId:    th.BasicUser.Id,
+	}, "")
+	assert.Equal(t, "api.command_mute.success_mute_direct_msg", resp.Text)
+	time.Sleep(time.Millisecond)
+	channel2M, _ = th.App.GetChannelMember(channel2.Id, th.BasicUser.Id)
+	assert.Equal(t, model.CHANNEL_NOTIFY_MENTION, channel2M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+
+	// Now unmute the channel
+	resp = cmd.DoCommand(th.App, &model.CommandArgs{
+		T:         i18n.IdentityTfunc(),
+		ChannelId: channel2.Id,
+		UserId:    th.BasicUser.Id,
+	}, "")
+
+	assert.Equal(t, "api.command_mute.success_unmute_direct_msg", resp.Text)
+	time.Sleep(time.Millisecond)
+	channel2M, _ = th.App.GetChannelMember(channel2.Id, th.BasicUser.Id)
+	assert.Equal(t, model.CHANNEL_NOTIFY_ALL, channel2M.NotifyProps[model.MARK_UNREAD_NOTIFY_PROP])
+}
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -906,6 +906,14 @@
    "id": "api.command_mute.error",
    "translation": "Could not find the channel {{.Channel}}. Please use the [channel handle](https://about.mattermost.com/default-channel-handle-documentation) to identify channels."
  },
+  {
+    "id": "api.command_mute.no_channel.error",
+    "translation": "Could not find the specified channel. Please use the [channel handle](https://about.mattermost.com/default-channel-handle-documentation) to identify channels."
+  },
+  {
+    "id": "api.command_mute.not_member.error",
+    "translation": "Could not mute channel {{.Channel}} as you are not a member."
+  },
  {
    "id": "api.command_mute.hint",
    "translation": "~[channel]"