Merge pull request #27164 from frenzibyte/comment-mapper-pill

Add support for displaying "mapper" badge in comment section

osu.Game.Tests/Visual/Online/TestSceneCommentsContainer.cs

@@ -170,6 +170,24 @@ namespace osu.Game.Tests.Visual.Online
             });
         }
 
+        [Test]
+        public void TestPostAsOwner()
+        {
+            setUpCommentsResponse(getExampleComments());
+            AddStep("show comments", () => commentsContainer.ShowComments(CommentableType.Beatmapset, 123));
+
+            setUpPostResponse(true);
+            AddStep("enter text", () => editorTextBox.Current.Value = "comm");
+            AddStep("submit", () => commentsContainer.ChildrenOfType<CommentEditor>().Single().ChildrenOfType<RoundedButton>().First().TriggerClick());
+
+            AddUntilStep("comment sent", () =>
+            {
+                string writtenText = editorTextBox.Current.Value;
+                var comment = commentsContainer.ChildrenOfType<DrawableComment>().LastOrDefault();
+                return comment != null && comment.ChildrenOfType<SpriteText>().Any(y => y.Text == writtenText) && comment.ChildrenOfType<SpriteText>().Any(y => y.Text == "MAPPER");
+            });
+        }
+
         private void setUpCommentsResponse(CommentBundle commentBundle)
             => AddStep("set up response", () =>
             {
@@ -183,7 +201,7 @@ namespace osu.Game.Tests.Visual.Online
                 };
             });
 
-        private void setUpPostResponse()
+        private void setUpPostResponse(bool asOwner = false)
             => AddStep("set up response", () =>
             {
                 dummyAPI.HandleRequest = request =>
@@ -191,7 +209,7 @@ namespace osu.Game.Tests.Visual.Online
                     if (!(request is CommentPostRequest req))
                         return false;
 
-                    req.TriggerSuccess(new CommentBundle
+                    var bundle = new CommentBundle
                     {
                         Comments = new List<Comment>
                         {
@@ -202,9 +220,26 @@ namespace osu.Game.Tests.Visual.Online
                                 LegacyName = "FirstUser",
                                 CreatedAt = DateTimeOffset.Now,
                                 VotesCount = 98,
+                                CommentableId = 2001,
+                                CommentableType = "test",
                             }
                         }
-                    });
+                    };
+
+                    if (asOwner)
+                    {
+                        bundle.Comments[0].UserId = 1001;
+                        bundle.Comments[0].User = new APIUser { Id = 1001, Username = "FirstUser" };
+                        bundle.CommentableMeta.Add(new CommentableMeta
+                        {
+                            Id = 2001,
+                            OwnerId = 1001,
+                            OwnerTitle = "MAPPER",
+                            Type = "test",
+                        });
+                    }
+
+                    req.TriggerSuccess(bundle);
                     return true;
                 };
             });

osu.Game.Tests/Visual/Online/TestSceneDrawableComment.cs

@@ -4,62 +4,66 @@
 #nullable disable
 
 using System;
-using NUnit.Framework;
+using System.Linq;
-using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Shapes;
+using osu.Game.Graphics.Containers;
 using osu.Game.Online.API.Requests.Responses;
-using osu.Game.Overlays;
 using osu.Game.Overlays.Comments;
+using osu.Game.Tests.Visual.UserInterface;
 
 namespace osu.Game.Tests.Visual.Online
 {
-    public partial class TestSceneDrawableComment : OsuTestScene
+    public partial class TestSceneDrawableComment : ThemeComparisonTestScene
     {
-        [Cached]
+        public TestSceneDrawableComment()
-        private readonly OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Purple);
+            : base(false)
-
-        private Container container;
-
-        [SetUp]
-        public void SetUp() => Schedule(() =>
         {
-            Children = new Drawable[]
-            {
-                new Box
-                {
-                    RelativeSizeAxes = Axes.Both,
-                    Colour = colourProvider.Background4,
-                },
-                container = new Container
-                {
-                    RelativeSizeAxes = Axes.X,
-                    AutoSizeAxes = Axes.Y,
-                },
-            };
-        });
-
-        [TestCaseSource(nameof(comments))]
-        public void TestComment(string description, string text)
-        {
-            AddStep(description, () =>
-            {
-                comment.Pinned = description == "Pinned";
-                comment.Message = text;
-                container.Add(new DrawableComment(comment));
-            });
         }
 
-        private static readonly Comment comment = new Comment
+        protected override Drawable CreateContent() => new OsuScrollContainer(Direction.Vertical)
         {
-            Id = 1,
+            RelativeSizeAxes = Axes.Both,
-            LegacyName = "Test User",
+            Child = new FillFlowContainer
-            CreatedAt = DateTimeOffset.Now,
+            {
-            VotesCount = 0,
+                RelativeSizeAxes = Axes.X,
+                AutoSizeAxes = Axes.Y,
+                Direction = FillDirection.Vertical,
+                ChildrenEnumerable = comments.Select(info =>
+                {
+                    var comment = new Comment
+                    {
+                        Id = 1,
+                        UserId = 1000,
+                        User = new APIUser { Id = 1000, Username = "Someone" },
+                        CreatedAt = DateTimeOffset.Now,
+                        VotesCount = 0,
+                        Pinned = info[0] == "Pinned",
+                        Message = info[1],
+                        CommentableId = 2001,
+                        CommentableType = "test"
+                    };
+
+                    return new[]
+                    {
+                        new DrawableComment(comment, Array.Empty<CommentableMeta>()),
+                        new DrawableComment(comment, new[]
+                        {
+                            new CommentableMeta
+                            {
+                                Id = 2001,
+                                OwnerId = comment.UserId,
+                                OwnerTitle = "MAPPER",
+                                Type = "test",
+                            },
+                            new CommentableMeta { Title = "Other Meta" },
+                        }),
+                    };
+                }).SelectMany(c => c)
+            }
         };
 
-        private static object[] comments =
+        private static readonly string[][] comments =
         {
             new[] { "Plain", "This is plain comment" },
             new[] { "Pinned", "This is pinned comment" },

osu.Game.Tests/Visual/UserInterface/ThemeComparisonTestScene.cs

@@ -14,31 +14,39 @@ namespace osu.Game.Tests.Visual.UserInterface
 {
     public abstract partial class ThemeComparisonTestScene : OsuGridTestScene
     {
-        protected ThemeComparisonTestScene()
+        private readonly bool showWithoutColourProvider;
-            : base(1, 2)
+
+        protected ThemeComparisonTestScene(bool showWithoutColourProvider = true)
+            : base(1, showWithoutColourProvider ? 2 : 1)
         {
+            this.showWithoutColourProvider = showWithoutColourProvider;
         }
 
         [BackgroundDependencyLoader]
         private void load(OsuColour colours)
         {
-            Cell(0, 0).AddRange(new[]
+            if (showWithoutColourProvider)
             {
-                new Box
+                Cell(0, 0).AddRange(new[]
                 {
-                    RelativeSizeAxes = Axes.Both,
+                    new Box
-                    Colour = colours.GreySeaFoam
+                    {
-                },
+                        RelativeSizeAxes = Axes.Both,
-                CreateContent()
+                        Colour = colours.GreySeaFoam
-            });
+                    },
+                    CreateContent()
+                });
+            }
         }
 
         protected void CreateThemedContent(OverlayColourScheme colourScheme)
         {
             var colourProvider = new OverlayColourProvider(colourScheme);
 
-            Cell(0, 1).Clear();
+            int col = showWithoutColourProvider ? 1 : 0;
-            Cell(0, 1).Add(new DependencyProvidingContainer
+
+            Cell(0, col).Clear();
+            Cell(0, col).Add(new DependencyProvidingContainer
             {
                 RelativeSizeAxes = Axes.Both,
                 CachedDependencies = new (Type, object)[]

osu.Game/Online/API/Requests/Responses/Comment.cs

@@ -33,7 +33,7 @@ namespace osu.Game.Online.API.Requests.Responses
         [JsonProperty(@"votes_count")]
         public int VotesCount { get; set; }
 
-        [JsonProperty(@"commenatble_type")]
+        [JsonProperty(@"commentable_type")]
         public string CommentableType { get; set; } = null!;
 
         [JsonProperty(@"commentable_id")]

osu.Game/Online/API/Requests/Responses/CommentBundle.cs

@@ -11,6 +11,9 @@ namespace osu.Game.Online.API.Requests.Responses
 {
     public class CommentBundle
     {
+        [JsonProperty(@"commentable_meta")]
+        public List<CommentableMeta> CommentableMeta { get; set; } = new List<CommentableMeta>();
+
         [JsonProperty(@"comments")]
         public List<Comment> Comments { get; set; }
 

osu.Game/Online/API/Requests/Responses/CommentableMeta.cs

@@ -0,0 +1,28 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using Newtonsoft.Json;
+
+namespace osu.Game.Online.API.Requests.Responses
+{
+    public class CommentableMeta
+    {
+        [JsonProperty("id")]
+        public long Id { get; set; }
+
+        [JsonProperty("owner_id")]
+        public long? OwnerId { get; set; }
+
+        [JsonProperty("owner_title")]
+        public string? OwnerTitle { get; set; }
+
+        [JsonProperty("title")]
+        public string Title { get; set; } = string.Empty;
+
+        [JsonProperty("type")]
+        public string Type { get; set; } = string.Empty;
+
+        [JsonProperty("url")]
+        public string Url { get; set; } = string.Empty;
+    }
+}

osu.Game/Overlays/Comments/CommentAuthorLine.cs

@@ -0,0 +1,180 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Collections.Generic;
+using System.Linq;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Cursor;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics.Sprites;
+using osu.Framework.Localisation;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Resources.Localisation.Web;
+using osuTK;
+
+namespace osu.Game.Overlays.Comments
+{
+    public partial class CommentAuthorLine : FillFlowContainer
+    {
+        private readonly Comment comment;
+        private readonly IReadOnlyList<CommentableMeta> meta;
+
+        private OsuSpriteText deletedLabel = null!;
+
+        public CommentAuthorLine(Comment comment, IReadOnlyList<CommentableMeta> meta)
+        {
+            this.comment = comment;
+            this.meta = meta;
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            AutoSizeAxes = Axes.Both;
+            Direction = FillDirection.Horizontal;
+            Spacing = new Vector2(4, 0);
+
+            Add(new LinkFlowContainer(s => s.Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold))
+            {
+                AutoSizeAxes = Axes.Both
+            }.With(username =>
+            {
+                if (comment.UserId.HasValue)
+                    username.AddUserLink(comment.User);
+                else
+                    username.AddText(comment.LegacyName!);
+            }));
+
+            var ownerMeta = meta.FirstOrDefault(m => m.Id == comment.CommentableId && m.Type == comment.CommentableType);
+
+            if (ownerMeta?.OwnerId != null && ownerMeta.OwnerId == comment.UserId)
+            {
+                Add(new OwnerTitleBadge(ownerMeta.OwnerTitle ?? string.Empty)
+                {
+                    // add top space to align with username
+                    Margin = new MarginPadding { Top = 1f },
+                });
+            }
+
+            if (comment.Pinned)
+                Add(new PinnedCommentNotice());
+
+            Add(new ParentUsername(comment));
+
+            Add(deletedLabel = new OsuSpriteText
+            {
+                Alpha = 0f,
+                Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold),
+                Text = CommentsStrings.Deleted
+            });
+        }
+
+        public void MarkDeleted()
+        {
+            deletedLabel.Show();
+        }
+
+        private partial class OwnerTitleBadge : CircularContainer
+        {
+            private readonly string title;
+
+            public OwnerTitleBadge(string title)
+            {
+                this.title = title;
+            }
+
+            [BackgroundDependencyLoader]
+            private void load(OverlayColourProvider colourProvider)
+            {
+                AutoSizeAxes = Axes.Both;
+                Masking = true;
+
+                InternalChildren = new Drawable[]
+                {
+                    new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = colourProvider.Light1,
+                    },
+                    new OsuSpriteText
+                    {
+                        Text = title,
+                        Font = OsuFont.Default.With(size: 10, weight: FontWeight.Bold),
+                        Margin = new MarginPadding { Vertical = 2, Horizontal = 5 },
+                        Colour = colourProvider.Background6,
+                    },
+                };
+            }
+        }
+
+        private partial class PinnedCommentNotice : FillFlowContainer
+        {
+            public PinnedCommentNotice()
+            {
+                AutoSizeAxes = Axes.Both;
+                Direction = FillDirection.Horizontal;
+                Spacing = new Vector2(2, 0);
+                Children = new Drawable[]
+                {
+                    new SpriteIcon
+                    {
+                        Icon = FontAwesome.Solid.Thumbtack,
+                        Size = new Vector2(14),
+                        Anchor = Anchor.CentreLeft,
+                        Origin = Anchor.CentreLeft,
+                    },
+                    new OsuSpriteText
+                    {
+                        Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold),
+                        Text = CommentsStrings.Pinned,
+                        Anchor = Anchor.CentreLeft,
+                        Origin = Anchor.CentreLeft,
+                    }
+                };
+            }
+        }
+
+        private partial class ParentUsername : FillFlowContainer, IHasTooltip
+        {
+            public LocalisableString TooltipText => getParentMessage();
+
+            private readonly Comment? parentComment;
+
+            public ParentUsername(Comment comment)
+            {
+                parentComment = comment.ParentComment;
+
+                AutoSizeAxes = Axes.Both;
+                Direction = FillDirection.Horizontal;
+                Spacing = new Vector2(3, 0);
+                Alpha = comment.ParentId == null ? 0 : 1;
+                Children = new Drawable[]
+                {
+                    new SpriteIcon
+                    {
+                        Icon = FontAwesome.Solid.Reply,
+                        Size = new Vector2(14),
+                    },
+                    new OsuSpriteText
+                    {
+                        Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold, italics: true),
+                        Text = parentComment?.User?.Username ?? parentComment?.LegacyName!
+                    }
+                };
+            }
+
+            private LocalisableString getParentMessage()
+            {
+                if (parentComment == null)
+                    return string.Empty;
+
+                return parentComment.HasMessage ? parentComment.Message : parentComment.IsDeleted ? CommentsStrings.Deleted : string.Empty;
+            }
+        }
+    }
+}

osu.Game/Overlays/Comments/CommentsContainer.cs

@@ -301,7 +301,7 @@ namespace osu.Game.Overlays.Comments
 
             void addNewComment(Comment comment)
             {
-                var drawableComment = GetDrawableComment(comment);
+                var drawableComment = GetDrawableComment(comment, bundle.CommentableMeta);
 
                 if (comment.ParentId == null)
                 {
@@ -333,7 +333,7 @@ namespace osu.Game.Overlays.Comments
                 if (CommentDictionary.ContainsKey(comment.Id))
                     continue;
 
-                topLevelComments.Add(GetDrawableComment(comment));
+                topLevelComments.Add(GetDrawableComment(comment, bundle.CommentableMeta));
             }
 
             if (topLevelComments.Any())
@@ -351,12 +351,12 @@ namespace osu.Game.Overlays.Comments
             }
         }
 
-        public DrawableComment GetDrawableComment(Comment comment)
+        public DrawableComment GetDrawableComment(Comment comment, IReadOnlyList<CommentableMeta> meta)
         {
             if (CommentDictionary.TryGetValue(comment.Id, out var existing))
                 return existing;
 
-            return CommentDictionary[comment.Id] = new DrawableComment(comment)
+            return CommentDictionary[comment.Id] = new DrawableComment(comment, meta)
             {
                 ShowDeleted = { BindTarget = ShowDeleted },
                 Sort = { BindTarget = Sort },

osu.Game/Overlays/Comments/DrawableComment.cs

@@ -4,12 +4,10 @@
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics;
 using osu.Game.Graphics;
-using osu.Framework.Graphics.Sprites;
 using osuTK;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Users.Drawables;
 using osu.Game.Graphics.Containers;
-using osu.Framework.Graphics.Cursor;
 using osu.Framework.Bindables;
 using System.Linq;
 using osu.Game.Graphics.Sprites;
@@ -21,7 +19,6 @@ using osu.Framework.Extensions.IEnumerableExtensions;
 using System.Collections.Specialized;
 using System.Diagnostics;
 using osu.Framework.Extensions.LocalisationExtensions;
-using osu.Framework.Localisation;
 using osu.Framework.Logging;
 using osu.Framework.Platform;
 using osu.Game.Graphics.UserInterface;
@@ -42,6 +39,7 @@ namespace osu.Game.Overlays.Comments
         public Action<DrawableComment, int> RepliesRequested = null!;
 
         public readonly Comment Comment;
+        public readonly IReadOnlyList<CommentableMeta> Meta;
 
         public readonly BindableBool ShowDeleted = new BindableBool();
         public readonly Bindable<CommentsSortCriteria> Sort = new Bindable<CommentsSortCriteria>();
@@ -72,7 +70,7 @@ namespace osu.Game.Overlays.Comments
         private LinkFlowContainer actionsContainer = null!;
         private LoadingSpinner actionsLoading = null!;
         private DeletedCommentsCounter deletedCommentsCounter = null!;
-        private OsuSpriteText deletedLabel = null!;
+        private CommentAuthorLine author = null!;
         private GridContainer content = null!;
         private VotePill votePill = null!;
         private Container<CommentEditor> replyEditorContainer = null!;
@@ -90,15 +88,15 @@ namespace osu.Game.Overlays.Comments
         [Resolved]
         private OnScreenDisplay? onScreenDisplay { get; set; }
 
-        public DrawableComment(Comment comment)
+        public DrawableComment(Comment comment, IReadOnlyList<CommentableMeta> meta)
         {
             Comment = comment;
+            Meta = meta;
         }
 
         [BackgroundDependencyLoader]
         private void load(OverlayColourProvider colourProvider, DrawableComment? parentComment)
         {
-            LinkFlowContainer username;
             FillFlowContainer info;
             CommentMarkdownContainer message;
 
@@ -174,27 +172,7 @@ namespace osu.Game.Overlays.Comments
                                             },
                                             Children = new Drawable[]
                                             {
-                                                new FillFlowContainer
+                                                author = new CommentAuthorLine(Comment, Meta),
-                                                {
-                                                    AutoSizeAxes = Axes.Both,
-                                                    Direction = FillDirection.Horizontal,
-                                                    Spacing = new Vector2(10, 0),
-                                                    Children = new[]
-                                                    {
-                                                        username = new LinkFlowContainer(s => s.Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold))
-                                                        {
-                                                            AutoSizeAxes = Axes.Both
-                                                        },
-                                                        Comment.Pinned ? new PinnedCommentNotice() : Empty(),
-                                                        new ParentUsername(Comment),
-                                                        deletedLabel = new OsuSpriteText
-                                                        {
-                                                            Alpha = 0f,
-                                                            Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold),
-                                                            Text = CommentsStrings.Deleted
-                                                        }
-                                                    }
-                                                },
                                                 message = new CommentMarkdownContainer
                                                 {
                                                     RelativeSizeAxes = Axes.X,
@@ -218,7 +196,7 @@ namespace osu.Game.Overlays.Comments
                                                             {
                                                                 new DrawableDate(Comment.CreatedAt, 12, false)
                                                                 {
-                                                                    Colour = colourProvider.Foreground1
+                                                                    Colour = colourProvider.Foreground1,
                                                                 }
                                                             }
                                                         },
@@ -311,11 +289,6 @@ namespace osu.Game.Overlays.Comments
                 }
             };
 
-            if (Comment.UserId.HasValue)
-                username.AddUserLink(Comment.User);
-            else
-                username.AddText(Comment.LegacyName!);
-
             if (Comment.EditedAt.HasValue && Comment.EditedUser != null)
             {
                 var font = OsuFont.GetFont(size: 12, weight: FontWeight.Regular);
@@ -400,7 +373,7 @@ namespace osu.Game.Overlays.Comments
         /// </summary>
         private void makeDeleted()
         {
-            deletedLabel.Show();
+            author.MarkDeleted();
             content.FadeColour(OsuColour.Gray(0.5f));
             votePill.Hide();
             actionsContainer.Expire();
@@ -547,70 +520,5 @@ namespace osu.Game.Overlays.Comments
                 Top = 10
             };
         }
-
-        private partial class PinnedCommentNotice : FillFlowContainer
-        {
-            public PinnedCommentNotice()
-            {
-                AutoSizeAxes = Axes.Both;
-                Direction = FillDirection.Horizontal;
-                Spacing = new Vector2(2, 0);
-                Children = new Drawable[]
-                {
-                    new SpriteIcon
-                    {
-                        Icon = FontAwesome.Solid.Thumbtack,
-                        Size = new Vector2(14),
-                        Anchor = Anchor.CentreLeft,
-                        Origin = Anchor.CentreLeft,
-                    },
-                    new OsuSpriteText
-                    {
-                        Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold),
-                        Text = CommentsStrings.Pinned,
-                        Anchor = Anchor.CentreLeft,
-                        Origin = Anchor.CentreLeft,
-                    }
-                };
-            }
-        }
-
-        private partial class ParentUsername : FillFlowContainer, IHasTooltip
-        {
-            public LocalisableString TooltipText => getParentMessage();
-
-            private readonly Comment? parentComment;
-
-            public ParentUsername(Comment comment)
-            {
-                parentComment = comment.ParentComment;
-
-                AutoSizeAxes = Axes.Both;
-                Direction = FillDirection.Horizontal;
-                Spacing = new Vector2(3, 0);
-                Alpha = comment.ParentId == null ? 0 : 1;
-                Children = new Drawable[]
-                {
-                    new SpriteIcon
-                    {
-                        Icon = FontAwesome.Solid.Reply,
-                        Size = new Vector2(14),
-                    },
-                    new OsuSpriteText
-                    {
-                        Font = OsuFont.GetFont(size: 14, weight: FontWeight.Bold, italics: true),
-                        Text = parentComment?.User?.Username ?? parentComment?.LegacyName!
-                    }
-                };
-            }
-
-            private LocalisableString getParentMessage()
-            {
-                if (parentComment == null)
-                    return string.Empty;
-
-                return parentComment.HasMessage ? parentComment.Message : parentComment.IsDeleted ? CommentsStrings.Deleted : string.Empty;
-            }
-        }
     }
 }

osu.Game/Overlays/Comments/ReplyCommentEditor.cs

@@ -60,7 +60,7 @@ namespace osu.Game.Overlays.Comments
             foreach (var comment in cb.Comments)
                 comment.ParentComment = parentComment;
 
-            var drawables = cb.Comments.Select(commentsContainer.GetDrawableComment).ToArray();
+            var drawables = cb.Comments.Select(c => commentsContainer.GetDrawableComment(c, cb.CommentableMeta)).ToArray();
             OnPost?.Invoke(drawables);
 
             OnCancel!.Invoke();