Skip to main content

Lease

@rotorsoft/act-root

@rotorsoft/act-root / act/src / Lease

Type Alias: Lease

Lease = object

Defined in: libs/act/src/types/reaction.ts:214

Lease information for distributed stream processing.

Leases prevent concurrent processing of the same stream by multiple workers. When a worker acquires a lease, it has exclusive rights to process events for that stream until the lease expires or is acknowledged.

The drain process uses leases to:

  • Prevent race conditions in distributed setups
  • Track processing progress (watermark)
  • Manage retries on failures
  • Balance load between lagging and leading streams

Example​

app.on("acked", (leases) => {
  leases.forEach(lease => {
    console.log(`Processed ${lease.stream} up to event ${lease.at}`);
  });
});

app.on("blocked", (blocked) => {
  blocked.forEach(({ stream, retry, error }) => {
    console.error(`Stream ${stream} blocked after ${retry} retries: ${error}`);
  });
});

See​

Drain for drain cycle results

Properties​

at​

readonly at: number

Defined in: libs/act/src/types/reaction.ts:217

Watermark: last successfully processed event ID

by​

readonly by: string

Defined in: libs/act/src/types/reaction.ts:218

Unique identifier of the lease holder (UUID)

lagging​

readonly lagging: boolean

Defined in: libs/act/src/types/reaction.ts:220

Whether this stream is behind (lagging frontier)

retry​

readonly retry: number

Defined in: libs/act/src/types/reaction.ts:219

Number of retry attempts (0 = first attempt)

source?​

readonly optional source?: string

Defined in: libs/act/src/types/reaction.ts:216

Optional source stream for filtering

stream​

readonly stream: string

Defined in: libs/act/src/types/reaction.ts:215

The target stream name being processed