RedisIdempotencyStore

Defined in: packages/pipeline-idempotency/src/stores/redis.store.ts:76

IdempotencyStore backed by Redis (node-redis) — a drop-in replacement for the memory store that shares state across instances.

Atomicity comes from Redis itself: setIfAbsent issues SET key value PX <ttl> NX, which sets the key only if it does not already exist and returns null otherwise. Owner-aware completion and release use Lua scripts so a stale execution cannot overwrite/delete a newer claim. TTL is enforced by Redis, so expired keys never linger.

A stored value that is not valid JSON fails closed: get throws, and the owner-aware writes cannot prove ownership of it, so they leave it untouched and return false.

Example

import { createClient } from 'redis';
const client = createClient({ url: process.env.REDIS_URL });
await client.connect();
const store = new RedisIdempotencyStore(client);

Implements

IdempotencyStore

Constructors

Constructor

new RedisIdempotencyStore(client, options?): RedisIdempotencyStore

Defined in: packages/pipeline-idempotency/src/stores/redis.store.ts:79

Parameters

client

RedisClientLike

options?

RedisIdempotencyStoreOptions = {}

Returns

RedisIdempotencyStore

Methods

completeIfOwned()

completeIfOwned(key, claimId, record, ttlMs): Promise<boolean>

Defined in: packages/pipeline-idempotency/src/stores/redis.store.ts:104

Atomically replaces the live in_progress record with record only when the existing record is still owned by claimId.

Parameters

key

string

claimId

string

record

IdempotencyRecord

ttlMs

number

Returns

Promise<boolean>

true when this claim completed its own record; false when the claim expired, was replaced, or was otherwise no longer owned by the caller.

Implementation of

IdempotencyStore.completeIfOwned

delete()

delete(key): Promise<void>

Defined in: packages/pipeline-idempotency/src/stores/redis.store.ts:135

Unconditional delete for administrative or custom use. Pipeline failure release uses deleteIfOwned, not this method.

Parameters

key

string

Returns

Promise<void>

Implementation of

IdempotencyStore.delete

deleteIfOwned()

deleteIfOwned(key, claimId): Promise<boolean>

Defined in: packages/pipeline-idempotency/src/stores/redis.store.ts:117

Atomically removes the live record only when it is still owned by claimId. Used by releaseOnError so a stale failure cannot delete a newer execution’s claim.