Merge pull request #646 from wger-project/feature/ingredient-cache

Use local sqlite database for ingredient cache

Author: rolandgeider

lib/core/locator.dart

@@ -18,8 +18,6 @@ class ServiceLocator {
   Future<void> _initDB() async {
     ExerciseDatabase exerciseDB;
     IngredientDatabase ingredientDB;
-    // final exerciseDB = ExerciseDatabase();
-    // final ingredientDB = IngredientDatabase();
 
     if (Platform.environment.containsKey('FLUTTER_TEST')) {
       exerciseDB = ExerciseDatabase.inMemory(NativeDatabase.memory());

lib/database/exercises/exercise_database.dart

@@ -15,6 +15,7 @@ part 'exercise_database.g.dart';
 @DataClassName('ExerciseTable')
 class Exercises extends Table {
   const Exercises();
+
   IntColumn get id => integer()();
 
   TextColumn get data => text()();
@@ -32,6 +33,7 @@ class Exercises extends Table {
 @DataClassName('MuscleTable')
 class Muscles extends Table {
   const Muscles();
+
   IntColumn get id => integer()();
 
   TextColumn get data => text().map(const MuscleConverter())();
@@ -40,6 +42,7 @@ class Muscles extends Table {
 @DataClassName('CategoryTable')
 class Categories extends Table {
   const Categories();
+
   IntColumn get id => integer()();
 
   TextColumn get data => text().map(const ExerciseCategoryConverter())();
@@ -48,6 +51,7 @@ class Categories extends Table {
 @DataClassName('LanguagesTable')
 class Languages extends Table {
   const Languages();
+
   IntColumn get id => integer()();
 
   TextColumn get data => text().map(const LanguageConverter())();
@@ -56,6 +60,7 @@ class Languages extends Table {
 @DataClassName('EquipmentTable')
 class Equipments extends Table {
   const Equipments();
+
   IntColumn get id => integer()();
 
   TextColumn get data => text().map(const EquipmentConverter())();
@@ -68,10 +73,30 @@ class ExerciseDatabase extends _$ExerciseDatabase {
   // Named constructor for creating in-memory database
   ExerciseDatabase.inMemory(super.e);
 
+  /// Note that this needs to be bumped if the JSON response from the server changes
   @override
-  // TODO: implement schemaVersion
   int get schemaVersion => 1;
 
+  /// There is not really a migration strategy. If we bump the version
+  /// number, delete everything and recreate the new tables. The provider
+  /// will fetch everything as needed from the server
+  @override
+  MigrationStrategy get migration => MigrationStrategy(
+        onUpgrade: (m, from, to) async {
+          // no-op, but needs to be defined
+          return;
+        },
+        beforeOpen: (openingDetails) async {
+          if (openingDetails.hadUpgrade) {
+            final m = createMigrator();
+            for (final table in allTables) {
+              await m.deleteTable(table.actualTableName);
+              await m.createTable(table);
+            }
+          }
+        },
+      );
+
   Future<void> deleteEverything() {
     return transaction(() async {
       for (final table in allTables) {

lib/database/ingredients/ingredients_database.dart

@@ -10,11 +10,13 @@ part 'ingredients_database.g.dart';
 @DataClassName('IngredientTable')
 class Ingredients extends Table {
   const Ingredients();
+
   IntColumn get id => integer()();
 
   TextColumn get data => text()();
 
-  DateTimeColumn get lastUpdate => dateTime()();
+  /// The date when the ingredient was last fetched from the server
+  DateTimeColumn get lastFetched => dateTime()();
 }
 
 @DriftDatabase(tables: [Ingredients])
@@ -24,9 +26,37 @@ class IngredientDatabase extends _$IngredientDatabase {
   // Named constructor for creating in-memory database
   IngredientDatabase.inMemory(super.e);
 
+  /// Note that this needs to be bumped if the JSON response from the server changes
+  @override
+  int get schemaVersion => 2;
+
+  /// There is not really a migration strategy. If we bump the version
+  /// number, delete everything and recreate the new tables. The nutrition provider
+  /// will fetch everything as needed from the server
   @override
-  // TODO: implement schemaVersion
-  int get schemaVersion => 1;
+  MigrationStrategy get migration => MigrationStrategy(
+        onUpgrade: (m, from, to) async {
+          // no-op, but needs to be defined
+          return;
+        },
+        beforeOpen: (openingDetails) async {
+          if (openingDetails.hadUpgrade) {
+            final m = createMigrator();
+            for (final table in allTables) {
+              await m.deleteTable(table.actualTableName);
+              await m.createTable(table);
+            }
+          }
+        },
+      );
+
+  Future<void> deleteEverything() {
+    return transaction(() async {
+      for (final table in allTables) {
+        await delete(table).go();
+      }
+    });
+  }
 }
 
 LazyDatabase _openConnection() {