feat: Add dx to catch ConfigureAwait(false) (#152)

Signed-off-by: Benjamin Evenson <2031163+benjiro@users.noreply.github.com>
open-feature · Sep 22, 2023 · 9c42d4a · 9c42d4a
1 parent dd92cbf
commit 9c42d4a
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -146,6 +146,9 @@ dotnet_diagnostic.IDE0005.severity = none
 # RS0041: Public members should not use oblivious types
 dotnet_diagnostic.RS0041.severity = suggestion
 
+# CA2007: Do not directly await a Task
+dotnet_diagnostic.CA2007.severity = error
+
 [obj/**.cs]
 generated_code = true
 

diff --git a/build/Common.props b/build/Common.props
@@ -2,6 +2,7 @@
   <PropertyGroup>
     <LangVersion>7.3</LangVersion>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)'=='Debug'">

diff --git a/test/OpenFeature.Benchmarks/OpenFeatureClientBenchmarks.cs b/test/OpenFeature.Benchmarks/OpenFeatureClientBenchmarks.cs
@@ -1,5 +1,6 @@
 
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using AutoFixture;
 using BenchmarkDotNet.Attributes;
@@ -12,6 +13,7 @@ namespace OpenFeature.Benchmark
     [SimpleJob(RuntimeMoniker.Net60, baseline: true)]
     [JsonExporterAttribute.Full]
     [JsonExporterAttribute.FullCompressed]
+    [SuppressMessage("Reliability", "CA2007:Consider calling ConfigureAwait on the awaited task")]
     public class OpenFeatureClientBenchmarks
     {
         private readonly string _clientName;

diff --git a/test/OpenFeature.Tests/FeatureProviderTests.cs b/test/OpenFeature.Tests/FeatureProviderTests.cs
@@ -1,3 +1,4 @@
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using AutoFixture;
 using FluentAssertions;
@@ -9,6 +10,7 @@
 
 namespace OpenFeature.Tests
 {
+    [SuppressMessage("Reliability", "CA2007:Consider calling ConfigureAwait on the awaited task")]
     public class FeatureProviderTests : ClearOpenFeatureInstanceFixture
     {
         [Fact]

diff --git a/test/OpenFeature.Tests/OpenFeatureClientTests.cs b/test/OpenFeature.Tests/OpenFeatureClientTests.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading.Tasks;
 using AutoFixture;
@@ -16,6 +17,7 @@
 
 namespace OpenFeature.Tests
 {
+    [SuppressMessage("Reliability", "CA2007:Consider calling ConfigureAwait on the awaited task")]
     public class OpenFeatureClientTests : ClearOpenFeatureInstanceFixture
     {
         [Fact]

diff --git a/test/OpenFeature.Tests/OpenFeatureHookTests.cs b/test/OpenFeature.Tests/OpenFeatureHookTests.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading.Tasks;
 using AutoFixture;
@@ -14,6 +15,7 @@
 
 namespace OpenFeature.Tests
 {
+    [SuppressMessage("Reliability", "CA2007:Consider calling ConfigureAwait on the awaited task")]
     public class OpenFeatureHookTests : ClearOpenFeatureInstanceFixture
     {
         [Fact]