Update to .NET Core 3.1 and apply all necessary changes to IAsyncEnumerable implementations that comes with this update. (#239)

HoundThe · web-flow · commit b87b2486d5ae · 2021-02-10T22:01:15.000-06:00
diff --git a/RedditSharp.sln b/RedditSharp.sln
@@ -15,8 +15,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RedditSharpTests", "RedditS
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnitTesting", "UnitTesting\UnitTesting.csproj", "{D164656E-D0E6-41A0-ADEA-37C55E34531B}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnitTesting_old", "UnitTesting_old\UnitTesting_old.csproj", "{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}"
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -63,18 +61,6 @@ Global
 		{D164656E-D0E6-41A0-ADEA-37C55E34531B}.Release|Mixed Platforms.Build.0 = Release|Any CPU
 		{D164656E-D0E6-41A0-ADEA-37C55E34531B}.Release|x86.ActiveCfg = Release|Any CPU
 		{D164656E-D0E6-41A0-ADEA-37C55E34531B}.Release|x86.Build.0 = Release|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Debug|x86.Build.0 = Debug|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Release|Any CPU.Build.0 = Release|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Release|Mixed Platforms.Build.0 = Release|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Release|x86.ActiveCfg = Release|Any CPU
-		{A4640FC9-F8A5-4B11-A9FE-8FEB626B2080}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/RedditSharp/CommentsEnumerable.cs b/RedditSharp/CommentsEnumerable.cs
@@ -34,7 +34,7 @@ public CommentsEnumarable(IWebAgent agent, Post post, int limitPerRequest = 0)
         /// Returns <see cref="IAsyncEnumerator{T}"/> for the comments on the <see cref="Post"/>> 
         /// </summary>
         /// <returns></returns>
-        public IAsyncEnumerator<Comment> GetEnumerator()
+        public IAsyncEnumerator<Comment> GetAsyncEnumerator(CancellationToken cancellationToken = default)
         {
             return new CommentsEnumerator(agent, post, limit);
         }
@@ -67,7 +67,7 @@ public Comment Current
                 }
             }
 
-            public async Task<bool> MoveNext(CancellationToken cancellationToken)
+            public async ValueTask<bool> MoveNextAsync()
             {
 
                 if (currentIndex == -1)
@@ -139,9 +139,9 @@ private async Task GetBaseComments()
                 currentBranch = retrieved;
             }
 
-            public void Dispose()
+            public ValueTask DisposeAsync()
             {
-                
+                return new ValueTask();
             }
         }
     }
diff --git a/RedditSharp/Listing.cs b/RedditSharp/Listing.cs
@@ -173,7 +173,7 @@ public IAsyncEnumerator<T> GetEnumerator(int limitPerRequest, int maximumLimit =
         }
 
         /// <inheritdoc/>
-        public IAsyncEnumerator<T> GetEnumerator()
+        public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken cancellationToken = default)
         {
             return GetEnumerator(LimitPerRequest, MaximumLimit, IsStream);
         }
@@ -365,26 +365,25 @@ private void Parse(JToken json)
                 Before = json["data"]["before"].Value<string>();
             }
 
-            public void Dispose()
+            public ValueTask DisposeAsync()
             {
-                // ...
+                return default;
             }
 
-            public async Task<bool> MoveNext(CancellationToken cancellationToken)
+            public async ValueTask<bool> MoveNextAsync()
             {
                 if (stream)
                 {
-                    return await MoveNextForwardAsync(cancellationToken).ConfigureAwait(false);
+                    return await MoveNextForwardAsync().ConfigureAwait(false);
                 }
                 else
                 {
-                    return await MoveNextBackAsync(cancellationToken).ConfigureAwait(false);
+                    return await MoveNextBackAsync().ConfigureAwait(false);
                 }
             }
 
-            private async Task<bool> MoveNextBackAsync(CancellationToken cancellationToken)
+            private async Task<bool> MoveNextBackAsync()
             {
-                cancellationToken.ThrowIfCancellationRequested();
                 if (CurrentIndex == -1)
                 {
                     //first call, get a page and set CurrentIndex
@@ -421,7 +420,7 @@ private async Task<bool> MoveNextBackAsync(CancellationToken cancellationToken)
                 return true;
             }
 
-            private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToken)
+            private async Task<bool> MoveNextForwardAsync()
             {
                 CurrentIndex++;
 
@@ -435,7 +434,6 @@ private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToke
                     int tries = 0;
                     while (true)
                     {
-                        cancellationToken.ThrowIfCancellationRequested();
                         tries++;
 
                         try
@@ -446,7 +444,7 @@ private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToke
                         catch (Exception ex)
                         {
                             // sleep for a while to see if we can recover
-                            await Sleep(tries, cancellationToken, ex).ConfigureAwait(false);
+                            await Sleep(tries, ex).ConfigureAwait(false);
                         }
 
                         // the page is only populated if there are *new* items to yielded from the listing.
@@ -456,14 +454,14 @@ private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToke
                         }
 
                         // No listings were returned in the page.
-                        await Sleep(tries, cancellationToken).ConfigureAwait(false);
+                        await Sleep(tries).ConfigureAwait(false);
                     }
                 }
                 Count++;
                 return true;
             }
 
-            private async Task Sleep(int tries, CancellationToken cancellationToken, Exception ex = null)
+            private async Task Sleep(int tries, Exception ex = null)
             {
                 // wait up to 3 minutes between tries
                 // TODO: Make this configurable
@@ -481,7 +479,7 @@ private async Task Sleep(int tries, CancellationToken cancellationToken, Excepti
                 {
                     seconds = tries * 5;
                 }
-                await Task.Delay(seconds * 1000, cancellationToken).ConfigureAwait(false);
+                await Task.Delay(seconds * 1000).ConfigureAwait(false);
             }
         }
 #pragma warning restore
diff --git a/RedditSharp/RedditSharp.csproj b/RedditSharp/RedditSharp.csproj
@@ -3,8 +3,7 @@
   <PropertyGroup>
     <AssemblyTitle>RedditSharp</AssemblyTitle>
     <VersionPrefix>2.0.0</VersionPrefix>
-    <TargetFrameworks Condition="'$(LibraryFrameworks)'==''">net462;netstandard1.3;netstandard2.0;</TargetFrameworks>
-    <TargetFrameworks Condition="'$(LibraryFrameworks)'!=''">$(LibraryFrameworks)</TargetFrameworks>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
     <AssemblyName>RedditSharp</AssemblyName>
     <PackageId>RedditSharp</PackageId>
     <PackageProjectUrl>https://github.com/CrustyJew/RedditSharp</PackageProjectUrl>
@@ -21,7 +20,7 @@
     <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
     <PackageReference Include="System.Threading.Thread" Version="4.3.0" />
     <PackageReference Include="System.Reactive.Linq" Version="3.1.1" />
-    <PackageReference Include="System.Interactive.Async" Version="3.1.1" />
+    <PackageReference Include="System.Interactive.Async" Version="4.1.1" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net462' ">
diff --git a/RedditSharp/Things/PrivateMessage.cs b/RedditSharp/Things/PrivateMessage.cs
@@ -131,8 +131,8 @@ public PrivateMessage GetParent()
                     return null;
             }
             //TODO: Convert this into an async function
-            var firstPage = thread.First();
-            firstPage.Wait();
+            var firstPage = thread.FirstAsync();
+            firstPage.GetAwaiter();
             var firstMessage = firstPage.Result;
             if (firstMessage?.FullName == ParentID)
                 return firstMessage;
diff --git a/RedditSharpTests/RedditSharpTests.csproj b/RedditSharpTests/RedditSharpTests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp2.2</TargetFramework>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
     <AssemblyName>RedditSharpTests</AssemblyName>
     <PackageId>RedditSharpTests</PackageId>
     <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
diff --git a/RedditSharpTests/Things/SubredditTests.cs b/RedditSharpTests/Things/SubredditTests.cs
@@ -20,7 +20,7 @@ public async Task GetContributors()
             RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
             RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent);
             var sub = await reddit.GetSubredditAsync(authFixture.Config["TestSubreddit"]);
-            var contribs = await sub.GetContributors().ToList();
+            var contribs = await sub.GetContributors().ToListAsync();
 
             Assert.NotEmpty(contribs);
             Assert.Contains<string>(authFixture.TestUserName.ToLower(), contribs.Select(c => c.Name.ToLower()));
@@ -56,8 +56,8 @@ public async Task GetRALLComments()
             RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
             RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent, true);
 
-            var comments = reddit.RSlashAll.GetComments(5);
-            Assert.Equal(5, await comments.Count());
+            var comments = await reddit.RSlashAll.GetComments().Take(5).CountAsync();
+            Assert.Equal(5, comments);
         }
 
         [Fact]
@@ -66,7 +66,7 @@ public async Task PageComments()
             RedditSharp.WebAgent agent = new RedditSharp.WebAgent(authFixture.AccessToken);
             RedditSharp.Reddit reddit = new RedditSharp.Reddit(agent, true);
 
-            var comments = await reddit.RSlashAll.GetComments().Take(55).ToList();
+            var comments = await reddit.RSlashAll.GetComments().Take(55).ToListAsync();
 
             Assert.Equal(55, comments.Count);
 
@@ -80,7 +80,7 @@ public async Task StreamComments()
 
             var count = 0;
             var comments = reddit.RSlashAll.GetComments().GetEnumerator(50, 100, true);
-            while (await comments.MoveNext(CancellationToken.None))
+            while (await comments.MoveNextAsync())
             {
                 count++;
             }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public CommentsEnumarable(IWebAgent agent, Post post, int limitPerRequest = 0)`
`34`	`34`	`/// Returns <see cref="IAsyncEnumerator{T}"/> for the comments on the <see cref="Post"/>>`
`35`	`35`	`/// </summary>`
`36`	`36`	`/// <returns></returns>`
`37`		`- public IAsyncEnumerator<Comment> GetEnumerator()`
	`37`	`+ public IAsyncEnumerator<Comment> GetAsyncEnumerator(CancellationToken cancellationToken = default)`
`38`	`38`	`{`
`39`	`39`	`return new CommentsEnumerator(agent, post, limit);`
`40`	`40`	`}`
`@@ -67,7 +67,7 @@ public Comment Current`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`70`		`- public async Task<bool> MoveNext(CancellationToken cancellationToken)`
	`70`	`+ public async ValueTask<bool> MoveNextAsync()`
`71`	`71`	`{`
`72`	`72`
`73`	`73`	`if (currentIndex == -1)`
`@@ -139,9 +139,9 @@ private async Task GetBaseComments()`
`139`	`139`	`currentBranch = retrieved;`
`140`	`140`	`}`
`141`	`141`
`142`		`- public void Dispose()`
	`142`	`+ public ValueTask DisposeAsync()`
`143`	`143`	`{`
`144`		`-`
	`144`	`+ return new ValueTask();`
`145`	`145`	`}`
`146`	`146`	`}`
`147`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ public IAsyncEnumerator<T> GetEnumerator(int limitPerRequest, int maximumLimit =`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`/// <inheritdoc/>`
`176`		`- public IAsyncEnumerator<T> GetEnumerator()`
	`176`	`+ public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken cancellationToken = default)`
`177`	`177`	`{`
`178`	`178`	`return GetEnumerator(LimitPerRequest, MaximumLimit, IsStream);`
`179`	`179`	`}`
`@@ -365,26 +365,25 @@ private void Parse(JToken json)`
`365`	`365`	`Before = json["data"]["before"].Value<string>();`
`366`	`366`	`}`
`367`	`367`
`368`		`- public void Dispose()`
	`368`	`+ public ValueTask DisposeAsync()`
`369`	`369`	`{`
`370`		`- // ...`
	`370`	`+ return default;`
`371`	`371`	`}`
`372`	`372`
`373`		`- public async Task<bool> MoveNext(CancellationToken cancellationToken)`
	`373`	`+ public async ValueTask<bool> MoveNextAsync()`
`374`	`374`	`{`
`375`	`375`	`if (stream)`
`376`	`376`	`{`
`377`		`- return await MoveNextForwardAsync(cancellationToken).ConfigureAwait(false);`
	`377`	`+ return await MoveNextForwardAsync().ConfigureAwait(false);`
`378`	`378`	`}`
`379`	`379`	`else`
`380`	`380`	`{`
`381`		`- return await MoveNextBackAsync(cancellationToken).ConfigureAwait(false);`
	`381`	`+ return await MoveNextBackAsync().ConfigureAwait(false);`
`382`	`382`	`}`
`383`	`383`	`}`
`384`	`384`
`385`		`- private async Task<bool> MoveNextBackAsync(CancellationToken cancellationToken)`
	`385`	`+ private async Task<bool> MoveNextBackAsync()`
`386`	`386`	`{`
`387`		`- cancellationToken.ThrowIfCancellationRequested();`
`388`	`387`	`if (CurrentIndex == -1)`
`389`	`388`	`{`
`390`	`389`	`//first call, get a page and set CurrentIndex`
`@@ -421,7 +420,7 @@ private async Task<bool> MoveNextBackAsync(CancellationToken cancellationToken)`
`421`	`420`	`return true;`
`422`	`421`	`}`
`423`	`422`
`424`		`- private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToken)`
	`423`	`+ private async Task<bool> MoveNextForwardAsync()`
`425`	`424`	`{`
`426`	`425`	`CurrentIndex++;`
`427`	`426`
`@@ -435,7 +434,6 @@ private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToke`
`435`	`434`	`int tries = 0;`
`436`	`435`	`while (true)`
`437`	`436`	`{`
`438`		`- cancellationToken.ThrowIfCancellationRequested();`
`439`	`437`	`tries++;`
`440`	`438`
`441`	`439`	`try`
`@@ -446,7 +444,7 @@ private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToke`
`446`	`444`	`catch (Exception ex)`
`447`	`445`	`{`
`448`	`446`	`// sleep for a while to see if we can recover`
`449`		`- await Sleep(tries, cancellationToken, ex).ConfigureAwait(false);`
	`447`	`+ await Sleep(tries, ex).ConfigureAwait(false);`
`450`	`448`	`}`
`451`	`449`
`452`	`450`	`// the page is only populated if there are new items to yielded from the listing.`
`@@ -456,14 +454,14 @@ private async Task<bool> MoveNextForwardAsync(CancellationToken cancellationToke`
`456`	`454`	`}`
`457`	`455`
`458`	`456`	`// No listings were returned in the page.`
`459`		`- await Sleep(tries, cancellationToken).ConfigureAwait(false);`
	`457`	`+ await Sleep(tries).ConfigureAwait(false);`
`460`	`458`	`}`
`461`	`459`	`}`
`462`	`460`	`Count++;`
`463`	`461`	`return true;`
`464`	`462`	`}`
`465`	`463`
`466`		`- private async Task Sleep(int tries, CancellationToken cancellationToken, Exception ex = null)`
	`464`	`+ private async Task Sleep(int tries, Exception ex = null)`
`467`	`465`	`{`
`468`	`466`	`// wait up to 3 minutes between tries`
`469`	`467`	`// TODO: Make this configurable`
`@@ -481,7 +479,7 @@ private async Task Sleep(int tries, CancellationToken cancellationToken, Excepti`
`481`	`479`	`{`
`482`	`480`	`seconds = tries * 5;`
`483`	`481`	`}`
`484`		`- await Task.Delay(seconds * 1000, cancellationToken).ConfigureAwait(false);`
	`482`	`+ await Task.Delay(seconds * 1000).ConfigureAwait(false);`
`485`	`483`	`}`
`486`	`484`	`}`
`487`	`485`	`#pragma warning restore`