Replace pragma warning with [DangerousMethodUsage.Audited(...)]

Brightspace · Jul 21, 2023 · a5654cb · a5654cb
1 parent 95dff15
commit a5654cb
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/src/D2L.Security.OAuth2/Utilities/D2LHttpClient.cs b/src/D2L.Security.OAuth2/Utilities/D2LHttpClient.cs
@@ -2,6 +2,7 @@
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
+using D2L.CodeStyle.Annotations;
 
 namespace D2L.Security.OAuth2.Utilities {
 	/// <summary>
@@ -42,69 +43,79 @@ public Task<HttpResponseMessage> SendAsync( HttpRequestMessage request, HttpComp
 		public Task<HttpResponseMessage> SendAsync( HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken )
 			=> m_httpClient.SendAsync( request, completionOption, cancellationToken );
 
-#pragma warning disable D2L0018 // Avoid using dangerous methods
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( string requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri, completionOption, cancellationToken ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( Uri requestUri, CancellationToken cancellationToken ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri, cancellationToken ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( Uri requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri, completionOption, cancellationToken ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( Uri requestUri, HttpCompletionOption completionOption ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri, completionOption ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( string requestUri, HttpCompletionOption completionOption ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri, completionOption ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( Uri requestUri ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( string requestUri ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Get( string requestUri, CancellationToken cancellationToken ) {
 			var task = Task.Run( () => m_httpClient.GetAsync( requestUri, cancellationToken ) );
 			task.Wait();
 			return task.Result;
 		}
 
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Send( HttpRequestMessage request ) {
 			var task = Task.Run( () => m_httpClient.SendAsync( request ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Send( HttpRequestMessage request, CancellationToken cancellationToken ) {
 			var task = Task.Run( () => m_httpClient.SendAsync( request, cancellationToken ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Send( HttpRequestMessage request, HttpCompletionOption completionOption ) {
 			var task = Task.Run( () => m_httpClient.SendAsync( request, completionOption ) );
 			task.Wait();
 			return task.Result;
 		}
+		[DangerousMethodUsage.Audited( typeof( Task ), "Run", "Ana DuCristea", "2023-07-23", "Temporary sync implementation of HttpClient for generated sync methods to be replaced later" )]
 		public HttpResponseMessage Send( HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken ) {
 			var task = Task.Run( () => m_httpClient.SendAsync( request, completionOption, cancellationToken ) );
 			task.Wait();
 			return task.Result;
 		}
-#pragma warning restore D2L0018 // Avoid using dangerous methods
 
 		public void Dispose() { m_httpClient.Dispose(); }
 	}

diff --git a/src/D2L.Security.OAuth2/Utilities/ID2LHttpClient.cs b/src/D2L.Security.OAuth2/Utilities/ID2LHttpClient.cs
@@ -28,19 +28,13 @@ internal interface ID2LHttpClient : IDisposable {
 		public HttpResponseMessage Get( string requestUri, CancellationToken cancellationToken );
 
 		public Task<HttpResponseMessage> SendAsync( HttpRequestMessage request );
-
 		public Task<HttpResponseMessage> SendAsync( HttpRequestMessage request, CancellationToken cancellationToken );
-
 		public Task<HttpResponseMessage> SendAsync( HttpRequestMessage request, HttpCompletionOption completionOption );
-
 		public Task<HttpResponseMessage> SendAsync( HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken );
 
 		public HttpResponseMessage Send( HttpRequestMessage request );
-
 		public HttpResponseMessage Send( HttpRequestMessage request, CancellationToken cancellationToken );
-
 		public HttpResponseMessage Send( HttpRequestMessage request, HttpCompletionOption completionOption );
-
 		public HttpResponseMessage Send( HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken );
 	}
 }