Merge pull request rrousselGit#190 from rrousselGit/fix-dispose

fixes rrousselGit#154
scopendo · Oct 14, 2020 · d81a46c · d81a46c
2 parents f438d8e + db82cf2
commit d81a46c
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 9 deletions.
diff --git a/packages/flutter_riverpod/CHANGELOG.md b/packages/flutter_riverpod/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 0.11.2
+
+- Fixed a bug where providers (usually ScopedProviders) did not dispose correctly
+  (see also https://github.com/rrousselGit/river_pod/issues/154).
+
 # 0.11.1
 
 - Fixed a bug where hot-reload did not work for `ConsumerWidget`/`Consumer`

diff --git a/packages/hooks_riverpod/CHANGELOG.md b/packages/hooks_riverpod/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 0.11.2
+
+- Fixed a bug where providers (usually ScopedProviders) did not dispose correctly
+  (see also https://github.com/rrousselGit/river_pod/issues/154).
+
 # 0.11.1
 
 - Fixed a bug where hot-reload did not work for `ConsumerWidget`/`Consumer`

diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 0.11.2
+
+- Fixed a bug where providers (usually ScopedProviders) did not dispose correctly
+  (see also https://github.com/rrousselGit/river_pod/issues/154).
+
 # 0.11.0
 
 - `package:riverpod/riverpod.dart` now exports `StateNotifier`

diff --git a/packages/riverpod/lib/src/framework/container.dart b/packages/riverpod/lib/src/framework/container.dart
@@ -361,7 +361,10 @@ class ProviderContainer {
     final queue = DoubleLinkedQueue<ProviderElement>();
 
     for (final element in _stateReaders.values) {
-      if (element.dependents == null || element._subscriptions.isEmpty) {
+      if (element._subscriptions == null ||
+          element._subscriptions.keys
+              .where((e) => e._container == this)
+              .isEmpty) {
         queue.add(element);
       }
     }
@@ -376,14 +379,15 @@ class ProviderContainer {
 
       yield element;
 
-      if (element._dependents == null) {
-        continue;
-      }
-      for (final dependent in element._dependents) {
-        if (dependent._container == this &&
-            // All the parents of a node must have been visited before a node is visited
-            dependent._subscriptions.keys.every(visitedNodes.contains)) {
-          queue.add(dependent);
+      if (element._dependents != null) {
+        for (final dependent in element._dependents) {
+          if (dependent._container == this &&
+              // All the parents of a node must have been visited before a node is visited
+              dependent._subscriptions.keys.every((e) {
+                return e._container != this || visitedNodes.contains(e);
+              })) {
+            queue.add(dependent);
+          }
         }
       }
     }

diff --git a/packages/riverpod/test/framework2/scoped_provider_test.dart b/packages/riverpod/test/framework2/scoped_provider_test.dart
@@ -92,6 +92,10 @@ void main() {
       await Future<void>.value();
 
       expect(element.mounted, false);
+
+      container.dispose();
+
+      expect(element.mounted, false);
     });
 
     test('overridesAs are auto disposed', () async {

diff --git a/packages/riverpod/test/visit_states_test.dart b/packages/riverpod/test/visit_states_test.dart
@@ -64,6 +64,51 @@ void main() {
     }
   });
 
+  //  A#1
+  //  |
+  //  B#2
+  test('linear across two containers', () {
+    final a = Provider<A>((ref) => A());
+
+    final b = ScopedProvider<B>((watch) {
+      watch(a);
+      return B();
+    });
+
+    final parent = ProviderContainer();
+    final container = ProviderContainer(parent: parent);
+    container.read(b);
+
+    expect(compute(container), [b]);
+  });
+
+  //  A#1  B#2
+  //    \  /
+  //     C#2
+  test('branching across two containers', () {
+    final a = Provider<A>((ref) => A());
+
+    final b = ScopedProvider<B>((watch) {
+      return B();
+    });
+
+    final c = ScopedProvider<C>((watch) {
+      watch(a);
+      watch(b);
+      return C();
+    });
+
+    final parent = ProviderContainer();
+
+    final perm = Permutations(2, [b, c]);
+    for (final permutation in perm()) {
+      final container = ProviderContainer(parent: parent);
+      permutation.forEach(container.read);
+
+      expect(compute(container), [b, c]);
+    }
+  });
+
   ///       A
   ///     /   \
   ///    B __  |