Await store.putFile so cache info is persisted #492

flutter_cache_manager/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
+* Awaits cache-info persist in `putFile`, `putFileStream`, and downloads so the stored object has an id before those calls return
 * Fixes `JsonCacheInfoRepository` losing metadata when the app exits within 3 seconds of a cache change by writing through promptly with serialized, atomic file writes ([#491](https://github.com/Baseflow/flutter_cache_manager/issues/491))
 * Modernizes GitHub Actions CI (combined quality job, pinned Flutter 3.44.4, Dependabot for actions)
 * Updates example Android project to AGP 9.0.1 / Gradle 9.1 / Kotlin 2.3.20

flutter_cache_manager/lib/src/cache_manager.dart

@@ -242,7 +242,7 @@ class CacheManager implements BaseCacheManager {
 
     final file = await _config.fileSystem.createFile(cacheObject.relativePath);
     await file.writeAsBytes(fileBytes);
-    _store.putFile(cacheObject);
+    await _store.putFile(cacheObject);
     return file;
   }
 
@@ -287,7 +287,7 @@ class CacheManager implements BaseCacheManager {
         .map((event) => event)
         .pipe(sink);
 
-    _store.putFile(cacheObject);
+    await _store.putFile(cacheObject);
     return file;
   }
 

flutter_cache_manager/lib/src/web/web_helper.dart

@@ -156,11 +156,10 @@ class WebHelper {
       newCacheObject = newCacheObject.copyWith(length: savedBytes);
     }
 
-    _store.putFile(newCacheObject).then((_) {
-      if (newCacheObject.relativePath != oldCacheObject.relativePath) {
-        _removeOldFile(oldCacheObject.relativePath);
-      }
-    });
+    await _store.putFile(newCacheObject);
+    if (newCacheObject.relativePath != oldCacheObject.relativePath) {
+      await _removeOldFile(oldCacheObject.relativePath);
+    }
 
     final file = await _store.fileSystem.createFile(
       newCacheObject.relativePath,

flutter_cache_manager/test/cache_manager_test.dart

@@ -424,6 +424,35 @@ void main() {
       expect(arg.key, fileKey);
       expect(arg.url, fileUrl);
     });
+
+    test('putFile waits for store persist before returning', () async {
+      var persistDone = false;
+      var store = MockCacheStore();
+      when(store.putFile(any)).thenAnswer((_) async {
+        await Future<void>.delayed(const Duration(milliseconds: 40));
+        persistDone = true;
+      });
+
+      var cacheManager = TestCacheManager(createTestConfig(), store: store);
+      await cacheManager.putFile('baseflow.com/test', Uint8List(8));
+      expect(persistDone, isTrue);
+    });
+
+    test('putFileStream waits for store persist before returning', () async {
+      var persistDone = false;
+      var store = MockCacheStore();
+      when(store.putFile(any)).thenAnswer((_) async {
+        await Future<void>.delayed(const Duration(milliseconds: 40));
+        persistDone = true;
+      });
+
+      var cacheManager = TestCacheManager(createTestConfig(), store: store);
+      await cacheManager.putFileStream(
+        'baseflow.com/test',
+        Stream<List<int>>.value([1, 2, 3]),
+      );
+      expect(persistDone, isTrue);
+    });
   });
 
   group('Testing remove files from cache', () {

flutter_cache_manager/test/web_helper_test.dart

@@ -248,6 +248,40 @@ void main() {
       verify(store.putFile(any)).called(1);
     });
 
+    test('downloadFile waits for persist before yielding FileInfo', () async {
+      const imageUrl = 'baseflow.com/testimage';
+
+      var persistDone = false;
+      var config = createTestConfig();
+      var store = _createStore(config);
+      when(store.putFile(any)).thenAnswer((_) async {
+        await Future<void>.delayed(const Duration(milliseconds: 40));
+        persistDone = true;
+      });
+
+      final fileService = MockFileService();
+      when(fileService.get(imageUrl, headers: anyNamed('headers'))).thenAnswer((
+        _,
+      ) {
+        return Future.value(
+          MockFileFetcherResponse(
+            Stream.value([0, 1, 2, 3, 4, 5]),
+            6,
+            'testv1',
+            '.jpg',
+            200,
+            DateTime.now(),
+          ),
+        );
+      });
+
+      var webHelper = WebHelper(store, fileService);
+      await webHelper
+          .downloadFile(imageUrl)
+          .firstWhere((r) => r is FileInfo, orElse: null);
+      expect(persistDone, isTrue);
+    });
+
     test('File should be removed if extension changed', () async {
       const imageUrl = 'baseflow.com/testimage';
       var imageName = 'image.png';