Avalonia/tests/Avalonia.Controls.UnitTests/ItemsSourceViewTests.cs

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Linq;
using Avalonia.Collections;
using Avalonia.Controls.Platform;
using Avalonia.Diagnostics;
using Avalonia.Threading;
using Avalonia.UnitTests;
using Xunit;

namespace Avalonia.Controls.UnitTests
{
    public class ItemsSourceViewTests : ScopedTestBase
    {
        [Fact]
        public void Only_Subscribes_To_Source_CollectionChanged_When_CollectionChanged_Subscribed()
        {
            var source = new AvaloniaList<string>();
            var target = ItemsSourceView.GetOrCreate(source);
            var debug = (INotifyCollectionChangedDebug)source;

            Assert.Null(debug.GetCollectionChangedSubscribers());

            void Handler(object? sender, NotifyCollectionChangedEventArgs e) { }
            target.CollectionChanged += Handler;

            var subscribers = debug.GetCollectionChangedSubscribers();
            Assert.NotNull(subscribers);
            Assert.Equal(1, subscribers.Length);

            target.CollectionChanged -= Handler;

            Assert.Null(debug.GetCollectionChangedSubscribers());
        }

        [Fact]
        public void Cannot_Create_ItemsSourceView_With_Collection_That_Implements_INCC_But_Not_List()
        {
            var source = new InvalidCollection();
            Assert.Throws<ArgumentException>(() => ItemsSourceView.GetOrCreate(source));
        }

        [Fact]
        public void Reassigning_Source_Unsubscribes_From_Previous_Source()
        {
            var source = new AvaloniaList<string>();
            var target = new ReassignableItemsSourceView(source);
            var debug = (INotifyCollectionChangedDebug)source;

            target.CollectionChanged += (s, e) => { };

            var subscribers = debug.GetCollectionChangedSubscribers();
            Assert.NotNull(subscribers);
            Assert.Equal(1, subscribers.Length);

            target.SetSource(new string[0]);

            Assert.Null(debug.GetCollectionChangedSubscribers());
        }

        [Fact]
        public void Reassigning_Source_Subscribes_To_New_Source()
        {
            var source = new AvaloniaList<string>();
            var target = new ReassignableItemsSourceView(new string[0]);
            var debug = (INotifyCollectionChangedDebug)source;

            target.CollectionChanged += (s, e) => { };
            target.SetSource(source);

            var subscribers = debug.GetCollectionChangedSubscribers();
            Assert.NotNull(subscribers);
            Assert.Equal(1, subscribers.Length);
        }

        [Fact]
        public void Filtered_View_Adds_New_Items()
        {
            var source = new AvaloniaList<string>() { "foo", "bar" };
            var target = ItemsSourceView.GetOrCreate(source);

            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            target.Filters.Add(new FunctionItemFilter(ob => !Equals(bool.FalseString, ob)));

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            source.Add(bool.FalseString);

            Assert.Empty(collectionChangeEvents);

            Assert.Equal(new int[] { 0, 1, -1 }, ItemsSourceView.GetDiagnosticItemMap(target));

            source.InsertRange(1, new[] { bool.TrueString, bool.TrueString });

            Assert.Equal(new int[] { 0, 1, 2, 3, -1 }, ItemsSourceView.GetDiagnosticItemMap(target));

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Add, collectionChangeEvents[0].Action);
            Assert.Equal(1, collectionChangeEvents[0].NewStartingIndex);
            Assert.Equal(2, collectionChangeEvents[0].NewItems.Count);
            Assert.Equal(bool.TrueString, collectionChangeEvents[0].NewItems[0]);

            Assert.Equal(4, target.Count);
            Assert.Equal(bool.TrueString, target[1]);
            Assert.Equal(bool.TrueString, target[2]);

            source.Add(bool.TrueString);

            Assert.Equal(new int[] { 0, 1, 2, 3, -1, 4 }, ItemsSourceView.GetDiagnosticItemMap(target));

            Assert.Equal(5, target.Count);
            Assert.Equal(bool.TrueString, target[^1]);
        }

        [Fact]
        public void Filtered_View_Removes_Old_Items()
        {
            var source = new AvaloniaList<string>() { "foo", "bar", bool.TrueString, bool.FalseString, bool.TrueString, "end" };
            var target = ItemsSourceView.GetOrCreate(source);

            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            target.Filters.Add(new FunctionItemFilter(ob => !Equals(bool.FalseString, ob)));

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            Assert.Equal(new int[] { 0, 1, 2, -1, 3, 4 }, ItemsSourceView.GetDiagnosticItemMap(target));

            source.RemoveAt(4);

            Assert.Equal(4, target.Count);
            Assert.Equal(new int[] { 0, 1, 2, -1, 3 }, ItemsSourceView.GetDiagnosticItemMap(target));

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Remove, collectionChangeEvents[0].Action);
            Assert.Equal(3, collectionChangeEvents[0].OldStartingIndex);
            Assert.Equal(1, collectionChangeEvents[0].OldItems.Count);
            Assert.Equal(bool.TrueString, collectionChangeEvents[0].OldItems[0]);
            collectionChangeEvents.Clear();

            source.RemoveAt(3);
            Assert.Empty(collectionChangeEvents);
            Assert.Equal(4, target.Count);

            Assert.Equal(new int[] { 0, 1, 2, 3 }, ItemsSourceView.GetDiagnosticItemMap(target));
        }

        [Fact]
        public void Filtered_View_Resets_When_Source_Cleared()
        {
            var source = new AvaloniaList<string>() { "foo", "bar" };
            var target = ItemsSourceView.GetOrCreate(source);

            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            target.Filters.Add(new FunctionItemFilter(ob => !Equals(bool.FalseString, ob)));

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            source.Clear();

            Assert.Equal(0, target.Count);
            Assert.Equal(Array.Empty<int>(), ItemsSourceView.GetDiagnosticItemMap(target));
            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
        }

        [Fact]
        public void ComparableSorter_Sorts_Integers()
        {
            var random = new Random();
            var source = new AvaloniaList<int>(Enumerable.Repeat(0, 100).Select(i => random.Next(int.MinValue + 1, int.MaxValue)));
            var target = ItemsSourceView.GetOrCreate(source);

            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            target.Sorters.Add(new ComparableSorter());

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            Assert.Equal(target.Cast<int>().OrderBy(i => i), target);

            source.Add(int.MinValue);

            Assert.Equal(target[0], int.MinValue);

            source.Insert(0, int.MaxValue);

            Assert.Equal(target[target.Count - 1], int.MaxValue);
        }

        [Fact]
        public void Disabled_Layers_Update_View_When_Activated()
        {
            var random = new Random();
            var source = new AvaloniaList<int>(Enumerable.Repeat(0, 100));
            var target = ItemsSourceView.GetOrCreate(source);

            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            var filter = new FunctionItemFilter(ob => (int)ob % 2 == 0) { IsActive = false };
            target.Filters.Add(filter);

            var sorter = new ComparableSorter() { IsActive = false, SortDirection = ListSortDirection.Descending };
            target.Sorters.Add(sorter);

            Assert.Equal(0, collectionChangeEvents.Count);

            Assert.Equal(source, target);

            sorter.IsActive = true;

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            Assert.Equal(source.Reverse(), target);

            filter.IsActive = true;

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            Assert.Equal(source.Reverse().Where((i, _) => i % 2 == 0), target);

            sorter.IsActive = false;

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            collectionChangeEvents.Clear();

            Assert.Equal(source.Where((i, _) => i % 2 == 0), target);
        }

        [Fact]
        public void Layers_Refreshed_When_InvalidationProperty_Changes()
        {
            var source = new AvaloniaList<ViewModel>(Enumerable.Repeat(0, 5).Select(i => new ViewModel()));
            var target = ItemsSourceView.GetOrCreate(source);
            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            target.Filters.Add(new FunctionItemFilter(ob => ((ViewModel)ob).PassesFilter)
            {
                InvalidationPropertyNames = new() { nameof(ViewModel.PassesFilter) },
            });

            target.Sorters.Add(new ComparableSorter(ob => ((ViewModel)ob).LastModified)
            {
                InvalidationPropertyNames = new() { nameof(ViewModel.LastModified) },
            });

            foreach (var vm in source)
                Assert.Equal(1, vm.PropertyChangedSubscriberCount); // One event subscription should be shared between all layers

            Assert.Equal(2, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[1].Action);
            collectionChangeEvents.Clear();

            source[3].PassesFilter = true;

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Add, collectionChangeEvents[0].Action);
            Assert.Equal(0, collectionChangeEvents[0].NewStartingIndex);
            Assert.Equal(new[] { source[3] }, collectionChangeEvents[0].NewItems);
            Assert.Equal(source[3], target[0]);
            collectionChangeEvents.Clear();

            source[0].PassesFilter = true;

            Assert.Equal(new[] { source[3], source[0] }, target); // source[0] comes last because it was modified more recently
        }

        [Fact]
        public void Off_Thread_Collection_Changes_Throw_Exception_When_Layers_Active_And_No_DeferredRefreshScope()
        {
            var dispatcherImpl = new ConfigurableIsLoopThreadDispatcherImpl();
            using var app = UnitTestApplication.Start(new TestServices(dispatcherImpl: dispatcherImpl));

            var source = new AvaloniaList<int>(Enumerable.Repeat(0, 5));
            var target = ItemsSourceView.GetOrCreate(source);

            target.CollectionChanged += delegate { }; // ensure that source.CollectionChanged is subscribed to

            dispatcherImpl.CurrentThreadIsLoopThread = false;

            // Should not throw. If no layers are involved, ItemsSourceView can process the event on any thread.
            // What happens when others try to handle the resulting CollectionChanged event is not its problem!
            source.Add(-1);

            dispatcherImpl.CurrentThreadIsLoopThread = true;
            target.Sorters.Add(new ComparableSorter());

            dispatcherImpl.CurrentThreadIsLoopThread = false;

            Assert.Throws<ItemsSourceView.InvalidThreadException>(() => source.Add(-1));

            using (target.EnterDeferredRefreshScope())
            {
                source.Add(-2);
            }

            Assert.Equal(8, target.Count);
            Assert.Equal(-2, target[0]);
        }

        [Fact]
        public void DeferredUpdateScope_Batches_Changes_Together()
        {
            var dispatcher = new ManagedDispatcherImpl(null);
            using var app = UnitTestApplication.Start(new TestServices(dispatcherImpl: dispatcher));

            var source = new AvaloniaList<int>();
            var target = ItemsSourceView.GetOrCreate(source);

            var collectionChangeEvents = new List<NotifyCollectionChangedEventArgs>();

            target.CollectionChanged += (s, e) => collectionChangeEvents.Add(e);

            using (target.EnterDeferredRefreshScope())
            {
                source.Add(0);
                source.Add(1);
                source.Add(2);
                source.Remove(1);

                target.Filters.Add(new FunctionItemFilter(ob => (int)ob % 2 == 0));

                source.Add(4);
            }

            Assert.Equal(1, collectionChangeEvents.Count);
            Assert.Equal(NotifyCollectionChangedAction.Reset, collectionChangeEvents[0].Action);
            Assert.Equal(new[] { 0, 2, 4 }, target);
        }

        private class ViewModel : INotifyPropertyChanged
        {
            private bool _passesFilter;
            public bool PassesFilter
            {
                get => _passesFilter;
                set
                {
                    _passesFilter = value;
                    PropertyChanged?.Invoke(this, new(nameof(PassesFilter)));

                    LastModified = DateTimeOffset.Now;
                    PropertyChanged?.Invoke(this, new(nameof(LastModified)));
                }
            }

            public DateTimeOffset? LastModified { get; private set; }

            public event PropertyChangedEventHandler PropertyChanged;

            public int PropertyChangedSubscriberCount => PropertyChanged?.GetInvocationList().Length ?? 0;
        }

        private class InvalidCollection : INotifyCollectionChanged, IEnumerable<string>
        {
            public event NotifyCollectionChangedEventHandler? CollectionChanged { add { } remove { } }

            public IEnumerator<string> GetEnumerator()
            {
                yield break;
            }

            IEnumerator IEnumerable.GetEnumerator()
            {
                yield break;
            }
        }

        private class ReassignableItemsSourceView : ItemsSourceView
        {
            public ReassignableItemsSourceView(IEnumerable source)
                : base(null, source)
            {
            }

            public new void SetSource(IEnumerable source) => base.SetSource(source);
        }

        private class ConfigurableIsLoopThreadDispatcherImpl : IDispatcherImpl
        {
            private bool _signalling;

            bool IDispatcherImpl.CurrentThreadIsLoopThread => _signalling || CurrentThreadIsLoopThread;

            public bool CurrentThreadIsLoopThread { get; set; } = true;
            public long Now => DateTime.Now.Ticks;

            public event Action Signaled;
            public event Action Timer;

            public void Signal()
            {
                _signalling = true;

                try
                {
                    Signaled?.Invoke();
                }
                finally
                {
                    _signalling = false;
                }
            }

            public void UpdateTimer(long? dueTimeInMs)
            {
                Timer?.Invoke();
            }
        }
    }
}