Breaking change: This version introduces a new Redis data structure for storing entitlement data. This change enables support for credit entitlements at high scale.
What changed
- The Redis data structure now stores entitlements in a polymorphic format that supports both boolean and credit-based entitlements
- Credit features are now properly linked to their credit entitlements
Why this matters
If you deploy persistent-cache-service v3.0.0 before upgrading all SDK/sidecar instances:- Older versions will misinterpret the new data structure
- Entitlement checks may return incorrect results
- This could affect your customers’ access to features
Migration steps
You must follow this upgrade sequence:- Upgrade your SDK or Sidecar to the minimum required versions (upgrade whichever you use):
@stigg/node-server-sdk→ v4.12.1 or later- sidecar-service → v5.194.5 or later
- Deploy all updated services — ensure all SDK and/or sidecar instances are running the new version
- Deploy persistent-cache-service v3.0.0 — only after step 2 is complete
- Added in-memory and persistent credit balance cache support to the SDK.
- Credit balances now automatically update on grant and consumption events.
- Entitlement evaluation uses the cached credit balance for faster checks.
