Skip to content

CHANGELOG.md

Latest commit

 

History

History
53 lines (37 loc) · 2.67 KB

CHANGELOG.md

File metadata and controls

53 lines (37 loc) · 2.67 KB
Raw

Changelog

All notable changes to the Streamkit project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Fixed

  • Client: NewClientWithRetryPolicy() now correctly uses the provided retry policy instead of ignoring it
  • Client: Added ±25% jitter to exponential backoff to prevent thundering herd on mass reconnects
  • Client: Improved IsRetryable() to exclude permanent errors (auth failures, not found, invalid arguments)
  • Client: Enhanced offset resume in resilience enumerator:
    • ConsumeSpace now increments timestamp by 1ns to avoid duplicate entries
    • Consume now updates offset map with last seen sequence per space/segment pair
    • Added debug logging for offset updates

Documentation

Operational contracts

Documented production behavior (see docs/limitations.md):

Client (pkg/client)

  1. Lock map growth — Per-segment produce locks accumulate without automatic eviction.

    • Impact: Not an issue for typical workloads (<10,000 active segments); high-churn scenarios (millions of unique segment keys) may see gradual memory growth.
    • Mitigation: Monitor segment cardinality; recycle long-lived client processes if needed. LRU eviction is on the roadmap.

  2. Consumption deduplication — Delivery is at-least-once; resilience enumerators resume from last consumed position when possible.

    • Impact: Rare duplicates under concurrent producers or clock skew.
    • Mitigation: Dedupe on Entry.Sequence at the application layer for exactly-once business semantics.

  3. Subscription lifecycle — Retryable failures stay in the reconnect loop; permanent errors stop the subscription and remove it from the client registry.

    • Impact: Applications must resubscribe after permanent errors.
    • Contract: Reconnect delivers latest snapshot → live updates. Durable replay/cursors are not part of the subscription API.

Roadmap

  • Lock map cleanup/LRU eviction for high-churn segment scenarios
  • Subscription failure callback: OnSubscriptionFailed(id string, err error)
  • Enhanced observability: Prometheus metrics for client operations
  • Batch API for high-throughput produces
  • Expanded consume reconnect guidance and benchmarks

Version History

See GitHub Releases for tagged versions published to the Go module proxy.