cascading insert wip

mqus · Apr 25, 2021 · 02733df · 02733df
1 parent 19cadca
commit 02733df
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 14 deletions.
diff --git a/floor/lib/src/adapter/insertion_adapter.dart b/floor/lib/src/adapter/insertion_adapter.dart
@@ -8,18 +8,18 @@ class InsertionAdapter<T> {
   final DatabaseExecutor _database;
   final String _entityName;
   final Map<String, Object?> Function(T) _valueMapper;
-  final StreamController<Set<String>>? _changeListener;
+  final void Function(bool) _changeHandler;
 
   InsertionAdapter(
     final DatabaseExecutor database,
     final String entityName,
     final Map<String, Object?> Function(T) valueMapper, [
-    final StreamController<Set<String>>? changeListener,
+    final void Function(bool)? changeHandler,
   ])  : assert(entityName.isNotEmpty),
         _database = database,
         _entityName = entityName,
         _valueMapper = valueMapper,
-        _changeListener = changeListener;
+        _changeHandler = changeHandler ?? ((bool isReplace) {/* do nothing */});
 
   Future<void> insert(
     final T item,
@@ -42,7 +42,7 @@ class InsertionAdapter<T> {
       );
     }
     await batch.commit(noResult: true);
-    _changeListener?.add({_entityName});
+    _changeHandler(onConflictStrategy == OnConflictStrategy.replace);
   }
 
   Future<int> insertAndReturnId(
@@ -66,7 +66,8 @@ class InsertionAdapter<T> {
       );
     }
     final result = (await batch.commit(noResult: false)).cast<int>();
-    if (result.isNotEmpty) _changeListener?.add({_entityName});
+    if (result.isNotEmpty)
+      _changeHandler(onConflictStrategy == OnConflictStrategy.replace);
     return result;
   }
 
@@ -79,7 +80,8 @@ class InsertionAdapter<T> {
       _valueMapper(item),
       conflictAlgorithm: onConflictStrategy.asSqfliteConflictAlgorithm(),
     );
-    if (result != 0) _changeListener?.add({_entityName});
+    if (result != 0)
+      _changeHandler(onConflictStrategy == OnConflictStrategy.replace);
     return result;
   }
 }
diff --git a/floor/test/adapter/insertion_adapter_test.dart b/floor/test/adapter/insertion_adapter_test.dart
@@ -182,11 +182,14 @@ void main() {
     // ignore: close_sinks
     final mockStreamController = MockStreamController<Set<String>>();
 
+    final changeHandler = (bool isReplace) {
+      mockStreamController.add({entityName});
+    };
     final underTest = InsertionAdapter(
       mockDatabaseExecutor,
       entityName,
       valueMapper,
-      mockStreamController,
+      changeHandler,
     );
 
     tearDown(() {

diff --git a/floor/test/integration/stream_query_test.dart b/floor/test/integration/stream_query_test.dart
@@ -137,13 +137,20 @@ void main() {
           actual,
           emitsInOrder(<List<Dog>>[
             [], // initial state,
+            [], // after inserting person1, [1]
+            [], // after inserting person2, [1]
             [dog1], // after inserting dog1
             [dog1], // after inserting dog2
             [], // after removing person1, which triggers cascade remove
           ]));
+      // [1] due to insert method having onConflict:replace, dog entries could be affected by this query, so a stream event is triggered.
 
       await personDao.insertPerson(person1);
+      // avoid that delete happens before the re-execution of
+      // the select query for the stream
+      await Future<void>.delayed(const Duration(milliseconds: 100));
       await personDao.insertPerson(person2);
+      await Future<void>.delayed(const Duration(milliseconds: 100));
 
       await database.dogDao.insertDog(dog1);
 

diff --git a/floor_generator/lib/writer/dao_writer.dart b/floor_generator/lib/writer/dao_writer.dart
@@ -83,12 +83,14 @@ class DaoWriter extends Writer {
         final valueMapper =
             '(${entity.classElement.displayName} item) => ${entity.valueMapping}';
 
-        final requiresChangeListener =
-            dbHasViewStreams || streamEntities.contains(entity);
+        // create a special change handler which decides case-by-case:
+        // if the insertion happens with onConflict:replace, consider the insertion like a deletion.
+        // if it will not replace (e.g. abort or ignore), only output the single entity at most.
+        final changeHandler = _generateChangeHandler(foreignKeyRelationships.getAffectedByDelete(entity), entity);
 
         constructorBuilder
           ..initializers.add(Code(
-              "$fieldName = InsertionAdapter(database, '${entity.name}', $valueMapper${requiresChangeListener ? ', changeListener' : ''})"));
+              "$fieldName = InsertionAdapter(database, '${entity.name}', $valueMapper$changeHandler)"));
       }
     }
 
@@ -221,15 +223,22 @@ class DaoWriter extends Writer {
   ///
   /// The affected set can be generated with [getAffectedByUpdateEntities]
   /// and [getAffectedByDeleteEntities]
-  String _generateChangeHandler(final Set<Entity> affected) {
+  String _generateChangeHandler(final Set<Entity> affected ,[Entity? insertionEntity]) {
     final toNotify = streamEntities.intersection(affected);
 
-    if (toNotify.isNotEmpty || dbHasViewStreams)
+    if (toNotify.isNotEmpty || dbHasViewStreams) {
       // if there are streaming views, create a new handler even if the set
       // is empty. This will only trigger a reload of the views.
-      return ', () => changeListener.add(const {${toNotify.map((e) => e.name.toLiteral()).join(', ')}})';
-    else
+      final set = 'const {${toNotify.map((e) => e.name.toLiteral()).join(', ')}}';
+      if (insertionEntity == null) {
+        return ', () => changeListener.add($set)';
+      } else {
+        final singleSet = 'const {${streamEntities.contains(insertionEntity)?insertionEntity.name.toLiteral():''}}';
+        return ', (isReplace) => changeListener.add(isReplace?$set:$singleSet)';
+      }
+    } else {
       // do not generate a Handler if the listener doesn't have to be updated
       return '';
+    }
   }
 }