feat: Add optional cancellation token for oauth client

zoriya · web-flow · commit 4f892d696acf · 2025-01-03T11:43:56.000-06:00
diff --git a/Octokit.Reactive/Clients/IObservableOauthClient.cs b/Octokit.Reactive/Clients/IObservableOauthClient.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Threading;
 
 namespace Octokit.Reactive
 {
@@ -22,8 +23,9 @@ public interface IObservableOauthClient
         /// an access token using this method.
         /// </remarks>
         /// <param name="request"></param>
+        /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        IObservable<OauthToken> CreateAccessToken(OauthTokenRequest request);
+        IObservable<OauthToken> CreateAccessToken(OauthTokenRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Makes a request to initiate the device flow authentication.
@@ -33,25 +35,28 @@ public interface IObservableOauthClient
         /// This request also returns a device verification code that you must use to receive an access token to check the status of user authentication.
         /// </remarks>
         /// <param name="request"></param>
+        /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        IObservable<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request);
+        IObservable<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
-        /// Makes a request to get an access token using the response from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest)"/>.
+        /// Makes a request to get an access token using the response from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest, CancellationToken)"/>.
         /// </summary>
         /// <remarks>
         /// Will poll the access token endpoint, until the device and user codes expire or the user has successfully authorized the app with a valid user code.
         /// </remarks>
         /// <param name="clientId">The client Id you received from GitHub when you registered the application.</param>
-        /// <param name="deviceFlowResponse">The response you received from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest)"/></param>
+        /// <param name="deviceFlowResponse">The response you received from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest, CancellationToken)"/></param>
+        /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        IObservable<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse);
+        IObservable<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse, CancellationToken cancellationToken = default);
 
         /// <summary>
-        /// Makes a request to get an access token using the refresh token returned in <see cref="CreateAccessToken(OauthTokenRequest)"/>.
+        /// Makes a request to get an access token using the refresh token returned in <see cref="CreateAccessToken(OauthTokenRequest, CancellationToken)"/>.
         /// </summary>
         /// <param name="request">Token renewal request.</param>
+        /// <param name="cancellationToken"></param>
         /// <returns><see cref="OauthToken"/> with the new token set.</returns>
-        IObservable<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request);
+        IObservable<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request, CancellationToken cancellationToken = default);
     }
 }
diff --git a/Octokit.Reactive/Clients/ObservableOauthClient.cs b/Octokit.Reactive/Clients/ObservableOauthClient.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Reactive.Threading.Tasks;
+using System.Threading;
 
 namespace Octokit.Reactive
 {
@@ -23,24 +24,24 @@ public Uri GetGitHubLoginUrl(OauthLoginRequest request)
             return _client.Oauth.GetGitHubLoginUrl(request);
         }
 
-        public IObservable<OauthToken> CreateAccessToken(OauthTokenRequest request)
+        public IObservable<OauthToken> CreateAccessToken(OauthTokenRequest request, CancellationToken cancellationToken = default)
         {
-            return _client.Oauth.CreateAccessToken(request).ToObservable();
+            return _client.Oauth.CreateAccessToken(request, cancellationToken).ToObservable();
         }
 
-        public IObservable<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request)
+        public IObservable<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request, CancellationToken cancellationToken = default)
         {
-            return _client.Oauth.InitiateDeviceFlow(request).ToObservable();
+            return _client.Oauth.InitiateDeviceFlow(request, cancellationToken).ToObservable();
         }
 
-        public IObservable<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse)
+        public IObservable<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse, CancellationToken cancellationToken = default)
         {
-            return _client.Oauth.CreateAccessTokenForDeviceFlow(clientId, deviceFlowResponse).ToObservable();
+            return _client.Oauth.CreateAccessTokenForDeviceFlow(clientId, deviceFlowResponse, cancellationToken).ToObservable();
         }
 
-        public IObservable<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request)
+        public IObservable<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request, CancellationToken cancellationToken = default)
         {
-            return _client.Oauth.CreateAccessTokenFromRenewalToken(request)
+            return _client.Oauth.CreateAccessTokenFromRenewalToken(request, cancellationToken)
                 .ToObservable();
         }
     }
diff --git a/Octokit/Clients/IOAuthClient.cs b/Octokit/Clients/IOAuthClient.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Octokit
@@ -26,8 +27,9 @@ public interface IOauthClient
         /// an access token using this method.
         /// </remarks>
         /// <param name="request"></param>
+        /// <param name="concellationToken"></param>
         /// <returns></returns>
-        Task<OauthToken> CreateAccessToken(OauthTokenRequest request);
+        Task<OauthToken> CreateAccessToken(OauthTokenRequest request, CancellationToken concellationToken = default);
 
         /// <summary>
         /// Makes a request to initiate the device flow authentication.
@@ -37,25 +39,28 @@ public interface IOauthClient
         /// This request also returns a device verification code that you must use to receive an access token to check the status of user authentication.
         /// </remarks>
         /// <param name="request"></param>
+        /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request);
+        Task<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
-        /// Makes a request to get an access token using the response from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest)"/>.
+        /// Makes a request to get an access token using the response from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest, CancellationToken)"/>.
         /// </summary>
         /// <remarks>
         /// Will poll the access token endpoint, until the device and user codes expire or the user has successfully authorized the app with a valid user code.
         /// </remarks>
         /// <param name="clientId">The client Id you received from GitHub when you registered the application.</param>
-        /// <param name="deviceFlowResponse">The response you received from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest)"/></param>
+        /// <param name="deviceFlowResponse">The response you received from <see cref="InitiateDeviceFlow(OauthDeviceFlowRequest, CancellationToken)"/></param>
+        /// <param name="concellationToken"></param>
         /// <returns></returns>
-        Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse);
+        Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse, CancellationToken concellationToken = default);
 
         /// <summary>
-        /// Makes a request to get an access token using the refresh token returned in <see cref="CreateAccessToken(OauthTokenRequest)"/>.
+        /// Makes a request to get an access token using the refresh token returned in <see cref="CreateAccessToken(OauthTokenRequest, CancellationToken)"/>.
         /// </summary>
         /// <param name="request">Token renewal request.</param>
+        /// <param name="concellationToken"></param>
         /// <returns><see cref="OauthToken"/> with the new token set.</returns>
-        Task<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request);
+        Task<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request, CancellationToken concellationToken = default);
     }
 }
diff --git a/Octokit/Clients/OAuthClient.cs b/Octokit/Clients/OAuthClient.cs
@@ -1,6 +1,7 @@
 ﻿using System;
 using System.Globalization;
 using System.Net.Http;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Octokit
@@ -48,33 +49,33 @@ public Uri GetGitHubLoginUrl(OauthLoginRequest request)
         }
 
         [ManualRoute("POST", "/login/oauth/access_token")]
-        public async Task<OauthToken> CreateAccessToken(OauthTokenRequest request)
+        public async Task<OauthToken> CreateAccessToken(OauthTokenRequest request, CancellationToken cancellationToken = default)
         {
             Ensure.ArgumentNotNull(request, nameof(request));
 
             var endPoint = ApiUrls.OauthAccessToken();
 
             var body = new FormUrlEncodedContent(request.ToParametersDictionary());
 
-            var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);
+            var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);
             return response.Body;
         }
 
         [ManualRoute("POST", "/login/device/code")]
-        public async Task<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request)
+        public async Task<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request, CancellationToken cancellationToken = default)
         {
             Ensure.ArgumentNotNull(request, nameof(request));
 
             var endPoint = ApiUrls.OauthDeviceCode();
 
             var body = new FormUrlEncodedContent(request.ToParametersDictionary());
 
-            var response = await connection.Post<OauthDeviceFlowResponse>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);
+            var response = await connection.Post<OauthDeviceFlowResponse>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);
             return response.Body;
         }
 
         [ManualRoute("POST", "/login/oauth/access_token")]
-        public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse)
+        public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse, CancellationToken cancellationToken = default)
         {
             Ensure.ArgumentNotNullOrEmptyString(clientId, nameof(clientId));
             Ensure.ArgumentNotNull(deviceFlowResponse, nameof(deviceFlowResponse));
@@ -85,9 +86,11 @@ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, Oa
 
             while (true)
             {
+                cancellationToken.ThrowIfCancellationRequested();
+
                 var request = new OauthTokenRequestForDeviceFlow(clientId, deviceFlowResponse.DeviceCode);
                 var body = new FormUrlEncodedContent(request.ToParametersDictionary());
-                var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);
+                var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);
 
                 if (response.Body.Error != null)
                 {
@@ -103,7 +106,7 @@ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, Oa
                             throw new ApiException(string.Format(CultureInfo.InvariantCulture, "{0}: {1}\n{2}", response.Body.Error, response.Body.ErrorDescription, response.Body.ErrorUri), null);
                     }
 
-                    await Task.Delay(TimeSpan.FromSeconds(pollingDelay));
+                    await Task.Delay(TimeSpan.FromSeconds(pollingDelay), cancellationToken);
                 }
                 else
                 {
@@ -113,14 +116,14 @@ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, Oa
         }
 
         [ManualRoute("POST", "/login/oauth/access_token")]
-        public async Task<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request)
+        public async Task<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request, CancellationToken cancellationToken = default)
         {
             Ensure.ArgumentNotNull(request, nameof(request));
 
             var endPoint = ApiUrls.OauthAccessToken();
             var body = new FormUrlEncodedContent(request.ToParametersDictionary());
 
-            var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);
+            var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);
             return response.Body;
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Reactive.Threading.Tasks;`
	`3`	`+using System.Threading;`
`3`	`4`
`4`	`5`	`namespace Octokit.Reactive`
`5`	`6`	`{`
`@@ -23,24 +24,24 @@ public Uri GetGitHubLoginUrl(OauthLoginRequest request)`
`23`	`24`	`return _client.Oauth.GetGitHubLoginUrl(request);`
`24`	`25`	`}`
`25`	`26`
`26`		`- public IObservable<OauthToken> CreateAccessToken(OauthTokenRequest request)`
	`27`	`+ public IObservable<OauthToken> CreateAccessToken(OauthTokenRequest request, CancellationToken cancellationToken = default)`
`27`	`28`	`{`
`28`		`- return _client.Oauth.CreateAccessToken(request).ToObservable();`
	`29`	`+ return _client.Oauth.CreateAccessToken(request, cancellationToken).ToObservable();`
`29`	`30`	`}`
`30`	`31`
`31`		`- public IObservable<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request)`
	`32`	`+ public IObservable<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request, CancellationToken cancellationToken = default)`
`32`	`33`	`{`
`33`		`- return _client.Oauth.InitiateDeviceFlow(request).ToObservable();`
	`34`	`+ return _client.Oauth.InitiateDeviceFlow(request, cancellationToken).ToObservable();`
`34`	`35`	`}`
`35`	`36`
`36`		`- public IObservable<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse)`
	`37`	`+ public IObservable<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse, CancellationToken cancellationToken = default)`
`37`	`38`	`{`
`38`		`- return _client.Oauth.CreateAccessTokenForDeviceFlow(clientId, deviceFlowResponse).ToObservable();`
	`39`	`+ return _client.Oauth.CreateAccessTokenForDeviceFlow(clientId, deviceFlowResponse, cancellationToken).ToObservable();`
`39`	`40`	`}`
`40`	`41`
`41`		`- public IObservable<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request)`
	`42`	`+ public IObservable<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request, CancellationToken cancellationToken = default)`
`42`	`43`	`{`
`43`		`- return _client.Oauth.CreateAccessTokenFromRenewalToken(request)`
	`44`	`+ return _client.Oauth.CreateAccessTokenFromRenewalToken(request, cancellationToken)`
`44`	`45`	`.ToObservable();`
`45`	`46`	`}`
`46`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Globalization;`
`3`	`3`	`using System.Net.Http;`
	`4`	`+using System.Threading;`
`4`	`5`	`using System.Threading.Tasks;`
`5`	`6`
`6`	`7`	`namespace Octokit`
`@@ -48,33 +49,33 @@ public Uri GetGitHubLoginUrl(OauthLoginRequest request)`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`[ManualRoute("POST", "/login/oauth/access_token")]`
`51`		`- public async Task<OauthToken> CreateAccessToken(OauthTokenRequest request)`
	`52`	`+ public async Task<OauthToken> CreateAccessToken(OauthTokenRequest request, CancellationToken cancellationToken = default)`
`52`	`53`	`{`
`53`	`54`	`Ensure.ArgumentNotNull(request, nameof(request));`
`54`	`55`
`55`	`56`	`var endPoint = ApiUrls.OauthAccessToken();`
`56`	`57`
`57`	`58`	`var body = new FormUrlEncodedContent(request.ToParametersDictionary());`
`58`	`59`
`59`		`- var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);`
	`60`	`+ var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);`
`60`	`61`	`return response.Body;`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`[ManualRoute("POST", "/login/device/code")]`
`64`		`- public async Task<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request)`
	`65`	`+ public async Task<OauthDeviceFlowResponse> InitiateDeviceFlow(OauthDeviceFlowRequest request, CancellationToken cancellationToken = default)`
`65`	`66`	`{`
`66`	`67`	`Ensure.ArgumentNotNull(request, nameof(request));`
`67`	`68`
`68`	`69`	`var endPoint = ApiUrls.OauthDeviceCode();`
`69`	`70`
`70`	`71`	`var body = new FormUrlEncodedContent(request.ToParametersDictionary());`
`71`	`72`
`72`		`- var response = await connection.Post<OauthDeviceFlowResponse>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);`
	`73`	`+ var response = await connection.Post<OauthDeviceFlowResponse>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);`
`73`	`74`	`return response.Body;`
`74`	`75`	`}`
`75`	`76`
`76`	`77`	`[ManualRoute("POST", "/login/oauth/access_token")]`
`77`		`- public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse)`
	`78`	`+ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, OauthDeviceFlowResponse deviceFlowResponse, CancellationToken cancellationToken = default)`
`78`	`79`	`{`
`79`	`80`	`Ensure.ArgumentNotNullOrEmptyString(clientId, nameof(clientId));`
`80`	`81`	`Ensure.ArgumentNotNull(deviceFlowResponse, nameof(deviceFlowResponse));`
`@@ -85,9 +86,11 @@ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, Oa`
`85`	`86`
`86`	`87`	`while (true)`
`87`	`88`	`{`
	`89`	`+ cancellationToken.ThrowIfCancellationRequested();`
	`90`	`+`
`88`	`91`	`var request = new OauthTokenRequestForDeviceFlow(clientId, deviceFlowResponse.DeviceCode);`
`89`	`92`	`var body = new FormUrlEncodedContent(request.ToParametersDictionary());`
`90`		`- var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);`
	`93`	`+ var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);`
`91`	`94`
`92`	`95`	`if (response.Body.Error != null)`
`93`	`96`	`{`
`@@ -103,7 +106,7 @@ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, Oa`
`103`	`106`	`throw new ApiException(string.Format(CultureInfo.InvariantCulture, "{0}: {1}\n{2}", response.Body.Error, response.Body.ErrorDescription, response.Body.ErrorUri), null);`
`104`	`107`	`}`
`105`	`108`
`106`		`- await Task.Delay(TimeSpan.FromSeconds(pollingDelay));`
	`109`	`+ await Task.Delay(TimeSpan.FromSeconds(pollingDelay), cancellationToken);`
`107`	`110`	`}`
`108`	`111`	`else`
`109`	`112`	`{`
`@@ -113,14 +116,14 @@ public async Task<OauthToken> CreateAccessTokenForDeviceFlow(string clientId, Oa`
`113`	`116`	`}`
`114`	`117`
`115`	`118`	`[ManualRoute("POST", "/login/oauth/access_token")]`
`116`		`- public async Task<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request)`
	`119`	`+ public async Task<OauthToken> CreateAccessTokenFromRenewalToken(OauthTokenRenewalRequest request, CancellationToken cancellationToken = default)`
`117`	`120`	`{`
`118`	`121`	`Ensure.ArgumentNotNull(request, nameof(request));`
`119`	`122`
`120`	`123`	`var endPoint = ApiUrls.OauthAccessToken();`
`121`	`124`	`var body = new FormUrlEncodedContent(request.ToParametersDictionary());`
`122`	`125`
`123`		`- var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress).ConfigureAwait(false);`
	`126`	`+ var response = await connection.Post<OauthToken>(endPoint, body, "application/json", null, hostAddress, cancellationToken).ConfigureAwait(false);`
`124`	`127`	`return response.Body;`
`125`	`128`	`}`
`126`	`129`	`}`