isAutoDispose

packages/riverpod/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Unreleased build
 
+- Instead of `Provider.autoDispose()` and `Provider.autoDispose.family()`, it is now possible to write `Provider(isAutoDispose: true)` and `Provider.family(isAutoDispose: true)`.
 - **Breaking**: ProviderListenable.addListener is deleted and now internal-only.
   A simpler alternative will be added in the future.
 - **Breaking**: ProviderObserver methods have been updated to take a `ProviderObserverContext` parameter.

packages/riverpod/test/feature/auto_dispose_test.dart

@@ -0,0 +1,82 @@
+// ignore_for_file: inference_failure_on_generic_invocation
+
+import 'package:riverpod/legacy.dart';
+import 'package:riverpod/riverpod.dart';
+import 'package:test/test.dart';
+
+class Builder<T extends Function, R> {
+  Builder(this.ctor);
+
+  final R Function(T create, {bool isAutoDispose}) ctor;
+
+  Factory<R> build(T fn) {
+    return ({Object isAutoDispose = const Object()}) {
+      switch (isAutoDispose) {
+        case const Object():
+          return ctor(fn);
+        case bool():
+          return ctor(fn, isAutoDispose: isAutoDispose);
+        default:
+          throw ArgumentError('isAutoDispose must be a boolean');
+      }
+    };
+  }
+}
+
+extension<T, R> on Builder<T Function(Ref ref), R> {
+  Factory<R> get unimplemented => build((ref) => throw UnimplementedError());
+}
+
+extension<T, R> on Builder<T Function(Ref ref, Object?), R> {
+  Factory<R> get unimplemented => build((ref, _) => throw UnimplementedError());
+}
+
+extension<T, R> on Builder<T Function(), R> {
+  Factory<R> get unimplemented => build(() => throw UnimplementedError());
+}
+
+typedef Factory<R> = R Function({bool isAutoDispose});
+
+final matrix = [
+  // Functional
+  Builder(Provider.new).unimplemented,
+  Builder(Provider.family.call).unimplemented,
+  Builder(FutureProvider.new).unimplemented,
+  Builder(FutureProvider.family.call).unimplemented,
+  Builder(StreamProvider.new).unimplemented,
+  Builder(StreamProvider.family.call).unimplemented,
+  // Notifier
+  Builder(NotifierProvider.new).unimplemented,
+  Builder(NotifierProvider.family.call).unimplemented,
+  Builder(AsyncNotifierProvider.new).unimplemented,
+  Builder(AsyncNotifierProvider.family.call).unimplemented,
+  Builder(StreamNotifierProvider.new).unimplemented,
+  Builder(StreamNotifierProvider.family.call).unimplemented,
+  // Legacy
+  Builder(StateProvider.new).unimplemented,
+  Builder(StateProvider.family.call).unimplemented,
+  Builder(StateNotifierProvider.new).unimplemented,
+  Builder(StateNotifierProvider.family.call).unimplemented,
+];
+
+void main() {
+  test('Defaults isAutoDispose to false', () {
+    for (final builder in matrix) {
+      expect(
+        builder().isAutoDispose,
+        isFalse,
+        reason: '${builder().runtimeType}',
+      );
+    }
+  });
+
+  test('Can set isAutoDispose', () {
+    for (final builder in matrix) {
+      expect(
+        builder(isAutoDispose: true).isAutoDispose,
+        isTrue,
+        reason: '${builder().runtimeType}',
+      );
+    }
+  });
+}

tools/generate_providers/bin/generate_providers.dart

@@ -247,6 +247,7 @@ void _generateFunctionalFamily(
 
   buffer.writeln('''
 @internal
+@publicInMisc
 class $builderName {
   const $builderName();
 
@@ -256,6 +257,7 @@ class $builderName {
     String? name,
     Iterable<ProviderOrFamily>? dependencies,
     Retry? retry,
+    ${_isAutoDisposeArg(disposeType)}
   }) {
     return ${provider.providerName}Family<${provider.genericsUsage}, ArgT>(
       create,
@@ -283,6 +285,7 @@ void _generateFunctionalOrphan(
 
   buffer.writeln('''
 @internal
+@publicInMisc
 class $builderName {
   const $builderName();
 
@@ -292,6 +295,7 @@ class $builderName {
     String? name,
     Iterable<ProviderOrFamily>? dependencies,
     Retry? retry,
+    ${_isAutoDisposeArg(disposeType)}
   }) {
     return ${provider.providerName}<${provider.genericsUsage}>(
       create,
@@ -366,7 +370,13 @@ String _isAutoDisposeParam(_DisposeType disposeType) {
   if (disposeType == _DisposeType.autoDispose) {
     return 'isAutoDispose: true,';
   }
-  return '';
+  return 'isAutoDispose: isAutoDispose,';
+}
+
+String _isAutoDisposeArg(_DisposeType disposeType) {
+  if (disposeType == _DisposeType.autoDispose) return '';
+
+  return 'bool isAutoDispose = false,';
 }
 
 void _generateNotifier(
@@ -389,6 +399,7 @@ void _generateNotifier(
 
   buffer.writeln('''
 @internal
+@publicInMisc
 class $builderName {
   const $builderName();
 
@@ -398,17 +409,14 @@ class $builderName {
     String? name,
     Iterable<ProviderOrFamily>? dependencies,
     Retry? retry,
-    Persist? persist,
-    bool? shouldPersist,
+    ${_isAutoDisposeArg(disposeType)}
   }) {
     return $providerName${provider.genericsUsage}$ctor(
       create,
       name: name,
       ${_isAutoDisposeParam(disposeType)}
       dependencies: dependencies,
       retry: retry,
-      persist: persist,
-      shouldPersist: shouldPersist,
     );
   }