[Host.AzureServiceBus] Modify user properties on failure / Supply reason and description on dead-letter

[EtherZa]

#358 Added support for suppliying modified user properties with using an ASB transport when using a custom ServiceBusConsumerErrorHandler<T> implemntation and Failure().

public sealed class SampleConsumerErrorHandler<T> : ServiceBusConsumerErrorHandler<T>
{
    public override Task<ProcessResult> OnHandleError(T message, IConsumerContext consumerContext, Exception exception, int attempts)
    {
        var properties = new Dictionary<string, object>
        {
            { "Key", "value" },
            { "Attempts", attempts },
            { "SMB.Exception", exception.ToString().Substring(0, 1000) }
        };

        return Task.FromResult(Failure(properties));
    }
}

---

An option to supply a dead-letter reason/description when sending a message to the DLQ has also been included. If neither a reason nor description are supplied, it will fall back to the original implementation of exception type as the reason and exception message as the description.

public sealed class SampleConsumerErrorHandler<T> : ServiceBusConsumerErrorHandler<T>
{
    public override Task<ProcessResult> OnHandleError(T message, IConsumerContext consumerContext, Exception exception, int attempts)
    {
        return Task.FromResult(DeadLetter("reason", "description"));
    }
}

---

PS. It's great to see that v3 has escaped :)

[zarusz]

Thanks for another great change that resolves #358!

I have a small suggestion for the documentation - once that’s addressed, I’ll be happy to merge.

Yes, v3 is out now! If you need this feature sooner, I can release it as 3.0.1 or a similar patch.

[EtherZa]

Hi @zarusz. The feature would be certainly be useful, but it's no rush if you have other plans/etc for a delayed release.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
85.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[EtherZa]

Hi @zarusz. Is it too late to change my mind on an early release?

I've been told that my team is producing around 100gb of logs a day and reckon that I can reduce it substantially by dynamically changing the logging behaviour on a failure.

[zarusz]

Ok, let me push 3.0.1 today.

[EtherZa]

Fantastic! Thank you very much.

[zarusz]

It has been done: https://www.nuget.org/packages/SlimMessageBus.Host.AzureServiceBus/3.0.1