BabelQueue.Redis 1.1.0

BabelQueue.Redis

Redis transport for BabelQueue — "Polyglot Queues, Simplified." Built on StackExchange.Redis and the framework-agnostic BabelQueue.Core.

A canonical-envelope publisher and a URN-routed consumer, so a Redis-based .NET service speaks the same wire contract (envelope shape, URN identity, trace propagation) as the PHP/Laravel, Python, Go, Node and Java SDKs. Implements §1 of the broker-bindings contract — the reliable-queue list pattern.

Install

dotnet add package BabelQueue.Redis

It pulls BabelQueue.Core and StackExchange.Redis transitively.

Use

using BabelQueue.Redis;
using StackExchange.Redis;

var redis = await ConnectionMultiplexer.ConnectAsync("localhost:6379");
IDatabase db = redis.GetDatabase();

// produce
var id = await new RedisPublisher(db, "orders")
    .PublishAsync("urn:babel:orders:created", new Dictionary<string, object?> { ["order_id"] = 1042 });

// consume
var handlers = new Dictionary<string, BabelHandler>
{
    ["urn:babel:orders:created"] = async (env, rawBody, headers, ct) =>
    {
        // env.Data, env.TraceId, env.Attempts ...; headers carries any out-of-band traceparent
    },
};
var consumer = new RedisConsumer(db, "orders", handlers, new RedisConsumerOptions
{
    OnError = (err, env, raw) => Console.Error.WriteLine(err),
});
await consumer.RunAsync(cancellationToken); // polls until cancelled

Contract mapping (§1)

Unlike the SQS/RabbitMQ bindings, a Redis list element carries no native metadata, so there is no header/attribute projection: the list element is the canonical envelope JSON, byte-for-byte, with no wrapping and no added fields. A consumer in any language pops that same body and decodes it. (The one exception is opt-in out-of-band headers — see OpenTelemetry traceparent propagation — which ride in a transport-owned frame that wraps the bare envelope; a header-less publish still stores the bare envelope byte-for-byte.)

Reservation follows the reliable-queue pattern (mirroring the Go reference): the head of the queue is atomically moved onto a per-queue <queue>:processing list, then removed on ack. A throwing handler leaves the element on the processing list (at-least-once); the poll loop never stops on a bad message — observe via OnError / OnUnknownUrn. The envelope is unchanged (schema_version stays 1); Redis support is purely additive.

Reliable-queue scope. This is a .NET-owned reliable queue: produce/reserve/ack are self-consistent and crash-safe on a queue this SDK owns end-to-end. Full parity with Laravel's reserved-sorted-set reservation on a shared PHP+.NET Redis queue (queues:<name>:reserved scored by retry_after, attempts incremented by the reservation Lua script) is a separate task — see broker-bindings §1.4.

OpenTelemetry traceparent propagation (ADR-0028)

A Redis list element has no native metadata channel, so to carry the active producer span's W3C traceparent for true cross-hop span linkage the transport owns a tiny JSON frame that wraps the bare envelope, beside it (never inside it):

{"__bq_frame":1,"headers":{"traceparent":"00-…"},"body":"<raw wire envelope>"}

RPUSH stores the frame, so the stored value is the LREM ack handle and the reliable-queue semantics are untouched. Framing is opt-in and backward compatible: a header-less publish stores the bare envelope byte-for-byte, and the consumer un-frames a reserved value (a bare value from an older/cross-version publisher still consumes with no headers). The frame is byte-compatible with the Go/PHP Redis frame, so cross-language queues interoperate.

using BabelQueue.Tracing;

// produce: BabelQueue.Core fills the carrier with the active span's traceparent
var headers = new Dictionary<string, string>();
await Telemetry.PublishAsync("urn:babel:orders:created", data, headers,
    env => new RedisPublisher(db, "orders").PublishWithHeadersAsync("urn:babel:orders:created", data, headers));

// consume: the handler receives the un-framed body + headers; wrap to link the span
["urn:babel:orders:created"] = (env, rawBody, headers, ct) =>
    Telemetry.Wrap(async e => { /* ... */ }, headers)(env)

With no traceparent the consumer falls back to the v0.1 trace_id mapping. Requires BabelQueue.Core 1.4.0.

Build & test

dotnet test

IDatabase is an interface, so the unit tests mock it with Moq — no Redis, no network.

License

MIT