Merge pull request #8288 from EVAST9919/friends-layout-split

Implement FriendDisplay component

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

@@ -0,0 +1,87 @@
+// 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;
+using System.Collections.Generic;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Overlays.Dashboard.Friends;
+using osu.Framework.Graphics;
+using osu.Game.Users;
+using osu.Game.Overlays;
+using osu.Framework.Allocation;
+using NUnit.Framework;
+
+namespace osu.Game.Tests.Visual.Online
+{
+    public class TestSceneFriendDisplay : OsuTestScene
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[]
+        {
+            typeof(FriendDisplay),
+            typeof(FriendOnlineStreamControl),
+            typeof(UserListToolbar)
+        };
+
+        protected override bool UseOnlineAPI => true;
+
+        [Cached]
+        private readonly OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Purple);
+
+        private FriendDisplay display;
+
+        [SetUp]
+        public void Setup() => Schedule(() =>
+        {
+            Child = new BasicScrollContainer
+            {
+                RelativeSizeAxes = Axes.Both,
+                Child = display = new FriendDisplay()
+            };
+        });
+
+        [Test]
+        public void TestOffline()
+        {
+            AddStep("Populate", () => display.Users = getUsers());
+        }
+
+        [Test]
+        public void TestOnline()
+        {
+            AddStep("Fetch online", () => display?.Fetch());
+        }
+
+        private List<User> getUsers() => new List<User>
+        {
+            new User
+            {
+                Username = "flyte",
+                Id = 3103765,
+                IsOnline = true,
+                CurrentModeRank = 1111,
+                Country = new Country { FlagName = "JP" },
+                CoverUrl = "https://osu.ppy.sh/images/headers/profile-covers/c6.jpg"
+            },
+            new User
+            {
+                Username = "peppy",
+                Id = 2,
+                IsOnline = false,
+                CurrentModeRank = 2222,
+                Country = new Country { FlagName = "AU" },
+                CoverUrl = "https://osu.ppy.sh/images/headers/profile-covers/c3.jpg",
+                IsSupporter = true,
+                SupportLevel = 3,
+            },
+            new User
+            {
+                Username = "Evast",
+                Id = 8195163,
+                Country = new Country { FlagName = "BY" },
+                CoverUrl = "https://assets.ppy.sh/user-profile-covers/8195163/4a8e2ad5a02a2642b631438cfa6c6bd7e2f9db289be881cb27df18331f64144c.jpeg",
+                IsOnline = false,
+                LastVisit = DateTimeOffset.Now
+            }
+        };
+    }
+}

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

@@ -8,7 +8,7 @@ using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Game.Overlays;
-using osu.Game.Overlays.Home.Friends;
+using osu.Game.Overlays.Dashboard.Friends;
 using osu.Game.Users;
 
 namespace osu.Game.Tests.Visual.UserInterface
@@ -17,20 +17,20 @@ namespace osu.Game.Tests.Visual.UserInterface
     {
         public override IReadOnlyList<Type> RequiredTypes => new[]
         {
-            typeof(FriendsOnlineStatusControl),
+            typeof(FriendOnlineStreamControl),
             typeof(FriendsOnlineStatusItem),
             typeof(OverlayStreamControl<>),
             typeof(OverlayStreamItem<>),
-            typeof(FriendsBundle)
+            typeof(FriendStream)
         };
 
         [Cached]
         private readonly OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Blue);
 
-        private FriendsOnlineStatusControl control;
+        private FriendOnlineStreamControl control;
 
         [SetUp]
-        public void SetUp() => Schedule(() => Child = control = new FriendsOnlineStatusControl
+        public void SetUp() => Schedule(() => Child = control = new FriendOnlineStreamControl
         {
             Anchor = Anchor.Centre,
             Origin = Anchor.Centre,
@@ -55,9 +55,9 @@ namespace osu.Game.Tests.Visual.UserInterface
                 }
             }));
 
-            AddAssert("3 users", () => control.Items.FirstOrDefault(item => item.Status == FriendsOnlineStatus.All)?.Count == 3);
-            AddAssert("1 online user", () => control.Items.FirstOrDefault(item => item.Status == FriendsOnlineStatus.Online)?.Count == 1);
-            AddAssert("2 offline users", () => control.Items.FirstOrDefault(item => item.Status == FriendsOnlineStatus.Offline)?.Count == 2);
+            AddAssert("3 users", () => control.Items.FirstOrDefault(item => item.Status == OnlineStatus.All)?.Count == 3);
+            AddAssert("1 online user", () => control.Items.FirstOrDefault(item => item.Status == OnlineStatus.Online)?.Count == 1);
+            AddAssert("2 offline users", () => control.Items.FirstOrDefault(item => item.Status == OnlineStatus.Offline)?.Count == 2);
         }
     }
 }

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

@@ -8,7 +8,7 @@ using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Overlays;
-using osu.Game.Overlays.Home.Friends;
+using osu.Game.Overlays.Dashboard.Friends;
 using osuTK;
 
 namespace osu.Game.Tests.Visual.UserInterface

osu.Game/Overlays/Dashboard/Friends/FriendDisplay.cs

@@ -0,0 +1,267 @@
+// 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 System.Threading;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Game.Graphics.UserInterface;
+using osu.Game.Online.API;
+using osu.Game.Online.API.Requests;
+using osu.Game.Users;
+using osuTK;
+
+namespace osu.Game.Overlays.Dashboard.Friends
+{
+    public class FriendDisplay : CompositeDrawable
+    {
+        private List<User> users = new List<User>();
+
+        public List<User> Users
+        {
+            get => users;
+            set
+            {
+                users = value;
+
+                onlineStreamControl.Populate(value);
+            }
+        }
+
+        [Resolved]
+        private IAPIProvider api { get; set; }
+
+        private GetFriendsRequest request;
+        private CancellationTokenSource cancellationToken;
+
+        private Drawable currentContent;
+
+        private readonly FriendOnlineStreamControl onlineStreamControl;
+        private readonly Box background;
+        private readonly Box controlBackground;
+        private readonly UserListToolbar userListToolbar;
+        private readonly Container itemsPlaceholder;
+        private readonly LoadingLayer loading;
+
+        public FriendDisplay()
+        {
+            RelativeSizeAxes = Axes.X;
+            AutoSizeAxes = Axes.Y;
+            InternalChild = new FillFlowContainer
+            {
+                RelativeSizeAxes = Axes.X,
+                AutoSizeAxes = Axes.Y,
+                Children = new Drawable[]
+                {
+                    new Container
+                    {
+                        RelativeSizeAxes = Axes.X,
+                        AutoSizeAxes = Axes.Y,
+                        Children = new Drawable[]
+                        {
+                            controlBackground = new Box
+                            {
+                                RelativeSizeAxes = Axes.Both
+                            },
+                            new Container
+                            {
+                                RelativeSizeAxes = Axes.X,
+                                AutoSizeAxes = Axes.Y,
+                                Padding = new MarginPadding
+                                {
+                                    Top = 20,
+                                    Horizontal = 45
+                                },
+                                Child = onlineStreamControl = new FriendOnlineStreamControl(),
+                            }
+                        }
+                    },
+                    new Container
+                    {
+                        Name = "User List",
+                        RelativeSizeAxes = Axes.X,
+                        AutoSizeAxes = Axes.Y,
+                        Children = new Drawable[]
+                        {
+                            background = new Box
+                            {
+                                RelativeSizeAxes = Axes.Both
+                            },
+                            new FillFlowContainer
+                            {
+                                RelativeSizeAxes = Axes.X,
+                                AutoSizeAxes = Axes.Y,
+                                Direction = FillDirection.Vertical,
+                                Margin = new MarginPadding { Bottom = 20 },
+                                Children = new Drawable[]
+                                {
+                                    new Container
+                                    {
+                                        RelativeSizeAxes = Axes.X,
+                                        AutoSizeAxes = Axes.Y,
+                                        Padding = new MarginPadding
+                                        {
+                                            Horizontal = 40,
+                                            Vertical = 20
+                                        },
+                                        Child = userListToolbar = new UserListToolbar
+                                        {
+                                            Anchor = Anchor.CentreRight,
+                                            Origin = Anchor.CentreRight,
+                                        }
+                                    },
+                                    new Container
+                                    {
+                                        RelativeSizeAxes = Axes.X,
+                                        AutoSizeAxes = Axes.Y,
+                                        Children = new Drawable[]
+                                        {
+                                            itemsPlaceholder = new Container
+                                            {
+                                                RelativeSizeAxes = Axes.X,
+                                                AutoSizeAxes = Axes.Y,
+                                                Padding = new MarginPadding { Horizontal = 50 }
+                                            },
+                                            loading = new LoadingLayer(itemsPlaceholder)
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OverlayColourProvider colourProvider)
+        {
+            background.Colour = colourProvider.Background4;
+            controlBackground.Colour = colourProvider.Background5;
+        }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            onlineStreamControl.Current.BindValueChanged(_ => recreatePanels());
+            userListToolbar.DisplayStyle.BindValueChanged(_ => recreatePanels());
+            userListToolbar.SortCriteria.BindValueChanged(_ => recreatePanels());
+        }
+
+        public void Fetch()
+        {
+            if (!api.IsLoggedIn)
+                return;
+
+            request = new GetFriendsRequest();
+            request.Success += response => Schedule(() => Users = response);
+            api.Queue(request);
+        }
+
+        private void recreatePanels()
+        {
+            if (!users.Any())
+                return;
+
+            cancellationToken?.Cancel();
+
+            if (itemsPlaceholder.Any())
+                loading.Show();
+
+            var sortedUsers = sortUsers(getUsersInCurrentGroup());
+
+            LoadComponentAsync(createTable(sortedUsers), addContentToPlaceholder, (cancellationToken = new CancellationTokenSource()).Token);
+        }
+
+        private List<User> getUsersInCurrentGroup()
+        {
+            switch (onlineStreamControl.Current.Value?.Status)
+            {
+                default:
+                case OnlineStatus.All:
+                    return users;
+
+                case OnlineStatus.Offline:
+                    return users.Where(u => !u.IsOnline).ToList();
+
+                case OnlineStatus.Online:
+                    return users.Where(u => u.IsOnline).ToList();
+            }
+        }
+
+        private void addContentToPlaceholder(Drawable content)
+        {
+            loading.Hide();
+
+            var lastContent = currentContent;
+
+            if (lastContent != null)
+            {
+                lastContent.FadeOut(100, Easing.OutQuint).Expire();
+                lastContent.Delay(25).Schedule(() => lastContent.BypassAutoSizeAxes = Axes.Y);
+            }
+
+            itemsPlaceholder.Add(currentContent = content);
+            currentContent.FadeIn(200, Easing.OutQuint);
+        }
+
+        private FillFlowContainer createTable(List<User> users)
+        {
+            var style = userListToolbar.DisplayStyle.Value;
+
+            return new FillFlowContainer
+            {
+                RelativeSizeAxes = Axes.X,
+                AutoSizeAxes = Axes.Y,
+                Spacing = new Vector2(style == OverlayPanelDisplayStyle.Card ? 10 : 2),
+                Children = users.Select(u => createUserPanel(u, style)).ToList()
+            };
+        }
+
+        private UserPanel createUserPanel(User user, OverlayPanelDisplayStyle style)
+        {
+            switch (style)
+            {
+                default:
+                case OverlayPanelDisplayStyle.Card:
+                    return new UserGridPanel(user).With(panel =>
+                    {
+                        panel.Anchor = Anchor.TopCentre;
+                        panel.Origin = Anchor.TopCentre;
+                        panel.Width = 290;
+                    });
+
+                case OverlayPanelDisplayStyle.List:
+                    return new UserListPanel(user);
+            }
+        }
+
+        private List<User> sortUsers(List<User> unsorted)
+        {
+            switch (userListToolbar.SortCriteria.Value)
+            {
+                default:
+                case UserSortCriteria.LastVisit:
+                    return unsorted.OrderByDescending(u => u.LastVisit).ToList();
+
+                case UserSortCriteria.Rank:
+                    return unsorted.OrderByDescending(u => u.CurrentModeRank.HasValue).ThenBy(u => u.CurrentModeRank ?? 0).ToList();
+
+                case UserSortCriteria.Username:
+                    return unsorted.OrderBy(u => u.Username).ToList();
+            }
+        }
+
+        protected override void Dispose(bool isDisposing)
+        {
+            request?.Cancel();
+            cancellationToken?.Cancel();
+
+            base.Dispose(isDisposing);
+        }
+    }
+}

osu.Game/Overlays/Dashboard/Friends/FriendOnlineStreamControl.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 System.Collections.Generic;
+using System.Linq;
+using osu.Game.Users;
+
+namespace osu.Game.Overlays.Dashboard.Friends
+{
+    public class FriendOnlineStreamControl : OverlayStreamControl<FriendStream>
+    {
+        protected override OverlayStreamItem<FriendStream> CreateStreamItem(FriendStream value) => new FriendsOnlineStatusItem(value);
+
+        public void Populate(List<User> users)
+        {
+            Clear();
+
+            var userCount = users.Count;
+            var onlineUsersCount = users.Count(user => user.IsOnline);
+
+            AddItem(new FriendStream(OnlineStatus.All, userCount));
+            AddItem(new FriendStream(OnlineStatus.Online, onlineUsersCount));
+            AddItem(new FriendStream(OnlineStatus.Offline, userCount - onlineUsersCount));
+
+            Current.Value = Items.FirstOrDefault();
+        }
+    }
+}

osu.Game/Overlays/Dashboard/Friends/FriendStream.cs

@@ -0,0 +1,18 @@
+// 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.
+
+namespace osu.Game.Overlays.Dashboard.Friends
+{
+    public class FriendStream
+    {
+        public OnlineStatus Status { get; }
+
+        public int Count { get; }
+
+        public FriendStream(OnlineStatus status, int count)
+        {
+            Status = status;
+            Count = count;
+        }
+    }
+}

osu.Game/Overlays/Dashboard/Friends/FriendsOnlineStatusItem.cs

@@ -5,11 +5,11 @@ using System;
 using osu.Game.Graphics;
 using osuTK.Graphics;
 
-namespace osu.Game.Overlays.Home.Friends
+namespace osu.Game.Overlays.Dashboard.Friends
 {
-    public class FriendsOnlineStatusItem : OverlayStreamItem<FriendsBundle>
+    public class FriendsOnlineStatusItem : OverlayStreamItem<FriendStream>
     {
-        public FriendsOnlineStatusItem(FriendsBundle value)
+        public FriendsOnlineStatusItem(FriendStream value)
             : base(value)
         {
         }
@@ -22,13 +22,13 @@ namespace osu.Game.Overlays.Home.Friends
         {
             switch (Value.Status)
             {
-                case FriendsOnlineStatus.All:
+                case OnlineStatus.All:
                     return Color4.White;
 
-                case FriendsOnlineStatus.Online:
+                case OnlineStatus.Online:
                     return colours.GreenLight;
 
-                case FriendsOnlineStatus.Offline:
+                case OnlineStatus.Offline:
                     return Color4.Black;
 
                 default:

osu.Game/Overlays/Dashboard/Friends/OnlineStatus.cs

@@ -0,0 +1,12 @@
+// 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.
+
+namespace osu.Game.Overlays.Dashboard.Friends
+{
+    public enum OnlineStatus
+    {
+        All,
+        Online,
+        Offline
+    }
+}

osu.Game/Overlays/Dashboard/Friends/UserListToolbar.cs

@@ -6,7 +6,7 @@ using osu.Framework.Graphics.Containers;
 using osuTK;
 using osu.Framework.Bindables;
 
-namespace osu.Game.Overlays.Home.Friends
+namespace osu.Game.Overlays.Dashboard.Friends
 {
     public class UserListToolbar : CompositeDrawable
     {

osu.Game/Overlays/Dashboard/Friends/UserSortTabControl.cs

@@ -3,7 +3,7 @@
 
 using System.ComponentModel;
 
-namespace osu.Game.Overlays.Home.Friends
+namespace osu.Game.Overlays.Dashboard.Friends
 {
     public class UserSortTabControl : OverlaySortTabControl<UserSortCriteria>
     {

osu.Game/Overlays/Home/Friends/FriendsBundle.cs

@@ -1,25 +0,0 @@
-// 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.
-
-namespace osu.Game.Overlays.Home.Friends
-{
-    public class FriendsBundle
-    {
-        public FriendsOnlineStatus Status { get; }
-
-        public int Count { get; }
-
-        public FriendsBundle(FriendsOnlineStatus status, int count)
-        {
-            Status = status;
-            Count = count;
-        }
-    }
-
-    public enum FriendsOnlineStatus
-    {
-        All,
-        Online,
-        Offline
-    }
-}

osu.Game/Overlays/Home/Friends/FriendsOnlineStatusControl.cs

@@ -1,26 +0,0 @@
-// 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.Game.Users;
-
-namespace osu.Game.Overlays.Home.Friends
-{
-    public class FriendsOnlineStatusControl : OverlayStreamControl<FriendsBundle>
-    {
-        protected override OverlayStreamItem<FriendsBundle> CreateStreamItem(FriendsBundle value) => new FriendsOnlineStatusItem(value);
-
-        public void Populate(List<User> users)
-        {
-            var userCount = users.Count;
-            var onlineUsersCount = users.Count(user => user.IsOnline);
-
-            AddItem(new FriendsBundle(FriendsOnlineStatus.All, userCount));
-            AddItem(new FriendsBundle(FriendsOnlineStatus.Online, onlineUsersCount));
-            AddItem(new FriendsBundle(FriendsOnlineStatus.Offline, userCount - onlineUsersCount));
-
-            Current.Value = Items.FirstOrDefault();
-        }
-    }
-}

osu.Game/Users/User.cs

@@ -69,6 +69,9 @@ namespace osu.Game.Users
         [JsonProperty(@"support_level")]
         public int SupportLevel;
 
+        [JsonProperty(@"current_mode_rank")]
+        public int? CurrentModeRank;
+
         [JsonProperty(@"is_gmt")]
         public bool IsGMT;
 

osu.Game/Users/UserPanel.cs

@@ -99,6 +99,9 @@ namespace osu.Game.Users
         {
             base.LoadComplete();
             Status.TriggerChange();
+
+            // Colour should be applied immediately on first load.
+            statusIcon.FinishTransforms();
         }
 
         protected override bool OnHover(HoverEvent e)