Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a26777ca21 | |||
| 7ff43afe52 | |||
| 81d35b5645 | |||
| 33f4b80ff8 |
@@ -0,0 +1,26 @@
|
|||||||
|
# HrynCo.RabbitMq Agent Rules
|
||||||
|
|
||||||
|
## Git workflow
|
||||||
|
|
||||||
|
- Treat `main` as the only default and integration branch for this repository.
|
||||||
|
- Start every task branch from the latest `origin/main`.
|
||||||
|
- Before creating a task branch, fetch the remote, switch to `main`, and fast-forward it from `origin/main`.
|
||||||
|
- Create the task branch only after confirming that local `main` matches `origin/main`.
|
||||||
|
- Open pull requests from the task branch into `main`.
|
||||||
|
- Do not use `development` as the base or pull-request target for new work in this repository.
|
||||||
|
- Do not commit, push, publish a NuGet package, or merge unless the repository owner explicitly requests that step.
|
||||||
|
|
||||||
|
Recommended branch preparation:
|
||||||
|
|
||||||
|
```text
|
||||||
|
git fetch origin
|
||||||
|
git switch main
|
||||||
|
git pull --ff-only origin main
|
||||||
|
git switch -c <task-branch>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Delivery
|
||||||
|
|
||||||
|
- Keep changes focused and backward compatible where practical because this repository produces a shared NuGet package.
|
||||||
|
- Run the solution tests before handoff.
|
||||||
|
- Use Conventional Commit messages with a lowercase subject and finish the commit body with `Ref: <issue-id>` when an issue exists.
|
||||||
@@ -57,6 +57,33 @@ public sealed class RabbitMqConsumerBaseExtensionTests
|
|||||||
error.Should().BeNull();
|
error.Should().BeNull();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task RetriesExhaustedHook_ReceivesMessageContextAndTerminalException()
|
||||||
|
{
|
||||||
|
var consumer = new TerminalFailureConsumer(CreateOptions());
|
||||||
|
var message = CreateMessage();
|
||||||
|
var exception = new InvalidOperationException("terminal failure");
|
||||||
|
|
||||||
|
await consumer.InvokeRetriesExhaustedAsync(message, Context, exception);
|
||||||
|
|
||||||
|
consumer.FailedMessage.Should().BeSameAs(message);
|
||||||
|
consumer.FailedContext.Should().BeSameAs(Context);
|
||||||
|
consumer.TerminalException.Should().BeSameAs(exception);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task RetriesExhaustedHook_IsNoOpByDefault()
|
||||||
|
{
|
||||||
|
var consumer = new LegacyConsumer(CreateOptions());
|
||||||
|
|
||||||
|
Func<Task> act = () => consumer.InvokeRetriesExhaustedAsync(
|
||||||
|
CreateMessage(),
|
||||||
|
Context,
|
||||||
|
new InvalidOperationException("terminal failure"));
|
||||||
|
|
||||||
|
await act.Should().NotThrowAsync();
|
||||||
|
}
|
||||||
|
|
||||||
private static TestMessage CreateMessage() => new()
|
private static TestMessage CreateMessage() => new()
|
||||||
{
|
{
|
||||||
CorrelationContext = new CorrelationContext { CorrelationId = "payload-correlation" },
|
CorrelationContext = new CorrelationContext { CorrelationId = "payload-correlation" },
|
||||||
@@ -117,6 +144,51 @@ public sealed class RabbitMqConsumerBaseExtensionTests
|
|||||||
{
|
{
|
||||||
return TryValidateMessage(message, context, out error);
|
return TryValidateMessage(message, context, out error);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public Task InvokeRetriesExhaustedAsync(
|
||||||
|
TestMessage message,
|
||||||
|
RabbitMqMessageContext context,
|
||||||
|
Exception exception)
|
||||||
|
{
|
||||||
|
return HandleMessageRetriesExhaustedAsync(
|
||||||
|
message,
|
||||||
|
context,
|
||||||
|
exception,
|
||||||
|
CancellationToken.None);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private sealed class TerminalFailureConsumer(IOptionsMonitor<RabbitMqSettings> options)
|
||||||
|
: RabbitMqConsumerBase<TestMessage, string>(options, NullLogger.Instance)
|
||||||
|
{
|
||||||
|
protected override string QueueName => "messages.test";
|
||||||
|
public TestMessage? FailedMessage { get; private set; }
|
||||||
|
public RabbitMqMessageContext? FailedContext { get; private set; }
|
||||||
|
public Exception? TerminalException { get; private set; }
|
||||||
|
|
||||||
|
protected override Task HandleMessageRetriesExhaustedAsync(
|
||||||
|
TestMessage message,
|
||||||
|
RabbitMqMessageContext context,
|
||||||
|
Exception exception,
|
||||||
|
CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
FailedMessage = message;
|
||||||
|
FailedContext = context;
|
||||||
|
TerminalException = exception;
|
||||||
|
return Task.CompletedTask;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Task InvokeRetriesExhaustedAsync(
|
||||||
|
TestMessage message,
|
||||||
|
RabbitMqMessageContext context,
|
||||||
|
Exception exception)
|
||||||
|
{
|
||||||
|
return HandleMessageRetriesExhaustedAsync(
|
||||||
|
message,
|
||||||
|
context,
|
||||||
|
exception,
|
||||||
|
CancellationToken.None);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private sealed record TestMessage : IRabbitMqMessage<string>
|
private sealed record TestMessage : IRabbitMqMessage<string>
|
||||||
|
|||||||
@@ -1,27 +1,27 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<TargetFramework>net10.0</TargetFramework>
|
<TargetFramework>net10.0</TargetFramework>
|
||||||
<ImplicitUsings>disable</ImplicitUsings>
|
<ImplicitUsings>disable</ImplicitUsings>
|
||||||
<Nullable>enable</Nullable>
|
<Nullable>enable</Nullable>
|
||||||
<RootNamespace>Hrynco.RabbitMq</RootNamespace>
|
<RootNamespace>Hrynco.RabbitMq</RootNamespace>
|
||||||
<PackageId>HrynCo.RabbitMq</PackageId>
|
<PackageId>HrynCo.RabbitMq</PackageId>
|
||||||
<Authors>HrynCo</Authors>
|
<Authors>HrynCo</Authors>
|
||||||
<Description>RabbitMQ publisher and consumer base for HrynCo applications.</Description>
|
<Description>RabbitMQ publisher and consumer base for HrynCo applications.</Description>
|
||||||
<PackageTags>hrynco rabbitmq messaging</PackageTags>
|
<PackageTags>hrynco rabbitmq messaging</PackageTags>
|
||||||
<RepositoryType>git</RepositoryType>
|
<RepositoryType>git</RepositoryType>
|
||||||
<RepositoryUrl>https://gitea.grynco.com.ua/hrynco/hrynco-rabbitmq.git</RepositoryUrl>
|
<RepositoryUrl>https://gitea.hrynco.com/hrynco/hrynco-rabbitmq.git</RepositoryUrl>
|
||||||
<PackageReadmeFile>README.md</PackageReadmeFile>
|
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="RabbitMQ.Client" Version="7.2.1"/>
|
<PackageReference Include="RabbitMQ.Client" Version="7.2.1"/>
|
||||||
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="10.0.0"/>
|
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="10.0.0"/>
|
||||||
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.0"/>
|
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.0"/>
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<None Include="README.md" Pack="true" PackagePath=""/>
|
<None Include="README.md" Pack="true" PackagePath=""/>
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
|
|||||||
+36
-27
@@ -1,27 +1,36 @@
|
|||||||
# HrynCo.RabbitMq
|
# HrynCo.RabbitMq
|
||||||
|
|
||||||
RabbitMQ publisher and consumer base for HrynCo applications.
|
RabbitMQ publisher and consumer base for HrynCo applications.
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
- `RabbitMqSettings` — connection settings record (host, port, user, password, virtual host)
|
- `RabbitMqSettings` — connection settings record (host, port, user, password, virtual host)
|
||||||
- `IRabbitMqPublisher` / `RabbitMqPublisher` — publishes JSON-serialized messages to a named queue
|
- `IRabbitMqPublisher` / `RabbitMqPublisher` — publishes JSON-serialized messages to a named queue
|
||||||
- `RabbitMqConsumerBase<TMessage, TMessageData>` — background service base with connection management, manual ACK/NACK, retry, permanent-validation rejection, and backward-compatible context-aware handling
|
- `RabbitMqConsumerBase<TMessage, TMessageData>` — background service base with connection management, manual ACK/NACK, retry, permanent-validation rejection, and backward-compatible context-aware handling
|
||||||
- `RabbitMqMessageContext` — neutral AMQP delivery metadata (`MessageId`, type, correlation, routing, headers, and redelivery state)
|
- `RabbitMqMessageContext` — neutral AMQP delivery metadata (`MessageId`, type, correlation, routing, headers, and redelivery state)
|
||||||
- `IRabbitMqMessage<TMessageData>` — message contract interface
|
- `IRabbitMqMessage<TMessageData>` — message contract interface
|
||||||
- `CorrelationContext` — correlation ID carrier
|
- `CorrelationContext` — correlation ID carrier
|
||||||
|
|
||||||
## Packaging
|
## Packaging
|
||||||
|
|
||||||
This package is intended for reuse through NuGet. The test project is excluded from packing.
|
This package is intended for reuse through NuGet. The test project is excluded from packing.
|
||||||
|
|
||||||
## Consumer extension points
|
## Consumer extension points
|
||||||
|
|
||||||
Existing consumers can keep overriding `HandleMessageAsync(message, cancellationToken)`.
|
Existing consumers can keep overriding `HandleMessageAsync(message, cancellationToken)`.
|
||||||
Consumers that need AMQP metadata can instead override
|
Consumers that need AMQP metadata can instead override
|
||||||
`HandleMessageAsync(message, context, cancellationToken)`. The base class retains
|
`HandleMessageAsync(message, context, cancellationToken)`. The base class retains
|
||||||
ownership of acknowledgements and retries.
|
ownership of acknowledgements and retries.
|
||||||
|
|
||||||
Override `TryValidateMessage(...)` for application-specific permanent validation.
|
Override `TryValidateMessage(...)` for application-specific permanent validation.
|
||||||
Returning `false` nacks the delivery without requeue before retry processing begins.
|
Returning `false` nacks the delivery without requeue before retry processing begins.
|
||||||
Keep validation errors free of credentials and sensitive payload values.
|
Keep validation errors free of credentials and sensitive payload values.
|
||||||
|
|
||||||
|
Override `HandleMessageRetriesExhaustedAsync(...)` when a consumer must react once to a
|
||||||
|
terminal processing failure, for example by publishing a neutral failure result to the
|
||||||
|
requesting client. The hook runs after the final handler exception and before the original
|
||||||
|
delivery is nacked without requeue. Hook failures are logged and do not replace the
|
||||||
|
original failure or acknowledgement policy. Application shutdown cancellation does not
|
||||||
|
invoke the hook.
|
||||||
|
|
||||||
|
Package repository metadata points to [HrynCo.RabbitMq on Gitea](https://gitea.hrynco.com/hrynco/hrynco-rabbitmq). The hostname change does not alter package versions or messaging behavior.
|
||||||
|
|||||||
@@ -82,6 +82,20 @@ public abstract class RabbitMqConsumerBase<TMessage, TMessageData> : BackgroundS
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Handles a terminal processing failure after all message retries are exhausted.
|
||||||
|
/// The default implementation is a no-op. Implementations should avoid throwing;
|
||||||
|
/// failures from this hook are logged and the original message is still nacked.
|
||||||
|
/// </summary>
|
||||||
|
protected virtual Task HandleMessageRetriesExhaustedAsync(
|
||||||
|
TMessage message,
|
||||||
|
RabbitMqMessageContext context,
|
||||||
|
Exception exception,
|
||||||
|
CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
return Task.CompletedTask;
|
||||||
|
}
|
||||||
|
|
||||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||||
{
|
{
|
||||||
await EnsureConnectionAsync(stoppingToken);
|
await EnsureConnectionAsync(stoppingToken);
|
||||||
@@ -155,6 +169,10 @@ public abstract class RabbitMqConsumerBase<TMessage, TMessageData> : BackgroundS
|
|||||||
await _channel!.BasicAckAsync(args.DeliveryTag, multiple: false, cancellationToken: cancellationToken);
|
await _channel!.BasicAckAsync(args.DeliveryTag, multiple: false, cancellationToken: cancellationToken);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
|
||||||
|
{
|
||||||
|
throw;
|
||||||
|
}
|
||||||
catch (Exception ex) when (attempt < MaxRetries)
|
catch (Exception ex) when (attempt < MaxRetries)
|
||||||
{
|
{
|
||||||
_logger.LogWarning(ex,
|
_logger.LogWarning(ex,
|
||||||
@@ -169,6 +187,23 @@ public abstract class RabbitMqConsumerBase<TMessage, TMessageData> : BackgroundS
|
|||||||
"All {Max} attempts exhausted for message on queue {Queue} [CorrelationId={CorrelationId}] — nacking without requeue",
|
"All {Max} attempts exhausted for message on queue {Queue} [CorrelationId={CorrelationId}] — nacking without requeue",
|
||||||
MaxRetries, QueueName, payloadCorrelationId);
|
MaxRetries, QueueName, payloadCorrelationId);
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
await HandleMessageRetriesExhaustedAsync(
|
||||||
|
message,
|
||||||
|
context,
|
||||||
|
ex,
|
||||||
|
cancellationToken);
|
||||||
|
}
|
||||||
|
catch (Exception hookException)
|
||||||
|
{
|
||||||
|
_logger.LogError(
|
||||||
|
hookException,
|
||||||
|
"Terminal failure hook failed for message on queue {Queue} [CorrelationId={CorrelationId}]",
|
||||||
|
QueueName,
|
||||||
|
payloadCorrelationId);
|
||||||
|
}
|
||||||
|
|
||||||
await NackWithoutRequeueAsync(args.DeliveryTag, cancellationToken);
|
await NackWithoutRequeueAsync(args.DeliveryTag, cancellationToken);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user