| | | 1 | | using Microsoft.Data.SqlClient; |
| | | 2 | | using Microsoft.Extensions.Options; |
| | | 3 | | using System.Diagnostics; |
| | | 4 | | using System.Text.Json; |
| | | 5 | | |
| | | 6 | | namespace AsyncResponse.Transports.SqlServer; |
| | | 7 | | |
| | | 8 | | /// <summary>Publishes <see cref="WorkerJobEnvelope"/> messages to the SQL Server worker queue.</summary> |
| | | 9 | | public sealed class SqlServerWorkerTransport : IWorkerTransport |
| | | 10 | | { |
| | | 11 | | private readonly SqlServerAsyncResponseTransportOptions _options; |
| | | 12 | | private readonly SqlServerTransportStore _store; |
| | | 13 | | |
| | | 14 | | /// <summary>Creates a SQL Server worker transport over the configured connection string.</summary> |
| | | 15 | | public SqlServerWorkerTransport(IOptions<SqlServerAsyncResponseTransportOptions> options) |
| | 3 | 16 | | : this(options, new SqlServerTransportStore(options)) |
| | | 17 | | { |
| | 3 | 18 | | } |
| | | 19 | | |
| | 3 | 20 | | internal SqlServerWorkerTransport( |
| | 3 | 21 | | IOptions<SqlServerAsyncResponseTransportOptions> options, |
| | 3 | 22 | | SqlServerTransportStore store) |
| | | 23 | | { |
| | 3 | 24 | | _options = options.Value; |
| | 3 | 25 | | SqlServerTransportOptionsValidator.ValidateCommon(_options); |
| | 3 | 26 | | _store = store; |
| | 3 | 27 | | } |
| | | 28 | | |
| | | 29 | | /// <inheritdoc /> |
| | | 30 | | public async Task PublishAsync(WorkerJobEnvelope job, CancellationToken cancellationToken = default) |
| | | 31 | | { |
| | 3 | 32 | | ArgumentNullException.ThrowIfNull(job); |
| | | 33 | | |
| | 3 | 34 | | using var activity = AsyncResponseDiagnostics.StartActivity( |
| | 3 | 35 | | "asyncresponse.worker.publish", |
| | 3 | 36 | | ActivityKind.Producer, |
| | 3 | 37 | | job.CorrelationId); |
| | 3 | 38 | | activity?.SetTag("asyncresponse.transport", "sqlserver"); |
| | 3 | 39 | | activity?.SetTag("messaging.system", "sqlserver"); |
| | 3 | 40 | | activity?.SetTag("messaging.destination.name", _options.WorkerQueue); |
| | 3 | 41 | | AsyncResponseDiagnostics.SetReplyTarget(activity, job.ReplyTarget); |
| | 3 | 42 | | AsyncResponseDiagnostics.SetWorker(activity, job.Call); |
| | | 43 | | |
| | | 44 | | try |
| | | 45 | | { |
| | 3 | 46 | | var headers = string.IsNullOrWhiteSpace(job.CorrelationId) |
| | 3 | 47 | | ? null |
| | 3 | 48 | | : new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase) |
| | 3 | 49 | | { |
| | 3 | 50 | | [_options.CorrelationIdHeader] = job.CorrelationId! |
| | 3 | 51 | | }; |
| | | 52 | | |
| | 3 | 53 | | var payload = AsyncResponseJson.Serialize(job); |
| | | 54 | | // Stable id outside the retry loop so a retried publish is idempotent rather than enqueuing |
| | | 55 | | // the same worker job twice. |
| | 3 | 56 | | var messageId = Guid.NewGuid(); |
| | 3 | 57 | | await SqlServerTransportRetry.ExecuteAsync( |
| | 3 | 58 | | async token => |
| | 3 | 59 | | { |
| | 3 | 60 | | await _store.PublishAsync(messageId, _options.WorkerQueue, payload, headers, token).ConfigureAwait(f |
| | 1 | 61 | | return true; |
| | 1 | 62 | | }, |
| | 3 | 63 | | _options.PublishMaxAttempts, |
| | 3 | 64 | | _options.PublishRetryBaseDelay, |
| | 3 | 65 | | _options.PublishRetryMaxDelay, |
| | 3 | 66 | | cancellationToken).ConfigureAwait(false); |
| | 1 | 67 | | } |
| | 3 | 68 | | catch (Exception ex) |
| | | 69 | | { |
| | 3 | 70 | | AsyncResponseDiagnostics.SetError(activity, ex); |
| | 3 | 71 | | throw; |
| | | 72 | | } |
| | 1 | 73 | | } |
| | | 74 | | } |
| | | 75 | | |
| | | 76 | | internal static class SqlServerTransportRetry |
| | | 77 | | { |
| | | 78 | | public static Task<T> ExecuteAsync<T>( |
| | | 79 | | Func<CancellationToken, Task<T>> action, |
| | | 80 | | int maxAttempts, |
| | | 81 | | TimeSpan baseDelay, |
| | | 82 | | TimeSpan maxDelay, |
| | | 83 | | CancellationToken cancellationToken) |
| | | 84 | | => AsyncResponseRetry.ExecuteAsync(action, IsTransient, maxAttempts, baseDelay, maxDelay, cancellationToken); |
| | | 85 | | |
| | | 86 | | public static bool IsTransient(Exception exception) |
| | | 87 | | => exception is not OperationCanceledException |
| | | 88 | | && (exception is SqlException sqlException && SqlServerTransientFaults.IsTransient(sqlException) |
| | | 89 | | || exception is TimeoutException); |
| | | 90 | | } |
| | | 91 | | |
| | | 92 | | /// <summary> |
| | | 93 | | /// Classifies SQL Server errors worth retrying. <see cref="SqlException"/> exposes no public |
| | | 94 | | /// transient flag, so this mirrors the error numbers Microsoft's own retry guidance and the |
| | | 95 | | /// SqlClient configurable-retry defaults treat as transient, plus severity ≥ 20 (broken connection). |
| | | 96 | | /// </summary> |
| | | 97 | | internal static class SqlServerTransientFaults |
| | | 98 | | { |
| | | 99 | | private static readonly HashSet<int> TransientErrorNumbers = |
| | | 100 | | [ |
| | | 101 | | -2, // client-side command timeout |
| | | 102 | | 20, // instance does not support encryption |
| | | 103 | | 64, // connection lost during login |
| | | 104 | | 121, // transport semaphore timeout |
| | | 105 | | 233, // no process on the other end of the pipe |
| | | 106 | | 997, // overlapped I/O in progress |
| | | 107 | | 1204, // lock resources exhausted |
| | | 108 | | 1205, // deadlock victim |
| | | 109 | | 1222, // lock request timeout |
| | | 110 | | 4060, // database unavailable |
| | | 111 | | 4221, // readable secondary timeout |
| | | 112 | | 10053, // transport-level connection abort |
| | | 113 | | 10054, // transport-level connection reset |
| | | 114 | | 10060, // network unreachable / connect timeout |
| | | 115 | | 10928, // Azure SQL resource limit reached |
| | | 116 | | 10929, // Azure SQL minimum guarantee exceeded |
| | | 117 | | 40143, // Azure SQL connection failure |
| | | 118 | | 40197, // Azure SQL service processing error |
| | | 119 | | 40501, // Azure SQL service busy |
| | | 120 | | 40540, // Azure SQL service unavailable |
| | | 121 | | 40613, // Azure SQL database unavailable |
| | | 122 | | 49918, // cannot process request, not enough resources |
| | | 123 | | 49919, // cannot process create/update request |
| | | 124 | | 49920 // cannot process request, too many operations |
| | | 125 | | ]; |
| | | 126 | | |
| | | 127 | | public static bool IsTransient(SqlException exception) |
| | | 128 | | { |
| | | 129 | | if (exception.Class >= 20) |
| | | 130 | | return true; |
| | | 131 | | |
| | | 132 | | foreach (SqlError error in exception.Errors) |
| | | 133 | | { |
| | | 134 | | if (TransientErrorNumbers.Contains(error.Number)) |
| | | 135 | | return true; |
| | | 136 | | } |
| | | 137 | | |
| | | 138 | | return TransientErrorNumbers.Contains(exception.Number); |
| | | 139 | | } |
| | | 140 | | } |