Update dependencies and refactor for asynchronous code (#46)

* Update dependencies and refactor for asynchronous code

This commit updates the target .NET frameworks of the build and tests to .NET 8.0, and also updates various packages to newer versions. In addition, the existing synchronous code has been refactored to asynchronous, utilizing 'async' and 'await' key words to improve code performance and readability. 'TreatWarningsAsErrors' has been enabled for better code quality control.

* Refactor assertion statements in test files

This commit refactors the assertion statements in multiple test classes to improve clarity and readability. The adjustments involve replacing certain "Assert.True" statements with more straightforward assertions, like "Assert.NotNull" and "Assert.False", as well as revising the checking method of object counts for more precise verification.

* Refactor test assertion in NotesServiceTests

Changed the assertion method used in the test of NotesServiceTests. Rather than comparing the Notes count to zero, the refactored code now uses Assert.Empty to check if the Notes collection is empty, improving readability and conciseness of the code.

* Update dotnet-sonarscanner version

The dotnet-sonarscanner version has been updated from 5.13.1 to 6.1.0 in the _build.csproj file. This update aims to leverage new features and improvements added in the newer version of the scanner.

* Update SonarQube login method

Updated the login strategy from .SetLogin to .SetToken in Build.cs. This change reflects the recent requirement in SonarQube API that advises usage of tokens over login password for security reasons.

Author: olsh

Todoist.Net.sln.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Todoist/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

build/Build.cs

@@ -84,7 +84,7 @@ class Build : NukeBuild
                 s = s
                     .SetServer("https://sonarcloud.io")
                     .SetFramework("net5.0")
-                    .SetLogin(SonarQubeApiKey)
+                    .SetToken(SonarQubeApiKey)
                     .SetProjectKey("todoist-net")
                     .SetName("Todoist.Net")
                     .SetOrganization("olsh")

build/_build.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <RootNamespace></RootNamespace>
     <NoWarn>CS0649;CS0169;CA1050;CA1822;CA2211;IDE1006</NoWarn>
     <NukeRootDirectory>..</NukeRootDirectory>
@@ -12,8 +12,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Nuke.Common" Version="7.0.4" />
-    <PackageDownload Include="dotnet-sonarscanner" Version="[5.13.1]" />
+    <PackageReference Include="Nuke.Common" Version="8.0.0" />
+    <PackageDownload Include="dotnet-sonarscanner" Version="[6.1.0]" />
   </ItemGroup>
 
 </Project>

src/Todoist.Net.Tests/Services/ActivityServiceTests.cs

@@ -1,3 +1,5 @@
+using System.Threading.Tasks;
+
 using Todoist.Net.Models;
 using Todoist.Net.Tests.Extensions;
 
@@ -18,26 +20,28 @@ public ActivityServiceTests(ITestOutputHelper outputHelper)
         }
 
         [Fact]
-        public void GetActivity_HasEntries()
+        public async Task TestActivityLogIsNotEmpty()
         {
             var client = TodoistClientFactory.Create(_outputHelper);
 
-            var logEntries = client.Activity.GetAsync(new LogFilter { Limit = 50 }).Result.Events;
+            const int LogEntriesLimit = 50;
+            var logFilter = new LogFilter { Limit = LogEntriesLimit };
+            var logEntries = await client.Activity.GetAsync(logFilter);
 
-            Assert.NotEmpty(logEntries);
+            Assert.NotEmpty(logEntries.Events);
         }
 
         [Fact]
-        public void GetActivityWithEventObjectFilter_HasEntries()
+        public async Task GetActivityWithEventObjectFilter_HasEntries()
         {
             var client = TodoistClientFactory.Create(_outputHelper);
 
             var logFilter = new LogFilter();
-            logFilter.ObjectEventTypes.Add(new ObjectEventTypes() { ObjectType = "project" });
+            logFilter.ObjectEventTypes.Add(new ObjectEventTypes { ObjectType = "project" });
 
-            var logEntries = client.Activity.GetAsync(logFilter).Result.Events;
+            var logEntries = await client.Activity.GetAsync(logFilter);
 
-            Assert.NotEmpty(logEntries);
+            Assert.NotEmpty(logEntries.Events);
         }
     }
 }

src/Todoist.Net.Tests/Services/BackupServiceTests.cs

@@ -1,4 +1,6 @@
 using System.Linq;
+using System.Threading.Tasks;
+
 using Todoist.Net.Tests.Extensions;
 
 using Xunit;
@@ -18,11 +20,11 @@ public BackupServiceTests(ITestOutputHelper outputHelper)
         }
 
         [Fact]
-        public void GetBackups_Success()
+        public async Task GetBackups_Success()
         {
             var client = TodoistClientFactory.Create(_outputHelper);
 
-            var backups = client.Backups.GetAsync().Result;
+            var backups = await client.Backups.GetAsync();
 
             Assert.True(backups.Any());
         }

src/Todoist.Net.Tests/Services/EmailServiceTests.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Threading.Tasks;
 
 using Todoist.Net.Models;
 using Todoist.Net.Tests.Extensions;
@@ -20,18 +21,20 @@ public EmailServiceTests(ITestOutputHelper outputHelper)
 
         [Fact]
         [Trait(Constants.TraitName, Constants.IntegrationPremiumTraitValue)]
-        public void GetOrCreateAsyncDisable_NewProject_Success()
+        public async Task GetOrCreateAsyncDisable_NewProject_Success()
         {
             var client = TodoistClientFactory.Create(_outputHelper);
 
-            var projectId = client.Projects.AddAsync(new Project(Guid.NewGuid().ToString())).Result;
-            var emailInfo = client.Emails.GetOrCreateAsync(ObjectType.Project, projectId).Result;
+            var project = new Project(Guid.NewGuid().ToString());
+            var projectId = await client.Projects.AddAsync(project);
+
+            var emailInfo = await client.Emails.GetOrCreateAsync(ObjectType.Project, projectId);
 
             Assert.NotNull(emailInfo);
             Assert.NotNull(emailInfo.Email);
 
-            client.Emails.DisableAsync(ObjectType.Project, projectId).Wait();
-            client.Projects.DeleteAsync(projectId).Wait();
+            await client.Emails.DisableAsync(ObjectType.Project, projectId);
+            await client.Projects.DeleteAsync(projectId);
         }
     }
 }

src/Todoist.Net.Tests/Services/FiltersServiceTests.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using System.Threading.Tasks;
 
 using Todoist.Net.Models;
 using Todoist.Net.Tests.Extensions;
@@ -21,42 +22,41 @@ public FiltersServiceTests(ITestOutputHelper outputHelper)
         }
 
         [Fact]
-        public void GetFilterInfo_Success()
+        public async Task GetFilterInfo_Success()
         {
             var client = TodoistClientFactory.Create(_outputHelper);
 
-            var filters = client.Filters.GetAsync().Result.ToList();
+            var filters = (await client.Filters.GetAsync()).ToList();
 
-            Assert.True(filters.Any());
+            Assert.True(filters.Count > 0);
 
-            var result = client.Filters.GetAsync(filters.First().Id).Result;
+            var result = await client.Filters.GetAsync(filters.First().Id);
 
-            Assert.True(result != null);
+            Assert.NotNull(result);
         }
 
         [Fact]
-        public void CreateUpdateDelete_Success()
+        public async Task CreateUpdateDelete_Success()
         {
             var client = TodoistClientFactory.Create(_outputHelper);
 
             var filter = new Filter(Guid.NewGuid().ToString(), "today");
-            client.Filters.AddAsync(filter).Wait();
+            await client.Filters.AddAsync(filter);
 
-            var filters = client.Filters.GetAsync().Result;
+            var filters = await client.Filters.GetAsync();
 
             Assert.Contains(filters, f => f.Name == filter.Name);
 
             filter.Query = "test";
-            client.Filters.UpdateAsync(filter)
-                .Wait();
+            await client.Filters.UpdateAsync(filter);
             var filterOrder = 2;
-            client.Filters.UpdateOrderAsync(new OrderEntry(filter.Id, filterOrder)).Wait();
+            await client.Filters.UpdateOrderAsync(new OrderEntry(filter.Id, filterOrder));
 
-            var filterInfo = client.Filters.GetAsync(filter.Id).Result;
+            var filterInfo = await client.Filters.GetAsync(filter.Id);
             Assert.Equal(filter.Query, filterInfo.Filter.Query);
             Assert.Equal(filterOrder, filterInfo.Filter.ItemOrder);
 
-            client.Filters.DeleteAsync(filter.Id).Wait();
+            await client.Filters.DeleteAsync(filter.Id);
         }
     }
 }