fix: Enabling AsyncUsageAnalyzers and fixing violations (#243)

hiranya911 · web-flow · commit b6c335953aa4 · 2020-08-31T10:52:11.000-07:00
* fix: Enabling AsyncUsageAnalyzers and fixing violations

* fix: Removed experimental changes
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/AbstractFirebaseAuth.cs b/FirebaseAdmin/FirebaseAdmin/Auth/AbstractFirebaseAuth.cs
@@ -313,7 +313,8 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(
                 .ConfigureAwait(false);
             if (checkRevoked)
             {
-                var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken);
+                var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken)
+                    .ConfigureAwait(false);
                 if (revoked)
                 {
                     throw new FirebaseAuthException(
@@ -701,7 +702,8 @@ public async Task<DeleteUsersResult> DeleteUsersAsync(IReadOnlyList<string> uids
         public async Task<UserImportResult> ImportUsersAsync(
           IEnumerable<ImportUserRecordArgs> users)
         {
-          return await this.ImportUsersAsync(users, default(CancellationToken)).ConfigureAwait(false);
+            return await this.ImportUsersAsync(users, default(CancellationToken))
+                .ConfigureAwait(false);
         }
 
         /// <summary>
@@ -726,7 +728,8 @@ public async Task<UserImportResult> ImportUsersAsync(
           IEnumerable<ImportUserRecordArgs> users,
           CancellationToken cancellationToken)
         {
-          return await this.ImportUsersAsync(users, null, cancellationToken).ConfigureAwait(false);
+            return await this.ImportUsersAsync(users, null, cancellationToken)
+                .ConfigureAwait(false);
         }
 
         /// <summary>
@@ -746,7 +749,8 @@ public async Task<UserImportResult> ImportUsersAsync(
             IEnumerable<ImportUserRecordArgs> users,
             UserImportOptions options)
         {
-          return await this.ImportUsersAsync(users, options, default(CancellationToken)).ConfigureAwait(false);
+            return await this.ImportUsersAsync(users, options, default(CancellationToken))
+                .ConfigureAwait(false);
         }
 
         /// <summary>
@@ -769,8 +773,9 @@ public async Task<UserImportResult> ImportUsersAsync(
             UserImportOptions options,
             CancellationToken cancellationToken)
         {
-          var request = new UserImportRequest(users, options);
-          return await this.UserManager.ImportUsersAsync(request, cancellationToken);
+            var request = new UserImportRequest(users, options);
+            return await this.UserManager.ImportUsersAsync(request, cancellationToken)
+                .ConfigureAwait(false);
         }
 
         /// <summary>
@@ -1227,7 +1232,7 @@ private protected TResult IfNotDeleted<TResult>(Func<TResult> func)
         private protected async Task<bool> IsRevokedAsync(
             FirebaseToken token, CancellationToken cancellationToken)
         {
-            var user = await this.GetUserAsync(token.Uid, cancellationToken);
+            var user = await this.GetUserAsync(token.Uid, cancellationToken).ConfigureAwait(false);
             var cutoff = user.TokensValidAfterTimestamp.Subtract(UserRecord.UnixEpoch)
                 .TotalSeconds;
             return token.IssuedAtTimeSeconds < cutoff;
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs b/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs
@@ -208,7 +208,8 @@ public async Task<FirebaseToken> VerifySessionCookieAsync(
                 .ConfigureAwait(false);
             if (checkRevoked)
             {
-                var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken);
+                var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken)
+                    .ConfigureAwait(false);
                 if (revoked)
                 {
                     throw new FirebaseAuthException(
diff --git a/FirebaseAdmin/FirebaseAdmin/FirebaseAdmin.csproj b/FirebaseAdmin/FirebaseAdmin/FirebaseAdmin.csproj
@@ -32,6 +32,9 @@
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.1-beta.61">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003">
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
     <AdditionalFiles Include="../../stylecop.json" />
   </ItemGroup>
 
diff --git a/FirebaseAdmin/FirebaseAdmin/HttpErrorHandler.cs b/FirebaseAdmin/FirebaseAdmin/HttpErrorHandler.cs
@@ -92,4 +92,4 @@ internal class FirebaseExceptionArgs
             internal string ResponseBody { get; set; }
         }
     }
-}
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/Action.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/Action.cs
@@ -51,4 +51,4 @@ internal Action(Action action)
         [JsonProperty("icon")]
         public string Icon { get; set; }
     }
-}
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/Direction.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/Direction.cs
@@ -34,4 +34,4 @@ public enum Direction
         /// </summary>
         RightToLeft,
     }
-}
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/FirebaseMessagingClient.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/FirebaseMessagingClient.cs
@@ -201,12 +201,15 @@ private async Task<BatchResponse> SendBatchRequestAsync(
             var batch = this.CreateBatchRequest(
                 messages,
                 dryRun,
-                async (content, error, index, message) =>
+                (content, error, index, message) =>
                 {
                     SendResponse sendResponse;
                     if (error != null)
                     {
-                        sendResponse = SendResponse.FromException(await this.CreateException(message).ConfigureAwait(false));
+                        var json = (error as ContentRetainingRequestError).Content;
+                        var exception = MessagingErrorHandler.Instance.HandleHttpErrorResponse(
+                            message, json);
+                        sendResponse = SendResponse.FromException(exception);
                     }
                     else if (content != null)
                     {
@@ -247,13 +250,6 @@ private BatchRequest CreateBatchRequest(
             return batch;
         }
 
-        private async Task<FirebaseMessagingException> CreateException(HttpResponseMessage response)
-        {
-            var json = await response.Content.ReadAsStringAsync()
-                .ConfigureAwait(false);
-            return MessagingErrorHandler.Instance.HandleHttpErrorResponse(response, json);
-        }
-
         /// <summary>
         /// Represents the envelope message accepted by the FCM backend service, including the message
         /// payload and other options like <c>validate_only</c>.
@@ -300,6 +296,30 @@ public FCMClientService(Initializer initializer)
             public override string BasePath => null;
 
             public override IList<string> Features => null;
+
+            public override async Task<RequestError> DeserializeError(HttpResponseMessage response)
+            {
+                var error = await base.DeserializeError(response).ConfigureAwait(false);
+
+                // Read the full response text here and add it to the RequestError so it can be
+                // used in the batch request callback.
+                // See https://github.com/googleapis/google-api-dotnet-client/issues/1632.
+                var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+                return new ContentRetainingRequestError(error, content);
+            }
+        }
+
+        private sealed class ContentRetainingRequestError : RequestError
+        {
+            internal ContentRetainingRequestError(RequestError error, string content)
+            {
+                this.Code = error.Code;
+                this.Message = error.Message;
+                this.Errors = error.Errors;
+                this.Content = content;
+            }
+
+            internal string Content { get; }
         }
 
         private sealed class FCMClientServiceRequest : ClientServiceRequest<string>
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/Priority.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/Priority.cs
@@ -29,4 +29,4 @@ public enum Priority
         /// </summary>
         Normal,
     }
-}
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Util/IHttpResponseDeserializer.cs b/FirebaseAdmin/FirebaseAdmin/Util/IHttpResponseDeserializer.cs
@@ -27,4 +27,4 @@ internal interface IHttpResponseDeserializer
         /// <typeparam name="T">Type to deserialize the response into.</typeparam>
         T Deserialize<T>(string body);
     }
-}
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Util/RetryHttpClientInitializer.cs b/FirebaseAdmin/FirebaseAdmin/Util/RetryHttpClientInitializer.cs
@@ -101,11 +101,11 @@ protected override async Task Wait(TimeSpan ts, CancellationToken cancellationTo
             {
                 if (this.waiter != null)
                 {
-                    await this.waiter.Wait(ts, cancellationToken);
+                    await this.waiter.Wait(ts, cancellationToken).ConfigureAwait(false);
                 }
                 else
                 {
-                    await base.Wait(ts, cancellationToken);
+                    await base.Wait(ts, cancellationToken).ConfigureAwait(false);
                 }
             }
 
diff --git a/stylecop.json b/stylecop.json
@@ -3,6 +3,9 @@
     "settings": {
         "documentationRules": {
             "documentInternalElements": false
+        },
+        "layoutRules": {
+            "newlineAtEndOfFile": "require"
         }
     }
 }
diff --git a/stylecop.ruleset b/stylecop.ruleset
@@ -2,6 +2,8 @@
 <RuleSet Name="Rules for FirebaseAdmin" Description="Code analysis rules for FirebaseAdmin." ToolsVersion="14.0">
   <Rules AnalyzerId="AsyncUsageAnalyzers" RuleNamespace="AsyncUsageAnalyzers">
     <Rule Id="UseConfigureAwait" Action="Warning" />
+    <Rule Id="AvoidAsyncSuffix" Action="None" />
+    <Rule Id="UseAsyncSuffix" Action="None" />
   </Rules>
   <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
     <Rule Id="SA1200" Action="None" /> <!-- Using clauses inside namespaces -->
diff --git a/stylecop_test.ruleset b/stylecop_test.ruleset
@@ -1,8 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <RuleSet Name="Rules for FirebaseAdmin" Description="Code analysis rules for FirebaseAdmin." ToolsVersion="14.0">
-  <Rules AnalyzerId="AsyncUsageAnalyzers" RuleNamespace="AsyncUsageAnalyzers">
-    <Rule Id="UseConfigureAwait" Action="Warning" />
-  </Rules>
   <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
     <Rule Id="SA1200" Action="None" /> <!-- Using clauses inside namespaces -->
     <Rule Id="SA1402" Action="None" /> <!-- Multiple types in same file -->

Original file line number	Diff line number	Diff line change
`@@ -313,7 +313,8 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(`
`313`	`313`	`.ConfigureAwait(false);`
`314`	`314`	`if (checkRevoked)`
`315`	`315`	`{`
`316`		`- var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken);`
	`316`	`+ var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken)`
	`317`	`+ .ConfigureAwait(false);`
`317`	`318`	`if (revoked)`
`318`	`319`	`{`
`319`	`320`	`throw new FirebaseAuthException(`
`@@ -701,7 +702,8 @@ public async Task<DeleteUsersResult> DeleteUsersAsync(IReadOnlyList<string> uids`
`701`	`702`	`public async Task<UserImportResult> ImportUsersAsync(`
`702`	`703`	`IEnumerable<ImportUserRecordArgs> users)`
`703`	`704`	`{`
`704`		`- return await this.ImportUsersAsync(users, default(CancellationToken)).ConfigureAwait(false);`
	`705`	`+ return await this.ImportUsersAsync(users, default(CancellationToken))`
	`706`	`+ .ConfigureAwait(false);`
`705`	`707`	`}`
`706`	`708`
`707`	`709`	`/// <summary>`
`@@ -726,7 +728,8 @@ public async Task<UserImportResult> ImportUsersAsync(`
`726`	`728`	`IEnumerable<ImportUserRecordArgs> users,`
`727`	`729`	`CancellationToken cancellationToken)`
`728`	`730`	`{`
`729`		`- return await this.ImportUsersAsync(users, null, cancellationToken).ConfigureAwait(false);`
	`731`	`+ return await this.ImportUsersAsync(users, null, cancellationToken)`
	`732`	`+ .ConfigureAwait(false);`
`730`	`733`	`}`
`731`	`734`
`732`	`735`	`/// <summary>`
`@@ -746,7 +749,8 @@ public async Task<UserImportResult> ImportUsersAsync(`
`746`	`749`	`IEnumerable<ImportUserRecordArgs> users,`
`747`	`750`	`UserImportOptions options)`
`748`	`751`	`{`
`749`		`- return await this.ImportUsersAsync(users, options, default(CancellationToken)).ConfigureAwait(false);`
	`752`	`+ return await this.ImportUsersAsync(users, options, default(CancellationToken))`
	`753`	`+ .ConfigureAwait(false);`
`750`	`754`	`}`
`751`	`755`
`752`	`756`	`/// <summary>`
`@@ -769,8 +773,9 @@ public async Task<UserImportResult> ImportUsersAsync(`
`769`	`773`	`UserImportOptions options,`
`770`	`774`	`CancellationToken cancellationToken)`
`771`	`775`	`{`
`772`		`- var request = new UserImportRequest(users, options);`
`773`		`- return await this.UserManager.ImportUsersAsync(request, cancellationToken);`
	`776`	`+ var request = new UserImportRequest(users, options);`
	`777`	`+ return await this.UserManager.ImportUsersAsync(request, cancellationToken)`
	`778`	`+ .ConfigureAwait(false);`
`774`	`779`	`}`
`775`	`780`
`776`	`781`	`/// <summary>`
`@@ -1227,7 +1232,7 @@ private protected TResult IfNotDeleted<TResult>(Func<TResult> func)`
`1227`	`1232`	`private protected async Task<bool> IsRevokedAsync(`
`1228`	`1233`	`FirebaseToken token, CancellationToken cancellationToken)`
`1229`	`1234`	`{`
`1230`		`- var user = await this.GetUserAsync(token.Uid, cancellationToken);`
	`1235`	`+ var user = await this.GetUserAsync(token.Uid, cancellationToken).ConfigureAwait(false);`
`1231`	`1236`	`var cutoff = user.TokensValidAfterTimestamp.Subtract(UserRecord.UnixEpoch)`
`1232`	`1237`	`.TotalSeconds;`
`1233`	`1238`	`return token.IssuedAtTimeSeconds < cutoff;`
Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,8 @@ public async Task<FirebaseToken> VerifySessionCookieAsync(`
`208`	`208`	`.ConfigureAwait(false);`
`209`	`209`	`if (checkRevoked)`
`210`	`210`	`{`
`211`		`- var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken);`
	`211`	`+ var revoked = await this.IsRevokedAsync(decodedToken, cancellationToken)`
	`212`	`+ .ConfigureAwait(false);`
`212`	`213`	`if (revoked)`
`213`	`214`	`{`
`214`	`215`	`throw new FirebaseAuthException(`
Original file line number	Diff line number	Diff line change
`@@ -92,4 +92,4 @@ internal class FirebaseExceptionArgs`
`92`	`92`	`internal string ResponseBody { get; set; }`
`93`	`93`	`}`
`94`	`94`	`}`
`95`		`-}`
	`95`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,4 @@ internal Action(Action action)`
`51`	`51`	`[JsonProperty("icon")]`
`52`	`52`	`public string Icon { get; set; }`
`53`	`53`	`}`
`54`		`-}`
	`54`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,4 @@ public enum Direction`
`34`	`34`	`/// </summary>`
`35`	`35`	`RightToLeft,`
`36`	`36`	`}`
`37`		`-}`
	`37`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,4 @@ public enum Priority`
`29`	`29`	`/// </summary>`
`30`	`30`	`Normal,`
`31`	`31`	`}`
`32`		`-}`
	`32`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -27,4 +27,4 @@ internal interface IHttpResponseDeserializer`
`27`	`27`	`/// <typeparam name="T">Type to deserialize the response into.</typeparam>`
`28`	`28`	`T Deserialize<T>(string body);`
`29`	`29`	`}`
`30`		`-}`
	`30`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -101,11 +101,11 @@ protected override async Task Wait(TimeSpan ts, CancellationToken cancellationTo`
`101`	`101`	`{`
`102`	`102`	`if (this.waiter != null)`
`103`	`103`	`{`
`104`		`- await this.waiter.Wait(ts, cancellationToken);`
	`104`	`+ await this.waiter.Wait(ts, cancellationToken).ConfigureAwait(false);`
`105`	`105`	`}`
`106`	`106`	`else`
`107`	`107`	`{`
`108`		`- await base.Wait(ts, cancellationToken);`
	`108`	`+ await base.Wait(ts, cancellationToken).ConfigureAwait(false);`
`109`	`109`	`}`
`110`	`110`	`}`
`111`	`111`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,9 @@`
`3`	`3`	`"settings": {`
`4`	`4`	`"documentationRules": {`
`5`	`5`	`"documentInternalElements": false`
	`6`	`+ },`
	`7`	`+ "layoutRules": {`
	`8`	`+ "newlineAtEndOfFile": "require"`
`6`	`9`	`}`
`7`	`10`	`}`
`8`	`11`	`}`