Add regression tests for #2816

closes #2816
rrousselGit · Mar 9, 2024 · ea91d6d · ea91d6d
1 parent 1ff2870
commit ea91d6d
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 0 deletions.
diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md
@@ -6,6 +6,8 @@
   with the provider if the provider is no-longer used.
 - Fix `selectAsync` sometimes never resolving.
 - Fix `ProviderSubscription.read` returned by `ref.listen(provider.future)` not throwing if used after the subscription has been closed.
+- Fix `ref.onAddListener` and other life-cycles not being triggered when
+  listening to `provider.future`/`provider.notifier`.
 
 ## 2.5.0 - 2024-02-03
 

diff --git a/packages/riverpod/test/framework/modifiers_test.dart b/packages/riverpod/test/framework/modifiers_test.dart
@@ -1,4 +1,5 @@
 // ignore_for_file: prefer_const_constructors
+import 'package:mockito/mockito.dart';
 import 'package:riverpod/riverpod.dart';
 import 'package:riverpod/src/builders.dart';
 import 'package:test/test.dart';
@@ -23,6 +24,59 @@ void main() {
     });
   });
 
+  test('Listening to a modifier correctly fires ref life-cycles', () async {
+    final container = createContainer();
+    final onDispose = OnDisposeMock();
+    final onAddListener = OnAddListener();
+    final onRemoveListener = OnRemoveListener();
+    final onResume = OnResume();
+    final onCancel = OnCancelMock();
+
+    final provider = FutureProvider((ref) {
+      ref.onDispose(onDispose.call);
+      ref.onAddListener(onAddListener.call);
+      ref.onRemoveListener(onRemoveListener.call);
+      ref.onCancel(onCancel.call);
+      ref.onResume(onResume.call);
+      return 0;
+    });
+
+    final sub = container.listen(provider.future, (prev, value) {});
+
+    verifyOnly(onAddListener, onAddListener());
+
+    final sub2 = container.listen(provider.future, (prev, value) {});
+
+    verifyOnly(onAddListener, onAddListener());
+
+    sub.close();
+
+    verifyOnly(onRemoveListener, onRemoveListener());
+    verifyZeroInteractions(onCancel);
+
+    sub2.close();
+
+    verifyOnly(onRemoveListener, onRemoveListener());
+    verifyZeroInteractions(onResume);
+    verifyOnly(onCancel, onCancel());
+
+    container.listen(provider.future, (prev, value) {});
+
+    verifyOnly(onAddListener, onAddListener());
+    verifyOnly(onResume, onResume());
+
+    container.listen(provider.future, (prev, value) {});
+
+    verifyOnly(onAddListener, onAddListener());
+    verifyNoMoreInteractions(onCancel);
+    verifyNoMoreInteractions(onResume);
+    verifyZeroInteractions(onDispose);
+
+    container.invalidate(provider);
+
+    verifyOnly(onDispose, onDispose());
+  });
+
   test('builders', () {
     expect(Provider.autoDispose.family, Provider.family.autoDispose);
     expect(