TestSceneChannelManager.cs

// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

#nullable disable

using System.Collections.Generic;
using System.Linq;
using NUnit.Framework;
using osu.Framework.Allocation;
using osu.Framework.Graphics.Containers;
using osu.Framework.Testing;
using osu.Game.Online.API;
using osu.Game.Online.API.Requests;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Online.Chat;
using osu.Game.Tests.Visual;

namespace osu.Game.Tests.Chat
{
    [HeadlessTest]
    public partial class TestSceneChannelManager : OsuTestScene
    {
        private ChannelManager channelManager;
        private int currentMessageId;
        private List<Message> sentMessages;
        private List<int> silencedUserIds;

        [SetUp]
        public void Setup() => Schedule(() =>
        {
            var container = new ChannelManagerContainer(API);
            Child = container;
            channelManager = container.ChannelManager;
        });

        [SetUpSteps]
        public void SetUpSteps()
        {
            AddStep("register request handling", () =>
            {
                currentMessageId = 0;
                sentMessages = new List<Message>();
                silencedUserIds = new List<int>();

                ((DummyAPIAccess)API).LocalUserState.Blocks.Clear();
                ((DummyAPIAccess)API).HandleRequest = req =>
                {
                    switch (req)
                    {
                        case JoinChannelRequest joinChannel:
                            joinChannel.TriggerSuccess();
                            return true;

                        case PostMessageRequest postMessage:
                            handlePostMessageRequest(postMessage);
                            return true;

                        case MarkChannelAsReadRequest markRead:
                            handleMarkChannelAsReadRequest(markRead);
                            return true;

                        case ChatAckRequest ack:
                            ack.TriggerSuccess(new ChatAckResponse { Silences = silencedUserIds.Select(u => new ChatSilence { UserId = u }).ToArray() });
                            silencedUserIds.Clear();
                            return true;

                        case GetMessagesRequest getMessages:
                            getMessages.TriggerSuccess(sentMessages);
                            return true;

                        case GetUpdatesRequest updatesRequest:
                            updatesRequest.TriggerSuccess(new GetUpdatesResponse
                            {
                                Messages = sentMessages.ToList(),
                                Presence = new List<Channel>()
                            });
                            return true;
                    }

                    return false;
                };
            });
        }

        [Test]
        public void TestCommandsPostedToCorrectChannelWhenNotCurrent()
        {
            Channel channel1 = null;
            Channel channel2 = null;

            AddStep("join 2 rooms", () =>
            {
                channelManager.JoinChannel(channel1 = createChannel(1, ChannelType.Public));
                channelManager.JoinChannel(channel2 = createChannel(2, ChannelType.Public));
            });

            AddStep("select channel 1", () => channelManager.CurrentChannel.Value = channel1);

            AddStep("post /me command to channel 2", () => channelManager.PostCommand("me dances", channel2));
            AddAssert("/me command received by channel 2", () => channel2.Messages.Last().Content == "dances");

            AddStep("post /np command to channel 2", () => channelManager.PostCommand("np", channel2));
            AddAssert("/np command received by channel 2", () => channel2.Messages.Last().Content.Contains("is listening to"));
        }

        [Test]
        public void TestMarkAsReadIgnoringLocalMessages()
        {
            Channel channel = null;

            AddStep("join channel and select it", () =>
            {
                channelManager.JoinChannel(channel = createChannel(1, ChannelType.Public));
                channelManager.CurrentChannel.Value = channel;
            });

            AddStep("post message", () => channelManager.PostMessage("Something interesting"));
            AddUntilStep("message posted", () => !channel.Messages.Any(m => m is LocalMessage));

            AddStep("post /help command", () => channelManager.PostCommand("help", channel));
            AddStep("post /me command with no action", () => channelManager.PostCommand("me", channel));
            AddStep("post /join command with no channel", () => channelManager.PostCommand("join", channel));
            AddStep("post /join command with non-existent channel", () => channelManager.PostCommand("join i-dont-exist", channel));
            AddStep("post non-existent command", () => channelManager.PostCommand("non-existent-cmd arg", channel));

            AddStep("mark channel as read", () => channelManager.MarkChannelAsRead(channel));
            AddAssert("channel's last read ID is set to the latest message", () => channel.LastReadId == sentMessages.Last().Id);
        }

        [Test]
        public void TestSilencedUsersAreRemoved()
        {
            Channel channel = null;

            AddStep("join channel and select it", () =>
            {
                channelManager.JoinChannel(channel = createChannel(1, ChannelType.Public));
                channelManager.CurrentChannel.Value = channel;
            });

            AddStep("post message", () => channelManager.PostMessage("Definitely something bad"));

            AddStep("mark user as silenced and send ack request", () =>
            {
                silencedUserIds.Add(API.LocalUser.Value.OnlineID);
                channelManager.SendAck();
            });

            AddAssert("channel has no more messages", () => channel.Messages, () => Is.Empty);
        }

        [Test]
        public void TestCommandNameCaseInsensitivity()
        {
            Channel channel = null;

            AddStep("join channel and select it", () =>
            {
                channelManager.JoinChannel(channel = createChannel(1, ChannelType.Public));
                channelManager.CurrentChannel.Value = channel;
            });

            AddStep("post /me command", () => channelManager.PostCommand("ME DANCES"));
            AddUntilStep("/me command received", () => channel.Messages.Last().Content.Contains("DANCES"));
            AddStep("post /help command", () => channelManager.PostCommand("HeLp"));
            AddUntilStep("/help command received", () => channel.Messages.Last().Content.Contains("Supported commands"));
        }

        [Test]
        public void TestBlockedUserMessagesAreDeletedFromInitialMessageBatch()
        {
            Channel channel = null;

            AddStep("create channel", () => channel = createChannel(1, ChannelType.Public));
            AddStep("post a message from blocked user", () => sentMessages.Add(new Message
            {
                ChannelId = channel.Id,
                Content = "i am blocked",
                SenderId = 1234
            }));
            AddStep("mark user as blocked", () => ((DummyAPIAccess)API).LocalUserState.Blocks.Add(new APIRelation
            {
                TargetUser = new APIUser { Username = "blocked", Id = 1234 },
                TargetID = 1234,
            }));

            AddStep("join channel and select it", () =>
            {
                channelManager.JoinChannel(channel);
                channelManager.CurrentChannel.Value = channel;
            });
            AddAssert("channel has no messages", () => channel.Messages, () => Is.Empty);
        }

        [Test]
        public void TestBlockedUserMessagesAreDeletedImmediatelyOnBlock()
        {
            Channel channel = null;

            AddStep("create channel", () => channel = createChannel(1, ChannelType.Public));

            AddStep("join channel and select it", () =>
            {
                channelManager.JoinChannel(channel);
                channelManager.CurrentChannel.Value = channel;
            });
            AddStep("post a message from blocked user", () => sentMessages.Add(new Message
            {
                ChannelId = channel.Id,
                Content = "i am blocked",
                SenderId = 1234
            }));
            AddUntilStep("channel has message", () => channel.Messages, () => Is.Not.Empty);

            AddStep("block user", () => ((DummyAPIAccess)API).LocalUserState.Blocks.Add(new APIRelation
            {
                TargetUser = new APIUser { Username = "blocked", Id = 1234 },
                TargetID = 1234,
            }));
            AddAssert("channel has no messages", () => channel.Messages, () => Is.Empty);
        }

        [Test]
        public void TestPrivateChannelsPurgedOnUserChange()
        {
            var pmChannel = createChannel(1002, ChannelType.PM);
            AddStep("join a few private channels", () =>
            {
                channelManager.JoinChannel(createChannel(1001, ChannelType.PM));
                channelManager.JoinChannel(createChannel(1003, ChannelType.Team));
                channelManager.JoinChannel(pmChannel);
            });
            AddStep("close a PM channel", () => channelManager.LeaveChannel(pmChannel));

            AddStep("switch user", () =>
            {
                ((DummyAPIAccess.DummyLocalUserState)API.LocalUserState).User.Value = new APIUser
                {
                    Id = 9009,
                    Username = "someone_else"
                };
            });

            AddAssert("not joined to private channels of previous user",
                () => !channelManager.JoinedChannels.Select(ch => ch.Id).Any(id => id >= 1001 && id <= 1003));
        }

        private void handlePostMessageRequest(PostMessageRequest request)
        {
            var message = new Message(++currentMessageId)
            {
                IsAction = request.Message.IsAction,
                ChannelId = request.Message.ChannelId,
                Content = request.Message.Content,
                Links = request.Message.Links,
                Timestamp = request.Message.Timestamp,
                Sender = request.Message.Sender,
                Uuid = request.Message.Uuid
            };

            sentMessages.Add(message);
            request.TriggerSuccess(message);
        }

        private void handleMarkChannelAsReadRequest(MarkChannelAsReadRequest request)
        {
            // only accept messages that were sent through the API
            if (sentMessages.Contains(request.Message))
            {
                request.TriggerSuccess();
            }
            else
            {
                request.TriggerFailure(new APIException("unknown message!", null));
            }
        }

        private Channel createChannel(int id, ChannelType type) => new Channel(new APIUser { Id = id })
        {
            Id = id,
            Name = $"Channel {id}",
            Topic = $"Topic of channel {id} with type {type}",
            Type = type,
            LastMessageId = 0,
        };

        private partial class ChannelManagerContainer : CompositeDrawable
        {
            [Cached]
            public ChannelManager ChannelManager { get; }

            public ChannelManagerContainer(IAPIProvider apiProvider)
            {
                InternalChild = ChannelManager = new ChannelManager(apiProvider);
            }
        }
    }
}