Scaffold ByteSize() measuring size estimation for history event cache #6693
Conversation
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
…mpty size estimation function for mutableState and shardContext
72ff3b6 to
e04ef95
Compare
shijiesheng
reviewed
Mar 27, 2025
shijiesheng
approved these changes
Apr 1, 2025
|
change title to scaffold rather than implement |
shijiesheng
reviewed
Apr 1, 2025
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.
What changed?
Scaffold ByteSize() measuring size estimation for history event cache
Also added empty ByteSize() for structs in HistoryEvent
Why?
We want to modernize existing cadence common cache implement to a bytes-based system. That means we need to have a method to measure each entry (which is currently accepting any generic interface). We found the "Reflect" package provides a measuring function but runtime is too slow to be used in cache operations. Therefore, we will require all usages to implement the ByteSize() function in their cache logic if they want to migrate to the new bytes-based system.
In order to seamless transition from the current cache system with an entry-based model, the implementation and rollout will be done in following phases:
Define the Sizeable interface
Implement Sizeable for cadence-history service
a. Implement Size() for ExecutionCache
b. Implement Size() for EventCache <-- This PR
Implement bytes-based cache system
Enable new cache system for usage in cadence-history service
Implement and enable new cache system for the remaining usages
How did you test it?
Unit tests
Potential risks
No risk since this PR only adds read-only function that is not used.
Release notes
Documentation Changes