Repository navigation
feat: add GetOrTrySetFunc to support fallible value loading - #226
Open
AdamMagued wants to merge 1 commit into
Open
AdamMagued wants to merge 1 commit into
AdamMagued wants to merge 1 commit into
Conversation
Add GetOrTrySetFunc to Cache, enabling callers to atomically retrieve or attempt to compute and set an item using a fallible loader function. If the loader function signals cancellation (cancel=true), no item is cached or overwritten, and (nil, false) is returned without caching transient errors. Subsequent calls can re-execute the loader. Fixes jellydator#188
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.
Summary
Adds
GetOrTrySetFunctoCacheto support fallible value computation and loading without caching transient errors or partial failures.Problem
Currently,
GetOrSetFuncexecutes a value factoryfunc() Vand unconditionally inserts the result into the cache. When loading values that may fail (e.g., transient network or database errors), callers must either catch the error outside and manually delete the cached entry or avoidGetOrSetFunc, which can lead to race conditions or caching invalid data.Solution
Introduces
GetOrTrySetFunc(key K, fn func() (V, bool), opts ...Option[K, V]) (*Item[K, V], bool):retrieved=truewithout executingfn.fnis executed under the cache mutex.fnreturnscancel=true, the operation is aborted: no item is inserted or overwritten in the cache, and(nil, false)is returned.fnreturnscancel=false, the item is created, stored with the configured options (such as TTL), and returned with(item, false).Verification
Test_Cache_GetOrTrySetFunccovering successful set, hit without execution, cancellation on cache miss, loader re-execution after cancellation, and expired item handling.go test -v ./...andgo test -race ./....Fixes #188