Switch from Isar to Drift for Caching (#253)

Author: jakobkoerber

ios/Podfile.lock

@@ -1,36 +1,36 @@
 PODS:
   - device_info_plus (0.0.1):
     - Flutter
-  - Firebase/CoreOnly (10.25.0):
-    - FirebaseCore (= 10.25.0)
-  - Firebase/Crashlytics (10.25.0):
+  - Firebase/CoreOnly (10.27.0):
+    - FirebaseCore (= 10.27.0)
+  - Firebase/Crashlytics (10.27.0):
     - Firebase/CoreOnly
-    - FirebaseCrashlytics (~> 10.25.0)
-  - Firebase/RemoteConfig (10.25.0):
+    - FirebaseCrashlytics (~> 10.27.0)
+  - Firebase/RemoteConfig (10.27.0):
     - Firebase/CoreOnly
-    - FirebaseRemoteConfig (~> 10.25.0)
-  - firebase_core (2.31.1):
-    - Firebase/CoreOnly (= 10.25.0)
+    - FirebaseRemoteConfig (~> 10.27.0)
+  - firebase_core (3.1.0):
+    - Firebase/CoreOnly (= 10.27.0)
     - Flutter
-  - firebase_crashlytics (3.5.6):
-    - Firebase/Crashlytics (= 10.25.0)
+  - firebase_crashlytics (4.0.1):
+    - Firebase/Crashlytics (= 10.27.0)
     - firebase_core
     - Flutter
-  - firebase_remote_config (4.4.6):
-    - Firebase/RemoteConfig (= 10.25.0)
+  - firebase_remote_config (5.0.1):
+    - Firebase/RemoteConfig (= 10.27.0)
     - firebase_core
     - Flutter
-  - FirebaseABTesting (10.25.0):
+  - FirebaseABTesting (10.28.0):
     - FirebaseCore (~> 10.0)
-  - FirebaseCore (10.25.0):
+  - FirebaseCore (10.27.0):
     - FirebaseCoreInternal (~> 10.0)
     - GoogleUtilities/Environment (~> 7.12)
     - GoogleUtilities/Logger (~> 7.12)
-  - FirebaseCoreExtension (10.25.0):
+  - FirebaseCoreExtension (10.28.0):
     - FirebaseCore (~> 10.0)
-  - FirebaseCoreInternal (10.25.0):
+  - FirebaseCoreInternal (10.28.0):
     - "GoogleUtilities/NSData+zlib (~> 7.8)"
-  - FirebaseCrashlytics (10.25.0):
+  - FirebaseCrashlytics (10.27.0):
     - FirebaseCore (~> 10.5)
     - FirebaseInstallations (~> 10.0)
     - FirebaseRemoteConfigInterop (~> 10.23)
@@ -39,21 +39,21 @@ PODS:
     - GoogleUtilities/Environment (~> 7.8)
     - nanopb (< 2.30911.0, >= 2.30908.0)
     - PromisesObjC (~> 2.1)
-  - FirebaseInstallations (10.25.0):
+  - FirebaseInstallations (10.28.0):
     - FirebaseCore (~> 10.0)
     - GoogleUtilities/Environment (~> 7.8)
     - GoogleUtilities/UserDefaults (~> 7.8)
     - PromisesObjC (~> 2.1)
-  - FirebaseRemoteConfig (10.25.0):
+  - FirebaseRemoteConfig (10.27.0):
     - FirebaseABTesting (~> 10.0)
     - FirebaseCore (~> 10.0)
     - FirebaseInstallations (~> 10.0)
     - FirebaseRemoteConfigInterop (~> 10.23)
     - FirebaseSharedSwift (~> 10.0)
     - GoogleUtilities/Environment (~> 7.8)
     - "GoogleUtilities/NSData+zlib (~> 7.8)"
-  - FirebaseRemoteConfigInterop (10.25.0)
-  - FirebaseSessions (10.25.0):
+  - FirebaseRemoteConfigInterop (10.28.0)
+  - FirebaseSessions (10.28.0):
     - FirebaseCore (~> 10.5)
     - FirebaseCoreExtension (~> 10.0)
     - FirebaseInstallations (~> 10.0)
@@ -62,7 +62,7 @@ PODS:
     - GoogleUtilities/UserDefaults (~> 7.13)
     - nanopb (< 2.30911.0, >= 2.30908.0)
     - PromisesSwift (~> 2.1)
-  - FirebaseSharedSwift (10.25.0)
+  - FirebaseSharedSwift (10.28.0)
   - Flutter (1.0.0)
   - flutter_native_splash (0.0.1):
     - Flutter
@@ -96,8 +96,6 @@ PODS:
     - GoogleUtilities/Privacy
   - home_widget (0.0.1):
     - Flutter
-  - isar_flutter_libs (1.0.0):
-    - Flutter
   - map_launcher (0.0.1):
     - Flutter
   - nanopb (2.30910.0):
@@ -123,6 +121,24 @@ PODS:
   - sqflite (0.0.3):
     - Flutter
     - FlutterMacOS
+  - "sqlite3 (3.46.0+1)":
+    - "sqlite3/common (= 3.46.0+1)"
+  - "sqlite3/common (3.46.0+1)"
+  - "sqlite3/dbstatvtab (3.46.0+1)":
+    - sqlite3/common
+  - "sqlite3/fts5 (3.46.0+1)":
+    - sqlite3/common
+  - "sqlite3/perf-threadsafe (3.46.0+1)":
+    - sqlite3/common
+  - "sqlite3/rtree (3.46.0+1)":
+    - sqlite3/common
+  - sqlite3_flutter_libs (0.0.1):
+    - Flutter
+    - "sqlite3 (~> 3.46.0+1)"
+    - sqlite3/dbstatvtab
+    - sqlite3/fts5
+    - sqlite3/perf-threadsafe
+    - sqlite3/rtree
   - url_launcher_ios (0.0.1):
     - Flutter
   - video_player_avfoundation (0.0.1):
@@ -140,14 +156,14 @@ DEPENDENCIES:
   - geolocator_apple (from `.symlinks/plugins/geolocator_apple/ios`)
   - google_maps_flutter_ios (from `.symlinks/plugins/google_maps_flutter_ios/ios`)
   - home_widget (from `.symlinks/plugins/home_widget/ios`)
-  - isar_flutter_libs (from `.symlinks/plugins/isar_flutter_libs/ios`)
   - map_launcher (from `.symlinks/plugins/map_launcher/ios`)
   - package_info_plus (from `.symlinks/plugins/package_info_plus/ios`)
   - path_provider_foundation (from `.symlinks/plugins/path_provider_foundation/darwin`)
   - permission_handler_apple (from `.symlinks/plugins/permission_handler_apple/ios`)
   - quick_actions_ios (from `.symlinks/plugins/quick_actions_ios/ios`)
   - shared_preferences_foundation (from `.symlinks/plugins/shared_preferences_foundation/darwin`)
   - sqflite (from `.symlinks/plugins/sqflite/darwin`)
+  - sqlite3_flutter_libs (from `.symlinks/plugins/sqlite3_flutter_libs/ios`)
   - url_launcher_ios (from `.symlinks/plugins/url_launcher_ios/ios`)
   - video_player_avfoundation (from `.symlinks/plugins/video_player_avfoundation/darwin`)
 
@@ -170,6 +186,7 @@ SPEC REPOS:
     - nanopb
     - PromisesObjC
     - PromisesSwift
+    - sqlite3
 
 EXTERNAL SOURCES:
   device_info_plus:
@@ -192,8 +209,6 @@ EXTERNAL SOURCES:
     :path: ".symlinks/plugins/google_maps_flutter_ios/ios"
   home_widget:
     :path: ".symlinks/plugins/home_widget/ios"
-  isar_flutter_libs:
-    :path: ".symlinks/plugins/isar_flutter_libs/ios"
   map_launcher:
     :path: ".symlinks/plugins/map_launcher/ios"
   package_info_plus:
@@ -208,27 +223,29 @@ EXTERNAL SOURCES:
     :path: ".symlinks/plugins/shared_preferences_foundation/darwin"
   sqflite:
     :path: ".symlinks/plugins/sqflite/darwin"
+  sqlite3_flutter_libs:
+    :path: ".symlinks/plugins/sqlite3_flutter_libs/ios"
   url_launcher_ios:
     :path: ".symlinks/plugins/url_launcher_ios/ios"
   video_player_avfoundation:
     :path: ".symlinks/plugins/video_player_avfoundation/darwin"
 
 SPEC CHECKSUMS:
   device_info_plus: 97af1d7e84681a90d0693e63169a5d50e0839a0d
-  Firebase: 0312a2352584f782ea56f66d91606891d4607f06
-  firebase_core: 22e117a2e0dec3cb318c8f53f2dd01c140375617
-  firebase_crashlytics: bd50e4bbd2ac62cb6d5efd73449f414a2619e55b
-  firebase_remote_config: 347436da419c4b6d64995edc037e9ed56158354b
-  FirebaseABTesting: e6e3c3e0e35813874f571d1b7bdae2aab319dd38
-  FirebaseCore: 7ec4d0484817f12c3373955bc87762d96842d483
-  FirebaseCoreExtension: 8a47811d0b155501559ef05d089518152a0a1677
-  FirebaseCoreInternal: 910a81992c33715fec9263ca7381d59ab3a750b7
-  FirebaseCrashlytics: 4b96efb0ce73b38b2a85e8b8bd1bd8f63f09d015
-  FirebaseInstallations: 91950fe859846fff0fbd296180909dd273103b09
-  FirebaseRemoteConfig: 9f3935cefecd85d5b312192117f444957de24a75
-  FirebaseRemoteConfigInterop: b25018791b204c0d78a90e394d6c62d9b1f22da8
-  FirebaseSessions: c0939656253a1fa0e94ecc266ccf770cc8b33732
-  FirebaseSharedSwift: 0274086954b1b2d5fd7e829eccc587044d72a4ba
+  Firebase: 26b040b20866a55f55eb3611b9fcf3ae64816b86
+  firebase_core: 483cfad66d24d8f3c233f31db4263830c625c909
+  firebase_crashlytics: 8f04c663c8734f97c4ccbe81b8511ce7060e3b28
+  firebase_remote_config: 3c103e81a3fba5f50c0a522d65a49e5695d57fbc
+  FirebaseABTesting: 589bc28c0ab3e5554336895a34aa262e24276665
+  FirebaseCore: a2b95ae4ce7c83ceecfbbbe3b6f1cddc7415a808
+  FirebaseCoreExtension: f63147b723e2a700fe0f34ec6fb7f358d6fe83e0
+  FirebaseCoreInternal: 58d07f1362fddeb0feb6a857d1d1d1c5e558e698
+  FirebaseCrashlytics: 81ea6ec96519388687f6061beb838a8eec482293
+  FirebaseInstallations: 60c1d3bc1beef809fd1ad1189a8057a040c59f2e
+  FirebaseRemoteConfig: 37a2ba3c8c454be8553a41ba1a2f4a4f0b845670
+  FirebaseRemoteConfigInterop: 70d200c6956ef3b5c3592a95e824c1210682d785
+  FirebaseSessions: 20da8500ad66bb12622743e170459bf62a0768e8
+  FirebaseSharedSwift: 48de4aec81a6b79bb30404e5e6db43ea74848fed
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
   flutter_native_splash: edf599c81f74d093a4daf8e17bd7a018854bc778
   flutter_secure_storage: d33dac7ae2ea08509be337e775f6b59f1ff45f12
@@ -238,7 +255,6 @@ SPEC CHECKSUMS:
   GoogleMaps: 8939898920281c649150e0af74aa291c60f2e77d
   GoogleUtilities: ea963c370a38a8069cc5f7ba4ca849a60b6d7d15
   home_widget: 0434835a4c9a75704264feff6be17ea40e0f0d57
-  isar_flutter_libs: fdf730ca925d05687f36d7f1d355e482529ed097
   map_launcher: 5fde49ac9a52672bf99da746599f507b4490d7b5
   nanopb: 438bc412db1928dac798aa6fd75726007be04262
   package_info_plus: 58f0028419748fad15bf008b270aaa8e54380b1c
@@ -249,6 +265,8 @@ SPEC CHECKSUMS:
   quick_actions_ios: 56f3cbaa71e94f212838d1f9fe354bd0734779bf
   shared_preferences_foundation: fcdcbc04712aee1108ac7fda236f363274528f78
   sqflite: 673a0e54cc04b7d6dba8d24fb8095b31c3a99eec
+  sqlite3: 292c3e1bfe89f64e51ea7fc7dab9182a017c8630
+  sqlite3_flutter_libs: c00457ebd31e59fa6bb830380ddba24d44fbcd3b
   url_launcher_ios: 5334b05cef931de560670eeae103fd3e431ac3fe
   video_player_avfoundation: 7c6c11d8470e1675df7397027218274b6d2360b3
 

ios/build/.last_build_id

@@ -1 +1 @@
-e728d5ba4e52068eb059d8c80cc8e750
+39f4bf50ad275767c79aa66def67de4c

lib/base/networking/base/grpc_client.dart

@@ -1,23 +1,25 @@
 import 'dart:async';
 import 'dart:io';
 
-import 'package:campus_flutter/base/networking/cache/grpc_cache_interceptor.dart';
+import 'package:campus_flutter/base/networking/cache/cache_entry.dart';
 import 'package:campus_flutter/base/networking/apis/tumdev/campus_backend.pbgrpc.dart';
+import 'package:campus_flutter/base/networking/cache/grpc_cache_interceptor.dart';
 import 'package:device_info_plus/device_info_plus.dart';
 import 'package:grpc/grpc_or_grpcweb.dart';
-import 'package:isar/isar.dart';
 import 'package:package_info_plus/package_info_plus.dart';
 
 class GrpcClient extends CampusClient {
-  static Future<GrpcClient> createGrpcClient(Isar isar) async {
-    return GrpcClient(isar, await _callOptions());
+  static Future<GrpcClient> createGrpcClient(
+    CacheDatabase cacheDatabase,
+  ) async {
+    return GrpcClient(cacheDatabase, await _callOptions());
   }
 
-  GrpcClient(Isar isar, CallOptions callOptions)
+  GrpcClient(CacheDatabase cacheDatabase, CallOptions callOptions)
       : super(
           _channel(),
           options: callOptions,
-          interceptors: [GrpcCacheInterceptor(isar)],
+          interceptors: [GrpcCacheInterceptor(cacheDatabase)],
         );
 
   static Future<CallOptions> _callOptions() async {
@@ -33,10 +35,6 @@ class GrpcClient extends CampusClient {
       AndroidDeviceInfo androidInfo = await deviceInfo.androidInfo;
       osVersion = androidInfo.version.toString();
       deviceId = androidInfo.serialNumber;
-    } else if (Platform.isMacOS) {
-      MacOsDeviceInfo macInfo = await deviceInfo.macOsInfo;
-      osVersion = macInfo.osRelease;
-      deviceId = macInfo.model;
     }
     return CallOptions(
       metadata: {

lib/base/networking/base/rest_client.dart

@@ -2,20 +2,20 @@ import 'dart:convert';
 import 'dart:developer';
 
 import 'package:campus_flutter/base/networking/cache/cache.dart';
+import 'package:campus_flutter/base/networking/cache/cache_entry.dart';
 import 'package:campus_flutter/base/networking/cache/rest_cache_interceptor.dart';
 import 'package:campus_flutter/base/networking/protocols/api.dart';
 import 'package:campus_flutter/base/networking/protocols/api_exception.dart';
 import 'package:campus_flutter/base/networking/base/api_response.dart';
 import 'package:dio/dio.dart';
-import 'package:isar/isar.dart';
 import 'package:xml2json/xml2json.dart';
 
 class RestClient {
   late Dio dio;
   late Cache cache;
 
-  RestClient(Isar isar) {
-    final cache = Cache(isar: isar);
+  RestClient(CacheDatabase cacheDatabase) {
+    final cache = Cache(cacheDatabase: cacheDatabase);
     this.cache = cache;
 
     /// add custom cache interceptor to dio

lib/base/networking/cache/cache.dart

@@ -1,66 +1,71 @@
-import 'package:isar/isar.dart';
 import 'package:campus_flutter/base/networking/cache/cache_entry.dart';
+import 'package:campus_flutter/base/services/connection_service.dart';
 import 'package:campus_flutter/base/util/fast_hash.dart';
+import 'package:campus_flutter/main.dart';
+import 'package:drift/drift.dart';
 
 class Cache {
-  final Isar isar;
+  final CacheDatabase cacheDatabase;
 
-  final Duration ttl = const Duration(days: 30);
+  final Duration onlineTtl = const Duration(minutes: 10);
 
-  Cache({required this.isar});
+  final Duration offlineTtl = const Duration(days: 30);
 
-  void add(String body, String uri) {
+  Cache({required this.cacheDatabase});
+
+  void add(String body, String key) {
     final today = DateTime.now();
-    final cacheEntry = CacheEntry(
-      id: fastHash(uri),
-      url: uri,
-      validUntil: today.add(ttl),
-      saved: today,
-      data: body,
-    );
-    isar.writeTxn(
-      () => isar.cacheEntrys.put(cacheEntry),
+    final id = fastHash(key);
+
+    cacheDatabase.managers.cacheEntry.create(
+      (o) => CacheEntryCompanion.insert(
+        id: id,
+        url: key,
+        validUntil: today.add(offlineTtl),
+        saved: today,
+        body: body,
+      ),
+      mode: InsertMode.replace,
     );
   }
 
-  CacheEntry? get(String uri) {
-    final hash = fastHash(uri);
-    final entry = isar.txnSync(() => isar.cacheEntrys.getSync(hash));
-    if (entry != null) {
-      final today = DateTime.now();
-      if (entry.validUntil.isAfter(today)) {
-        return entry;
-      } else {
-        isar.writeTxn(() => isar.cacheEntrys.delete(hash));
-        return null;
-      }
-    } else {
-      return null;
-    }
-  }
+  Future<CacheEntryData?> get(String key) async {
+    final id = fastHash(key);
+
+    final entry = await cacheDatabase.managers.cacheEntry
+        .filter((f) => f.id.equals(id))
+        .limit(1)
+        .getSingleOrNull();
 
-  Future<CacheEntry?> getAsync(String uri) async {
-    final hash = fastHash(uri);
-    final entry = await isar.txn(() => isar.cacheEntrys.get(hash));
     if (entry != null) {
       final today = DateTime.now();
-      if (entry.validUntil.isAfter(today)) {
-        return entry;
+      if (getIt<ConnectionService>().hasInternet() &&
+          !key.contains("tumCard")) {
+        if (entry.saved.isAfter(today.subtract(onlineTtl))) {
+          return entry;
+        } else {
+          delete(key);
+          return null;
+        }
       } else {
-        isar.writeTxn(() => isar.cacheEntrys.delete(hash));
-        return null;
+        if (entry.validUntil.isAfter(today)) {
+          return entry;
+        } else {
+          delete(key);
+          return null;
+        }
       }
     } else {
       return null;
     }
   }
 
   void delete(String key) {
-    final hash = fastHash(key);
-    isar.writeTxn(() => isar.cacheEntrys.delete(hash));
+    final id = fastHash(key);
+    cacheDatabase.managers.cacheEntry.filter((f) => f.id.equals(id)).delete();
   }
 
   Future<void> resetCache() async {
-    return await isar.writeTxn(() => isar.clear());
+    await cacheDatabase.managers.cacheEntry.delete();
   }
 }