Merge pull request #136 from Insire/configure_async_methods

jbogard · web-flow · commit 03c91a618650 · 2025-03-07T14:11:02.000-06:00
Add ConfigureAwait(false) to async method calls, to prevent potential…
diff --git a/Respawn/Respawner.cs b/Respawn/Respawner.cs
@@ -38,11 +38,11 @@ public static async Task<Respawner> CreateAsync(string nameOrConnectionString, R
 
             await using var connection = new SqlConnection(nameOrConnectionString);
 
-            await connection.OpenAsync();
+            await connection.OpenAsync().ConfigureAwait(false);
 
             var respawner = new Respawner(options);
 
-            await respawner.BuildDeleteTables(connection);
+            await respawner.BuildDeleteTables(connection).ConfigureAwait(false);
 
             return respawner;
         }
@@ -59,80 +59,79 @@ public static async Task<Respawner> CreateAsync(DbConnection connection, Respawn
 
             var respawner = new Respawner(options);
 
-            await respawner.BuildDeleteTables(connection);
+            await respawner.BuildDeleteTables(connection).ConfigureAwait(false);
 
             return respawner;
         }
 
-
         public virtual async Task ResetAsync(string nameOrConnectionString)
         {
             await using var connection = new SqlConnection(nameOrConnectionString);
 
-            await connection.OpenAsync();
+            await connection.OpenAsync().ConfigureAwait(false);
 
-            await ResetAsync(connection);
+            await ResetAsync(connection).ConfigureAwait(false);
         }
 
         public virtual async Task ResetAsync(DbConnection connection)
         {
             if (_temporalTables.Any())
             {
                 var turnOffVersioningCommandText = Options.DbAdapter.BuildTurnOffSystemVersioningCommandText(_temporalTables);
-                await ExecuteAlterSystemVersioningAsync(connection, turnOffVersioningCommandText);
+                await ExecuteAlterSystemVersioningAsync(connection, turnOffVersioningCommandText).ConfigureAwait(false);
             }
 
             try
             {
-                await ExecuteDeleteSqlAsync(connection);
+                await ExecuteDeleteSqlAsync(connection).ConfigureAwait(false);
             }
             finally
             {
                 if (_temporalTables.Any())
                 {
                     var turnOnVersioningCommandText = Options.DbAdapter.BuildTurnOnSystemVersioningCommandText(_temporalTables);
-                    await ExecuteAlterSystemVersioningAsync(connection, turnOnVersioningCommandText);
+                    await ExecuteAlterSystemVersioningAsync(connection, turnOnVersioningCommandText).ConfigureAwait(false);
                 }
             }
         }
 
         private async Task ExecuteAlterSystemVersioningAsync(DbConnection connection, string commandText)
         {
-            await using var tx = await connection.BeginTransactionAsync();
+            await using var tx = await connection.BeginTransactionAsync().ConfigureAwait(false);
             await using var cmd = connection.CreateCommand();
 
             cmd.CommandTimeout = Options.CommandTimeout ?? cmd.CommandTimeout;
             cmd.CommandText = commandText;
             cmd.Transaction = tx;
 
-            await cmd.ExecuteNonQueryAsync();
+            await cmd.ExecuteNonQueryAsync().ConfigureAwait(false);
 
-            await tx.CommitAsync();
+            await tx.CommitAsync().ConfigureAwait(false);
         }
 
         private async Task ExecuteDeleteSqlAsync(DbConnection connection)
         {
-            await using var tx = await connection.BeginTransactionAsync();
+            await using var tx = await connection.BeginTransactionAsync().ConfigureAwait(false);
             await using var cmd = connection.CreateCommand();
 
             cmd.CommandTimeout = Options.CommandTimeout ?? cmd.CommandTimeout;
             cmd.CommandText = DeleteSql;
             cmd.Transaction = tx;
 
-            await cmd.ExecuteNonQueryAsync();
+            await cmd.ExecuteNonQueryAsync().ConfigureAwait(false);
 
             if (ReseedSql != null)
             {
                 cmd.CommandText = ReseedSql;
-                await cmd.ExecuteNonQueryAsync();
+                await cmd.ExecuteNonQueryAsync().ConfigureAwait(false);
             }
 
-            await tx.CommitAsync();
+            await tx.CommitAsync().ConfigureAwait(false);
         }
 
         private async Task BuildDeleteTables(DbConnection connection)
         {
-            var allTables = await GetAllTables(connection);
+            var allTables = await GetAllTables(connection).ConfigureAwait(false);
 
             if (!allTables.Any())
             {
@@ -142,10 +141,10 @@ private async Task BuildDeleteTables(DbConnection connection)
 
             if (Options.CheckTemporalTables && await Options.DbAdapter.CheckSupportsTemporalTables(connection))
             {
-                _temporalTables = await GetAllTemporalTables(connection);
+                _temporalTables = await GetAllTemporalTables(connection).ConfigureAwait(false);
             }
 
-            var allRelationships = await GetRelationships(connection);
+            var allRelationships = await GetRelationships(connection).ConfigureAwait(false);
 
             var graphBuilder = new GraphBuilder(allTables, allRelationships);
 
@@ -162,13 +161,13 @@ private async Task<HashSet<Relationship>> GetRelationships(DbConnection connecti
 
             cmd.CommandText = commandText;
 
-            await using var reader = await cmd.ExecuteReaderAsync();
+            await using var reader = await cmd.ExecuteReaderAsync().ConfigureAwait(false);
 
-            while (await reader.ReadAsync())
+            while (await reader.ReadAsync().ConfigureAwait(false))
             {
                 relationships.Add(new Relationship(
-                    new Table(await reader.IsDBNullAsync(0) ? null : reader.GetString(0), reader.GetString(1)),
-                    new Table(await reader.IsDBNullAsync(2) ? null : reader.GetString(2), reader.GetString(3)),
+                    new Table(await reader.IsDBNullAsync(0).ConfigureAwait(false) ? null : reader.GetString(0), reader.GetString(1)),
+                    new Table(await reader.IsDBNullAsync(2).ConfigureAwait(false) ? null : reader.GetString(2), reader.GetString(3)),
                     reader.GetString(4)));
             }
 
@@ -185,11 +184,11 @@ private async Task<HashSet<Table>> GetAllTables(DbConnection connection)
 
             cmd.CommandText = commandText;
 
-            await using var reader = await cmd.ExecuteReaderAsync();
+            await using var reader = await cmd.ExecuteReaderAsync().ConfigureAwait(false);
 
-            while (await reader.ReadAsync())
+            while (await reader.ReadAsync().ConfigureAwait(false))
             {
-                tables.Add(new Table(await reader.IsDBNullAsync(0) ? null : reader.GetString(0), reader.GetString(1)));
+                tables.Add(new Table(await reader.IsDBNullAsync(0).ConfigureAwait(false) ? null : reader.GetString(0), reader.GetString(1)));
             }
 
             return tables;
@@ -205,11 +204,11 @@ private async Task<IList<TemporalTable>> GetAllTemporalTables(DbConnection conne
 
             cmd.CommandText = commandText;
 
-            await using var reader = await cmd.ExecuteReaderAsync();
+            await using var reader = await cmd.ExecuteReaderAsync().ConfigureAwait(false);
 
-            while (await reader.ReadAsync())
+            while (await reader.ReadAsync().ConfigureAwait(false))
             {
-                tables.Add(new TemporalTable(await reader.IsDBNullAsync(0) ? null : reader.GetString(0), reader.GetString(1), reader.GetString(2), reader.GetString(3)));
+                tables.Add(new TemporalTable(await reader.IsDBNullAsync(0).ConfigureAwait(false) ? null : reader.GetString(0), reader.GetString(1), reader.GetString(2), reader.GetString(3)));
             }
 
             return tables;
diff --git a/Respawn/SqlServerDbAdapter.cs b/Respawn/SqlServerDbAdapter.cs
@@ -308,8 +308,8 @@ public string BuildTurnOnSystemVersioningCommandText(IEnumerable<TemporalTable>
 
         public async Task<bool> CheckSupportsTemporalTables(DbConnection connection)
         {
-            _compatibilityLevel ??= await GetCompatibilityLevel(connection);
-            _engineEdition ??= await GetEngineEdition(connection);
+            _compatibilityLevel ??= await GetCompatibilityLevel(connection).ConfigureAwait(false);
+            _engineEdition ??= await GetEngineEdition(connection).ConfigureAwait(false);
 
             //Code taken from https://github.com/dotnet/efcore/blob/main/src/EFCore.SqlServer/Scaffolding/Internal/SqlServerDatabaseModelFactory.cs
             return _compatibilityLevel >= 130 && _engineEdition != 6;
@@ -320,7 +320,7 @@ private static async Task<int> GetEngineEdition(DbConnection connection)
             await using var command = connection.CreateCommand();
             command.CommandText = @"
 SELECT SERVERPROPERTY('EngineEdition');";
-            var engineEdition = await command.ExecuteScalarAsync();
+            var engineEdition = await command.ExecuteScalarAsync().ConfigureAwait(false);
             return (int)engineEdition!;
         }
 
@@ -332,7 +332,7 @@ SELECT compatibility_level
 FROM sys.databases
 WHERE name = '{connection.Database}';";
 
-            var result = await command.ExecuteScalarAsync();
+            var result = await command.ExecuteScalarAsync().ConfigureAwait(false);
             return result != null ? Convert.ToByte(result) : (byte)0;
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -38,11 +38,11 @@ public static async Task<Respawner> CreateAsync(string nameOrConnectionString, R`
`38`	`38`
`39`	`39`	`await using var connection = new SqlConnection(nameOrConnectionString);`
`40`	`40`
`41`		`- await connection.OpenAsync();`
	`41`	`+ await connection.OpenAsync().ConfigureAwait(false);`
`42`	`42`
`43`	`43`	`var respawner = new Respawner(options);`
`44`	`44`
`45`		`- await respawner.BuildDeleteTables(connection);`
	`45`	`+ await respawner.BuildDeleteTables(connection).ConfigureAwait(false);`
`46`	`46`
`47`	`47`	`return respawner;`
`48`	`48`	`}`
`@@ -59,80 +59,79 @@ public static async Task<Respawner> CreateAsync(DbConnection connection, Respawn`
`59`	`59`
`60`	`60`	`var respawner = new Respawner(options);`
`61`	`61`
`62`		`- await respawner.BuildDeleteTables(connection);`
	`62`	`+ await respawner.BuildDeleteTables(connection).ConfigureAwait(false);`
`63`	`63`
`64`	`64`	`return respawner;`
`65`	`65`	`}`
`66`	`66`
`67`		`-`
`68`	`67`	`public virtual async Task ResetAsync(string nameOrConnectionString)`
`69`	`68`	`{`
`70`	`69`	`await using var connection = new SqlConnection(nameOrConnectionString);`
`71`	`70`
`72`		`- await connection.OpenAsync();`
	`71`	`+ await connection.OpenAsync().ConfigureAwait(false);`
`73`	`72`
`74`		`- await ResetAsync(connection);`
	`73`	`+ await ResetAsync(connection).ConfigureAwait(false);`
`75`	`74`	`}`
`76`	`75`
`77`	`76`	`public virtual async Task ResetAsync(DbConnection connection)`
`78`	`77`	`{`
`79`	`78`	`if (_temporalTables.Any())`
`80`	`79`	`{`
`81`	`80`	`var turnOffVersioningCommandText = Options.DbAdapter.BuildTurnOffSystemVersioningCommandText(_temporalTables);`
`82`		`- await ExecuteAlterSystemVersioningAsync(connection, turnOffVersioningCommandText);`
	`81`	`+ await ExecuteAlterSystemVersioningAsync(connection, turnOffVersioningCommandText).ConfigureAwait(false);`
`83`	`82`	`}`
`84`	`83`
`85`	`84`	`try`
`86`	`85`	`{`
`87`		`- await ExecuteDeleteSqlAsync(connection);`
	`86`	`+ await ExecuteDeleteSqlAsync(connection).ConfigureAwait(false);`
`88`	`87`	`}`
`89`	`88`	`finally`
`90`	`89`	`{`
`91`	`90`	`if (_temporalTables.Any())`
`92`	`91`	`{`
`93`	`92`	`var turnOnVersioningCommandText = Options.DbAdapter.BuildTurnOnSystemVersioningCommandText(_temporalTables);`
`94`		`- await ExecuteAlterSystemVersioningAsync(connection, turnOnVersioningCommandText);`
	`93`	`+ await ExecuteAlterSystemVersioningAsync(connection, turnOnVersioningCommandText).ConfigureAwait(false);`
`95`	`94`	`}`
`96`	`95`	`}`
`97`	`96`	`}`
`98`	`97`
`99`	`98`	`private async Task ExecuteAlterSystemVersioningAsync(DbConnection connection, string commandText)`
`100`	`99`	`{`
`101`		`- await using var tx = await connection.BeginTransactionAsync();`
	`100`	`+ await using var tx = await connection.BeginTransactionAsync().ConfigureAwait(false);`
`102`	`101`	`await using var cmd = connection.CreateCommand();`
`103`	`102`
`104`	`103`	`cmd.CommandTimeout = Options.CommandTimeout ?? cmd.CommandTimeout;`
`105`	`104`	`cmd.CommandText = commandText;`
`106`	`105`	`cmd.Transaction = tx;`
`107`	`106`
`108`		`- await cmd.ExecuteNonQueryAsync();`
	`107`	`+ await cmd.ExecuteNonQueryAsync().ConfigureAwait(false);`
`109`	`108`
`110`		`- await tx.CommitAsync();`
	`109`	`+ await tx.CommitAsync().ConfigureAwait(false);`
`111`	`110`	`}`
`112`	`111`
`113`	`112`	`private async Task ExecuteDeleteSqlAsync(DbConnection connection)`
`114`	`113`	`{`
`115`		`- await using var tx = await connection.BeginTransactionAsync();`
	`114`	`+ await using var tx = await connection.BeginTransactionAsync().ConfigureAwait(false);`
`116`	`115`	`await using var cmd = connection.CreateCommand();`
`117`	`116`
`118`	`117`	`cmd.CommandTimeout = Options.CommandTimeout ?? cmd.CommandTimeout;`
`119`	`118`	`cmd.CommandText = DeleteSql;`
`120`	`119`	`cmd.Transaction = tx;`
`121`	`120`
`122`		`- await cmd.ExecuteNonQueryAsync();`
	`121`	`+ await cmd.ExecuteNonQueryAsync().ConfigureAwait(false);`
`123`	`122`
`124`	`123`	`if (ReseedSql != null)`
`125`	`124`	`{`
`126`	`125`	`cmd.CommandText = ReseedSql;`
`127`		`- await cmd.ExecuteNonQueryAsync();`
	`126`	`+ await cmd.ExecuteNonQueryAsync().ConfigureAwait(false);`
`128`	`127`	`}`
`129`	`128`
`130`		`- await tx.CommitAsync();`
	`129`	`+ await tx.CommitAsync().ConfigureAwait(false);`
`131`	`130`	`}`
`132`	`131`
`133`	`132`	`private async Task BuildDeleteTables(DbConnection connection)`
`134`	`133`	`{`
`135`		`- var allTables = await GetAllTables(connection);`
	`134`	`+ var allTables = await GetAllTables(connection).ConfigureAwait(false);`
`136`	`135`
`137`	`136`	`if (!allTables.Any())`
`138`	`137`	`{`
`@@ -142,10 +141,10 @@ private async Task BuildDeleteTables(DbConnection connection)`
`142`	`141`
`143`	`142`	`if (Options.CheckTemporalTables && await Options.DbAdapter.CheckSupportsTemporalTables(connection))`
`144`	`143`	`{`
`145`		`- _temporalTables = await GetAllTemporalTables(connection);`
	`144`	`+ _temporalTables = await GetAllTemporalTables(connection).ConfigureAwait(false);`
`146`	`145`	`}`
`147`	`146`
`148`		`- var allRelationships = await GetRelationships(connection);`
	`147`	`+ var allRelationships = await GetRelationships(connection).ConfigureAwait(false);`
`149`	`148`
`150`	`149`	`var graphBuilder = new GraphBuilder(allTables, allRelationships);`
`151`	`150`
`@@ -162,13 +161,13 @@ private async Task<HashSet<Relationship>> GetRelationships(DbConnection connecti`
`162`	`161`
`163`	`162`	`cmd.CommandText = commandText;`
`164`	`163`
`165`		`- await using var reader = await cmd.ExecuteReaderAsync();`
	`164`	`+ await using var reader = await cmd.ExecuteReaderAsync().ConfigureAwait(false);`
`166`	`165`
`167`		`- while (await reader.ReadAsync())`
	`166`	`+ while (await reader.ReadAsync().ConfigureAwait(false))`
`168`	`167`	`{`
`169`	`168`	`relationships.Add(new Relationship(`
`170`		`- new Table(await reader.IsDBNullAsync(0) ? null : reader.GetString(0), reader.GetString(1)),`
`171`		`- new Table(await reader.IsDBNullAsync(2) ? null : reader.GetString(2), reader.GetString(3)),`
	`169`	`+ new Table(await reader.IsDBNullAsync(0).ConfigureAwait(false) ? null : reader.GetString(0), reader.GetString(1)),`
	`170`	`+ new Table(await reader.IsDBNullAsync(2).ConfigureAwait(false) ? null : reader.GetString(2), reader.GetString(3)),`
`172`	`171`	`reader.GetString(4)));`
`173`	`172`	`}`
`174`	`173`
`@@ -185,11 +184,11 @@ private async Task<HashSet<Table>> GetAllTables(DbConnection connection)`
`185`	`184`
`186`	`185`	`cmd.CommandText = commandText;`
`187`	`186`
`188`		`- await using var reader = await cmd.ExecuteReaderAsync();`
	`187`	`+ await using var reader = await cmd.ExecuteReaderAsync().ConfigureAwait(false);`
`189`	`188`
`190`		`- while (await reader.ReadAsync())`
	`189`	`+ while (await reader.ReadAsync().ConfigureAwait(false))`
`191`	`190`	`{`
`192`		`- tables.Add(new Table(await reader.IsDBNullAsync(0) ? null : reader.GetString(0), reader.GetString(1)));`
	`191`	`+ tables.Add(new Table(await reader.IsDBNullAsync(0).ConfigureAwait(false) ? null : reader.GetString(0), reader.GetString(1)));`
`193`	`192`	`}`
`194`	`193`
`195`	`194`	`return tables;`
`@@ -205,11 +204,11 @@ private async Task<IList<TemporalTable>> GetAllTemporalTables(DbConnection conne`
`205`	`204`
`206`	`205`	`cmd.CommandText = commandText;`
`207`	`206`
`208`		`- await using var reader = await cmd.ExecuteReaderAsync();`
	`207`	`+ await using var reader = await cmd.ExecuteReaderAsync().ConfigureAwait(false);`
`209`	`208`
`210`		`- while (await reader.ReadAsync())`
	`209`	`+ while (await reader.ReadAsync().ConfigureAwait(false))`
`211`	`210`	`{`
`212`		`- tables.Add(new TemporalTable(await reader.IsDBNullAsync(0) ? null : reader.GetString(0), reader.GetString(1), reader.GetString(2), reader.GetString(3)));`
	`211`	`+ tables.Add(new TemporalTable(await reader.IsDBNullAsync(0).ConfigureAwait(false) ? null : reader.GetString(0), reader.GetString(1), reader.GetString(2), reader.GetString(3)));`
`213`	`212`	`}`
`214`	`213`
`215`	`214`	`return tables;`
Original file line number	Diff line number	Diff line change
`@@ -308,8 +308,8 @@ public string BuildTurnOnSystemVersioningCommandText(IEnumerable<TemporalTable>`
`308`	`308`
`309`	`309`	`public async Task<bool> CheckSupportsTemporalTables(DbConnection connection)`
`310`	`310`	`{`
`311`		`- _compatibilityLevel ??= await GetCompatibilityLevel(connection);`
`312`		`- _engineEdition ??= await GetEngineEdition(connection);`
	`311`	`+ _compatibilityLevel ??= await GetCompatibilityLevel(connection).ConfigureAwait(false);`
	`312`	`+ _engineEdition ??= await GetEngineEdition(connection).ConfigureAwait(false);`
`313`	`313`
`314`	`314`	`//Code taken from https://github.com/dotnet/efcore/blob/main/src/EFCore.SqlServer/Scaffolding/Internal/SqlServerDatabaseModelFactory.cs`
`315`	`315`	`return _compatibilityLevel >= 130 && _engineEdition != 6;`
`@@ -320,7 +320,7 @@ private static async Task<int> GetEngineEdition(DbConnection connection)`
`320`	`320`	`await using var command = connection.CreateCommand();`
`321`	`321`	`command.CommandText = @"`
`322`	`322`	`SELECT SERVERPROPERTY('EngineEdition');";`
`323`		`- var engineEdition = await command.ExecuteScalarAsync();`
	`323`	`+ var engineEdition = await command.ExecuteScalarAsync().ConfigureAwait(false);`
`324`	`324`	`return (int)engineEdition!;`
`325`	`325`	`}`
`326`	`326`
`@@ -332,7 +332,7 @@ SELECT compatibility_level`
`332`	`332`	`FROM sys.databases`
`333`	`333`	`WHERE name = '{connection.Database}';";`
`334`	`334`
`335`		`- var result = await command.ExecuteScalarAsync();`
	`335`	`+ var result = await command.ExecuteScalarAsync().ConfigureAwait(false);`
`336`	`336`	`return result != null ? Convert.ToByte(result) : (byte)0;`
`337`	`337`	`}`
`338`	`338`	`}`