Skip to content

fix: withConverter #99

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.

Sign up for GitHub

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

Open
imsamgarg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: withConverter #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 44 additions & 14 deletions lib/src/firestore_cache.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import 'exceptions.dart';
/// firestoreCacheField: cacheField,
/// );
/// ```
///
class FirestoreCache {
/// Fetch a document with read from cache first then server.
///
Expand All @@ -43,12 +44,13 @@ class FirestoreCache {
/// This method should only be used if the document you are fetching does not
/// change over time. Once the document is cached, it will always be read from
/// the cache.
static Future<DocumentSnapshot<Map<String, dynamic>>> getDocument(
DocumentReference<Map<String, dynamic>> docRef, {
static Future<DocumentSnapshot<T>> getDocument<T>(
DocumentReference<T> docRef, {
Source source = Source.cache,
bool isRefreshEmptyCache = true,
}) async {
DocumentSnapshot<Map<String, dynamic>> doc;
DocumentSnapshot<T> doc;

try {
doc = await docRef.get(GetOptions(source: source));
if (doc.data() == null && isRefreshEmptyCache) doc = await docRef.get();
Expand Down Expand Up @@ -77,19 +79,31 @@ class FirestoreCache {
/// You can also pass in [localCacheKey] as the key for storing the last local
/// cache date, and [isUpdateCacheDate] to set if it should update the last
/// local cache date to current date and time.
static Future<QuerySnapshot<Map<String, dynamic>>> getDocuments({
required Query<Map<String, dynamic>> query,
required DocumentReference<Map<String, dynamic>> cacheDocRef,
///
/// If you are using firestore collection withConverter then you have to also
/// pass toFirestore method to converter
static Future<QuerySnapshot<T>> getDocuments<T>({
required Query<T> query,
required DocumentReference<T> cacheDocRef,
Copy link
Owner

@zeshuaro zeshuaro May 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can understand the use case for Query<T> then returning QuerySnapshot<T>. But can people simply pass in the default Map<String, dynamic> for cacheDocRef? For the example code you shared, can you pass in FirebaseFirestore.instance.doc('col/doc') instead? This document is simply used for fetching the cache date info, so I would imagine there's no need to use the parameter with the converters.

Also, I don't think it can use the same type T which is used for Query and the returned QuerySnapshot>, as it probably has a different type.

required String firestoreCacheField,
String? localCacheKey,
bool isUpdateCacheDate = true,
Map<String, Object?> Function(T value, SetOptions? options)? converter,
}) async {
if (cacheDocRef is! DocumentReference<Map<String, dynamic>>) {
assert(
converter != null,
"converter should not be null if cacheDocRef's collection is initiated with withConverter method ",
);
}

localCacheKey = localCacheKey ?? firestoreCacheField;

final isFetch = await isFetchDocuments(
cacheDocRef,
firestoreCacheField,
localCacheKey,
converter: converter,
);
final src = isFetch ? Source.serverAndCache : Source.cache;
var snapshot = await query.get(GetOptions(source: src));
Expand All @@ -115,11 +129,12 @@ class FirestoreCache {
}

@visibleForTesting
static Future<bool> isFetchDocuments(
DocumentReference<Map<String, dynamic>> cacheDocRef,
static Future<bool> isFetchDocuments<T>(
DocumentReference<T> cacheDocRef,
String firestoreCacheField,
String localCacheKey,
) async {
String localCacheKey, {
Map<String, Object?> Function(T value, SetOptions? options)? converter,
}) async {
var isFetch = true;
final prefs = await SharedPreferences.getInstance();
final dateStr = prefs.getString(localCacheKey);
Expand All @@ -129,13 +144,28 @@ class FirestoreCache {
final doc = await cacheDocRef.get();
final data = doc.data();

if (!doc.exists) {
if (!doc.exists || data == null) {
throw CacheDocDoesNotExist();
} else if (data == null || !data.containsKey(firestoreCacheField)) {
throw CacheDocFieldDoesNotExist();
}

final serverDateRaw = data[firestoreCacheField];
final dynamic serverDateRaw;

if (doc is DocumentSnapshot<Map<String, dynamic>>) {
if (!(data as Map).containsKey(firestoreCacheField)) {
throw CacheDocFieldDoesNotExist();
}

serverDateRaw = data[firestoreCacheField];
} else {
final newData = converter!(data, null);

if (!(newData).containsKey(firestoreCacheField)) {
throw CacheDocFieldDoesNotExist();
}

serverDateRaw = newData[firestoreCacheField];
}

DateTime? serverDate;

if (serverDateRaw is Timestamp) {
Expand Down