Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: async cache storing exception fixed #548

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
fix: async cache storing exception fixed
akmalviya03 committed Oct 17, 2024
commit f856dcb515c9f907f3e04f432ed7e47a99e1ebb4
31 changes: 27 additions & 4 deletions pkgs/async/lib/src/async_cache.dart
Original file line number Diff line number Diff line change
@@ -36,6 +36,15 @@ class AsyncCache<T> {
/// Cached results of a previous [fetch] call.
Future<T>? _cachedValueFuture;

/// Whether the cache will keep a future completed with an error.
///
/// If `false`, a non-ephemeral cache will clear the cached future
/// immediately if the future completes with an error, as if the
/// caching was ephemeral.
/// _(Ephemeral caches always clear when the future completes,
/// so this flag has no effect on those.)_
final bool _cacheErrors;

/// Fires when the cache should be considered stale.
Timer? _stale;

@@ -44,14 +53,18 @@ class AsyncCache<T> {
/// The [duration] starts counting after the Future returned by [fetch]
/// completes, or after the Stream returned by `fetchStream` emits a done
/// event.
AsyncCache(Duration duration) : _duration = duration;
/// If [cacheErrors] is `false` the cache will be invalidated if the [Future]
/// returned by the callback completes as an error.
AsyncCache(Duration duration, {bool cacheErrors = true})
: _duration = duration,
_cacheErrors = cacheErrors;

/// Creates a cache that invalidates after an in-flight request is complete.
///
/// An ephemeral cache guarantees that a callback function will only be
/// executed at most once concurrently. This is useful for requests for which
/// data is updated frequently but stale data is acceptable.
AsyncCache.ephemeral() : _duration = null;
AsyncCache.ephemeral(): _duration = null, _cacheErrors = true;

/// Returns a cached value from a previous call to [fetch], or runs [callback]
/// to compute a new one.
@@ -62,8 +75,18 @@ class AsyncCache<T> {
if (_cachedStreamSplitter != null) {
throw StateError('Previously used to cache via `fetchStream`');
}
return _cachedValueFuture ??= callback()
..whenComplete(_startStaleTimer).ignore();
if (_cacheErrors) {
return _cachedValueFuture ??= callback()
..whenComplete(_startStaleTimer).ignore();
} else {
return _cachedValueFuture ??= callback().then((value) {
_startStaleTimer();
return value;
}, onError: (Object error, StackTrace stack) {
invalidate();
throw error;
});
}
}

/// Returns a cached stream from a previous call to [fetchStream], or runs
14 changes: 14 additions & 0 deletions pkgs/async/test/async_cache_test.dart
Original file line number Diff line number Diff line change
@@ -18,6 +18,20 @@ void main() {
cache = AsyncCache(const Duration(hours: 1));
});

test('should not fetch when callback throws exception', () async {
cache = AsyncCache(const Duration(hours: 1), cacheErrors: false);

Future<String> asyncFunctionThatThrows() {
throw Exception();
}

var errorThrowingFuture = cache.fetch(asyncFunctionThatThrows);
await expectLater(errorThrowingFuture, throwsA(isException));

var valueFuture = cache.fetch(() async => 'Success');
expect(await valueFuture, 'Success');
});

test('should fetch via a callback when no cache exists', () async {
expect(await cache.fetch(() async => 'Expensive'), 'Expensive');
});