Code Quality: Refactoring of SidebarControl.xaml.cs

[QuaintMako]

Resolved / Related Issues
Items resolved / related issues by this PR.

• Related to Feature: Nullable reference types annotations #9895

What has been done

• Refactored src/Files.App/UserControls/SidebarControl.xaml.cs extensively.
• Merged several duplicated sections into methods.
• Reduced the nesting levels.
• Nullable references annotations added.
• Formatting.

Validation
How did you test these changes?

• Built and ran the app

[BanCrash]

On home section, if you click on a tag color on the sidebar, it will throw a notification error and the below error on Visual Studio. However on the last preview there is no error.

--- MESSAGE ---A Task's exception(s) were not observed either by Waiting on the Task or accessing its Exception property. As a result, the unobserved exception was rethrown by the finalizer thread. (Cannot access a disposed object.)
--- INNER ---System.ObjectDisposedException: Cannot access a disposed object.
   at System.Threading.ReaderWriterLockSlim.TryEnterReadLockCore(TimeoutTracker timeout)
   at System.Threading.ReaderWriterLockSlim.TryEnterReadLock(TimeSpan timeout)
   at LiteDB.Engine.LockService.EnterTransaction()
   at LiteDB.Engine.TransactionMonitor.GetTransaction(Boolean create, Boolean queryOnly, Boolean& isNew)
   at LiteDB.Engine.QueryExecutor.ExecuteQuery(Boolean executionPlan)
   at LiteDB.Engine.QueryExecutor.ExecuteQuery()
   at LiteDB.Engine.LiteEngine.Query(String collection, Query query)
   at LiteDB.LiteQueryable`1.ExecuteReader()
   at LiteDB.LiteQueryable`1.ToDocuments()+MoveNext()
   at System.Linq.Enumerable.SelectEnumerableIterator`2.MoveNext()
   at System.Linq.Enumerable.WhereEnumerableIterator`1.MoveNext()
   at Files.App.Filesystem.Search.FolderSearch.SearchTagsAsync(String folder, IList`1 results, CancellationToken token)
   at Files.App.Filesystem.Search.FolderSearch.AddItemsAsync(String folder, IList`1 results, CancellationToken token)
   at Files.App.Filesystem.Search.FolderSearch.AddItemsAsyncForHome(IList`1 results, CancellationToken token)
   at Files.App.ViewModels.ItemViewModel.SearchAsync(FolderSearch search)---------------------------------------

[QuaintMako]

On home section, if you click on a tag color on the sidebar, it will throw a notification error and the below error on Visual Studio. However on the last preview there is no error.

--- MESSAGE ---A Task's exception(s) were not observed either by Waiting on the Task or accessing its Exception property. As a result, the unobserved exception was rethrown by the finalizer thread. (Cannot access a disposed object.)
--- INNER ---System.ObjectDisposedException: Cannot access a disposed object.
   at System.Threading.ReaderWriterLockSlim.TryEnterReadLockCore(TimeoutTracker timeout)
   at System.Threading.ReaderWriterLockSlim.TryEnterReadLock(TimeSpan timeout)
   at LiteDB.Engine.LockService.EnterTransaction()
   at LiteDB.Engine.TransactionMonitor.GetTransaction(Boolean create, Boolean queryOnly, Boolean& isNew)
   at LiteDB.Engine.QueryExecutor.ExecuteQuery(Boolean executionPlan)
   at LiteDB.Engine.QueryExecutor.ExecuteQuery()
   at LiteDB.Engine.LiteEngine.Query(String collection, Query query)
   at LiteDB.LiteQueryable`1.ExecuteReader()
   at LiteDB.LiteQueryable`1.ToDocuments()+MoveNext()
   at System.Linq.Enumerable.SelectEnumerableIterator`2.MoveNext()
   at System.Linq.Enumerable.WhereEnumerableIterator`1.MoveNext()
   at Files.App.Filesystem.Search.FolderSearch.SearchTagsAsync(String folder, IList`1 results, CancellationToken token)
   at Files.App.Filesystem.Search.FolderSearch.AddItemsAsync(String folder, IList`1 results, CancellationToken token)
   at Files.App.Filesystem.Search.FolderSearch.AddItemsAsyncForHome(IList`1 results, CancellationToken token)
   at Files.App.ViewModels.ItemViewModel.SearchAsync(FolderSearch search)---------------------------------------

I cannot seem to reproduce this error. @BanCrash is it still an issue for you? Is it reproductible 100% ?

[gave92]

On home section, if you click on a tag color on the sidebar, it will throw a notification error and the below error on Visual Studio. However on the last preview there is no error.

--- MESSAGE ---A Task's exception(s) were not observed either by Waiting on the Task or accessing its Exception property. As a result, the unobserved exception was rethrown by the finalizer thread. (Cannot access a disposed object.)
--- INNER ---System.ObjectDisposedException: Cannot access a disposed object.
   at System.Threading.ReaderWriterLockSlim.TryEnterReadLockCore(TimeoutTracker timeout)
   at System.Threading.ReaderWriterLockSlim.TryEnterReadLock(TimeSpan timeout)

I cannot seem to reproduce this error. @BanCrash is it still an issue for you? Is it reproductible 100% ?

That error has been fixed by @hez2010 in #10503, just make you have merged main and the error should go away.

[gave92]

If you agree with the changes in 496b161, LGTM.

[QuaintMako]

If you agree with the changes in 496b161, LGTM.

All good for me!

[yaira2]

LGTM

[yaira2]

@QuaintMako Does expanding/collapsing sidebar sections crash the app for you?

[gave92]

Yeah removing null checks.. always risky :)

[QuaintMako]

@yaira2 I actually don't have a crash expanding/collapsing the sidebar section... Could you open an issue with the logs?

[gave92]

Collapsing the favorite section:

2023-01-02 19:31:05.2671|ERROR|AppUnhandledException|Object reference not set to an instance of an object.
System.NullReferenceException: Object reference not set to an instance of an object.
at Files.App.UserControls.SidebarControl.Sidebar_ItemInvoked(NavigationView sender, NavigationViewItemInvokedEventArgs args)
at System.Threading.Tasks.Task.<>c.b__128_0(Object state)

[QuaintMako]

I cannot seem to reproduce it at all.
@gave92 do you think adding back the null checking could fix the issue?

[gave92]

Funny. Yeah adding back that null check fixes the issue for me.