Skip to content

Enforce calling ConfigureAwait() when awaiting a Task #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Amer Jusupovic (amerjusupovic) merged 6 commits into from
May 2, 2023
Merged

Enforce calling ConfigureAwait() when awaiting a Task #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f0d15fc
add .ConfigureAwait(false) to await calls in ExecuteWithFailoverPolic…
amerjusupovic May 1, 2023
e48df1f
add warning rule for CA2007 configureawait, add another missing confi…
amerjusupovic May 1, 2023
a2fc30f
enforce ca2007 with an error message
amerjusupovic May 1, 2023
b80ade4
fix spacing in csproj, comment in ruleset file
amerjusupovic May 1, 2023
6001a28
fix spacing again
amerjusupovic May 1, 2023
2a57cc6
spacing
amerjusupovic May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions AzureAppConfigurationRules.ruleset
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- This rule is to enforce calling ConfigureAwait() when awaiting a Task, preventing thread issues. -->
<RuleSet Name="Default" ToolsVersion="17.0">
<Rules AnalyzerId="Microsoft.CodeAnalysis.NetAnalyzers" RuleNamespace="Microsoft.CodeAnalysis.NetAnalyzers">
<Rule Id="CA2007" Action="Error" />

@jimmyca15 Jimmy Campbell (jimmyca15) May 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment describing the purpose of the rule.

</Rules>
</RuleSet>
7 changes: 6 additions & 1 deletion Microsoft.Extensions.Configuration.AzureAppConfiguration.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.AppConfigur
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tests.AzureAppConfiguration.Functions.Worker", "tests\Tests.AzureAppConfiguration.Functions.Worker\Tests.AzureAppConfiguration.Functions.Worker.csproj", "{A9287214-6689-479F-A9F8-D0C02DE433F0}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleAppWithFailOver", "examples\ConsoleAppWithFailOver\ConsoleAppWithFailOver.csproj", "{A6C611F1-D687-4262-8904-828C239CF2E5}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConsoleAppWithFailOver", "examples\ConsoleAppWithFailOver\ConsoleAppWithFailOver.csproj", "{A6C611F1-D687-4262-8904-828C239CF2E5}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Properties", "Properties", "{4EC40BFD-526B-474E-8A7E-EF463FB2D55A}"
ProjectSection(SolutionItems) = preProject
AzureAppConfigurationRules.ruleset = AzureAppConfigurationRules.ruleset
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
5 changes: 5 additions & 0 deletions ...soft.Azure.AppConfiguration.AspNetCore/Microsoft.Azure.AppConfiguration.AspNetCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,9 @@
<Version>$(OfficialVersion)-$(CDP_PATCH_NUMBER)-$(Revision)</Version>
</PropertyGroup>

<PropertyGroup>
<CodeAnalysisRuleSet>..\..\AzureAppConfigurationRules.ruleset</CodeAnalysisRuleSet>
<EnableNETAnalyzers>True</EnableNETAnalyzers>
</PropertyGroup>

</Project>
5 changes: 5 additions & 0 deletions ...ppConfiguration.Functions.Worker/Microsoft.Azure.AppConfiguration.Functions.Worker.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,9 @@
<Version>$(OfficialVersion)-$(CDP_PATCH_NUMBER)-$(Revision)</Version>
</PropertyGroup>

<PropertyGroup>
<CodeAnalysisRuleSet>..\..\AzureAppConfigurationRules.ruleset</CodeAnalysisRuleSet>
<EnableNETAnalyzers>True</EnableNETAnalyzers>
</PropertyGroup>

</Project>
6 changes: 3 additions & 3 deletions ...Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,7 @@ private async Task<Dictionary<KeyValueIdentifier, ConfigurationSetting>> LoadKey
ConfigurationSetting watchedKv = null;
try
{
await CallWithRequestTracing(async () => watchedKv = await client.GetConfigurationSettingAsync(watchedKey, watchedLabel, cancellationToken)).ConfigureAwait(false);
await CallWithRequestTracing(async () => watchedKv = await client.GetConfigurationSettingAsync(watchedKey, watchedLabel, cancellationToken).ConfigureAwait(false)).ConfigureAwait(false);
}
catch (RequestFailedException e) when (e.Status == (int)HttpStatusCode.NotFound)
{
Expand Down Expand Up @@ -871,10 +871,10 @@ private async Task ExecuteWithFailOverPolicyAsync(IEnumerable<ConfigurationClien
{
await ExecuteWithFailOverPolicyAsync<object>(clients, async (client) =>
{
await funcToExecute(client);
await funcToExecute(client).ConfigureAwait(false);
return null;

}, cancellationToken);
}, cancellationToken).ConfigureAwait(false);
}

private bool IsFailOverable(AggregateException ex)
Expand Down
5 changes: 5 additions & 0 deletions ...ion.AzureAppConfiguration/Microsoft.Extensions.Configuration.AzureAppConfiguration.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,10 @@
<PropertyGroup Condition="'$(CDP_PATCH_NUMBER)'!='' AND '$(CDP_BUILD_TYPE)'!='Official'">
<Version>$(OfficialVersion)-$(CDP_PATCH_NUMBER)-$(Revision)</Version>
</PropertyGroup>

<PropertyGroup>
<CodeAnalysisRuleSet>..\..\AzureAppConfigurationRules.ruleset</CodeAnalysisRuleSet>
<EnableNETAnalyzers>True</EnableNETAnalyzers>
</PropertyGroup>

</Project>