| | | 1 | | using Microsoft.Extensions.Hosting; |
| | | 2 | | using Microsoft.Extensions.Logging; |
| | | 3 | | using Microsoft.Extensions.Options; |
| | | 4 | | using System.Text; |
| | | 5 | | |
| | | 6 | | namespace AsyncResponse.Transports.RabbitMQ; |
| | | 7 | | |
| | | 8 | | internal abstract class RabbitMqSubscriberService : BackgroundService |
| | | 9 | | { |
| | | 10 | | private readonly IRabbitMqConnectionFactory _connectionFactory; |
| | | 11 | | |
| | | 12 | | /// <summary>Runs the RabbitMqSubscriberService operation.</summary> |
| | | 13 | | protected RabbitMqSubscriberService( |
| | | 14 | | IOptions<RabbitMqAsyncResponseOptions> options, |
| | | 15 | | ILogger logger) |
| | 3 | 16 | | : this(options, logger, new RabbitMqConnectionFactoryAdapter(options.Value)) |
| | | 17 | | { |
| | 3 | 18 | | } |
| | | 19 | | |
| | | 20 | | /// <summary>Runs the RabbitMqSubscriberService operation.</summary> |
| | 3 | 21 | | protected RabbitMqSubscriberService( |
| | 3 | 22 | | IOptions<RabbitMqAsyncResponseOptions> options, |
| | 3 | 23 | | ILogger logger, |
| | 3 | 24 | | IRabbitMqConnectionFactory connectionFactory) |
| | | 25 | | { |
| | 3 | 26 | | Options = options.Value; |
| | 3 | 27 | | Logger = logger; |
| | 3 | 28 | | _connectionFactory = connectionFactory; |
| | 3 | 29 | | } |
| | | 30 | | |
| | | 31 | | protected RabbitMqAsyncResponseOptions Options { get; } |
| | | 32 | | protected ILogger Logger { get; } |
| | | 33 | | |
| | | 34 | | protected abstract string QueueName { get; } |
| | | 35 | | protected abstract RabbitMqSubscriberOptions SubscriberOptions { get; } |
| | | 36 | | protected abstract RabbitMqSubscriberRole SubscriberRole { get; } |
| | | 37 | | /// <summary>Ensures the required resource exists.</summary> |
| | | 38 | | protected abstract Task EnsureTopologyAsync(IRabbitMqChannel channel, CancellationToken cancellationToken); |
| | | 39 | | /// <summary>Handles the delivered message.</summary> |
| | | 40 | | protected abstract Task HandleMessageAsync(RabbitMqDelivery delivery, CancellationToken cancellationToken); |
| | | 41 | | |
| | | 42 | | /// <summary>Runs this background operation until cancellation is requested.</summary> |
| | | 43 | | protected override async Task ExecuteAsync(CancellationToken stoppingToken) |
| | | 44 | | { |
| | 3 | 45 | | var queue = QueueName; |
| | 3 | 46 | | RabbitMqMessageDispatcher.ValidateOptions(Options, SubscriberOptions, SubscriberRole); |
| | | 47 | | |
| | | 48 | | // basic.nack requeue does not increment the x-death header, so the resolved attempt for a plain |
| | | 49 | | // requeued delivery never exceeds 2. Warn once at startup instead of silently never enforcing the cap. |
| | 3 | 50 | | if (SubscriberOptions.AckMode is RabbitMqAckMode.AckAfterHandlerCompletes |
| | 3 | 51 | | && SubscriberOptions.MaxDeliveryAttempts > 2) |
| | | 52 | | { |
| | 0 | 53 | | Logger.LogWarning( |
| | 0 | 54 | | "RabbitMQ {OptionName} is {MaxDeliveryAttempts} for queue {Queue} ({Role}), but attempts beyond 2 cannot |
| | 0 | 55 | | + "basic.nack requeue does not increment x-death, so the cap only takes effect once a TTL-retry dead-let |
| | 0 | 56 | | + "re-delivers the message through a dead-letter exchange.", |
| | 0 | 57 | | nameof(RabbitMqSubscriberOptions.MaxDeliveryAttempts), |
| | 0 | 58 | | SubscriberOptions.MaxDeliveryAttempts, |
| | 0 | 59 | | queue, |
| | 0 | 60 | | SubscriberRole); |
| | | 61 | | } |
| | | 62 | | |
| | 3 | 63 | | while (!stoppingToken.IsCancellationRequested) |
| | | 64 | | { |
| | | 65 | | try |
| | | 66 | | { |
| | 3 | 67 | | await RunSubscriberAsync(queue, stoppingToken).ConfigureAwait(false); |
| | 3 | 68 | | return; |
| | | 69 | | } |
| | 3 | 70 | | catch (OperationCanceledException) when (stoppingToken.IsCancellationRequested) |
| | | 71 | | { |
| | 3 | 72 | | return; |
| | | 73 | | } |
| | 3 | 74 | | catch (Exception ex) when (!stoppingToken.IsCancellationRequested) |
| | | 75 | | { |
| | 2 | 76 | | var retryDelay = Options.NetworkRecoveryInterval > TimeSpan.Zero |
| | 2 | 77 | | ? Options.NetworkRecoveryInterval |
| | 2 | 78 | | : TimeSpan.FromSeconds(5); |
| | 2 | 79 | | Logger.LogWarning( |
| | 2 | 80 | | ex, |
| | 2 | 81 | | "RabbitMQ subscriber could not start for queue {Queue} ({Role}); retrying in {RetryDelay}.", |
| | 2 | 82 | | queue, |
| | 2 | 83 | | SubscriberRole, |
| | 2 | 84 | | retryDelay); |
| | 2 | 85 | | await Task.Delay(retryDelay, stoppingToken).ConfigureAwait(false); |
| | | 86 | | } |
| | | 87 | | } |
| | 3 | 88 | | } |
| | | 89 | | |
| | | 90 | | private async Task RunSubscriberAsync(string queue, CancellationToken stoppingToken) |
| | | 91 | | { |
| | 3 | 92 | | await using var connection = await _connectionFactory.CreateConnectionAsync(stoppingToken).ConfigureAwait(false) |
| | 3 | 93 | | await using var channel = await connection.CreateChannelAsync(cancellationToken: stoppingToken).ConfigureAwait(f |
| | 3 | 94 | | await EnsureTopologyAsync(channel, stoppingToken).ConfigureAwait(false); |
| | 3 | 95 | | await channel.BasicQosAsync(SubscriberOptions.PrefetchCount, stoppingToken).ConfigureAwait(false); |
| | | 96 | | |
| | 3 | 97 | | await using var dispatcher = RabbitMqMessageDispatcher.Create( |
| | 3 | 98 | | HandleMessageAsync, |
| | 3 | 99 | | Options, |
| | 3 | 100 | | SubscriberOptions, |
| | 3 | 101 | | Logger, |
| | 3 | 102 | | queue, |
| | 3 | 103 | | SubscriberRole); |
| | | 104 | | |
| | 3 | 105 | | Logger.LogInformation( |
| | 3 | 106 | | "RabbitMQ subscriber started. Queue: {Queue}. Role: {Role}. AckMode: {AckMode}.", |
| | 3 | 107 | | queue, |
| | 3 | 108 | | SubscriberRole, |
| | 3 | 109 | | SubscriberOptions.AckMode); |
| | | 110 | | |
| | 3 | 111 | | var consumerTag = await channel.BasicConsumeAsync( |
| | 3 | 112 | | queue, |
| | 3 | 113 | | delivery => dispatcher.HandleAsync(delivery, channel, stoppingToken), |
| | 3 | 114 | | stoppingToken).ConfigureAwait(false); |
| | | 115 | | |
| | | 116 | | try |
| | | 117 | | { |
| | 3 | 118 | | await Task.Delay(Timeout.InfiniteTimeSpan, stoppingToken).ConfigureAwait(false); |
| | 1 | 119 | | } |
| | 3 | 120 | | catch (OperationCanceledException) when (stoppingToken.IsCancellationRequested) |
| | | 121 | | { |
| | 3 | 122 | | using var shutdown = new CancellationTokenSource(Options.ShutdownTimeout); |
| | 3 | 123 | | await channel.BasicCancelAsync(consumerTag, shutdown.Token).ConfigureAwait(false); |
| | 2 | 124 | | await channel.CloseAsync(shutdown.Token).ConfigureAwait(false); |
| | 2 | 125 | | await connection.CloseAsync(Options.ShutdownTimeout, shutdown.Token).ConfigureAwait(false); |
| | 3 | 126 | | } |
| | 3 | 127 | | } |
| | | 128 | | } |
| | | 129 | | |
| | | 130 | | internal sealed class RabbitMqWorkerSubscriber : RabbitMqSubscriberService |
| | | 131 | | { |
| | | 132 | | private readonly IAsyncResponseIngress _ingress; |
| | | 133 | | |
| | | 134 | | /// <summary>Runs the RabbitMqWorkerSubscriber operation.</summary> |
| | | 135 | | public RabbitMqWorkerSubscriber( |
| | | 136 | | IOptions<RabbitMqAsyncResponseOptions> options, |
| | | 137 | | IAsyncResponseIngress ingress, |
| | | 138 | | ILogger<RabbitMqWorkerSubscriber> logger) |
| | | 139 | | : base(options, logger) |
| | | 140 | | { |
| | | 141 | | _ingress = ingress; |
| | | 142 | | } |
| | | 143 | | |
| | | 144 | | internal RabbitMqWorkerSubscriber( |
| | | 145 | | IOptions<RabbitMqAsyncResponseOptions> options, |
| | | 146 | | IAsyncResponseIngress ingress, |
| | | 147 | | ILogger<RabbitMqWorkerSubscriber> logger, |
| | | 148 | | IRabbitMqConnectionFactory connectionFactory) |
| | | 149 | | : base(options, logger, connectionFactory) |
| | | 150 | | { |
| | | 151 | | _ingress = ingress; |
| | | 152 | | } |
| | | 153 | | |
| | | 154 | | protected override string QueueName |
| | | 155 | | => RabbitMqOptionsValidator.Required(Options.WorkerQueue, nameof(Options.WorkerQueue)); |
| | | 156 | | |
| | | 157 | | protected override RabbitMqSubscriberOptions SubscriberOptions => Options.WorkerSubscriber; |
| | | 158 | | protected override RabbitMqSubscriberRole SubscriberRole => RabbitMqSubscriberRole.Worker; |
| | | 159 | | |
| | | 160 | | /// <summary>Ensures the required resource exists.</summary> |
| | | 161 | | protected override Task EnsureTopologyAsync(IRabbitMqChannel channel, CancellationToken cancellationToken) |
| | | 162 | | => RabbitMqTopology.EnsureWorkerAsync(channel, Options, cancellationToken); |
| | | 163 | | |
| | | 164 | | /// <summary>Handles the delivered message.</summary> |
| | | 165 | | protected override Task HandleMessageAsync(RabbitMqDelivery delivery, CancellationToken cancellationToken) |
| | | 166 | | => _ingress.HandleWorkerMessageAsync(Encoding.UTF8.GetString(delivery.Body.Span)); |
| | | 167 | | } |
| | | 168 | | |
| | | 169 | | internal sealed class RabbitMqResponseIngressSubscriber : RabbitMqSubscriberService |
| | | 170 | | { |
| | | 171 | | private readonly IAsyncResponseIngress _ingress; |
| | | 172 | | |
| | | 173 | | /// <summary>Runs the RabbitMqResponseIngressSubscriber operation.</summary> |
| | | 174 | | public RabbitMqResponseIngressSubscriber( |
| | | 175 | | IOptions<RabbitMqAsyncResponseOptions> options, |
| | | 176 | | IAsyncResponseIngress ingress, |
| | | 177 | | ILogger<RabbitMqResponseIngressSubscriber> logger) |
| | | 178 | | : base(options, logger) |
| | | 179 | | { |
| | | 180 | | _ingress = ingress; |
| | | 181 | | } |
| | | 182 | | |
| | | 183 | | internal RabbitMqResponseIngressSubscriber( |
| | | 184 | | IOptions<RabbitMqAsyncResponseOptions> options, |
| | | 185 | | IAsyncResponseIngress ingress, |
| | | 186 | | ILogger<RabbitMqResponseIngressSubscriber> logger, |
| | | 187 | | IRabbitMqConnectionFactory connectionFactory) |
| | | 188 | | : base(options, logger, connectionFactory) |
| | | 189 | | { |
| | | 190 | | _ingress = ingress; |
| | | 191 | | } |
| | | 192 | | |
| | | 193 | | protected override string QueueName |
| | | 194 | | => RabbitMqOptionsValidator.Required(Options.ResponseQueue, nameof(Options.ResponseQueue)); |
| | | 195 | | |
| | | 196 | | protected override RabbitMqSubscriberOptions SubscriberOptions => Options.ResponseSubscriber; |
| | | 197 | | protected override RabbitMqSubscriberRole SubscriberRole => RabbitMqSubscriberRole.ResponseIngress; |
| | | 198 | | |
| | | 199 | | /// <summary>Ensures the required resource exists.</summary> |
| | | 200 | | protected override Task EnsureTopologyAsync(IRabbitMqChannel channel, CancellationToken cancellationToken) |
| | | 201 | | => RabbitMqTopology.EnsureResponseAsync(channel, Options, cancellationToken); |
| | | 202 | | |
| | | 203 | | /// <summary>Handles the delivered message.</summary> |
| | | 204 | | protected override Task HandleMessageAsync(RabbitMqDelivery delivery, CancellationToken cancellationToken) |
| | | 205 | | { |
| | | 206 | | var messageJson = Encoding.UTF8.GetString(delivery.Body.Span); |
| | | 207 | | var correlationId = RabbitMqCorrelationIdExtractor.Extract(delivery, messageJson, Options); |
| | | 208 | | return _ingress.HandleResponseMessageAsync(messageJson, correlationId); |
| | | 209 | | } |
| | | 210 | | } |