Add Ref.listen(weak: true)

rrousselGit · Mar 16, 2024 · 39db426 · 39db426
2 parents 2701c74 + f96031e
commit 39db426
Show file tree

Hide file tree

Showing 200 changed files with 2,297 additions and 1,680 deletions.
diff --git a/examples/counter/lib/main.g.dart b/examples/counter/lib/main.g.dart
diff --git a/examples/pub/lib/detail.g.dart b/examples/pub/lib/detail.g.dart
diff --git a/examples/pub/lib/search.g.dart b/examples/pub/lib/search.g.dart
diff --git a/examples/stackoverflow/lib/common.g.dart b/examples/stackoverflow/lib/common.g.dart
diff --git a/examples/stackoverflow/lib/question.g.dart b/examples/stackoverflow/lib/question.g.dart
diff --git a/examples/stackoverflow/lib/tag.g.dart b/examples/stackoverflow/lib/tag.g.dart
diff --git a/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart b/packages/flutter_riverpod/lib/src/providers/legacy/change_notifier_provider.dart
@@ -135,9 +135,9 @@ final class ChangeNotifierProvider<NotifierT extends ChangeNotifier?>
   @internal
   @override
   ChangeNotifierProviderElement<NotifierT> $createElement(
-    ProviderContainer container,
+    $ProviderPointer pointer,
   ) {
-    return ChangeNotifierProviderElement<NotifierT>._(this, container);
+    return ChangeNotifierProviderElement<NotifierT>._(this, pointer);
   }
 
   @mustBeOverridden
@@ -161,7 +161,7 @@ final class ChangeNotifierProvider<NotifierT extends ChangeNotifier?>
 /// The element of [ChangeNotifierProvider].
 class ChangeNotifierProviderElement<NotifierT extends ChangeNotifier?>
     extends ProviderElement<NotifierT> {
-  ChangeNotifierProviderElement._(this.provider, super.container);
+  ChangeNotifierProviderElement._(this.provider, super.pointer);
 
   @override
   final ChangeNotifierProvider<NotifierT> provider;
@@ -240,8 +240,8 @@ class ChangeNotifierProviderFamily<NotifierT extends ChangeNotifier?, Arg>
   ) {
     return $FamilyOverride(
       from: this,
-      createElement: (container, provider) {
-        provider as ChangeNotifierProvider<NotifierT>;
+      createElement: (pointer) {
+        final provider = pointer.origin as ChangeNotifierProvider<NotifierT>;
 
         return ChangeNotifierProvider<NotifierT>.internal(
           (ref) => create(ref, provider.argument as Arg),
@@ -251,7 +251,7 @@ class ChangeNotifierProviderFamily<NotifierT extends ChangeNotifier?, Arg>
           dependencies: null,
           allTransitiveDependencies: null,
           name: null,
-        ).$createElement(container);
+        ).$createElement(pointer);
       },
     );
   }

diff --git a/packages/riverpod/CHANGELOG.md b/packages/riverpod/CHANGELOG.md
@@ -15,6 +15,10 @@
 - `Stream/FutureProvider.overrideWithValue` was added back.
 - **Breaking**: `Notifier` and variants are now recreated whenever the provider
   rebuilds. This enables using `Ref.mounted` to check dispose.
+- Added `Ref.listen(..., weak: true)`.
+  When specifying `weak: true`, the listener will not cause the provider to be
+  initialized. This is useful when wanting to react to changes to a provider,
+  but not trigger a network request if not necessary.
 - An error is now thrown when trying to override a provider twice in the same
   `ProviderContainer`.
 - Disposing a `ProviderContainer` now disposes of all of its sub `ProviderContainers` too.

diff --git a/packages/riverpod/lib/riverpod.dart b/packages/riverpod/lib/riverpod.dart
@@ -20,11 +20,12 @@ export 'src/framework.dart'
         Node,
         ProviderElementProxy,
         OnError,
+        WeakNode,
         ProviderContainerTest,
         DebugRiverpodDevtoolBiding,
         TransitiveFamilyOverride,
         TransitiveProviderOverride,
-        ProviderPointer,
+        $ProviderPointer,
         UnmountedRefException,
         ProviderPointerManager,
         ProviderDirectory,

diff --git a/packages/riverpod/lib/src/common/listenable.dart b/packages/riverpod/lib/src/common/listenable.dart
@@ -48,12 +48,6 @@ class ProxyElementValueListenable<T> extends _ValueListenable<T> {
         _notifyError(value.error, value.stackTrace);
     }
   }
-
-  /// Updates the [result] of this [ProxyElementValueListenable] without invoking listeners.
-  // ignore: use_setters_to_change_properties, non_constant_identifier_names
-  void UNSAFE_setResultWithoutNotifyingListeners(Result<T>? value) {
-    _result = value;
-  }
 }
 
 class _ValueListenable<T> {