Merge | Merge netfx-specific exception handling (#3179)

* Exception handling merge

Merge exception handling for SqlBulkCopy, SqlCommandBuilder, SqlDataReader, SqlInternalConnection, SqlTransaction and (partially) SqlConnection

* Code review changes

Wrapped each call to SqlInternalConnection.BestEffortCleanup in #if, rather than having an empty BestEffortCleanup method.

* Added missing PrepareConstrainedRegions calls

These were part of the netfx exception handling

Author: edwardneal

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlBulkCopy.cs

@@ -1988,8 +1988,13 @@ private Task WriteRowSourceToServerAsync(int columnCount, CancellationToken ctok
             _parserLock = internalConnection._parserLock;
             _parserLock.Wait(canReleaseFromAnyThread: _isAsyncBulkCopy);
 
+            TdsParser bestEffortCleanupTarget = null;
+#if NETFRAMEWORK
+            RuntimeHelpers.PrepareConstrainedRegions();
+#endif
             try
             {
+                bestEffortCleanupTarget = SqlInternalConnection.GetBestEffortCleanupTarget(_connection);
                 WriteRowSourceToServerCommon(columnCount); // This is common in both sync and async
                 Task resultTask = WriteToServerInternalAsync(ctoken); // resultTask is null for sync, but Task for async.
                 if (resultTask != null)
@@ -2037,6 +2042,9 @@ private Task WriteRowSourceToServerAsync(int columnCount, CancellationToken ctok
             catch (System.Threading.ThreadAbortException e)
             {
                 _connection.Abort(e);
+#if NETFRAMEWORK
+                SqlInternalConnection.BestEffortCleanup(bestEffortCleanupTarget);
+#endif
                 throw;
             }
             finally
@@ -2297,7 +2305,8 @@ private void CopyColumnsAsyncSetupContinuation(TaskCompletionSource<object> sour
                     {
                         source.SetResult(null);
                     }
-                }
+                },
+                connectionToDoom: _connection.GetOpenTdsConnection()
            );
         }
 
@@ -2434,8 +2443,8 @@ private Task CopyRowsAsync(int rowsSoFar, int totalRows, CancellationToken cts,
                             resultTask = source.Task;
 
                             AsyncHelper.ContinueTaskWithState(readTask, source, this,
-                                onSuccess: (object state) => ((SqlBulkCopy)state).CopyRowsAsync(i + 1, totalRows, cts, source)
-                                
+                                onSuccess: (object state) => ((SqlBulkCopy)state).CopyRowsAsync(i + 1, totalRows, cts, source),
+                                connectionToDoom: _connection.GetOpenTdsConnection()
                             );
                             return resultTask; // Associated task will be completed when all rows are copied to server/exception/cancelled.
                         }
@@ -2459,12 +2468,14 @@ private Task CopyRowsAsync(int rowsSoFar, int totalRows, CancellationToken cts,
                                 else
                                 {
                                     AsyncHelper.ContinueTaskWithState(readTask, source, sqlBulkCopy,
-                                        onSuccess: (object state2) => ((SqlBulkCopy)state2).CopyRowsAsync(i + 1, totalRows, cts, source)
+                                        onSuccess: (object state2) => ((SqlBulkCopy)state2).CopyRowsAsync(i + 1, totalRows, cts, source),
+                                        connectionToDoom: _connection.GetOpenTdsConnection()
                                     );
                                 }
-                           }
-                       );
-                       return resultTask;
+                            },
+                            connectionToDoom: _connection.GetOpenTdsConnection()
+                        );
+                        return resultTask;
                     }
                 }
 
@@ -2542,7 +2553,8 @@ private Task CopyBatchesAsync(BulkCopySimpleResultSet internalResults, string up
                                     // Continuation finished sync, recall into CopyBatchesAsync to continue
                                     sqlBulkCopy.CopyBatchesAsync(internalResults, updateBulkCommandText, cts, source);
                                 }
-                            }
+                            },
+                            connectionToDoom: _connection.GetOpenTdsConnection()
                         );
                         return source.Task;
                     }
@@ -2609,7 +2621,8 @@ private Task CopyBatchesAsyncContinued(BulkCopySimpleResultSet internalResults,
                             }
                         },
                         onFailure: static (Exception _, object state) => ((SqlBulkCopy)state).CopyBatchesAsyncContinuedOnError(cleanupParser: false),
-                        onCancellation: static (object state) => ((SqlBulkCopy)state).CopyBatchesAsyncContinuedOnError(cleanupParser: true)
+                        onCancellation: static (object state) => ((SqlBulkCopy)state).CopyBatchesAsyncContinuedOnError(cleanupParser: true),
+                        connectionToDoom: _connection.GetOpenTdsConnection()
                     );
 
                     return source.Task;
@@ -2675,7 +2688,8 @@ private Task CopyBatchesAsyncContinuedOnSuccess(BulkCopySimpleResultSet internal
                             // Always call back into CopyBatchesAsync
                             sqlBulkCopy.CopyBatchesAsync(internalResults, updateBulkCommandText, cts, source);
                         },
-                        onFailure: static (Exception _, object state) => ((SqlBulkCopy)state).CopyBatchesAsyncContinuedOnError(cleanupParser: false)
+                        onFailure: static (Exception _, object state) => ((SqlBulkCopy)state).CopyBatchesAsyncContinuedOnError(cleanupParser: false),
+                        connectionToDoom: _connection.GetOpenTdsConnection()
                     );
                     return source.Task;
                 }
@@ -2698,6 +2712,9 @@ private Task CopyBatchesAsyncContinuedOnSuccess(BulkCopySimpleResultSet internal
         private void CopyBatchesAsyncContinuedOnError(bool cleanupParser)
         {
             SqlInternalConnectionTds internalConnection = _connection.GetOpenTdsConnection();
+#if NETFRAMEWORK
+            RuntimeHelpers.PrepareConstrainedRegions();
+#endif
             try
             {
                 if ((cleanupParser) && (_parser != null) && (_stateObj != null))
@@ -2838,7 +2855,8 @@ private void WriteToServerInternalRestContinuedAsync(BulkCopySimpleResultSet int
                                     }
                                 }
                             }
-                        }
+                        },
+                        connectionToDoom: _connection.GetOpenTdsConnection()
                     );
                     return;
                 }
@@ -2957,6 +2975,7 @@ private void WriteToServerInternalRestAsync(CancellationToken cts, TaskCompletio
                                 _parserLock.Wait(canReleaseFromAnyThread: true);
                                 WriteToServerInternalRestAsync(cts, source);
                             },
+                            connectionToAbort: _connection,
                             onFailure: static (Exception _, object state) => ((StrongBox<CancellationTokenRegistration>)state).Value.Dispose(),
                             onCancellation: static (object state) => ((StrongBox<CancellationTokenRegistration>)state).Value.Dispose(),
                             exceptionConverter: (ex) => SQL.BulkLoadInvalidDestinationTable(_destinationTableName, ex));
@@ -3008,7 +3027,8 @@ private void WriteToServerInternalRestAsync(CancellationToken cts, TaskCompletio
                 if (internalResultsTask != null)
                 {
                     AsyncHelper.ContinueTaskWithState(internalResultsTask, source, this,
-                        onSuccess: (object state) => ((SqlBulkCopy)state).WriteToServerInternalRestContinuedAsync(internalResultsTask.Result, cts, source)
+                        onSuccess: (object state) => ((SqlBulkCopy)state).WriteToServerInternalRestContinuedAsync(internalResultsTask.Result, cts, source),
+                        connectionToDoom: _connection.GetOpenTdsConnection()
                     );
                 }
                 else
@@ -3092,7 +3112,8 @@ private Task WriteToServerInternalAsync(CancellationToken ctoken)
                             {
                                 sqlBulkCopy.WriteToServerInternalRestAsync(ctoken, source); // Passing the same completion which will be completed by the Callee.
                             }
-                        }
+                        },
+                        connectionToDoom: _connection.GetOpenTdsConnection()
                     );
                     return resultTask;
                 }

src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlConnection.cs

@@ -1233,11 +1233,35 @@ public override void ChangeDatabase(string database)
             SqlStatistics statistics = null;
             RepairInnerConnection();
             SqlClientEventSource.Log.TryCorrelationTraceEvent("SqlConnection.ChangeDatabase | API | Correlation | Object Id {0}, Activity Id {1}, Database {2}", ObjectID, ActivityCorrelator.Current, database);
+            TdsParser bestEffortCleanupTarget = null;
+
+#if NETFRAMEWORK
+            RuntimeHelpers.PrepareConstrainedRegions();
+#endif
             try
             {
+                bestEffortCleanupTarget = SqlInternalConnection.GetBestEffortCleanupTarget(this);
                 statistics = SqlStatistics.StartTimer(Statistics);
                 InnerConnection.ChangeDatabase(database);
             }
+            catch (System.OutOfMemoryException e)
+            {
+                Abort(e);
+                throw;
+            }
+            catch (System.StackOverflowException e)
+            {
+                Abort(e);
+                throw;
+            }
+            catch (System.Threading.ThreadAbortException e)
+            {
+                Abort(e);
+#if NETFRAMEWORK
+                SqlInternalConnection.BestEffortCleanup(bestEffortCleanupTarget);
+#endif
+                throw;
+            }
             finally
             {
                 SqlStatistics.StopTimer(statistics);
@@ -1301,10 +1325,15 @@ public override void Close()
                 }
 
                 SqlStatistics statistics = null;
-
+                TdsParser bestEffortCleanupTarget = null;
                 Exception e = null;
+
+#if NETFRAMEWORK
+                RuntimeHelpers.PrepareConstrainedRegions();
+#endif
                 try
                 {
+                    bestEffortCleanupTarget = SqlInternalConnection.GetBestEffortCleanupTarget(this);
                     statistics = SqlStatistics.StartTimer(Statistics);
 
                     Task reconnectTask = _currentReconnectionTask;
@@ -1330,6 +1359,27 @@ public override void Close()
                         _statistics._closeTimestamp = ADP.TimerCurrent();
                     }
                 }
+                catch (System.OutOfMemoryException ex)
+                {
+                    e = ex;
+                    Abort(ex);
+                    throw;
+                }
+                catch (System.StackOverflowException ex)
+                {
+                    e = ex;
+                    Abort(ex);
+                    throw;
+                }
+                catch (System.Threading.ThreadAbortException ex)
+                {
+                    e = ex;
+                    Abort(ex);
+#if NETFRAMEWORK
+                    SqlInternalConnection.BestEffortCleanup(bestEffortCleanupTarget);
+#endif
+                    throw;
+                }
                 catch (Exception ex)
                 {
                     e = ex;