refactor(sequenceCache): implement explicit CacheState state machine - #727
Merged
Kingsman-99 merged 1 commit intoAug 29, 2026
Conversation
|
@kingsrichie79-cmyk Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #701
Description
This PR refactors the sequence number cache in
src/sequenceCache.tsto use an explicit state machine, replacing the previous implicit flag-based logic. This makes transitions between states fully auditable, strict, and easier to trace, preventing edge cases where the cache could end up in an invalid state.Technical Changes
CacheStateType Union: DefinedCacheStateas'valid' | 'invalidated' | 'refreshing', completely replacing the scattered implicit tracking.SequenceEntry: ConvertedSequenceEntryfrom a basic interface into a class that holds and manages its own internal_state.transition(newState: CacheState)method inSequenceEntryto funnel all state changes through a unified validation check.StateTransitionErrorclass. If an invalid transition is attempted (e.g., trying to transition fromvaliddirectly torefreshingwithout going throughinvalidated), it throws this error immediately.getSequence,invalidate,refresh) was left intact and is fully backward-compatible. Under the hood, they now trigger the correct transitions (e.g.,invalidate()gracefully transitions fromvalid->invalidated->refreshing).Acceptance Criteria Met
CacheStatetype union replaces the implicit boolean flags.transition(newState)function that validates the transition.StateTransitionError.getSequence,invalidate,refresh) remains unchanged.